{ "openapi": "3.0.0", "info": { "title": "CISCO-MEDIA-GATEWAY-MIB MIB API", "version": "1.0.0", "description": "SNMP MIB translated to YANG data model\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-MEDIA-GATEWAY-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/CISCO-MEDIA-GATEWAY-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "CISCO-MEDIA-GATEWAY-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-MEDIA-GATEWAY-MIB:cMediaGwTable": { "get": { "summary": "Get cMediaGwTable data", "description": "Retrieve cMediaGwTable operational data from MIB", "tags": [ "CISCO-MEDIA-GATEWAY-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table contains the global media gateway parameters\n information.\n It supports the modification of the global media gateway \n parameters.", "properties": { "cMediaGwEntry": { "type": "array", "description": "A Media Gateway Entry. \n At system power-up, an entry is created by the agent \n if the system detects a media gateway module has been added \n to the system, and an entry is deleted if the entry associated\n media gateway module has been removed from the system.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "integer", "description": "An index that uniquely identifies an entry in the \n cMediaGwTable.", "minimum": -2147483648, "maximum": 2147483647 }, "cmgwDomainName": { "type": "string", "description": "This object is used to represent a domain name under which \n the Media Gateway could also be registered in a DNS name\n server. \n \n The value of this object reflects the value of \n cmgwConfigDomainName from the entry with a value of \n 'gateway(1)' for object cmgwConfigDomainNameEntity of \n cMediaGwDomainNameConfigTable.\n \n If there is no entry in cMediaGwDomainNameConfigTable with\n 'gateway(1)' of cmgwConfigDomainNameEntity, then\n the value of this object will be empty string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cmgwPhysicalIndex": { "type": "string", "description": "This object represents the entPhysicalIndex of the\n card in which media gateway is running. It will contain\n value 0 if the entPhysicalIndex value is not available or \n not applicable", "x-yang-type": "cisco-tc:EntPhysicalIndexOrZero" }, "cmgwServiceState": { "type": "string", "description": "This object indicates the current service state of the Media \n Gateway.\n This object is controlled by 'cmgwAdminState' \n object.", "x-yang-type": "CISCO-MEDIA-GATEWAY-MIB:CGwServiceState" }, "cmgwAdminState": { "type": "string", "description": "This object is used to change the service state of \n the Media Gateway from inService to outOfService or from \n outOfService to inService. \n The resulting service state of the gateway is represented \n by 'cmgwServiceState'.", "x-yang-type": "CISCO-MEDIA-GATEWAY-MIB:CGwAdminState" }, "cmgwGraceTime": { "type": "integer", "description": "This object is used to represent grace period.\n The grace period (restart delay in RSIP message) is \n expressed in a number of seconds. \n It means how soon the gateway will be taken out of service.\n The value -1 indicates that the grace period time is\n disabled.", "minimum": -2147483648, "maximum": 2147483647 }, "cmgwVtMappingMode": { "type": "string", "description": "This object is used to represent the VT (sonet Virtual\n Tributary) counting.\n \n standard - standard counting (based on Bellcore TR253)\n titan - TITAN5500 counting (based on Tellabs TITAN 5500)\n \n Note: 'titan' is valid only if sonet line medium type \n (sonetMediumType of SONET-MIB) is 'sonet' and \n sonet path payload type (cspSonetPathPayload of\n CISCO-SONET-MIB) is 'vt15vc11'." }, "cmgwSrcFilterEnabled": { "type": "boolean", "description": "This object is used to enable or disable the source IP\n and port filtering with MGC for security consideration\n as follows:\n 'true' - source IP and port filter is enabled \n 'false' - source IP and port filter is disable" }, "cmgwLawInterceptEnabled": { "type": "boolean", "description": "This object is used to enable or disable the lawful\n intercept for government.\n as follows:\n 'true' - enable lawful intercept\n 'false' - disable lawful intercept" }, "cmgwV23Enabled": { "type": "boolean", "description": "This object is to enable or disable V23 tone.\n Setting the object value to 'true', will cause VXSM (Voice Switching\n Service Module) to detect V23 tone." } } } } } }, "example": { "CISCO-MEDIA-GATEWAY-MIB:cMediaGwTable": { "cMediaGwEntry": [ { "cmgwIndex": 1, "cmgwDomainName": "interface-1", "cmgwPhysicalIndex": "1", "cmgwServiceState": "up(1)", "cmgwAdminState": "up(1)", "cmgwGraceTime": -2147483648, "cmgwVtMappingMode": "example-string", "cmgwSrcFilterEnabled": true, "cmgwLawInterceptEnabled": true, "cmgwV23Enabled": true }, { "cmgwIndex": 2, "cmgwDomainName": "interface-1", "cmgwPhysicalIndex": "2", "cmgwServiceState": "up(1)", "cmgwAdminState": "up(1)", "cmgwGraceTime": -2147483648, "cmgwVtMappingMode": "example-string", "cmgwSrcFilterEnabled": true, "cmgwLawInterceptEnabled": true, "cmgwV23Enabled": true }, { "cmgwIndex": 3, "cmgwDomainName": "interface-1", "cmgwPhysicalIndex": "3", "cmgwServiceState": "up(1)", "cmgwAdminState": "up(1)", "cmgwGraceTime": -2147483648, "cmgwVtMappingMode": "example-string", "cmgwSrcFilterEnabled": true, "cmgwLawInterceptEnabled": true, "cmgwV23Enabled": true } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cMediaGwTable", "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": "/cMediaGwTable", "x-restconf-kind": "container" }, "/data/CISCO-MEDIA-GATEWAY-MIB:cMediaGwTable/cMediaGwEntry": { "get": { "summary": "Get cMediaGwEntry list", "description": "Retrieve list of cMediaGwEntry entries from MIB", "tags": [ "CISCO-MEDIA-GATEWAY-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A Media Gateway Entry. \n At system power-up, an entry is created by the agent \n if the system detects a media gateway module has been added \n to the system, and an entry is deleted if the entry associated\n media gateway module has been removed from the system.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "integer", "description": "An index that uniquely identifies an entry in the \n cMediaGwTable.", "minimum": -2147483648, "maximum": 2147483647 }, "cmgwDomainName": { "type": "string", "description": "This object is used to represent a domain name under which \n the Media Gateway could also be registered in a DNS name\n server. \n \n The value of this object reflects the value of \n cmgwConfigDomainName from the entry with a value of \n 'gateway(1)' for object cmgwConfigDomainNameEntity of \n cMediaGwDomainNameConfigTable.\n \n If there is no entry in cMediaGwDomainNameConfigTable with\n 'gateway(1)' of cmgwConfigDomainNameEntity, then\n the value of this object will be empty string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cmgwPhysicalIndex": { "type": "string", "description": "This object represents the entPhysicalIndex of the\n card in which media gateway is running. It will contain\n value 0 if the entPhysicalIndex value is not available or \n not applicable", "x-yang-type": "cisco-tc:EntPhysicalIndexOrZero" }, "cmgwServiceState": { "type": "string", "description": "This object indicates the current service state of the Media \n Gateway.\n This object is controlled by 'cmgwAdminState' \n object.", "x-yang-type": "CISCO-MEDIA-GATEWAY-MIB:CGwServiceState" }, "cmgwAdminState": { "type": "string", "description": "This object is used to change the service state of \n the Media Gateway from inService to outOfService or from \n outOfService to inService. \n The resulting service state of the gateway is represented \n by 'cmgwServiceState'.", "x-yang-type": "CISCO-MEDIA-GATEWAY-MIB:CGwAdminState" }, "cmgwGraceTime": { "type": "integer", "description": "This object is used to represent grace period.\n The grace period (restart delay in RSIP message) is \n expressed in a number of seconds. \n It means how soon the gateway will be taken out of service.\n The value -1 indicates that the grace period time is\n disabled.", "minimum": -2147483648, "maximum": 2147483647 }, "cmgwVtMappingMode": { "type": "string", "description": "This object is used to represent the VT (sonet Virtual\n Tributary) counting.\n \n standard - standard counting (based on Bellcore TR253)\n titan - TITAN5500 counting (based on Tellabs TITAN 5500)\n \n Note: 'titan' is valid only if sonet line medium type \n (sonetMediumType of SONET-MIB) is 'sonet' and \n sonet path payload type (cspSonetPathPayload of\n CISCO-SONET-MIB) is 'vt15vc11'." }, "cmgwSrcFilterEnabled": { "type": "boolean", "description": "This object is used to enable or disable the source IP\n and port filtering with MGC for security consideration\n as follows:\n 'true' - source IP and port filter is enabled \n 'false' - source IP and port filter is disable" }, "cmgwLawInterceptEnabled": { "type": "boolean", "description": "This object is used to enable or disable the lawful\n intercept for government.\n as follows:\n 'true' - enable lawful intercept\n 'false' - disable lawful intercept" }, "cmgwV23Enabled": { "type": "boolean", "description": "This object is to enable or disable V23 tone.\n Setting the object value to 'true', will cause VXSM (Voice Switching\n Service Module) to detect V23 tone." } } } }, "example": { "CISCO-MEDIA-GATEWAY-MIB:cMediaGwEntry": [ { "cmgwIndex": 1, "cmgwDomainName": "interface-1", "cmgwPhysicalIndex": "example-string", "cmgwServiceState": "up(1)", "cmgwAdminState": "up(1)", "cmgwGraceTime": -2147483648, "cmgwVtMappingMode": "example-string", "cmgwSrcFilterEnabled": true, "cmgwLawInterceptEnabled": true, "cmgwV23Enabled": true } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cMediaGwEntry", "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": "/cMediaGwTable/cMediaGwEntry", "x-restconf-kind": "container" }, "/data/CISCO-MEDIA-GATEWAY-MIB:cMediaGwTable/cMediaGwEntry={cmgwIndex}": { "get": { "summary": "Get cMediaGwEntry entry", "description": "Retrieve specific cMediaGwEntry entry by key from MIB", "tags": [ "CISCO-MEDIA-GATEWAY-MIB" ], "parameters": [ { "name": "cmgwIndex", "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": { "cmgwIndex": { "type": "integer", "description": "An index that uniquely identifies an entry in the \n cMediaGwTable.", "minimum": -2147483648, "maximum": 2147483647 }, "cmgwDomainName": { "type": "string", "description": "This object is used to represent a domain name under which \n the Media Gateway could also be registered in a DNS name\n server. \n \n The value of this object reflects the value of \n cmgwConfigDomainName from the entry with a value of \n 'gateway(1)' for object cmgwConfigDomainNameEntity of \n cMediaGwDomainNameConfigTable.\n \n If there is no entry in cMediaGwDomainNameConfigTable with\n 'gateway(1)' of cmgwConfigDomainNameEntity, then\n the value of this object will be empty string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cmgwPhysicalIndex": { "type": "string", "description": "This object represents the entPhysicalIndex of the\n card in which media gateway is running. It will contain\n value 0 if the entPhysicalIndex value is not available or \n not applicable", "x-yang-type": "cisco-tc:EntPhysicalIndexOrZero" }, "cmgwServiceState": { "type": "string", "description": "This object indicates the current service state of the Media \n Gateway.\n This object is controlled by 'cmgwAdminState' \n object.", "x-yang-type": "CISCO-MEDIA-GATEWAY-MIB:CGwServiceState" }, "cmgwAdminState": { "type": "string", "description": "This object is used to change the service state of \n the Media Gateway from inService to outOfService or from \n outOfService to inService. \n The resulting service state of the gateway is represented \n by 'cmgwServiceState'.", "x-yang-type": "CISCO-MEDIA-GATEWAY-MIB:CGwAdminState" }, "cmgwGraceTime": { "type": "integer", "description": "This object is used to represent grace period.\n The grace period (restart delay in RSIP message) is \n expressed in a number of seconds. \n It means how soon the gateway will be taken out of service.\n The value -1 indicates that the grace period time is\n disabled.", "minimum": -2147483648, "maximum": 2147483647 }, "cmgwVtMappingMode": { "type": "string", "description": "This object is used to represent the VT (sonet Virtual\n Tributary) counting.\n \n standard - standard counting (based on Bellcore TR253)\n titan - TITAN5500 counting (based on Tellabs TITAN 5500)\n \n Note: 'titan' is valid only if sonet line medium type \n (sonetMediumType of SONET-MIB) is 'sonet' and \n sonet path payload type (cspSonetPathPayload of\n CISCO-SONET-MIB) is 'vt15vc11'." }, "cmgwSrcFilterEnabled": { "type": "boolean", "description": "This object is used to enable or disable the source IP\n and port filtering with MGC for security consideration\n as follows:\n 'true' - source IP and port filter is enabled \n 'false' - source IP and port filter is disable" }, "cmgwLawInterceptEnabled": { "type": "boolean", "description": "This object is used to enable or disable the lawful\n intercept for government.\n as follows:\n 'true' - enable lawful intercept\n 'false' - disable lawful intercept" }, "cmgwV23Enabled": { "type": "boolean", "description": "This object is to enable or disable V23 tone.\n Setting the object value to 'true', will cause VXSM (Voice Switching\n Service Module) to detect V23 tone." } } }, "example": { "CISCO-MEDIA-GATEWAY-MIB:cMediaGwEntry": { "cmgwIndex": 1, "cmgwDomainName": "interface-1", "cmgwPhysicalIndex": "example-string", "cmgwServiceState": "up(1)", "cmgwAdminState": "up(1)", "cmgwGraceTime": -2147483648, "cmgwVtMappingMode": "example-string", "cmgwSrcFilterEnabled": true, "cmgwLawInterceptEnabled": true, "cmgwV23Enabled": true } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cMediaGwEntry-2" }, "x-yang-path": "/cMediaGwTable/cMediaGwEntry={cmgwIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cmgwIndex" ] }, "/data/CISCO-MEDIA-GATEWAY-MIB:cmgwSignalProtocolTable": { "get": { "summary": "Get cmgwSignalProtocolTable data", "description": "Retrieve cmgwSignalProtocolTable operational data from MIB", "tags": [ "CISCO-MEDIA-GATEWAY-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table contains the available signaling protocols that\n are supported by the media gateway for communication with\n MGCs.", "properties": { "cmgwSignalProtocolEntry": { "type": "array", "description": "Each entry represents an signaling protocol supported\n by the media gateway.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref" }, "cmgwSignalProtocolIndex": { "type": "integer", "description": "An index that uniquely identifies an entry in\n cmgwSignalProtocolTable.", "minimum": -2147483648, "maximum": 2147483647 }, "cmgwSignalProtocol": { "type": "string", "description": "This object is used to represent the protocol type.\n other - None of the following types.\n mgcp - Media Gateway Control Protocol\n h248 - Media Gateway Control (ITU H.248)\n tgcp - Trunking Gateway Control Protocol" }, "cmgwSignalProtocolVersion": { "type": "string", "description": "This object is used to represent the protocol version. \n For example cmgwSignalProtocol is 'mgcp(2)' and\n this object is string '1.0'. cmgwSignalProtocol is \n 'h248(3)' and this object is set to '2.0'.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cmgwSignalProtocolPort": { "type": "string", "description": "This object is used to represent the UDP port associated \n with the protocol.\n If the value of cmgwSignalProtocol is 'mgcp(2)' and the\n value of cmgwSignalProtcolVersion is '1.0', the default\n value of this object is '2727'. \n If the value of cmgwSignalProtocol is 'h248(3)' and the\n value of cmgwSignalProtcolVersion is '1.0', the default\n value of this object is '2944'.", "x-yang-type": "cisco-tc:CiscoPort" }, "cmgwSignalMgcProtocolPort": { "type": "string", "description": "This object specifies the protocol port of the Media Gateway\n Controller (MGC).\n If the value of cmgwSignalProtocol is 'mgcp(2)' or 'tgcp(4)'\n and the value of cmgwSignalProtcolVersion is '1.0', the\n default value of this object is '2427'.\n If the value of cmgwSignalProtocol is 'h248(3)' and the\n value of cmgwSignalProtcolVersion is '1.0', the default\n value of this object is '2944'.", "format": "inet:port-number" }, "cmgwSignalProtocolPreference": { "type": "integer", "description": "This object specifies the preference of the signal protocol \n supported in the media gateway.\n \n If this object is set to 0, the corresponding signal\n protocol will not be used by the gateway.\n \n The value of this object is unique within the corresponding\n gateway. The entry with lower value has higher preference.", "minimum": -2147483648, "maximum": 2147483647 }, "cmgwSignalProtocolConfigVer": { "type": "string", "description": "This object specifies the protocol version\n used by the gateway in the messages to MGC\n in order to exchange the service capabilities.\n \n For example cmgwSignalProtocol is 'h248(3)' and\n this object can be string '1' or '1.0', '2' or '2.0'. \n \n 'MAX' is a special string indicating the gateway will\n use the highest protocol version supported in the \n gateway, but it can be changed to lower version after \n it negotiates with MGC. The final negotiated protocol\n version will be indicated in cmgwSignalProtocolVersion.\n \n The version strings other than 'MAX' can be specified for\n the gateway to communicate with the MGC which doesn't\n support service capabilities negotiation. For example if\n a MGC supports only version 1.0 MGCP, this object should\n be set to '1' to instruct the gateway using MGCP \n version 1.0 format messages to communicate with MGC.", "x-yang-type": "snmp-framework:SnmpAdminString" } } } } } }, "example": { "CISCO-MEDIA-GATEWAY-MIB:cmgwSignalProtocolTable": { "cmgwSignalProtocolEntry": [ { "cmgwIndex": "1", "cmgwSignalProtocolIndex": 1, "cmgwSignalProtocol": "example-string", "cmgwSignalProtocolVersion": "example-string", "cmgwSignalProtocolPort": "example-string", "cmgwSignalMgcProtocolPort": "example-string", "cmgwSignalProtocolPreference": -2147483648, "cmgwSignalProtocolConfigVer": "example-string" }, { "cmgwIndex": "2", "cmgwSignalProtocolIndex": 2, "cmgwSignalProtocol": "example-string", "cmgwSignalProtocolVersion": "example-string", "cmgwSignalProtocolPort": "example-string", "cmgwSignalMgcProtocolPort": "example-string", "cmgwSignalProtocolPreference": -2147483648, "cmgwSignalProtocolConfigVer": "example-string" }, { "cmgwIndex": "3", "cmgwSignalProtocolIndex": 3, "cmgwSignalProtocol": "example-string", "cmgwSignalProtocolVersion": "example-string", "cmgwSignalProtocolPort": "example-string", "cmgwSignalMgcProtocolPort": "example-string", "cmgwSignalProtocolPreference": -2147483648, "cmgwSignalProtocolConfigVer": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cmgwSignalProtocolTable", "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": "/cmgwSignalProtocolTable", "x-restconf-kind": "container" }, "/data/CISCO-MEDIA-GATEWAY-MIB:cmgwSignalProtocolTable/cmgwSignalProtocolEntry": { "get": { "summary": "Get cmgwSignalProtocolEntry list", "description": "Retrieve list of cmgwSignalProtocolEntry entries from MIB", "tags": [ "CISCO-MEDIA-GATEWAY-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Each entry represents an signaling protocol supported\n by the media gateway.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref" }, "cmgwSignalProtocolIndex": { "type": "integer", "description": "An index that uniquely identifies an entry in\n cmgwSignalProtocolTable.", "minimum": -2147483648, "maximum": 2147483647 }, "cmgwSignalProtocol": { "type": "string", "description": "This object is used to represent the protocol type.\n other - None of the following types.\n mgcp - Media Gateway Control Protocol\n h248 - Media Gateway Control (ITU H.248)\n tgcp - Trunking Gateway Control Protocol" }, "cmgwSignalProtocolVersion": { "type": "string", "description": "This object is used to represent the protocol version. \n For example cmgwSignalProtocol is 'mgcp(2)' and\n this object is string '1.0'. cmgwSignalProtocol is \n 'h248(3)' and this object is set to '2.0'.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cmgwSignalProtocolPort": { "type": "string", "description": "This object is used to represent the UDP port associated \n with the protocol.\n If the value of cmgwSignalProtocol is 'mgcp(2)' and the\n value of cmgwSignalProtcolVersion is '1.0', the default\n value of this object is '2727'. \n If the value of cmgwSignalProtocol is 'h248(3)' and the\n value of cmgwSignalProtcolVersion is '1.0', the default\n value of this object is '2944'.", "x-yang-type": "cisco-tc:CiscoPort" }, "cmgwSignalMgcProtocolPort": { "type": "string", "description": "This object specifies the protocol port of the Media Gateway\n Controller (MGC).\n If the value of cmgwSignalProtocol is 'mgcp(2)' or 'tgcp(4)'\n and the value of cmgwSignalProtcolVersion is '1.0', the\n default value of this object is '2427'.\n If the value of cmgwSignalProtocol is 'h248(3)' and the\n value of cmgwSignalProtcolVersion is '1.0', the default\n value of this object is '2944'.", "format": "inet:port-number" }, "cmgwSignalProtocolPreference": { "type": "integer", "description": "This object specifies the preference of the signal protocol \n supported in the media gateway.\n \n If this object is set to 0, the corresponding signal\n protocol will not be used by the gateway.\n \n The value of this object is unique within the corresponding\n gateway. The entry with lower value has higher preference.", "minimum": -2147483648, "maximum": 2147483647 }, "cmgwSignalProtocolConfigVer": { "type": "string", "description": "This object specifies the protocol version\n used by the gateway in the messages to MGC\n in order to exchange the service capabilities.\n \n For example cmgwSignalProtocol is 'h248(3)' and\n this object can be string '1' or '1.0', '2' or '2.0'. \n \n 'MAX' is a special string indicating the gateway will\n use the highest protocol version supported in the \n gateway, but it can be changed to lower version after \n it negotiates with MGC. The final negotiated protocol\n version will be indicated in cmgwSignalProtocolVersion.\n \n The version strings other than 'MAX' can be specified for\n the gateway to communicate with the MGC which doesn't\n support service capabilities negotiation. For example if\n a MGC supports only version 1.0 MGCP, this object should\n be set to '1' to instruct the gateway using MGCP \n version 1.0 format messages to communicate with MGC.", "x-yang-type": "snmp-framework:SnmpAdminString" } } } }, "example": { "CISCO-MEDIA-GATEWAY-MIB:cmgwSignalProtocolEntry": [ { "cmgwIndex": "example-string", "cmgwSignalProtocolIndex": 1, "cmgwSignalProtocol": "example-string", "cmgwSignalProtocolVersion": "example-string", "cmgwSignalProtocolPort": "example-string", "cmgwSignalMgcProtocolPort": "example-string", "cmgwSignalProtocolPreference": -2147483648, "cmgwSignalProtocolConfigVer": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cmgwSignalProtocolEntry", "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": "/cmgwSignalProtocolTable/cmgwSignalProtocolEntry", "x-restconf-kind": "container" }, "/data/CISCO-MEDIA-GATEWAY-MIB:cMediaGwIpConfigTable": { "get": { "summary": "Get cMediaGwIpConfigTable data", "description": "Retrieve cMediaGwIpConfigTable operational data from MIB", "tags": [ "CISCO-MEDIA-GATEWAY-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "cMediaGwIpConfigTable", "properties": { "cMediaGwIpConfigEntry": { "type": "array", "description": "A Media Gateway IP configuration entry. \n Each entry represents a media gateway IP address for MGCs\n to communicate with the media gateway.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref" }, "cmgwIpConfigIndex": { "type": "integer", "description": "A unique index to identify each media gateway IP address.", "minimum": -2147483648, "maximum": 2147483647 }, "cmgwIpConfigIfIndex": { "type": "string", "description": "This object is ifIndex of the interface which is associated\n to the media gateway IP address.\n \n For ATM interface, the IP address should be associated to\n an existing PVC:\n cmgwIpConfigIfIndex represents port of the PVC\n cmgwIpConfigVpi represents VPI of the PVC\n cmgwIpConfigVci represents VCI of the PVC\n And one PVC only can be associated with one IP address.\n \n If this object is set to zero which means the IP address\n is not associated to any interface.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "cmgwIpConfigVpi": { "type": "integer", "description": "This object represents VPI of the PVC which is associated\n to the IP address.\n If the IP address is not associated to PVC, the value \n of this object is set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "cmgwIpConfigVci": { "type": "integer", "description": "This object represents VCI of the PVC which is associated\n to the IP address.\n If the IP address is not associated to PVC, the value\n of this object is set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "cmgwIpConfigAddrType": { "type": "string", "description": "This object is the IP address type.", "x-yang-type": "inet-address:InetAddressType" }, "cmgwIpConfigAddress": { "type": "string", "description": "The configured IP address of media gateway.\n This object can not be modified.", "x-yang-type": "inet-address:InetAddress" }, "cmgwIpConfigSubnetMask": { "type": "string", "description": "This object is used to specify the number of leading one \n bits which from the mask to be logical-ANDed with the media \n gateway address before being compared to the value in the \n cmgwIpCofigAddress.\n \n Any assignment (implicit or otherwise) of an instance of\n this object to a value x must be rejected if the bitwise\n logical-AND of the mask formed from x with the value \n of the corresponding instance of the cmgwIpCofigAddress \n object is not equal to cmgwIpCofigAddress.", "x-yang-type": "inet-address:InetAddressPrefixLength" }, "cmgwIpConfigDefaultGwIp": { "type": "boolean", "description": "This object specifies cmgwIpConfigAddress of the entry\n will become the default gateway address.\n This object can be set to 'true' for only one entry in\n the table." }, "cmgwIpConfigForRemoteMapping": { "type": "boolean", "description": "This object specifies whether the address defined in\n cmgwIpConfigAddress is the address mapping at the\n remote end of this PVC. \n \n If this object is set to 'true', the address defined\n in cmgwIpConfigAddress is for the remote end of the PVC.\n If this object is set to 'false', the address defined\n in cmgwIpConfigAddress is for the local end of the PVC." }, "cmgwIpConfigRowStatus": { "type": "string", "description": "This object is used to add and delete an entry.\n \n When an entry of the table is created, the following \n objects are mandatory:\n cmgwIpConfigIfIndex\n cmgwIpConfigVpi\n cmgwIpConfigVci\n cmgwIpConfigAddress\n cmgwIpConfigSubnetMask\n \n These objects can not be modified after the value of this\n object is set to 'active'. \n Modification can only be done by deleting and re-adding the \n entry again.\n \n After the system verify the validity of the data, it\n will set the cmgwIpConfigRowStatus to 'active'.", "x-yang-type": "snmpv2-tc:RowStatus" } } } } } }, "example": { "CISCO-MEDIA-GATEWAY-MIB:cMediaGwIpConfigTable": { "cMediaGwIpConfigEntry": [ { "cmgwIndex": "1", "cmgwIpConfigIndex": 1, "cmgwIpConfigIfIndex": "1", "cmgwIpConfigVpi": -2147483648, "cmgwIpConfigVci": -2147483648, "cmgwIpConfigAddrType": "192.168.1.1", "cmgwIpConfigAddress": "192.168.1.1", "cmgwIpConfigSubnetMask": "192.168.1.1", "cmgwIpConfigDefaultGwIp": true, "cmgwIpConfigForRemoteMapping": true, "cmgwIpConfigRowStatus": "192.168.1.1" }, { "cmgwIndex": "2", "cmgwIpConfigIndex": 2, "cmgwIpConfigIfIndex": "2", "cmgwIpConfigVpi": -2147483648, "cmgwIpConfigVci": -2147483648, "cmgwIpConfigAddrType": "192.168.1.1", "cmgwIpConfigAddress": "192.168.1.1", "cmgwIpConfigSubnetMask": "192.168.1.1", "cmgwIpConfigDefaultGwIp": true, "cmgwIpConfigForRemoteMapping": true, "cmgwIpConfigRowStatus": "192.168.1.1" }, { "cmgwIndex": "3", "cmgwIpConfigIndex": 3, "cmgwIpConfigIfIndex": "3", "cmgwIpConfigVpi": -2147483648, "cmgwIpConfigVci": -2147483648, "cmgwIpConfigAddrType": "192.168.1.1", "cmgwIpConfigAddress": "192.168.1.1", "cmgwIpConfigSubnetMask": "192.168.1.1", "cmgwIpConfigDefaultGwIp": true, "cmgwIpConfigForRemoteMapping": true, "cmgwIpConfigRowStatus": "192.168.1.1" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cMediaGwIpConfigTable", "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": "/cMediaGwIpConfigTable", "x-restconf-kind": "container" }, "/data/CISCO-MEDIA-GATEWAY-MIB:cMediaGwIpConfigTable/cMediaGwIpConfigEntry": { "get": { "summary": "Get cMediaGwIpConfigEntry list", "description": "Retrieve list of cMediaGwIpConfigEntry entries from MIB", "tags": [ "CISCO-MEDIA-GATEWAY-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A Media Gateway IP configuration entry. \n Each entry represents a media gateway IP address for MGCs\n to communicate with the media gateway.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref" }, "cmgwIpConfigIndex": { "type": "integer", "description": "A unique index to identify each media gateway IP address.", "minimum": -2147483648, "maximum": 2147483647 }, "cmgwIpConfigIfIndex": { "type": "string", "description": "This object is ifIndex of the interface which is associated\n to the media gateway IP address.\n \n For ATM interface, the IP address should be associated to\n an existing PVC:\n cmgwIpConfigIfIndex represents port of the PVC\n cmgwIpConfigVpi represents VPI of the PVC\n cmgwIpConfigVci represents VCI of the PVC\n And one PVC only can be associated with one IP address.\n \n If this object is set to zero which means the IP address\n is not associated to any interface.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "cmgwIpConfigVpi": { "type": "integer", "description": "This object represents VPI of the PVC which is associated\n to the IP address.\n If the IP address is not associated to PVC, the value \n of this object is set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "cmgwIpConfigVci": { "type": "integer", "description": "This object represents VCI of the PVC which is associated\n to the IP address.\n If the IP address is not associated to PVC, the value\n of this object is set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "cmgwIpConfigAddrType": { "type": "string", "description": "This object is the IP address type.", "x-yang-type": "inet-address:InetAddressType" }, "cmgwIpConfigAddress": { "type": "string", "description": "The configured IP address of media gateway.\n This object can not be modified.", "x-yang-type": "inet-address:InetAddress" }, "cmgwIpConfigSubnetMask": { "type": "string", "description": "This object is used to specify the number of leading one \n bits which from the mask to be logical-ANDed with the media \n gateway address before being compared to the value in the \n cmgwIpCofigAddress.\n \n Any assignment (implicit or otherwise) of an instance of\n this object to a value x must be rejected if the bitwise\n logical-AND of the mask formed from x with the value \n of the corresponding instance of the cmgwIpCofigAddress \n object is not equal to cmgwIpCofigAddress.", "x-yang-type": "inet-address:InetAddressPrefixLength" }, "cmgwIpConfigDefaultGwIp": { "type": "boolean", "description": "This object specifies cmgwIpConfigAddress of the entry\n will become the default gateway address.\n This object can be set to 'true' for only one entry in\n the table." }, "cmgwIpConfigForRemoteMapping": { "type": "boolean", "description": "This object specifies whether the address defined in\n cmgwIpConfigAddress is the address mapping at the\n remote end of this PVC. \n \n If this object is set to 'true', the address defined\n in cmgwIpConfigAddress is for the remote end of the PVC.\n If this object is set to 'false', the address defined\n in cmgwIpConfigAddress is for the local end of the PVC." }, "cmgwIpConfigRowStatus": { "type": "string", "description": "This object is used to add and delete an entry.\n \n When an entry of the table is created, the following \n objects are mandatory:\n cmgwIpConfigIfIndex\n cmgwIpConfigVpi\n cmgwIpConfigVci\n cmgwIpConfigAddress\n cmgwIpConfigSubnetMask\n \n These objects can not be modified after the value of this\n object is set to 'active'. \n Modification can only be done by deleting and re-adding the \n entry again.\n \n After the system verify the validity of the data, it\n will set the cmgwIpConfigRowStatus to 'active'.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "CISCO-MEDIA-GATEWAY-MIB:cMediaGwIpConfigEntry": [ { "cmgwIndex": "example-string", "cmgwIpConfigIndex": 1, "cmgwIpConfigIfIndex": "192.168.1.1", "cmgwIpConfigVpi": -2147483648, "cmgwIpConfigVci": -2147483648, "cmgwIpConfigAddrType": "192.168.1.1", "cmgwIpConfigAddress": "192.168.1.1", "cmgwIpConfigSubnetMask": "192.168.1.1", "cmgwIpConfigDefaultGwIp": true, "cmgwIpConfigForRemoteMapping": true, "cmgwIpConfigRowStatus": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cMediaGwIpConfigEntry", "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": "/cMediaGwIpConfigTable/cMediaGwIpConfigEntry", "x-restconf-kind": "container" }, "/data/CISCO-MEDIA-GATEWAY-MIB:cMediaGwDomainNameConfigTable": { "get": { "summary": "Get cMediaGwDomainNameConfigTable data", "description": "Retrieve cMediaGwDomainNameConfigTable operational data from MIB", "tags": [ "CISCO-MEDIA-GATEWAY-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table provides the domain names which are configured by \n users. \n The domain names can be used to represent IP addresses \n for:\n gateway\n External DNS name server\n MGC (call agent)", "properties": { "cMediaGwDomainNameConfigEntry": { "type": "array", "description": "Each entry represents a domain name used in the system.\n \n Creation and deletion are supported. Modification\n is prohibited.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref" }, "cmgwConfigDomainNameIndex": { "type": "integer", "description": "An index that is uniquely identifies a domain name\n configured in the system.", "minimum": -2147483648, "maximum": 2147483647 }, "cmgwConfigDomainNameEntity": { "type": "string", "description": "This object indicates which entity to use this domain name.\n \n gateway(1) - The domain name of media gateway.\n With the same cmgwIndex, there is one and \n only one entry allowed with the value \n 'gateway(1)' of this object.\n \n dnsServer(2) - The domain name of DNS name server that is used \n by Media gateway to find Internet Network \n Address from a DNS name.\n \n mgc(3) - The domain name of a MGC (Media Gateway\n Controller) associated with the media \n gateway." }, "cmgwConfigDomainName": { "type": "string", "description": "This object specifies the domain name.\n \n The domain name should be unique if there are more than\n one entries having the same value in the object \n cmgwConfigDomainNameEntity.\n For example, the gateway domain name should be unique \n if the cmgwConfigDomainNameEntity has the value of \n 'gateway(1)'.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cmgwConfigDomainNameRowStatus": { "type": "string", "description": "This object is used to add and delete an entry.\n \n When an entry is created, the following objects\n are mandatory:\n cmgwConfigDomainName\n cmgwConfigDomainNameEntity\n \n When deleting domain name of DNS name server\n (cmgwConfigDomainNameEntity is dnsServer (2)), the \n cMediaGwDnsIpConfigTable should be empty.\n \n Adding/deleting entry with cmgwConfigDomainNameEntity\n of 'mgc' will cause adding/deleting entry in \n cMgcConfigTable (CISCO-MGC-MIB) automatically.\n \n The cmgwConfigDomainName and cmgwConfigDomainNameEntity\n can not be modified if the value of this object is\n 'active'.", "x-yang-type": "snmpv2-tc:RowStatus" } } } } } }, "example": { "CISCO-MEDIA-GATEWAY-MIB:cMediaGwDomainNameConfigTable": { "cMediaGwDomainNameConfigEntry": [ { "cmgwIndex": "1", "cmgwConfigDomainNameIndex": 1, "cmgwConfigDomainNameEntity": "interface-1", "cmgwConfigDomainName": "interface-1", "cmgwConfigDomainNameRowStatus": "up(1)" }, { "cmgwIndex": "2", "cmgwConfigDomainNameIndex": 2, "cmgwConfigDomainNameEntity": "interface-1", "cmgwConfigDomainName": "interface-1", "cmgwConfigDomainNameRowStatus": "up(1)" }, { "cmgwIndex": "3", "cmgwConfigDomainNameIndex": 3, "cmgwConfigDomainNameEntity": "interface-1", "cmgwConfigDomainName": "interface-1", "cmgwConfigDomainNameRowStatus": "up(1)" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cMediaGwDomainNameConfigTable", "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": "/cMediaGwDomainNameConfigTable", "x-restconf-kind": "container" }, "/data/CISCO-MEDIA-GATEWAY-MIB:cMediaGwDomainNameConfigTable/cMediaGwDomainNameConfigEntry": { "get": { "summary": "Get cMediaGwDomainNameConfigEntry list", "description": "Retrieve list of cMediaGwDomainNameConfigEntry entries from MIB", "tags": [ "CISCO-MEDIA-GATEWAY-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Each entry represents a domain name used in the system.\n \n Creation and deletion are supported. Modification\n is prohibited.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref" }, "cmgwConfigDomainNameIndex": { "type": "integer", "description": "An index that is uniquely identifies a domain name\n configured in the system.", "minimum": -2147483648, "maximum": 2147483647 }, "cmgwConfigDomainNameEntity": { "type": "string", "description": "This object indicates which entity to use this domain name.\n \n gateway(1) - The domain name of media gateway.\n With the same cmgwIndex, there is one and \n only one entry allowed with the value \n 'gateway(1)' of this object.\n \n dnsServer(2) - The domain name of DNS name server that is used \n by Media gateway to find Internet Network \n Address from a DNS name.\n \n mgc(3) - The domain name of a MGC (Media Gateway\n Controller) associated with the media \n gateway." }, "cmgwConfigDomainName": { "type": "string", "description": "This object specifies the domain name.\n \n The domain name should be unique if there are more than\n one entries having the same value in the object \n cmgwConfigDomainNameEntity.\n For example, the gateway domain name should be unique \n if the cmgwConfigDomainNameEntity has the value of \n 'gateway(1)'.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cmgwConfigDomainNameRowStatus": { "type": "string", "description": "This object is used to add and delete an entry.\n \n When an entry is created, the following objects\n are mandatory:\n cmgwConfigDomainName\n cmgwConfigDomainNameEntity\n \n When deleting domain name of DNS name server\n (cmgwConfigDomainNameEntity is dnsServer (2)), the \n cMediaGwDnsIpConfigTable should be empty.\n \n Adding/deleting entry with cmgwConfigDomainNameEntity\n of 'mgc' will cause adding/deleting entry in \n cMgcConfigTable (CISCO-MGC-MIB) automatically.\n \n The cmgwConfigDomainName and cmgwConfigDomainNameEntity\n can not be modified if the value of this object is\n 'active'.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "CISCO-MEDIA-GATEWAY-MIB:cMediaGwDomainNameConfigEntry": [ { "cmgwIndex": "example-string", "cmgwConfigDomainNameIndex": 1, "cmgwConfigDomainNameEntity": "interface-1", "cmgwConfigDomainName": "interface-1", "cmgwConfigDomainNameRowStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cMediaGwDomainNameConfigEntry", "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": "/cMediaGwDomainNameConfigTable/cMediaGwDomainNameConfigEntry", "x-restconf-kind": "container" }, "/data/CISCO-MEDIA-GATEWAY-MIB:cMediaGwDnsIpConfigTable": { "get": { "summary": "Get cMediaGwDnsIpConfigTable data", "description": "Retrieve cMediaGwDnsIpConfigTable operational data from MIB", "tags": [ "CISCO-MEDIA-GATEWAY-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "There is only one DNS name server on a gateway\n and the domain name of the DNS name server is put on \n cMediaGwDomainNameConfigTable with 'dnsServer (2)'.\n \n There could be multi IP addresses are associated with the\n DNS name server, this table is used to store these IP \n addresses.\n \n If any domain name using external resolution, the last entry\n of this table is not allowed to be deleted.", "properties": { "cMediaGwDnsIpConfigEntry": { "type": "array", "description": "Each entry represents an IP address of the DNS name \n server.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref" }, "cmgwDnsIpIndex": { "type": "integer", "description": "An index that uniquely identifies an IP address of DNS\n name server.", "minimum": -2147483648, "maximum": 2147483647 }, "cmgwDnsDomainName": { "type": "string", "description": "The domain name of DNS name server.\n \n The value of this object reflects the value of \n cmgwConfigDomainName from the entry with a value of \n 'dnsServer(2)' for object cmgwConfigDomainNameEntity of \n cMediaGwDomainNameConfigTable.\n \n If there is no entry in cMediaGwDomainNameConfigTable with\n 'dnsServer(2)' of cmgwConfigDomainNameEntity, then\n the value of this object will be empty string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cmgwDnsIpType": { "type": "string", "description": "DNS name server IP address type.", "x-yang-type": "inet-address:InetAddressType" }, "cmgwDnsIp": { "type": "string", "description": "The IP address of DNS name server.\n The IP address of DNS name server must be unique\n in this table.", "x-yang-type": "inet-address:InetAddress" }, "cmgwDnsIpRowStatus": { "type": "string", "description": "This object is used to add and delete an entry.\n \n When an entry of the table is created, the value of\n this object should be set to 'createAndGo' and the\n following objects are mandatory:\n cmgwDnsIp\n \n When the user wants to delete the entry, the value of\n this object should be set to 'destroy'.\n \n The entry can not be modified if the value of this \n object is 'active'.", "x-yang-type": "snmpv2-tc:RowStatus" } } } } } }, "example": { "CISCO-MEDIA-GATEWAY-MIB:cMediaGwDnsIpConfigTable": { "cMediaGwDnsIpConfigEntry": [ { "cmgwIndex": "1", "cmgwDnsIpIndex": 1, "cmgwDnsDomainName": "interface-1", "cmgwDnsIpType": "192.168.1.1", "cmgwDnsIp": "192.168.1.1", "cmgwDnsIpRowStatus": "192.168.1.1" }, { "cmgwIndex": "2", "cmgwDnsIpIndex": 2, "cmgwDnsDomainName": "interface-1", "cmgwDnsIpType": "192.168.1.1", "cmgwDnsIp": "192.168.1.1", "cmgwDnsIpRowStatus": "192.168.1.1" }, { "cmgwIndex": "3", "cmgwDnsIpIndex": 3, "cmgwDnsDomainName": "interface-1", "cmgwDnsIpType": "192.168.1.1", "cmgwDnsIp": "192.168.1.1", "cmgwDnsIpRowStatus": "192.168.1.1" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cMediaGwDnsIpConfigTable", "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": "/cMediaGwDnsIpConfigTable", "x-restconf-kind": "container" }, "/data/CISCO-MEDIA-GATEWAY-MIB:cMediaGwDnsIpConfigTable/cMediaGwDnsIpConfigEntry": { "get": { "summary": "Get cMediaGwDnsIpConfigEntry list", "description": "Retrieve list of cMediaGwDnsIpConfigEntry entries from MIB", "tags": [ "CISCO-MEDIA-GATEWAY-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Each entry represents an IP address of the DNS name \n server.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref" }, "cmgwDnsIpIndex": { "type": "integer", "description": "An index that uniquely identifies an IP address of DNS\n name server.", "minimum": -2147483648, "maximum": 2147483647 }, "cmgwDnsDomainName": { "type": "string", "description": "The domain name of DNS name server.\n \n The value of this object reflects the value of \n cmgwConfigDomainName from the entry with a value of \n 'dnsServer(2)' for object cmgwConfigDomainNameEntity of \n cMediaGwDomainNameConfigTable.\n \n If there is no entry in cMediaGwDomainNameConfigTable with\n 'dnsServer(2)' of cmgwConfigDomainNameEntity, then\n the value of this object will be empty string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cmgwDnsIpType": { "type": "string", "description": "DNS name server IP address type.", "x-yang-type": "inet-address:InetAddressType" }, "cmgwDnsIp": { "type": "string", "description": "The IP address of DNS name server.\n The IP address of DNS name server must be unique\n in this table.", "x-yang-type": "inet-address:InetAddress" }, "cmgwDnsIpRowStatus": { "type": "string", "description": "This object is used to add and delete an entry.\n \n When an entry of the table is created, the value of\n this object should be set to 'createAndGo' and the\n following objects are mandatory:\n cmgwDnsIp\n \n When the user wants to delete the entry, the value of\n this object should be set to 'destroy'.\n \n The entry can not be modified if the value of this \n object is 'active'.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "CISCO-MEDIA-GATEWAY-MIB:cMediaGwDnsIpConfigEntry": [ { "cmgwIndex": "example-string", "cmgwDnsIpIndex": 1, "cmgwDnsDomainName": "interface-1", "cmgwDnsIpType": "192.168.1.1", "cmgwDnsIp": "192.168.1.1", "cmgwDnsIpRowStatus": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cMediaGwDnsIpConfigEntry", "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": "/cMediaGwDnsIpConfigTable/cMediaGwDnsIpConfigEntry", "x-restconf-kind": "container" }, "/data/CISCO-MEDIA-GATEWAY-MIB:cmgwLifTable": { "get": { "summary": "Get cmgwLifTable data", "description": "Retrieve cmgwLifTable operational data from MIB", "tags": [ "CISCO-MEDIA-GATEWAY-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table is for managing LIF (Logical Interface) \n in a media gateway. \n \n LIF is a logical interface which groups the TDM \n DSx1s associated with a set of packet resource partitions \n (PVCs) in a media gateway.\n \n LIF is used for:\n 1. VoIP switching \n 2. VoATM switching", "properties": { "cmgwLifEntry": { "type": "array", "description": "An entry of this table is created by the media gateway\n when it supports the VoIP/VoATM application.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref" }, "cmgwLifNumber": { "type": "string", "description": "An index that uniquely identifies a LIF in the \n media gateway.", "x-yang-type": "CISCO-MEDIA-GATEWAY-MIB:GatewayLifNumber" }, "cmgwLifPvcCount": { "type": "integer", "description": "This object represents the total number of PVC within \n this LIF.\n \n When users associate/disassociate a PVC with a LIF \n by giving a non-zero/zero value of cwacChanLifNum\n in cwAtmChanExtConfigTable, the value of this object \n will be incremented/decremented accordingly.\n \n The value zero means there is no PVC associated with \n the LIF.", "minimum": 0, "maximum": 4294967295 }, "cmgwLifVoiceIfCount": { "type": "integer", "description": "This object represents the total number of Voice Interfaces\n within this LIF.\n \n When users associate/disassociate a Voice Interface with\n a LIF by giving a non-zero/zero value of \n ccasVoiceCfgLifNumber for the DS0 group in \n ccasVoiceExtCfgTable, the value of this object will be \n incremented/decremented accordingly. \n \n The value zero means there is no Voice Interface associated\n with the LIF.", "minimum": 0, "maximum": 4294967295 } } } } } }, "example": { "CISCO-MEDIA-GATEWAY-MIB:cmgwLifTable": { "cmgwLifEntry": [ { "cmgwIndex": "1", "cmgwLifNumber": "example-string", "cmgwLifPvcCount": 0, "cmgwLifVoiceIfCount": 0 }, { "cmgwIndex": "2", "cmgwLifNumber": "example-string", "cmgwLifPvcCount": 0, "cmgwLifVoiceIfCount": 0 }, { "cmgwIndex": "3", "cmgwLifNumber": "example-string", "cmgwLifPvcCount": 0, "cmgwLifVoiceIfCount": 0 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cmgwLifTable", "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": "/cmgwLifTable", "x-restconf-kind": "container" }, "/data/CISCO-MEDIA-GATEWAY-MIB:cmgwLifTable/cmgwLifEntry": { "get": { "summary": "Get cmgwLifEntry list", "description": "Retrieve list of cmgwLifEntry entries from MIB", "tags": [ "CISCO-MEDIA-GATEWAY-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry of this table is created by the media gateway\n when it supports the VoIP/VoATM application.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref" }, "cmgwLifNumber": { "type": "string", "description": "An index that uniquely identifies a LIF in the \n media gateway.", "x-yang-type": "CISCO-MEDIA-GATEWAY-MIB:GatewayLifNumber" }, "cmgwLifPvcCount": { "type": "integer", "description": "This object represents the total number of PVC within \n this LIF.\n \n When users associate/disassociate a PVC with a LIF \n by giving a non-zero/zero value of cwacChanLifNum\n in cwAtmChanExtConfigTable, the value of this object \n will be incremented/decremented accordingly.\n \n The value zero means there is no PVC associated with \n the LIF.", "minimum": 0, "maximum": 4294967295 }, "cmgwLifVoiceIfCount": { "type": "integer", "description": "This object represents the total number of Voice Interfaces\n within this LIF.\n \n When users associate/disassociate a Voice Interface with\n a LIF by giving a non-zero/zero value of \n ccasVoiceCfgLifNumber for the DS0 group in \n ccasVoiceExtCfgTable, the value of this object will be \n incremented/decremented accordingly. \n \n The value zero means there is no Voice Interface associated\n with the LIF.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-MEDIA-GATEWAY-MIB:cmgwLifEntry": [ { "cmgwIndex": "example-string", "cmgwLifNumber": "example-string", "cmgwLifPvcCount": 0, "cmgwLifVoiceIfCount": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cmgwLifEntry", "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": "/cmgwLifTable/cmgwLifEntry", "x-restconf-kind": "container" }, "/data/CISCO-MEDIA-GATEWAY-MIB:cMediaGwCallControlConfigTable": { "get": { "summary": "Get cMediaGwCallControlConfigTable data", "description": "Retrieve cMediaGwCallControlConfigTable operational data from MIB", "tags": [ "CISCO-MEDIA-GATEWAY-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table defines general call control attributes for\n the media gateway.", "properties": { "cMediaGwCallControlConfigEntry": { "type": "array", "description": "One entry for each media gateway which supports call control \n protocol.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref" }, "cMediaGwCcCfgControlTos": { "type": "integer", "description": "This object specifies Type Of Service (TOS) field of\n IP header for the signaling control packet in VoIP\n application.", "minimum": 0, "maximum": 4294967295 }, "cMediaGwCcCfgBearerTos": { "type": "integer", "description": "This object specifies Type Of Service (TOS) field\n of IP header for the voice payload packet in VoIP\n application.", "minimum": 0, "maximum": 4294967295 }, "cMediaGwCcCfgNtePayload": { "type": "integer", "description": "This object specifies NTE (Named Telephony Events)\n payload type.", "minimum": 0, "maximum": 4294967295 }, "cMediaGwCcCfgNsePayload": { "type": "integer", "description": "This object specifies NSE (Network Signaling Events)\n payload type.", "minimum": 0, "maximum": 4294967295 }, "cMediaGwCcCfgNseRespTimer": { "type": "integer", "description": "This object specifies Network Signaling Event (NSE)\n timeout value.", "minimum": 0, "maximum": 4294967295 }, "cMediaGwCcCfgVbdJitterDelayMode": { "type": "string", "description": "The object specifies the jitter buffer mode applied to\n a VBD (Voice Band Data) call connection.\n \n adaptive - means to use cMediaGwCcCfgVbdJitterNomDelay as\n the initial jitter buffers size and let the DSP\n pick the optimal value of the jitter buffer\n size between the range of\n cMediaGwCcCfgVbcJitterMaxDelay and\n cMediaGwCcCfgVbcJitterMinDelay.\n \n fixed - means to use a constant jitter buffer size\n which is specified by cMediaGwCcCfgVbdJitterNomDelay.", "x-yang-type": "CISCO-MEDIA-GATEWAY-MIB:CCallControlJitterDelayMode" }, "cMediaGwCcCfgVbdJitterMaxDelay": { "type": "integer", "description": "This object specifies the maximum jitter buffer size \n in VBD (Voice Band Data)", "minimum": 0, "maximum": 4294967295 }, "cMediaGwCcCfgVbdJitterNomDelay": { "type": "integer", "description": "This object specifies the nominal jitter buffer size \n in VBD (Voice Band Data)", "minimum": 0, "maximum": 4294967295 }, "cMediaGwCcCfgVbdJitterMinDelay": { "type": "integer", "description": "This object specifies the nominal jitter buffer size \n in VBD (Voice Band Data)", "minimum": 0, "maximum": 4294967295 }, "cMediaGwCcCfgDefaultTonePlanId": { "type": "string", "description": "This object specifies the default tone plan index\n (the value of cvtcTonePlanId) for the media gateway.", "x-yang-type": "CISCO-MEDIA-GATEWAY-MIB:CVoiceTonePlanIndex" }, "cMediaGwCcCfgDescrInfoEnabled": { "type": "boolean", "description": "This object specifies whether the media gateway supports\n descriptive suffix of the name schema for terminations.\n \n There are two parts in name schema of termination, prefix\n and suffix. For example the name schema for a DS (Digital\n Subscriber) termination, can be 'DS/OC3_2/DS1_6/DS0_24'.\n It represents DS type termination in 2nd OC3 line, \n 6th DS1 and 24th DS0 channel. In this example, 'DS' is \n the prefix, 'OC3_2/DS1_6/DS0_24' is the suffix.\n \n The name schema in above example has a descriptive suffix.\n The non-descriptive suffix for the same termination is \n '2/6/24' and name schema becomes 'DS/2/6/24'.\n \n This object can not be modified if there is any termination\n existing in the media gateway." }, "cMediaGwCcCfgDsNamePrefix": { "type": "string", "description": "This object specifies the prefix of the name schema for\n DS (Digital Subscriber) terminations.\n The value of this object must be unique among the \n following objects:\n cMediaGwCcCfgDsNamePrefix\n cMediaGwCcCfgRtpNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgDefRtpNamePrefix\n This object can not be modified when there is any\n DS termination existing in the media gateway.\n It is default to 'DS'.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cMediaGwCcCfgRtpNamePrefix": { "type": "string", "description": "This object specifies the prefix of the name schema for\n RTP (Real-Time Transport Protocol) terminations.\n The value of this object must be unique among the \n following objects:\n cMediaGwCcCfgDsNamePrefix\n cMediaGwCcCfgRtpNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgDefRtpNamePrefix\n This object can not be modified when there is any\n RTP termination type existing in the media gateway.\n It is default to 'RTP'.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cMediaGwCcCfgAal1SvcNamePrefix": { "type": "string", "description": "This object specifies the prefix of the name schema for\n voice over AAL1 SVC (Switched Virtual Circuit)\n terminations.\n The value of this object must be unique among the \n following objects:\n cMediaGwCcCfgDsNamePrefix\n cMediaGwCcCfgRtpNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgDefRtpNamePrefix\n This object can not be modified when there is any\n AAL1 SVC termination type existing in the media gateway.\n It is default to 'AAL1/SVC'.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cMediaGwCcCfgAal2SvcNamePrefix": { "type": "string", "description": "This object specifies the prefix of the name schema for\n voice over AAL2 SVC (Switched Virtual Circuit)\n terminations.\n The value of this object must be unique among the \n following objects:\n cMediaGwCcCfgDsNamePrefix\n cMediaGwCcCfgRtpNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgDefRtpNamePrefix\n This object can not be modified when there is any\n AAL2 SVC termination type existing in the media gateway.\n It is default to 'AAL2/SVC'.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cMediaGwCcCfgClusterEnabled": { "type": "string", "description": "This object specifies the condition of the cluster generation\n in the call control.\n \n A cluster is a group of endpoints that share a particular\n bearer possibility for connections among each other.\n \n disabled(1) - The generation of the cluster attribute\n is disabled.\n enabled(2) - Unconditionally generate the cluster\n attribute.\n conditionalEnabled(3) - The generation of the cluster \n attribute is upon MGC request." }, "cMediaGwCcCfgDefBearerTraffic": { "type": "string", "description": "This object specifies the combination of the network\n type (IP/ATM), virtual circuit type (PVC/SVC) and\n ATM adaptation layer type (AAL1/AAL2/AAL5) for the\n connection used in transporting bearer traffic.\n \n ipPvcAal5 (1) - The bearer traffic is transported in\n IP network, through Permanent Virtual\n Circuit(PVC) over AAL5 adaptation layer.\n atmPvcAal2 (2) - The bearer traffic is transported in\n ATM network, through Permanent Virtual\n Circuit(PVC) over AAL2 adaptation layer.\n atmSvcAal2 (3) - The bearer traffic is transported in\n ATM network, through Switching Virtual\n Circuit(SVC) over AAL2 adaptation layer.\n atmSvcAal1 (4) - The bearer traffic is transported in\n ATM network, through Switching Virtual\n Circuit(SVC) over AAL1 adaptation layer.\n \n In MGCP, if the call agent specifies the bear traffic type \n in the local connection options (CRCX request), \n configuration of this object will have no effect, \n otherwise the value of this object will be used when \n media gateway sending CRCX response." }, "cMediaGwCcCfgDefRtpNamePrefix": { "type": "string", "description": "This object specifies the prefix of the name schema for\n default RTP terminations.\n The value of this object must be unique among the \n following objects:\n cMediaGwCcCfgDsNamePrefix\n cMediaGwCcCfgRtpNamePrefix\n cMediaGwCcCfgAal1SvcNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n \n It is defaulted to 'TGWRTP'.", "x-yang-type": "snmp-framework:SnmpAdminString" } } } } } }, "example": { "CISCO-MEDIA-GATEWAY-MIB:cMediaGwCallControlConfigTable": { "cMediaGwCallControlConfigEntry": [ { "cmgwIndex": "1", "cMediaGwCcCfgControlTos": 0, "cMediaGwCcCfgBearerTos": 0, "cMediaGwCcCfgNtePayload": 0, "cMediaGwCcCfgNsePayload": 0, "cMediaGwCcCfgNseRespTimer": 0, "cMediaGwCcCfgVbdJitterDelayMode": "example-string", "cMediaGwCcCfgVbdJitterMaxDelay": 0, "cMediaGwCcCfgVbdJitterNomDelay": 0, "cMediaGwCcCfgVbdJitterMinDelay": 0, "cMediaGwCcCfgDefaultTonePlanId": "example-string", "cMediaGwCcCfgDescrInfoEnabled": true, "cMediaGwCcCfgDsNamePrefix": "interface-1", "cMediaGwCcCfgRtpNamePrefix": "interface-1", "cMediaGwCcCfgAal1SvcNamePrefix": "interface-1", "cMediaGwCcCfgAal2SvcNamePrefix": "interface-1", "cMediaGwCcCfgClusterEnabled": "example-string", "cMediaGwCcCfgDefBearerTraffic": "example-string", "cMediaGwCcCfgDefRtpNamePrefix": "interface-1" }, { "cmgwIndex": "2", "cMediaGwCcCfgControlTos": 0, "cMediaGwCcCfgBearerTos": 0, "cMediaGwCcCfgNtePayload": 0, "cMediaGwCcCfgNsePayload": 0, "cMediaGwCcCfgNseRespTimer": 0, "cMediaGwCcCfgVbdJitterDelayMode": "example-string", "cMediaGwCcCfgVbdJitterMaxDelay": 0, "cMediaGwCcCfgVbdJitterNomDelay": 0, "cMediaGwCcCfgVbdJitterMinDelay": 0, "cMediaGwCcCfgDefaultTonePlanId": "example-string", "cMediaGwCcCfgDescrInfoEnabled": true, "cMediaGwCcCfgDsNamePrefix": "interface-1", "cMediaGwCcCfgRtpNamePrefix": "interface-1", "cMediaGwCcCfgAal1SvcNamePrefix": "interface-1", "cMediaGwCcCfgAal2SvcNamePrefix": "interface-1", "cMediaGwCcCfgClusterEnabled": "example-string", "cMediaGwCcCfgDefBearerTraffic": "example-string", "cMediaGwCcCfgDefRtpNamePrefix": "interface-1" }, { "cmgwIndex": "3", "cMediaGwCcCfgControlTos": 0, "cMediaGwCcCfgBearerTos": 0, "cMediaGwCcCfgNtePayload": 0, "cMediaGwCcCfgNsePayload": 0, "cMediaGwCcCfgNseRespTimer": 0, "cMediaGwCcCfgVbdJitterDelayMode": "example-string", "cMediaGwCcCfgVbdJitterMaxDelay": 0, "cMediaGwCcCfgVbdJitterNomDelay": 0, "cMediaGwCcCfgVbdJitterMinDelay": 0, "cMediaGwCcCfgDefaultTonePlanId": "example-string", "cMediaGwCcCfgDescrInfoEnabled": true, "cMediaGwCcCfgDsNamePrefix": "interface-1", "cMediaGwCcCfgRtpNamePrefix": "interface-1", "cMediaGwCcCfgAal1SvcNamePrefix": "interface-1", "cMediaGwCcCfgAal2SvcNamePrefix": "interface-1", "cMediaGwCcCfgClusterEnabled": "example-string", "cMediaGwCcCfgDefBearerTraffic": "example-string", "cMediaGwCcCfgDefRtpNamePrefix": "interface-1" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cMediaGwCallControlConfigTable", "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": "/cMediaGwCallControlConfigTable", "x-restconf-kind": "container" }, "/data/CISCO-MEDIA-GATEWAY-MIB:cMediaGwCallControlConfigTable/cMediaGwCallControlConfigEntry": { "get": { "summary": "Get cMediaGwCallControlConfigEntry list", "description": "Retrieve list of cMediaGwCallControlConfigEntry entries from MIB", "tags": [ "CISCO-MEDIA-GATEWAY-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "One entry for each media gateway which supports call control \n protocol.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref" }, "cMediaGwCcCfgControlTos": { "type": "integer", "description": "This object specifies Type Of Service (TOS) field of\n IP header for the signaling control packet in VoIP\n application.", "minimum": 0, "maximum": 4294967295 }, "cMediaGwCcCfgBearerTos": { "type": "integer", "description": "This object specifies Type Of Service (TOS) field\n of IP header for the voice payload packet in VoIP\n application.", "minimum": 0, "maximum": 4294967295 }, "cMediaGwCcCfgNtePayload": { "type": "integer", "description": "This object specifies NTE (Named Telephony Events)\n payload type.", "minimum": 0, "maximum": 4294967295 }, "cMediaGwCcCfgNsePayload": { "type": "integer", "description": "This object specifies NSE (Network Signaling Events)\n payload type.", "minimum": 0, "maximum": 4294967295 }, "cMediaGwCcCfgNseRespTimer": { "type": "integer", "description": "This object specifies Network Signaling Event (NSE)\n timeout value.", "minimum": 0, "maximum": 4294967295 }, "cMediaGwCcCfgVbdJitterDelayMode": { "type": "string", "description": "The object specifies the jitter buffer mode applied to\n a VBD (Voice Band Data) call connection.\n \n adaptive - means to use cMediaGwCcCfgVbdJitterNomDelay as\n the initial jitter buffers size and let the DSP\n pick the optimal value of the jitter buffer\n size between the range of\n cMediaGwCcCfgVbcJitterMaxDelay and\n cMediaGwCcCfgVbcJitterMinDelay.\n \n fixed - means to use a constant jitter buffer size\n which is specified by cMediaGwCcCfgVbdJitterNomDelay.", "x-yang-type": "CISCO-MEDIA-GATEWAY-MIB:CCallControlJitterDelayMode" }, "cMediaGwCcCfgVbdJitterMaxDelay": { "type": "integer", "description": "This object specifies the maximum jitter buffer size \n in VBD (Voice Band Data)", "minimum": 0, "maximum": 4294967295 }, "cMediaGwCcCfgVbdJitterNomDelay": { "type": "integer", "description": "This object specifies the nominal jitter buffer size \n in VBD (Voice Band Data)", "minimum": 0, "maximum": 4294967295 }, "cMediaGwCcCfgVbdJitterMinDelay": { "type": "integer", "description": "This object specifies the nominal jitter buffer size \n in VBD (Voice Band Data)", "minimum": 0, "maximum": 4294967295 }, "cMediaGwCcCfgDefaultTonePlanId": { "type": "string", "description": "This object specifies the default tone plan index\n (the value of cvtcTonePlanId) for the media gateway.", "x-yang-type": "CISCO-MEDIA-GATEWAY-MIB:CVoiceTonePlanIndex" }, "cMediaGwCcCfgDescrInfoEnabled": { "type": "boolean", "description": "This object specifies whether the media gateway supports\n descriptive suffix of the name schema for terminations.\n \n There are two parts in name schema of termination, prefix\n and suffix. For example the name schema for a DS (Digital\n Subscriber) termination, can be 'DS/OC3_2/DS1_6/DS0_24'.\n It represents DS type termination in 2nd OC3 line, \n 6th DS1 and 24th DS0 channel. In this example, 'DS' is \n the prefix, 'OC3_2/DS1_6/DS0_24' is the suffix.\n \n The name schema in above example has a descriptive suffix.\n The non-descriptive suffix for the same termination is \n '2/6/24' and name schema becomes 'DS/2/6/24'.\n \n This object can not be modified if there is any termination\n existing in the media gateway." }, "cMediaGwCcCfgDsNamePrefix": { "type": "string", "description": "This object specifies the prefix of the name schema for\n DS (Digital Subscriber) terminations.\n The value of this object must be unique among the \n following objects:\n cMediaGwCcCfgDsNamePrefix\n cMediaGwCcCfgRtpNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgDefRtpNamePrefix\n This object can not be modified when there is any\n DS termination existing in the media gateway.\n It is default to 'DS'.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cMediaGwCcCfgRtpNamePrefix": { "type": "string", "description": "This object specifies the prefix of the name schema for\n RTP (Real-Time Transport Protocol) terminations.\n The value of this object must be unique among the \n following objects:\n cMediaGwCcCfgDsNamePrefix\n cMediaGwCcCfgRtpNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgDefRtpNamePrefix\n This object can not be modified when there is any\n RTP termination type existing in the media gateway.\n It is default to 'RTP'.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cMediaGwCcCfgAal1SvcNamePrefix": { "type": "string", "description": "This object specifies the prefix of the name schema for\n voice over AAL1 SVC (Switched Virtual Circuit)\n terminations.\n The value of this object must be unique among the \n following objects:\n cMediaGwCcCfgDsNamePrefix\n cMediaGwCcCfgRtpNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgDefRtpNamePrefix\n This object can not be modified when there is any\n AAL1 SVC termination type existing in the media gateway.\n It is default to 'AAL1/SVC'.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cMediaGwCcCfgAal2SvcNamePrefix": { "type": "string", "description": "This object specifies the prefix of the name schema for\n voice over AAL2 SVC (Switched Virtual Circuit)\n terminations.\n The value of this object must be unique among the \n following objects:\n cMediaGwCcCfgDsNamePrefix\n cMediaGwCcCfgRtpNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgDefRtpNamePrefix\n This object can not be modified when there is any\n AAL2 SVC termination type existing in the media gateway.\n It is default to 'AAL2/SVC'.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cMediaGwCcCfgClusterEnabled": { "type": "string", "description": "This object specifies the condition of the cluster generation\n in the call control.\n \n A cluster is a group of endpoints that share a particular\n bearer possibility for connections among each other.\n \n disabled(1) - The generation of the cluster attribute\n is disabled.\n enabled(2) - Unconditionally generate the cluster\n attribute.\n conditionalEnabled(3) - The generation of the cluster \n attribute is upon MGC request." }, "cMediaGwCcCfgDefBearerTraffic": { "type": "string", "description": "This object specifies the combination of the network\n type (IP/ATM), virtual circuit type (PVC/SVC) and\n ATM adaptation layer type (AAL1/AAL2/AAL5) for the\n connection used in transporting bearer traffic.\n \n ipPvcAal5 (1) - The bearer traffic is transported in\n IP network, through Permanent Virtual\n Circuit(PVC) over AAL5 adaptation layer.\n atmPvcAal2 (2) - The bearer traffic is transported in\n ATM network, through Permanent Virtual\n Circuit(PVC) over AAL2 adaptation layer.\n atmSvcAal2 (3) - The bearer traffic is transported in\n ATM network, through Switching Virtual\n Circuit(SVC) over AAL2 adaptation layer.\n atmSvcAal1 (4) - The bearer traffic is transported in\n ATM network, through Switching Virtual\n Circuit(SVC) over AAL1 adaptation layer.\n \n In MGCP, if the call agent specifies the bear traffic type \n in the local connection options (CRCX request), \n configuration of this object will have no effect, \n otherwise the value of this object will be used when \n media gateway sending CRCX response." }, "cMediaGwCcCfgDefRtpNamePrefix": { "type": "string", "description": "This object specifies the prefix of the name schema for\n default RTP terminations.\n The value of this object must be unique among the \n following objects:\n cMediaGwCcCfgDsNamePrefix\n cMediaGwCcCfgRtpNamePrefix\n cMediaGwCcCfgAal1SvcNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n \n It is defaulted to 'TGWRTP'.", "x-yang-type": "snmp-framework:SnmpAdminString" } } } }, "example": { "CISCO-MEDIA-GATEWAY-MIB:cMediaGwCallControlConfigEntry": [ { "cmgwIndex": "example-string", "cMediaGwCcCfgControlTos": 0, "cMediaGwCcCfgBearerTos": 0, "cMediaGwCcCfgNtePayload": 0, "cMediaGwCcCfgNsePayload": 0, "cMediaGwCcCfgNseRespTimer": 0, "cMediaGwCcCfgVbdJitterDelayMode": "example-string", "cMediaGwCcCfgVbdJitterMaxDelay": 0, "cMediaGwCcCfgVbdJitterNomDelay": 0, "cMediaGwCcCfgVbdJitterMinDelay": 0, "cMediaGwCcCfgDefaultTonePlanId": "example-string", "cMediaGwCcCfgDescrInfoEnabled": true, "cMediaGwCcCfgDsNamePrefix": "interface-1", "cMediaGwCcCfgRtpNamePrefix": "interface-1", "cMediaGwCcCfgAal1SvcNamePrefix": "interface-1", "cMediaGwCcCfgAal2SvcNamePrefix": "interface-1", "cMediaGwCcCfgClusterEnabled": "example-string", "cMediaGwCcCfgDefBearerTraffic": "example-string", "cMediaGwCcCfgDefRtpNamePrefix": "interface-1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cMediaGwCallControlConfigEntry", "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": "/cMediaGwCallControlConfigTable/cMediaGwCallControlConfigEntry", "x-restconf-kind": "container" }, "/data/CISCO-MEDIA-GATEWAY-MIB:cMediaGwCallControlConfigTable/cMediaGwCallControlConfigEntry={cmgwIndex}": { "get": { "summary": "Get cMediaGwCallControlConfigEntry entry", "description": "Retrieve specific cMediaGwCallControlConfigEntry entry by key from MIB", "tags": [ "CISCO-MEDIA-GATEWAY-MIB" ], "parameters": [ { "name": "cmgwIndex", "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": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref" }, "cMediaGwCcCfgControlTos": { "type": "integer", "description": "This object specifies Type Of Service (TOS) field of\n IP header for the signaling control packet in VoIP\n application.", "minimum": 0, "maximum": 4294967295 }, "cMediaGwCcCfgBearerTos": { "type": "integer", "description": "This object specifies Type Of Service (TOS) field\n of IP header for the voice payload packet in VoIP\n application.", "minimum": 0, "maximum": 4294967295 }, "cMediaGwCcCfgNtePayload": { "type": "integer", "description": "This object specifies NTE (Named Telephony Events)\n payload type.", "minimum": 0, "maximum": 4294967295 }, "cMediaGwCcCfgNsePayload": { "type": "integer", "description": "This object specifies NSE (Network Signaling Events)\n payload type.", "minimum": 0, "maximum": 4294967295 }, "cMediaGwCcCfgNseRespTimer": { "type": "integer", "description": "This object specifies Network Signaling Event (NSE)\n timeout value.", "minimum": 0, "maximum": 4294967295 }, "cMediaGwCcCfgVbdJitterDelayMode": { "type": "string", "description": "The object specifies the jitter buffer mode applied to\n a VBD (Voice Band Data) call connection.\n \n adaptive - means to use cMediaGwCcCfgVbdJitterNomDelay as\n the initial jitter buffers size and let the DSP\n pick the optimal value of the jitter buffer\n size between the range of\n cMediaGwCcCfgVbcJitterMaxDelay and\n cMediaGwCcCfgVbcJitterMinDelay.\n \n fixed - means to use a constant jitter buffer size\n which is specified by cMediaGwCcCfgVbdJitterNomDelay.", "x-yang-type": "CISCO-MEDIA-GATEWAY-MIB:CCallControlJitterDelayMode" }, "cMediaGwCcCfgVbdJitterMaxDelay": { "type": "integer", "description": "This object specifies the maximum jitter buffer size \n in VBD (Voice Band Data)", "minimum": 0, "maximum": 4294967295 }, "cMediaGwCcCfgVbdJitterNomDelay": { "type": "integer", "description": "This object specifies the nominal jitter buffer size \n in VBD (Voice Band Data)", "minimum": 0, "maximum": 4294967295 }, "cMediaGwCcCfgVbdJitterMinDelay": { "type": "integer", "description": "This object specifies the nominal jitter buffer size \n in VBD (Voice Band Data)", "minimum": 0, "maximum": 4294967295 }, "cMediaGwCcCfgDefaultTonePlanId": { "type": "string", "description": "This object specifies the default tone plan index\n (the value of cvtcTonePlanId) for the media gateway.", "x-yang-type": "CISCO-MEDIA-GATEWAY-MIB:CVoiceTonePlanIndex" }, "cMediaGwCcCfgDescrInfoEnabled": { "type": "boolean", "description": "This object specifies whether the media gateway supports\n descriptive suffix of the name schema for terminations.\n \n There are two parts in name schema of termination, prefix\n and suffix. For example the name schema for a DS (Digital\n Subscriber) termination, can be 'DS/OC3_2/DS1_6/DS0_24'.\n It represents DS type termination in 2nd OC3 line, \n 6th DS1 and 24th DS0 channel. In this example, 'DS' is \n the prefix, 'OC3_2/DS1_6/DS0_24' is the suffix.\n \n The name schema in above example has a descriptive suffix.\n The non-descriptive suffix for the same termination is \n '2/6/24' and name schema becomes 'DS/2/6/24'.\n \n This object can not be modified if there is any termination\n existing in the media gateway." }, "cMediaGwCcCfgDsNamePrefix": { "type": "string", "description": "This object specifies the prefix of the name schema for\n DS (Digital Subscriber) terminations.\n The value of this object must be unique among the \n following objects:\n cMediaGwCcCfgDsNamePrefix\n cMediaGwCcCfgRtpNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgDefRtpNamePrefix\n This object can not be modified when there is any\n DS termination existing in the media gateway.\n It is default to 'DS'.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cMediaGwCcCfgRtpNamePrefix": { "type": "string", "description": "This object specifies the prefix of the name schema for\n RTP (Real-Time Transport Protocol) terminations.\n The value of this object must be unique among the \n following objects:\n cMediaGwCcCfgDsNamePrefix\n cMediaGwCcCfgRtpNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgDefRtpNamePrefix\n This object can not be modified when there is any\n RTP termination type existing in the media gateway.\n It is default to 'RTP'.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cMediaGwCcCfgAal1SvcNamePrefix": { "type": "string", "description": "This object specifies the prefix of the name schema for\n voice over AAL1 SVC (Switched Virtual Circuit)\n terminations.\n The value of this object must be unique among the \n following objects:\n cMediaGwCcCfgDsNamePrefix\n cMediaGwCcCfgRtpNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgDefRtpNamePrefix\n This object can not be modified when there is any\n AAL1 SVC termination type existing in the media gateway.\n It is default to 'AAL1/SVC'.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cMediaGwCcCfgAal2SvcNamePrefix": { "type": "string", "description": "This object specifies the prefix of the name schema for\n voice over AAL2 SVC (Switched Virtual Circuit)\n terminations.\n The value of this object must be unique among the \n following objects:\n cMediaGwCcCfgDsNamePrefix\n cMediaGwCcCfgRtpNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgDefRtpNamePrefix\n This object can not be modified when there is any\n AAL2 SVC termination type existing in the media gateway.\n It is default to 'AAL2/SVC'.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cMediaGwCcCfgClusterEnabled": { "type": "string", "description": "This object specifies the condition of the cluster generation\n in the call control.\n \n A cluster is a group of endpoints that share a particular\n bearer possibility for connections among each other.\n \n disabled(1) - The generation of the cluster attribute\n is disabled.\n enabled(2) - Unconditionally generate the cluster\n attribute.\n conditionalEnabled(3) - The generation of the cluster \n attribute is upon MGC request." }, "cMediaGwCcCfgDefBearerTraffic": { "type": "string", "description": "This object specifies the combination of the network\n type (IP/ATM), virtual circuit type (PVC/SVC) and\n ATM adaptation layer type (AAL1/AAL2/AAL5) for the\n connection used in transporting bearer traffic.\n \n ipPvcAal5 (1) - The bearer traffic is transported in\n IP network, through Permanent Virtual\n Circuit(PVC) over AAL5 adaptation layer.\n atmPvcAal2 (2) - The bearer traffic is transported in\n ATM network, through Permanent Virtual\n Circuit(PVC) over AAL2 adaptation layer.\n atmSvcAal2 (3) - The bearer traffic is transported in\n ATM network, through Switching Virtual\n Circuit(SVC) over AAL2 adaptation layer.\n atmSvcAal1 (4) - The bearer traffic is transported in\n ATM network, through Switching Virtual\n Circuit(SVC) over AAL1 adaptation layer.\n \n In MGCP, if the call agent specifies the bear traffic type \n in the local connection options (CRCX request), \n configuration of this object will have no effect, \n otherwise the value of this object will be used when \n media gateway sending CRCX response." }, "cMediaGwCcCfgDefRtpNamePrefix": { "type": "string", "description": "This object specifies the prefix of the name schema for\n default RTP terminations.\n The value of this object must be unique among the \n following objects:\n cMediaGwCcCfgDsNamePrefix\n cMediaGwCcCfgRtpNamePrefix\n cMediaGwCcCfgAal1SvcNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n \n It is defaulted to 'TGWRTP'.", "x-yang-type": "snmp-framework:SnmpAdminString" } } }, "example": { "CISCO-MEDIA-GATEWAY-MIB:cMediaGwCallControlConfigEntry": { "cmgwIndex": "example-string", "cMediaGwCcCfgControlTos": 0, "cMediaGwCcCfgBearerTos": 0, "cMediaGwCcCfgNtePayload": 0, "cMediaGwCcCfgNsePayload": 0, "cMediaGwCcCfgNseRespTimer": 0, "cMediaGwCcCfgVbdJitterDelayMode": "example-string", "cMediaGwCcCfgVbdJitterMaxDelay": 0, "cMediaGwCcCfgVbdJitterNomDelay": 0, "cMediaGwCcCfgVbdJitterMinDelay": 0, "cMediaGwCcCfgDefaultTonePlanId": "example-string", "cMediaGwCcCfgDescrInfoEnabled": true, "cMediaGwCcCfgDsNamePrefix": "interface-1", "cMediaGwCcCfgRtpNamePrefix": "interface-1", "cMediaGwCcCfgAal1SvcNamePrefix": "interface-1", "cMediaGwCcCfgAal2SvcNamePrefix": "interface-1", "cMediaGwCcCfgClusterEnabled": "example-string", "cMediaGwCcCfgDefBearerTraffic": "example-string", "cMediaGwCcCfgDefRtpNamePrefix": "interface-1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cMediaGwCallControlConfigEntry-2" }, "x-yang-path": "/cMediaGwCallControlConfigTable/cMediaGwCallControlConfigEntry={cmgwIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cmgwIndex" ] }, "/data/CISCO-MEDIA-GATEWAY-MIB:cMediaGwRscStatsTable": { "get": { "summary": "Get cMediaGwRscStatsTable data", "description": "Retrieve cMediaGwRscStatsTable operational data from MIB", "tags": [ "CISCO-MEDIA-GATEWAY-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table stores the gateway resource statistics\n information.", "properties": { "cMediaGwRscStatsEntry": { "type": "array", "description": "Each entry stores the statistics\n information for a specific resource.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref" }, "cmgwRscStatsIndex": { "type": "string", "description": "An index that uniquely identifies a specific gateway\n resource." }, "cmgwRscMaximumUtilization": { "type": "integer", "description": "This object indicates the maximum utilization of the\n resource over the interval specified by the\n 'cmgwRscSinceLastReset'.", "minimum": 0, "maximum": 4294967295 }, "cmgwRscMinimumUtilization": { "type": "integer", "description": "This object indicates the minimum utilization of the\n resource over the interval specified by the\n 'cmgwRscSinceLastReset'.", "minimum": 0, "maximum": 4294967295 }, "cmgwRscAverageUtilization": { "type": "integer", "description": "This object indicates the average utilization of the\n resource over the interval specified by the\n 'cmgwRscSinceLastReset'.", "minimum": 0, "maximum": 4294967295 }, "cmgwRscSinceLastReset": { "type": "integer", "description": "The elapsed time (in seconds) from the last periodic reset.\n \n The following objects are reset at the last reset:\n \n 'cmgwRscMaximumUtilization'\n 'cmgwRscMinimumUtilization'\n 'cmgwRscAverageUtilization'", "minimum": 0, "maximum": 4294967295 } } } } } }, "example": { "CISCO-MEDIA-GATEWAY-MIB:cMediaGwRscStatsTable": { "cMediaGwRscStatsEntry": [ { "cmgwIndex": "1", "cmgwRscStatsIndex": "1", "cmgwRscMaximumUtilization": 0, "cmgwRscMinimumUtilization": 0, "cmgwRscAverageUtilization": 0, "cmgwRscSinceLastReset": 0 }, { "cmgwIndex": "2", "cmgwRscStatsIndex": "2", "cmgwRscMaximumUtilization": 0, "cmgwRscMinimumUtilization": 0, "cmgwRscAverageUtilization": 0, "cmgwRscSinceLastReset": 0 }, { "cmgwIndex": "3", "cmgwRscStatsIndex": "3", "cmgwRscMaximumUtilization": 0, "cmgwRscMinimumUtilization": 0, "cmgwRscAverageUtilization": 0, "cmgwRscSinceLastReset": 0 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cMediaGwRscStatsTable", "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": "/cMediaGwRscStatsTable", "x-restconf-kind": "container" }, "/data/CISCO-MEDIA-GATEWAY-MIB:cMediaGwRscStatsTable/cMediaGwRscStatsEntry": { "get": { "summary": "Get cMediaGwRscStatsEntry list", "description": "Retrieve list of cMediaGwRscStatsEntry entries from MIB", "tags": [ "CISCO-MEDIA-GATEWAY-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Each entry stores the statistics\n information for a specific resource.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref" }, "cmgwRscStatsIndex": { "type": "string", "description": "An index that uniquely identifies a specific gateway\n resource." }, "cmgwRscMaximumUtilization": { "type": "integer", "description": "This object indicates the maximum utilization of the\n resource over the interval specified by the\n 'cmgwRscSinceLastReset'.", "minimum": 0, "maximum": 4294967295 }, "cmgwRscMinimumUtilization": { "type": "integer", "description": "This object indicates the minimum utilization of the\n resource over the interval specified by the\n 'cmgwRscSinceLastReset'.", "minimum": 0, "maximum": 4294967295 }, "cmgwRscAverageUtilization": { "type": "integer", "description": "This object indicates the average utilization of the\n resource over the interval specified by the\n 'cmgwRscSinceLastReset'.", "minimum": 0, "maximum": 4294967295 }, "cmgwRscSinceLastReset": { "type": "integer", "description": "The elapsed time (in seconds) from the last periodic reset.\n \n The following objects are reset at the last reset:\n \n 'cmgwRscMaximumUtilization'\n 'cmgwRscMinimumUtilization'\n 'cmgwRscAverageUtilization'", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-MEDIA-GATEWAY-MIB:cMediaGwRscStatsEntry": [ { "cmgwIndex": "example-string", "cmgwRscStatsIndex": "example-string", "cmgwRscMaximumUtilization": 0, "cmgwRscMinimumUtilization": 0, "cmgwRscAverageUtilization": 0, "cmgwRscSinceLastReset": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cMediaGwRscStatsEntry", "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": "/cMediaGwRscStatsTable/cMediaGwRscStatsEntry", "x-restconf-kind": "container" }, "/data/CISCO-MEDIA-GATEWAY-MIB:cMediaGwEntry": { "get": { "summary": "Get cMediaGwEntry list", "description": "Retrieve list of cMediaGwEntry entries from MIB", "tags": [ "CISCO-MEDIA-GATEWAY-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A Media Gateway Entry. \n At system power-up, an entry is created by the agent \n if the system detects a media gateway module has been added \n to the system, and an entry is deleted if the entry associated\n media gateway module has been removed from the system.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "integer", "description": "An index that uniquely identifies an entry in the \n cMediaGwTable.", "minimum": -2147483648, "maximum": 2147483647 }, "cmgwDomainName": { "type": "string", "description": "This object is used to represent a domain name under which \n the Media Gateway could also be registered in a DNS name\n server. \n \n The value of this object reflects the value of \n cmgwConfigDomainName from the entry with a value of \n 'gateway(1)' for object cmgwConfigDomainNameEntity of \n cMediaGwDomainNameConfigTable.\n \n If there is no entry in cMediaGwDomainNameConfigTable with\n 'gateway(1)' of cmgwConfigDomainNameEntity, then\n the value of this object will be empty string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cmgwPhysicalIndex": { "type": "string", "description": "This object represents the entPhysicalIndex of the\n card in which media gateway is running. It will contain\n value 0 if the entPhysicalIndex value is not available or \n not applicable", "x-yang-type": "cisco-tc:EntPhysicalIndexOrZero" }, "cmgwServiceState": { "type": "string", "description": "This object indicates the current service state of the Media \n Gateway.\n This object is controlled by 'cmgwAdminState' \n object.", "x-yang-type": "CISCO-MEDIA-GATEWAY-MIB:CGwServiceState" }, "cmgwAdminState": { "type": "string", "description": "This object is used to change the service state of \n the Media Gateway from inService to outOfService or from \n outOfService to inService. \n The resulting service state of the gateway is represented \n by 'cmgwServiceState'.", "x-yang-type": "CISCO-MEDIA-GATEWAY-MIB:CGwAdminState" }, "cmgwGraceTime": { "type": "integer", "description": "This object is used to represent grace period.\n The grace period (restart delay in RSIP message) is \n expressed in a number of seconds. \n It means how soon the gateway will be taken out of service.\n The value -1 indicates that the grace period time is\n disabled.", "minimum": -2147483648, "maximum": 2147483647 }, "cmgwVtMappingMode": { "type": "string", "description": "This object is used to represent the VT (sonet Virtual\n Tributary) counting.\n \n standard - standard counting (based on Bellcore TR253)\n titan - TITAN5500 counting (based on Tellabs TITAN 5500)\n \n Note: 'titan' is valid only if sonet line medium type \n (sonetMediumType of SONET-MIB) is 'sonet' and \n sonet path payload type (cspSonetPathPayload of\n CISCO-SONET-MIB) is 'vt15vc11'." }, "cmgwSrcFilterEnabled": { "type": "boolean", "description": "This object is used to enable or disable the source IP\n and port filtering with MGC for security consideration\n as follows:\n 'true' - source IP and port filter is enabled \n 'false' - source IP and port filter is disable" }, "cmgwLawInterceptEnabled": { "type": "boolean", "description": "This object is used to enable or disable the lawful\n intercept for government.\n as follows:\n 'true' - enable lawful intercept\n 'false' - disable lawful intercept" }, "cmgwV23Enabled": { "type": "boolean", "description": "This object is to enable or disable V23 tone.\n Setting the object value to 'true', will cause VXSM (Voice Switching\n Service Module) to detect V23 tone." } } } }, "example": { "CISCO-MEDIA-GATEWAY-MIB:cMediaGwEntry": [ { "cmgwIndex": 1, "cmgwDomainName": "interface-1", "cmgwPhysicalIndex": "example-string", "cmgwServiceState": "up(1)", "cmgwAdminState": "up(1)", "cmgwGraceTime": -2147483648, "cmgwVtMappingMode": "example-string", "cmgwSrcFilterEnabled": true, "cmgwLawInterceptEnabled": true, "cmgwV23Enabled": true } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cMediaGwEntry-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": "/cMediaGwEntry", "x-restconf-kind": "container" }, "/data/CISCO-MEDIA-GATEWAY-MIB:cMediaGwEntry={cmgwIndex}": { "get": { "summary": "Get cMediaGwEntry entry", "description": "Retrieve specific cMediaGwEntry entry by key from MIB", "tags": [ "CISCO-MEDIA-GATEWAY-MIB" ], "parameters": [ { "name": "cmgwIndex", "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": { "cmgwIndex": { "type": "integer", "description": "An index that uniquely identifies an entry in the \n cMediaGwTable.", "minimum": -2147483648, "maximum": 2147483647 }, "cmgwDomainName": { "type": "string", "description": "This object is used to represent a domain name under which \n the Media Gateway could also be registered in a DNS name\n server. \n \n The value of this object reflects the value of \n cmgwConfigDomainName from the entry with a value of \n 'gateway(1)' for object cmgwConfigDomainNameEntity of \n cMediaGwDomainNameConfigTable.\n \n If there is no entry in cMediaGwDomainNameConfigTable with\n 'gateway(1)' of cmgwConfigDomainNameEntity, then\n the value of this object will be empty string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cmgwPhysicalIndex": { "type": "string", "description": "This object represents the entPhysicalIndex of the\n card in which media gateway is running. It will contain\n value 0 if the entPhysicalIndex value is not available or \n not applicable", "x-yang-type": "cisco-tc:EntPhysicalIndexOrZero" }, "cmgwServiceState": { "type": "string", "description": "This object indicates the current service state of the Media \n Gateway.\n This object is controlled by 'cmgwAdminState' \n object.", "x-yang-type": "CISCO-MEDIA-GATEWAY-MIB:CGwServiceState" }, "cmgwAdminState": { "type": "string", "description": "This object is used to change the service state of \n the Media Gateway from inService to outOfService or from \n outOfService to inService. \n The resulting service state of the gateway is represented \n by 'cmgwServiceState'.", "x-yang-type": "CISCO-MEDIA-GATEWAY-MIB:CGwAdminState" }, "cmgwGraceTime": { "type": "integer", "description": "This object is used to represent grace period.\n The grace period (restart delay in RSIP message) is \n expressed in a number of seconds. \n It means how soon the gateway will be taken out of service.\n The value -1 indicates that the grace period time is\n disabled.", "minimum": -2147483648, "maximum": 2147483647 }, "cmgwVtMappingMode": { "type": "string", "description": "This object is used to represent the VT (sonet Virtual\n Tributary) counting.\n \n standard - standard counting (based on Bellcore TR253)\n titan - TITAN5500 counting (based on Tellabs TITAN 5500)\n \n Note: 'titan' is valid only if sonet line medium type \n (sonetMediumType of SONET-MIB) is 'sonet' and \n sonet path payload type (cspSonetPathPayload of\n CISCO-SONET-MIB) is 'vt15vc11'." }, "cmgwSrcFilterEnabled": { "type": "boolean", "description": "This object is used to enable or disable the source IP\n and port filtering with MGC for security consideration\n as follows:\n 'true' - source IP and port filter is enabled \n 'false' - source IP and port filter is disable" }, "cmgwLawInterceptEnabled": { "type": "boolean", "description": "This object is used to enable or disable the lawful\n intercept for government.\n as follows:\n 'true' - enable lawful intercept\n 'false' - disable lawful intercept" }, "cmgwV23Enabled": { "type": "boolean", "description": "This object is to enable or disable V23 tone.\n Setting the object value to 'true', will cause VXSM (Voice Switching\n Service Module) to detect V23 tone." } } }, "example": { "CISCO-MEDIA-GATEWAY-MIB:cMediaGwEntry": { "cmgwIndex": 1, "cmgwDomainName": "interface-1", "cmgwPhysicalIndex": "example-string", "cmgwServiceState": "up(1)", "cmgwAdminState": "up(1)", "cmgwGraceTime": -2147483648, "cmgwVtMappingMode": "example-string", "cmgwSrcFilterEnabled": true, "cmgwLawInterceptEnabled": true, "cmgwV23Enabled": true } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cMediaGwEntry-4" }, "x-yang-path": "/cMediaGwEntry={cmgwIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cmgwIndex" ] }, "/data/CISCO-MEDIA-GATEWAY-MIB:cmgwSignalProtocolEntry": { "get": { "summary": "Get cmgwSignalProtocolEntry list", "description": "Retrieve list of cmgwSignalProtocolEntry entries from MIB", "tags": [ "CISCO-MEDIA-GATEWAY-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Each entry represents an signaling protocol supported\n by the media gateway.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref" }, "cmgwSignalProtocolIndex": { "type": "integer", "description": "An index that uniquely identifies an entry in\n cmgwSignalProtocolTable.", "minimum": -2147483648, "maximum": 2147483647 }, "cmgwSignalProtocol": { "type": "string", "description": "This object is used to represent the protocol type.\n other - None of the following types.\n mgcp - Media Gateway Control Protocol\n h248 - Media Gateway Control (ITU H.248)\n tgcp - Trunking Gateway Control Protocol" }, "cmgwSignalProtocolVersion": { "type": "string", "description": "This object is used to represent the protocol version. \n For example cmgwSignalProtocol is 'mgcp(2)' and\n this object is string '1.0'. cmgwSignalProtocol is \n 'h248(3)' and this object is set to '2.0'.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cmgwSignalProtocolPort": { "type": "string", "description": "This object is used to represent the UDP port associated \n with the protocol.\n If the value of cmgwSignalProtocol is 'mgcp(2)' and the\n value of cmgwSignalProtcolVersion is '1.0', the default\n value of this object is '2727'. \n If the value of cmgwSignalProtocol is 'h248(3)' and the\n value of cmgwSignalProtcolVersion is '1.0', the default\n value of this object is '2944'.", "x-yang-type": "cisco-tc:CiscoPort" }, "cmgwSignalMgcProtocolPort": { "type": "string", "description": "This object specifies the protocol port of the Media Gateway\n Controller (MGC).\n If the value of cmgwSignalProtocol is 'mgcp(2)' or 'tgcp(4)'\n and the value of cmgwSignalProtcolVersion is '1.0', the\n default value of this object is '2427'.\n If the value of cmgwSignalProtocol is 'h248(3)' and the\n value of cmgwSignalProtcolVersion is '1.0', the default\n value of this object is '2944'.", "format": "inet:port-number" }, "cmgwSignalProtocolPreference": { "type": "integer", "description": "This object specifies the preference of the signal protocol \n supported in the media gateway.\n \n If this object is set to 0, the corresponding signal\n protocol will not be used by the gateway.\n \n The value of this object is unique within the corresponding\n gateway. The entry with lower value has higher preference.", "minimum": -2147483648, "maximum": 2147483647 }, "cmgwSignalProtocolConfigVer": { "type": "string", "description": "This object specifies the protocol version\n used by the gateway in the messages to MGC\n in order to exchange the service capabilities.\n \n For example cmgwSignalProtocol is 'h248(3)' and\n this object can be string '1' or '1.0', '2' or '2.0'. \n \n 'MAX' is a special string indicating the gateway will\n use the highest protocol version supported in the \n gateway, but it can be changed to lower version after \n it negotiates with MGC. The final negotiated protocol\n version will be indicated in cmgwSignalProtocolVersion.\n \n The version strings other than 'MAX' can be specified for\n the gateway to communicate with the MGC which doesn't\n support service capabilities negotiation. For example if\n a MGC supports only version 1.0 MGCP, this object should\n be set to '1' to instruct the gateway using MGCP \n version 1.0 format messages to communicate with MGC.", "x-yang-type": "snmp-framework:SnmpAdminString" } } } }, "example": { "CISCO-MEDIA-GATEWAY-MIB:cmgwSignalProtocolEntry": [ { "cmgwIndex": "example-string", "cmgwSignalProtocolIndex": 1, "cmgwSignalProtocol": "example-string", "cmgwSignalProtocolVersion": "example-string", "cmgwSignalProtocolPort": "example-string", "cmgwSignalMgcProtocolPort": "example-string", "cmgwSignalProtocolPreference": -2147483648, "cmgwSignalProtocolConfigVer": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cmgwSignalProtocolEntry-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": "/cmgwSignalProtocolEntry", "x-restconf-kind": "container" }, "/data/CISCO-MEDIA-GATEWAY-MIB:cMediaGwIpConfigEntry": { "get": { "summary": "Get cMediaGwIpConfigEntry list", "description": "Retrieve list of cMediaGwIpConfigEntry entries from MIB", "tags": [ "CISCO-MEDIA-GATEWAY-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A Media Gateway IP configuration entry. \n Each entry represents a media gateway IP address for MGCs\n to communicate with the media gateway.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref" }, "cmgwIpConfigIndex": { "type": "integer", "description": "A unique index to identify each media gateway IP address.", "minimum": -2147483648, "maximum": 2147483647 }, "cmgwIpConfigIfIndex": { "type": "string", "description": "This object is ifIndex of the interface which is associated\n to the media gateway IP address.\n \n For ATM interface, the IP address should be associated to\n an existing PVC:\n cmgwIpConfigIfIndex represents port of the PVC\n cmgwIpConfigVpi represents VPI of the PVC\n cmgwIpConfigVci represents VCI of the PVC\n And one PVC only can be associated with one IP address.\n \n If this object is set to zero which means the IP address\n is not associated to any interface.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "cmgwIpConfigVpi": { "type": "integer", "description": "This object represents VPI of the PVC which is associated\n to the IP address.\n If the IP address is not associated to PVC, the value \n of this object is set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "cmgwIpConfigVci": { "type": "integer", "description": "This object represents VCI of the PVC which is associated\n to the IP address.\n If the IP address is not associated to PVC, the value\n of this object is set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "cmgwIpConfigAddrType": { "type": "string", "description": "This object is the IP address type.", "x-yang-type": "inet-address:InetAddressType" }, "cmgwIpConfigAddress": { "type": "string", "description": "The configured IP address of media gateway.\n This object can not be modified.", "x-yang-type": "inet-address:InetAddress" }, "cmgwIpConfigSubnetMask": { "type": "string", "description": "This object is used to specify the number of leading one \n bits which from the mask to be logical-ANDed with the media \n gateway address before being compared to the value in the \n cmgwIpCofigAddress.\n \n Any assignment (implicit or otherwise) of an instance of\n this object to a value x must be rejected if the bitwise\n logical-AND of the mask formed from x with the value \n of the corresponding instance of the cmgwIpCofigAddress \n object is not equal to cmgwIpCofigAddress.", "x-yang-type": "inet-address:InetAddressPrefixLength" }, "cmgwIpConfigDefaultGwIp": { "type": "boolean", "description": "This object specifies cmgwIpConfigAddress of the entry\n will become the default gateway address.\n This object can be set to 'true' for only one entry in\n the table." }, "cmgwIpConfigForRemoteMapping": { "type": "boolean", "description": "This object specifies whether the address defined in\n cmgwIpConfigAddress is the address mapping at the\n remote end of this PVC. \n \n If this object is set to 'true', the address defined\n in cmgwIpConfigAddress is for the remote end of the PVC.\n If this object is set to 'false', the address defined\n in cmgwIpConfigAddress is for the local end of the PVC." }, "cmgwIpConfigRowStatus": { "type": "string", "description": "This object is used to add and delete an entry.\n \n When an entry of the table is created, the following \n objects are mandatory:\n cmgwIpConfigIfIndex\n cmgwIpConfigVpi\n cmgwIpConfigVci\n cmgwIpConfigAddress\n cmgwIpConfigSubnetMask\n \n These objects can not be modified after the value of this\n object is set to 'active'. \n Modification can only be done by deleting and re-adding the \n entry again.\n \n After the system verify the validity of the data, it\n will set the cmgwIpConfigRowStatus to 'active'.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "CISCO-MEDIA-GATEWAY-MIB:cMediaGwIpConfigEntry": [ { "cmgwIndex": "example-string", "cmgwIpConfigIndex": 1, "cmgwIpConfigIfIndex": "192.168.1.1", "cmgwIpConfigVpi": -2147483648, "cmgwIpConfigVci": -2147483648, "cmgwIpConfigAddrType": "192.168.1.1", "cmgwIpConfigAddress": "192.168.1.1", "cmgwIpConfigSubnetMask": "192.168.1.1", "cmgwIpConfigDefaultGwIp": true, "cmgwIpConfigForRemoteMapping": true, "cmgwIpConfigRowStatus": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cMediaGwIpConfigEntry-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": "/cMediaGwIpConfigEntry", "x-restconf-kind": "container" }, "/data/CISCO-MEDIA-GATEWAY-MIB:cMediaGwDomainNameConfigEntry": { "get": { "summary": "Get cMediaGwDomainNameConfigEntry list", "description": "Retrieve list of cMediaGwDomainNameConfigEntry entries from MIB", "tags": [ "CISCO-MEDIA-GATEWAY-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Each entry represents a domain name used in the system.\n \n Creation and deletion are supported. Modification\n is prohibited.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref" }, "cmgwConfigDomainNameIndex": { "type": "integer", "description": "An index that is uniquely identifies a domain name\n configured in the system.", "minimum": -2147483648, "maximum": 2147483647 }, "cmgwConfigDomainNameEntity": { "type": "string", "description": "This object indicates which entity to use this domain name.\n \n gateway(1) - The domain name of media gateway.\n With the same cmgwIndex, there is one and \n only one entry allowed with the value \n 'gateway(1)' of this object.\n \n dnsServer(2) - The domain name of DNS name server that is used \n by Media gateway to find Internet Network \n Address from a DNS name.\n \n mgc(3) - The domain name of a MGC (Media Gateway\n Controller) associated with the media \n gateway." }, "cmgwConfigDomainName": { "type": "string", "description": "This object specifies the domain name.\n \n The domain name should be unique if there are more than\n one entries having the same value in the object \n cmgwConfigDomainNameEntity.\n For example, the gateway domain name should be unique \n if the cmgwConfigDomainNameEntity has the value of \n 'gateway(1)'.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cmgwConfigDomainNameRowStatus": { "type": "string", "description": "This object is used to add and delete an entry.\n \n When an entry is created, the following objects\n are mandatory:\n cmgwConfigDomainName\n cmgwConfigDomainNameEntity\n \n When deleting domain name of DNS name server\n (cmgwConfigDomainNameEntity is dnsServer (2)), the \n cMediaGwDnsIpConfigTable should be empty.\n \n Adding/deleting entry with cmgwConfigDomainNameEntity\n of 'mgc' will cause adding/deleting entry in \n cMgcConfigTable (CISCO-MGC-MIB) automatically.\n \n The cmgwConfigDomainName and cmgwConfigDomainNameEntity\n can not be modified if the value of this object is\n 'active'.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "CISCO-MEDIA-GATEWAY-MIB:cMediaGwDomainNameConfigEntry": [ { "cmgwIndex": "example-string", "cmgwConfigDomainNameIndex": 1, "cmgwConfigDomainNameEntity": "interface-1", "cmgwConfigDomainName": "interface-1", "cmgwConfigDomainNameRowStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cMediaGwDomainNameConfigEntry-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": "/cMediaGwDomainNameConfigEntry", "x-restconf-kind": "container" }, "/data/CISCO-MEDIA-GATEWAY-MIB:cMediaGwDnsIpConfigEntry": { "get": { "summary": "Get cMediaGwDnsIpConfigEntry list", "description": "Retrieve list of cMediaGwDnsIpConfigEntry entries from MIB", "tags": [ "CISCO-MEDIA-GATEWAY-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Each entry represents an IP address of the DNS name \n server.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref" }, "cmgwDnsIpIndex": { "type": "integer", "description": "An index that uniquely identifies an IP address of DNS\n name server.", "minimum": -2147483648, "maximum": 2147483647 }, "cmgwDnsDomainName": { "type": "string", "description": "The domain name of DNS name server.\n \n The value of this object reflects the value of \n cmgwConfigDomainName from the entry with a value of \n 'dnsServer(2)' for object cmgwConfigDomainNameEntity of \n cMediaGwDomainNameConfigTable.\n \n If there is no entry in cMediaGwDomainNameConfigTable with\n 'dnsServer(2)' of cmgwConfigDomainNameEntity, then\n the value of this object will be empty string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cmgwDnsIpType": { "type": "string", "description": "DNS name server IP address type.", "x-yang-type": "inet-address:InetAddressType" }, "cmgwDnsIp": { "type": "string", "description": "The IP address of DNS name server.\n The IP address of DNS name server must be unique\n in this table.", "x-yang-type": "inet-address:InetAddress" }, "cmgwDnsIpRowStatus": { "type": "string", "description": "This object is used to add and delete an entry.\n \n When an entry of the table is created, the value of\n this object should be set to 'createAndGo' and the\n following objects are mandatory:\n cmgwDnsIp\n \n When the user wants to delete the entry, the value of\n this object should be set to 'destroy'.\n \n The entry can not be modified if the value of this \n object is 'active'.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "CISCO-MEDIA-GATEWAY-MIB:cMediaGwDnsIpConfigEntry": [ { "cmgwIndex": "example-string", "cmgwDnsIpIndex": 1, "cmgwDnsDomainName": "interface-1", "cmgwDnsIpType": "192.168.1.1", "cmgwDnsIp": "192.168.1.1", "cmgwDnsIpRowStatus": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cMediaGwDnsIpConfigEntry-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": "/cMediaGwDnsIpConfigEntry", "x-restconf-kind": "container" }, "/data/CISCO-MEDIA-GATEWAY-MIB:cmgwLifEntry": { "get": { "summary": "Get cmgwLifEntry list", "description": "Retrieve list of cmgwLifEntry entries from MIB", "tags": [ "CISCO-MEDIA-GATEWAY-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry of this table is created by the media gateway\n when it supports the VoIP/VoATM application.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref" }, "cmgwLifNumber": { "type": "string", "description": "An index that uniquely identifies a LIF in the \n media gateway.", "x-yang-type": "CISCO-MEDIA-GATEWAY-MIB:GatewayLifNumber" }, "cmgwLifPvcCount": { "type": "integer", "description": "This object represents the total number of PVC within \n this LIF.\n \n When users associate/disassociate a PVC with a LIF \n by giving a non-zero/zero value of cwacChanLifNum\n in cwAtmChanExtConfigTable, the value of this object \n will be incremented/decremented accordingly.\n \n The value zero means there is no PVC associated with \n the LIF.", "minimum": 0, "maximum": 4294967295 }, "cmgwLifVoiceIfCount": { "type": "integer", "description": "This object represents the total number of Voice Interfaces\n within this LIF.\n \n When users associate/disassociate a Voice Interface with\n a LIF by giving a non-zero/zero value of \n ccasVoiceCfgLifNumber for the DS0 group in \n ccasVoiceExtCfgTable, the value of this object will be \n incremented/decremented accordingly. \n \n The value zero means there is no Voice Interface associated\n with the LIF.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-MEDIA-GATEWAY-MIB:cmgwLifEntry": [ { "cmgwIndex": "example-string", "cmgwLifNumber": "example-string", "cmgwLifPvcCount": 0, "cmgwLifVoiceIfCount": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cmgwLifEntry-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": "/cmgwLifEntry", "x-restconf-kind": "container" }, "/data/CISCO-MEDIA-GATEWAY-MIB:cMediaGwCallControlConfigEntry": { "get": { "summary": "Get cMediaGwCallControlConfigEntry list", "description": "Retrieve list of cMediaGwCallControlConfigEntry entries from MIB", "tags": [ "CISCO-MEDIA-GATEWAY-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "One entry for each media gateway which supports call control \n protocol.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref" }, "cMediaGwCcCfgControlTos": { "type": "integer", "description": "This object specifies Type Of Service (TOS) field of\n IP header for the signaling control packet in VoIP\n application.", "minimum": 0, "maximum": 4294967295 }, "cMediaGwCcCfgBearerTos": { "type": "integer", "description": "This object specifies Type Of Service (TOS) field\n of IP header for the voice payload packet in VoIP\n application.", "minimum": 0, "maximum": 4294967295 }, "cMediaGwCcCfgNtePayload": { "type": "integer", "description": "This object specifies NTE (Named Telephony Events)\n payload type.", "minimum": 0, "maximum": 4294967295 }, "cMediaGwCcCfgNsePayload": { "type": "integer", "description": "This object specifies NSE (Network Signaling Events)\n payload type.", "minimum": 0, "maximum": 4294967295 }, "cMediaGwCcCfgNseRespTimer": { "type": "integer", "description": "This object specifies Network Signaling Event (NSE)\n timeout value.", "minimum": 0, "maximum": 4294967295 }, "cMediaGwCcCfgVbdJitterDelayMode": { "type": "string", "description": "The object specifies the jitter buffer mode applied to\n a VBD (Voice Band Data) call connection.\n \n adaptive - means to use cMediaGwCcCfgVbdJitterNomDelay as\n the initial jitter buffers size and let the DSP\n pick the optimal value of the jitter buffer\n size between the range of\n cMediaGwCcCfgVbcJitterMaxDelay and\n cMediaGwCcCfgVbcJitterMinDelay.\n \n fixed - means to use a constant jitter buffer size\n which is specified by cMediaGwCcCfgVbdJitterNomDelay.", "x-yang-type": "CISCO-MEDIA-GATEWAY-MIB:CCallControlJitterDelayMode" }, "cMediaGwCcCfgVbdJitterMaxDelay": { "type": "integer", "description": "This object specifies the maximum jitter buffer size \n in VBD (Voice Band Data)", "minimum": 0, "maximum": 4294967295 }, "cMediaGwCcCfgVbdJitterNomDelay": { "type": "integer", "description": "This object specifies the nominal jitter buffer size \n in VBD (Voice Band Data)", "minimum": 0, "maximum": 4294967295 }, "cMediaGwCcCfgVbdJitterMinDelay": { "type": "integer", "description": "This object specifies the nominal jitter buffer size \n in VBD (Voice Band Data)", "minimum": 0, "maximum": 4294967295 }, "cMediaGwCcCfgDefaultTonePlanId": { "type": "string", "description": "This object specifies the default tone plan index\n (the value of cvtcTonePlanId) for the media gateway.", "x-yang-type": "CISCO-MEDIA-GATEWAY-MIB:CVoiceTonePlanIndex" }, "cMediaGwCcCfgDescrInfoEnabled": { "type": "boolean", "description": "This object specifies whether the media gateway supports\n descriptive suffix of the name schema for terminations.\n \n There are two parts in name schema of termination, prefix\n and suffix. For example the name schema for a DS (Digital\n Subscriber) termination, can be 'DS/OC3_2/DS1_6/DS0_24'.\n It represents DS type termination in 2nd OC3 line, \n 6th DS1 and 24th DS0 channel. In this example, 'DS' is \n the prefix, 'OC3_2/DS1_6/DS0_24' is the suffix.\n \n The name schema in above example has a descriptive suffix.\n The non-descriptive suffix for the same termination is \n '2/6/24' and name schema becomes 'DS/2/6/24'.\n \n This object can not be modified if there is any termination\n existing in the media gateway." }, "cMediaGwCcCfgDsNamePrefix": { "type": "string", "description": "This object specifies the prefix of the name schema for\n DS (Digital Subscriber) terminations.\n The value of this object must be unique among the \n following objects:\n cMediaGwCcCfgDsNamePrefix\n cMediaGwCcCfgRtpNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgDefRtpNamePrefix\n This object can not be modified when there is any\n DS termination existing in the media gateway.\n It is default to 'DS'.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cMediaGwCcCfgRtpNamePrefix": { "type": "string", "description": "This object specifies the prefix of the name schema for\n RTP (Real-Time Transport Protocol) terminations.\n The value of this object must be unique among the \n following objects:\n cMediaGwCcCfgDsNamePrefix\n cMediaGwCcCfgRtpNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgDefRtpNamePrefix\n This object can not be modified when there is any\n RTP termination type existing in the media gateway.\n It is default to 'RTP'.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cMediaGwCcCfgAal1SvcNamePrefix": { "type": "string", "description": "This object specifies the prefix of the name schema for\n voice over AAL1 SVC (Switched Virtual Circuit)\n terminations.\n The value of this object must be unique among the \n following objects:\n cMediaGwCcCfgDsNamePrefix\n cMediaGwCcCfgRtpNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgDefRtpNamePrefix\n This object can not be modified when there is any\n AAL1 SVC termination type existing in the media gateway.\n It is default to 'AAL1/SVC'.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cMediaGwCcCfgAal2SvcNamePrefix": { "type": "string", "description": "This object specifies the prefix of the name schema for\n voice over AAL2 SVC (Switched Virtual Circuit)\n terminations.\n The value of this object must be unique among the \n following objects:\n cMediaGwCcCfgDsNamePrefix\n cMediaGwCcCfgRtpNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgDefRtpNamePrefix\n This object can not be modified when there is any\n AAL2 SVC termination type existing in the media gateway.\n It is default to 'AAL2/SVC'.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cMediaGwCcCfgClusterEnabled": { "type": "string", "description": "This object specifies the condition of the cluster generation\n in the call control.\n \n A cluster is a group of endpoints that share a particular\n bearer possibility for connections among each other.\n \n disabled(1) - The generation of the cluster attribute\n is disabled.\n enabled(2) - Unconditionally generate the cluster\n attribute.\n conditionalEnabled(3) - The generation of the cluster \n attribute is upon MGC request." }, "cMediaGwCcCfgDefBearerTraffic": { "type": "string", "description": "This object specifies the combination of the network\n type (IP/ATM), virtual circuit type (PVC/SVC) and\n ATM adaptation layer type (AAL1/AAL2/AAL5) for the\n connection used in transporting bearer traffic.\n \n ipPvcAal5 (1) - The bearer traffic is transported in\n IP network, through Permanent Virtual\n Circuit(PVC) over AAL5 adaptation layer.\n atmPvcAal2 (2) - The bearer traffic is transported in\n ATM network, through Permanent Virtual\n Circuit(PVC) over AAL2 adaptation layer.\n atmSvcAal2 (3) - The bearer traffic is transported in\n ATM network, through Switching Virtual\n Circuit(SVC) over AAL2 adaptation layer.\n atmSvcAal1 (4) - The bearer traffic is transported in\n ATM network, through Switching Virtual\n Circuit(SVC) over AAL1 adaptation layer.\n \n In MGCP, if the call agent specifies the bear traffic type \n in the local connection options (CRCX request), \n configuration of this object will have no effect, \n otherwise the value of this object will be used when \n media gateway sending CRCX response." }, "cMediaGwCcCfgDefRtpNamePrefix": { "type": "string", "description": "This object specifies the prefix of the name schema for\n default RTP terminations.\n The value of this object must be unique among the \n following objects:\n cMediaGwCcCfgDsNamePrefix\n cMediaGwCcCfgRtpNamePrefix\n cMediaGwCcCfgAal1SvcNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n \n It is defaulted to 'TGWRTP'.", "x-yang-type": "snmp-framework:SnmpAdminString" } } } }, "example": { "CISCO-MEDIA-GATEWAY-MIB:cMediaGwCallControlConfigEntry": [ { "cmgwIndex": "example-string", "cMediaGwCcCfgControlTos": 0, "cMediaGwCcCfgBearerTos": 0, "cMediaGwCcCfgNtePayload": 0, "cMediaGwCcCfgNsePayload": 0, "cMediaGwCcCfgNseRespTimer": 0, "cMediaGwCcCfgVbdJitterDelayMode": "example-string", "cMediaGwCcCfgVbdJitterMaxDelay": 0, "cMediaGwCcCfgVbdJitterNomDelay": 0, "cMediaGwCcCfgVbdJitterMinDelay": 0, "cMediaGwCcCfgDefaultTonePlanId": "example-string", "cMediaGwCcCfgDescrInfoEnabled": true, "cMediaGwCcCfgDsNamePrefix": "interface-1", "cMediaGwCcCfgRtpNamePrefix": "interface-1", "cMediaGwCcCfgAal1SvcNamePrefix": "interface-1", "cMediaGwCcCfgAal2SvcNamePrefix": "interface-1", "cMediaGwCcCfgClusterEnabled": "example-string", "cMediaGwCcCfgDefBearerTraffic": "example-string", "cMediaGwCcCfgDefRtpNamePrefix": "interface-1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cMediaGwCallControlConfigEntry-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": "/cMediaGwCallControlConfigEntry", "x-restconf-kind": "container" }, "/data/CISCO-MEDIA-GATEWAY-MIB:cMediaGwCallControlConfigEntry={cmgwIndex}": { "get": { "summary": "Get cMediaGwCallControlConfigEntry entry", "description": "Retrieve specific cMediaGwCallControlConfigEntry entry by key from MIB", "tags": [ "CISCO-MEDIA-GATEWAY-MIB" ], "parameters": [ { "name": "cmgwIndex", "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": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref" }, "cMediaGwCcCfgControlTos": { "type": "integer", "description": "This object specifies Type Of Service (TOS) field of\n IP header for the signaling control packet in VoIP\n application.", "minimum": 0, "maximum": 4294967295 }, "cMediaGwCcCfgBearerTos": { "type": "integer", "description": "This object specifies Type Of Service (TOS) field\n of IP header for the voice payload packet in VoIP\n application.", "minimum": 0, "maximum": 4294967295 }, "cMediaGwCcCfgNtePayload": { "type": "integer", "description": "This object specifies NTE (Named Telephony Events)\n payload type.", "minimum": 0, "maximum": 4294967295 }, "cMediaGwCcCfgNsePayload": { "type": "integer", "description": "This object specifies NSE (Network Signaling Events)\n payload type.", "minimum": 0, "maximum": 4294967295 }, "cMediaGwCcCfgNseRespTimer": { "type": "integer", "description": "This object specifies Network Signaling Event (NSE)\n timeout value.", "minimum": 0, "maximum": 4294967295 }, "cMediaGwCcCfgVbdJitterDelayMode": { "type": "string", "description": "The object specifies the jitter buffer mode applied to\n a VBD (Voice Band Data) call connection.\n \n adaptive - means to use cMediaGwCcCfgVbdJitterNomDelay as\n the initial jitter buffers size and let the DSP\n pick the optimal value of the jitter buffer\n size between the range of\n cMediaGwCcCfgVbcJitterMaxDelay and\n cMediaGwCcCfgVbcJitterMinDelay.\n \n fixed - means to use a constant jitter buffer size\n which is specified by cMediaGwCcCfgVbdJitterNomDelay.", "x-yang-type": "CISCO-MEDIA-GATEWAY-MIB:CCallControlJitterDelayMode" }, "cMediaGwCcCfgVbdJitterMaxDelay": { "type": "integer", "description": "This object specifies the maximum jitter buffer size \n in VBD (Voice Band Data)", "minimum": 0, "maximum": 4294967295 }, "cMediaGwCcCfgVbdJitterNomDelay": { "type": "integer", "description": "This object specifies the nominal jitter buffer size \n in VBD (Voice Band Data)", "minimum": 0, "maximum": 4294967295 }, "cMediaGwCcCfgVbdJitterMinDelay": { "type": "integer", "description": "This object specifies the nominal jitter buffer size \n in VBD (Voice Band Data)", "minimum": 0, "maximum": 4294967295 }, "cMediaGwCcCfgDefaultTonePlanId": { "type": "string", "description": "This object specifies the default tone plan index\n (the value of cvtcTonePlanId) for the media gateway.", "x-yang-type": "CISCO-MEDIA-GATEWAY-MIB:CVoiceTonePlanIndex" }, "cMediaGwCcCfgDescrInfoEnabled": { "type": "boolean", "description": "This object specifies whether the media gateway supports\n descriptive suffix of the name schema for terminations.\n \n There are two parts in name schema of termination, prefix\n and suffix. For example the name schema for a DS (Digital\n Subscriber) termination, can be 'DS/OC3_2/DS1_6/DS0_24'.\n It represents DS type termination in 2nd OC3 line, \n 6th DS1 and 24th DS0 channel. In this example, 'DS' is \n the prefix, 'OC3_2/DS1_6/DS0_24' is the suffix.\n \n The name schema in above example has a descriptive suffix.\n The non-descriptive suffix for the same termination is \n '2/6/24' and name schema becomes 'DS/2/6/24'.\n \n This object can not be modified if there is any termination\n existing in the media gateway." }, "cMediaGwCcCfgDsNamePrefix": { "type": "string", "description": "This object specifies the prefix of the name schema for\n DS (Digital Subscriber) terminations.\n The value of this object must be unique among the \n following objects:\n cMediaGwCcCfgDsNamePrefix\n cMediaGwCcCfgRtpNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgDefRtpNamePrefix\n This object can not be modified when there is any\n DS termination existing in the media gateway.\n It is default to 'DS'.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cMediaGwCcCfgRtpNamePrefix": { "type": "string", "description": "This object specifies the prefix of the name schema for\n RTP (Real-Time Transport Protocol) terminations.\n The value of this object must be unique among the \n following objects:\n cMediaGwCcCfgDsNamePrefix\n cMediaGwCcCfgRtpNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgDefRtpNamePrefix\n This object can not be modified when there is any\n RTP termination type existing in the media gateway.\n It is default to 'RTP'.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cMediaGwCcCfgAal1SvcNamePrefix": { "type": "string", "description": "This object specifies the prefix of the name schema for\n voice over AAL1 SVC (Switched Virtual Circuit)\n terminations.\n The value of this object must be unique among the \n following objects:\n cMediaGwCcCfgDsNamePrefix\n cMediaGwCcCfgRtpNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgDefRtpNamePrefix\n This object can not be modified when there is any\n AAL1 SVC termination type existing in the media gateway.\n It is default to 'AAL1/SVC'.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cMediaGwCcCfgAal2SvcNamePrefix": { "type": "string", "description": "This object specifies the prefix of the name schema for\n voice over AAL2 SVC (Switched Virtual Circuit)\n terminations.\n The value of this object must be unique among the \n following objects:\n cMediaGwCcCfgDsNamePrefix\n cMediaGwCcCfgRtpNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgDefRtpNamePrefix\n This object can not be modified when there is any\n AAL2 SVC termination type existing in the media gateway.\n It is default to 'AAL2/SVC'.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cMediaGwCcCfgClusterEnabled": { "type": "string", "description": "This object specifies the condition of the cluster generation\n in the call control.\n \n A cluster is a group of endpoints that share a particular\n bearer possibility for connections among each other.\n \n disabled(1) - The generation of the cluster attribute\n is disabled.\n enabled(2) - Unconditionally generate the cluster\n attribute.\n conditionalEnabled(3) - The generation of the cluster \n attribute is upon MGC request." }, "cMediaGwCcCfgDefBearerTraffic": { "type": "string", "description": "This object specifies the combination of the network\n type (IP/ATM), virtual circuit type (PVC/SVC) and\n ATM adaptation layer type (AAL1/AAL2/AAL5) for the\n connection used in transporting bearer traffic.\n \n ipPvcAal5 (1) - The bearer traffic is transported in\n IP network, through Permanent Virtual\n Circuit(PVC) over AAL5 adaptation layer.\n atmPvcAal2 (2) - The bearer traffic is transported in\n ATM network, through Permanent Virtual\n Circuit(PVC) over AAL2 adaptation layer.\n atmSvcAal2 (3) - The bearer traffic is transported in\n ATM network, through Switching Virtual\n Circuit(SVC) over AAL2 adaptation layer.\n atmSvcAal1 (4) - The bearer traffic is transported in\n ATM network, through Switching Virtual\n Circuit(SVC) over AAL1 adaptation layer.\n \n In MGCP, if the call agent specifies the bear traffic type \n in the local connection options (CRCX request), \n configuration of this object will have no effect, \n otherwise the value of this object will be used when \n media gateway sending CRCX response." }, "cMediaGwCcCfgDefRtpNamePrefix": { "type": "string", "description": "This object specifies the prefix of the name schema for\n default RTP terminations.\n The value of this object must be unique among the \n following objects:\n cMediaGwCcCfgDsNamePrefix\n cMediaGwCcCfgRtpNamePrefix\n cMediaGwCcCfgAal1SvcNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n \n It is defaulted to 'TGWRTP'.", "x-yang-type": "snmp-framework:SnmpAdminString" } } }, "example": { "CISCO-MEDIA-GATEWAY-MIB:cMediaGwCallControlConfigEntry": { "cmgwIndex": "example-string", "cMediaGwCcCfgControlTos": 0, "cMediaGwCcCfgBearerTos": 0, "cMediaGwCcCfgNtePayload": 0, "cMediaGwCcCfgNsePayload": 0, "cMediaGwCcCfgNseRespTimer": 0, "cMediaGwCcCfgVbdJitterDelayMode": "example-string", "cMediaGwCcCfgVbdJitterMaxDelay": 0, "cMediaGwCcCfgVbdJitterNomDelay": 0, "cMediaGwCcCfgVbdJitterMinDelay": 0, "cMediaGwCcCfgDefaultTonePlanId": "example-string", "cMediaGwCcCfgDescrInfoEnabled": true, "cMediaGwCcCfgDsNamePrefix": "interface-1", "cMediaGwCcCfgRtpNamePrefix": "interface-1", "cMediaGwCcCfgAal1SvcNamePrefix": "interface-1", "cMediaGwCcCfgAal2SvcNamePrefix": "interface-1", "cMediaGwCcCfgClusterEnabled": "example-string", "cMediaGwCcCfgDefBearerTraffic": "example-string", "cMediaGwCcCfgDefRtpNamePrefix": "interface-1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cMediaGwCallControlConfigEntry-4" }, "x-yang-path": "/cMediaGwCallControlConfigEntry={cmgwIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cmgwIndex" ] }, "/data/CISCO-MEDIA-GATEWAY-MIB:cMediaGwRscStatsEntry": { "get": { "summary": "Get cMediaGwRscStatsEntry list", "description": "Retrieve list of cMediaGwRscStatsEntry entries from MIB", "tags": [ "CISCO-MEDIA-GATEWAY-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Each entry stores the statistics\n information for a specific resource.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref" }, "cmgwRscStatsIndex": { "type": "string", "description": "An index that uniquely identifies a specific gateway\n resource." }, "cmgwRscMaximumUtilization": { "type": "integer", "description": "This object indicates the maximum utilization of the\n resource over the interval specified by the\n 'cmgwRscSinceLastReset'.", "minimum": 0, "maximum": 4294967295 }, "cmgwRscMinimumUtilization": { "type": "integer", "description": "This object indicates the minimum utilization of the\n resource over the interval specified by the\n 'cmgwRscSinceLastReset'.", "minimum": 0, "maximum": 4294967295 }, "cmgwRscAverageUtilization": { "type": "integer", "description": "This object indicates the average utilization of the\n resource over the interval specified by the\n 'cmgwRscSinceLastReset'.", "minimum": 0, "maximum": 4294967295 }, "cmgwRscSinceLastReset": { "type": "integer", "description": "The elapsed time (in seconds) from the last periodic reset.\n \n The following objects are reset at the last reset:\n \n 'cmgwRscMaximumUtilization'\n 'cmgwRscMinimumUtilization'\n 'cmgwRscAverageUtilization'", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-MEDIA-GATEWAY-MIB:cMediaGwRscStatsEntry": [ { "cmgwIndex": "example-string", "cmgwRscStatsIndex": "example-string", "cmgwRscMaximumUtilization": 0, "cmgwRscMinimumUtilization": 0, "cmgwRscAverageUtilization": 0, "cmgwRscSinceLastReset": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cMediaGwRscStatsEntry-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": "/cMediaGwRscStatsEntry", "x-restconf-kind": "container" }, "/data/CISCO-MEDIA-GATEWAY-MIB:cmgwSignalProtocolTable/cmgwSignalProtocolEntry={cmgwIndex},{cmgwSignalProtocolIndex}": { "get": { "summary": "Get cmgwSignalProtocolEntry entry", "description": "Retrieve specific cmgwSignalProtocolEntry entry by key from MIB", "tags": [ "CISCO-MEDIA-GATEWAY-MIB" ], "parameters": [ { "name": "cmgwIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cmgwSignalProtocolIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref" }, "cmgwSignalProtocolIndex": { "type": "integer", "description": "An index that uniquely identifies an entry in\n cmgwSignalProtocolTable.", "minimum": -2147483648, "maximum": 2147483647 }, "cmgwSignalProtocol": { "type": "string", "description": "This object is used to represent the protocol type.\n other - None of the following types.\n mgcp - Media Gateway Control Protocol\n h248 - Media Gateway Control (ITU H.248)\n tgcp - Trunking Gateway Control Protocol" }, "cmgwSignalProtocolVersion": { "type": "string", "description": "This object is used to represent the protocol version. \n For example cmgwSignalProtocol is 'mgcp(2)' and\n this object is string '1.0'. cmgwSignalProtocol is \n 'h248(3)' and this object is set to '2.0'.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cmgwSignalProtocolPort": { "type": "string", "description": "This object is used to represent the UDP port associated \n with the protocol.\n If the value of cmgwSignalProtocol is 'mgcp(2)' and the\n value of cmgwSignalProtcolVersion is '1.0', the default\n value of this object is '2727'. \n If the value of cmgwSignalProtocol is 'h248(3)' and the\n value of cmgwSignalProtcolVersion is '1.0', the default\n value of this object is '2944'.", "x-yang-type": "cisco-tc:CiscoPort" }, "cmgwSignalMgcProtocolPort": { "type": "string", "description": "This object specifies the protocol port of the Media Gateway\n Controller (MGC).\n If the value of cmgwSignalProtocol is 'mgcp(2)' or 'tgcp(4)'\n and the value of cmgwSignalProtcolVersion is '1.0', the\n default value of this object is '2427'.\n If the value of cmgwSignalProtocol is 'h248(3)' and the\n value of cmgwSignalProtcolVersion is '1.0', the default\n value of this object is '2944'.", "format": "inet:port-number" }, "cmgwSignalProtocolPreference": { "type": "integer", "description": "This object specifies the preference of the signal protocol \n supported in the media gateway.\n \n If this object is set to 0, the corresponding signal\n protocol will not be used by the gateway.\n \n The value of this object is unique within the corresponding\n gateway. The entry with lower value has higher preference.", "minimum": -2147483648, "maximum": 2147483647 }, "cmgwSignalProtocolConfigVer": { "type": "string", "description": "This object specifies the protocol version\n used by the gateway in the messages to MGC\n in order to exchange the service capabilities.\n \n For example cmgwSignalProtocol is 'h248(3)' and\n this object can be string '1' or '1.0', '2' or '2.0'. \n \n 'MAX' is a special string indicating the gateway will\n use the highest protocol version supported in the \n gateway, but it can be changed to lower version after \n it negotiates with MGC. The final negotiated protocol\n version will be indicated in cmgwSignalProtocolVersion.\n \n The version strings other than 'MAX' can be specified for\n the gateway to communicate with the MGC which doesn't\n support service capabilities negotiation. For example if\n a MGC supports only version 1.0 MGCP, this object should\n be set to '1' to instruct the gateway using MGCP \n version 1.0 format messages to communicate with MGC.", "x-yang-type": "snmp-framework:SnmpAdminString" } } }, "example": { "CISCO-MEDIA-GATEWAY-MIB:cmgwSignalProtocolEntry": { "cmgwIndex": "example-string", "cmgwSignalProtocolIndex": 1, "cmgwSignalProtocol": "example-string", "cmgwSignalProtocolVersion": "example-string", "cmgwSignalProtocolPort": "example-string", "cmgwSignalMgcProtocolPort": "example-string", "cmgwSignalProtocolPreference": -2147483648, "cmgwSignalProtocolConfigVer": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cmgwSignalProtocolEntry-2" }, "x-yang-path": "/cmgwSignalProtocolTable/cmgwSignalProtocolEntry={cmgwIndex cmgwSignalProtocolIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cmgwIndex cmgwSignalProtocolIndex" ] }, "/data/CISCO-MEDIA-GATEWAY-MIB:cMediaGwIpConfigTable/cMediaGwIpConfigEntry={cmgwIndex},{cmgwIpConfigIndex}": { "get": { "summary": "Get cMediaGwIpConfigEntry entry", "description": "Retrieve specific cMediaGwIpConfigEntry entry by key from MIB", "tags": [ "CISCO-MEDIA-GATEWAY-MIB" ], "parameters": [ { "name": "cmgwIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cmgwIpConfigIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref" }, "cmgwIpConfigIndex": { "type": "integer", "description": "A unique index to identify each media gateway IP address.", "minimum": -2147483648, "maximum": 2147483647 }, "cmgwIpConfigIfIndex": { "type": "string", "description": "This object is ifIndex of the interface which is associated\n to the media gateway IP address.\n \n For ATM interface, the IP address should be associated to\n an existing PVC:\n cmgwIpConfigIfIndex represents port of the PVC\n cmgwIpConfigVpi represents VPI of the PVC\n cmgwIpConfigVci represents VCI of the PVC\n And one PVC only can be associated with one IP address.\n \n If this object is set to zero which means the IP address\n is not associated to any interface.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "cmgwIpConfigVpi": { "type": "integer", "description": "This object represents VPI of the PVC which is associated\n to the IP address.\n If the IP address is not associated to PVC, the value \n of this object is set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "cmgwIpConfigVci": { "type": "integer", "description": "This object represents VCI of the PVC which is associated\n to the IP address.\n If the IP address is not associated to PVC, the value\n of this object is set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "cmgwIpConfigAddrType": { "type": "string", "description": "This object is the IP address type.", "x-yang-type": "inet-address:InetAddressType" }, "cmgwIpConfigAddress": { "type": "string", "description": "The configured IP address of media gateway.\n This object can not be modified.", "x-yang-type": "inet-address:InetAddress" }, "cmgwIpConfigSubnetMask": { "type": "string", "description": "This object is used to specify the number of leading one \n bits which from the mask to be logical-ANDed with the media \n gateway address before being compared to the value in the \n cmgwIpCofigAddress.\n \n Any assignment (implicit or otherwise) of an instance of\n this object to a value x must be rejected if the bitwise\n logical-AND of the mask formed from x with the value \n of the corresponding instance of the cmgwIpCofigAddress \n object is not equal to cmgwIpCofigAddress.", "x-yang-type": "inet-address:InetAddressPrefixLength" }, "cmgwIpConfigDefaultGwIp": { "type": "boolean", "description": "This object specifies cmgwIpConfigAddress of the entry\n will become the default gateway address.\n This object can be set to 'true' for only one entry in\n the table." }, "cmgwIpConfigForRemoteMapping": { "type": "boolean", "description": "This object specifies whether the address defined in\n cmgwIpConfigAddress is the address mapping at the\n remote end of this PVC. \n \n If this object is set to 'true', the address defined\n in cmgwIpConfigAddress is for the remote end of the PVC.\n If this object is set to 'false', the address defined\n in cmgwIpConfigAddress is for the local end of the PVC." }, "cmgwIpConfigRowStatus": { "type": "string", "description": "This object is used to add and delete an entry.\n \n When an entry of the table is created, the following \n objects are mandatory:\n cmgwIpConfigIfIndex\n cmgwIpConfigVpi\n cmgwIpConfigVci\n cmgwIpConfigAddress\n cmgwIpConfigSubnetMask\n \n These objects can not be modified after the value of this\n object is set to 'active'. \n Modification can only be done by deleting and re-adding the \n entry again.\n \n After the system verify the validity of the data, it\n will set the cmgwIpConfigRowStatus to 'active'.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "CISCO-MEDIA-GATEWAY-MIB:cMediaGwIpConfigEntry": { "cmgwIndex": "example-string", "cmgwIpConfigIndex": 1, "cmgwIpConfigIfIndex": "192.168.1.1", "cmgwIpConfigVpi": -2147483648, "cmgwIpConfigVci": -2147483648, "cmgwIpConfigAddrType": "192.168.1.1", "cmgwIpConfigAddress": "192.168.1.1", "cmgwIpConfigSubnetMask": "192.168.1.1", "cmgwIpConfigDefaultGwIp": true, "cmgwIpConfigForRemoteMapping": true, "cmgwIpConfigRowStatus": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cMediaGwIpConfigEntry-2" }, "x-yang-path": "/cMediaGwIpConfigTable/cMediaGwIpConfigEntry={cmgwIndex cmgwIpConfigIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cmgwIndex cmgwIpConfigIndex" ] }, "/data/CISCO-MEDIA-GATEWAY-MIB:cMediaGwDomainNameConfigTable/cMediaGwDomainNameConfigEntry={cmgwIndex},{cmgwConfigDomainNameIndex}": { "get": { "summary": "Get cMediaGwDomainNameConfigEntry entry", "description": "Retrieve specific cMediaGwDomainNameConfigEntry entry by key from MIB", "tags": [ "CISCO-MEDIA-GATEWAY-MIB" ], "parameters": [ { "name": "cmgwIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cmgwConfigDomainNameIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref" }, "cmgwConfigDomainNameIndex": { "type": "integer", "description": "An index that is uniquely identifies a domain name\n configured in the system.", "minimum": -2147483648, "maximum": 2147483647 }, "cmgwConfigDomainNameEntity": { "type": "string", "description": "This object indicates which entity to use this domain name.\n \n gateway(1) - The domain name of media gateway.\n With the same cmgwIndex, there is one and \n only one entry allowed with the value \n 'gateway(1)' of this object.\n \n dnsServer(2) - The domain name of DNS name server that is used \n by Media gateway to find Internet Network \n Address from a DNS name.\n \n mgc(3) - The domain name of a MGC (Media Gateway\n Controller) associated with the media \n gateway." }, "cmgwConfigDomainName": { "type": "string", "description": "This object specifies the domain name.\n \n The domain name should be unique if there are more than\n one entries having the same value in the object \n cmgwConfigDomainNameEntity.\n For example, the gateway domain name should be unique \n if the cmgwConfigDomainNameEntity has the value of \n 'gateway(1)'.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cmgwConfigDomainNameRowStatus": { "type": "string", "description": "This object is used to add and delete an entry.\n \n When an entry is created, the following objects\n are mandatory:\n cmgwConfigDomainName\n cmgwConfigDomainNameEntity\n \n When deleting domain name of DNS name server\n (cmgwConfigDomainNameEntity is dnsServer (2)), the \n cMediaGwDnsIpConfigTable should be empty.\n \n Adding/deleting entry with cmgwConfigDomainNameEntity\n of 'mgc' will cause adding/deleting entry in \n cMgcConfigTable (CISCO-MGC-MIB) automatically.\n \n The cmgwConfigDomainName and cmgwConfigDomainNameEntity\n can not be modified if the value of this object is\n 'active'.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "CISCO-MEDIA-GATEWAY-MIB:cMediaGwDomainNameConfigEntry": { "cmgwIndex": "example-string", "cmgwConfigDomainNameIndex": 1, "cmgwConfigDomainNameEntity": "interface-1", "cmgwConfigDomainName": "interface-1", "cmgwConfigDomainNameRowStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cMediaGwDomainNameConfigEntry-2" }, "x-yang-path": "/cMediaGwDomainNameConfigTable/cMediaGwDomainNameConfigEntry={cmgwIndex cmgwConfigDomainNameIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cmgwIndex cmgwConfigDomainNameIndex" ] }, "/data/CISCO-MEDIA-GATEWAY-MIB:cMediaGwDnsIpConfigTable/cMediaGwDnsIpConfigEntry={cmgwIndex},{cmgwDnsIpIndex}": { "get": { "summary": "Get cMediaGwDnsIpConfigEntry entry", "description": "Retrieve specific cMediaGwDnsIpConfigEntry entry by key from MIB", "tags": [ "CISCO-MEDIA-GATEWAY-MIB" ], "parameters": [ { "name": "cmgwIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cmgwDnsIpIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref" }, "cmgwDnsIpIndex": { "type": "integer", "description": "An index that uniquely identifies an IP address of DNS\n name server.", "minimum": -2147483648, "maximum": 2147483647 }, "cmgwDnsDomainName": { "type": "string", "description": "The domain name of DNS name server.\n \n The value of this object reflects the value of \n cmgwConfigDomainName from the entry with a value of \n 'dnsServer(2)' for object cmgwConfigDomainNameEntity of \n cMediaGwDomainNameConfigTable.\n \n If there is no entry in cMediaGwDomainNameConfigTable with\n 'dnsServer(2)' of cmgwConfigDomainNameEntity, then\n the value of this object will be empty string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cmgwDnsIpType": { "type": "string", "description": "DNS name server IP address type.", "x-yang-type": "inet-address:InetAddressType" }, "cmgwDnsIp": { "type": "string", "description": "The IP address of DNS name server.\n The IP address of DNS name server must be unique\n in this table.", "x-yang-type": "inet-address:InetAddress" }, "cmgwDnsIpRowStatus": { "type": "string", "description": "This object is used to add and delete an entry.\n \n When an entry of the table is created, the value of\n this object should be set to 'createAndGo' and the\n following objects are mandatory:\n cmgwDnsIp\n \n When the user wants to delete the entry, the value of\n this object should be set to 'destroy'.\n \n The entry can not be modified if the value of this \n object is 'active'.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "CISCO-MEDIA-GATEWAY-MIB:cMediaGwDnsIpConfigEntry": { "cmgwIndex": "example-string", "cmgwDnsIpIndex": 1, "cmgwDnsDomainName": "interface-1", "cmgwDnsIpType": "192.168.1.1", "cmgwDnsIp": "192.168.1.1", "cmgwDnsIpRowStatus": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cMediaGwDnsIpConfigEntry-2" }, "x-yang-path": "/cMediaGwDnsIpConfigTable/cMediaGwDnsIpConfigEntry={cmgwIndex cmgwDnsIpIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cmgwIndex cmgwDnsIpIndex" ] }, "/data/CISCO-MEDIA-GATEWAY-MIB:cmgwLifTable/cmgwLifEntry={cmgwIndex},{cmgwLifNumber}": { "get": { "summary": "Get cmgwLifEntry entry", "description": "Retrieve specific cmgwLifEntry entry by key from MIB", "tags": [ "CISCO-MEDIA-GATEWAY-MIB" ], "parameters": [ { "name": "cmgwIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cmgwLifNumber", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref" }, "cmgwLifNumber": { "type": "string", "description": "An index that uniquely identifies a LIF in the \n media gateway.", "x-yang-type": "CISCO-MEDIA-GATEWAY-MIB:GatewayLifNumber" }, "cmgwLifPvcCount": { "type": "integer", "description": "This object represents the total number of PVC within \n this LIF.\n \n When users associate/disassociate a PVC with a LIF \n by giving a non-zero/zero value of cwacChanLifNum\n in cwAtmChanExtConfigTable, the value of this object \n will be incremented/decremented accordingly.\n \n The value zero means there is no PVC associated with \n the LIF.", "minimum": 0, "maximum": 4294967295 }, "cmgwLifVoiceIfCount": { "type": "integer", "description": "This object represents the total number of Voice Interfaces\n within this LIF.\n \n When users associate/disassociate a Voice Interface with\n a LIF by giving a non-zero/zero value of \n ccasVoiceCfgLifNumber for the DS0 group in \n ccasVoiceExtCfgTable, the value of this object will be \n incremented/decremented accordingly. \n \n The value zero means there is no Voice Interface associated\n with the LIF.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-MEDIA-GATEWAY-MIB:cmgwLifEntry": { "cmgwIndex": "example-string", "cmgwLifNumber": "example-string", "cmgwLifPvcCount": 0, "cmgwLifVoiceIfCount": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cmgwLifEntry-2" }, "x-yang-path": "/cmgwLifTable/cmgwLifEntry={cmgwIndex cmgwLifNumber}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cmgwIndex cmgwLifNumber" ] }, "/data/CISCO-MEDIA-GATEWAY-MIB:cMediaGwRscStatsTable/cMediaGwRscStatsEntry={cmgwIndex},{cmgwRscStatsIndex}": { "get": { "summary": "Get cMediaGwRscStatsEntry entry", "description": "Retrieve specific cMediaGwRscStatsEntry entry by key from MIB", "tags": [ "CISCO-MEDIA-GATEWAY-MIB" ], "parameters": [ { "name": "cmgwIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cmgwRscStatsIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref" }, "cmgwRscStatsIndex": { "type": "string", "description": "An index that uniquely identifies a specific gateway\n resource." }, "cmgwRscMaximumUtilization": { "type": "integer", "description": "This object indicates the maximum utilization of the\n resource over the interval specified by the\n 'cmgwRscSinceLastReset'.", "minimum": 0, "maximum": 4294967295 }, "cmgwRscMinimumUtilization": { "type": "integer", "description": "This object indicates the minimum utilization of the\n resource over the interval specified by the\n 'cmgwRscSinceLastReset'.", "minimum": 0, "maximum": 4294967295 }, "cmgwRscAverageUtilization": { "type": "integer", "description": "This object indicates the average utilization of the\n resource over the interval specified by the\n 'cmgwRscSinceLastReset'.", "minimum": 0, "maximum": 4294967295 }, "cmgwRscSinceLastReset": { "type": "integer", "description": "The elapsed time (in seconds) from the last periodic reset.\n \n The following objects are reset at the last reset:\n \n 'cmgwRscMaximumUtilization'\n 'cmgwRscMinimumUtilization'\n 'cmgwRscAverageUtilization'", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-MEDIA-GATEWAY-MIB:cMediaGwRscStatsEntry": { "cmgwIndex": "example-string", "cmgwRscStatsIndex": "example-string", "cmgwRscMaximumUtilization": 0, "cmgwRscMinimumUtilization": 0, "cmgwRscAverageUtilization": 0, "cmgwRscSinceLastReset": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cMediaGwRscStatsEntry-2" }, "x-yang-path": "/cMediaGwRscStatsTable/cMediaGwRscStatsEntry={cmgwIndex cmgwRscStatsIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cmgwIndex cmgwRscStatsIndex" ] }, "/data/CISCO-MEDIA-GATEWAY-MIB:cmgwSignalProtocolEntry={cmgwIndex},{cmgwSignalProtocolIndex}": { "get": { "summary": "Get cmgwSignalProtocolEntry entry", "description": "Retrieve specific cmgwSignalProtocolEntry entry by key from MIB", "tags": [ "CISCO-MEDIA-GATEWAY-MIB" ], "parameters": [ { "name": "cmgwIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cmgwSignalProtocolIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref" }, "cmgwSignalProtocolIndex": { "type": "integer", "description": "An index that uniquely identifies an entry in\n cmgwSignalProtocolTable.", "minimum": -2147483648, "maximum": 2147483647 }, "cmgwSignalProtocol": { "type": "string", "description": "This object is used to represent the protocol type.\n other - None of the following types.\n mgcp - Media Gateway Control Protocol\n h248 - Media Gateway Control (ITU H.248)\n tgcp - Trunking Gateway Control Protocol" }, "cmgwSignalProtocolVersion": { "type": "string", "description": "This object is used to represent the protocol version. \n For example cmgwSignalProtocol is 'mgcp(2)' and\n this object is string '1.0'. cmgwSignalProtocol is \n 'h248(3)' and this object is set to '2.0'.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cmgwSignalProtocolPort": { "type": "string", "description": "This object is used to represent the UDP port associated \n with the protocol.\n If the value of cmgwSignalProtocol is 'mgcp(2)' and the\n value of cmgwSignalProtcolVersion is '1.0', the default\n value of this object is '2727'. \n If the value of cmgwSignalProtocol is 'h248(3)' and the\n value of cmgwSignalProtcolVersion is '1.0', the default\n value of this object is '2944'.", "x-yang-type": "cisco-tc:CiscoPort" }, "cmgwSignalMgcProtocolPort": { "type": "string", "description": "This object specifies the protocol port of the Media Gateway\n Controller (MGC).\n If the value of cmgwSignalProtocol is 'mgcp(2)' or 'tgcp(4)'\n and the value of cmgwSignalProtcolVersion is '1.0', the\n default value of this object is '2427'.\n If the value of cmgwSignalProtocol is 'h248(3)' and the\n value of cmgwSignalProtcolVersion is '1.0', the default\n value of this object is '2944'.", "format": "inet:port-number" }, "cmgwSignalProtocolPreference": { "type": "integer", "description": "This object specifies the preference of the signal protocol \n supported in the media gateway.\n \n If this object is set to 0, the corresponding signal\n protocol will not be used by the gateway.\n \n The value of this object is unique within the corresponding\n gateway. The entry with lower value has higher preference.", "minimum": -2147483648, "maximum": 2147483647 }, "cmgwSignalProtocolConfigVer": { "type": "string", "description": "This object specifies the protocol version\n used by the gateway in the messages to MGC\n in order to exchange the service capabilities.\n \n For example cmgwSignalProtocol is 'h248(3)' and\n this object can be string '1' or '1.0', '2' or '2.0'. \n \n 'MAX' is a special string indicating the gateway will\n use the highest protocol version supported in the \n gateway, but it can be changed to lower version after \n it negotiates with MGC. The final negotiated protocol\n version will be indicated in cmgwSignalProtocolVersion.\n \n The version strings other than 'MAX' can be specified for\n the gateway to communicate with the MGC which doesn't\n support service capabilities negotiation. For example if\n a MGC supports only version 1.0 MGCP, this object should\n be set to '1' to instruct the gateway using MGCP \n version 1.0 format messages to communicate with MGC.", "x-yang-type": "snmp-framework:SnmpAdminString" } } }, "example": { "CISCO-MEDIA-GATEWAY-MIB:cmgwSignalProtocolEntry": { "cmgwIndex": "example-string", "cmgwSignalProtocolIndex": 1, "cmgwSignalProtocol": "example-string", "cmgwSignalProtocolVersion": "example-string", "cmgwSignalProtocolPort": "example-string", "cmgwSignalMgcProtocolPort": "example-string", "cmgwSignalProtocolPreference": -2147483648, "cmgwSignalProtocolConfigVer": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cmgwSignalProtocolEntry-4" }, "x-yang-path": "/cmgwSignalProtocolEntry={cmgwIndex cmgwSignalProtocolIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cmgwIndex cmgwSignalProtocolIndex" ] }, "/data/CISCO-MEDIA-GATEWAY-MIB:cMediaGwIpConfigEntry={cmgwIndex},{cmgwIpConfigIndex}": { "get": { "summary": "Get cMediaGwIpConfigEntry entry", "description": "Retrieve specific cMediaGwIpConfigEntry entry by key from MIB", "tags": [ "CISCO-MEDIA-GATEWAY-MIB" ], "parameters": [ { "name": "cmgwIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cmgwIpConfigIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref" }, "cmgwIpConfigIndex": { "type": "integer", "description": "A unique index to identify each media gateway IP address.", "minimum": -2147483648, "maximum": 2147483647 }, "cmgwIpConfigIfIndex": { "type": "string", "description": "This object is ifIndex of the interface which is associated\n to the media gateway IP address.\n \n For ATM interface, the IP address should be associated to\n an existing PVC:\n cmgwIpConfigIfIndex represents port of the PVC\n cmgwIpConfigVpi represents VPI of the PVC\n cmgwIpConfigVci represents VCI of the PVC\n And one PVC only can be associated with one IP address.\n \n If this object is set to zero which means the IP address\n is not associated to any interface.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "cmgwIpConfigVpi": { "type": "integer", "description": "This object represents VPI of the PVC which is associated\n to the IP address.\n If the IP address is not associated to PVC, the value \n of this object is set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "cmgwIpConfigVci": { "type": "integer", "description": "This object represents VCI of the PVC which is associated\n to the IP address.\n If the IP address is not associated to PVC, the value\n of this object is set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "cmgwIpConfigAddrType": { "type": "string", "description": "This object is the IP address type.", "x-yang-type": "inet-address:InetAddressType" }, "cmgwIpConfigAddress": { "type": "string", "description": "The configured IP address of media gateway.\n This object can not be modified.", "x-yang-type": "inet-address:InetAddress" }, "cmgwIpConfigSubnetMask": { "type": "string", "description": "This object is used to specify the number of leading one \n bits which from the mask to be logical-ANDed with the media \n gateway address before being compared to the value in the \n cmgwIpCofigAddress.\n \n Any assignment (implicit or otherwise) of an instance of\n this object to a value x must be rejected if the bitwise\n logical-AND of the mask formed from x with the value \n of the corresponding instance of the cmgwIpCofigAddress \n object is not equal to cmgwIpCofigAddress.", "x-yang-type": "inet-address:InetAddressPrefixLength" }, "cmgwIpConfigDefaultGwIp": { "type": "boolean", "description": "This object specifies cmgwIpConfigAddress of the entry\n will become the default gateway address.\n This object can be set to 'true' for only one entry in\n the table." }, "cmgwIpConfigForRemoteMapping": { "type": "boolean", "description": "This object specifies whether the address defined in\n cmgwIpConfigAddress is the address mapping at the\n remote end of this PVC. \n \n If this object is set to 'true', the address defined\n in cmgwIpConfigAddress is for the remote end of the PVC.\n If this object is set to 'false', the address defined\n in cmgwIpConfigAddress is for the local end of the PVC." }, "cmgwIpConfigRowStatus": { "type": "string", "description": "This object is used to add and delete an entry.\n \n When an entry of the table is created, the following \n objects are mandatory:\n cmgwIpConfigIfIndex\n cmgwIpConfigVpi\n cmgwIpConfigVci\n cmgwIpConfigAddress\n cmgwIpConfigSubnetMask\n \n These objects can not be modified after the value of this\n object is set to 'active'. \n Modification can only be done by deleting and re-adding the \n entry again.\n \n After the system verify the validity of the data, it\n will set the cmgwIpConfigRowStatus to 'active'.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "CISCO-MEDIA-GATEWAY-MIB:cMediaGwIpConfigEntry": { "cmgwIndex": "example-string", "cmgwIpConfigIndex": 1, "cmgwIpConfigIfIndex": "192.168.1.1", "cmgwIpConfigVpi": -2147483648, "cmgwIpConfigVci": -2147483648, "cmgwIpConfigAddrType": "192.168.1.1", "cmgwIpConfigAddress": "192.168.1.1", "cmgwIpConfigSubnetMask": "192.168.1.1", "cmgwIpConfigDefaultGwIp": true, "cmgwIpConfigForRemoteMapping": true, "cmgwIpConfigRowStatus": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cMediaGwIpConfigEntry-4" }, "x-yang-path": "/cMediaGwIpConfigEntry={cmgwIndex cmgwIpConfigIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cmgwIndex cmgwIpConfigIndex" ] }, "/data/CISCO-MEDIA-GATEWAY-MIB:cMediaGwDomainNameConfigEntry={cmgwIndex},{cmgwConfigDomainNameIndex}": { "get": { "summary": "Get cMediaGwDomainNameConfigEntry entry", "description": "Retrieve specific cMediaGwDomainNameConfigEntry entry by key from MIB", "tags": [ "CISCO-MEDIA-GATEWAY-MIB" ], "parameters": [ { "name": "cmgwIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cmgwConfigDomainNameIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref" }, "cmgwConfigDomainNameIndex": { "type": "integer", "description": "An index that is uniquely identifies a domain name\n configured in the system.", "minimum": -2147483648, "maximum": 2147483647 }, "cmgwConfigDomainNameEntity": { "type": "string", "description": "This object indicates which entity to use this domain name.\n \n gateway(1) - The domain name of media gateway.\n With the same cmgwIndex, there is one and \n only one entry allowed with the value \n 'gateway(1)' of this object.\n \n dnsServer(2) - The domain name of DNS name server that is used \n by Media gateway to find Internet Network \n Address from a DNS name.\n \n mgc(3) - The domain name of a MGC (Media Gateway\n Controller) associated with the media \n gateway." }, "cmgwConfigDomainName": { "type": "string", "description": "This object specifies the domain name.\n \n The domain name should be unique if there are more than\n one entries having the same value in the object \n cmgwConfigDomainNameEntity.\n For example, the gateway domain name should be unique \n if the cmgwConfigDomainNameEntity has the value of \n 'gateway(1)'.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cmgwConfigDomainNameRowStatus": { "type": "string", "description": "This object is used to add and delete an entry.\n \n When an entry is created, the following objects\n are mandatory:\n cmgwConfigDomainName\n cmgwConfigDomainNameEntity\n \n When deleting domain name of DNS name server\n (cmgwConfigDomainNameEntity is dnsServer (2)), the \n cMediaGwDnsIpConfigTable should be empty.\n \n Adding/deleting entry with cmgwConfigDomainNameEntity\n of 'mgc' will cause adding/deleting entry in \n cMgcConfigTable (CISCO-MGC-MIB) automatically.\n \n The cmgwConfigDomainName and cmgwConfigDomainNameEntity\n can not be modified if the value of this object is\n 'active'.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "CISCO-MEDIA-GATEWAY-MIB:cMediaGwDomainNameConfigEntry": { "cmgwIndex": "example-string", "cmgwConfigDomainNameIndex": 1, "cmgwConfigDomainNameEntity": "interface-1", "cmgwConfigDomainName": "interface-1", "cmgwConfigDomainNameRowStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cMediaGwDomainNameConfigEntry-4" }, "x-yang-path": "/cMediaGwDomainNameConfigEntry={cmgwIndex cmgwConfigDomainNameIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cmgwIndex cmgwConfigDomainNameIndex" ] }, "/data/CISCO-MEDIA-GATEWAY-MIB:cMediaGwDnsIpConfigEntry={cmgwIndex},{cmgwDnsIpIndex}": { "get": { "summary": "Get cMediaGwDnsIpConfigEntry entry", "description": "Retrieve specific cMediaGwDnsIpConfigEntry entry by key from MIB", "tags": [ "CISCO-MEDIA-GATEWAY-MIB" ], "parameters": [ { "name": "cmgwIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cmgwDnsIpIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref" }, "cmgwDnsIpIndex": { "type": "integer", "description": "An index that uniquely identifies an IP address of DNS\n name server.", "minimum": -2147483648, "maximum": 2147483647 }, "cmgwDnsDomainName": { "type": "string", "description": "The domain name of DNS name server.\n \n The value of this object reflects the value of \n cmgwConfigDomainName from the entry with a value of \n 'dnsServer(2)' for object cmgwConfigDomainNameEntity of \n cMediaGwDomainNameConfigTable.\n \n If there is no entry in cMediaGwDomainNameConfigTable with\n 'dnsServer(2)' of cmgwConfigDomainNameEntity, then\n the value of this object will be empty string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cmgwDnsIpType": { "type": "string", "description": "DNS name server IP address type.", "x-yang-type": "inet-address:InetAddressType" }, "cmgwDnsIp": { "type": "string", "description": "The IP address of DNS name server.\n The IP address of DNS name server must be unique\n in this table.", "x-yang-type": "inet-address:InetAddress" }, "cmgwDnsIpRowStatus": { "type": "string", "description": "This object is used to add and delete an entry.\n \n When an entry of the table is created, the value of\n this object should be set to 'createAndGo' and the\n following objects are mandatory:\n cmgwDnsIp\n \n When the user wants to delete the entry, the value of\n this object should be set to 'destroy'.\n \n The entry can not be modified if the value of this \n object is 'active'.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "CISCO-MEDIA-GATEWAY-MIB:cMediaGwDnsIpConfigEntry": { "cmgwIndex": "example-string", "cmgwDnsIpIndex": 1, "cmgwDnsDomainName": "interface-1", "cmgwDnsIpType": "192.168.1.1", "cmgwDnsIp": "192.168.1.1", "cmgwDnsIpRowStatus": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cMediaGwDnsIpConfigEntry-4" }, "x-yang-path": "/cMediaGwDnsIpConfigEntry={cmgwIndex cmgwDnsIpIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cmgwIndex cmgwDnsIpIndex" ] }, "/data/CISCO-MEDIA-GATEWAY-MIB:cmgwLifEntry={cmgwIndex},{cmgwLifNumber}": { "get": { "summary": "Get cmgwLifEntry entry", "description": "Retrieve specific cmgwLifEntry entry by key from MIB", "tags": [ "CISCO-MEDIA-GATEWAY-MIB" ], "parameters": [ { "name": "cmgwIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cmgwLifNumber", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref" }, "cmgwLifNumber": { "type": "string", "description": "An index that uniquely identifies a LIF in the \n media gateway.", "x-yang-type": "CISCO-MEDIA-GATEWAY-MIB:GatewayLifNumber" }, "cmgwLifPvcCount": { "type": "integer", "description": "This object represents the total number of PVC within \n this LIF.\n \n When users associate/disassociate a PVC with a LIF \n by giving a non-zero/zero value of cwacChanLifNum\n in cwAtmChanExtConfigTable, the value of this object \n will be incremented/decremented accordingly.\n \n The value zero means there is no PVC associated with \n the LIF.", "minimum": 0, "maximum": 4294967295 }, "cmgwLifVoiceIfCount": { "type": "integer", "description": "This object represents the total number of Voice Interfaces\n within this LIF.\n \n When users associate/disassociate a Voice Interface with\n a LIF by giving a non-zero/zero value of \n ccasVoiceCfgLifNumber for the DS0 group in \n ccasVoiceExtCfgTable, the value of this object will be \n incremented/decremented accordingly. \n \n The value zero means there is no Voice Interface associated\n with the LIF.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-MEDIA-GATEWAY-MIB:cmgwLifEntry": { "cmgwIndex": "example-string", "cmgwLifNumber": "example-string", "cmgwLifPvcCount": 0, "cmgwLifVoiceIfCount": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cmgwLifEntry-4" }, "x-yang-path": "/cmgwLifEntry={cmgwIndex cmgwLifNumber}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cmgwIndex cmgwLifNumber" ] }, "/data/CISCO-MEDIA-GATEWAY-MIB:cMediaGwRscStatsEntry={cmgwIndex},{cmgwRscStatsIndex}": { "get": { "summary": "Get cMediaGwRscStatsEntry entry", "description": "Retrieve specific cMediaGwRscStatsEntry entry by key from MIB", "tags": [ "CISCO-MEDIA-GATEWAY-MIB" ], "parameters": [ { "name": "cmgwIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cmgwRscStatsIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref" }, "cmgwRscStatsIndex": { "type": "string", "description": "An index that uniquely identifies a specific gateway\n resource." }, "cmgwRscMaximumUtilization": { "type": "integer", "description": "This object indicates the maximum utilization of the\n resource over the interval specified by the\n 'cmgwRscSinceLastReset'.", "minimum": 0, "maximum": 4294967295 }, "cmgwRscMinimumUtilization": { "type": "integer", "description": "This object indicates the minimum utilization of the\n resource over the interval specified by the\n 'cmgwRscSinceLastReset'.", "minimum": 0, "maximum": 4294967295 }, "cmgwRscAverageUtilization": { "type": "integer", "description": "This object indicates the average utilization of the\n resource over the interval specified by the\n 'cmgwRscSinceLastReset'.", "minimum": 0, "maximum": 4294967295 }, "cmgwRscSinceLastReset": { "type": "integer", "description": "The elapsed time (in seconds) from the last periodic reset.\n \n The following objects are reset at the last reset:\n \n 'cmgwRscMaximumUtilization'\n 'cmgwRscMinimumUtilization'\n 'cmgwRscAverageUtilization'", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-MEDIA-GATEWAY-MIB:cMediaGwRscStatsEntry": { "cmgwIndex": "example-string", "cmgwRscStatsIndex": "example-string", "cmgwRscMaximumUtilization": 0, "cmgwRscMinimumUtilization": 0, "cmgwRscAverageUtilization": 0, "cmgwRscSinceLastReset": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cMediaGwRscStatsEntry-4" }, "x-yang-path": "/cMediaGwRscStatsEntry={cmgwIndex cmgwRscStatsIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cmgwIndex cmgwRscStatsIndex" ] } }, "components": { "schemas": { "CISCO-MEDIA-GATEWAY-MIB_CISCO-MEDIA-GATEWAY-MIB": { "type": "object", "description": "This table contains the global media gateway parameters\n information.\n It supports the modification of the global media gateway \n parameters.", "properties": { "cMediaGwEntry": { "type": "array", "description": "A Media Gateway Entry. \n At system power-up, an entry is created by the agent \n if the system detects a media gateway module has been added \n to the system, and an entry is deleted if the entry associated\n media gateway module has been removed from the system.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "integer", "description": "An index that uniquely identifies an entry in the \n cMediaGwTable.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cmgwDomainName": { "type": "string", "description": "This object is used to represent a domain name under which \n the Media Gateway could also be registered in a DNS name\n server. \n \n The value of this object reflects the value of \n cmgwConfigDomainName from the entry with a value of \n 'gateway(1)' for object cmgwConfigDomainNameEntity of \n cMediaGwDomainNameConfigTable.\n \n If there is no entry in cMediaGwDomainNameConfigTable with\n 'gateway(1)' of cmgwConfigDomainNameEntity, then\n the value of this object will be empty string.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cmgwPhysicalIndex": { "type": "string", "description": "This object represents the entPhysicalIndex of the\n card in which media gateway is running. It will contain\n value 0 if the entPhysicalIndex value is not available or \n not applicable", "x-yang-type": "cisco-tc:EntPhysicalIndexOrZero", "readOnly": true }, "cmgwServiceState": { "type": "string", "description": "This object indicates the current service state of the Media \n Gateway.\n This object is controlled by 'cmgwAdminState' \n object.", "x-yang-type": "CISCO-MEDIA-GATEWAY-MIB:CGwServiceState", "readOnly": true }, "cmgwAdminState": { "type": "string", "description": "This object is used to change the service state of \n the Media Gateway from inService to outOfService or from \n outOfService to inService. \n The resulting service state of the gateway is represented \n by 'cmgwServiceState'.", "x-yang-type": "CISCO-MEDIA-GATEWAY-MIB:CGwAdminState", "readOnly": true }, "cmgwGraceTime": { "type": "integer", "description": "This object is used to represent grace period.\n The grace period (restart delay in RSIP message) is \n expressed in a number of seconds. \n It means how soon the gateway will be taken out of service.\n The value -1 indicates that the grace period time is\n disabled.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cmgwVtMappingMode": { "type": "string", "description": "This object is used to represent the VT (sonet Virtual\n Tributary) counting.\n \n standard - standard counting (based on Bellcore TR253)\n titan - TITAN5500 counting (based on Tellabs TITAN 5500)\n \n Note: 'titan' is valid only if sonet line medium type \n (sonetMediumType of SONET-MIB) is 'sonet' and \n sonet path payload type (cspSonetPathPayload of\n CISCO-SONET-MIB) is 'vt15vc11'.", "readOnly": true }, "cmgwSrcFilterEnabled": { "type": "boolean", "description": "This object is used to enable or disable the source IP\n and port filtering with MGC for security consideration\n as follows:\n 'true' - source IP and port filter is enabled \n 'false' - source IP and port filter is disable", "readOnly": true }, "cmgwLawInterceptEnabled": { "type": "boolean", "description": "This object is used to enable or disable the lawful\n intercept for government.\n as follows:\n 'true' - enable lawful intercept\n 'false' - disable lawful intercept", "readOnly": true }, "cmgwV23Enabled": { "type": "boolean", "description": "This object is to enable or disable V23 tone.\n Setting the object value to 'true', will cause VXSM (Voice Switching\n Service Module) to detect V23 tone.", "readOnly": true } } }, "readOnly": true }, "cmgwSignalProtocolEntry": { "type": "array", "description": "Each entry represents an signaling protocol supported\n by the media gateway.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref", "readOnly": true }, "cmgwSignalProtocolIndex": { "type": "integer", "description": "An index that uniquely identifies an entry in\n cmgwSignalProtocolTable.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cmgwSignalProtocol": { "type": "string", "description": "This object is used to represent the protocol type.\n other - None of the following types.\n mgcp - Media Gateway Control Protocol\n h248 - Media Gateway Control (ITU H.248)\n tgcp - Trunking Gateway Control Protocol", "readOnly": true }, "cmgwSignalProtocolVersion": { "type": "string", "description": "This object is used to represent the protocol version. \n For example cmgwSignalProtocol is 'mgcp(2)' and\n this object is string '1.0'. cmgwSignalProtocol is \n 'h248(3)' and this object is set to '2.0'.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cmgwSignalProtocolPort": { "type": "string", "description": "This object is used to represent the UDP port associated \n with the protocol.\n If the value of cmgwSignalProtocol is 'mgcp(2)' and the\n value of cmgwSignalProtcolVersion is '1.0', the default\n value of this object is '2727'. \n If the value of cmgwSignalProtocol is 'h248(3)' and the\n value of cmgwSignalProtcolVersion is '1.0', the default\n value of this object is '2944'.", "x-yang-type": "cisco-tc:CiscoPort", "readOnly": true }, "cmgwSignalMgcProtocolPort": { "type": "string", "description": "This object specifies the protocol port of the Media Gateway\n Controller (MGC).\n If the value of cmgwSignalProtocol is 'mgcp(2)' or 'tgcp(4)'\n and the value of cmgwSignalProtcolVersion is '1.0', the\n default value of this object is '2427'.\n If the value of cmgwSignalProtocol is 'h248(3)' and the\n value of cmgwSignalProtcolVersion is '1.0', the default\n value of this object is '2944'.", "format": "inet:port-number", "readOnly": true }, "cmgwSignalProtocolPreference": { "type": "integer", "description": "This object specifies the preference of the signal protocol \n supported in the media gateway.\n \n If this object is set to 0, the corresponding signal\n protocol will not be used by the gateway.\n \n The value of this object is unique within the corresponding\n gateway. The entry with lower value has higher preference.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cmgwSignalProtocolConfigVer": { "type": "string", "description": "This object specifies the protocol version\n used by the gateway in the messages to MGC\n in order to exchange the service capabilities.\n \n For example cmgwSignalProtocol is 'h248(3)' and\n this object can be string '1' or '1.0', '2' or '2.0'. \n \n 'MAX' is a special string indicating the gateway will\n use the highest protocol version supported in the \n gateway, but it can be changed to lower version after \n it negotiates with MGC. The final negotiated protocol\n version will be indicated in cmgwSignalProtocolVersion.\n \n The version strings other than 'MAX' can be specified for\n the gateway to communicate with the MGC which doesn't\n support service capabilities negotiation. For example if\n a MGC supports only version 1.0 MGCP, this object should\n be set to '1' to instruct the gateway using MGCP \n version 1.0 format messages to communicate with MGC.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true } } }, "readOnly": true }, "cMediaGwIpConfigEntry": { "type": "array", "description": "A Media Gateway IP configuration entry. \n Each entry represents a media gateway IP address for MGCs\n to communicate with the media gateway.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref", "readOnly": true }, "cmgwIpConfigIndex": { "type": "integer", "description": "A unique index to identify each media gateway IP address.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cmgwIpConfigIfIndex": { "type": "string", "description": "This object is ifIndex of the interface which is associated\n to the media gateway IP address.\n \n For ATM interface, the IP address should be associated to\n an existing PVC:\n cmgwIpConfigIfIndex represents port of the PVC\n cmgwIpConfigVpi represents VPI of the PVC\n cmgwIpConfigVci represents VCI of the PVC\n And one PVC only can be associated with one IP address.\n \n If this object is set to zero which means the IP address\n is not associated to any interface.", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true }, "cmgwIpConfigVpi": { "type": "integer", "description": "This object represents VPI of the PVC which is associated\n to the IP address.\n If the IP address is not associated to PVC, the value \n of this object is set to -1.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cmgwIpConfigVci": { "type": "integer", "description": "This object represents VCI of the PVC which is associated\n to the IP address.\n If the IP address is not associated to PVC, the value\n of this object is set to -1.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cmgwIpConfigAddrType": { "type": "string", "description": "This object is the IP address type.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cmgwIpConfigAddress": { "type": "string", "description": "The configured IP address of media gateway.\n This object can not be modified.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cmgwIpConfigSubnetMask": { "type": "string", "description": "This object is used to specify the number of leading one \n bits which from the mask to be logical-ANDed with the media \n gateway address before being compared to the value in the \n cmgwIpCofigAddress.\n \n Any assignment (implicit or otherwise) of an instance of\n this object to a value x must be rejected if the bitwise\n logical-AND of the mask formed from x with the value \n of the corresponding instance of the cmgwIpCofigAddress \n object is not equal to cmgwIpCofigAddress.", "x-yang-type": "inet-address:InetAddressPrefixLength", "readOnly": true }, "cmgwIpConfigDefaultGwIp": { "type": "boolean", "description": "This object specifies cmgwIpConfigAddress of the entry\n will become the default gateway address.\n This object can be set to 'true' for only one entry in\n the table.", "readOnly": true }, "cmgwIpConfigForRemoteMapping": { "type": "boolean", "description": "This object specifies whether the address defined in\n cmgwIpConfigAddress is the address mapping at the\n remote end of this PVC. \n \n If this object is set to 'true', the address defined\n in cmgwIpConfigAddress is for the remote end of the PVC.\n If this object is set to 'false', the address defined\n in cmgwIpConfigAddress is for the local end of the PVC.", "readOnly": true }, "cmgwIpConfigRowStatus": { "type": "string", "description": "This object is used to add and delete an entry.\n \n When an entry of the table is created, the following \n objects are mandatory:\n cmgwIpConfigIfIndex\n cmgwIpConfigVpi\n cmgwIpConfigVci\n cmgwIpConfigAddress\n cmgwIpConfigSubnetMask\n \n These objects can not be modified after the value of this\n object is set to 'active'. \n Modification can only be done by deleting and re-adding the \n entry again.\n \n After the system verify the validity of the data, it\n will set the cmgwIpConfigRowStatus to 'active'.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true }, "cMediaGwDomainNameConfigEntry": { "type": "array", "description": "Each entry represents a domain name used in the system.\n \n Creation and deletion are supported. Modification\n is prohibited.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref", "readOnly": true }, "cmgwConfigDomainNameIndex": { "type": "integer", "description": "An index that is uniquely identifies a domain name\n configured in the system.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cmgwConfigDomainNameEntity": { "type": "string", "description": "This object indicates which entity to use this domain name.\n \n gateway(1) - The domain name of media gateway.\n With the same cmgwIndex, there is one and \n only one entry allowed with the value \n 'gateway(1)' of this object.\n \n dnsServer(2) - The domain name of DNS name server that is used \n by Media gateway to find Internet Network \n Address from a DNS name.\n \n mgc(3) - The domain name of a MGC (Media Gateway\n Controller) associated with the media \n gateway.", "readOnly": true }, "cmgwConfigDomainName": { "type": "string", "description": "This object specifies the domain name.\n \n The domain name should be unique if there are more than\n one entries having the same value in the object \n cmgwConfigDomainNameEntity.\n For example, the gateway domain name should be unique \n if the cmgwConfigDomainNameEntity has the value of \n 'gateway(1)'.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cmgwConfigDomainNameRowStatus": { "type": "string", "description": "This object is used to add and delete an entry.\n \n When an entry is created, the following objects\n are mandatory:\n cmgwConfigDomainName\n cmgwConfigDomainNameEntity\n \n When deleting domain name of DNS name server\n (cmgwConfigDomainNameEntity is dnsServer (2)), the \n cMediaGwDnsIpConfigTable should be empty.\n \n Adding/deleting entry with cmgwConfigDomainNameEntity\n of 'mgc' will cause adding/deleting entry in \n cMgcConfigTable (CISCO-MGC-MIB) automatically.\n \n The cmgwConfigDomainName and cmgwConfigDomainNameEntity\n can not be modified if the value of this object is\n 'active'.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true }, "cMediaGwDnsIpConfigEntry": { "type": "array", "description": "Each entry represents an IP address of the DNS name \n server.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref", "readOnly": true }, "cmgwDnsIpIndex": { "type": "integer", "description": "An index that uniquely identifies an IP address of DNS\n name server.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cmgwDnsDomainName": { "type": "string", "description": "The domain name of DNS name server.\n \n The value of this object reflects the value of \n cmgwConfigDomainName from the entry with a value of \n 'dnsServer(2)' for object cmgwConfigDomainNameEntity of \n cMediaGwDomainNameConfigTable.\n \n If there is no entry in cMediaGwDomainNameConfigTable with\n 'dnsServer(2)' of cmgwConfigDomainNameEntity, then\n the value of this object will be empty string.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cmgwDnsIpType": { "type": "string", "description": "DNS name server IP address type.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cmgwDnsIp": { "type": "string", "description": "The IP address of DNS name server.\n The IP address of DNS name server must be unique\n in this table.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cmgwDnsIpRowStatus": { "type": "string", "description": "This object is used to add and delete an entry.\n \n When an entry of the table is created, the value of\n this object should be set to 'createAndGo' and the\n following objects are mandatory:\n cmgwDnsIp\n \n When the user wants to delete the entry, the value of\n this object should be set to 'destroy'.\n \n The entry can not be modified if the value of this \n object is 'active'.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true }, "cmgwLifEntry": { "type": "array", "description": "An entry of this table is created by the media gateway\n when it supports the VoIP/VoATM application.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref", "readOnly": true }, "cmgwLifNumber": { "type": "string", "description": "An index that uniquely identifies a LIF in the \n media gateway.", "x-yang-type": "CISCO-MEDIA-GATEWAY-MIB:GatewayLifNumber", "readOnly": true }, "cmgwLifPvcCount": { "type": "integer", "description": "This object represents the total number of PVC within \n this LIF.\n \n When users associate/disassociate a PVC with a LIF \n by giving a non-zero/zero value of cwacChanLifNum\n in cwAtmChanExtConfigTable, the value of this object \n will be incremented/decremented accordingly.\n \n The value zero means there is no PVC associated with \n the LIF.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cmgwLifVoiceIfCount": { "type": "integer", "description": "This object represents the total number of Voice Interfaces\n within this LIF.\n \n When users associate/disassociate a Voice Interface with\n a LIF by giving a non-zero/zero value of \n ccasVoiceCfgLifNumber for the DS0 group in \n ccasVoiceExtCfgTable, the value of this object will be \n incremented/decremented accordingly. \n \n The value zero means there is no Voice Interface associated\n with the LIF.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true }, "cMediaGwCallControlConfigEntry": { "type": "array", "description": "One entry for each media gateway which supports call control \n protocol.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref", "readOnly": true }, "cMediaGwCcCfgControlTos": { "type": "integer", "description": "This object specifies Type Of Service (TOS) field of\n IP header for the signaling control packet in VoIP\n application.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cMediaGwCcCfgBearerTos": { "type": "integer", "description": "This object specifies Type Of Service (TOS) field\n of IP header for the voice payload packet in VoIP\n application.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cMediaGwCcCfgNtePayload": { "type": "integer", "description": "This object specifies NTE (Named Telephony Events)\n payload type.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cMediaGwCcCfgNsePayload": { "type": "integer", "description": "This object specifies NSE (Network Signaling Events)\n payload type.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cMediaGwCcCfgNseRespTimer": { "type": "integer", "description": "This object specifies Network Signaling Event (NSE)\n timeout value.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cMediaGwCcCfgVbdJitterDelayMode": { "type": "string", "description": "The object specifies the jitter buffer mode applied to\n a VBD (Voice Band Data) call connection.\n \n adaptive - means to use cMediaGwCcCfgVbdJitterNomDelay as\n the initial jitter buffers size and let the DSP\n pick the optimal value of the jitter buffer\n size between the range of\n cMediaGwCcCfgVbcJitterMaxDelay and\n cMediaGwCcCfgVbcJitterMinDelay.\n \n fixed - means to use a constant jitter buffer size\n which is specified by cMediaGwCcCfgVbdJitterNomDelay.", "x-yang-type": "CISCO-MEDIA-GATEWAY-MIB:CCallControlJitterDelayMode", "readOnly": true }, "cMediaGwCcCfgVbdJitterMaxDelay": { "type": "integer", "description": "This object specifies the maximum jitter buffer size \n in VBD (Voice Band Data)", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cMediaGwCcCfgVbdJitterNomDelay": { "type": "integer", "description": "This object specifies the nominal jitter buffer size \n in VBD (Voice Band Data)", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cMediaGwCcCfgVbdJitterMinDelay": { "type": "integer", "description": "This object specifies the nominal jitter buffer size \n in VBD (Voice Band Data)", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cMediaGwCcCfgDefaultTonePlanId": { "type": "string", "description": "This object specifies the default tone plan index\n (the value of cvtcTonePlanId) for the media gateway.", "x-yang-type": "CISCO-MEDIA-GATEWAY-MIB:CVoiceTonePlanIndex", "readOnly": true }, "cMediaGwCcCfgDescrInfoEnabled": { "type": "boolean", "description": "This object specifies whether the media gateway supports\n descriptive suffix of the name schema for terminations.\n \n There are two parts in name schema of termination, prefix\n and suffix. For example the name schema for a DS (Digital\n Subscriber) termination, can be 'DS/OC3_2/DS1_6/DS0_24'.\n It represents DS type termination in 2nd OC3 line, \n 6th DS1 and 24th DS0 channel. In this example, 'DS' is \n the prefix, 'OC3_2/DS1_6/DS0_24' is the suffix.\n \n The name schema in above example has a descriptive suffix.\n The non-descriptive suffix for the same termination is \n '2/6/24' and name schema becomes 'DS/2/6/24'.\n \n This object can not be modified if there is any termination\n existing in the media gateway.", "readOnly": true }, "cMediaGwCcCfgDsNamePrefix": { "type": "string", "description": "This object specifies the prefix of the name schema for\n DS (Digital Subscriber) terminations.\n The value of this object must be unique among the \n following objects:\n cMediaGwCcCfgDsNamePrefix\n cMediaGwCcCfgRtpNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgDefRtpNamePrefix\n This object can not be modified when there is any\n DS termination existing in the media gateway.\n It is default to 'DS'.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cMediaGwCcCfgRtpNamePrefix": { "type": "string", "description": "This object specifies the prefix of the name schema for\n RTP (Real-Time Transport Protocol) terminations.\n The value of this object must be unique among the \n following objects:\n cMediaGwCcCfgDsNamePrefix\n cMediaGwCcCfgRtpNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgDefRtpNamePrefix\n This object can not be modified when there is any\n RTP termination type existing in the media gateway.\n It is default to 'RTP'.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cMediaGwCcCfgAal1SvcNamePrefix": { "type": "string", "description": "This object specifies the prefix of the name schema for\n voice over AAL1 SVC (Switched Virtual Circuit)\n terminations.\n The value of this object must be unique among the \n following objects:\n cMediaGwCcCfgDsNamePrefix\n cMediaGwCcCfgRtpNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgDefRtpNamePrefix\n This object can not be modified when there is any\n AAL1 SVC termination type existing in the media gateway.\n It is default to 'AAL1/SVC'.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cMediaGwCcCfgAal2SvcNamePrefix": { "type": "string", "description": "This object specifies the prefix of the name schema for\n voice over AAL2 SVC (Switched Virtual Circuit)\n terminations.\n The value of this object must be unique among the \n following objects:\n cMediaGwCcCfgDsNamePrefix\n cMediaGwCcCfgRtpNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgDefRtpNamePrefix\n This object can not be modified when there is any\n AAL2 SVC termination type existing in the media gateway.\n It is default to 'AAL2/SVC'.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cMediaGwCcCfgClusterEnabled": { "type": "string", "description": "This object specifies the condition of the cluster generation\n in the call control.\n \n A cluster is a group of endpoints that share a particular\n bearer possibility for connections among each other.\n \n disabled(1) - The generation of the cluster attribute\n is disabled.\n enabled(2) - Unconditionally generate the cluster\n attribute.\n conditionalEnabled(3) - The generation of the cluster \n attribute is upon MGC request.", "readOnly": true }, "cMediaGwCcCfgDefBearerTraffic": { "type": "string", "description": "This object specifies the combination of the network\n type (IP/ATM), virtual circuit type (PVC/SVC) and\n ATM adaptation layer type (AAL1/AAL2/AAL5) for the\n connection used in transporting bearer traffic.\n \n ipPvcAal5 (1) - The bearer traffic is transported in\n IP network, through Permanent Virtual\n Circuit(PVC) over AAL5 adaptation layer.\n atmPvcAal2 (2) - The bearer traffic is transported in\n ATM network, through Permanent Virtual\n Circuit(PVC) over AAL2 adaptation layer.\n atmSvcAal2 (3) - The bearer traffic is transported in\n ATM network, through Switching Virtual\n Circuit(SVC) over AAL2 adaptation layer.\n atmSvcAal1 (4) - The bearer traffic is transported in\n ATM network, through Switching Virtual\n Circuit(SVC) over AAL1 adaptation layer.\n \n In MGCP, if the call agent specifies the bear traffic type \n in the local connection options (CRCX request), \n configuration of this object will have no effect, \n otherwise the value of this object will be used when \n media gateway sending CRCX response.", "readOnly": true }, "cMediaGwCcCfgDefRtpNamePrefix": { "type": "string", "description": "This object specifies the prefix of the name schema for\n default RTP terminations.\n The value of this object must be unique among the \n following objects:\n cMediaGwCcCfgDsNamePrefix\n cMediaGwCcCfgRtpNamePrefix\n cMediaGwCcCfgAal1SvcNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n \n It is defaulted to 'TGWRTP'.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true } } }, "readOnly": true }, "cMediaGwRscStatsEntry": { "type": "array", "description": "Each entry stores the statistics\n information for a specific resource.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref", "readOnly": true }, "cmgwRscStatsIndex": { "type": "string", "description": "An index that uniquely identifies a specific gateway\n resource.", "readOnly": true }, "cmgwRscMaximumUtilization": { "type": "integer", "description": "This object indicates the maximum utilization of the\n resource over the interval specified by the\n 'cmgwRscSinceLastReset'.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cmgwRscMinimumUtilization": { "type": "integer", "description": "This object indicates the minimum utilization of the\n resource over the interval specified by the\n 'cmgwRscSinceLastReset'.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cmgwRscAverageUtilization": { "type": "integer", "description": "This object indicates the average utilization of the\n resource over the interval specified by the\n 'cmgwRscSinceLastReset'.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cmgwRscSinceLastReset": { "type": "integer", "description": "The elapsed time (in seconds) from the last periodic reset.\n \n The following objects are reset at the last reset:\n \n 'cmgwRscMaximumUtilization'\n 'cmgwRscMinimumUtilization'\n 'cmgwRscAverageUtilization'", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true }, "cMediaGwTable": { "type": "object", "description": "This table contains the global media gateway parameters\n information.\n It supports the modification of the global media gateway \n parameters.", "properties": { "cMediaGwEntry": { "type": "array", "description": "A Media Gateway Entry. \n At system power-up, an entry is created by the agent \n if the system detects a media gateway module has been added \n to the system, and an entry is deleted if the entry associated\n media gateway module has been removed from the system.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "integer", "description": "An index that uniquely identifies an entry in the \n cMediaGwTable.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cmgwDomainName": { "type": "string", "description": "This object is used to represent a domain name under which \n the Media Gateway could also be registered in a DNS name\n server. \n \n The value of this object reflects the value of \n cmgwConfigDomainName from the entry with a value of \n 'gateway(1)' for object cmgwConfigDomainNameEntity of \n cMediaGwDomainNameConfigTable.\n \n If there is no entry in cMediaGwDomainNameConfigTable with\n 'gateway(1)' of cmgwConfigDomainNameEntity, then\n the value of this object will be empty string.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cmgwPhysicalIndex": { "type": "string", "description": "This object represents the entPhysicalIndex of the\n card in which media gateway is running. It will contain\n value 0 if the entPhysicalIndex value is not available or \n not applicable", "x-yang-type": "cisco-tc:EntPhysicalIndexOrZero", "readOnly": true }, "cmgwServiceState": { "type": "string", "description": "This object indicates the current service state of the Media \n Gateway.\n This object is controlled by 'cmgwAdminState' \n object.", "x-yang-type": "CISCO-MEDIA-GATEWAY-MIB:CGwServiceState", "readOnly": true }, "cmgwAdminState": { "type": "string", "description": "This object is used to change the service state of \n the Media Gateway from inService to outOfService or from \n outOfService to inService. \n The resulting service state of the gateway is represented \n by 'cmgwServiceState'.", "x-yang-type": "CISCO-MEDIA-GATEWAY-MIB:CGwAdminState", "readOnly": true }, "cmgwGraceTime": { "type": "integer", "description": "This object is used to represent grace period.\n The grace period (restart delay in RSIP message) is \n expressed in a number of seconds. \n It means how soon the gateway will be taken out of service.\n The value -1 indicates that the grace period time is\n disabled.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cmgwVtMappingMode": { "type": "string", "description": "This object is used to represent the VT (sonet Virtual\n Tributary) counting.\n \n standard - standard counting (based on Bellcore TR253)\n titan - TITAN5500 counting (based on Tellabs TITAN 5500)\n \n Note: 'titan' is valid only if sonet line medium type \n (sonetMediumType of SONET-MIB) is 'sonet' and \n sonet path payload type (cspSonetPathPayload of\n CISCO-SONET-MIB) is 'vt15vc11'.", "readOnly": true }, "cmgwSrcFilterEnabled": { "type": "boolean", "description": "This object is used to enable or disable the source IP\n and port filtering with MGC for security consideration\n as follows:\n 'true' - source IP and port filter is enabled \n 'false' - source IP and port filter is disable", "readOnly": true }, "cmgwLawInterceptEnabled": { "type": "boolean", "description": "This object is used to enable or disable the lawful\n intercept for government.\n as follows:\n 'true' - enable lawful intercept\n 'false' - disable lawful intercept", "readOnly": true }, "cmgwV23Enabled": { "type": "boolean", "description": "This object is to enable or disable V23 tone.\n Setting the object value to 'true', will cause VXSM (Voice Switching\n Service Module) to detect V23 tone.", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cmgwSignalProtocolTable": { "type": "object", "description": "This table contains the available signaling protocols that\n are supported by the media gateway for communication with\n MGCs.", "properties": { "cmgwSignalProtocolEntry": { "type": "array", "description": "Each entry represents an signaling protocol supported\n by the media gateway.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref", "readOnly": true }, "cmgwSignalProtocolIndex": { "type": "integer", "description": "An index that uniquely identifies an entry in\n cmgwSignalProtocolTable.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cmgwSignalProtocol": { "type": "string", "description": "This object is used to represent the protocol type.\n other - None of the following types.\n mgcp - Media Gateway Control Protocol\n h248 - Media Gateway Control (ITU H.248)\n tgcp - Trunking Gateway Control Protocol", "readOnly": true }, "cmgwSignalProtocolVersion": { "type": "string", "description": "This object is used to represent the protocol version. \n For example cmgwSignalProtocol is 'mgcp(2)' and\n this object is string '1.0'. cmgwSignalProtocol is \n 'h248(3)' and this object is set to '2.0'.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cmgwSignalProtocolPort": { "type": "string", "description": "This object is used to represent the UDP port associated \n with the protocol.\n If the value of cmgwSignalProtocol is 'mgcp(2)' and the\n value of cmgwSignalProtcolVersion is '1.0', the default\n value of this object is '2727'. \n If the value of cmgwSignalProtocol is 'h248(3)' and the\n value of cmgwSignalProtcolVersion is '1.0', the default\n value of this object is '2944'.", "x-yang-type": "cisco-tc:CiscoPort", "readOnly": true }, "cmgwSignalMgcProtocolPort": { "type": "string", "description": "This object specifies the protocol port of the Media Gateway\n Controller (MGC).\n If the value of cmgwSignalProtocol is 'mgcp(2)' or 'tgcp(4)'\n and the value of cmgwSignalProtcolVersion is '1.0', the\n default value of this object is '2427'.\n If the value of cmgwSignalProtocol is 'h248(3)' and the\n value of cmgwSignalProtcolVersion is '1.0', the default\n value of this object is '2944'.", "format": "inet:port-number", "readOnly": true }, "cmgwSignalProtocolPreference": { "type": "integer", "description": "This object specifies the preference of the signal protocol \n supported in the media gateway.\n \n If this object is set to 0, the corresponding signal\n protocol will not be used by the gateway.\n \n The value of this object is unique within the corresponding\n gateway. The entry with lower value has higher preference.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cmgwSignalProtocolConfigVer": { "type": "string", "description": "This object specifies the protocol version\n used by the gateway in the messages to MGC\n in order to exchange the service capabilities.\n \n For example cmgwSignalProtocol is 'h248(3)' and\n this object can be string '1' or '1.0', '2' or '2.0'. \n \n 'MAX' is a special string indicating the gateway will\n use the highest protocol version supported in the \n gateway, but it can be changed to lower version after \n it negotiates with MGC. The final negotiated protocol\n version will be indicated in cmgwSignalProtocolVersion.\n \n The version strings other than 'MAX' can be specified for\n the gateway to communicate with the MGC which doesn't\n support service capabilities negotiation. For example if\n a MGC supports only version 1.0 MGCP, this object should\n be set to '1' to instruct the gateway using MGCP \n version 1.0 format messages to communicate with MGC.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cMediaGwIpConfigTable": { "type": "object", "description": "cMediaGwIpConfigTable", "properties": { "cMediaGwIpConfigEntry": { "type": "array", "description": "A Media Gateway IP configuration entry. \n Each entry represents a media gateway IP address for MGCs\n to communicate with the media gateway.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref", "readOnly": true }, "cmgwIpConfigIndex": { "type": "integer", "description": "A unique index to identify each media gateway IP address.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cmgwIpConfigIfIndex": { "type": "string", "description": "This object is ifIndex of the interface which is associated\n to the media gateway IP address.\n \n For ATM interface, the IP address should be associated to\n an existing PVC:\n cmgwIpConfigIfIndex represents port of the PVC\n cmgwIpConfigVpi represents VPI of the PVC\n cmgwIpConfigVci represents VCI of the PVC\n And one PVC only can be associated with one IP address.\n \n If this object is set to zero which means the IP address\n is not associated to any interface.", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true }, "cmgwIpConfigVpi": { "type": "integer", "description": "This object represents VPI of the PVC which is associated\n to the IP address.\n If the IP address is not associated to PVC, the value \n of this object is set to -1.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cmgwIpConfigVci": { "type": "integer", "description": "This object represents VCI of the PVC which is associated\n to the IP address.\n If the IP address is not associated to PVC, the value\n of this object is set to -1.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cmgwIpConfigAddrType": { "type": "string", "description": "This object is the IP address type.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cmgwIpConfigAddress": { "type": "string", "description": "The configured IP address of media gateway.\n This object can not be modified.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cmgwIpConfigSubnetMask": { "type": "string", "description": "This object is used to specify the number of leading one \n bits which from the mask to be logical-ANDed with the media \n gateway address before being compared to the value in the \n cmgwIpCofigAddress.\n \n Any assignment (implicit or otherwise) of an instance of\n this object to a value x must be rejected if the bitwise\n logical-AND of the mask formed from x with the value \n of the corresponding instance of the cmgwIpCofigAddress \n object is not equal to cmgwIpCofigAddress.", "x-yang-type": "inet-address:InetAddressPrefixLength", "readOnly": true }, "cmgwIpConfigDefaultGwIp": { "type": "boolean", "description": "This object specifies cmgwIpConfigAddress of the entry\n will become the default gateway address.\n This object can be set to 'true' for only one entry in\n the table.", "readOnly": true }, "cmgwIpConfigForRemoteMapping": { "type": "boolean", "description": "This object specifies whether the address defined in\n cmgwIpConfigAddress is the address mapping at the\n remote end of this PVC. \n \n If this object is set to 'true', the address defined\n in cmgwIpConfigAddress is for the remote end of the PVC.\n If this object is set to 'false', the address defined\n in cmgwIpConfigAddress is for the local end of the PVC.", "readOnly": true }, "cmgwIpConfigRowStatus": { "type": "string", "description": "This object is used to add and delete an entry.\n \n When an entry of the table is created, the following \n objects are mandatory:\n cmgwIpConfigIfIndex\n cmgwIpConfigVpi\n cmgwIpConfigVci\n cmgwIpConfigAddress\n cmgwIpConfigSubnetMask\n \n These objects can not be modified after the value of this\n object is set to 'active'. \n Modification can only be done by deleting and re-adding the \n entry again.\n \n After the system verify the validity of the data, it\n will set the cmgwIpConfigRowStatus to 'active'.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cMediaGwDomainNameConfigTable": { "type": "object", "description": "This table provides the domain names which are configured by \n users. \n The domain names can be used to represent IP addresses \n for:\n gateway\n External DNS name server\n MGC (call agent)", "properties": { "cMediaGwDomainNameConfigEntry": { "type": "array", "description": "Each entry represents a domain name used in the system.\n \n Creation and deletion are supported. Modification\n is prohibited.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref", "readOnly": true }, "cmgwConfigDomainNameIndex": { "type": "integer", "description": "An index that is uniquely identifies a domain name\n configured in the system.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cmgwConfigDomainNameEntity": { "type": "string", "description": "This object indicates which entity to use this domain name.\n \n gateway(1) - The domain name of media gateway.\n With the same cmgwIndex, there is one and \n only one entry allowed with the value \n 'gateway(1)' of this object.\n \n dnsServer(2) - The domain name of DNS name server that is used \n by Media gateway to find Internet Network \n Address from a DNS name.\n \n mgc(3) - The domain name of a MGC (Media Gateway\n Controller) associated with the media \n gateway.", "readOnly": true }, "cmgwConfigDomainName": { "type": "string", "description": "This object specifies the domain name.\n \n The domain name should be unique if there are more than\n one entries having the same value in the object \n cmgwConfigDomainNameEntity.\n For example, the gateway domain name should be unique \n if the cmgwConfigDomainNameEntity has the value of \n 'gateway(1)'.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cmgwConfigDomainNameRowStatus": { "type": "string", "description": "This object is used to add and delete an entry.\n \n When an entry is created, the following objects\n are mandatory:\n cmgwConfigDomainName\n cmgwConfigDomainNameEntity\n \n When deleting domain name of DNS name server\n (cmgwConfigDomainNameEntity is dnsServer (2)), the \n cMediaGwDnsIpConfigTable should be empty.\n \n Adding/deleting entry with cmgwConfigDomainNameEntity\n of 'mgc' will cause adding/deleting entry in \n cMgcConfigTable (CISCO-MGC-MIB) automatically.\n \n The cmgwConfigDomainName and cmgwConfigDomainNameEntity\n can not be modified if the value of this object is\n 'active'.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cMediaGwDnsIpConfigTable": { "type": "object", "description": "There is only one DNS name server on a gateway\n and the domain name of the DNS name server is put on \n cMediaGwDomainNameConfigTable with 'dnsServer (2)'.\n \n There could be multi IP addresses are associated with the\n DNS name server, this table is used to store these IP \n addresses.\n \n If any domain name using external resolution, the last entry\n of this table is not allowed to be deleted.", "properties": { "cMediaGwDnsIpConfigEntry": { "type": "array", "description": "Each entry represents an IP address of the DNS name \n server.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref", "readOnly": true }, "cmgwDnsIpIndex": { "type": "integer", "description": "An index that uniquely identifies an IP address of DNS\n name server.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cmgwDnsDomainName": { "type": "string", "description": "The domain name of DNS name server.\n \n The value of this object reflects the value of \n cmgwConfigDomainName from the entry with a value of \n 'dnsServer(2)' for object cmgwConfigDomainNameEntity of \n cMediaGwDomainNameConfigTable.\n \n If there is no entry in cMediaGwDomainNameConfigTable with\n 'dnsServer(2)' of cmgwConfigDomainNameEntity, then\n the value of this object will be empty string.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cmgwDnsIpType": { "type": "string", "description": "DNS name server IP address type.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cmgwDnsIp": { "type": "string", "description": "The IP address of DNS name server.\n The IP address of DNS name server must be unique\n in this table.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cmgwDnsIpRowStatus": { "type": "string", "description": "This object is used to add and delete an entry.\n \n When an entry of the table is created, the value of\n this object should be set to 'createAndGo' and the\n following objects are mandatory:\n cmgwDnsIp\n \n When the user wants to delete the entry, the value of\n this object should be set to 'destroy'.\n \n The entry can not be modified if the value of this \n object is 'active'.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cmgwLifTable": { "type": "object", "description": "This table is for managing LIF (Logical Interface) \n in a media gateway. \n \n LIF is a logical interface which groups the TDM \n DSx1s associated with a set of packet resource partitions \n (PVCs) in a media gateway.\n \n LIF is used for:\n 1. VoIP switching \n 2. VoATM switching", "properties": { "cmgwLifEntry": { "type": "array", "description": "An entry of this table is created by the media gateway\n when it supports the VoIP/VoATM application.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref", "readOnly": true }, "cmgwLifNumber": { "type": "string", "description": "An index that uniquely identifies a LIF in the \n media gateway.", "x-yang-type": "CISCO-MEDIA-GATEWAY-MIB:GatewayLifNumber", "readOnly": true }, "cmgwLifPvcCount": { "type": "integer", "description": "This object represents the total number of PVC within \n this LIF.\n \n When users associate/disassociate a PVC with a LIF \n by giving a non-zero/zero value of cwacChanLifNum\n in cwAtmChanExtConfigTable, the value of this object \n will be incremented/decremented accordingly.\n \n The value zero means there is no PVC associated with \n the LIF.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cmgwLifVoiceIfCount": { "type": "integer", "description": "This object represents the total number of Voice Interfaces\n within this LIF.\n \n When users associate/disassociate a Voice Interface with\n a LIF by giving a non-zero/zero value of \n ccasVoiceCfgLifNumber for the DS0 group in \n ccasVoiceExtCfgTable, the value of this object will be \n incremented/decremented accordingly. \n \n The value zero means there is no Voice Interface associated\n with the LIF.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cMediaGwCallControlConfigTable": { "type": "object", "description": "This table defines general call control attributes for\n the media gateway.", "properties": { "cMediaGwCallControlConfigEntry": { "type": "array", "description": "One entry for each media gateway which supports call control \n protocol.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref", "readOnly": true }, "cMediaGwCcCfgControlTos": { "type": "integer", "description": "This object specifies Type Of Service (TOS) field of\n IP header for the signaling control packet in VoIP\n application.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cMediaGwCcCfgBearerTos": { "type": "integer", "description": "This object specifies Type Of Service (TOS) field\n of IP header for the voice payload packet in VoIP\n application.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cMediaGwCcCfgNtePayload": { "type": "integer", "description": "This object specifies NTE (Named Telephony Events)\n payload type.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cMediaGwCcCfgNsePayload": { "type": "integer", "description": "This object specifies NSE (Network Signaling Events)\n payload type.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cMediaGwCcCfgNseRespTimer": { "type": "integer", "description": "This object specifies Network Signaling Event (NSE)\n timeout value.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cMediaGwCcCfgVbdJitterDelayMode": { "type": "string", "description": "The object specifies the jitter buffer mode applied to\n a VBD (Voice Band Data) call connection.\n \n adaptive - means to use cMediaGwCcCfgVbdJitterNomDelay as\n the initial jitter buffers size and let the DSP\n pick the optimal value of the jitter buffer\n size between the range of\n cMediaGwCcCfgVbcJitterMaxDelay and\n cMediaGwCcCfgVbcJitterMinDelay.\n \n fixed - means to use a constant jitter buffer size\n which is specified by cMediaGwCcCfgVbdJitterNomDelay.", "x-yang-type": "CISCO-MEDIA-GATEWAY-MIB:CCallControlJitterDelayMode", "readOnly": true }, "cMediaGwCcCfgVbdJitterMaxDelay": { "type": "integer", "description": "This object specifies the maximum jitter buffer size \n in VBD (Voice Band Data)", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cMediaGwCcCfgVbdJitterNomDelay": { "type": "integer", "description": "This object specifies the nominal jitter buffer size \n in VBD (Voice Band Data)", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cMediaGwCcCfgVbdJitterMinDelay": { "type": "integer", "description": "This object specifies the nominal jitter buffer size \n in VBD (Voice Band Data)", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cMediaGwCcCfgDefaultTonePlanId": { "type": "string", "description": "This object specifies the default tone plan index\n (the value of cvtcTonePlanId) for the media gateway.", "x-yang-type": "CISCO-MEDIA-GATEWAY-MIB:CVoiceTonePlanIndex", "readOnly": true }, "cMediaGwCcCfgDescrInfoEnabled": { "type": "boolean", "description": "This object specifies whether the media gateway supports\n descriptive suffix of the name schema for terminations.\n \n There are two parts in name schema of termination, prefix\n and suffix. For example the name schema for a DS (Digital\n Subscriber) termination, can be 'DS/OC3_2/DS1_6/DS0_24'.\n It represents DS type termination in 2nd OC3 line, \n 6th DS1 and 24th DS0 channel. In this example, 'DS' is \n the prefix, 'OC3_2/DS1_6/DS0_24' is the suffix.\n \n The name schema in above example has a descriptive suffix.\n The non-descriptive suffix for the same termination is \n '2/6/24' and name schema becomes 'DS/2/6/24'.\n \n This object can not be modified if there is any termination\n existing in the media gateway.", "readOnly": true }, "cMediaGwCcCfgDsNamePrefix": { "type": "string", "description": "This object specifies the prefix of the name schema for\n DS (Digital Subscriber) terminations.\n The value of this object must be unique among the \n following objects:\n cMediaGwCcCfgDsNamePrefix\n cMediaGwCcCfgRtpNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgDefRtpNamePrefix\n This object can not be modified when there is any\n DS termination existing in the media gateway.\n It is default to 'DS'.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cMediaGwCcCfgRtpNamePrefix": { "type": "string", "description": "This object specifies the prefix of the name schema for\n RTP (Real-Time Transport Protocol) terminations.\n The value of this object must be unique among the \n following objects:\n cMediaGwCcCfgDsNamePrefix\n cMediaGwCcCfgRtpNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgDefRtpNamePrefix\n This object can not be modified when there is any\n RTP termination type existing in the media gateway.\n It is default to 'RTP'.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cMediaGwCcCfgAal1SvcNamePrefix": { "type": "string", "description": "This object specifies the prefix of the name schema for\n voice over AAL1 SVC (Switched Virtual Circuit)\n terminations.\n The value of this object must be unique among the \n following objects:\n cMediaGwCcCfgDsNamePrefix\n cMediaGwCcCfgRtpNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgDefRtpNamePrefix\n This object can not be modified when there is any\n AAL1 SVC termination type existing in the media gateway.\n It is default to 'AAL1/SVC'.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cMediaGwCcCfgAal2SvcNamePrefix": { "type": "string", "description": "This object specifies the prefix of the name schema for\n voice over AAL2 SVC (Switched Virtual Circuit)\n terminations.\n The value of this object must be unique among the \n following objects:\n cMediaGwCcCfgDsNamePrefix\n cMediaGwCcCfgRtpNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgDefRtpNamePrefix\n This object can not be modified when there is any\n AAL2 SVC termination type existing in the media gateway.\n It is default to 'AAL2/SVC'.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cMediaGwCcCfgClusterEnabled": { "type": "string", "description": "This object specifies the condition of the cluster generation\n in the call control.\n \n A cluster is a group of endpoints that share a particular\n bearer possibility for connections among each other.\n \n disabled(1) - The generation of the cluster attribute\n is disabled.\n enabled(2) - Unconditionally generate the cluster\n attribute.\n conditionalEnabled(3) - The generation of the cluster \n attribute is upon MGC request.", "readOnly": true }, "cMediaGwCcCfgDefBearerTraffic": { "type": "string", "description": "This object specifies the combination of the network\n type (IP/ATM), virtual circuit type (PVC/SVC) and\n ATM adaptation layer type (AAL1/AAL2/AAL5) for the\n connection used in transporting bearer traffic.\n \n ipPvcAal5 (1) - The bearer traffic is transported in\n IP network, through Permanent Virtual\n Circuit(PVC) over AAL5 adaptation layer.\n atmPvcAal2 (2) - The bearer traffic is transported in\n ATM network, through Permanent Virtual\n Circuit(PVC) over AAL2 adaptation layer.\n atmSvcAal2 (3) - The bearer traffic is transported in\n ATM network, through Switching Virtual\n Circuit(SVC) over AAL2 adaptation layer.\n atmSvcAal1 (4) - The bearer traffic is transported in\n ATM network, through Switching Virtual\n Circuit(SVC) over AAL1 adaptation layer.\n \n In MGCP, if the call agent specifies the bear traffic type \n in the local connection options (CRCX request), \n configuration of this object will have no effect, \n otherwise the value of this object will be used when \n media gateway sending CRCX response.", "readOnly": true }, "cMediaGwCcCfgDefRtpNamePrefix": { "type": "string", "description": "This object specifies the prefix of the name schema for\n default RTP terminations.\n The value of this object must be unique among the \n following objects:\n cMediaGwCcCfgDsNamePrefix\n cMediaGwCcCfgRtpNamePrefix\n cMediaGwCcCfgAal1SvcNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n \n It is defaulted to 'TGWRTP'.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cMediaGwRscStatsTable": { "type": "object", "description": "This table stores the gateway resource statistics\n information.", "properties": { "cMediaGwRscStatsEntry": { "type": "array", "description": "Each entry stores the statistics\n information for a specific resource.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref", "readOnly": true }, "cmgwRscStatsIndex": { "type": "string", "description": "An index that uniquely identifies a specific gateway\n resource.", "readOnly": true }, "cmgwRscMaximumUtilization": { "type": "integer", "description": "This object indicates the maximum utilization of the\n resource over the interval specified by the\n 'cmgwRscSinceLastReset'.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cmgwRscMinimumUtilization": { "type": "integer", "description": "This object indicates the minimum utilization of the\n resource over the interval specified by the\n 'cmgwRscSinceLastReset'.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cmgwRscAverageUtilization": { "type": "integer", "description": "This object indicates the average utilization of the\n resource over the interval specified by the\n 'cmgwRscSinceLastReset'.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cmgwRscSinceLastReset": { "type": "integer", "description": "The elapsed time (in seconds) from the last periodic reset.\n \n The following objects are reset at the last reset:\n \n 'cmgwRscMaximumUtilization'\n 'cmgwRscMinimumUtilization'\n 'cmgwRscAverageUtilization'", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true } }, "readOnly": true } } }, "CISCO-MEDIA-GATEWAY-MIB_cMediaGwEntry": { "type": "array", "description": "A Media Gateway Entry. \n At system power-up, an entry is created by the agent \n if the system detects a media gateway module has been added \n to the system, and an entry is deleted if the entry associated\n media gateway module has been removed from the system.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "integer", "description": "An index that uniquely identifies an entry in the \n cMediaGwTable.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cmgwDomainName": { "type": "string", "description": "This object is used to represent a domain name under which \n the Media Gateway could also be registered in a DNS name\n server. \n \n The value of this object reflects the value of \n cmgwConfigDomainName from the entry with a value of \n 'gateway(1)' for object cmgwConfigDomainNameEntity of \n cMediaGwDomainNameConfigTable.\n \n If there is no entry in cMediaGwDomainNameConfigTable with\n 'gateway(1)' of cmgwConfigDomainNameEntity, then\n the value of this object will be empty string.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cmgwPhysicalIndex": { "type": "string", "description": "This object represents the entPhysicalIndex of the\n card in which media gateway is running. It will contain\n value 0 if the entPhysicalIndex value is not available or \n not applicable", "x-yang-type": "cisco-tc:EntPhysicalIndexOrZero", "readOnly": true }, "cmgwServiceState": { "type": "string", "description": "This object indicates the current service state of the Media \n Gateway.\n This object is controlled by 'cmgwAdminState' \n object.", "x-yang-type": "CISCO-MEDIA-GATEWAY-MIB:CGwServiceState", "readOnly": true }, "cmgwAdminState": { "type": "string", "description": "This object is used to change the service state of \n the Media Gateway from inService to outOfService or from \n outOfService to inService. \n The resulting service state of the gateway is represented \n by 'cmgwServiceState'.", "x-yang-type": "CISCO-MEDIA-GATEWAY-MIB:CGwAdminState", "readOnly": true }, "cmgwGraceTime": { "type": "integer", "description": "This object is used to represent grace period.\n The grace period (restart delay in RSIP message) is \n expressed in a number of seconds. \n It means how soon the gateway will be taken out of service.\n The value -1 indicates that the grace period time is\n disabled.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cmgwVtMappingMode": { "type": "string", "description": "This object is used to represent the VT (sonet Virtual\n Tributary) counting.\n \n standard - standard counting (based on Bellcore TR253)\n titan - TITAN5500 counting (based on Tellabs TITAN 5500)\n \n Note: 'titan' is valid only if sonet line medium type \n (sonetMediumType of SONET-MIB) is 'sonet' and \n sonet path payload type (cspSonetPathPayload of\n CISCO-SONET-MIB) is 'vt15vc11'.", "readOnly": true }, "cmgwSrcFilterEnabled": { "type": "boolean", "description": "This object is used to enable or disable the source IP\n and port filtering with MGC for security consideration\n as follows:\n 'true' - source IP and port filter is enabled \n 'false' - source IP and port filter is disable", "readOnly": true }, "cmgwLawInterceptEnabled": { "type": "boolean", "description": "This object is used to enable or disable the lawful\n intercept for government.\n as follows:\n 'true' - enable lawful intercept\n 'false' - disable lawful intercept", "readOnly": true }, "cmgwV23Enabled": { "type": "boolean", "description": "This object is to enable or disable V23 tone.\n Setting the object value to 'true', will cause VXSM (Voice Switching\n Service Module) to detect V23 tone.", "readOnly": true } } } }, "CISCO-MEDIA-GATEWAY-MIB_cmgwSignalProtocolEntry": { "type": "array", "description": "Each entry represents an signaling protocol supported\n by the media gateway.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref", "readOnly": true }, "cmgwSignalProtocolIndex": { "type": "integer", "description": "An index that uniquely identifies an entry in\n cmgwSignalProtocolTable.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cmgwSignalProtocol": { "type": "string", "description": "This object is used to represent the protocol type.\n other - None of the following types.\n mgcp - Media Gateway Control Protocol\n h248 - Media Gateway Control (ITU H.248)\n tgcp - Trunking Gateway Control Protocol", "readOnly": true }, "cmgwSignalProtocolVersion": { "type": "string", "description": "This object is used to represent the protocol version. \n For example cmgwSignalProtocol is 'mgcp(2)' and\n this object is string '1.0'. cmgwSignalProtocol is \n 'h248(3)' and this object is set to '2.0'.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cmgwSignalProtocolPort": { "type": "string", "description": "This object is used to represent the UDP port associated \n with the protocol.\n If the value of cmgwSignalProtocol is 'mgcp(2)' and the\n value of cmgwSignalProtcolVersion is '1.0', the default\n value of this object is '2727'. \n If the value of cmgwSignalProtocol is 'h248(3)' and the\n value of cmgwSignalProtcolVersion is '1.0', the default\n value of this object is '2944'.", "x-yang-type": "cisco-tc:CiscoPort", "readOnly": true }, "cmgwSignalMgcProtocolPort": { "type": "string", "description": "This object specifies the protocol port of the Media Gateway\n Controller (MGC).\n If the value of cmgwSignalProtocol is 'mgcp(2)' or 'tgcp(4)'\n and the value of cmgwSignalProtcolVersion is '1.0', the\n default value of this object is '2427'.\n If the value of cmgwSignalProtocol is 'h248(3)' and the\n value of cmgwSignalProtcolVersion is '1.0', the default\n value of this object is '2944'.", "format": "inet:port-number", "readOnly": true }, "cmgwSignalProtocolPreference": { "type": "integer", "description": "This object specifies the preference of the signal protocol \n supported in the media gateway.\n \n If this object is set to 0, the corresponding signal\n protocol will not be used by the gateway.\n \n The value of this object is unique within the corresponding\n gateway. The entry with lower value has higher preference.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cmgwSignalProtocolConfigVer": { "type": "string", "description": "This object specifies the protocol version\n used by the gateway in the messages to MGC\n in order to exchange the service capabilities.\n \n For example cmgwSignalProtocol is 'h248(3)' and\n this object can be string '1' or '1.0', '2' or '2.0'. \n \n 'MAX' is a special string indicating the gateway will\n use the highest protocol version supported in the \n gateway, but it can be changed to lower version after \n it negotiates with MGC. The final negotiated protocol\n version will be indicated in cmgwSignalProtocolVersion.\n \n The version strings other than 'MAX' can be specified for\n the gateway to communicate with the MGC which doesn't\n support service capabilities negotiation. For example if\n a MGC supports only version 1.0 MGCP, this object should\n be set to '1' to instruct the gateway using MGCP \n version 1.0 format messages to communicate with MGC.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true } } } }, "CISCO-MEDIA-GATEWAY-MIB_cMediaGwIpConfigEntry": { "type": "array", "description": "A Media Gateway IP configuration entry. \n Each entry represents a media gateway IP address for MGCs\n to communicate with the media gateway.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref", "readOnly": true }, "cmgwIpConfigIndex": { "type": "integer", "description": "A unique index to identify each media gateway IP address.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cmgwIpConfigIfIndex": { "type": "string", "description": "This object is ifIndex of the interface which is associated\n to the media gateway IP address.\n \n For ATM interface, the IP address should be associated to\n an existing PVC:\n cmgwIpConfigIfIndex represents port of the PVC\n cmgwIpConfigVpi represents VPI of the PVC\n cmgwIpConfigVci represents VCI of the PVC\n And one PVC only can be associated with one IP address.\n \n If this object is set to zero which means the IP address\n is not associated to any interface.", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true }, "cmgwIpConfigVpi": { "type": "integer", "description": "This object represents VPI of the PVC which is associated\n to the IP address.\n If the IP address is not associated to PVC, the value \n of this object is set to -1.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cmgwIpConfigVci": { "type": "integer", "description": "This object represents VCI of the PVC which is associated\n to the IP address.\n If the IP address is not associated to PVC, the value\n of this object is set to -1.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cmgwIpConfigAddrType": { "type": "string", "description": "This object is the IP address type.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cmgwIpConfigAddress": { "type": "string", "description": "The configured IP address of media gateway.\n This object can not be modified.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cmgwIpConfigSubnetMask": { "type": "string", "description": "This object is used to specify the number of leading one \n bits which from the mask to be logical-ANDed with the media \n gateway address before being compared to the value in the \n cmgwIpCofigAddress.\n \n Any assignment (implicit or otherwise) of an instance of\n this object to a value x must be rejected if the bitwise\n logical-AND of the mask formed from x with the value \n of the corresponding instance of the cmgwIpCofigAddress \n object is not equal to cmgwIpCofigAddress.", "x-yang-type": "inet-address:InetAddressPrefixLength", "readOnly": true }, "cmgwIpConfigDefaultGwIp": { "type": "boolean", "description": "This object specifies cmgwIpConfigAddress of the entry\n will become the default gateway address.\n This object can be set to 'true' for only one entry in\n the table.", "readOnly": true }, "cmgwIpConfigForRemoteMapping": { "type": "boolean", "description": "This object specifies whether the address defined in\n cmgwIpConfigAddress is the address mapping at the\n remote end of this PVC. \n \n If this object is set to 'true', the address defined\n in cmgwIpConfigAddress is for the remote end of the PVC.\n If this object is set to 'false', the address defined\n in cmgwIpConfigAddress is for the local end of the PVC.", "readOnly": true }, "cmgwIpConfigRowStatus": { "type": "string", "description": "This object is used to add and delete an entry.\n \n When an entry of the table is created, the following \n objects are mandatory:\n cmgwIpConfigIfIndex\n cmgwIpConfigVpi\n cmgwIpConfigVci\n cmgwIpConfigAddress\n cmgwIpConfigSubnetMask\n \n These objects can not be modified after the value of this\n object is set to 'active'. \n Modification can only be done by deleting and re-adding the \n entry again.\n \n After the system verify the validity of the data, it\n will set the cmgwIpConfigRowStatus to 'active'.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } } }, "CISCO-MEDIA-GATEWAY-MIB_cMediaGwDomainNameConfigEntry": { "type": "array", "description": "Each entry represents a domain name used in the system.\n \n Creation and deletion are supported. Modification\n is prohibited.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref", "readOnly": true }, "cmgwConfigDomainNameIndex": { "type": "integer", "description": "An index that is uniquely identifies a domain name\n configured in the system.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cmgwConfigDomainNameEntity": { "type": "string", "description": "This object indicates which entity to use this domain name.\n \n gateway(1) - The domain name of media gateway.\n With the same cmgwIndex, there is one and \n only one entry allowed with the value \n 'gateway(1)' of this object.\n \n dnsServer(2) - The domain name of DNS name server that is used \n by Media gateway to find Internet Network \n Address from a DNS name.\n \n mgc(3) - The domain name of a MGC (Media Gateway\n Controller) associated with the media \n gateway.", "readOnly": true }, "cmgwConfigDomainName": { "type": "string", "description": "This object specifies the domain name.\n \n The domain name should be unique if there are more than\n one entries having the same value in the object \n cmgwConfigDomainNameEntity.\n For example, the gateway domain name should be unique \n if the cmgwConfigDomainNameEntity has the value of \n 'gateway(1)'.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cmgwConfigDomainNameRowStatus": { "type": "string", "description": "This object is used to add and delete an entry.\n \n When an entry is created, the following objects\n are mandatory:\n cmgwConfigDomainName\n cmgwConfigDomainNameEntity\n \n When deleting domain name of DNS name server\n (cmgwConfigDomainNameEntity is dnsServer (2)), the \n cMediaGwDnsIpConfigTable should be empty.\n \n Adding/deleting entry with cmgwConfigDomainNameEntity\n of 'mgc' will cause adding/deleting entry in \n cMgcConfigTable (CISCO-MGC-MIB) automatically.\n \n The cmgwConfigDomainName and cmgwConfigDomainNameEntity\n can not be modified if the value of this object is\n 'active'.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } } }, "CISCO-MEDIA-GATEWAY-MIB_cMediaGwDnsIpConfigEntry": { "type": "array", "description": "Each entry represents an IP address of the DNS name \n server.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref", "readOnly": true }, "cmgwDnsIpIndex": { "type": "integer", "description": "An index that uniquely identifies an IP address of DNS\n name server.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cmgwDnsDomainName": { "type": "string", "description": "The domain name of DNS name server.\n \n The value of this object reflects the value of \n cmgwConfigDomainName from the entry with a value of \n 'dnsServer(2)' for object cmgwConfigDomainNameEntity of \n cMediaGwDomainNameConfigTable.\n \n If there is no entry in cMediaGwDomainNameConfigTable with\n 'dnsServer(2)' of cmgwConfigDomainNameEntity, then\n the value of this object will be empty string.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cmgwDnsIpType": { "type": "string", "description": "DNS name server IP address type.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cmgwDnsIp": { "type": "string", "description": "The IP address of DNS name server.\n The IP address of DNS name server must be unique\n in this table.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cmgwDnsIpRowStatus": { "type": "string", "description": "This object is used to add and delete an entry.\n \n When an entry of the table is created, the value of\n this object should be set to 'createAndGo' and the\n following objects are mandatory:\n cmgwDnsIp\n \n When the user wants to delete the entry, the value of\n this object should be set to 'destroy'.\n \n The entry can not be modified if the value of this \n object is 'active'.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } } }, "CISCO-MEDIA-GATEWAY-MIB_cmgwLifEntry": { "type": "array", "description": "An entry of this table is created by the media gateway\n when it supports the VoIP/VoATM application.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref", "readOnly": true }, "cmgwLifNumber": { "type": "string", "description": "An index that uniquely identifies a LIF in the \n media gateway.", "x-yang-type": "CISCO-MEDIA-GATEWAY-MIB:GatewayLifNumber", "readOnly": true }, "cmgwLifPvcCount": { "type": "integer", "description": "This object represents the total number of PVC within \n this LIF.\n \n When users associate/disassociate a PVC with a LIF \n by giving a non-zero/zero value of cwacChanLifNum\n in cwAtmChanExtConfigTable, the value of this object \n will be incremented/decremented accordingly.\n \n The value zero means there is no PVC associated with \n the LIF.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cmgwLifVoiceIfCount": { "type": "integer", "description": "This object represents the total number of Voice Interfaces\n within this LIF.\n \n When users associate/disassociate a Voice Interface with\n a LIF by giving a non-zero/zero value of \n ccasVoiceCfgLifNumber for the DS0 group in \n ccasVoiceExtCfgTable, the value of this object will be \n incremented/decremented accordingly. \n \n The value zero means there is no Voice Interface associated\n with the LIF.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } } }, "CISCO-MEDIA-GATEWAY-MIB_cMediaGwCallControlConfigEntry": { "type": "array", "description": "One entry for each media gateway which supports call control \n protocol.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref", "readOnly": true }, "cMediaGwCcCfgControlTos": { "type": "integer", "description": "This object specifies Type Of Service (TOS) field of\n IP header for the signaling control packet in VoIP\n application.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cMediaGwCcCfgBearerTos": { "type": "integer", "description": "This object specifies Type Of Service (TOS) field\n of IP header for the voice payload packet in VoIP\n application.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cMediaGwCcCfgNtePayload": { "type": "integer", "description": "This object specifies NTE (Named Telephony Events)\n payload type.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cMediaGwCcCfgNsePayload": { "type": "integer", "description": "This object specifies NSE (Network Signaling Events)\n payload type.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cMediaGwCcCfgNseRespTimer": { "type": "integer", "description": "This object specifies Network Signaling Event (NSE)\n timeout value.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cMediaGwCcCfgVbdJitterDelayMode": { "type": "string", "description": "The object specifies the jitter buffer mode applied to\n a VBD (Voice Band Data) call connection.\n \n adaptive - means to use cMediaGwCcCfgVbdJitterNomDelay as\n the initial jitter buffers size and let the DSP\n pick the optimal value of the jitter buffer\n size between the range of\n cMediaGwCcCfgVbcJitterMaxDelay and\n cMediaGwCcCfgVbcJitterMinDelay.\n \n fixed - means to use a constant jitter buffer size\n which is specified by cMediaGwCcCfgVbdJitterNomDelay.", "x-yang-type": "CISCO-MEDIA-GATEWAY-MIB:CCallControlJitterDelayMode", "readOnly": true }, "cMediaGwCcCfgVbdJitterMaxDelay": { "type": "integer", "description": "This object specifies the maximum jitter buffer size \n in VBD (Voice Band Data)", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cMediaGwCcCfgVbdJitterNomDelay": { "type": "integer", "description": "This object specifies the nominal jitter buffer size \n in VBD (Voice Band Data)", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cMediaGwCcCfgVbdJitterMinDelay": { "type": "integer", "description": "This object specifies the nominal jitter buffer size \n in VBD (Voice Band Data)", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cMediaGwCcCfgDefaultTonePlanId": { "type": "string", "description": "This object specifies the default tone plan index\n (the value of cvtcTonePlanId) for the media gateway.", "x-yang-type": "CISCO-MEDIA-GATEWAY-MIB:CVoiceTonePlanIndex", "readOnly": true }, "cMediaGwCcCfgDescrInfoEnabled": { "type": "boolean", "description": "This object specifies whether the media gateway supports\n descriptive suffix of the name schema for terminations.\n \n There are two parts in name schema of termination, prefix\n and suffix. For example the name schema for a DS (Digital\n Subscriber) termination, can be 'DS/OC3_2/DS1_6/DS0_24'.\n It represents DS type termination in 2nd OC3 line, \n 6th DS1 and 24th DS0 channel. In this example, 'DS' is \n the prefix, 'OC3_2/DS1_6/DS0_24' is the suffix.\n \n The name schema in above example has a descriptive suffix.\n The non-descriptive suffix for the same termination is \n '2/6/24' and name schema becomes 'DS/2/6/24'.\n \n This object can not be modified if there is any termination\n existing in the media gateway.", "readOnly": true }, "cMediaGwCcCfgDsNamePrefix": { "type": "string", "description": "This object specifies the prefix of the name schema for\n DS (Digital Subscriber) terminations.\n The value of this object must be unique among the \n following objects:\n cMediaGwCcCfgDsNamePrefix\n cMediaGwCcCfgRtpNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgDefRtpNamePrefix\n This object can not be modified when there is any\n DS termination existing in the media gateway.\n It is default to 'DS'.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cMediaGwCcCfgRtpNamePrefix": { "type": "string", "description": "This object specifies the prefix of the name schema for\n RTP (Real-Time Transport Protocol) terminations.\n The value of this object must be unique among the \n following objects:\n cMediaGwCcCfgDsNamePrefix\n cMediaGwCcCfgRtpNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgDefRtpNamePrefix\n This object can not be modified when there is any\n RTP termination type existing in the media gateway.\n It is default to 'RTP'.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cMediaGwCcCfgAal1SvcNamePrefix": { "type": "string", "description": "This object specifies the prefix of the name schema for\n voice over AAL1 SVC (Switched Virtual Circuit)\n terminations.\n The value of this object must be unique among the \n following objects:\n cMediaGwCcCfgDsNamePrefix\n cMediaGwCcCfgRtpNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgDefRtpNamePrefix\n This object can not be modified when there is any\n AAL1 SVC termination type existing in the media gateway.\n It is default to 'AAL1/SVC'.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cMediaGwCcCfgAal2SvcNamePrefix": { "type": "string", "description": "This object specifies the prefix of the name schema for\n voice over AAL2 SVC (Switched Virtual Circuit)\n terminations.\n The value of this object must be unique among the \n following objects:\n cMediaGwCcCfgDsNamePrefix\n cMediaGwCcCfgRtpNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n cMediaGwCcCfgDefRtpNamePrefix\n This object can not be modified when there is any\n AAL2 SVC termination type existing in the media gateway.\n It is default to 'AAL2/SVC'.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cMediaGwCcCfgClusterEnabled": { "type": "string", "description": "This object specifies the condition of the cluster generation\n in the call control.\n \n A cluster is a group of endpoints that share a particular\n bearer possibility for connections among each other.\n \n disabled(1) - The generation of the cluster attribute\n is disabled.\n enabled(2) - Unconditionally generate the cluster\n attribute.\n conditionalEnabled(3) - The generation of the cluster \n attribute is upon MGC request.", "readOnly": true }, "cMediaGwCcCfgDefBearerTraffic": { "type": "string", "description": "This object specifies the combination of the network\n type (IP/ATM), virtual circuit type (PVC/SVC) and\n ATM adaptation layer type (AAL1/AAL2/AAL5) for the\n connection used in transporting bearer traffic.\n \n ipPvcAal5 (1) - The bearer traffic is transported in\n IP network, through Permanent Virtual\n Circuit(PVC) over AAL5 adaptation layer.\n atmPvcAal2 (2) - The bearer traffic is transported in\n ATM network, through Permanent Virtual\n Circuit(PVC) over AAL2 adaptation layer.\n atmSvcAal2 (3) - The bearer traffic is transported in\n ATM network, through Switching Virtual\n Circuit(SVC) over AAL2 adaptation layer.\n atmSvcAal1 (4) - The bearer traffic is transported in\n ATM network, through Switching Virtual\n Circuit(SVC) over AAL1 adaptation layer.\n \n In MGCP, if the call agent specifies the bear traffic type \n in the local connection options (CRCX request), \n configuration of this object will have no effect, \n otherwise the value of this object will be used when \n media gateway sending CRCX response.", "readOnly": true }, "cMediaGwCcCfgDefRtpNamePrefix": { "type": "string", "description": "This object specifies the prefix of the name schema for\n default RTP terminations.\n The value of this object must be unique among the \n following objects:\n cMediaGwCcCfgDsNamePrefix\n cMediaGwCcCfgRtpNamePrefix\n cMediaGwCcCfgAal1SvcNamePrefix\n cMediaGwCcCfgAal2SvcNamePrefix\n \n It is defaulted to 'TGWRTP'.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true } } } }, "CISCO-MEDIA-GATEWAY-MIB_cMediaGwRscStatsEntry": { "type": "array", "description": "Each entry stores the statistics\n information for a specific resource.", "items": { "type": "object", "properties": { "cmgwIndex": { "type": "string", "description": "cmgwIndex", "x-yang-type": "leafref", "readOnly": true }, "cmgwRscStatsIndex": { "type": "string", "description": "An index that uniquely identifies a specific gateway\n resource.", "readOnly": true }, "cmgwRscMaximumUtilization": { "type": "integer", "description": "This object indicates the maximum utilization of the\n resource over the interval specified by the\n 'cmgwRscSinceLastReset'.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cmgwRscMinimumUtilization": { "type": "integer", "description": "This object indicates the minimum utilization of the\n resource over the interval specified by the\n 'cmgwRscSinceLastReset'.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cmgwRscAverageUtilization": { "type": "integer", "description": "This object indicates the average utilization of the\n resource over the interval specified by the\n 'cmgwRscSinceLastReset'.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cmgwRscSinceLastReset": { "type": "integer", "description": "The elapsed time (in seconds) from the last periodic reset.\n \n The following objects are reset at the last reset:\n \n 'cmgwRscMaximumUtilization'\n 'cmgwRscMinimumUtilization'\n 'cmgwRscAverageUtilization'", "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-MEDIA-GATEWAY-MIB", "description": "MIB operations for CISCO-MEDIA-GATEWAY-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }