{ "openapi": "3.0.0", "info": { "title": "CISCO-SIP-UA-MIB MIB API", "version": "1.0.0", "description": "Cisco User Agent Session Initiation Protocol (SIP) \n MIB module. SIP is an application-layer signalling\n protocol for creating, modifying and terminating\n multimedia sessions with one or more participants.\n These sessions include Internet multimedia conferences\n and Internet telephone calls. SIP is defined in \n RFC 2543 (March 1999). \n \n This MIB is defined for the management of SIP User \n Agents (UAs). A User Agent is an application which \n contains both a User Agent Client (UAC) and a User \n Agent Server (UAS). A UAC is an application that \n initiates a SIP request. A UAS is an application that \n contacts the user when a SIP request is received and \n that returns a response on behalf of the user. The \n response accepts, rejects, or redirects the request.\n \n A SIP transaction occurs between a client and a server \n and comprises all messages from the first request sent\n from the client to the server up to a final (non-1xx) \n response sent from the server to the client.\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-SIP-UA-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/CISCO-SIP-UA-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "CISCO-SIP-UA-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-SIP-UA-MIB:cSipCfgBase": { "get": { "summary": "Get cSipCfgBase data", "description": "Retrieve cSipCfgBase operational data from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This object will reflect the version of SIP supported by this \n user agent. It will follow the same format as SIP version \n information contained in the SIP messages generated by this\n user agent. For example, user agents supporting SIP version 2\n will return 'SIP/2.0' as dictated by RFC 2543.", "properties": { "cSipCfgVersion": { "type": "string", "description": "This object will reflect the version of SIP supported by this \n user agent. It will follow the same format as SIP version \n information contained in the SIP messages generated by this\n user agent. For example, user agents supporting SIP version 2\n will return 'SIP/2.0' as dictated by RFC 2543.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cSipCfgTransport": { "type": "string", "description": "This object specifies the transport protocol the SIP user \n agent will use to receive SIP messages. A value of 'disabled'\n indicates that the UA will not receive any SIP messages." }, "cSipCfgUserLocationServerAddr": { "type": "string", "description": "This object specifies address of the User Location \n Server (ULS) being used to resolve the location of end \n points. This could be a Domain Name Server (DNS) or a \n SIP proxy/redirect server.\n \n The format of the address follows the IETF service location \n protocol. The syntax is as follows:\n \n mapping-type:type-specific-syntax\n \n the mapping-type specifies a scheme for mapping the matching \n dial string to a target server. The type-specific-syntax is \n exactly that, something that the particular mapping scheme can\n understand. For example,\n Session target Meaning\n ipv4:171.68.13.55:1006 The session target is the IP \n version 4 address of 171.68.13.55 \n and port 1006.\n dns:pots.cisco.com The session target is the IP host \n with dns name pots.cisco.com.\n \n The valid Mapping type definitions for the peer follow:\n ipv4 - Syntax: ipv4:w.x.y.z:port or ipv4:w.x.y.z \n dns - Syntax: dns:host.domain.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cSipCfgMaxForwards": { "type": "integer", "description": "This object may be used with any SIP method to limit the \n number of proxies that can forward the request to the next \n downstream server.", "minimum": -2147483648, "maximum": 2147483647 }, "cSipCfgBindSrcAddrInterface": { "type": "string", "description": "This object may specify the interface where the\n source IP address used in SIP signalling or media\n packets is configured. A value of 0 means that \n there is no specific source address configured and \n in this case the best local IP address will be chosen \n by the system.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "cSipCfgBindSrcAddrScope": { "type": "string", "description": "This object specifies the scope of packets to\n which the source IP address of the interface \n designated by cSipCfgBindSrcAddrInterface\n will be bound. A value of 'all' means the IP address \n will be bound to both SIP signalling and media packets.\n A value of 'control' means the IP address will only\n be bound to SIP signalling packets. \n If cSipCfgBindSrcAddrInterface is set to 0,\n the value of this object has no meaning." }, "cSipCfgDnsSrvQueryStringFormat": { "type": "string", "description": "This object specifies the format of the prefix used \n by the system for DNS SRV queries.\n \n v1 : RFC 2052 format - 'protocol.transport.'\n v2 : RFC 2782 format - '_protocol._transport.'\n \n This object allows backward compatibility with systems\n only supporting RFC 2052 format." }, "cSipCfgRedirectionDisabled": { "type": "boolean", "description": "This object specifies how call redirection (3xx)\n is handled by the user agent. \n \n If 'false', the user agent's treatment of incoming \n 3xx class response messages is as defined in RFC 2543. \n That is, the user agent uses the Contact header(s)\n from the 3xx response to reinitiate another INVITE\n transaction to the user's new location. The call \n is redirected.\n \n If 'true', the user agent treats incoming 3xx \n response messages as 4xx (client error) class \n response messages. In this case, the call is not\n redirected, instead it is released with the \n appropriate PSTN cause code.\n \n The mapping of SIP 3xx response status codes to\n 4xx response status codes is as follows:\n 300 Multiple Choices -> 410 Gone\n 301 Moved Permanently -> 410 Gone\n 302 Moved Temporarily -> 480 Temporarily Unavailable\n 305 User Proxy -> 410 Gone\n 380 Alternative Service -> 410 Gone\n Any other 3xx -> 410 Gone" }, "cSipCfgSymNatEnabled": { "type": "boolean", "description": "This object specifies whether remote media checks\n for Symmetric Network Address Translation (NAT) \n is enabled or disabled.\n \n If 'true', remote media checks are enabled. The\n gateway will have the ability to open a Real Time \n Transport Protocol (RTP) session with the remote\n end and then update (modify) the existing RTP\n session's remote address/port (raddr:rport) with\n the source address and port of the actual media\n packet received. This would be triggered for only\n those calls where the Session Description Protocol\n (SDP) received by the gateway has an indication to\n do so.\n \n If 'false', remote media checks are disabled." }, "cSipCfgSymNatDirectionRole": { "type": "string", "description": "This object specifies the value of the\n 'a=direction:' SDP attribute supported by \n the user agent. The direction attribute is used \n to describe the role of the user agent (as an \n endpoint for a connection-oriented media stream) \n in the connection setup procedure.\n \n none : No role is specified.\n passive : The user agent will advertise itself\n as a 'passive' entity (inside the NAT)\n in the SDP.\n active : The user agent will advertise itself\n as a 'active' entity (outside the NAT)\n in the SDP." }, "cSipCfgSuspendResumeEnabled": { "type": "boolean", "description": "This object specifies if support for handling \n Suspend/Resume events from the switch is enabled or not.\n \n If 'true', the user agent on getting a Suspend will\n notify the remote agent by sending it a re-invite with\n a hold SDP. Similarly, when the Gateway receives a Resume, it\n will initiate a re-invite with the original SDP and unhold the\n call.\n \n If 'false', the user agent will not initiate any re-invites\n on receiving Suspend/Resume events, basically it won't be\n putting the call on hold or off hold." }, "cSipCfgOfferCallHold": { "type": "string", "description": "This object specifies how the SIP gateway would initiate call\n hold requests.\n \n directionAttr: The user agent will use the direction\n attribute such as a=sendonly or a=inactive in\n the sdp to initiate call hold requests.\n \n connAddr: The user agent will use 0.0.0.0 connection address\n to specify Call Hold." }, "cSipCfgReasonHeaderOveride": { "type": "boolean", "description": "This object specifies that the Reason header overrides SIP \n status code mapping table." }, "cSipCfgMaximumForwards": { "type": "integer", "description": "This object may be used with any SIP method to limit the \n number of proxies that can forward the request to the next \n downstream server.", "minimum": -2147483648, "maximum": 2147483647 } } }, "example": { "CISCO-SIP-UA-MIB:cSipCfgBase": { "cSipCfgVersion": "192.168.1.1", "cSipCfgTransport": "192.168.1.1", "cSipCfgUserLocationServerAddr": "192.168.1.1", "cSipCfgMaxForwards": -2147483648, "cSipCfgBindSrcAddrInterface": "192.168.1.1", "cSipCfgBindSrcAddrScope": "192.168.1.1", "cSipCfgDnsSrvQueryStringFormat": "192.168.1.1", "cSipCfgRedirectionDisabled": true, "cSipCfgSymNatEnabled": true, "cSipCfgSymNatDirectionRole": "192.168.1.1", "cSipCfgSuspendResumeEnabled": true, "cSipCfgOfferCallHold": "192.168.1.1", "cSipCfgReasonHeaderOveride": true, "cSipCfgMaximumForwards": -2147483648 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipCfgBase", "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": "/cSipCfgBase", "x-restconf-kind": "container" }, "/data/CISCO-SIP-UA-MIB:cSipCfgTimer": { "get": { "summary": "Get cSipCfgTimer data", "description": "Retrieve cSipCfgTimer operational data from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This object specifies the time a user agent will wait to \n receive a provisional response to a INVITE before resending \n the INVITE.", "properties": { "cSipCfgTimerTrying": { "type": "integer", "description": "This object specifies the time a user agent will wait to \n receive a provisional response to a INVITE before resending \n the INVITE.", "minimum": -2147483648, "maximum": 2147483647 }, "cSipCfgTimerExpires": { "type": "integer", "description": "This object specifies the time a user agent will wait to \n receive a final response to a INVITE before cancelling the \n transaction.", "minimum": -2147483648, "maximum": 2147483647 }, "cSipCfgTimerConnect": { "type": "integer", "description": "This object specifies the time a user agent will wait to \n receive an ACK confirmation a session is established.", "minimum": -2147483648, "maximum": 2147483647 }, "cSipCfgTimerDisconnect": { "type": "integer", "description": "This object specifies the time a user agent will wait to \n receive an BYE confirmation a session is disconnected.", "minimum": -2147483648, "maximum": 2147483647 }, "cSipCfgTimerPrack": { "type": "integer", "description": "This object specifies the time a user agent will wait for \n a final response before retransmitting the PRACK (PRovisional\n ACKnowledgment).", "minimum": -2147483648, "maximum": 2147483647 }, "cSipCfgTimerComet": { "type": "integer", "description": "This object specifies the time a user agent will wait \n for a final response before retransmitting the COMET \n (COndition MET).", "minimum": -2147483648, "maximum": 2147483647 }, "cSipCfgTimerReliableRsp": { "type": "integer", "description": "This object specifies the amount of time to wait for a\n PRACK before retransmitting the reliable 1xx response.", "minimum": -2147483648, "maximum": 2147483647 }, "cSipCfgTimerNotify": { "type": "integer", "description": "This object specifies the amount of time to wait for a\n final response before retransmitting the Notify.", "minimum": -2147483648, "maximum": 2147483647 }, "cSipCfgTimerRefer": { "type": "integer", "description": "This object specifies the amount of time to wait for a\n final response before retransmitting the Refer.", "minimum": -2147483648, "maximum": 2147483647 }, "cSipCfgTimerSessionTimer": { "type": "integer", "description": "This object specifies the value of the Min-SE \n header for INVITE messages originated by this \n user agent and the minimum value of the \n Session-Expires headers for INVITE messages \n received by this user agent.\n \n Any Session-Expires headers received with a \n value below this object's value will be rejected\n with a 422 client error response message.\n \n Setting this object to a value less than 600 is\n valid, but the possibly of excessive re-INVITES \n and the impact of those messages should be fully \n understood and considered an acceptable risk.", "minimum": -2147483648, "maximum": 2147483647 }, "cSipCfgTimerHold": { "type": "integer", "description": "This object specifies the amount of time to wait before \n disconnecting a call already on hold. A value of 0 specifies\n that this functionality is disabled.", "minimum": -2147483648, "maximum": 2147483647 }, "cSipCfgTimerInfo": { "type": "integer", "description": "This object specifies the amount of time to wait for a\n 200ok response before retransmitting the Info.", "minimum": -2147483648, "maximum": 2147483647 }, "cSipCfgTimerConnectionAging": { "type": "integer", "description": "This object specifies the amount of time to wait before \n aging out a TCP/UDP connection.", "minimum": -2147483648, "maximum": 2147483647 }, "cSipCfgTimerBufferInvite": { "type": "integer", "description": "This object specifies the amount of time to buffer the INVITE \n while waiting for display name info in the Facility.\n \n A value of 0 means that the INVITE wouldn't be buffered\n waiting for the display name info in the Facility.", "minimum": -2147483648, "maximum": 2147483647 } } }, "example": { "CISCO-SIP-UA-MIB:cSipCfgTimer": { "cSipCfgTimerTrying": -2147483648, "cSipCfgTimerExpires": -2147483648, "cSipCfgTimerConnect": -2147483648, "cSipCfgTimerDisconnect": -2147483648, "cSipCfgTimerPrack": -2147483648, "cSipCfgTimerComet": -2147483648, "cSipCfgTimerReliableRsp": -2147483648, "cSipCfgTimerNotify": -2147483648, "cSipCfgTimerRefer": -2147483648, "cSipCfgTimerSessionTimer": -2147483648, "cSipCfgTimerHold": -2147483648, "cSipCfgTimerInfo": -2147483648, "cSipCfgTimerConnectionAging": -2147483648, "cSipCfgTimerBufferInvite": -2147483648 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipCfgTimer", "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": "/cSipCfgTimer", "x-restconf-kind": "container" }, "/data/CISCO-SIP-UA-MIB:cSipCfgRetry": { "get": { "summary": "Get cSipCfgRetry data", "description": "Retrieve cSipCfgRetry operational data from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This object specifies the number of times a user agent \n will retry sending a INVITE request.", "properties": { "cSipCfgRetryInvite": { "type": "integer", "description": "This object specifies the number of times a user agent \n will retry sending a INVITE request.", "minimum": -2147483648, "maximum": 2147483647 }, "cSipCfgRetryBye": { "type": "integer", "description": "This object specifies the number of times a user agent \n will retry sending a BYE request.", "minimum": -2147483648, "maximum": 2147483647 }, "cSipCfgRetryCancel": { "type": "integer", "description": "This object specifies the number of times a user agent \n will retry sending a CANCEL request.", "minimum": -2147483648, "maximum": 2147483647 }, "cSipCfgRetryRegister": { "type": "integer", "description": "This object specifies the number of times a user agent \n will retry sending a REGISTER request.", "minimum": -2147483648, "maximum": 2147483647 }, "cSipCfgRetryResponse": { "type": "integer", "description": "This object specifies the number of times a user agent \n will retry sending a Response and expecting a ACK.", "minimum": -2147483648, "maximum": 2147483647 }, "cSipCfgRetryPrack": { "type": "integer", "description": "This object specifies the number of times a user agent \n will retry sending a PRACK (PRovisional ACKnowledgement).", "minimum": -2147483648, "maximum": 2147483647 }, "cSipCfgRetryComet": { "type": "integer", "description": "This object specifies the number of times a user agent \n will retry sending a COMET (COndition MET).", "minimum": -2147483648, "maximum": 2147483647 }, "cSipCfgRetryReliableRsp": { "type": "integer", "description": "This object specifies the number of times a user agent \n will retry sending a reliable response.", "minimum": -2147483648, "maximum": 2147483647 }, "cSipCfgRetryNotify": { "type": "integer", "description": "This object specifies the number of times a user agent \n will retry sending a Notify request.", "minimum": -2147483648, "maximum": 2147483647 }, "cSipCfgRetryRefer": { "type": "integer", "description": "This object specifies the number of times a user agent \n will retry sending a Refer request.", "minimum": -2147483648, "maximum": 2147483647 }, "cSipCfgRetryInfo": { "type": "integer", "description": "This object specifies the number of times a user agent\n will retry sending a Info request.", "minimum": -2147483648, "maximum": 2147483647 }, "cSipCfgRetrySubscribe": { "type": "integer", "description": "This object specifies the number of times a user agent\n will retry sending a Subscribe request.", "minimum": -2147483648, "maximum": 2147483647 } } }, "example": { "CISCO-SIP-UA-MIB:cSipCfgRetry": { "cSipCfgRetryInvite": -2147483648, "cSipCfgRetryBye": -2147483648, "cSipCfgRetryCancel": -2147483648, "cSipCfgRetryRegister": -2147483648, "cSipCfgRetryResponse": -2147483648, "cSipCfgRetryPrack": -2147483648, "cSipCfgRetryComet": -2147483648, "cSipCfgRetryReliableRsp": -2147483648, "cSipCfgRetryNotify": -2147483648, "cSipCfgRetryRefer": -2147483648, "cSipCfgRetryInfo": -2147483648, "cSipCfgRetrySubscribe": -2147483648 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipCfgRetry", "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": "/cSipCfgRetry", "x-restconf-kind": "container" }, "/data/CISCO-SIP-UA-MIB:cSipCfgPeer": { "get": { "summary": "Get cSipCfgPeer data", "description": "Retrieve cSipCfgPeer operational data from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "cSipCfgPeer", "properties": { "cSipCfgOutSessionTransport": { "type": "string", "description": "This object specifies the session transport \n protocol that will be used for outbound SIP \n messages. This configuration is applicable\n to all dial-peers in the system having \n cSipCfgPeerOutSessionTransport set to 'system'." }, "cSipCfgReliable1xxRspStr": { "type": "string", "description": "This object specifies the string that will be \n placed in either the Supported or Require SIP \n header, as specified by cSipCfgReliable1xxRspHdr.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cSipCfgReliable1xxRspHdr": { "type": "string", "description": "This object specifies behavior with respect to\n Supported or Require headers in SIP messages sent\n and received via this dial-peer.\n \n If the originating gateway is configured for 'require',\n the Require header is added to the outgoing INVITEs\n with the value of cSipCfgReliable1xxStr. This\n requires the use of reliable provisional responses by\n the terminating gateway. Sessions will be torn down\n if this use cannot be supported by that gateway.\n \n If the originating gateway is configured for 'supported',\n the Supported header is added to the outgoing INVITEs\n with the value of cSipCfgReliable1xxStr. This \n requires that an attempt to use reliable provisional\n responses be made, but sessions can continue without them.\n \n If the originating gateway is configured for 'disabled',\n the value of cSipCfgReliable1xxStr will NOT be added to\n either the Require or Supported headers of outgoing INVITEs." }, "cSipCfgUrlType": { "type": "string", "description": "This object specifies the URL type sent in outbound\n INVITES generated by this device." } } }, "example": { "CISCO-SIP-UA-MIB:cSipCfgPeer": { "cSipCfgOutSessionTransport": "192.168.1.1", "cSipCfgReliable1xxRspStr": "192.168.1.1", "cSipCfgReliable1xxRspHdr": "192.168.1.1", "cSipCfgUrlType": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipCfgPeer", "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": "/cSipCfgPeer", "x-restconf-kind": "container" }, "/data/CISCO-SIP-UA-MIB:cSipCfgAaa": { "get": { "summary": "Get cSipCfgAaa data", "description": "Retrieve cSipCfgAaa operational data from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This object specifies the source of the information used to\n populate the username attribute of AAA billing records.", "properties": { "cSipCfgAaaUsername": { "type": "string", "description": "This object specifies the source of the information used to\n populate the username attribute of AAA billing records." } } }, "example": { "CISCO-SIP-UA-MIB:cSipCfgAaa": { "cSipCfgAaaUsername": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipCfgAaa", "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": "/cSipCfgAaa", "x-restconf-kind": "container" }, "/data/CISCO-SIP-UA-MIB:cSipCfgVoiceServiceVoip": { "get": { "summary": "Get cSipCfgVoiceServiceVoip data", "description": "Retrieve cSipCfgVoiceServiceVoip operational data from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "cSipCfgVoiceServiceVoip", "properties": { "cSipCfgHeaderPassingEnabled": { "type": "boolean", "description": "This object specifies if support for passing\n SIP headers from Invite, Subscribe, Notify Request to the\n application is enabled.\n \n If 'true', the headers received in a message will be passed\n to the application.\n \n If 'false', the headers received in a message will not be\n passed to the application." }, "cSipCfgMaxSubscriptionAccept": { "type": "integer", "description": "This object specifies the maximum number of concurrent SIP\n subscriptions a SIP Gateway can accept.", "minimum": 0, "maximum": 4294967295 }, "cSipCfgMaxSubscriptionOriginate": { "type": "integer", "description": "This object specifies the maximum number of concurrent SIP\n subscriptions that a SIP Gateway can originate. Default is Max\n Dialpeers on platform. Maximum is 2*Max Dialpeers on\n Platform.", "minimum": 0, "maximum": 4294967295 }, "cSipCfgSwitchTransportEnabled": { "type": "boolean", "description": "This object specifies if the functionality of switching\n between transports from udp to tcp if the message size of a\n Request is greater than 1300 bytes is enabled or not.\n \n This configuration is at the global level, and will only be \n considered if there exists no voip dial-peer." } } }, "example": { "CISCO-SIP-UA-MIB:cSipCfgVoiceServiceVoip": { "cSipCfgHeaderPassingEnabled": true, "cSipCfgMaxSubscriptionAccept": 0, "cSipCfgMaxSubscriptionOriginate": 0, "cSipCfgSwitchTransportEnabled": true } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipCfgVoiceServiceVoip", "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": "/cSipCfgVoiceServiceVoip", "x-restconf-kind": "container" }, "/data/CISCO-SIP-UA-MIB:cSipStatsInfo": { "get": { "summary": "Get cSipStatsInfo data", "description": "Retrieve cSipStatsInfo operational data from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "cSipStatsInfo", "properties": { "cSipStatsInfoTryingIns": { "type": "integer", "description": "This object reflects the total number of Trying\n (100) responses received by the user agent since system startup. \n Trying responses indicate that some unspecified\n action is being taken on behalf of this call, but\n the user has not yet been located. Inbound Trying\n responses indicate that outbound INVITE request \n sent out by this system have been received and\n are processed.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsInfoTryingOuts": { "type": "integer", "description": "This object reflects the total number of Trying\n (100) responses sent by the user agent since system startup.\n Trying responses indicate that some unspecified\n action is being taken on behalf of this call, but\n the user has not yet been located. Outbound Trying\n responses indicate this system is successfully \n receiving INVITE requests and processing them on \n behalf of the system initiating the INVITE.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsInfoRingingIns": { "type": "integer", "description": "This object reflects the total number of Ringing\n (180) responses received by the user agent since system startup.\n A inbound Ringing response indicates that the UAS\n processing a INVITE initiated by this system has \n found a possible location where the desired end user \n has registered recently and is trying to alert the user.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsInfoRingingOuts": { "type": "integer", "description": "This object reflects the total number of Ringing\n (180) responses sent by the user agent since system startup.\n A outbound Ringing response indicates that this\n system has processed an INVITE for a particular\n end user and found a possible location where that\n user has registered recently. The system is trying\n to alert the end user and is conveying that status\n to the system that originated the INVITE.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsInfoForwardedIns": { "type": "integer", "description": "This object reflects the total number of Call Is Being\n Forwarded (181) responses received by the user agent since system startup.\n A proxy server may use a Forwarded status code to\n indicate that the call is being forwarded to a different\n set of destinations. Inbound Forwarded responses indicate \n to this system that forwarding actions are taking place \n with regard to calls initiated by this system.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsInfoForwardedOuts": { "type": "integer", "description": "This object reflects the total number of Call Is Being\n Forwarded (181) responses sent by the user agent since system startup.\n A proxy server may use a Forwarded status code to\n indicate that the call is being forwarded to a different\n set of destinations. Outbound Forwarded responses\n indicate this system is taking some forwarding action\n for calls and conveying that status to the system that\n initiated the calls.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsInfoQueuedIns": { "type": "integer", "description": "This object reflects the total number of Queued\n (182) responses received by the user agent since system startup.\n Inbound Queued responses indicate that the users\n this system is attempting to call are temporarily\n unavailable but the SIP agents operating on behalf\n of those users wish to queue the calls rather than\n reject them. When the called parties become available,\n this system can expect to receive the appropriate\n final status response. The Reason-Phrase from the\n Queued response messages Status-Line may give further\n details about the status of the call. Multiple \n Queued responses to update this system about the status\n of the queued call my be received.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsInfoQueuedOuts": { "type": "integer", "description": "This object reflects the total number of Queued\n (182) responses sent by the user agent since system startup.\n Outbound Queued responses indicate this system\n has determined that the called party is temporarily\n unavailable but the call is not rejected. Rather \n the call is queued until the called party becomes\n available. Queued responses messages are sent to\n the system originating the call request to convey\n the current status of a queued call.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsInfoSessionProgIns": { "type": "integer", "description": "This object reflects the total number of Session\n Progress (183) responses received by the user agent since system startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsInfoSessionProgOuts": { "type": "integer", "description": "This object reflects the total number of Session\n Progress (183) responses sent by the user agent since system startup.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-SIP-UA-MIB:cSipStatsInfo": { "cSipStatsInfoTryingIns": 0, "cSipStatsInfoTryingOuts": 0, "cSipStatsInfoRingingIns": 0, "cSipStatsInfoRingingOuts": 0, "cSipStatsInfoForwardedIns": 0, "cSipStatsInfoForwardedOuts": 0, "cSipStatsInfoQueuedIns": 0, "cSipStatsInfoQueuedOuts": 0, "cSipStatsInfoSessionProgIns": 0, "cSipStatsInfoSessionProgOuts": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipStatsInfo", "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": "/cSipStatsInfo", "x-restconf-kind": "container" }, "/data/CISCO-SIP-UA-MIB:cSipStatsSuccess": { "get": { "summary": "Get cSipStatsSuccess data", "description": "Retrieve cSipStatsSuccess operational data from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "cSipStatsSuccess", "properties": { "cSipStatsSuccessOkIns": { "type": "integer", "description": "This object reflects the total number of Ok\n (200) responses received by the user agent since system startup.\n The meaning of inbound Ok responses depends\n on the method used in the associated request.\n \n BYE : The Ok response means the call has \n been terminated.\n \n CANCEL : The Ok response means the search for \n the end user has been cancelled.\n \n INVITE : The Ok response means the called party \n has agreed to participate in the call.\n \n OPTIONS : The Ok response means the called party \n has agreed to share its capabilities.\n \n REGISTER : The Ok response means the registration\n has succeeded.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsSuccessOkOuts": { "type": "integer", "description": "This object reflects the total number of Ok\n (200) responses sent by the user agent since system startup.\n The meaning of outbound Ok responses depends\n on the method used in the associated request.\n \n BYE : The Ok response means the call has \n been terminated.\n \n CANCEL : The Ok response means the search for \n the end user has been cancelled.\n \n INVITE : The Ok response means the called party \n has agreed to participate in the call.\n \n OPTIONS : The Ok response means the called party \n has agreed to share its capabilities.\n \n REGISTER : The Ok response means the registration\n has succeeded.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsSuccessAcceptedIns": { "type": "integer", "description": "This object reflects the total number of Accepted\n (202) responses received by the user agent since system startup.\n The meaning of outbound 202 Ok responses depends\n on the method used in the associated request.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsSuccessAcceptedOuts": { "type": "integer", "description": "This object reflects the total number of Accepted\n (202) responses sent by the user agent since system startup.\n The meaning of outbound 202 Ok responses depends\n on the method used in the associated request.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-SIP-UA-MIB:cSipStatsSuccess": { "cSipStatsSuccessOkIns": 0, "cSipStatsSuccessOkOuts": 0, "cSipStatsSuccessAcceptedIns": 0, "cSipStatsSuccessAcceptedOuts": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipStatsSuccess", "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": "/cSipStatsSuccess", "x-restconf-kind": "container" }, "/data/CISCO-SIP-UA-MIB:cSipStatsRedirect": { "get": { "summary": "Get cSipStatsRedirect data", "description": "Retrieve cSipStatsRedirect operational data from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This object reflects the total number of Multiple\n Choices (300) responses received by the user agent since system startup.\n Multiple Choices responses indicate that the called\n party can be reached at several different locations\n and the server cannot or prefers not to proxy the request.", "properties": { "cSipStatsRedirMultipleChoices": { "type": "integer", "description": "This object reflects the total number of Multiple\n Choices (300) responses received by the user agent since system startup.\n Multiple Choices responses indicate that the called\n party can be reached at several different locations\n and the server cannot or prefers not to proxy the request.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsRedirMovedPerms": { "type": "integer", "description": "This object reflects the total number of Moved \n Permanently (301) responses received by the user agent since system startup.\n Moved Permanently responses indicate that the called party \n can no longer be found at the address offered in the request \n and the requesting UAC should retry at the new address given \n by the Contact header field of the response.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsRedirMovedTemps": { "type": "integer", "description": "This object reflects the total number of Moved \n Temporarily (302) responses received by the user agent since system startup.\n Moved Temporarily responses indicate the UAC should\n retry the request directed at the new address(es)\n given by the Contact header field of the response.\n The duration of this redirection can be indicated\n through the Expires header. If no explicit expiration\n time is given, the new address(es) are only valid\n for this call.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsRedirSeeOthers": { "type": "integer", "description": "This object reflects the total number of See Other \n (303) responses received by the user agent since system startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsRedirUseProxys": { "type": "integer", "description": "This object reflects the total number of Use Proxy \n (305) responses received by the user agent since system startup.\n See Other responses indicate that requested resources\n must be accessed through the proxy given by the \n Contact header field of the response. The recipient\n of this response is expected to repeat this single\n request via the proxy.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsRedirAltServices": { "type": "integer", "description": "This object reflects the total number of Alternative\n Service (380) responses received by the user agent since system startup.\n Alternative Service responses indicate that the call\n was not successful, but alternative services are\n possible. Those alternative services are described\n in the message body of the response.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsRedirMovedTempsIns": { "type": "integer", "description": "This object reflects the total number of Moved\n Temporarily (302) responses received by the user agent since\n system startup. \n Moved Temporarily responses indicate the UAC should\n retry the request directed at the new address(es) \n given by the Contact header field of the response.\n The duration of this redirection can be indicated\n through the Expires header. If no explicit expiration\n time is given, the new address(es) are only valid\n for this call.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsRedirMovedTempsOuts": { "type": "integer", "description": "This object reflects the total number of Moved\n Temporarily (302) responses sent by the user agent since\n system startup.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-SIP-UA-MIB:cSipStatsRedirect": { "cSipStatsRedirMultipleChoices": 0, "cSipStatsRedirMovedPerms": 0, "cSipStatsRedirMovedTemps": 0, "cSipStatsRedirSeeOthers": 0, "cSipStatsRedirUseProxys": 0, "cSipStatsRedirAltServices": 0, "cSipStatsRedirMovedTempsIns": 0, "cSipStatsRedirMovedTempsOuts": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipStatsRedirect", "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": "/cSipStatsRedirect", "x-restconf-kind": "container" }, "/data/CISCO-SIP-UA-MIB:cSipStatsErrClient": { "get": { "summary": "Get cSipStatsErrClient data", "description": "Retrieve cSipStatsErrClient operational data from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This object reflects the total number of Bad Request (400) \n responses received by the user agent since system startup.\n Inbound Bad Request responses indicate that requests issued \n by this system could not be understood due to malformed \n syntax.", "properties": { "cSipStatsClientBadRequestIns": { "type": "integer", "description": "This object reflects the total number of Bad Request (400) \n responses received by the user agent since system startup.\n Inbound Bad Request responses indicate that requests issued \n by this system could not be understood due to malformed \n syntax.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientBadRequestOuts": { "type": "integer", "description": "This object reflects the total number of Bad Request (400) \n responses sent by the user agent since system startup.\n Outbound Bad Request responses indicate that requests \n received by this system could not be understood due to \n malformed syntax.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientUnauthorizedIns": { "type": "integer", "description": "This object reflects the total number of Unauthorized (401) \n responses received by the user agent since system startup. \n Inbound Unauthorized responses indicate that requests issued \n by this system require user authentication.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientUnauthorizedOuts": { "type": "integer", "description": "This object reflects the total number of Unauthorized (401) \n responses sent by the user agent since system startup.\n Outbound Unauthorized responses indicate that requests \n received by this system require user authentication.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientPaymentReqdIns": { "type": "integer", "description": "This object reflects the total number of Payment Required \n (402) responses received by the user agent since system startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientPaymentReqdOuts": { "type": "integer", "description": "This object reflects the total number of Payment Required \n (402) responses sent by the user agent since system startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientForbiddenIns": { "type": "integer", "description": "This object reflects the total number of Forbidden (403) \n responses received by the user agent since system startup.\n Inbound Forbidden responses indicate that requests issued\n by this system are understood by the server but the server\n refuses to fulfill the request. Authorization will not help\n and the requests should not be repeated.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientForbiddenOuts": { "type": "integer", "description": "This object reflects the total number of Forbidden (403) \n responses sent by the user agent since system startup.\n Outbound Forbidden responses indicate that requests received\n by this system are understood but this system is refusing to\n fulfill the requests.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientNotFoundIns": { "type": "integer", "description": "This object reflects the total number of Not Found (404) \n responses received by the user agent since system startup.\n Inbound Not Found responses indicate that the called party \n does not exist at the domain specified in the Request-URI \n or the domain is not handled by the recipient of the request.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientNotFoundOuts": { "type": "integer", "description": "This object reflects the total number of Not Found (404) \n responses sent by the user agent since system startup.\n Outbound Not Found responses indicate that this system\n knows that the called party does not exist at the domain\n specified in the Request-URI or the domain is not handled\n by this system.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientMethNotAllowedIns": { "type": "integer", "description": "This object reflects the total number of Method Not Allowed \n (405) received responses by the user agent.\n Inbound Method Not Allowed responses indicate that requests \n issued by this system have specified a SIP method in the \n Request-Line that is not allowed for the address identified \n by the Request-URI.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientMethNotAllowedOuts": { "type": "integer", "description": "This object reflects the total number of Method Not Allowed \n (405) received sent by the user agent since system startup.\n Outbound Method Not Allowed responses indicate that requests \n received by this system have SIP methods specified in the \n Request-Line that are not allowed for the address identified \n by the Request-URI.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientNotAcceptableIns": { "type": "integer", "description": "This object reflects the total number of Not Acceptable \n (406) responses received by the user agent since system startup.\n Inbound Not Acceptable responses indicate the resources \n identified by requests issued by this system cannot generate \n responses with content characteristics acceptable to this \n system according to the accept headers sent in the requests.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientNotAcceptableOuts": { "type": "integer", "description": "This object reflects the total number of Not Acceptable (406) \n responses sent by the user agent since system startup.\n Outbound Not Acceptable responses indicate that the resources\n identified by requests received by this system cannot generate\n responses with content characteristics acceptable to the \n system sending the requests.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientProxyAuthReqdIns": { "type": "integer", "description": "This object reflects the total number of Proxy Authentication \n Required (407) responses received by the user agent since system startup.\n Inbound Proxy Authentication Required responses indicate that \n this system must authenticate itself with the proxy before \n gaining access to the requested resource.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientProxyAuthReqdOuts": { "type": "integer", "description": "This object reflects the total number of Proxy Authentication \n Required (407) responses sent by the user agent since system startup.\n Outbound Proxy Authentication Required responses indicate that\n the systems issuing requests being processed by this system \n must authenticate themselves with this system before gaining \n access to requested resources.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientReqTimeoutIns": { "type": "integer", "description": "This object reflects the total number of Request Timeout \n (408) responses received by the user agent since system startup.\n Inbound Request Timeout responses indicate that requests \n issued by this system are not being processed by the server \n within the time indicated in the Expires header of the \n request.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientReqTimeoutOuts": { "type": "integer", "description": "This object reflects the total number of Request Timeout \n (408) responses sent by the user agent since system startup.\n Outbound Request Timeout responses indicate that this \n system is not able to produce an appropriate response within \n the time indicated in the Expires header of the request.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientConflictIns": { "type": "integer", "description": "This object reflects the total number of Conflict (409) \n responses received by the user agent since system startup.\n Inbound Conflict responses indicate that requests issued\n by this system could not be completed due to a conflict\n with the current state of a requested resource.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientConflictOuts": { "type": "integer", "description": "This object reflects the total number of Conflict (409) \n responses sent by the user agent since system startup.\n Outbound Conflict responses indicate that requests received\n by this system could not be completed due to a conflict\n with the current state of a requested resource.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientGoneIns": { "type": "integer", "description": "This object reflects the total number of Gone (410) \n responses received by the user agent since system startup.\n Inbound Gone responses indicate that resources requested\n by this system are no longer available at the recipient server\n and no forwarding address is known.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientGoneOuts": { "type": "integer", "description": "This object reflects the total number of Gone (410) \n responses sent by the user agent since system startup.\n Outbound Gone responses indicate that the requested\n resources are no longer available at this system and\n no forwarding address is known.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientLengthRequiredIns": { "type": "integer", "description": "This object reflects the total number of Length Required \n (411) responses received by the user agent since system startup.\n Inbound Length Required responses indicate that requests \n issued by this system are being refused by servers because \n of no defined Content-Length header field.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientLengthRequiredOuts": { "type": "integer", "description": "This object reflects the total number of Length Required \n (411) responses sent by the user agent since system startup.\n Outbound Length Required responses indicate that requests \n received by this system are being refused because of no \n defined Content-Length header field.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientReqEntTooLargeIns": { "type": "integer", "description": "This object reflects the total number of Request Entity Too \n Large (413) responses received by the user agent since system startup.\n Inbound Request Entity Too Large responses indicate that \n requests issued by this system are being refused because \n the request is larger than the server is willing or able to \n process.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientReqEntTooLargeOuts": { "type": "integer", "description": "This object reflects the total number of Request Entity Too \n Large (413) responses sent by the user agent since system startup.\n Outbound Request Entity Too Large responses indicate that \n requests received by this system are larger than this system \n is willing or able to process.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientReqURITooLargeIns": { "type": "integer", "description": "This object reflects the total number of Request-URI Too \n Large (414) responses received by the user agent since system startup.\n Inbound Request-URI Too Large responses indicate that \n requests issued by this system are being refused because the \n Request-URI is longer than the server is willing or able to \n interpret.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientReqURITooLargeOuts": { "type": "integer", "description": "This object reflects the total number of Request-URI Too \n Large (414) responses sent by the user agent since system startup.\n Outbound Request-URI Too Large responses indicate that \n Request-URIs received by this system are longer than this \n system is willing or able to interpret.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientNoSupMediaTypeIns": { "type": "integer", "description": "This object reflects the total number of Unsupported Media \n Type (415) responses received by the user agent since system startup.\n Inbound Unsupported Media Type responses indicate that \n requests issued by this system are being refused because the \n message body of the request is in a format not supported by \n the requested resource for the requested method.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientNoSupMediaTypeOuts": { "type": "integer", "description": "This object reflects the total number of Unsupported Media \n Type (415) responses sent by the user agent since system startup.\n Outbound Unsupported Media Type responses indicate that the \n body of requests received by this system are in a format not \n supported by the requested resource for the requested method.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientBadExtensionIns": { "type": "integer", "description": "This object reflects the total number of Bad Extension (420) \n responses received by the user agent since system startup.\n Inbound Bad Extension responses indicate that the recipient \n did not understand the protocol extension specified in a \n Require header field.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientBadExtensionOuts": { "type": "integer", "description": "This object reflects the total number of Bad Extension (420) \n responses sent by the user agent since system startup.\n Outbound Bad Extension responses indicate that this system\n did not understand the protocol extension specified in a\n Require header field of requests.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientTempNotAvailIns": { "type": "integer", "description": "This object reflects the total number of Temporarily Not \n Available (480) responses received by the user agent since system startup.\n Inbound Temporarily Not Available responses indicate that \n the called party is currently unavailable.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientTempNotAvailOuts": { "type": "integer", "description": "This object reflects the total number of Temporarily Not \n Available (480) responses sent by the user agent since system startup.\n Outbound Temporarily Not Available responses indicate that \n the called party's end system was contacted successfully but \n the called party is currently unavailable.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientCallLegNoExistIns": { "type": "integer", "description": "This object reflects the total number of Call Leg/Transaction \n Does Not Exist (481) responses received by the user agent since system startup.\n Inbound Call Leg/Transaction Does Not Exist responses indicate\n that either BYE or CANCEL requests issued by this system were \n received by a server and not matching call leg or transaction \n existed.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientCallLegNoExistOuts": { "type": "integer", "description": "This object reflects the total number of Call Leg/Transaction \n Does Not Exist (481) responses sent by the user agent since system startup.\n Outbound Call Leg/Transaction Does Not Exist responses \n indicate that BYE or CANCEL requests have been received by \n this system and not call leg or transaction matching that \n request exists.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientLoopDetectedIns": { "type": "integer", "description": "This object reflects the total number of Loop Detected (482) \n responses received by the user agent since system startup.\n Inbound Loop Detected responses indicate that requests issued\n by this system were received at servers and the server found \n itself in the Via path more than once.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientLoopDetectedOuts": { "type": "integer", "description": "This object reflects the total number of Loop Detected (482) \n responses sent by the user agent since system startup.\n Outbound Loop Detected responses indicate that requests \n received by this system contain a Via path with this system \n appearing more than once.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientTooManyHopsIns": { "type": "integer", "description": "This object reflects the total number of Too Many Hops (483) \n responses received by the user agent since system startup.\n Inbound Too Many Hops responses indicate that requests issued\n by this system contain more Via entries (hops) than allowed by\n the Max-Forwards header field of the requests.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientTooManyHopsOuts": { "type": "integer", "description": "This object reflects the total number of Too Many Hops (483) \n responses sent by the user agent since system startup.\n Outbound Too Many Hops responses indicate that requests\n received by this system contain more Via entries (hops) than\n are allowed by the Max-Forwards header field of the requests.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientAddrIncompleteIns": { "type": "integer", "description": "This object reflects the total number of Address Incomplete \n (484) responses received by the user agent since system startup.\n Inbound Address Incomplete responses indicate that requests \n issued by this system had To addresses or Request-URIs that \n were incomplete.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientAddrIncompleteOuts": { "type": "integer", "description": "This object reflects the total number of Address Incomplete \n (484) responses sent by the user agent since system startup.\n Outbound Address Incomplete responses indicate that requests \n received by this system had To addresses or Request-URIs that \n were incomplete.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientAmbiguousIns": { "type": "integer", "description": "This object reflects the total number of Ambiguous (485) \n responses received by the user agent since system startup.\n Inbound Ambiguous responses indicate that requests issued\n by this system provided ambiguous address information.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientAmbiguousOuts": { "type": "integer", "description": "This object reflects the total number of Ambiguous (485) \n responses sent by the user agent since system startup.\n Outbound Ambiguous responses indicate that requests received\n by this system contained ambiguous address information.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientBusyHereIns": { "type": "integer", "description": "This object reflects the total number of Busy Here (486) \n responses received by the user agent since system startup.\n Inbound Busy Here responses indicate that the\n called party is currently not willing or not able to\n take additional calls.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientBusyHereOuts": { "type": "integer", "description": "This object reflects the total number of Busy Here (486) \n responses sent by the user agent since system startup.\n Outbound Busy Here responses indicate that the\n called party's end system was contacted successfully but the\n called party is currently not willing or able to take \n additional calls.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientReqTermIns": { "type": "integer", "description": "This object reflects the total number of Request Terminated \n (487) responses received by the user agent since system startup.\n Request Terminated responses are issued if the original \n request was terminated via CANCEL or BYE.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientReqTermOuts": { "type": "integer", "description": "This object reflects the total number of Request Terminated \n (487) responses sent by the user agent since system startup.\n Request Terminated responses are issued if the original \n request was terminated via CANCEL or BYE.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientNoAcceptHereIns": { "type": "integer", "description": "This object reflects the total number of Not Acceptable Here\n (488) responses received by the user agent since system startup.\n The response has the same meaning as 606 (Not Acceptable), \n but only applies to the specific entity addressed by the \n Request-URI and the request may succeed elsewhere.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientNoAcceptHereOuts": { "type": "integer", "description": "This object reflects the total number of Not Acceptable Here\n (488) responses sent by the user agent since system startup.\n The response has the same meaning as 606 (Not Acceptable), \n but only applies to the specific entity addressed by the \n Request-URI and the request may succeed elsewhere.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientBadEventIns": { "type": "integer", "description": "This object reflects the total number of BadEvent (489) \n responses received by the user agent since system startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientBadEventOuts": { "type": "integer", "description": "This object reflects the total number of BadEvent (489) \n responses sent by the user agent since system startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientSTTooSmallIns": { "type": "integer", "description": "This object reflects the total number of SessionTimerTooSmall\n (422) responses received by the user agent since system \n startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientSTTooSmallOuts": { "type": "integer", "description": "This object reflects the total number of SessionTimerTooSmall\n (422) responses sent by the user agent since system startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientReqPendingIns": { "type": "integer", "description": "This object reflects the total number of RequestPending\n (491) responses received by the user agent since system\n startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsClientReqPendingOuts": { "type": "integer", "description": "This object reflects the total number of RequestPending\n (491) responses sent by the user agent since system startup.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-SIP-UA-MIB:cSipStatsErrClient": { "cSipStatsClientBadRequestIns": 0, "cSipStatsClientBadRequestOuts": 0, "cSipStatsClientUnauthorizedIns": 0, "cSipStatsClientUnauthorizedOuts": 0, "cSipStatsClientPaymentReqdIns": 0, "cSipStatsClientPaymentReqdOuts": 0, "cSipStatsClientForbiddenIns": 0, "cSipStatsClientForbiddenOuts": 0, "cSipStatsClientNotFoundIns": 0, "cSipStatsClientNotFoundOuts": 0, "cSipStatsClientMethNotAllowedIns": 0, "cSipStatsClientMethNotAllowedOuts": 0, "cSipStatsClientNotAcceptableIns": 0, "cSipStatsClientNotAcceptableOuts": 0, "cSipStatsClientProxyAuthReqdIns": 0, "cSipStatsClientProxyAuthReqdOuts": 0, "cSipStatsClientReqTimeoutIns": 0, "cSipStatsClientReqTimeoutOuts": 0, "cSipStatsClientConflictIns": 0, "cSipStatsClientConflictOuts": 0, "cSipStatsClientGoneIns": 0, "cSipStatsClientGoneOuts": 0, "cSipStatsClientLengthRequiredIns": 0, "cSipStatsClientLengthRequiredOuts": 0, "cSipStatsClientReqEntTooLargeIns": 0, "cSipStatsClientReqEntTooLargeOuts": 0, "cSipStatsClientReqURITooLargeIns": 0, "cSipStatsClientReqURITooLargeOuts": 0, "cSipStatsClientNoSupMediaTypeIns": 0, "cSipStatsClientNoSupMediaTypeOuts": 0, "cSipStatsClientBadExtensionIns": 0, "cSipStatsClientBadExtensionOuts": 0, "cSipStatsClientTempNotAvailIns": 0, "cSipStatsClientTempNotAvailOuts": 0, "cSipStatsClientCallLegNoExistIns": 0, "cSipStatsClientCallLegNoExistOuts": 0, "cSipStatsClientLoopDetectedIns": 0, "cSipStatsClientLoopDetectedOuts": 0, "cSipStatsClientTooManyHopsIns": 0, "cSipStatsClientTooManyHopsOuts": 0, "cSipStatsClientAddrIncompleteIns": 0, "cSipStatsClientAddrIncompleteOuts": 0, "cSipStatsClientAmbiguousIns": 0, "cSipStatsClientAmbiguousOuts": 0, "cSipStatsClientBusyHereIns": 0, "cSipStatsClientBusyHereOuts": 0, "cSipStatsClientReqTermIns": 0, "cSipStatsClientReqTermOuts": 0, "cSipStatsClientNoAcceptHereIns": 0, "cSipStatsClientNoAcceptHereOuts": 0, "cSipStatsClientBadEventIns": 0, "cSipStatsClientBadEventOuts": 0, "cSipStatsClientSTTooSmallIns": 0, "cSipStatsClientSTTooSmallOuts": 0, "cSipStatsClientReqPendingIns": 0, "cSipStatsClientReqPendingOuts": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipStatsErrClient", "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": "/cSipStatsErrClient", "x-restconf-kind": "container" }, "/data/CISCO-SIP-UA-MIB:cSipStatsErrServer": { "get": { "summary": "Get cSipStatsErrServer data", "description": "Retrieve cSipStatsErrServer operational data from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "cSipStatsErrServer", "properties": { "cSipStatsServerIntErrorIns": { "type": "integer", "description": "This object reflects the total number of Internal Server Error\n (500) responses received by the user agent since system startup.\n Inbound Internal Server Error responses indicate that servers \n to which this system is sending requests have encountered \n unexpected conditions that prevent them from fulfilling the \n requests.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsServerIntErrorOuts": { "type": "integer", "description": "This object reflects the total number of Internal Server Error\n (500) responses sent by the user agent since system startup.\n Outbound Internal Server Error responses indicate that this \n system has encountered unexpected conditions that prevent it \n from fulfilling received requests.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsServerNotImplementedIns": { "type": "integer", "description": "This object reflects the total number of Not Implemented \n (501) responses received by the user agent since system startup.\n Inbound Not Implemented responses indicate that servers to \n which this system is sending requests do not support the \n functionality required to fulfill the requests.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsServerNotImplementedOuts": { "type": "integer", "description": "This object reflects the total number of Not Implemented \n (501) responses sent by the user agent since system startup.\n Outbound Not Implemented responses indicate that this system\n does not support the functionality required to fulfill the \n requests.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsServerBadGatewayIns": { "type": "integer", "description": "This object reflects the total number of Bad Gateway (502) \n responses received by the user agent since system startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsServerBadGatewayOuts": { "type": "integer", "description": "This object reflects the total number of Bad Gateway (502) \n responses sent by the user agent since system startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsServerServiceUnavailIns": { "type": "integer", "description": "This object reflects the total number of Service Unavailable \n (503) responses received by the user agent since system startup.\n Inbound Service Unavailable responses indicate that the server\n servicing this system's request is temporarily unavailable to\n handle the request.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsServerServiceUnavailOuts": { "type": "integer", "description": "This object reflects the total number of Service Unavailable \n (503) responses sent by the user agent since system startup.\n Outbound Service Unavailable responses indicate that this\n system is temporarily unable to handle received requests.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsServerGatewayTimeoutIns": { "type": "integer", "description": "This object reflects the total number of Gateway Time-out \n (504) responses received by the user agent since system startup.\n Inbound Gateway Time-out responses indicate that the server\n attempting to complete this system's request did not receive\n a timely response from yet another system it was accessing to\n complete the request.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsServerGatewayTimeoutOuts": { "type": "integer", "description": "This object reflects the total number of Gateway Time-out \n (504) responses sent by the user agent since system startup.\n Outbound Gateway Time-out responses indicate that this system\n did not receive a timely response from the system it had\n accessed to assist in completing a received request.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsServerBadSipVersionIns": { "type": "integer", "description": "This object reflects the total number of SIP Version Not \n Supported (505) responses received by the user agent since system startup.\n Inbound SIP Version Not Supported responses indicate that \n the server does not support, or refuses to support, the SIP \n protocol version that was used in the request message.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsServerBadSipVersionOuts": { "type": "integer", "description": "This object reflects the total number of SIP Version Not \n Supported (505) responses sent by the user agent since system startup.\n Outbound SIP Version Not Supported responses indicate that \n this system does not support, or refuses to support, the SIP \n protocol version used in received requests.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsServerPrecondFailureIns": { "type": "integer", "description": "This object reflects the total number of Precondition \n Failure (580) responses received by the user agent since system startup.\n This response is returned by a UAS if it is unable to\n perform the mandatory preconditions for the session.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsServerPrecondFailureOuts": { "type": "integer", "description": "This object reflects the total number of Precondition \n Failure (580) responses sent by the user agent since system startup.\n This response is returned by a UAS if it is unable to\n perform the mandatory preconditions for the session.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-SIP-UA-MIB:cSipStatsErrServer": { "cSipStatsServerIntErrorIns": 0, "cSipStatsServerIntErrorOuts": 0, "cSipStatsServerNotImplementedIns": 0, "cSipStatsServerNotImplementedOuts": 0, "cSipStatsServerBadGatewayIns": 0, "cSipStatsServerBadGatewayOuts": 0, "cSipStatsServerServiceUnavailIns": 0, "cSipStatsServerServiceUnavailOuts": 0, "cSipStatsServerGatewayTimeoutIns": 0, "cSipStatsServerGatewayTimeoutOuts": 0, "cSipStatsServerBadSipVersionIns": 0, "cSipStatsServerBadSipVersionOuts": 0, "cSipStatsServerPrecondFailureIns": 0, "cSipStatsServerPrecondFailureOuts": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipStatsErrServer", "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": "/cSipStatsErrServer", "x-restconf-kind": "container" }, "/data/CISCO-SIP-UA-MIB:cSipStatsGlobalFail": { "get": { "summary": "Get cSipStatsGlobalFail data", "description": "Retrieve cSipStatsGlobalFail operational data from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "cSipStatsGlobalFail", "properties": { "cSipStatsGlobalBusyEverywhereIns": { "type": "integer", "description": "This object reflects the total number of Busy\n Everywhere (600) responses received by the user agent since system startup.\n Inbound Busy Everywhere responses indicate that the \n called party's end system was contacted successfully\n but the called party is busy and does not wish to take\n the call at this time.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsGlobalBusyEverywhereOuts": { "type": "integer", "description": "This object reflects the total number of Busy\n Everywhere (600) responses sent by the user agent since system startup.\n Outbound Busy Everywhere responses indicate that \n this system has successfully contacted a called party's\n end system and the called party does not wish to take\n the call at this time.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsGlobalDeclineIns": { "type": "integer", "description": "This object reflects the total number of Decline\n (603) responses received by the user agent since system startup.\n Decline responses indicate that the called party's end \n system was contacted successfully but the called party \n explicitly does not wish to, or cannot, participate.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsGlobalDeclineOuts": { "type": "integer", "description": "This object reflects the total number of Decline\n (603) responses sent by the user agent since system startup.\n Outbound Decline responses indicate that this system\n has successfully contacted a called party's end system\n and the called party explicitly does not wish to, or\n cannot, participate.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsGlobalNotAnywhereIns": { "type": "integer", "description": "This object reflects the total number of Does Not\n Exist Anywhere (604) responses received by the user agent since system startup.\n Inbound Does Not Exist Anywhere responses indicate that\n the server handling this system's request has authoritative\n information that the called party indicated in the To\n request field does not exist anywhere.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsGlobalNotAnywhereOuts": { "type": "integer", "description": "This object reflects the total number of Does Not\n Exist Anywhere (604) responses sent by the user agent since system startup.\n Outbound Does Not Exist Anywhere responses indicate that\n this system has authoritative information that the called\n party in the To field of received requests does not exist\n anywhere.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsGlobalNotAcceptableIns": { "type": "integer", "description": "This object reflects the total number of Not Acceptable\n (606) responses received by the user agent since system startup.\n Inbound Not Acceptable responses indicate that the called\n party's end system was contacted successfully but some\n aspect of the session description is not acceptable.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsGlobalNotAcceptableOuts": { "type": "integer", "description": "This object reflects the total number of Not Acceptable\n (606) responses sent by the user agent since system startup.\n Outbound Not Acceptable responses indicate that the called\n party wishes to communicate, but cannot adequately support\n the session described in the request.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-SIP-UA-MIB:cSipStatsGlobalFail": { "cSipStatsGlobalBusyEverywhereIns": 0, "cSipStatsGlobalBusyEverywhereOuts": 0, "cSipStatsGlobalDeclineIns": 0, "cSipStatsGlobalDeclineOuts": 0, "cSipStatsGlobalNotAnywhereIns": 0, "cSipStatsGlobalNotAnywhereOuts": 0, "cSipStatsGlobalNotAcceptableIns": 0, "cSipStatsGlobalNotAcceptableOuts": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipStatsGlobalFail", "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": "/cSipStatsGlobalFail", "x-restconf-kind": "container" }, "/data/CISCO-SIP-UA-MIB:cSipStatsTraffic": { "get": { "summary": "Get cSipStatsTraffic data", "description": "Retrieve cSipStatsTraffic operational data from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This object reflects the total number of INVITE requests \n received by the user agent since system startup.", "properties": { "cSipStatsTrafficInviteIns": { "type": "integer", "description": "This object reflects the total number of INVITE requests \n received by the user agent since system startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsTrafficInviteOuts": { "type": "integer", "description": "This object reflects the total number of INVITE requests sent\n by the user agent.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsTrafficAckIns": { "type": "integer", "description": "This object reflects the total number of ACK requests \n received by the user agent since system startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsTrafficAckOuts": { "type": "integer", "description": "This object reflects the total number of ACK requests sent\n by the user agent.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsTrafficByeIns": { "type": "integer", "description": "This object reflects the total number of BYE requests \n received by the user agent since system startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsTrafficByeOuts": { "type": "integer", "description": "This object reflects the total number of BYE requests sent\n by the user agent.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsTrafficCancelIns": { "type": "integer", "description": "This object reflects the total number of CANCEL requests \n received by the user agent since system startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsTrafficCancelOuts": { "type": "integer", "description": "This object reflects the total number of CANCEL requests sent\n by the user agent.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsTrafficOptionsIns": { "type": "integer", "description": "This object reflects the total number of OPTIONS requests \n received by the user agent since system startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsTrafficOptionsOuts": { "type": "integer", "description": "This object reflects the total number of OPTIONS requests sent\n by the user agent.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsTrafficRegisterIns": { "type": "integer", "description": "This object reflects the total number of REGISTER requests \n received by the user agent since system startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsTrafficRegisterOuts": { "type": "integer", "description": "This object reflects the total number of REGISTER requests \n sent by the user agent since system startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsTrafficCometIns": { "type": "integer", "description": "This object reflects the total number of COndition MET \n requests received by the user agent since system startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsTrafficCometOuts": { "type": "integer", "description": "This object reflects the total number of COndition MET \n requests sent by the user agent since system startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsTrafficPrackIns": { "type": "integer", "description": "This object reflects the total number of PRovisonal \n ACKnowledgement requests received by the user agent since system startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsTrafficPrackOuts": { "type": "integer", "description": "This object reflects the total number of PRovisonal \n ACKnowledgement requests sent by the user agent since system startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsTrafficReferIns": { "type": "integer", "description": "This object reflects the total number of Refer\n requests received by the user agent since system startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsTrafficReferOuts": { "type": "integer", "description": "This object reflects the total number of Refer\n requests sent by the user agent since system startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsTrafficNotifyIns": { "type": "integer", "description": "This object reflects the total number of Notify \n requests received by the user agent since system startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsTrafficNotifyOuts": { "type": "integer", "description": "This object reflects the total number of Notify \n requests sent by the user agent since system startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsTrafficInfoIns": { "type": "integer", "description": "This object reflects the total number of Info \n requests received by the user agent since system startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsTrafficInfoOuts": { "type": "integer", "description": "This object reflects the total number of Info \n requests sent by the user agent since system startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsTrafficSubscribeIns": { "type": "integer", "description": "This object reflects the total number of Subscribe\n requests received by the user agent since system startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsTrafficSubscribeOuts": { "type": "integer", "description": "This object reflects the total number of Subscribe\n requests sent by the user agent since system startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsTrafficUpdateIns": { "type": "integer", "description": "This object reflects the total number of Update\n requests received by the user agent since system startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsTrafficUpdateOuts": { "type": "integer", "description": "This object reflects the total number of Update\n requests sent by the user agent since system startup.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-SIP-UA-MIB:cSipStatsTraffic": { "cSipStatsTrafficInviteIns": 0, "cSipStatsTrafficInviteOuts": 0, "cSipStatsTrafficAckIns": 0, "cSipStatsTrafficAckOuts": 0, "cSipStatsTrafficByeIns": 0, "cSipStatsTrafficByeOuts": 0, "cSipStatsTrafficCancelIns": 0, "cSipStatsTrafficCancelOuts": 0, "cSipStatsTrafficOptionsIns": 0, "cSipStatsTrafficOptionsOuts": 0, "cSipStatsTrafficRegisterIns": 0, "cSipStatsTrafficRegisterOuts": 0, "cSipStatsTrafficCometIns": 0, "cSipStatsTrafficCometOuts": 0, "cSipStatsTrafficPrackIns": 0, "cSipStatsTrafficPrackOuts": 0, "cSipStatsTrafficReferIns": 0, "cSipStatsTrafficReferOuts": 0, "cSipStatsTrafficNotifyIns": 0, "cSipStatsTrafficNotifyOuts": 0, "cSipStatsTrafficInfoIns": 0, "cSipStatsTrafficInfoOuts": 0, "cSipStatsTrafficSubscribeIns": 0, "cSipStatsTrafficSubscribeOuts": 0, "cSipStatsTrafficUpdateIns": 0, "cSipStatsTrafficUpdateOuts": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipStatsTraffic", "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": "/cSipStatsTraffic", "x-restconf-kind": "container" }, "/data/CISCO-SIP-UA-MIB:cSipStatsRetry": { "get": { "summary": "Get cSipStatsRetry data", "description": "Retrieve cSipStatsRetry operational data from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This object reflects the total number of INVITE retries that \n have been sent by the user agent since system startup. If the number of 'first \n attempt' INVITES is of interest, subtract the value of this \n object from cSipStatsTrafficInviteOut.", "properties": { "cSipStatsRetryInvites": { "type": "integer", "description": "This object reflects the total number of INVITE retries that \n have been sent by the user agent since system startup. If the number of 'first \n attempt' INVITES is of interest, subtract the value of this \n object from cSipStatsTrafficInviteOut.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsRetryByes": { "type": "integer", "description": "This object reflects the total number of BYE retries that have\n been sent by the user agent since system startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsRetryCancels": { "type": "integer", "description": "This object reflects the total number of CANCEL retries that \n have been sent by the user agent since system startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsRetryRegisters": { "type": "integer", "description": "This object reflects the total number of REGISTER retries that\n have been sent by the user agent since system startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsRetryResponses": { "type": "integer", "description": "This object reflects the total number of Response (while \n expecting a ACK) retries that have been sent by the user\n agent.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsRetryPracks": { "type": "integer", "description": "This object reflects the total number of PRovisional\n ACKnowledgement retries sent by the user agent since system startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsRetryComets": { "type": "integer", "description": "This object reflects the total number of COndition\n MET retries sent by the user agent since system startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsRetryReliable1xxRsps": { "type": "integer", "description": "This object reflects the total number of Reliable\n 1xx Response retries sent by the user agent since system startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsRetryNotifys": { "type": "integer", "description": "This object reflects the total number of Notify \n retries that have been sent by the user agent since system startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsRetryRefers": { "type": "integer", "description": "This object reflects the total number of Refer\n retries that have been sent by the user agent since system startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsRetryInfo": { "type": "integer", "description": "This object reflects the total number of Info\n retries that have been sent by the user agent since system\n startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsRetrySubscribe": { "type": "integer", "description": "This object reflects the total number of Subscribe\n retries that have been sent by the user agent since system\n startup.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-SIP-UA-MIB:cSipStatsRetry": { "cSipStatsRetryInvites": 0, "cSipStatsRetryByes": 0, "cSipStatsRetryCancels": 0, "cSipStatsRetryRegisters": 0, "cSipStatsRetryResponses": 0, "cSipStatsRetryPracks": 0, "cSipStatsRetryComets": 0, "cSipStatsRetryReliable1xxRsps": 0, "cSipStatsRetryNotifys": 0, "cSipStatsRetryRefers": 0, "cSipStatsRetryInfo": 0, "cSipStatsRetrySubscribe": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipStatsRetry", "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": "/cSipStatsRetry", "x-restconf-kind": "container" }, "/data/CISCO-SIP-UA-MIB:cSipStatsMisc": { "get": { "summary": "Get cSipStatsMisc data", "description": "Retrieve cSipStatsMisc operational data from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This object reflects the total number of incoming Redirect \n (3xx) response messages that have been mapped to Client \n Error (4xx) response messages.", "properties": { "cSipStatsMisc3xxMappedTo4xxRsps": { "type": "integer", "description": "This object reflects the total number of incoming Redirect \n (3xx) response messages that have been mapped to Client \n Error (4xx) response messages.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-SIP-UA-MIB:cSipStatsMisc": { "cSipStatsMisc3xxMappedTo4xxRsps": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipStatsMisc", "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": "/cSipStatsMisc", "x-restconf-kind": "container" }, "/data/CISCO-SIP-UA-MIB:cSipStatsConnection": { "get": { "summary": "Get cSipStatsConnection data", "description": "Retrieve cSipStatsConnection operational data from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This object reflects the total number of TCP send failures\n since system startup.", "properties": { "cSipStatsConnTCPSendFailures": { "type": "integer", "description": "This object reflects the total number of TCP send failures\n since system startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsConnUDPSendFailures": { "type": "integer", "description": "This object reflects the total number of UDP send failures\n since system startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsConnTCPRemoteClosures": { "type": "integer", "description": "This object reflects the total number of Remote Closures \n for TCP since system startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsConnUDPCreateFailures": { "type": "integer", "description": "This object reflects the total number of connection create\n failures for UDP since system startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsConnTCPCreateFailures": { "type": "integer", "description": "This object reflects the total number of connection create\n failures for TCP since system startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsConnUDPInactiveTimeouts": { "type": "integer", "description": "This object reflects the total number of UDP connections that \n timed out due to inactivity since system startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsConnTCPInactiveTimeouts": { "type": "integer", "description": "This object reflects the total number of TCP connections that\n timed out due to inactivity since system startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsActiveUDPConnections": { "type": "integer", "description": "This object reflects the total number of active UDP\n connections since system startup.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsActiveTCPConnections": { "type": "integer", "description": "This object reflects the total number of active TCP\n connections since system startup.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-SIP-UA-MIB:cSipStatsConnection": { "cSipStatsConnTCPSendFailures": 0, "cSipStatsConnUDPSendFailures": 0, "cSipStatsConnTCPRemoteClosures": 0, "cSipStatsConnUDPCreateFailures": 0, "cSipStatsConnTCPCreateFailures": 0, "cSipStatsConnUDPInactiveTimeouts": 0, "cSipStatsConnTCPInactiveTimeouts": 0, "cSipStatsActiveUDPConnections": 0, "cSipStatsActiveTCPConnections": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipStatsConnection", "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": "/cSipStatsConnection", "x-restconf-kind": "container" }, "/data/CISCO-SIP-UA-MIB:cSipCfgEarlyMediaTable": { "get": { "summary": "Get cSipCfgEarlyMediaTable data", "description": "Retrieve cSipCfgEarlyMediaTable operational data from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table contains configuration for Early\n Media Cut Through. The configuration controls\n how the SIP user agent will process 1xx\n (Provisional) SIP response messages that contain \n Session Definition Protocol (SDP) payloads.", "properties": { "cSipCfgEarlyMediaEntry": { "type": "array", "description": "A row in the cSipCfgEarlyMediaTable.\n A row is accessible with a Provisional (1xx)\n status code value (eg, 180) and provides\n an object for the enabling or disabling of\n the Early Media Cut Through functionality.", "items": { "type": "object", "properties": { "cSipCfgEarlyMediaStatusCodeIndex": { "type": "string", "description": "A unique identifier of a row in this table and\n a valid SIP status code.", "x-yang-type": "CISCO-SIP-UA-MIB:CSipStatusCode" }, "cSipCfgEarlyMediaCutThruDisabled": { "type": "boolean", "description": "This object specifies whether Early Media \n Cut Through is enabled or disabled for the \n SIP response messages with status codes that \n match cSipCfgEarlyMediaStatusCodeIndex.\n \n If 'true', early media cut through is disabled,\n and the user agent will process the message as\n though it did not contain any SDP payload.\n \n If 'false', early media cut through is enabled,\n and the user agent will process the message\n similar to a 183 (Session Progress) and cut\n through for early media. The assumption being\n that the SDP is an indication that the far end\n is going to send early media." } } } } } }, "example": { "CISCO-SIP-UA-MIB:cSipCfgEarlyMediaTable": { "cSipCfgEarlyMediaEntry": [ { "cSipCfgEarlyMediaStatusCodeIndex": "1", "cSipCfgEarlyMediaCutThruDisabled": true }, { "cSipCfgEarlyMediaStatusCodeIndex": "2", "cSipCfgEarlyMediaCutThruDisabled": true }, { "cSipCfgEarlyMediaStatusCodeIndex": "3", "cSipCfgEarlyMediaCutThruDisabled": true } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipCfgEarlyMediaTable", "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": "/cSipCfgEarlyMediaTable", "x-restconf-kind": "container" }, "/data/CISCO-SIP-UA-MIB:cSipCfgEarlyMediaTable/cSipCfgEarlyMediaEntry": { "get": { "summary": "Get cSipCfgEarlyMediaEntry list", "description": "Retrieve list of cSipCfgEarlyMediaEntry entries from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A row in the cSipCfgEarlyMediaTable.\n A row is accessible with a Provisional (1xx)\n status code value (eg, 180) and provides\n an object for the enabling or disabling of\n the Early Media Cut Through functionality.", "items": { "type": "object", "properties": { "cSipCfgEarlyMediaStatusCodeIndex": { "type": "string", "description": "A unique identifier of a row in this table and\n a valid SIP status code.", "x-yang-type": "CISCO-SIP-UA-MIB:CSipStatusCode" }, "cSipCfgEarlyMediaCutThruDisabled": { "type": "boolean", "description": "This object specifies whether Early Media \n Cut Through is enabled or disabled for the \n SIP response messages with status codes that \n match cSipCfgEarlyMediaStatusCodeIndex.\n \n If 'true', early media cut through is disabled,\n and the user agent will process the message as\n though it did not contain any SDP payload.\n \n If 'false', early media cut through is enabled,\n and the user agent will process the message\n similar to a 183 (Session Progress) and cut\n through for early media. The assumption being\n that the SDP is an indication that the far end\n is going to send early media." } } } }, "example": { "CISCO-SIP-UA-MIB:cSipCfgEarlyMediaEntry": [ { "cSipCfgEarlyMediaStatusCodeIndex": "192.168.1.1", "cSipCfgEarlyMediaCutThruDisabled": true } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipCfgEarlyMediaEntry", "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": "/cSipCfgEarlyMediaTable/cSipCfgEarlyMediaEntry", "x-restconf-kind": "container" }, "/data/CISCO-SIP-UA-MIB:cSipCfgEarlyMediaTable/cSipCfgEarlyMediaEntry={cSipCfgEarlyMediaStatusCodeIndex}": { "get": { "summary": "Get cSipCfgEarlyMediaEntry entry", "description": "Retrieve specific cSipCfgEarlyMediaEntry entry by key from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "parameters": [ { "name": "cSipCfgEarlyMediaStatusCodeIndex", "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": { "cSipCfgEarlyMediaStatusCodeIndex": { "type": "string", "description": "A unique identifier of a row in this table and\n a valid SIP status code.", "x-yang-type": "CISCO-SIP-UA-MIB:CSipStatusCode" }, "cSipCfgEarlyMediaCutThruDisabled": { "type": "boolean", "description": "This object specifies whether Early Media \n Cut Through is enabled or disabled for the \n SIP response messages with status codes that \n match cSipCfgEarlyMediaStatusCodeIndex.\n \n If 'true', early media cut through is disabled,\n and the user agent will process the message as\n though it did not contain any SDP payload.\n \n If 'false', early media cut through is enabled,\n and the user agent will process the message\n similar to a 183 (Session Progress) and cut\n through for early media. The assumption being\n that the SDP is an indication that the far end\n is going to send early media." } } }, "example": { "CISCO-SIP-UA-MIB:cSipCfgEarlyMediaEntry": { "cSipCfgEarlyMediaStatusCodeIndex": "192.168.1.1", "cSipCfgEarlyMediaCutThruDisabled": true } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipCfgEarlyMediaEntry-2" }, "x-yang-path": "/cSipCfgEarlyMediaTable/cSipCfgEarlyMediaEntry={cSipCfgEarlyMediaStatusCodeIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cSipCfgEarlyMediaStatusCodeIndex" ] }, "/data/CISCO-SIP-UA-MIB:cSipCfgBindSourceAddrTable": { "get": { "summary": "Get cSipCfgBindSourceAddrTable data", "description": "Retrieve cSipCfgBindSourceAddrTable operational data from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table contains configuration for binding\n the scope of packets to the particular ethernet\n interface. The scope for the packets can be\n specified as either 'signalling' or 'media'\n packets. The ethernet interface shall be\n specified by the interface index. The table\n shall be indexed based on the scope.", "properties": { "cSipCfgBindSourceAddrEntry": { "type": "array", "description": "A row in the cSipCfgBindSourceAddrTable.\n A row is accessible with the scope of packets\n to which the source IP address of the interface\n designated by cSipCfgBindSourceAddrInterface\n will be bound.", "items": { "type": "object", "properties": { "cSipCfgBindSourceAddrScope": { "type": "string", "description": "A unique identifier of a row in this table and\n specifies the scope of packets to which the\n source IP address of the interface\n designated by cSipCfgBindSourceAddrInterface\n will be bound." }, "cSipCfgBindSourceAddrInterface": { "type": "string", "description": "This object may specify the interface where the\n source IP address used in SIP signalling or media\n packets is configured. A value of 0 means that\n there is no specific source address configured and\n in this case the best local IP address will be chosen\n by the system.", "x-yang-type": "if-mib:InterfaceIndexOrZero" } } } } } }, "example": { "CISCO-SIP-UA-MIB:cSipCfgBindSourceAddrTable": { "cSipCfgBindSourceAddrEntry": [ { "cSipCfgBindSourceAddrScope": "192.168.1.1", "cSipCfgBindSourceAddrInterface": "192.168.1.1" }, { "cSipCfgBindSourceAddrScope": "192.168.1.1", "cSipCfgBindSourceAddrInterface": "192.168.1.1" }, { "cSipCfgBindSourceAddrScope": "192.168.1.1", "cSipCfgBindSourceAddrInterface": "192.168.1.1" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipCfgBindSourceAddrTable", "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": "/cSipCfgBindSourceAddrTable", "x-restconf-kind": "container" }, "/data/CISCO-SIP-UA-MIB:cSipCfgBindSourceAddrTable/cSipCfgBindSourceAddrEntry": { "get": { "summary": "Get cSipCfgBindSourceAddrEntry list", "description": "Retrieve list of cSipCfgBindSourceAddrEntry entries from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A row in the cSipCfgBindSourceAddrTable.\n A row is accessible with the scope of packets\n to which the source IP address of the interface\n designated by cSipCfgBindSourceAddrInterface\n will be bound.", "items": { "type": "object", "properties": { "cSipCfgBindSourceAddrScope": { "type": "string", "description": "A unique identifier of a row in this table and\n specifies the scope of packets to which the\n source IP address of the interface\n designated by cSipCfgBindSourceAddrInterface\n will be bound." }, "cSipCfgBindSourceAddrInterface": { "type": "string", "description": "This object may specify the interface where the\n source IP address used in SIP signalling or media\n packets is configured. A value of 0 means that\n there is no specific source address configured and\n in this case the best local IP address will be chosen\n by the system.", "x-yang-type": "if-mib:InterfaceIndexOrZero" } } } }, "example": { "CISCO-SIP-UA-MIB:cSipCfgBindSourceAddrEntry": [ { "cSipCfgBindSourceAddrScope": "192.168.1.1", "cSipCfgBindSourceAddrInterface": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipCfgBindSourceAddrEntry", "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": "/cSipCfgBindSourceAddrTable/cSipCfgBindSourceAddrEntry", "x-restconf-kind": "container" }, "/data/CISCO-SIP-UA-MIB:cSipCfgBindSourceAddrTable/cSipCfgBindSourceAddrEntry={cSipCfgBindSourceAddrScope}": { "get": { "summary": "Get cSipCfgBindSourceAddrEntry entry", "description": "Retrieve specific cSipCfgBindSourceAddrEntry entry by key from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "parameters": [ { "name": "cSipCfgBindSourceAddrScope", "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": { "cSipCfgBindSourceAddrScope": { "type": "string", "description": "A unique identifier of a row in this table and\n specifies the scope of packets to which the\n source IP address of the interface\n designated by cSipCfgBindSourceAddrInterface\n will be bound." }, "cSipCfgBindSourceAddrInterface": { "type": "string", "description": "This object may specify the interface where the\n source IP address used in SIP signalling or media\n packets is configured. A value of 0 means that\n there is no specific source address configured and\n in this case the best local IP address will be chosen\n by the system.", "x-yang-type": "if-mib:InterfaceIndexOrZero" } } }, "example": { "CISCO-SIP-UA-MIB:cSipCfgBindSourceAddrEntry": { "cSipCfgBindSourceAddrScope": "192.168.1.1", "cSipCfgBindSourceAddrInterface": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipCfgBindSourceAddrEntry-2" }, "x-yang-path": "/cSipCfgBindSourceAddrTable/cSipCfgBindSourceAddrEntry={cSipCfgBindSourceAddrScope}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cSipCfgBindSourceAddrScope" ] }, "/data/CISCO-SIP-UA-MIB:cSipCfgPeerTable": { "get": { "summary": "Get cSipCfgPeerTable data", "description": "Retrieve cSipCfgPeerTable operational data from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "cSipCfgPeerTable", "properties": { "cSipCfgPeerEntry": { "type": "array", "description": "A row in the cSipCfgPeerTable.", "items": { "type": "object", "properties": { "cSipCfgPeerIndex": { "type": "integer", "description": "An arbitrary index that uniquely identifies a \n dial-peer configured for SIP.", "minimum": -2147483648, "maximum": 2147483647 }, "cSipCfgPeerOutSessionTransport": { "type": "string", "description": "This object specifies the session transport \n protocol that will be used by this dial-peer\n for outbound SIP messages. \n \n The value 'system' is the default and indicates \n that this dial-peer should use the value set by \n cSipCfgOutSessionTransport instead." }, "cSipCfgPeerReliable1xxRspStr": { "type": "string", "description": "This object specifies the string that will be \n placed in either the Supported or Require SIP \n header, as specified by cSipCfgPeerReliable1xxRspHdr.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cSipCfgPeerReliable1xxRspHdr": { "type": "string", "description": "This object specifies behavior with respect to\n Support or Require headers in SIP messages sent\n and received via this dial-peer.\n \n If the originating gateway is configured for 'require',\n the Require header is added to the outgoing INVITEs\n with the value of cSipCfgPeerReliable1xxStr. This\n requires the use of reliable provisional responses by\n the terminating gateway. Sessions will be torn down\n if this use cannot be supported by that gateway.\n \n If the originating gateway is configured for 'supported',\n the Supported header is added to the outgoing INVITEs\n with the value of cSipCfgPeerReliable1xxStr. This \n requires that an attempt to use reliable provisional\n responses be made, but sessions can continue without them.\n \n If the originating gateway is configured for 'disabled',\n the value of cSipCfgReliable1xxStr will NOT be added to\n either the Require or Supported headers of outgoing INVITEs.\n \n The value 'system' is the default and indicates that this \n dial-peer should use the value of cSipCfgReliable1xxRspHdr\n instead." }, "cSipCfgPeerUrlType": { "type": "string", "description": "This object specifies the URL type sent in outbound\n INVITES generated by this device.\n \n The value 'system' is the default and indicates that this \n dial-peer should use the value of cSipCfgUrlType instead." }, "cSipCfgPeerSwitchTransEnabled": { "type": "boolean", "description": "This object specifies if the functionality of switching\n between transports from UDP to TCP if the message size of a\n Request is greater than 1300 bytes is enabled or not." } } } } } }, "example": { "CISCO-SIP-UA-MIB:cSipCfgPeerTable": { "cSipCfgPeerEntry": [ { "cSipCfgPeerIndex": 1, "cSipCfgPeerOutSessionTransport": "192.168.1.1", "cSipCfgPeerReliable1xxRspStr": "192.168.1.1", "cSipCfgPeerReliable1xxRspHdr": "192.168.1.1", "cSipCfgPeerUrlType": "192.168.1.1", "cSipCfgPeerSwitchTransEnabled": true }, { "cSipCfgPeerIndex": 2, "cSipCfgPeerOutSessionTransport": "192.168.1.1", "cSipCfgPeerReliable1xxRspStr": "192.168.1.1", "cSipCfgPeerReliable1xxRspHdr": "192.168.1.1", "cSipCfgPeerUrlType": "192.168.1.1", "cSipCfgPeerSwitchTransEnabled": true }, { "cSipCfgPeerIndex": 3, "cSipCfgPeerOutSessionTransport": "192.168.1.1", "cSipCfgPeerReliable1xxRspStr": "192.168.1.1", "cSipCfgPeerReliable1xxRspHdr": "192.168.1.1", "cSipCfgPeerUrlType": "192.168.1.1", "cSipCfgPeerSwitchTransEnabled": true } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipCfgPeerTable", "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": "/cSipCfgPeerTable", "x-restconf-kind": "container" }, "/data/CISCO-SIP-UA-MIB:cSipCfgPeerTable/cSipCfgPeerEntry": { "get": { "summary": "Get cSipCfgPeerEntry list", "description": "Retrieve list of cSipCfgPeerEntry entries from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A row in the cSipCfgPeerTable.", "items": { "type": "object", "properties": { "cSipCfgPeerIndex": { "type": "integer", "description": "An arbitrary index that uniquely identifies a \n dial-peer configured for SIP.", "minimum": -2147483648, "maximum": 2147483647 }, "cSipCfgPeerOutSessionTransport": { "type": "string", "description": "This object specifies the session transport \n protocol that will be used by this dial-peer\n for outbound SIP messages. \n \n The value 'system' is the default and indicates \n that this dial-peer should use the value set by \n cSipCfgOutSessionTransport instead." }, "cSipCfgPeerReliable1xxRspStr": { "type": "string", "description": "This object specifies the string that will be \n placed in either the Supported or Require SIP \n header, as specified by cSipCfgPeerReliable1xxRspHdr.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cSipCfgPeerReliable1xxRspHdr": { "type": "string", "description": "This object specifies behavior with respect to\n Support or Require headers in SIP messages sent\n and received via this dial-peer.\n \n If the originating gateway is configured for 'require',\n the Require header is added to the outgoing INVITEs\n with the value of cSipCfgPeerReliable1xxStr. This\n requires the use of reliable provisional responses by\n the terminating gateway. Sessions will be torn down\n if this use cannot be supported by that gateway.\n \n If the originating gateway is configured for 'supported',\n the Supported header is added to the outgoing INVITEs\n with the value of cSipCfgPeerReliable1xxStr. This \n requires that an attempt to use reliable provisional\n responses be made, but sessions can continue without them.\n \n If the originating gateway is configured for 'disabled',\n the value of cSipCfgReliable1xxStr will NOT be added to\n either the Require or Supported headers of outgoing INVITEs.\n \n The value 'system' is the default and indicates that this \n dial-peer should use the value of cSipCfgReliable1xxRspHdr\n instead." }, "cSipCfgPeerUrlType": { "type": "string", "description": "This object specifies the URL type sent in outbound\n INVITES generated by this device.\n \n The value 'system' is the default and indicates that this \n dial-peer should use the value of cSipCfgUrlType instead." }, "cSipCfgPeerSwitchTransEnabled": { "type": "boolean", "description": "This object specifies if the functionality of switching\n between transports from UDP to TCP if the message size of a\n Request is greater than 1300 bytes is enabled or not." } } } }, "example": { "CISCO-SIP-UA-MIB:cSipCfgPeerEntry": [ { "cSipCfgPeerIndex": 1, "cSipCfgPeerOutSessionTransport": "192.168.1.1", "cSipCfgPeerReliable1xxRspStr": "192.168.1.1", "cSipCfgPeerReliable1xxRspHdr": "192.168.1.1", "cSipCfgPeerUrlType": "192.168.1.1", "cSipCfgPeerSwitchTransEnabled": true } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipCfgPeerEntry", "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": "/cSipCfgPeerTable/cSipCfgPeerEntry", "x-restconf-kind": "container" }, "/data/CISCO-SIP-UA-MIB:cSipCfgPeerTable/cSipCfgPeerEntry={cSipCfgPeerIndex}": { "get": { "summary": "Get cSipCfgPeerEntry entry", "description": "Retrieve specific cSipCfgPeerEntry entry by key from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "parameters": [ { "name": "cSipCfgPeerIndex", "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": { "cSipCfgPeerIndex": { "type": "integer", "description": "An arbitrary index that uniquely identifies a \n dial-peer configured for SIP.", "minimum": -2147483648, "maximum": 2147483647 }, "cSipCfgPeerOutSessionTransport": { "type": "string", "description": "This object specifies the session transport \n protocol that will be used by this dial-peer\n for outbound SIP messages. \n \n The value 'system' is the default and indicates \n that this dial-peer should use the value set by \n cSipCfgOutSessionTransport instead." }, "cSipCfgPeerReliable1xxRspStr": { "type": "string", "description": "This object specifies the string that will be \n placed in either the Supported or Require SIP \n header, as specified by cSipCfgPeerReliable1xxRspHdr.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cSipCfgPeerReliable1xxRspHdr": { "type": "string", "description": "This object specifies behavior with respect to\n Support or Require headers in SIP messages sent\n and received via this dial-peer.\n \n If the originating gateway is configured for 'require',\n the Require header is added to the outgoing INVITEs\n with the value of cSipCfgPeerReliable1xxStr. This\n requires the use of reliable provisional responses by\n the terminating gateway. Sessions will be torn down\n if this use cannot be supported by that gateway.\n \n If the originating gateway is configured for 'supported',\n the Supported header is added to the outgoing INVITEs\n with the value of cSipCfgPeerReliable1xxStr. This \n requires that an attempt to use reliable provisional\n responses be made, but sessions can continue without them.\n \n If the originating gateway is configured for 'disabled',\n the value of cSipCfgReliable1xxStr will NOT be added to\n either the Require or Supported headers of outgoing INVITEs.\n \n The value 'system' is the default and indicates that this \n dial-peer should use the value of cSipCfgReliable1xxRspHdr\n instead." }, "cSipCfgPeerUrlType": { "type": "string", "description": "This object specifies the URL type sent in outbound\n INVITES generated by this device.\n \n The value 'system' is the default and indicates that this \n dial-peer should use the value of cSipCfgUrlType instead." }, "cSipCfgPeerSwitchTransEnabled": { "type": "boolean", "description": "This object specifies if the functionality of switching\n between transports from UDP to TCP if the message size of a\n Request is greater than 1300 bytes is enabled or not." } } }, "example": { "CISCO-SIP-UA-MIB:cSipCfgPeerEntry": { "cSipCfgPeerIndex": 1, "cSipCfgPeerOutSessionTransport": "192.168.1.1", "cSipCfgPeerReliable1xxRspStr": "192.168.1.1", "cSipCfgPeerReliable1xxRspHdr": "192.168.1.1", "cSipCfgPeerUrlType": "192.168.1.1", "cSipCfgPeerSwitchTransEnabled": true } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipCfgPeerEntry-2" }, "x-yang-path": "/cSipCfgPeerTable/cSipCfgPeerEntry={cSipCfgPeerIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cSipCfgPeerIndex" ] }, "/data/CISCO-SIP-UA-MIB:cSipCfgStatusCauseTable": { "get": { "summary": "Get cSipCfgStatusCauseTable data", "description": "Retrieve cSipCfgStatusCauseTable operational data from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table contains SIP status code to PSTN cause code\n mapping configuration. Inbound SIP response messages \n that will result in outbound PSTN signalling messages\n will have the SIP status codes transposed into the\n PSTN cause codes as prescribed by the contents of this \n table.", "properties": { "cSipCfgStatusCauseEntry": { "type": "array", "description": "A row in the cSipCfgStatusCauseTable. Entries cannot be\n created or destroyed by the actions of any NMS.", "items": { "type": "object", "properties": { "cSipCfgStatusCodeIndex": { "type": "string", "description": "A unique identifier of a row in this table and\n a valid SIP status code.", "x-yang-type": "CISCO-SIP-UA-MIB:CSipStatusCode" }, "cSipCfgPstnCause": { "type": "integer", "description": "The PSTN cause code to which the SIP status code\n given by cSipCfgStatusCodeIndex is to be mapped\n for outbound PSTN signalling messages.", "minimum": -2147483648, "maximum": 2147483647 }, "cSipCfgStatusCauseStoreStatus": { "type": "string", "description": "This object reflects the storage status of this\n table entry. If the value is 'volatile', then\n this entry only exists in RAM and the information\n would be lost (reverting to defaults) on system reload. \n If the value is 'nonVolatile' then this entry has been \n written to NVRAM and will persist across system reloads.", "x-yang-type": "snmpv2-tc:StorageType" } } } } } }, "example": { "CISCO-SIP-UA-MIB:cSipCfgStatusCauseTable": { "cSipCfgStatusCauseEntry": [ { "cSipCfgStatusCodeIndex": "1", "cSipCfgPstnCause": -2147483648, "cSipCfgStatusCauseStoreStatus": "192.168.1.1" }, { "cSipCfgStatusCodeIndex": "2", "cSipCfgPstnCause": -2147483648, "cSipCfgStatusCauseStoreStatus": "192.168.1.1" }, { "cSipCfgStatusCodeIndex": "3", "cSipCfgPstnCause": -2147483648, "cSipCfgStatusCauseStoreStatus": "192.168.1.1" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipCfgStatusCauseTable", "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": "/cSipCfgStatusCauseTable", "x-restconf-kind": "container" }, "/data/CISCO-SIP-UA-MIB:cSipCfgStatusCauseTable/cSipCfgStatusCauseEntry": { "get": { "summary": "Get cSipCfgStatusCauseEntry list", "description": "Retrieve list of cSipCfgStatusCauseEntry entries from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A row in the cSipCfgStatusCauseTable. Entries cannot be\n created or destroyed by the actions of any NMS.", "items": { "type": "object", "properties": { "cSipCfgStatusCodeIndex": { "type": "string", "description": "A unique identifier of a row in this table and\n a valid SIP status code.", "x-yang-type": "CISCO-SIP-UA-MIB:CSipStatusCode" }, "cSipCfgPstnCause": { "type": "integer", "description": "The PSTN cause code to which the SIP status code\n given by cSipCfgStatusCodeIndex is to be mapped\n for outbound PSTN signalling messages.", "minimum": -2147483648, "maximum": 2147483647 }, "cSipCfgStatusCauseStoreStatus": { "type": "string", "description": "This object reflects the storage status of this\n table entry. If the value is 'volatile', then\n this entry only exists in RAM and the information\n would be lost (reverting to defaults) on system reload. \n If the value is 'nonVolatile' then this entry has been \n written to NVRAM and will persist across system reloads.", "x-yang-type": "snmpv2-tc:StorageType" } } } }, "example": { "CISCO-SIP-UA-MIB:cSipCfgStatusCauseEntry": [ { "cSipCfgStatusCodeIndex": "192.168.1.1", "cSipCfgPstnCause": -2147483648, "cSipCfgStatusCauseStoreStatus": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipCfgStatusCauseEntry", "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": "/cSipCfgStatusCauseTable/cSipCfgStatusCauseEntry", "x-restconf-kind": "container" }, "/data/CISCO-SIP-UA-MIB:cSipCfgStatusCauseTable/cSipCfgStatusCauseEntry={cSipCfgStatusCodeIndex}": { "get": { "summary": "Get cSipCfgStatusCauseEntry entry", "description": "Retrieve specific cSipCfgStatusCauseEntry entry by key from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "parameters": [ { "name": "cSipCfgStatusCodeIndex", "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": { "cSipCfgStatusCodeIndex": { "type": "string", "description": "A unique identifier of a row in this table and\n a valid SIP status code.", "x-yang-type": "CISCO-SIP-UA-MIB:CSipStatusCode" }, "cSipCfgPstnCause": { "type": "integer", "description": "The PSTN cause code to which the SIP status code\n given by cSipCfgStatusCodeIndex is to be mapped\n for outbound PSTN signalling messages.", "minimum": -2147483648, "maximum": 2147483647 }, "cSipCfgStatusCauseStoreStatus": { "type": "string", "description": "This object reflects the storage status of this\n table entry. If the value is 'volatile', then\n this entry only exists in RAM and the information\n would be lost (reverting to defaults) on system reload. \n If the value is 'nonVolatile' then this entry has been \n written to NVRAM and will persist across system reloads.", "x-yang-type": "snmpv2-tc:StorageType" } } }, "example": { "CISCO-SIP-UA-MIB:cSipCfgStatusCauseEntry": { "cSipCfgStatusCodeIndex": "192.168.1.1", "cSipCfgPstnCause": -2147483648, "cSipCfgStatusCauseStoreStatus": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipCfgStatusCauseEntry-2" }, "x-yang-path": "/cSipCfgStatusCauseTable/cSipCfgStatusCauseEntry={cSipCfgStatusCodeIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cSipCfgStatusCodeIndex" ] }, "/data/CISCO-SIP-UA-MIB:cSipCfgCauseStatusTable": { "get": { "summary": "Get cSipCfgCauseStatusTable data", "description": "Retrieve cSipCfgCauseStatusTable operational data from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table contains PSTN cause code to SIP status code\n mapping configuration. Inbound PSTN signalling messages\n that will result in outbound SIP response messages \n will have the PSTN cause codes transposed into the\n SIP status codes as prescribed by the contents of this \n table.", "properties": { "cSipCfgCauseStatusEntry": { "type": "array", "description": "A row in the cSipCfgCauseStatusTable. Entries cannot be\n created or destroyed by the actions of any NMS.", "items": { "type": "object", "properties": { "cSipCfgPstnCauseIndex": { "type": "integer", "description": "A unique identifier of a row in this table and\n a valid PSTN cause code.", "minimum": -2147483648, "maximum": 2147483647 }, "cSipCfgStatusCode": { "type": "string", "description": "The SIP status code to which the PSTN cause code\n given by cSipCfgPstnCauseIndex is to be mapped\n for outbound SIP response messages.", "x-yang-type": "CISCO-SIP-UA-MIB:CSipStatusCode" }, "cSipCfgCauseStatusStoreStatus": { "type": "string", "description": "This object reflects the storage status of this\n table entry. If the value is 'volatile', then\n this entry only exists in RAM and the information\n would be lost (reverting to defaults) on system reload. \n If the value is 'nonVolatile' then this entry has been \n written to NVRAM and will persist across system reloads.", "x-yang-type": "snmpv2-tc:StorageType" } } } } } }, "example": { "CISCO-SIP-UA-MIB:cSipCfgCauseStatusTable": { "cSipCfgCauseStatusEntry": [ { "cSipCfgPstnCauseIndex": 1, "cSipCfgStatusCode": "192.168.1.1", "cSipCfgCauseStatusStoreStatus": "192.168.1.1" }, { "cSipCfgPstnCauseIndex": 2, "cSipCfgStatusCode": "192.168.1.1", "cSipCfgCauseStatusStoreStatus": "192.168.1.1" }, { "cSipCfgPstnCauseIndex": 3, "cSipCfgStatusCode": "192.168.1.1", "cSipCfgCauseStatusStoreStatus": "192.168.1.1" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipCfgCauseStatusTable", "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": "/cSipCfgCauseStatusTable", "x-restconf-kind": "container" }, "/data/CISCO-SIP-UA-MIB:cSipCfgCauseStatusTable/cSipCfgCauseStatusEntry": { "get": { "summary": "Get cSipCfgCauseStatusEntry list", "description": "Retrieve list of cSipCfgCauseStatusEntry entries from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A row in the cSipCfgCauseStatusTable. Entries cannot be\n created or destroyed by the actions of any NMS.", "items": { "type": "object", "properties": { "cSipCfgPstnCauseIndex": { "type": "integer", "description": "A unique identifier of a row in this table and\n a valid PSTN cause code.", "minimum": -2147483648, "maximum": 2147483647 }, "cSipCfgStatusCode": { "type": "string", "description": "The SIP status code to which the PSTN cause code\n given by cSipCfgPstnCauseIndex is to be mapped\n for outbound SIP response messages.", "x-yang-type": "CISCO-SIP-UA-MIB:CSipStatusCode" }, "cSipCfgCauseStatusStoreStatus": { "type": "string", "description": "This object reflects the storage status of this\n table entry. If the value is 'volatile', then\n this entry only exists in RAM and the information\n would be lost (reverting to defaults) on system reload. \n If the value is 'nonVolatile' then this entry has been \n written to NVRAM and will persist across system reloads.", "x-yang-type": "snmpv2-tc:StorageType" } } } }, "example": { "CISCO-SIP-UA-MIB:cSipCfgCauseStatusEntry": [ { "cSipCfgPstnCauseIndex": 1, "cSipCfgStatusCode": "192.168.1.1", "cSipCfgCauseStatusStoreStatus": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipCfgCauseStatusEntry", "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": "/cSipCfgCauseStatusTable/cSipCfgCauseStatusEntry", "x-restconf-kind": "container" }, "/data/CISCO-SIP-UA-MIB:cSipCfgCauseStatusTable/cSipCfgCauseStatusEntry={cSipCfgPstnCauseIndex}": { "get": { "summary": "Get cSipCfgCauseStatusEntry entry", "description": "Retrieve specific cSipCfgCauseStatusEntry entry by key from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "parameters": [ { "name": "cSipCfgPstnCauseIndex", "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": { "cSipCfgPstnCauseIndex": { "type": "integer", "description": "A unique identifier of a row in this table and\n a valid PSTN cause code.", "minimum": -2147483648, "maximum": 2147483647 }, "cSipCfgStatusCode": { "type": "string", "description": "The SIP status code to which the PSTN cause code\n given by cSipCfgPstnCauseIndex is to be mapped\n for outbound SIP response messages.", "x-yang-type": "CISCO-SIP-UA-MIB:CSipStatusCode" }, "cSipCfgCauseStatusStoreStatus": { "type": "string", "description": "This object reflects the storage status of this\n table entry. If the value is 'volatile', then\n this entry only exists in RAM and the information\n would be lost (reverting to defaults) on system reload. \n If the value is 'nonVolatile' then this entry has been \n written to NVRAM and will persist across system reloads.", "x-yang-type": "snmpv2-tc:StorageType" } } }, "example": { "CISCO-SIP-UA-MIB:cSipCfgCauseStatusEntry": { "cSipCfgPstnCauseIndex": 1, "cSipCfgStatusCode": "192.168.1.1", "cSipCfgCauseStatusStoreStatus": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipCfgCauseStatusEntry-2" }, "x-yang-path": "/cSipCfgCauseStatusTable/cSipCfgCauseStatusEntry={cSipCfgPstnCauseIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cSipCfgPstnCauseIndex" ] }, "/data/CISCO-SIP-UA-MIB:cSipStatsSuccessOkTable": { "get": { "summary": "Get cSipStatsSuccessOkTable data", "description": "Retrieve cSipStatsSuccessOkTable operational data from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table contains statistics for sent and\n received 200 Ok response messages. The \n statistics are kept on per SIP method basis.", "properties": { "cSipStatsSuccessOkEntry": { "type": "array", "description": "A row in the cSipStatsSuccessOkTable. There is \n an entry for each SIP method for which 200 Ok \n inbound and/or outbound statistics are kept.", "items": { "type": "object", "properties": { "cSipStatsSuccessOkMethod": { "type": "string", "description": "This object is used for instance identification\n of objects in this table. The value reflects a\n SIP method.", "x-yang-type": "CISCO-SIP-UA-MIB:CSipMethodStr" }, "cSipStatsSuccessOkInbounds": { "type": "integer", "description": "This object reflects the total number of Ok\n (200) responses sent by the user agent, since\n system startup, that were associated with the\n SIP method as specified by cSipStatsSuccessOkMethod.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsSuccessOkOutbounds": { "type": "integer", "description": "This object reflects the total number of Ok\n (200) responses received by the user agent, since\n system startup, that were associated with the\n SIP method as specified by cSipStatsSuccessOkMethod.", "minimum": 0, "maximum": 4294967295 } } } } } }, "example": { "CISCO-SIP-UA-MIB:cSipStatsSuccessOkTable": { "cSipStatsSuccessOkEntry": [ { "cSipStatsSuccessOkMethod": "192.168.1.1", "cSipStatsSuccessOkInbounds": 0, "cSipStatsSuccessOkOutbounds": 0 }, { "cSipStatsSuccessOkMethod": "192.168.1.1", "cSipStatsSuccessOkInbounds": 0, "cSipStatsSuccessOkOutbounds": 0 }, { "cSipStatsSuccessOkMethod": "192.168.1.1", "cSipStatsSuccessOkInbounds": 0, "cSipStatsSuccessOkOutbounds": 0 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipStatsSuccessOkTable", "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": "/cSipStatsSuccessOkTable", "x-restconf-kind": "container" }, "/data/CISCO-SIP-UA-MIB:cSipStatsSuccessOkTable/cSipStatsSuccessOkEntry": { "get": { "summary": "Get cSipStatsSuccessOkEntry list", "description": "Retrieve list of cSipStatsSuccessOkEntry entries from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A row in the cSipStatsSuccessOkTable. There is \n an entry for each SIP method for which 200 Ok \n inbound and/or outbound statistics are kept.", "items": { "type": "object", "properties": { "cSipStatsSuccessOkMethod": { "type": "string", "description": "This object is used for instance identification\n of objects in this table. The value reflects a\n SIP method.", "x-yang-type": "CISCO-SIP-UA-MIB:CSipMethodStr" }, "cSipStatsSuccessOkInbounds": { "type": "integer", "description": "This object reflects the total number of Ok\n (200) responses sent by the user agent, since\n system startup, that were associated with the\n SIP method as specified by cSipStatsSuccessOkMethod.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsSuccessOkOutbounds": { "type": "integer", "description": "This object reflects the total number of Ok\n (200) responses received by the user agent, since\n system startup, that were associated with the\n SIP method as specified by cSipStatsSuccessOkMethod.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-SIP-UA-MIB:cSipStatsSuccessOkEntry": [ { "cSipStatsSuccessOkMethod": "192.168.1.1", "cSipStatsSuccessOkInbounds": 0, "cSipStatsSuccessOkOutbounds": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipStatsSuccessOkEntry", "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": "/cSipStatsSuccessOkTable/cSipStatsSuccessOkEntry", "x-restconf-kind": "container" }, "/data/CISCO-SIP-UA-MIB:cSipStatsSuccessOkTable/cSipStatsSuccessOkEntry={cSipStatsSuccessOkMethod}": { "get": { "summary": "Get cSipStatsSuccessOkEntry entry", "description": "Retrieve specific cSipStatsSuccessOkEntry entry by key from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "parameters": [ { "name": "cSipStatsSuccessOkMethod", "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": { "cSipStatsSuccessOkMethod": { "type": "string", "description": "This object is used for instance identification\n of objects in this table. The value reflects a\n SIP method.", "x-yang-type": "CISCO-SIP-UA-MIB:CSipMethodStr" }, "cSipStatsSuccessOkInbounds": { "type": "integer", "description": "This object reflects the total number of Ok\n (200) responses sent by the user agent, since\n system startup, that were associated with the\n SIP method as specified by cSipStatsSuccessOkMethod.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsSuccessOkOutbounds": { "type": "integer", "description": "This object reflects the total number of Ok\n (200) responses received by the user agent, since\n system startup, that were associated with the\n SIP method as specified by cSipStatsSuccessOkMethod.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-SIP-UA-MIB:cSipStatsSuccessOkEntry": { "cSipStatsSuccessOkMethod": "192.168.1.1", "cSipStatsSuccessOkInbounds": 0, "cSipStatsSuccessOkOutbounds": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipStatsSuccessOkEntry-2" }, "x-yang-path": "/cSipStatsSuccessOkTable/cSipStatsSuccessOkEntry={cSipStatsSuccessOkMethod}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cSipStatsSuccessOkMethod" ] }, "/data/CISCO-SIP-UA-MIB:cSipCfgEarlyMediaEntry": { "get": { "summary": "Get cSipCfgEarlyMediaEntry list", "description": "Retrieve list of cSipCfgEarlyMediaEntry entries from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A row in the cSipCfgEarlyMediaTable.\n A row is accessible with a Provisional (1xx)\n status code value (eg, 180) and provides\n an object for the enabling or disabling of\n the Early Media Cut Through functionality.", "items": { "type": "object", "properties": { "cSipCfgEarlyMediaStatusCodeIndex": { "type": "string", "description": "A unique identifier of a row in this table and\n a valid SIP status code.", "x-yang-type": "CISCO-SIP-UA-MIB:CSipStatusCode" }, "cSipCfgEarlyMediaCutThruDisabled": { "type": "boolean", "description": "This object specifies whether Early Media \n Cut Through is enabled or disabled for the \n SIP response messages with status codes that \n match cSipCfgEarlyMediaStatusCodeIndex.\n \n If 'true', early media cut through is disabled,\n and the user agent will process the message as\n though it did not contain any SDP payload.\n \n If 'false', early media cut through is enabled,\n and the user agent will process the message\n similar to a 183 (Session Progress) and cut\n through for early media. The assumption being\n that the SDP is an indication that the far end\n is going to send early media." } } } }, "example": { "CISCO-SIP-UA-MIB:cSipCfgEarlyMediaEntry": [ { "cSipCfgEarlyMediaStatusCodeIndex": "192.168.1.1", "cSipCfgEarlyMediaCutThruDisabled": true } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipCfgEarlyMediaEntry-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": "/cSipCfgEarlyMediaEntry", "x-restconf-kind": "container" }, "/data/CISCO-SIP-UA-MIB:cSipCfgEarlyMediaEntry={cSipCfgEarlyMediaStatusCodeIndex}": { "get": { "summary": "Get cSipCfgEarlyMediaEntry entry", "description": "Retrieve specific cSipCfgEarlyMediaEntry entry by key from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "parameters": [ { "name": "cSipCfgEarlyMediaStatusCodeIndex", "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": { "cSipCfgEarlyMediaStatusCodeIndex": { "type": "string", "description": "A unique identifier of a row in this table and\n a valid SIP status code.", "x-yang-type": "CISCO-SIP-UA-MIB:CSipStatusCode" }, "cSipCfgEarlyMediaCutThruDisabled": { "type": "boolean", "description": "This object specifies whether Early Media \n Cut Through is enabled or disabled for the \n SIP response messages with status codes that \n match cSipCfgEarlyMediaStatusCodeIndex.\n \n If 'true', early media cut through is disabled,\n and the user agent will process the message as\n though it did not contain any SDP payload.\n \n If 'false', early media cut through is enabled,\n and the user agent will process the message\n similar to a 183 (Session Progress) and cut\n through for early media. The assumption being\n that the SDP is an indication that the far end\n is going to send early media." } } }, "example": { "CISCO-SIP-UA-MIB:cSipCfgEarlyMediaEntry": { "cSipCfgEarlyMediaStatusCodeIndex": "192.168.1.1", "cSipCfgEarlyMediaCutThruDisabled": true } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipCfgEarlyMediaEntry-4" }, "x-yang-path": "/cSipCfgEarlyMediaEntry={cSipCfgEarlyMediaStatusCodeIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cSipCfgEarlyMediaStatusCodeIndex" ] }, "/data/CISCO-SIP-UA-MIB:cSipCfgBindSourceAddrEntry": { "get": { "summary": "Get cSipCfgBindSourceAddrEntry list", "description": "Retrieve list of cSipCfgBindSourceAddrEntry entries from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A row in the cSipCfgBindSourceAddrTable.\n A row is accessible with the scope of packets\n to which the source IP address of the interface\n designated by cSipCfgBindSourceAddrInterface\n will be bound.", "items": { "type": "object", "properties": { "cSipCfgBindSourceAddrScope": { "type": "string", "description": "A unique identifier of a row in this table and\n specifies the scope of packets to which the\n source IP address of the interface\n designated by cSipCfgBindSourceAddrInterface\n will be bound." }, "cSipCfgBindSourceAddrInterface": { "type": "string", "description": "This object may specify the interface where the\n source IP address used in SIP signalling or media\n packets is configured. A value of 0 means that\n there is no specific source address configured and\n in this case the best local IP address will be chosen\n by the system.", "x-yang-type": "if-mib:InterfaceIndexOrZero" } } } }, "example": { "CISCO-SIP-UA-MIB:cSipCfgBindSourceAddrEntry": [ { "cSipCfgBindSourceAddrScope": "192.168.1.1", "cSipCfgBindSourceAddrInterface": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipCfgBindSourceAddrEntry-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": "/cSipCfgBindSourceAddrEntry", "x-restconf-kind": "container" }, "/data/CISCO-SIP-UA-MIB:cSipCfgBindSourceAddrEntry={cSipCfgBindSourceAddrScope}": { "get": { "summary": "Get cSipCfgBindSourceAddrEntry entry", "description": "Retrieve specific cSipCfgBindSourceAddrEntry entry by key from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "parameters": [ { "name": "cSipCfgBindSourceAddrScope", "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": { "cSipCfgBindSourceAddrScope": { "type": "string", "description": "A unique identifier of a row in this table and\n specifies the scope of packets to which the\n source IP address of the interface\n designated by cSipCfgBindSourceAddrInterface\n will be bound." }, "cSipCfgBindSourceAddrInterface": { "type": "string", "description": "This object may specify the interface where the\n source IP address used in SIP signalling or media\n packets is configured. A value of 0 means that\n there is no specific source address configured and\n in this case the best local IP address will be chosen\n by the system.", "x-yang-type": "if-mib:InterfaceIndexOrZero" } } }, "example": { "CISCO-SIP-UA-MIB:cSipCfgBindSourceAddrEntry": { "cSipCfgBindSourceAddrScope": "192.168.1.1", "cSipCfgBindSourceAddrInterface": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipCfgBindSourceAddrEntry-4" }, "x-yang-path": "/cSipCfgBindSourceAddrEntry={cSipCfgBindSourceAddrScope}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cSipCfgBindSourceAddrScope" ] }, "/data/CISCO-SIP-UA-MIB:cSipCfgPeerEntry": { "get": { "summary": "Get cSipCfgPeerEntry list", "description": "Retrieve list of cSipCfgPeerEntry entries from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A row in the cSipCfgPeerTable.", "items": { "type": "object", "properties": { "cSipCfgPeerIndex": { "type": "integer", "description": "An arbitrary index that uniquely identifies a \n dial-peer configured for SIP.", "minimum": -2147483648, "maximum": 2147483647 }, "cSipCfgPeerOutSessionTransport": { "type": "string", "description": "This object specifies the session transport \n protocol that will be used by this dial-peer\n for outbound SIP messages. \n \n The value 'system' is the default and indicates \n that this dial-peer should use the value set by \n cSipCfgOutSessionTransport instead." }, "cSipCfgPeerReliable1xxRspStr": { "type": "string", "description": "This object specifies the string that will be \n placed in either the Supported or Require SIP \n header, as specified by cSipCfgPeerReliable1xxRspHdr.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cSipCfgPeerReliable1xxRspHdr": { "type": "string", "description": "This object specifies behavior with respect to\n Support or Require headers in SIP messages sent\n and received via this dial-peer.\n \n If the originating gateway is configured for 'require',\n the Require header is added to the outgoing INVITEs\n with the value of cSipCfgPeerReliable1xxStr. This\n requires the use of reliable provisional responses by\n the terminating gateway. Sessions will be torn down\n if this use cannot be supported by that gateway.\n \n If the originating gateway is configured for 'supported',\n the Supported header is added to the outgoing INVITEs\n with the value of cSipCfgPeerReliable1xxStr. This \n requires that an attempt to use reliable provisional\n responses be made, but sessions can continue without them.\n \n If the originating gateway is configured for 'disabled',\n the value of cSipCfgReliable1xxStr will NOT be added to\n either the Require or Supported headers of outgoing INVITEs.\n \n The value 'system' is the default and indicates that this \n dial-peer should use the value of cSipCfgReliable1xxRspHdr\n instead." }, "cSipCfgPeerUrlType": { "type": "string", "description": "This object specifies the URL type sent in outbound\n INVITES generated by this device.\n \n The value 'system' is the default and indicates that this \n dial-peer should use the value of cSipCfgUrlType instead." }, "cSipCfgPeerSwitchTransEnabled": { "type": "boolean", "description": "This object specifies if the functionality of switching\n between transports from UDP to TCP if the message size of a\n Request is greater than 1300 bytes is enabled or not." } } } }, "example": { "CISCO-SIP-UA-MIB:cSipCfgPeerEntry": [ { "cSipCfgPeerIndex": 1, "cSipCfgPeerOutSessionTransport": "192.168.1.1", "cSipCfgPeerReliable1xxRspStr": "192.168.1.1", "cSipCfgPeerReliable1xxRspHdr": "192.168.1.1", "cSipCfgPeerUrlType": "192.168.1.1", "cSipCfgPeerSwitchTransEnabled": true } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipCfgPeerEntry-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": "/cSipCfgPeerEntry", "x-restconf-kind": "container" }, "/data/CISCO-SIP-UA-MIB:cSipCfgPeerEntry={cSipCfgPeerIndex}": { "get": { "summary": "Get cSipCfgPeerEntry entry", "description": "Retrieve specific cSipCfgPeerEntry entry by key from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "parameters": [ { "name": "cSipCfgPeerIndex", "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": { "cSipCfgPeerIndex": { "type": "integer", "description": "An arbitrary index that uniquely identifies a \n dial-peer configured for SIP.", "minimum": -2147483648, "maximum": 2147483647 }, "cSipCfgPeerOutSessionTransport": { "type": "string", "description": "This object specifies the session transport \n protocol that will be used by this dial-peer\n for outbound SIP messages. \n \n The value 'system' is the default and indicates \n that this dial-peer should use the value set by \n cSipCfgOutSessionTransport instead." }, "cSipCfgPeerReliable1xxRspStr": { "type": "string", "description": "This object specifies the string that will be \n placed in either the Supported or Require SIP \n header, as specified by cSipCfgPeerReliable1xxRspHdr.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cSipCfgPeerReliable1xxRspHdr": { "type": "string", "description": "This object specifies behavior with respect to\n Support or Require headers in SIP messages sent\n and received via this dial-peer.\n \n If the originating gateway is configured for 'require',\n the Require header is added to the outgoing INVITEs\n with the value of cSipCfgPeerReliable1xxStr. This\n requires the use of reliable provisional responses by\n the terminating gateway. Sessions will be torn down\n if this use cannot be supported by that gateway.\n \n If the originating gateway is configured for 'supported',\n the Supported header is added to the outgoing INVITEs\n with the value of cSipCfgPeerReliable1xxStr. This \n requires that an attempt to use reliable provisional\n responses be made, but sessions can continue without them.\n \n If the originating gateway is configured for 'disabled',\n the value of cSipCfgReliable1xxStr will NOT be added to\n either the Require or Supported headers of outgoing INVITEs.\n \n The value 'system' is the default and indicates that this \n dial-peer should use the value of cSipCfgReliable1xxRspHdr\n instead." }, "cSipCfgPeerUrlType": { "type": "string", "description": "This object specifies the URL type sent in outbound\n INVITES generated by this device.\n \n The value 'system' is the default and indicates that this \n dial-peer should use the value of cSipCfgUrlType instead." }, "cSipCfgPeerSwitchTransEnabled": { "type": "boolean", "description": "This object specifies if the functionality of switching\n between transports from UDP to TCP if the message size of a\n Request is greater than 1300 bytes is enabled or not." } } }, "example": { "CISCO-SIP-UA-MIB:cSipCfgPeerEntry": { "cSipCfgPeerIndex": 1, "cSipCfgPeerOutSessionTransport": "192.168.1.1", "cSipCfgPeerReliable1xxRspStr": "192.168.1.1", "cSipCfgPeerReliable1xxRspHdr": "192.168.1.1", "cSipCfgPeerUrlType": "192.168.1.1", "cSipCfgPeerSwitchTransEnabled": true } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipCfgPeerEntry-4" }, "x-yang-path": "/cSipCfgPeerEntry={cSipCfgPeerIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cSipCfgPeerIndex" ] }, "/data/CISCO-SIP-UA-MIB:cSipCfgStatusCauseEntry": { "get": { "summary": "Get cSipCfgStatusCauseEntry list", "description": "Retrieve list of cSipCfgStatusCauseEntry entries from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A row in the cSipCfgStatusCauseTable. Entries cannot be\n created or destroyed by the actions of any NMS.", "items": { "type": "object", "properties": { "cSipCfgStatusCodeIndex": { "type": "string", "description": "A unique identifier of a row in this table and\n a valid SIP status code.", "x-yang-type": "CISCO-SIP-UA-MIB:CSipStatusCode" }, "cSipCfgPstnCause": { "type": "integer", "description": "The PSTN cause code to which the SIP status code\n given by cSipCfgStatusCodeIndex is to be mapped\n for outbound PSTN signalling messages.", "minimum": -2147483648, "maximum": 2147483647 }, "cSipCfgStatusCauseStoreStatus": { "type": "string", "description": "This object reflects the storage status of this\n table entry. If the value is 'volatile', then\n this entry only exists in RAM and the information\n would be lost (reverting to defaults) on system reload. \n If the value is 'nonVolatile' then this entry has been \n written to NVRAM and will persist across system reloads.", "x-yang-type": "snmpv2-tc:StorageType" } } } }, "example": { "CISCO-SIP-UA-MIB:cSipCfgStatusCauseEntry": [ { "cSipCfgStatusCodeIndex": "192.168.1.1", "cSipCfgPstnCause": -2147483648, "cSipCfgStatusCauseStoreStatus": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipCfgStatusCauseEntry-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": "/cSipCfgStatusCauseEntry", "x-restconf-kind": "container" }, "/data/CISCO-SIP-UA-MIB:cSipCfgStatusCauseEntry={cSipCfgStatusCodeIndex}": { "get": { "summary": "Get cSipCfgStatusCauseEntry entry", "description": "Retrieve specific cSipCfgStatusCauseEntry entry by key from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "parameters": [ { "name": "cSipCfgStatusCodeIndex", "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": { "cSipCfgStatusCodeIndex": { "type": "string", "description": "A unique identifier of a row in this table and\n a valid SIP status code.", "x-yang-type": "CISCO-SIP-UA-MIB:CSipStatusCode" }, "cSipCfgPstnCause": { "type": "integer", "description": "The PSTN cause code to which the SIP status code\n given by cSipCfgStatusCodeIndex is to be mapped\n for outbound PSTN signalling messages.", "minimum": -2147483648, "maximum": 2147483647 }, "cSipCfgStatusCauseStoreStatus": { "type": "string", "description": "This object reflects the storage status of this\n table entry. If the value is 'volatile', then\n this entry only exists in RAM and the information\n would be lost (reverting to defaults) on system reload. \n If the value is 'nonVolatile' then this entry has been \n written to NVRAM and will persist across system reloads.", "x-yang-type": "snmpv2-tc:StorageType" } } }, "example": { "CISCO-SIP-UA-MIB:cSipCfgStatusCauseEntry": { "cSipCfgStatusCodeIndex": "192.168.1.1", "cSipCfgPstnCause": -2147483648, "cSipCfgStatusCauseStoreStatus": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipCfgStatusCauseEntry-4" }, "x-yang-path": "/cSipCfgStatusCauseEntry={cSipCfgStatusCodeIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cSipCfgStatusCodeIndex" ] }, "/data/CISCO-SIP-UA-MIB:cSipCfgCauseStatusEntry": { "get": { "summary": "Get cSipCfgCauseStatusEntry list", "description": "Retrieve list of cSipCfgCauseStatusEntry entries from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A row in the cSipCfgCauseStatusTable. Entries cannot be\n created or destroyed by the actions of any NMS.", "items": { "type": "object", "properties": { "cSipCfgPstnCauseIndex": { "type": "integer", "description": "A unique identifier of a row in this table and\n a valid PSTN cause code.", "minimum": -2147483648, "maximum": 2147483647 }, "cSipCfgStatusCode": { "type": "string", "description": "The SIP status code to which the PSTN cause code\n given by cSipCfgPstnCauseIndex is to be mapped\n for outbound SIP response messages.", "x-yang-type": "CISCO-SIP-UA-MIB:CSipStatusCode" }, "cSipCfgCauseStatusStoreStatus": { "type": "string", "description": "This object reflects the storage status of this\n table entry. If the value is 'volatile', then\n this entry only exists in RAM and the information\n would be lost (reverting to defaults) on system reload. \n If the value is 'nonVolatile' then this entry has been \n written to NVRAM and will persist across system reloads.", "x-yang-type": "snmpv2-tc:StorageType" } } } }, "example": { "CISCO-SIP-UA-MIB:cSipCfgCauseStatusEntry": [ { "cSipCfgPstnCauseIndex": 1, "cSipCfgStatusCode": "192.168.1.1", "cSipCfgCauseStatusStoreStatus": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipCfgCauseStatusEntry-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": "/cSipCfgCauseStatusEntry", "x-restconf-kind": "container" }, "/data/CISCO-SIP-UA-MIB:cSipCfgCauseStatusEntry={cSipCfgPstnCauseIndex}": { "get": { "summary": "Get cSipCfgCauseStatusEntry entry", "description": "Retrieve specific cSipCfgCauseStatusEntry entry by key from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "parameters": [ { "name": "cSipCfgPstnCauseIndex", "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": { "cSipCfgPstnCauseIndex": { "type": "integer", "description": "A unique identifier of a row in this table and\n a valid PSTN cause code.", "minimum": -2147483648, "maximum": 2147483647 }, "cSipCfgStatusCode": { "type": "string", "description": "The SIP status code to which the PSTN cause code\n given by cSipCfgPstnCauseIndex is to be mapped\n for outbound SIP response messages.", "x-yang-type": "CISCO-SIP-UA-MIB:CSipStatusCode" }, "cSipCfgCauseStatusStoreStatus": { "type": "string", "description": "This object reflects the storage status of this\n table entry. If the value is 'volatile', then\n this entry only exists in RAM and the information\n would be lost (reverting to defaults) on system reload. \n If the value is 'nonVolatile' then this entry has been \n written to NVRAM and will persist across system reloads.", "x-yang-type": "snmpv2-tc:StorageType" } } }, "example": { "CISCO-SIP-UA-MIB:cSipCfgCauseStatusEntry": { "cSipCfgPstnCauseIndex": 1, "cSipCfgStatusCode": "192.168.1.1", "cSipCfgCauseStatusStoreStatus": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipCfgCauseStatusEntry-4" }, "x-yang-path": "/cSipCfgCauseStatusEntry={cSipCfgPstnCauseIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cSipCfgPstnCauseIndex" ] }, "/data/CISCO-SIP-UA-MIB:cSipStatsSuccessOkEntry": { "get": { "summary": "Get cSipStatsSuccessOkEntry list", "description": "Retrieve list of cSipStatsSuccessOkEntry entries from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A row in the cSipStatsSuccessOkTable. There is \n an entry for each SIP method for which 200 Ok \n inbound and/or outbound statistics are kept.", "items": { "type": "object", "properties": { "cSipStatsSuccessOkMethod": { "type": "string", "description": "This object is used for instance identification\n of objects in this table. The value reflects a\n SIP method.", "x-yang-type": "CISCO-SIP-UA-MIB:CSipMethodStr" }, "cSipStatsSuccessOkInbounds": { "type": "integer", "description": "This object reflects the total number of Ok\n (200) responses sent by the user agent, since\n system startup, that were associated with the\n SIP method as specified by cSipStatsSuccessOkMethod.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsSuccessOkOutbounds": { "type": "integer", "description": "This object reflects the total number of Ok\n (200) responses received by the user agent, since\n system startup, that were associated with the\n SIP method as specified by cSipStatsSuccessOkMethod.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-SIP-UA-MIB:cSipStatsSuccessOkEntry": [ { "cSipStatsSuccessOkMethod": "192.168.1.1", "cSipStatsSuccessOkInbounds": 0, "cSipStatsSuccessOkOutbounds": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipStatsSuccessOkEntry-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": "/cSipStatsSuccessOkEntry", "x-restconf-kind": "container" }, "/data/CISCO-SIP-UA-MIB:cSipStatsSuccessOkEntry={cSipStatsSuccessOkMethod}": { "get": { "summary": "Get cSipStatsSuccessOkEntry entry", "description": "Retrieve specific cSipStatsSuccessOkEntry entry by key from MIB", "tags": [ "CISCO-SIP-UA-MIB" ], "parameters": [ { "name": "cSipStatsSuccessOkMethod", "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": { "cSipStatsSuccessOkMethod": { "type": "string", "description": "This object is used for instance identification\n of objects in this table. The value reflects a\n SIP method.", "x-yang-type": "CISCO-SIP-UA-MIB:CSipMethodStr" }, "cSipStatsSuccessOkInbounds": { "type": "integer", "description": "This object reflects the total number of Ok\n (200) responses sent by the user agent, since\n system startup, that were associated with the\n SIP method as specified by cSipStatsSuccessOkMethod.", "minimum": 0, "maximum": 4294967295 }, "cSipStatsSuccessOkOutbounds": { "type": "integer", "description": "This object reflects the total number of Ok\n (200) responses received by the user agent, since\n system startup, that were associated with the\n SIP method as specified by cSipStatsSuccessOkMethod.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-SIP-UA-MIB:cSipStatsSuccessOkEntry": { "cSipStatsSuccessOkMethod": "192.168.1.1", "cSipStatsSuccessOkInbounds": 0, "cSipStatsSuccessOkOutbounds": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cSipStatsSuccessOkEntry-4" }, "x-yang-path": "/cSipStatsSuccessOkEntry={cSipStatsSuccessOkMethod}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cSipStatsSuccessOkMethod" ] } }, "components": { "schemas": { "CISCO-SIP-UA-MIB_CISCO-SIP-UA-MIB": { "type": "object", "description": "CISCO-SIP-UA-MIB", "properties": { "cSipCfgEarlyMediaEntry": { "type": "array", "description": "A row in the cSipCfgEarlyMediaTable.\n A row is accessible with a Provisional (1xx)\n status code value (eg, 180) and provides\n an object for the enabling or disabling of\n the Early Media Cut Through functionality.", "items": { "type": "object", "properties": { "cSipCfgEarlyMediaStatusCodeIndex": { "type": "string", "description": "A unique identifier of a row in this table and\n a valid SIP status code.", "x-yang-type": "CISCO-SIP-UA-MIB:CSipStatusCode", "readOnly": true }, "cSipCfgEarlyMediaCutThruDisabled": { "type": "boolean", "description": "This object specifies whether Early Media \n Cut Through is enabled or disabled for the \n SIP response messages with status codes that \n match cSipCfgEarlyMediaStatusCodeIndex.\n \n If 'true', early media cut through is disabled,\n and the user agent will process the message as\n though it did not contain any SDP payload.\n \n If 'false', early media cut through is enabled,\n and the user agent will process the message\n similar to a 183 (Session Progress) and cut\n through for early media. The assumption being\n that the SDP is an indication that the far end\n is going to send early media.", "readOnly": true } } }, "readOnly": true }, "cSipCfgBindSourceAddrEntry": { "type": "array", "description": "A row in the cSipCfgBindSourceAddrTable.\n A row is accessible with the scope of packets\n to which the source IP address of the interface\n designated by cSipCfgBindSourceAddrInterface\n will be bound.", "items": { "type": "object", "properties": { "cSipCfgBindSourceAddrScope": { "type": "string", "description": "A unique identifier of a row in this table and\n specifies the scope of packets to which the\n source IP address of the interface\n designated by cSipCfgBindSourceAddrInterface\n will be bound.", "readOnly": true }, "cSipCfgBindSourceAddrInterface": { "type": "string", "description": "This object may specify the interface where the\n source IP address used in SIP signalling or media\n packets is configured. A value of 0 means that\n there is no specific source address configured and\n in this case the best local IP address will be chosen\n by the system.", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true } } }, "readOnly": true }, "cSipCfgPeerEntry": { "type": "array", "description": "A row in the cSipCfgPeerTable.", "items": { "type": "object", "properties": { "cSipCfgPeerIndex": { "type": "integer", "description": "An arbitrary index that uniquely identifies a \n dial-peer configured for SIP.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cSipCfgPeerOutSessionTransport": { "type": "string", "description": "This object specifies the session transport \n protocol that will be used by this dial-peer\n for outbound SIP messages. \n \n The value 'system' is the default and indicates \n that this dial-peer should use the value set by \n cSipCfgOutSessionTransport instead.", "readOnly": true }, "cSipCfgPeerReliable1xxRspStr": { "type": "string", "description": "This object specifies the string that will be \n placed in either the Supported or Require SIP \n header, as specified by cSipCfgPeerReliable1xxRspHdr.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cSipCfgPeerReliable1xxRspHdr": { "type": "string", "description": "This object specifies behavior with respect to\n Support or Require headers in SIP messages sent\n and received via this dial-peer.\n \n If the originating gateway is configured for 'require',\n the Require header is added to the outgoing INVITEs\n with the value of cSipCfgPeerReliable1xxStr. This\n requires the use of reliable provisional responses by\n the terminating gateway. Sessions will be torn down\n if this use cannot be supported by that gateway.\n \n If the originating gateway is configured for 'supported',\n the Supported header is added to the outgoing INVITEs\n with the value of cSipCfgPeerReliable1xxStr. This \n requires that an attempt to use reliable provisional\n responses be made, but sessions can continue without them.\n \n If the originating gateway is configured for 'disabled',\n the value of cSipCfgReliable1xxStr will NOT be added to\n either the Require or Supported headers of outgoing INVITEs.\n \n The value 'system' is the default and indicates that this \n dial-peer should use the value of cSipCfgReliable1xxRspHdr\n instead.", "readOnly": true }, "cSipCfgPeerUrlType": { "type": "string", "description": "This object specifies the URL type sent in outbound\n INVITES generated by this device.\n \n The value 'system' is the default and indicates that this \n dial-peer should use the value of cSipCfgUrlType instead.", "readOnly": true }, "cSipCfgPeerSwitchTransEnabled": { "type": "boolean", "description": "This object specifies if the functionality of switching\n between transports from UDP to TCP if the message size of a\n Request is greater than 1300 bytes is enabled or not.", "readOnly": true } } }, "readOnly": true }, "cSipCfgStatusCauseEntry": { "type": "array", "description": "A row in the cSipCfgStatusCauseTable. Entries cannot be\n created or destroyed by the actions of any NMS.", "items": { "type": "object", "properties": { "cSipCfgStatusCodeIndex": { "type": "string", "description": "A unique identifier of a row in this table and\n a valid SIP status code.", "x-yang-type": "CISCO-SIP-UA-MIB:CSipStatusCode", "readOnly": true }, "cSipCfgPstnCause": { "type": "integer", "description": "The PSTN cause code to which the SIP status code\n given by cSipCfgStatusCodeIndex is to be mapped\n for outbound PSTN signalling messages.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cSipCfgStatusCauseStoreStatus": { "type": "string", "description": "This object reflects the storage status of this\n table entry. If the value is 'volatile', then\n this entry only exists in RAM and the information\n would be lost (reverting to defaults) on system reload. \n If the value is 'nonVolatile' then this entry has been \n written to NVRAM and will persist across system reloads.", "x-yang-type": "snmpv2-tc:StorageType", "readOnly": true } } }, "readOnly": true }, "cSipCfgCauseStatusEntry": { "type": "array", "description": "A row in the cSipCfgCauseStatusTable. Entries cannot be\n created or destroyed by the actions of any NMS.", "items": { "type": "object", "properties": { "cSipCfgPstnCauseIndex": { "type": "integer", "description": "A unique identifier of a row in this table and\n a valid PSTN cause code.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cSipCfgStatusCode": { "type": "string", "description": "The SIP status code to which the PSTN cause code\n given by cSipCfgPstnCauseIndex is to be mapped\n for outbound SIP response messages.", "x-yang-type": "CISCO-SIP-UA-MIB:CSipStatusCode", "readOnly": true }, "cSipCfgCauseStatusStoreStatus": { "type": "string", "description": "This object reflects the storage status of this\n table entry. If the value is 'volatile', then\n this entry only exists in RAM and the information\n would be lost (reverting to defaults) on system reload. \n If the value is 'nonVolatile' then this entry has been \n written to NVRAM and will persist across system reloads.", "x-yang-type": "snmpv2-tc:StorageType", "readOnly": true } } }, "readOnly": true }, "cSipStatsSuccessOkEntry": { "type": "array", "description": "A row in the cSipStatsSuccessOkTable. There is \n an entry for each SIP method for which 200 Ok \n inbound and/or outbound statistics are kept.", "items": { "type": "object", "properties": { "cSipStatsSuccessOkMethod": { "type": "string", "description": "This object is used for instance identification\n of objects in this table. The value reflects a\n SIP method.", "x-yang-type": "CISCO-SIP-UA-MIB:CSipMethodStr", "readOnly": true }, "cSipStatsSuccessOkInbounds": { "type": "integer", "description": "This object reflects the total number of Ok\n (200) responses sent by the user agent, since\n system startup, that were associated with the\n SIP method as specified by cSipStatsSuccessOkMethod.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsSuccessOkOutbounds": { "type": "integer", "description": "This object reflects the total number of Ok\n (200) responses received by the user agent, since\n system startup, that were associated with the\n SIP method as specified by cSipStatsSuccessOkMethod.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true }, "cSipCfgBase": { "type": "object", "description": "This object will reflect the version of SIP supported by this \n user agent. It will follow the same format as SIP version \n information contained in the SIP messages generated by this\n user agent. For example, user agents supporting SIP version 2\n will return 'SIP/2.0' as dictated by RFC 2543.", "properties": { "cSipCfgVersion": { "type": "string", "description": "This object will reflect the version of SIP supported by this \n user agent. It will follow the same format as SIP version \n information contained in the SIP messages generated by this\n user agent. For example, user agents supporting SIP version 2\n will return 'SIP/2.0' as dictated by RFC 2543.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cSipCfgTransport": { "type": "string", "description": "This object specifies the transport protocol the SIP user \n agent will use to receive SIP messages. A value of 'disabled'\n indicates that the UA will not receive any SIP messages.", "readOnly": true }, "cSipCfgUserLocationServerAddr": { "type": "string", "description": "This object specifies address of the User Location \n Server (ULS) being used to resolve the location of end \n points. This could be a Domain Name Server (DNS) or a \n SIP proxy/redirect server.\n \n The format of the address follows the IETF service location \n protocol. The syntax is as follows:\n \n mapping-type:type-specific-syntax\n \n the mapping-type specifies a scheme for mapping the matching \n dial string to a target server. The type-specific-syntax is \n exactly that, something that the particular mapping scheme can\n understand. For example,\n Session target Meaning\n ipv4:171.68.13.55:1006 The session target is the IP \n version 4 address of 171.68.13.55 \n and port 1006.\n dns:pots.cisco.com The session target is the IP host \n with dns name pots.cisco.com.\n \n The valid Mapping type definitions for the peer follow:\n ipv4 - Syntax: ipv4:w.x.y.z:port or ipv4:w.x.y.z \n dns - Syntax: dns:host.domain.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cSipCfgMaxForwards": { "type": "integer", "description": "This object may be used with any SIP method to limit the \n number of proxies that can forward the request to the next \n downstream server.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cSipCfgBindSrcAddrInterface": { "type": "string", "description": "This object may specify the interface where the\n source IP address used in SIP signalling or media\n packets is configured. A value of 0 means that \n there is no specific source address configured and \n in this case the best local IP address will be chosen \n by the system.", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true }, "cSipCfgBindSrcAddrScope": { "type": "string", "description": "This object specifies the scope of packets to\n which the source IP address of the interface \n designated by cSipCfgBindSrcAddrInterface\n will be bound. A value of 'all' means the IP address \n will be bound to both SIP signalling and media packets.\n A value of 'control' means the IP address will only\n be bound to SIP signalling packets. \n If cSipCfgBindSrcAddrInterface is set to 0,\n the value of this object has no meaning.", "readOnly": true }, "cSipCfgDnsSrvQueryStringFormat": { "type": "string", "description": "This object specifies the format of the prefix used \n by the system for DNS SRV queries.\n \n v1 : RFC 2052 format - 'protocol.transport.'\n v2 : RFC 2782 format - '_protocol._transport.'\n \n This object allows backward compatibility with systems\n only supporting RFC 2052 format.", "readOnly": true }, "cSipCfgRedirectionDisabled": { "type": "boolean", "description": "This object specifies how call redirection (3xx)\n is handled by the user agent. \n \n If 'false', the user agent's treatment of incoming \n 3xx class response messages is as defined in RFC 2543. \n That is, the user agent uses the Contact header(s)\n from the 3xx response to reinitiate another INVITE\n transaction to the user's new location. The call \n is redirected.\n \n If 'true', the user agent treats incoming 3xx \n response messages as 4xx (client error) class \n response messages. In this case, the call is not\n redirected, instead it is released with the \n appropriate PSTN cause code.\n \n The mapping of SIP 3xx response status codes to\n 4xx response status codes is as follows:\n 300 Multiple Choices -> 410 Gone\n 301 Moved Permanently -> 410 Gone\n 302 Moved Temporarily -> 480 Temporarily Unavailable\n 305 User Proxy -> 410 Gone\n 380 Alternative Service -> 410 Gone\n Any other 3xx -> 410 Gone", "readOnly": true }, "cSipCfgSymNatEnabled": { "type": "boolean", "description": "This object specifies whether remote media checks\n for Symmetric Network Address Translation (NAT) \n is enabled or disabled.\n \n If 'true', remote media checks are enabled. The\n gateway will have the ability to open a Real Time \n Transport Protocol (RTP) session with the remote\n end and then update (modify) the existing RTP\n session's remote address/port (raddr:rport) with\n the source address and port of the actual media\n packet received. This would be triggered for only\n those calls where the Session Description Protocol\n (SDP) received by the gateway has an indication to\n do so.\n \n If 'false', remote media checks are disabled.", "readOnly": true }, "cSipCfgSymNatDirectionRole": { "type": "string", "description": "This object specifies the value of the\n 'a=direction:' SDP attribute supported by \n the user agent. The direction attribute is used \n to describe the role of the user agent (as an \n endpoint for a connection-oriented media stream) \n in the connection setup procedure.\n \n none : No role is specified.\n passive : The user agent will advertise itself\n as a 'passive' entity (inside the NAT)\n in the SDP.\n active : The user agent will advertise itself\n as a 'active' entity (outside the NAT)\n in the SDP.", "readOnly": true }, "cSipCfgSuspendResumeEnabled": { "type": "boolean", "description": "This object specifies if support for handling \n Suspend/Resume events from the switch is enabled or not.\n \n If 'true', the user agent on getting a Suspend will\n notify the remote agent by sending it a re-invite with\n a hold SDP. Similarly, when the Gateway receives a Resume, it\n will initiate a re-invite with the original SDP and unhold the\n call.\n \n If 'false', the user agent will not initiate any re-invites\n on receiving Suspend/Resume events, basically it won't be\n putting the call on hold or off hold.", "readOnly": true }, "cSipCfgOfferCallHold": { "type": "string", "description": "This object specifies how the SIP gateway would initiate call\n hold requests.\n \n directionAttr: The user agent will use the direction\n attribute such as a=sendonly or a=inactive in\n the sdp to initiate call hold requests.\n \n connAddr: The user agent will use 0.0.0.0 connection address\n to specify Call Hold.", "readOnly": true }, "cSipCfgReasonHeaderOveride": { "type": "boolean", "description": "This object specifies that the Reason header overrides SIP \n status code mapping table.", "readOnly": true }, "cSipCfgMaximumForwards": { "type": "integer", "description": "This object may be used with any SIP method to limit the \n number of proxies that can forward the request to the next \n downstream server.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true } }, "readOnly": true }, "cSipCfgTimer": { "type": "object", "description": "This object specifies the time a user agent will wait to \n receive a provisional response to a INVITE before resending \n the INVITE.", "properties": { "cSipCfgTimerTrying": { "type": "integer", "description": "This object specifies the time a user agent will wait to \n receive a provisional response to a INVITE before resending \n the INVITE.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cSipCfgTimerExpires": { "type": "integer", "description": "This object specifies the time a user agent will wait to \n receive a final response to a INVITE before cancelling the \n transaction.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cSipCfgTimerConnect": { "type": "integer", "description": "This object specifies the time a user agent will wait to \n receive an ACK confirmation a session is established.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cSipCfgTimerDisconnect": { "type": "integer", "description": "This object specifies the time a user agent will wait to \n receive an BYE confirmation a session is disconnected.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cSipCfgTimerPrack": { "type": "integer", "description": "This object specifies the time a user agent will wait for \n a final response before retransmitting the PRACK (PRovisional\n ACKnowledgment).", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cSipCfgTimerComet": { "type": "integer", "description": "This object specifies the time a user agent will wait \n for a final response before retransmitting the COMET \n (COndition MET).", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cSipCfgTimerReliableRsp": { "type": "integer", "description": "This object specifies the amount of time to wait for a\n PRACK before retransmitting the reliable 1xx response.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cSipCfgTimerNotify": { "type": "integer", "description": "This object specifies the amount of time to wait for a\n final response before retransmitting the Notify.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cSipCfgTimerRefer": { "type": "integer", "description": "This object specifies the amount of time to wait for a\n final response before retransmitting the Refer.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cSipCfgTimerSessionTimer": { "type": "integer", "description": "This object specifies the value of the Min-SE \n header for INVITE messages originated by this \n user agent and the minimum value of the \n Session-Expires headers for INVITE messages \n received by this user agent.\n \n Any Session-Expires headers received with a \n value below this object's value will be rejected\n with a 422 client error response message.\n \n Setting this object to a value less than 600 is\n valid, but the possibly of excessive re-INVITES \n and the impact of those messages should be fully \n understood and considered an acceptable risk.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cSipCfgTimerHold": { "type": "integer", "description": "This object specifies the amount of time to wait before \n disconnecting a call already on hold. A value of 0 specifies\n that this functionality is disabled.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cSipCfgTimerInfo": { "type": "integer", "description": "This object specifies the amount of time to wait for a\n 200ok response before retransmitting the Info.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cSipCfgTimerConnectionAging": { "type": "integer", "description": "This object specifies the amount of time to wait before \n aging out a TCP/UDP connection.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cSipCfgTimerBufferInvite": { "type": "integer", "description": "This object specifies the amount of time to buffer the INVITE \n while waiting for display name info in the Facility.\n \n A value of 0 means that the INVITE wouldn't be buffered\n waiting for the display name info in the Facility.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true } }, "readOnly": true }, "cSipCfgRetry": { "type": "object", "description": "This object specifies the number of times a user agent \n will retry sending a INVITE request.", "properties": { "cSipCfgRetryInvite": { "type": "integer", "description": "This object specifies the number of times a user agent \n will retry sending a INVITE request.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cSipCfgRetryBye": { "type": "integer", "description": "This object specifies the number of times a user agent \n will retry sending a BYE request.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cSipCfgRetryCancel": { "type": "integer", "description": "This object specifies the number of times a user agent \n will retry sending a CANCEL request.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cSipCfgRetryRegister": { "type": "integer", "description": "This object specifies the number of times a user agent \n will retry sending a REGISTER request.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cSipCfgRetryResponse": { "type": "integer", "description": "This object specifies the number of times a user agent \n will retry sending a Response and expecting a ACK.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cSipCfgRetryPrack": { "type": "integer", "description": "This object specifies the number of times a user agent \n will retry sending a PRACK (PRovisional ACKnowledgement).", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cSipCfgRetryComet": { "type": "integer", "description": "This object specifies the number of times a user agent \n will retry sending a COMET (COndition MET).", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cSipCfgRetryReliableRsp": { "type": "integer", "description": "This object specifies the number of times a user agent \n will retry sending a reliable response.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cSipCfgRetryNotify": { "type": "integer", "description": "This object specifies the number of times a user agent \n will retry sending a Notify request.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cSipCfgRetryRefer": { "type": "integer", "description": "This object specifies the number of times a user agent \n will retry sending a Refer request.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cSipCfgRetryInfo": { "type": "integer", "description": "This object specifies the number of times a user agent\n will retry sending a Info request.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cSipCfgRetrySubscribe": { "type": "integer", "description": "This object specifies the number of times a user agent\n will retry sending a Subscribe request.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true } }, "readOnly": true }, "cSipCfgPeer": { "type": "object", "description": "cSipCfgPeer", "properties": { "cSipCfgOutSessionTransport": { "type": "string", "description": "This object specifies the session transport \n protocol that will be used for outbound SIP \n messages. This configuration is applicable\n to all dial-peers in the system having \n cSipCfgPeerOutSessionTransport set to 'system'.", "readOnly": true }, "cSipCfgReliable1xxRspStr": { "type": "string", "description": "This object specifies the string that will be \n placed in either the Supported or Require SIP \n header, as specified by cSipCfgReliable1xxRspHdr.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cSipCfgReliable1xxRspHdr": { "type": "string", "description": "This object specifies behavior with respect to\n Supported or Require headers in SIP messages sent\n and received via this dial-peer.\n \n If the originating gateway is configured for 'require',\n the Require header is added to the outgoing INVITEs\n with the value of cSipCfgReliable1xxStr. This\n requires the use of reliable provisional responses by\n the terminating gateway. Sessions will be torn down\n if this use cannot be supported by that gateway.\n \n If the originating gateway is configured for 'supported',\n the Supported header is added to the outgoing INVITEs\n with the value of cSipCfgReliable1xxStr. This \n requires that an attempt to use reliable provisional\n responses be made, but sessions can continue without them.\n \n If the originating gateway is configured for 'disabled',\n the value of cSipCfgReliable1xxStr will NOT be added to\n either the Require or Supported headers of outgoing INVITEs.", "readOnly": true }, "cSipCfgUrlType": { "type": "string", "description": "This object specifies the URL type sent in outbound\n INVITES generated by this device.", "readOnly": true } }, "readOnly": true }, "cSipCfgAaa": { "type": "object", "description": "This object specifies the source of the information used to\n populate the username attribute of AAA billing records.", "properties": { "cSipCfgAaaUsername": { "type": "string", "description": "This object specifies the source of the information used to\n populate the username attribute of AAA billing records.", "readOnly": true } }, "readOnly": true }, "cSipCfgVoiceServiceVoip": { "type": "object", "description": "cSipCfgVoiceServiceVoip", "properties": { "cSipCfgHeaderPassingEnabled": { "type": "boolean", "description": "This object specifies if support for passing\n SIP headers from Invite, Subscribe, Notify Request to the\n application is enabled.\n \n If 'true', the headers received in a message will be passed\n to the application.\n \n If 'false', the headers received in a message will not be\n passed to the application.", "readOnly": true }, "cSipCfgMaxSubscriptionAccept": { "type": "integer", "description": "This object specifies the maximum number of concurrent SIP\n subscriptions a SIP Gateway can accept.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipCfgMaxSubscriptionOriginate": { "type": "integer", "description": "This object specifies the maximum number of concurrent SIP\n subscriptions that a SIP Gateway can originate. Default is Max\n Dialpeers on platform. Maximum is 2*Max Dialpeers on\n Platform.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipCfgSwitchTransportEnabled": { "type": "boolean", "description": "This object specifies if the functionality of switching\n between transports from udp to tcp if the message size of a\n Request is greater than 1300 bytes is enabled or not.\n \n This configuration is at the global level, and will only be \n considered if there exists no voip dial-peer.", "readOnly": true } }, "readOnly": true }, "cSipStatsInfo": { "type": "object", "description": "cSipStatsInfo", "properties": { "cSipStatsInfoTryingIns": { "type": "integer", "description": "This object reflects the total number of Trying\n (100) responses received by the user agent since system startup. \n Trying responses indicate that some unspecified\n action is being taken on behalf of this call, but\n the user has not yet been located. Inbound Trying\n responses indicate that outbound INVITE request \n sent out by this system have been received and\n are processed.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsInfoTryingOuts": { "type": "integer", "description": "This object reflects the total number of Trying\n (100) responses sent by the user agent since system startup.\n Trying responses indicate that some unspecified\n action is being taken on behalf of this call, but\n the user has not yet been located. Outbound Trying\n responses indicate this system is successfully \n receiving INVITE requests and processing them on \n behalf of the system initiating the INVITE.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsInfoRingingIns": { "type": "integer", "description": "This object reflects the total number of Ringing\n (180) responses received by the user agent since system startup.\n A inbound Ringing response indicates that the UAS\n processing a INVITE initiated by this system has \n found a possible location where the desired end user \n has registered recently and is trying to alert the user.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsInfoRingingOuts": { "type": "integer", "description": "This object reflects the total number of Ringing\n (180) responses sent by the user agent since system startup.\n A outbound Ringing response indicates that this\n system has processed an INVITE for a particular\n end user and found a possible location where that\n user has registered recently. The system is trying\n to alert the end user and is conveying that status\n to the system that originated the INVITE.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsInfoForwardedIns": { "type": "integer", "description": "This object reflects the total number of Call Is Being\n Forwarded (181) responses received by the user agent since system startup.\n A proxy server may use a Forwarded status code to\n indicate that the call is being forwarded to a different\n set of destinations. Inbound Forwarded responses indicate \n to this system that forwarding actions are taking place \n with regard to calls initiated by this system.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsInfoForwardedOuts": { "type": "integer", "description": "This object reflects the total number of Call Is Being\n Forwarded (181) responses sent by the user agent since system startup.\n A proxy server may use a Forwarded status code to\n indicate that the call is being forwarded to a different\n set of destinations. Outbound Forwarded responses\n indicate this system is taking some forwarding action\n for calls and conveying that status to the system that\n initiated the calls.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsInfoQueuedIns": { "type": "integer", "description": "This object reflects the total number of Queued\n (182) responses received by the user agent since system startup.\n Inbound Queued responses indicate that the users\n this system is attempting to call are temporarily\n unavailable but the SIP agents operating on behalf\n of those users wish to queue the calls rather than\n reject them. When the called parties become available,\n this system can expect to receive the appropriate\n final status response. The Reason-Phrase from the\n Queued response messages Status-Line may give further\n details about the status of the call. Multiple \n Queued responses to update this system about the status\n of the queued call my be received.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsInfoQueuedOuts": { "type": "integer", "description": "This object reflects the total number of Queued\n (182) responses sent by the user agent since system startup.\n Outbound Queued responses indicate this system\n has determined that the called party is temporarily\n unavailable but the call is not rejected. Rather \n the call is queued until the called party becomes\n available. Queued responses messages are sent to\n the system originating the call request to convey\n the current status of a queued call.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsInfoSessionProgIns": { "type": "integer", "description": "This object reflects the total number of Session\n Progress (183) responses received by the user agent since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsInfoSessionProgOuts": { "type": "integer", "description": "This object reflects the total number of Session\n Progress (183) responses sent by the user agent since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true } }, "readOnly": true }, "cSipStatsSuccess": { "type": "object", "description": "cSipStatsSuccess", "properties": { "cSipStatsSuccessOkIns": { "type": "integer", "description": "This object reflects the total number of Ok\n (200) responses received by the user agent since system startup.\n The meaning of inbound Ok responses depends\n on the method used in the associated request.\n \n BYE : The Ok response means the call has \n been terminated.\n \n CANCEL : The Ok response means the search for \n the end user has been cancelled.\n \n INVITE : The Ok response means the called party \n has agreed to participate in the call.\n \n OPTIONS : The Ok response means the called party \n has agreed to share its capabilities.\n \n REGISTER : The Ok response means the registration\n has succeeded.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsSuccessOkOuts": { "type": "integer", "description": "This object reflects the total number of Ok\n (200) responses sent by the user agent since system startup.\n The meaning of outbound Ok responses depends\n on the method used in the associated request.\n \n BYE : The Ok response means the call has \n been terminated.\n \n CANCEL : The Ok response means the search for \n the end user has been cancelled.\n \n INVITE : The Ok response means the called party \n has agreed to participate in the call.\n \n OPTIONS : The Ok response means the called party \n has agreed to share its capabilities.\n \n REGISTER : The Ok response means the registration\n has succeeded.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsSuccessAcceptedIns": { "type": "integer", "description": "This object reflects the total number of Accepted\n (202) responses received by the user agent since system startup.\n The meaning of outbound 202 Ok responses depends\n on the method used in the associated request.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsSuccessAcceptedOuts": { "type": "integer", "description": "This object reflects the total number of Accepted\n (202) responses sent by the user agent since system startup.\n The meaning of outbound 202 Ok responses depends\n on the method used in the associated request.", "minimum": 0, "maximum": 4294967295, "readOnly": true } }, "readOnly": true }, "cSipStatsRedirect": { "type": "object", "description": "This object reflects the total number of Multiple\n Choices (300) responses received by the user agent since system startup.\n Multiple Choices responses indicate that the called\n party can be reached at several different locations\n and the server cannot or prefers not to proxy the request.", "properties": { "cSipStatsRedirMultipleChoices": { "type": "integer", "description": "This object reflects the total number of Multiple\n Choices (300) responses received by the user agent since system startup.\n Multiple Choices responses indicate that the called\n party can be reached at several different locations\n and the server cannot or prefers not to proxy the request.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsRedirMovedPerms": { "type": "integer", "description": "This object reflects the total number of Moved \n Permanently (301) responses received by the user agent since system startup.\n Moved Permanently responses indicate that the called party \n can no longer be found at the address offered in the request \n and the requesting UAC should retry at the new address given \n by the Contact header field of the response.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsRedirMovedTemps": { "type": "integer", "description": "This object reflects the total number of Moved \n Temporarily (302) responses received by the user agent since system startup.\n Moved Temporarily responses indicate the UAC should\n retry the request directed at the new address(es)\n given by the Contact header field of the response.\n The duration of this redirection can be indicated\n through the Expires header. If no explicit expiration\n time is given, the new address(es) are only valid\n for this call.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsRedirSeeOthers": { "type": "integer", "description": "This object reflects the total number of See Other \n (303) responses received by the user agent since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsRedirUseProxys": { "type": "integer", "description": "This object reflects the total number of Use Proxy \n (305) responses received by the user agent since system startup.\n See Other responses indicate that requested resources\n must be accessed through the proxy given by the \n Contact header field of the response. The recipient\n of this response is expected to repeat this single\n request via the proxy.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsRedirAltServices": { "type": "integer", "description": "This object reflects the total number of Alternative\n Service (380) responses received by the user agent since system startup.\n Alternative Service responses indicate that the call\n was not successful, but alternative services are\n possible. Those alternative services are described\n in the message body of the response.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsRedirMovedTempsIns": { "type": "integer", "description": "This object reflects the total number of Moved\n Temporarily (302) responses received by the user agent since\n system startup. \n Moved Temporarily responses indicate the UAC should\n retry the request directed at the new address(es) \n given by the Contact header field of the response.\n The duration of this redirection can be indicated\n through the Expires header. If no explicit expiration\n time is given, the new address(es) are only valid\n for this call.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsRedirMovedTempsOuts": { "type": "integer", "description": "This object reflects the total number of Moved\n Temporarily (302) responses sent by the user agent since\n system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true } }, "readOnly": true }, "cSipStatsErrClient": { "type": "object", "description": "This object reflects the total number of Bad Request (400) \n responses received by the user agent since system startup.\n Inbound Bad Request responses indicate that requests issued \n by this system could not be understood due to malformed \n syntax.", "properties": { "cSipStatsClientBadRequestIns": { "type": "integer", "description": "This object reflects the total number of Bad Request (400) \n responses received by the user agent since system startup.\n Inbound Bad Request responses indicate that requests issued \n by this system could not be understood due to malformed \n syntax.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientBadRequestOuts": { "type": "integer", "description": "This object reflects the total number of Bad Request (400) \n responses sent by the user agent since system startup.\n Outbound Bad Request responses indicate that requests \n received by this system could not be understood due to \n malformed syntax.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientUnauthorizedIns": { "type": "integer", "description": "This object reflects the total number of Unauthorized (401) \n responses received by the user agent since system startup. \n Inbound Unauthorized responses indicate that requests issued \n by this system require user authentication.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientUnauthorizedOuts": { "type": "integer", "description": "This object reflects the total number of Unauthorized (401) \n responses sent by the user agent since system startup.\n Outbound Unauthorized responses indicate that requests \n received by this system require user authentication.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientPaymentReqdIns": { "type": "integer", "description": "This object reflects the total number of Payment Required \n (402) responses received by the user agent since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientPaymentReqdOuts": { "type": "integer", "description": "This object reflects the total number of Payment Required \n (402) responses sent by the user agent since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientForbiddenIns": { "type": "integer", "description": "This object reflects the total number of Forbidden (403) \n responses received by the user agent since system startup.\n Inbound Forbidden responses indicate that requests issued\n by this system are understood by the server but the server\n refuses to fulfill the request. Authorization will not help\n and the requests should not be repeated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientForbiddenOuts": { "type": "integer", "description": "This object reflects the total number of Forbidden (403) \n responses sent by the user agent since system startup.\n Outbound Forbidden responses indicate that requests received\n by this system are understood but this system is refusing to\n fulfill the requests.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientNotFoundIns": { "type": "integer", "description": "This object reflects the total number of Not Found (404) \n responses received by the user agent since system startup.\n Inbound Not Found responses indicate that the called party \n does not exist at the domain specified in the Request-URI \n or the domain is not handled by the recipient of the request.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientNotFoundOuts": { "type": "integer", "description": "This object reflects the total number of Not Found (404) \n responses sent by the user agent since system startup.\n Outbound Not Found responses indicate that this system\n knows that the called party does not exist at the domain\n specified in the Request-URI or the domain is not handled\n by this system.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientMethNotAllowedIns": { "type": "integer", "description": "This object reflects the total number of Method Not Allowed \n (405) received responses by the user agent.\n Inbound Method Not Allowed responses indicate that requests \n issued by this system have specified a SIP method in the \n Request-Line that is not allowed for the address identified \n by the Request-URI.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientMethNotAllowedOuts": { "type": "integer", "description": "This object reflects the total number of Method Not Allowed \n (405) received sent by the user agent since system startup.\n Outbound Method Not Allowed responses indicate that requests \n received by this system have SIP methods specified in the \n Request-Line that are not allowed for the address identified \n by the Request-URI.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientNotAcceptableIns": { "type": "integer", "description": "This object reflects the total number of Not Acceptable \n (406) responses received by the user agent since system startup.\n Inbound Not Acceptable responses indicate the resources \n identified by requests issued by this system cannot generate \n responses with content characteristics acceptable to this \n system according to the accept headers sent in the requests.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientNotAcceptableOuts": { "type": "integer", "description": "This object reflects the total number of Not Acceptable (406) \n responses sent by the user agent since system startup.\n Outbound Not Acceptable responses indicate that the resources\n identified by requests received by this system cannot generate\n responses with content characteristics acceptable to the \n system sending the requests.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientProxyAuthReqdIns": { "type": "integer", "description": "This object reflects the total number of Proxy Authentication \n Required (407) responses received by the user agent since system startup.\n Inbound Proxy Authentication Required responses indicate that \n this system must authenticate itself with the proxy before \n gaining access to the requested resource.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientProxyAuthReqdOuts": { "type": "integer", "description": "This object reflects the total number of Proxy Authentication \n Required (407) responses sent by the user agent since system startup.\n Outbound Proxy Authentication Required responses indicate that\n the systems issuing requests being processed by this system \n must authenticate themselves with this system before gaining \n access to requested resources.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientReqTimeoutIns": { "type": "integer", "description": "This object reflects the total number of Request Timeout \n (408) responses received by the user agent since system startup.\n Inbound Request Timeout responses indicate that requests \n issued by this system are not being processed by the server \n within the time indicated in the Expires header of the \n request.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientReqTimeoutOuts": { "type": "integer", "description": "This object reflects the total number of Request Timeout \n (408) responses sent by the user agent since system startup.\n Outbound Request Timeout responses indicate that this \n system is not able to produce an appropriate response within \n the time indicated in the Expires header of the request.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientConflictIns": { "type": "integer", "description": "This object reflects the total number of Conflict (409) \n responses received by the user agent since system startup.\n Inbound Conflict responses indicate that requests issued\n by this system could not be completed due to a conflict\n with the current state of a requested resource.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientConflictOuts": { "type": "integer", "description": "This object reflects the total number of Conflict (409) \n responses sent by the user agent since system startup.\n Outbound Conflict responses indicate that requests received\n by this system could not be completed due to a conflict\n with the current state of a requested resource.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientGoneIns": { "type": "integer", "description": "This object reflects the total number of Gone (410) \n responses received by the user agent since system startup.\n Inbound Gone responses indicate that resources requested\n by this system are no longer available at the recipient server\n and no forwarding address is known.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientGoneOuts": { "type": "integer", "description": "This object reflects the total number of Gone (410) \n responses sent by the user agent since system startup.\n Outbound Gone responses indicate that the requested\n resources are no longer available at this system and\n no forwarding address is known.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientLengthRequiredIns": { "type": "integer", "description": "This object reflects the total number of Length Required \n (411) responses received by the user agent since system startup.\n Inbound Length Required responses indicate that requests \n issued by this system are being refused by servers because \n of no defined Content-Length header field.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientLengthRequiredOuts": { "type": "integer", "description": "This object reflects the total number of Length Required \n (411) responses sent by the user agent since system startup.\n Outbound Length Required responses indicate that requests \n received by this system are being refused because of no \n defined Content-Length header field.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientReqEntTooLargeIns": { "type": "integer", "description": "This object reflects the total number of Request Entity Too \n Large (413) responses received by the user agent since system startup.\n Inbound Request Entity Too Large responses indicate that \n requests issued by this system are being refused because \n the request is larger than the server is willing or able to \n process.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientReqEntTooLargeOuts": { "type": "integer", "description": "This object reflects the total number of Request Entity Too \n Large (413) responses sent by the user agent since system startup.\n Outbound Request Entity Too Large responses indicate that \n requests received by this system are larger than this system \n is willing or able to process.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientReqURITooLargeIns": { "type": "integer", "description": "This object reflects the total number of Request-URI Too \n Large (414) responses received by the user agent since system startup.\n Inbound Request-URI Too Large responses indicate that \n requests issued by this system are being refused because the \n Request-URI is longer than the server is willing or able to \n interpret.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientReqURITooLargeOuts": { "type": "integer", "description": "This object reflects the total number of Request-URI Too \n Large (414) responses sent by the user agent since system startup.\n Outbound Request-URI Too Large responses indicate that \n Request-URIs received by this system are longer than this \n system is willing or able to interpret.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientNoSupMediaTypeIns": { "type": "integer", "description": "This object reflects the total number of Unsupported Media \n Type (415) responses received by the user agent since system startup.\n Inbound Unsupported Media Type responses indicate that \n requests issued by this system are being refused because the \n message body of the request is in a format not supported by \n the requested resource for the requested method.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientNoSupMediaTypeOuts": { "type": "integer", "description": "This object reflects the total number of Unsupported Media \n Type (415) responses sent by the user agent since system startup.\n Outbound Unsupported Media Type responses indicate that the \n body of requests received by this system are in a format not \n supported by the requested resource for the requested method.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientBadExtensionIns": { "type": "integer", "description": "This object reflects the total number of Bad Extension (420) \n responses received by the user agent since system startup.\n Inbound Bad Extension responses indicate that the recipient \n did not understand the protocol extension specified in a \n Require header field.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientBadExtensionOuts": { "type": "integer", "description": "This object reflects the total number of Bad Extension (420) \n responses sent by the user agent since system startup.\n Outbound Bad Extension responses indicate that this system\n did not understand the protocol extension specified in a\n Require header field of requests.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientTempNotAvailIns": { "type": "integer", "description": "This object reflects the total number of Temporarily Not \n Available (480) responses received by the user agent since system startup.\n Inbound Temporarily Not Available responses indicate that \n the called party is currently unavailable.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientTempNotAvailOuts": { "type": "integer", "description": "This object reflects the total number of Temporarily Not \n Available (480) responses sent by the user agent since system startup.\n Outbound Temporarily Not Available responses indicate that \n the called party's end system was contacted successfully but \n the called party is currently unavailable.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientCallLegNoExistIns": { "type": "integer", "description": "This object reflects the total number of Call Leg/Transaction \n Does Not Exist (481) responses received by the user agent since system startup.\n Inbound Call Leg/Transaction Does Not Exist responses indicate\n that either BYE or CANCEL requests issued by this system were \n received by a server and not matching call leg or transaction \n existed.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientCallLegNoExistOuts": { "type": "integer", "description": "This object reflects the total number of Call Leg/Transaction \n Does Not Exist (481) responses sent by the user agent since system startup.\n Outbound Call Leg/Transaction Does Not Exist responses \n indicate that BYE or CANCEL requests have been received by \n this system and not call leg or transaction matching that \n request exists.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientLoopDetectedIns": { "type": "integer", "description": "This object reflects the total number of Loop Detected (482) \n responses received by the user agent since system startup.\n Inbound Loop Detected responses indicate that requests issued\n by this system were received at servers and the server found \n itself in the Via path more than once.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientLoopDetectedOuts": { "type": "integer", "description": "This object reflects the total number of Loop Detected (482) \n responses sent by the user agent since system startup.\n Outbound Loop Detected responses indicate that requests \n received by this system contain a Via path with this system \n appearing more than once.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientTooManyHopsIns": { "type": "integer", "description": "This object reflects the total number of Too Many Hops (483) \n responses received by the user agent since system startup.\n Inbound Too Many Hops responses indicate that requests issued\n by this system contain more Via entries (hops) than allowed by\n the Max-Forwards header field of the requests.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientTooManyHopsOuts": { "type": "integer", "description": "This object reflects the total number of Too Many Hops (483) \n responses sent by the user agent since system startup.\n Outbound Too Many Hops responses indicate that requests\n received by this system contain more Via entries (hops) than\n are allowed by the Max-Forwards header field of the requests.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientAddrIncompleteIns": { "type": "integer", "description": "This object reflects the total number of Address Incomplete \n (484) responses received by the user agent since system startup.\n Inbound Address Incomplete responses indicate that requests \n issued by this system had To addresses or Request-URIs that \n were incomplete.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientAddrIncompleteOuts": { "type": "integer", "description": "This object reflects the total number of Address Incomplete \n (484) responses sent by the user agent since system startup.\n Outbound Address Incomplete responses indicate that requests \n received by this system had To addresses or Request-URIs that \n were incomplete.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientAmbiguousIns": { "type": "integer", "description": "This object reflects the total number of Ambiguous (485) \n responses received by the user agent since system startup.\n Inbound Ambiguous responses indicate that requests issued\n by this system provided ambiguous address information.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientAmbiguousOuts": { "type": "integer", "description": "This object reflects the total number of Ambiguous (485) \n responses sent by the user agent since system startup.\n Outbound Ambiguous responses indicate that requests received\n by this system contained ambiguous address information.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientBusyHereIns": { "type": "integer", "description": "This object reflects the total number of Busy Here (486) \n responses received by the user agent since system startup.\n Inbound Busy Here responses indicate that the\n called party is currently not willing or not able to\n take additional calls.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientBusyHereOuts": { "type": "integer", "description": "This object reflects the total number of Busy Here (486) \n responses sent by the user agent since system startup.\n Outbound Busy Here responses indicate that the\n called party's end system was contacted successfully but the\n called party is currently not willing or able to take \n additional calls.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientReqTermIns": { "type": "integer", "description": "This object reflects the total number of Request Terminated \n (487) responses received by the user agent since system startup.\n Request Terminated responses are issued if the original \n request was terminated via CANCEL or BYE.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientReqTermOuts": { "type": "integer", "description": "This object reflects the total number of Request Terminated \n (487) responses sent by the user agent since system startup.\n Request Terminated responses are issued if the original \n request was terminated via CANCEL or BYE.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientNoAcceptHereIns": { "type": "integer", "description": "This object reflects the total number of Not Acceptable Here\n (488) responses received by the user agent since system startup.\n The response has the same meaning as 606 (Not Acceptable), \n but only applies to the specific entity addressed by the \n Request-URI and the request may succeed elsewhere.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientNoAcceptHereOuts": { "type": "integer", "description": "This object reflects the total number of Not Acceptable Here\n (488) responses sent by the user agent since system startup.\n The response has the same meaning as 606 (Not Acceptable), \n but only applies to the specific entity addressed by the \n Request-URI and the request may succeed elsewhere.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientBadEventIns": { "type": "integer", "description": "This object reflects the total number of BadEvent (489) \n responses received by the user agent since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientBadEventOuts": { "type": "integer", "description": "This object reflects the total number of BadEvent (489) \n responses sent by the user agent since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientSTTooSmallIns": { "type": "integer", "description": "This object reflects the total number of SessionTimerTooSmall\n (422) responses received by the user agent since system \n startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientSTTooSmallOuts": { "type": "integer", "description": "This object reflects the total number of SessionTimerTooSmall\n (422) responses sent by the user agent since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientReqPendingIns": { "type": "integer", "description": "This object reflects the total number of RequestPending\n (491) responses received by the user agent since system\n startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsClientReqPendingOuts": { "type": "integer", "description": "This object reflects the total number of RequestPending\n (491) responses sent by the user agent since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true } }, "readOnly": true }, "cSipStatsErrServer": { "type": "object", "description": "cSipStatsErrServer", "properties": { "cSipStatsServerIntErrorIns": { "type": "integer", "description": "This object reflects the total number of Internal Server Error\n (500) responses received by the user agent since system startup.\n Inbound Internal Server Error responses indicate that servers \n to which this system is sending requests have encountered \n unexpected conditions that prevent them from fulfilling the \n requests.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsServerIntErrorOuts": { "type": "integer", "description": "This object reflects the total number of Internal Server Error\n (500) responses sent by the user agent since system startup.\n Outbound Internal Server Error responses indicate that this \n system has encountered unexpected conditions that prevent it \n from fulfilling received requests.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsServerNotImplementedIns": { "type": "integer", "description": "This object reflects the total number of Not Implemented \n (501) responses received by the user agent since system startup.\n Inbound Not Implemented responses indicate that servers to \n which this system is sending requests do not support the \n functionality required to fulfill the requests.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsServerNotImplementedOuts": { "type": "integer", "description": "This object reflects the total number of Not Implemented \n (501) responses sent by the user agent since system startup.\n Outbound Not Implemented responses indicate that this system\n does not support the functionality required to fulfill the \n requests.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsServerBadGatewayIns": { "type": "integer", "description": "This object reflects the total number of Bad Gateway (502) \n responses received by the user agent since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsServerBadGatewayOuts": { "type": "integer", "description": "This object reflects the total number of Bad Gateway (502) \n responses sent by the user agent since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsServerServiceUnavailIns": { "type": "integer", "description": "This object reflects the total number of Service Unavailable \n (503) responses received by the user agent since system startup.\n Inbound Service Unavailable responses indicate that the server\n servicing this system's request is temporarily unavailable to\n handle the request.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsServerServiceUnavailOuts": { "type": "integer", "description": "This object reflects the total number of Service Unavailable \n (503) responses sent by the user agent since system startup.\n Outbound Service Unavailable responses indicate that this\n system is temporarily unable to handle received requests.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsServerGatewayTimeoutIns": { "type": "integer", "description": "This object reflects the total number of Gateway Time-out \n (504) responses received by the user agent since system startup.\n Inbound Gateway Time-out responses indicate that the server\n attempting to complete this system's request did not receive\n a timely response from yet another system it was accessing to\n complete the request.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsServerGatewayTimeoutOuts": { "type": "integer", "description": "This object reflects the total number of Gateway Time-out \n (504) responses sent by the user agent since system startup.\n Outbound Gateway Time-out responses indicate that this system\n did not receive a timely response from the system it had\n accessed to assist in completing a received request.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsServerBadSipVersionIns": { "type": "integer", "description": "This object reflects the total number of SIP Version Not \n Supported (505) responses received by the user agent since system startup.\n Inbound SIP Version Not Supported responses indicate that \n the server does not support, or refuses to support, the SIP \n protocol version that was used in the request message.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsServerBadSipVersionOuts": { "type": "integer", "description": "This object reflects the total number of SIP Version Not \n Supported (505) responses sent by the user agent since system startup.\n Outbound SIP Version Not Supported responses indicate that \n this system does not support, or refuses to support, the SIP \n protocol version used in received requests.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsServerPrecondFailureIns": { "type": "integer", "description": "This object reflects the total number of Precondition \n Failure (580) responses received by the user agent since system startup.\n This response is returned by a UAS if it is unable to\n perform the mandatory preconditions for the session.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsServerPrecondFailureOuts": { "type": "integer", "description": "This object reflects the total number of Precondition \n Failure (580) responses sent by the user agent since system startup.\n This response is returned by a UAS if it is unable to\n perform the mandatory preconditions for the session.", "minimum": 0, "maximum": 4294967295, "readOnly": true } }, "readOnly": true }, "cSipStatsGlobalFail": { "type": "object", "description": "cSipStatsGlobalFail", "properties": { "cSipStatsGlobalBusyEverywhereIns": { "type": "integer", "description": "This object reflects the total number of Busy\n Everywhere (600) responses received by the user agent since system startup.\n Inbound Busy Everywhere responses indicate that the \n called party's end system was contacted successfully\n but the called party is busy and does not wish to take\n the call at this time.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsGlobalBusyEverywhereOuts": { "type": "integer", "description": "This object reflects the total number of Busy\n Everywhere (600) responses sent by the user agent since system startup.\n Outbound Busy Everywhere responses indicate that \n this system has successfully contacted a called party's\n end system and the called party does not wish to take\n the call at this time.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsGlobalDeclineIns": { "type": "integer", "description": "This object reflects the total number of Decline\n (603) responses received by the user agent since system startup.\n Decline responses indicate that the called party's end \n system was contacted successfully but the called party \n explicitly does not wish to, or cannot, participate.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsGlobalDeclineOuts": { "type": "integer", "description": "This object reflects the total number of Decline\n (603) responses sent by the user agent since system startup.\n Outbound Decline responses indicate that this system\n has successfully contacted a called party's end system\n and the called party explicitly does not wish to, or\n cannot, participate.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsGlobalNotAnywhereIns": { "type": "integer", "description": "This object reflects the total number of Does Not\n Exist Anywhere (604) responses received by the user agent since system startup.\n Inbound Does Not Exist Anywhere responses indicate that\n the server handling this system's request has authoritative\n information that the called party indicated in the To\n request field does not exist anywhere.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsGlobalNotAnywhereOuts": { "type": "integer", "description": "This object reflects the total number of Does Not\n Exist Anywhere (604) responses sent by the user agent since system startup.\n Outbound Does Not Exist Anywhere responses indicate that\n this system has authoritative information that the called\n party in the To field of received requests does not exist\n anywhere.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsGlobalNotAcceptableIns": { "type": "integer", "description": "This object reflects the total number of Not Acceptable\n (606) responses received by the user agent since system startup.\n Inbound Not Acceptable responses indicate that the called\n party's end system was contacted successfully but some\n aspect of the session description is not acceptable.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsGlobalNotAcceptableOuts": { "type": "integer", "description": "This object reflects the total number of Not Acceptable\n (606) responses sent by the user agent since system startup.\n Outbound Not Acceptable responses indicate that the called\n party wishes to communicate, but cannot adequately support\n the session described in the request.", "minimum": 0, "maximum": 4294967295, "readOnly": true } }, "readOnly": true }, "cSipStatsTraffic": { "type": "object", "description": "This object reflects the total number of INVITE requests \n received by the user agent since system startup.", "properties": { "cSipStatsTrafficInviteIns": { "type": "integer", "description": "This object reflects the total number of INVITE requests \n received by the user agent since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsTrafficInviteOuts": { "type": "integer", "description": "This object reflects the total number of INVITE requests sent\n by the user agent.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsTrafficAckIns": { "type": "integer", "description": "This object reflects the total number of ACK requests \n received by the user agent since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsTrafficAckOuts": { "type": "integer", "description": "This object reflects the total number of ACK requests sent\n by the user agent.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsTrafficByeIns": { "type": "integer", "description": "This object reflects the total number of BYE requests \n received by the user agent since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsTrafficByeOuts": { "type": "integer", "description": "This object reflects the total number of BYE requests sent\n by the user agent.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsTrafficCancelIns": { "type": "integer", "description": "This object reflects the total number of CANCEL requests \n received by the user agent since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsTrafficCancelOuts": { "type": "integer", "description": "This object reflects the total number of CANCEL requests sent\n by the user agent.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsTrafficOptionsIns": { "type": "integer", "description": "This object reflects the total number of OPTIONS requests \n received by the user agent since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsTrafficOptionsOuts": { "type": "integer", "description": "This object reflects the total number of OPTIONS requests sent\n by the user agent.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsTrafficRegisterIns": { "type": "integer", "description": "This object reflects the total number of REGISTER requests \n received by the user agent since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsTrafficRegisterOuts": { "type": "integer", "description": "This object reflects the total number of REGISTER requests \n sent by the user agent since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsTrafficCometIns": { "type": "integer", "description": "This object reflects the total number of COndition MET \n requests received by the user agent since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsTrafficCometOuts": { "type": "integer", "description": "This object reflects the total number of COndition MET \n requests sent by the user agent since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsTrafficPrackIns": { "type": "integer", "description": "This object reflects the total number of PRovisonal \n ACKnowledgement requests received by the user agent since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsTrafficPrackOuts": { "type": "integer", "description": "This object reflects the total number of PRovisonal \n ACKnowledgement requests sent by the user agent since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsTrafficReferIns": { "type": "integer", "description": "This object reflects the total number of Refer\n requests received by the user agent since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsTrafficReferOuts": { "type": "integer", "description": "This object reflects the total number of Refer\n requests sent by the user agent since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsTrafficNotifyIns": { "type": "integer", "description": "This object reflects the total number of Notify \n requests received by the user agent since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsTrafficNotifyOuts": { "type": "integer", "description": "This object reflects the total number of Notify \n requests sent by the user agent since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsTrafficInfoIns": { "type": "integer", "description": "This object reflects the total number of Info \n requests received by the user agent since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsTrafficInfoOuts": { "type": "integer", "description": "This object reflects the total number of Info \n requests sent by the user agent since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsTrafficSubscribeIns": { "type": "integer", "description": "This object reflects the total number of Subscribe\n requests received by the user agent since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsTrafficSubscribeOuts": { "type": "integer", "description": "This object reflects the total number of Subscribe\n requests sent by the user agent since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsTrafficUpdateIns": { "type": "integer", "description": "This object reflects the total number of Update\n requests received by the user agent since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsTrafficUpdateOuts": { "type": "integer", "description": "This object reflects the total number of Update\n requests sent by the user agent since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true } }, "readOnly": true }, "cSipStatsRetry": { "type": "object", "description": "This object reflects the total number of INVITE retries that \n have been sent by the user agent since system startup. If the number of 'first \n attempt' INVITES is of interest, subtract the value of this \n object from cSipStatsTrafficInviteOut.", "properties": { "cSipStatsRetryInvites": { "type": "integer", "description": "This object reflects the total number of INVITE retries that \n have been sent by the user agent since system startup. If the number of 'first \n attempt' INVITES is of interest, subtract the value of this \n object from cSipStatsTrafficInviteOut.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsRetryByes": { "type": "integer", "description": "This object reflects the total number of BYE retries that have\n been sent by the user agent since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsRetryCancels": { "type": "integer", "description": "This object reflects the total number of CANCEL retries that \n have been sent by the user agent since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsRetryRegisters": { "type": "integer", "description": "This object reflects the total number of REGISTER retries that\n have been sent by the user agent since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsRetryResponses": { "type": "integer", "description": "This object reflects the total number of Response (while \n expecting a ACK) retries that have been sent by the user\n agent.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsRetryPracks": { "type": "integer", "description": "This object reflects the total number of PRovisional\n ACKnowledgement retries sent by the user agent since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsRetryComets": { "type": "integer", "description": "This object reflects the total number of COndition\n MET retries sent by the user agent since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsRetryReliable1xxRsps": { "type": "integer", "description": "This object reflects the total number of Reliable\n 1xx Response retries sent by the user agent since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsRetryNotifys": { "type": "integer", "description": "This object reflects the total number of Notify \n retries that have been sent by the user agent since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsRetryRefers": { "type": "integer", "description": "This object reflects the total number of Refer\n retries that have been sent by the user agent since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsRetryInfo": { "type": "integer", "description": "This object reflects the total number of Info\n retries that have been sent by the user agent since system\n startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsRetrySubscribe": { "type": "integer", "description": "This object reflects the total number of Subscribe\n retries that have been sent by the user agent since system\n startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true } }, "readOnly": true }, "cSipStatsMisc": { "type": "object", "description": "This object reflects the total number of incoming Redirect \n (3xx) response messages that have been mapped to Client \n Error (4xx) response messages.", "properties": { "cSipStatsMisc3xxMappedTo4xxRsps": { "type": "integer", "description": "This object reflects the total number of incoming Redirect \n (3xx) response messages that have been mapped to Client \n Error (4xx) response messages.", "minimum": 0, "maximum": 4294967295, "readOnly": true } }, "readOnly": true }, "cSipStatsConnection": { "type": "object", "description": "This object reflects the total number of TCP send failures\n since system startup.", "properties": { "cSipStatsConnTCPSendFailures": { "type": "integer", "description": "This object reflects the total number of TCP send failures\n since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsConnUDPSendFailures": { "type": "integer", "description": "This object reflects the total number of UDP send failures\n since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsConnTCPRemoteClosures": { "type": "integer", "description": "This object reflects the total number of Remote Closures \n for TCP since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsConnUDPCreateFailures": { "type": "integer", "description": "This object reflects the total number of connection create\n failures for UDP since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsConnTCPCreateFailures": { "type": "integer", "description": "This object reflects the total number of connection create\n failures for TCP since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsConnUDPInactiveTimeouts": { "type": "integer", "description": "This object reflects the total number of UDP connections that \n timed out due to inactivity since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsConnTCPInactiveTimeouts": { "type": "integer", "description": "This object reflects the total number of TCP connections that\n timed out due to inactivity since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsActiveUDPConnections": { "type": "integer", "description": "This object reflects the total number of active UDP\n connections since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsActiveTCPConnections": { "type": "integer", "description": "This object reflects the total number of active TCP\n connections since system startup.", "minimum": 0, "maximum": 4294967295, "readOnly": true } }, "readOnly": true }, "cSipCfgEarlyMediaTable": { "type": "object", "description": "This table contains configuration for Early\n Media Cut Through. The configuration controls\n how the SIP user agent will process 1xx\n (Provisional) SIP response messages that contain \n Session Definition Protocol (SDP) payloads.", "properties": { "cSipCfgEarlyMediaEntry": { "type": "array", "description": "A row in the cSipCfgEarlyMediaTable.\n A row is accessible with a Provisional (1xx)\n status code value (eg, 180) and provides\n an object for the enabling or disabling of\n the Early Media Cut Through functionality.", "items": { "type": "object", "properties": { "cSipCfgEarlyMediaStatusCodeIndex": { "type": "string", "description": "A unique identifier of a row in this table and\n a valid SIP status code.", "x-yang-type": "CISCO-SIP-UA-MIB:CSipStatusCode", "readOnly": true }, "cSipCfgEarlyMediaCutThruDisabled": { "type": "boolean", "description": "This object specifies whether Early Media \n Cut Through is enabled or disabled for the \n SIP response messages with status codes that \n match cSipCfgEarlyMediaStatusCodeIndex.\n \n If 'true', early media cut through is disabled,\n and the user agent will process the message as\n though it did not contain any SDP payload.\n \n If 'false', early media cut through is enabled,\n and the user agent will process the message\n similar to a 183 (Session Progress) and cut\n through for early media. The assumption being\n that the SDP is an indication that the far end\n is going to send early media.", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cSipCfgBindSourceAddrTable": { "type": "object", "description": "This table contains configuration for binding\n the scope of packets to the particular ethernet\n interface. The scope for the packets can be\n specified as either 'signalling' or 'media'\n packets. The ethernet interface shall be\n specified by the interface index. The table\n shall be indexed based on the scope.", "properties": { "cSipCfgBindSourceAddrEntry": { "type": "array", "description": "A row in the cSipCfgBindSourceAddrTable.\n A row is accessible with the scope of packets\n to which the source IP address of the interface\n designated by cSipCfgBindSourceAddrInterface\n will be bound.", "items": { "type": "object", "properties": { "cSipCfgBindSourceAddrScope": { "type": "string", "description": "A unique identifier of a row in this table and\n specifies the scope of packets to which the\n source IP address of the interface\n designated by cSipCfgBindSourceAddrInterface\n will be bound.", "readOnly": true }, "cSipCfgBindSourceAddrInterface": { "type": "string", "description": "This object may specify the interface where the\n source IP address used in SIP signalling or media\n packets is configured. A value of 0 means that\n there is no specific source address configured and\n in this case the best local IP address will be chosen\n by the system.", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cSipCfgPeerTable": { "type": "object", "description": "cSipCfgPeerTable", "properties": { "cSipCfgPeerEntry": { "type": "array", "description": "A row in the cSipCfgPeerTable.", "items": { "type": "object", "properties": { "cSipCfgPeerIndex": { "type": "integer", "description": "An arbitrary index that uniquely identifies a \n dial-peer configured for SIP.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cSipCfgPeerOutSessionTransport": { "type": "string", "description": "This object specifies the session transport \n protocol that will be used by this dial-peer\n for outbound SIP messages. \n \n The value 'system' is the default and indicates \n that this dial-peer should use the value set by \n cSipCfgOutSessionTransport instead.", "readOnly": true }, "cSipCfgPeerReliable1xxRspStr": { "type": "string", "description": "This object specifies the string that will be \n placed in either the Supported or Require SIP \n header, as specified by cSipCfgPeerReliable1xxRspHdr.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cSipCfgPeerReliable1xxRspHdr": { "type": "string", "description": "This object specifies behavior with respect to\n Support or Require headers in SIP messages sent\n and received via this dial-peer.\n \n If the originating gateway is configured for 'require',\n the Require header is added to the outgoing INVITEs\n with the value of cSipCfgPeerReliable1xxStr. This\n requires the use of reliable provisional responses by\n the terminating gateway. Sessions will be torn down\n if this use cannot be supported by that gateway.\n \n If the originating gateway is configured for 'supported',\n the Supported header is added to the outgoing INVITEs\n with the value of cSipCfgPeerReliable1xxStr. This \n requires that an attempt to use reliable provisional\n responses be made, but sessions can continue without them.\n \n If the originating gateway is configured for 'disabled',\n the value of cSipCfgReliable1xxStr will NOT be added to\n either the Require or Supported headers of outgoing INVITEs.\n \n The value 'system' is the default and indicates that this \n dial-peer should use the value of cSipCfgReliable1xxRspHdr\n instead.", "readOnly": true }, "cSipCfgPeerUrlType": { "type": "string", "description": "This object specifies the URL type sent in outbound\n INVITES generated by this device.\n \n The value 'system' is the default and indicates that this \n dial-peer should use the value of cSipCfgUrlType instead.", "readOnly": true }, "cSipCfgPeerSwitchTransEnabled": { "type": "boolean", "description": "This object specifies if the functionality of switching\n between transports from UDP to TCP if the message size of a\n Request is greater than 1300 bytes is enabled or not.", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cSipCfgStatusCauseTable": { "type": "object", "description": "This table contains SIP status code to PSTN cause code\n mapping configuration. Inbound SIP response messages \n that will result in outbound PSTN signalling messages\n will have the SIP status codes transposed into the\n PSTN cause codes as prescribed by the contents of this \n table.", "properties": { "cSipCfgStatusCauseEntry": { "type": "array", "description": "A row in the cSipCfgStatusCauseTable. Entries cannot be\n created or destroyed by the actions of any NMS.", "items": { "type": "object", "properties": { "cSipCfgStatusCodeIndex": { "type": "string", "description": "A unique identifier of a row in this table and\n a valid SIP status code.", "x-yang-type": "CISCO-SIP-UA-MIB:CSipStatusCode", "readOnly": true }, "cSipCfgPstnCause": { "type": "integer", "description": "The PSTN cause code to which the SIP status code\n given by cSipCfgStatusCodeIndex is to be mapped\n for outbound PSTN signalling messages.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cSipCfgStatusCauseStoreStatus": { "type": "string", "description": "This object reflects the storage status of this\n table entry. If the value is 'volatile', then\n this entry only exists in RAM and the information\n would be lost (reverting to defaults) on system reload. \n If the value is 'nonVolatile' then this entry has been \n written to NVRAM and will persist across system reloads.", "x-yang-type": "snmpv2-tc:StorageType", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cSipCfgCauseStatusTable": { "type": "object", "description": "This table contains PSTN cause code to SIP status code\n mapping configuration. Inbound PSTN signalling messages\n that will result in outbound SIP response messages \n will have the PSTN cause codes transposed into the\n SIP status codes as prescribed by the contents of this \n table.", "properties": { "cSipCfgCauseStatusEntry": { "type": "array", "description": "A row in the cSipCfgCauseStatusTable. Entries cannot be\n created or destroyed by the actions of any NMS.", "items": { "type": "object", "properties": { "cSipCfgPstnCauseIndex": { "type": "integer", "description": "A unique identifier of a row in this table and\n a valid PSTN cause code.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cSipCfgStatusCode": { "type": "string", "description": "The SIP status code to which the PSTN cause code\n given by cSipCfgPstnCauseIndex is to be mapped\n for outbound SIP response messages.", "x-yang-type": "CISCO-SIP-UA-MIB:CSipStatusCode", "readOnly": true }, "cSipCfgCauseStatusStoreStatus": { "type": "string", "description": "This object reflects the storage status of this\n table entry. If the value is 'volatile', then\n this entry only exists in RAM and the information\n would be lost (reverting to defaults) on system reload. \n If the value is 'nonVolatile' then this entry has been \n written to NVRAM and will persist across system reloads.", "x-yang-type": "snmpv2-tc:StorageType", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cSipStatsSuccessOkTable": { "type": "object", "description": "This table contains statistics for sent and\n received 200 Ok response messages. The \n statistics are kept on per SIP method basis.", "properties": { "cSipStatsSuccessOkEntry": { "type": "array", "description": "A row in the cSipStatsSuccessOkTable. There is \n an entry for each SIP method for which 200 Ok \n inbound and/or outbound statistics are kept.", "items": { "type": "object", "properties": { "cSipStatsSuccessOkMethod": { "type": "string", "description": "This object is used for instance identification\n of objects in this table. The value reflects a\n SIP method.", "x-yang-type": "CISCO-SIP-UA-MIB:CSipMethodStr", "readOnly": true }, "cSipStatsSuccessOkInbounds": { "type": "integer", "description": "This object reflects the total number of Ok\n (200) responses sent by the user agent, since\n system startup, that were associated with the\n SIP method as specified by cSipStatsSuccessOkMethod.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsSuccessOkOutbounds": { "type": "integer", "description": "This object reflects the total number of Ok\n (200) responses received by the user agent, since\n system startup, that were associated with the\n SIP method as specified by cSipStatsSuccessOkMethod.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true } }, "readOnly": true } } }, "CISCO-SIP-UA-MIB_cSipCfgEarlyMediaEntry": { "type": "array", "description": "A row in the cSipCfgEarlyMediaTable.\n A row is accessible with a Provisional (1xx)\n status code value (eg, 180) and provides\n an object for the enabling or disabling of\n the Early Media Cut Through functionality.", "items": { "type": "object", "properties": { "cSipCfgEarlyMediaStatusCodeIndex": { "type": "string", "description": "A unique identifier of a row in this table and\n a valid SIP status code.", "x-yang-type": "CISCO-SIP-UA-MIB:CSipStatusCode", "readOnly": true }, "cSipCfgEarlyMediaCutThruDisabled": { "type": "boolean", "description": "This object specifies whether Early Media \n Cut Through is enabled or disabled for the \n SIP response messages with status codes that \n match cSipCfgEarlyMediaStatusCodeIndex.\n \n If 'true', early media cut through is disabled,\n and the user agent will process the message as\n though it did not contain any SDP payload.\n \n If 'false', early media cut through is enabled,\n and the user agent will process the message\n similar to a 183 (Session Progress) and cut\n through for early media. The assumption being\n that the SDP is an indication that the far end\n is going to send early media.", "readOnly": true } } } }, "CISCO-SIP-UA-MIB_cSipCfgBindSourceAddrEntry": { "type": "array", "description": "A row in the cSipCfgBindSourceAddrTable.\n A row is accessible with the scope of packets\n to which the source IP address of the interface\n designated by cSipCfgBindSourceAddrInterface\n will be bound.", "items": { "type": "object", "properties": { "cSipCfgBindSourceAddrScope": { "type": "string", "description": "A unique identifier of a row in this table and\n specifies the scope of packets to which the\n source IP address of the interface\n designated by cSipCfgBindSourceAddrInterface\n will be bound.", "readOnly": true }, "cSipCfgBindSourceAddrInterface": { "type": "string", "description": "This object may specify the interface where the\n source IP address used in SIP signalling or media\n packets is configured. A value of 0 means that\n there is no specific source address configured and\n in this case the best local IP address will be chosen\n by the system.", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true } } } }, "CISCO-SIP-UA-MIB_cSipCfgPeerEntry": { "type": "array", "description": "A row in the cSipCfgPeerTable.", "items": { "type": "object", "properties": { "cSipCfgPeerIndex": { "type": "integer", "description": "An arbitrary index that uniquely identifies a \n dial-peer configured for SIP.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cSipCfgPeerOutSessionTransport": { "type": "string", "description": "This object specifies the session transport \n protocol that will be used by this dial-peer\n for outbound SIP messages. \n \n The value 'system' is the default and indicates \n that this dial-peer should use the value set by \n cSipCfgOutSessionTransport instead.", "readOnly": true }, "cSipCfgPeerReliable1xxRspStr": { "type": "string", "description": "This object specifies the string that will be \n placed in either the Supported or Require SIP \n header, as specified by cSipCfgPeerReliable1xxRspHdr.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cSipCfgPeerReliable1xxRspHdr": { "type": "string", "description": "This object specifies behavior with respect to\n Support or Require headers in SIP messages sent\n and received via this dial-peer.\n \n If the originating gateway is configured for 'require',\n the Require header is added to the outgoing INVITEs\n with the value of cSipCfgPeerReliable1xxStr. This\n requires the use of reliable provisional responses by\n the terminating gateway. Sessions will be torn down\n if this use cannot be supported by that gateway.\n \n If the originating gateway is configured for 'supported',\n the Supported header is added to the outgoing INVITEs\n with the value of cSipCfgPeerReliable1xxStr. This \n requires that an attempt to use reliable provisional\n responses be made, but sessions can continue without them.\n \n If the originating gateway is configured for 'disabled',\n the value of cSipCfgReliable1xxStr will NOT be added to\n either the Require or Supported headers of outgoing INVITEs.\n \n The value 'system' is the default and indicates that this \n dial-peer should use the value of cSipCfgReliable1xxRspHdr\n instead.", "readOnly": true }, "cSipCfgPeerUrlType": { "type": "string", "description": "This object specifies the URL type sent in outbound\n INVITES generated by this device.\n \n The value 'system' is the default and indicates that this \n dial-peer should use the value of cSipCfgUrlType instead.", "readOnly": true }, "cSipCfgPeerSwitchTransEnabled": { "type": "boolean", "description": "This object specifies if the functionality of switching\n between transports from UDP to TCP if the message size of a\n Request is greater than 1300 bytes is enabled or not.", "readOnly": true } } } }, "CISCO-SIP-UA-MIB_cSipCfgStatusCauseEntry": { "type": "array", "description": "A row in the cSipCfgStatusCauseTable. Entries cannot be\n created or destroyed by the actions of any NMS.", "items": { "type": "object", "properties": { "cSipCfgStatusCodeIndex": { "type": "string", "description": "A unique identifier of a row in this table and\n a valid SIP status code.", "x-yang-type": "CISCO-SIP-UA-MIB:CSipStatusCode", "readOnly": true }, "cSipCfgPstnCause": { "type": "integer", "description": "The PSTN cause code to which the SIP status code\n given by cSipCfgStatusCodeIndex is to be mapped\n for outbound PSTN signalling messages.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cSipCfgStatusCauseStoreStatus": { "type": "string", "description": "This object reflects the storage status of this\n table entry. If the value is 'volatile', then\n this entry only exists in RAM and the information\n would be lost (reverting to defaults) on system reload. \n If the value is 'nonVolatile' then this entry has been \n written to NVRAM and will persist across system reloads.", "x-yang-type": "snmpv2-tc:StorageType", "readOnly": true } } } }, "CISCO-SIP-UA-MIB_cSipCfgCauseStatusEntry": { "type": "array", "description": "A row in the cSipCfgCauseStatusTable. Entries cannot be\n created or destroyed by the actions of any NMS.", "items": { "type": "object", "properties": { "cSipCfgPstnCauseIndex": { "type": "integer", "description": "A unique identifier of a row in this table and\n a valid PSTN cause code.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cSipCfgStatusCode": { "type": "string", "description": "The SIP status code to which the PSTN cause code\n given by cSipCfgPstnCauseIndex is to be mapped\n for outbound SIP response messages.", "x-yang-type": "CISCO-SIP-UA-MIB:CSipStatusCode", "readOnly": true }, "cSipCfgCauseStatusStoreStatus": { "type": "string", "description": "This object reflects the storage status of this\n table entry. If the value is 'volatile', then\n this entry only exists in RAM and the information\n would be lost (reverting to defaults) on system reload. \n If the value is 'nonVolatile' then this entry has been \n written to NVRAM and will persist across system reloads.", "x-yang-type": "snmpv2-tc:StorageType", "readOnly": true } } } }, "CISCO-SIP-UA-MIB_cSipStatsSuccessOkEntry": { "type": "array", "description": "A row in the cSipStatsSuccessOkTable. There is \n an entry for each SIP method for which 200 Ok \n inbound and/or outbound statistics are kept.", "items": { "type": "object", "properties": { "cSipStatsSuccessOkMethod": { "type": "string", "description": "This object is used for instance identification\n of objects in this table. The value reflects a\n SIP method.", "x-yang-type": "CISCO-SIP-UA-MIB:CSipMethodStr", "readOnly": true }, "cSipStatsSuccessOkInbounds": { "type": "integer", "description": "This object reflects the total number of Ok\n (200) responses sent by the user agent, since\n system startup, that were associated with the\n SIP method as specified by cSipStatsSuccessOkMethod.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cSipStatsSuccessOkOutbounds": { "type": "integer", "description": "This object reflects the total number of Ok\n (200) responses received by the user agent, since\n system startup, that were associated with the\n SIP method as specified by cSipStatsSuccessOkMethod.", "minimum": 0, "maximum": 4294967295, "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-SIP-UA-MIB", "description": "MIB operations for CISCO-SIP-UA-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }