{ "openapi": "3.0.0", "info": { "title": "CISCO-VOICE-DNIS-MIB MIB API", "version": "1.0.0", "description": "The MIB module provides management support for Dialer\n Number Information Service (DNIS) mapping. A DNIS\n entry is associated with a Voice XML (VXML) page to\n provide audio play back features. Multiple DNIS\n entries can be grouped together to form a DNIS\n mapping with a unique map name.\n \n *** ABBREVIATIONS, ACRONYMS, AND SYMBOLS ***\n \n DNIS - Dialer Number Information Service\n \n XML - Extensible Markup Language\n \n VXML - Voice XML\n \n URL - Uniform Resource Locator\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-VOICE-DNIS-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/CISCO-VOICE-DNIS-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "CISCO-VOICE-DNIS-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-VOICE-DNIS-MIB:cvDnisMappingTable": { "get": { "summary": "Get cvDnisMappingTable data", "description": "Retrieve cvDnisMappingTable operational data from MIB", "tags": [ "CISCO-VOICE-DNIS-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The table contains the map name and a url specifying\n a file name. The file contains DNIS entries that belong\n to the DNIS mapping.", "properties": { "cvDnisMappingEntry": { "type": "array", "description": "cvDnisMappingEntry", "items": { "type": "object", "properties": { "cvDnisMappingName": { "type": "string", "description": "The name which uniquely identifies a DNIS mapping.", "x-yang-type": "CISCO-VOICE-DNIS-MIB:DnisMapname" }, "cvDnisMappingUrl": { "type": "string", "description": "The url specifies a file location. The file contains\n individual DNIS entries that belong to the DNIS map \n name specified by cvDnisMappingName.\n \n Once a url is created and associated with a map name (the\n association is complete when the row is made active(1)),\n it cannot be modified while cvDnisMappingStatus is\n active. If a different url needs to be associated with\n the current map name, the row status should be made\n notInService(2) and this object has to be modified to\n associate a new url. When a new association is made all\n the DNIS entries corresponding to the old association\n will be deleted from the cvDnisNodeTable.\n \n The url is read when the row status is made active(1) or\n when the row status is active and the object \n cvDnisMappingRefresh is explicitly set to refresh(2). \n If the url is not accessible then a\n cvDnisMappingUrlInaccessible notification will be\n generted.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvDnisMappingRefresh": { "type": "string", "description": "Whenever there is a need to re-read the contents of the\n file specified by cvDnisMappingUrl, this object can be\n set to refresh(2). This will cause the contents of the\n file to be re-read and correspondingly update the\n cvDnisNodeTable. After the completion of this operation,\n the value of this object is reset to idle(1). The only\n operation allowed on this object is setting it to\n refresh(2). This can only be done when the current value\n is idle(1) and the rowstatus is active(1).\n \n idle - The refreshing process is idle and the user\n can modify this object to refresh.\n refresh - The refreshing process is currently busy and\n the user have to wait till the object\n becomes idle to issue new refresh." }, "cvDnisMappingUrlAccessError": { "type": "string", "description": "ASCII text describing the error on last access of the url\n specified in cvDnisMappingUrl.\n \n If the url access does not succeed, then this object is\n populated with an error message indicating the reason for\n failure. If the url access succeeds, this object is set\n to null string.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvDnisMappingStatus": { "type": "string", "description": "This object is used to create a new row or modify or\n delete an existing row in this table. When making the\n status active(1), if a valid cvDnisMappingUrl is present\n the contents of the url is downloaded and during that\n time cvDnisMappingRefresh is set to refresh(2). When\n cvDnisMappingRefresh is set to refresh(2), only the\n destroy(6) operation is allowed.", "x-yang-type": "snmpv2-tc:RowStatus" } } } } } }, "example": { "CISCO-VOICE-DNIS-MIB:cvDnisMappingTable": { "cvDnisMappingEntry": [ { "cvDnisMappingName": "interface-1", "cvDnisMappingUrl": "example-string", "cvDnisMappingRefresh": "example-string", "cvDnisMappingUrlAccessError": "example-string", "cvDnisMappingStatus": "up(1)" }, { "cvDnisMappingName": "interface-1", "cvDnisMappingUrl": "example-string", "cvDnisMappingRefresh": "example-string", "cvDnisMappingUrlAccessError": "example-string", "cvDnisMappingStatus": "up(1)" }, { "cvDnisMappingName": "interface-1", "cvDnisMappingUrl": "example-string", "cvDnisMappingRefresh": "example-string", "cvDnisMappingUrlAccessError": "example-string", "cvDnisMappingStatus": "up(1)" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvDnisMappingTable", "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": "/cvDnisMappingTable", "x-restconf-kind": "container" }, "/data/CISCO-VOICE-DNIS-MIB:cvDnisMappingTable/cvDnisMappingEntry": { "get": { "summary": "Get cvDnisMappingEntry list", "description": "Retrieve list of cvDnisMappingEntry entries from MIB", "tags": [ "CISCO-VOICE-DNIS-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "cvDnisMappingEntry", "items": { "type": "object", "properties": { "cvDnisMappingName": { "type": "string", "description": "The name which uniquely identifies a DNIS mapping.", "x-yang-type": "CISCO-VOICE-DNIS-MIB:DnisMapname" }, "cvDnisMappingUrl": { "type": "string", "description": "The url specifies a file location. The file contains\n individual DNIS entries that belong to the DNIS map \n name specified by cvDnisMappingName.\n \n Once a url is created and associated with a map name (the\n association is complete when the row is made active(1)),\n it cannot be modified while cvDnisMappingStatus is\n active. If a different url needs to be associated with\n the current map name, the row status should be made\n notInService(2) and this object has to be modified to\n associate a new url. When a new association is made all\n the DNIS entries corresponding to the old association\n will be deleted from the cvDnisNodeTable.\n \n The url is read when the row status is made active(1) or\n when the row status is active and the object \n cvDnisMappingRefresh is explicitly set to refresh(2). \n If the url is not accessible then a\n cvDnisMappingUrlInaccessible notification will be\n generted.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvDnisMappingRefresh": { "type": "string", "description": "Whenever there is a need to re-read the contents of the\n file specified by cvDnisMappingUrl, this object can be\n set to refresh(2). This will cause the contents of the\n file to be re-read and correspondingly update the\n cvDnisNodeTable. After the completion of this operation,\n the value of this object is reset to idle(1). The only\n operation allowed on this object is setting it to\n refresh(2). This can only be done when the current value\n is idle(1) and the rowstatus is active(1).\n \n idle - The refreshing process is idle and the user\n can modify this object to refresh.\n refresh - The refreshing process is currently busy and\n the user have to wait till the object\n becomes idle to issue new refresh." }, "cvDnisMappingUrlAccessError": { "type": "string", "description": "ASCII text describing the error on last access of the url\n specified in cvDnisMappingUrl.\n \n If the url access does not succeed, then this object is\n populated with an error message indicating the reason for\n failure. If the url access succeeds, this object is set\n to null string.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvDnisMappingStatus": { "type": "string", "description": "This object is used to create a new row or modify or\n delete an existing row in this table. When making the\n status active(1), if a valid cvDnisMappingUrl is present\n the contents of the url is downloaded and during that\n time cvDnisMappingRefresh is set to refresh(2). When\n cvDnisMappingRefresh is set to refresh(2), only the\n destroy(6) operation is allowed.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "CISCO-VOICE-DNIS-MIB:cvDnisMappingEntry": [ { "cvDnisMappingName": "interface-1", "cvDnisMappingUrl": "example-string", "cvDnisMappingRefresh": "example-string", "cvDnisMappingUrlAccessError": "example-string", "cvDnisMappingStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvDnisMappingEntry", "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": "/cvDnisMappingTable/cvDnisMappingEntry", "x-restconf-kind": "container" }, "/data/CISCO-VOICE-DNIS-MIB:cvDnisMappingTable/cvDnisMappingEntry={cvDnisMappingName}": { "get": { "summary": "Get cvDnisMappingEntry entry", "description": "Retrieve specific cvDnisMappingEntry entry by key from MIB", "tags": [ "CISCO-VOICE-DNIS-MIB" ], "parameters": [ { "name": "cvDnisMappingName", "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": { "cvDnisMappingName": { "type": "string", "description": "The name which uniquely identifies a DNIS mapping.", "x-yang-type": "CISCO-VOICE-DNIS-MIB:DnisMapname" }, "cvDnisMappingUrl": { "type": "string", "description": "The url specifies a file location. The file contains\n individual DNIS entries that belong to the DNIS map \n name specified by cvDnisMappingName.\n \n Once a url is created and associated with a map name (the\n association is complete when the row is made active(1)),\n it cannot be modified while cvDnisMappingStatus is\n active. If a different url needs to be associated with\n the current map name, the row status should be made\n notInService(2) and this object has to be modified to\n associate a new url. When a new association is made all\n the DNIS entries corresponding to the old association\n will be deleted from the cvDnisNodeTable.\n \n The url is read when the row status is made active(1) or\n when the row status is active and the object \n cvDnisMappingRefresh is explicitly set to refresh(2). \n If the url is not accessible then a\n cvDnisMappingUrlInaccessible notification will be\n generted.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvDnisMappingRefresh": { "type": "string", "description": "Whenever there is a need to re-read the contents of the\n file specified by cvDnisMappingUrl, this object can be\n set to refresh(2). This will cause the contents of the\n file to be re-read and correspondingly update the\n cvDnisNodeTable. After the completion of this operation,\n the value of this object is reset to idle(1). The only\n operation allowed on this object is setting it to\n refresh(2). This can only be done when the current value\n is idle(1) and the rowstatus is active(1).\n \n idle - The refreshing process is idle and the user\n can modify this object to refresh.\n refresh - The refreshing process is currently busy and\n the user have to wait till the object\n becomes idle to issue new refresh." }, "cvDnisMappingUrlAccessError": { "type": "string", "description": "ASCII text describing the error on last access of the url\n specified in cvDnisMappingUrl.\n \n If the url access does not succeed, then this object is\n populated with an error message indicating the reason for\n failure. If the url access succeeds, this object is set\n to null string.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvDnisMappingStatus": { "type": "string", "description": "This object is used to create a new row or modify or\n delete an existing row in this table. When making the\n status active(1), if a valid cvDnisMappingUrl is present\n the contents of the url is downloaded and during that\n time cvDnisMappingRefresh is set to refresh(2). When\n cvDnisMappingRefresh is set to refresh(2), only the\n destroy(6) operation is allowed.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "CISCO-VOICE-DNIS-MIB:cvDnisMappingEntry": { "cvDnisMappingName": "interface-1", "cvDnisMappingUrl": "example-string", "cvDnisMappingRefresh": "example-string", "cvDnisMappingUrlAccessError": "example-string", "cvDnisMappingStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvDnisMappingEntry-2" }, "x-yang-path": "/cvDnisMappingTable/cvDnisMappingEntry={cvDnisMappingName}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cvDnisMappingName" ] }, "/data/CISCO-VOICE-DNIS-MIB:cvDnisNodeTable": { "get": { "summary": "Get cvDnisNodeTable data", "description": "Retrieve cvDnisNodeTable operational data from MIB", "tags": [ "CISCO-VOICE-DNIS-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The table contains a DNIS name and a url. The url is a\n pointer to a VXML page for the DNIS name.", "properties": { "cvDnisNodeEntry": { "type": "array", "description": "cvDnisNodeEntry", "items": { "type": "object", "properties": { "cvDnisMappingName": { "type": "string", "description": "cvDnisMappingName", "x-yang-type": "leafref" }, "cvDnisNumber": { "type": "string", "description": "The individual DNIS name. It is unique within a DNIS\n mapping.", "x-yang-type": "CISCO-VOICE-DNIS-MIB:CvE164String" }, "cvDnisNodeUrl": { "type": "string", "description": "The url specifies a VXML page. This page contains\n voice XML links to play audio data.\n \n This url which is a VXML page is not read immediately\n when the row is made active(1), but only when a call that\n requires the use of this DNIS comes through.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvDnisNodeModifiable": { "type": "boolean", "description": "This object specifies whether the object in a particular\n row is modifiable. The object is set to true(1) if the\n corresponding map name (defined in cvDnisMappingTable)\n does not have any file name provided in the\n cvDnisMappingUrl object. Otherwise this object is set to\n false(2) and the row becomes read only." }, "cvDnisNodeStatus": { "type": "string", "description": "This object is used to create a new row or modify or\n delete an existing row in this table. The objects in a\n row can be modified or deleted while the row status is\n active(1) and cvDnisNodeModifiable is true(1). The row\n status cannot be set to notInService(2) or\n createAndWait(5).", "x-yang-type": "snmpv2-tc:RowStatus" } } } } } }, "example": { "CISCO-VOICE-DNIS-MIB:cvDnisNodeTable": { "cvDnisNodeEntry": [ { "cvDnisMappingName": "interface-1", "cvDnisNumber": "example-string", "cvDnisNodeUrl": "example-string", "cvDnisNodeModifiable": true, "cvDnisNodeStatus": "up(1)" }, { "cvDnisMappingName": "interface-1", "cvDnisNumber": "example-string", "cvDnisNodeUrl": "example-string", "cvDnisNodeModifiable": true, "cvDnisNodeStatus": "up(1)" }, { "cvDnisMappingName": "interface-1", "cvDnisNumber": "example-string", "cvDnisNodeUrl": "example-string", "cvDnisNodeModifiable": true, "cvDnisNodeStatus": "up(1)" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvDnisNodeTable", "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": "/cvDnisNodeTable", "x-restconf-kind": "container" }, "/data/CISCO-VOICE-DNIS-MIB:cvDnisNodeTable/cvDnisNodeEntry": { "get": { "summary": "Get cvDnisNodeEntry list", "description": "Retrieve list of cvDnisNodeEntry entries from MIB", "tags": [ "CISCO-VOICE-DNIS-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "cvDnisNodeEntry", "items": { "type": "object", "properties": { "cvDnisMappingName": { "type": "string", "description": "cvDnisMappingName", "x-yang-type": "leafref" }, "cvDnisNumber": { "type": "string", "description": "The individual DNIS name. It is unique within a DNIS\n mapping.", "x-yang-type": "CISCO-VOICE-DNIS-MIB:CvE164String" }, "cvDnisNodeUrl": { "type": "string", "description": "The url specifies a VXML page. This page contains\n voice XML links to play audio data.\n \n This url which is a VXML page is not read immediately\n when the row is made active(1), but only when a call that\n requires the use of this DNIS comes through.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvDnisNodeModifiable": { "type": "boolean", "description": "This object specifies whether the object in a particular\n row is modifiable. The object is set to true(1) if the\n corresponding map name (defined in cvDnisMappingTable)\n does not have any file name provided in the\n cvDnisMappingUrl object. Otherwise this object is set to\n false(2) and the row becomes read only." }, "cvDnisNodeStatus": { "type": "string", "description": "This object is used to create a new row or modify or\n delete an existing row in this table. The objects in a\n row can be modified or deleted while the row status is\n active(1) and cvDnisNodeModifiable is true(1). The row\n status cannot be set to notInService(2) or\n createAndWait(5).", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "CISCO-VOICE-DNIS-MIB:cvDnisNodeEntry": [ { "cvDnisMappingName": "interface-1", "cvDnisNumber": "example-string", "cvDnisNodeUrl": "example-string", "cvDnisNodeModifiable": true, "cvDnisNodeStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvDnisNodeEntry", "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": "/cvDnisNodeTable/cvDnisNodeEntry", "x-restconf-kind": "container" }, "/data/CISCO-VOICE-DNIS-MIB:cvDnisMappingEntry": { "get": { "summary": "Get cvDnisMappingEntry list", "description": "Retrieve list of cvDnisMappingEntry entries from MIB", "tags": [ "CISCO-VOICE-DNIS-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "cvDnisMappingEntry", "items": { "type": "object", "properties": { "cvDnisMappingName": { "type": "string", "description": "The name which uniquely identifies a DNIS mapping.", "x-yang-type": "CISCO-VOICE-DNIS-MIB:DnisMapname" }, "cvDnisMappingUrl": { "type": "string", "description": "The url specifies a file location. The file contains\n individual DNIS entries that belong to the DNIS map \n name specified by cvDnisMappingName.\n \n Once a url is created and associated with a map name (the\n association is complete when the row is made active(1)),\n it cannot be modified while cvDnisMappingStatus is\n active. If a different url needs to be associated with\n the current map name, the row status should be made\n notInService(2) and this object has to be modified to\n associate a new url. When a new association is made all\n the DNIS entries corresponding to the old association\n will be deleted from the cvDnisNodeTable.\n \n The url is read when the row status is made active(1) or\n when the row status is active and the object \n cvDnisMappingRefresh is explicitly set to refresh(2). \n If the url is not accessible then a\n cvDnisMappingUrlInaccessible notification will be\n generted.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvDnisMappingRefresh": { "type": "string", "description": "Whenever there is a need to re-read the contents of the\n file specified by cvDnisMappingUrl, this object can be\n set to refresh(2). This will cause the contents of the\n file to be re-read and correspondingly update the\n cvDnisNodeTable. After the completion of this operation,\n the value of this object is reset to idle(1). The only\n operation allowed on this object is setting it to\n refresh(2). This can only be done when the current value\n is idle(1) and the rowstatus is active(1).\n \n idle - The refreshing process is idle and the user\n can modify this object to refresh.\n refresh - The refreshing process is currently busy and\n the user have to wait till the object\n becomes idle to issue new refresh." }, "cvDnisMappingUrlAccessError": { "type": "string", "description": "ASCII text describing the error on last access of the url\n specified in cvDnisMappingUrl.\n \n If the url access does not succeed, then this object is\n populated with an error message indicating the reason for\n failure. If the url access succeeds, this object is set\n to null string.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvDnisMappingStatus": { "type": "string", "description": "This object is used to create a new row or modify or\n delete an existing row in this table. When making the\n status active(1), if a valid cvDnisMappingUrl is present\n the contents of the url is downloaded and during that\n time cvDnisMappingRefresh is set to refresh(2). When\n cvDnisMappingRefresh is set to refresh(2), only the\n destroy(6) operation is allowed.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "CISCO-VOICE-DNIS-MIB:cvDnisMappingEntry": [ { "cvDnisMappingName": "interface-1", "cvDnisMappingUrl": "example-string", "cvDnisMappingRefresh": "example-string", "cvDnisMappingUrlAccessError": "example-string", "cvDnisMappingStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvDnisMappingEntry-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": "/cvDnisMappingEntry", "x-restconf-kind": "container" }, "/data/CISCO-VOICE-DNIS-MIB:cvDnisMappingEntry={cvDnisMappingName}": { "get": { "summary": "Get cvDnisMappingEntry entry", "description": "Retrieve specific cvDnisMappingEntry entry by key from MIB", "tags": [ "CISCO-VOICE-DNIS-MIB" ], "parameters": [ { "name": "cvDnisMappingName", "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": { "cvDnisMappingName": { "type": "string", "description": "The name which uniquely identifies a DNIS mapping.", "x-yang-type": "CISCO-VOICE-DNIS-MIB:DnisMapname" }, "cvDnisMappingUrl": { "type": "string", "description": "The url specifies a file location. The file contains\n individual DNIS entries that belong to the DNIS map \n name specified by cvDnisMappingName.\n \n Once a url is created and associated with a map name (the\n association is complete when the row is made active(1)),\n it cannot be modified while cvDnisMappingStatus is\n active. If a different url needs to be associated with\n the current map name, the row status should be made\n notInService(2) and this object has to be modified to\n associate a new url. When a new association is made all\n the DNIS entries corresponding to the old association\n will be deleted from the cvDnisNodeTable.\n \n The url is read when the row status is made active(1) or\n when the row status is active and the object \n cvDnisMappingRefresh is explicitly set to refresh(2). \n If the url is not accessible then a\n cvDnisMappingUrlInaccessible notification will be\n generted.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvDnisMappingRefresh": { "type": "string", "description": "Whenever there is a need to re-read the contents of the\n file specified by cvDnisMappingUrl, this object can be\n set to refresh(2). This will cause the contents of the\n file to be re-read and correspondingly update the\n cvDnisNodeTable. After the completion of this operation,\n the value of this object is reset to idle(1). The only\n operation allowed on this object is setting it to\n refresh(2). This can only be done when the current value\n is idle(1) and the rowstatus is active(1).\n \n idle - The refreshing process is idle and the user\n can modify this object to refresh.\n refresh - The refreshing process is currently busy and\n the user have to wait till the object\n becomes idle to issue new refresh." }, "cvDnisMappingUrlAccessError": { "type": "string", "description": "ASCII text describing the error on last access of the url\n specified in cvDnisMappingUrl.\n \n If the url access does not succeed, then this object is\n populated with an error message indicating the reason for\n failure. If the url access succeeds, this object is set\n to null string.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvDnisMappingStatus": { "type": "string", "description": "This object is used to create a new row or modify or\n delete an existing row in this table. When making the\n status active(1), if a valid cvDnisMappingUrl is present\n the contents of the url is downloaded and during that\n time cvDnisMappingRefresh is set to refresh(2). When\n cvDnisMappingRefresh is set to refresh(2), only the\n destroy(6) operation is allowed.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "CISCO-VOICE-DNIS-MIB:cvDnisMappingEntry": { "cvDnisMappingName": "interface-1", "cvDnisMappingUrl": "example-string", "cvDnisMappingRefresh": "example-string", "cvDnisMappingUrlAccessError": "example-string", "cvDnisMappingStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvDnisMappingEntry-4" }, "x-yang-path": "/cvDnisMappingEntry={cvDnisMappingName}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cvDnisMappingName" ] }, "/data/CISCO-VOICE-DNIS-MIB:cvDnisNodeEntry": { "get": { "summary": "Get cvDnisNodeEntry list", "description": "Retrieve list of cvDnisNodeEntry entries from MIB", "tags": [ "CISCO-VOICE-DNIS-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "cvDnisNodeEntry", "items": { "type": "object", "properties": { "cvDnisMappingName": { "type": "string", "description": "cvDnisMappingName", "x-yang-type": "leafref" }, "cvDnisNumber": { "type": "string", "description": "The individual DNIS name. It is unique within a DNIS\n mapping.", "x-yang-type": "CISCO-VOICE-DNIS-MIB:CvE164String" }, "cvDnisNodeUrl": { "type": "string", "description": "The url specifies a VXML page. This page contains\n voice XML links to play audio data.\n \n This url which is a VXML page is not read immediately\n when the row is made active(1), but only when a call that\n requires the use of this DNIS comes through.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvDnisNodeModifiable": { "type": "boolean", "description": "This object specifies whether the object in a particular\n row is modifiable. The object is set to true(1) if the\n corresponding map name (defined in cvDnisMappingTable)\n does not have any file name provided in the\n cvDnisMappingUrl object. Otherwise this object is set to\n false(2) and the row becomes read only." }, "cvDnisNodeStatus": { "type": "string", "description": "This object is used to create a new row or modify or\n delete an existing row in this table. The objects in a\n row can be modified or deleted while the row status is\n active(1) and cvDnisNodeModifiable is true(1). The row\n status cannot be set to notInService(2) or\n createAndWait(5).", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "CISCO-VOICE-DNIS-MIB:cvDnisNodeEntry": [ { "cvDnisMappingName": "interface-1", "cvDnisNumber": "example-string", "cvDnisNodeUrl": "example-string", "cvDnisNodeModifiable": true, "cvDnisNodeStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvDnisNodeEntry-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": "/cvDnisNodeEntry", "x-restconf-kind": "container" }, "/data/CISCO-VOICE-DNIS-MIB:cvDnisNodeTable/cvDnisNodeEntry={cvDnisMappingName},{cvDnisNumber}": { "get": { "summary": "Get cvDnisNodeEntry entry", "description": "Retrieve specific cvDnisNodeEntry entry by key from MIB", "tags": [ "CISCO-VOICE-DNIS-MIB" ], "parameters": [ { "name": "cvDnisMappingName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cvDnisNumber", "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": { "cvDnisMappingName": { "type": "string", "description": "cvDnisMappingName", "x-yang-type": "leafref" }, "cvDnisNumber": { "type": "string", "description": "The individual DNIS name. It is unique within a DNIS\n mapping.", "x-yang-type": "CISCO-VOICE-DNIS-MIB:CvE164String" }, "cvDnisNodeUrl": { "type": "string", "description": "The url specifies a VXML page. This page contains\n voice XML links to play audio data.\n \n This url which is a VXML page is not read immediately\n when the row is made active(1), but only when a call that\n requires the use of this DNIS comes through.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvDnisNodeModifiable": { "type": "boolean", "description": "This object specifies whether the object in a particular\n row is modifiable. The object is set to true(1) if the\n corresponding map name (defined in cvDnisMappingTable)\n does not have any file name provided in the\n cvDnisMappingUrl object. Otherwise this object is set to\n false(2) and the row becomes read only." }, "cvDnisNodeStatus": { "type": "string", "description": "This object is used to create a new row or modify or\n delete an existing row in this table. The objects in a\n row can be modified or deleted while the row status is\n active(1) and cvDnisNodeModifiable is true(1). The row\n status cannot be set to notInService(2) or\n createAndWait(5).", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "CISCO-VOICE-DNIS-MIB:cvDnisNodeEntry": { "cvDnisMappingName": "interface-1", "cvDnisNumber": "example-string", "cvDnisNodeUrl": "example-string", "cvDnisNodeModifiable": true, "cvDnisNodeStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvDnisNodeEntry-2" }, "x-yang-path": "/cvDnisNodeTable/cvDnisNodeEntry={cvDnisMappingName cvDnisNumber}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cvDnisMappingName cvDnisNumber" ] }, "/data/CISCO-VOICE-DNIS-MIB:cvDnisNodeEntry={cvDnisMappingName},{cvDnisNumber}": { "get": { "summary": "Get cvDnisNodeEntry entry", "description": "Retrieve specific cvDnisNodeEntry entry by key from MIB", "tags": [ "CISCO-VOICE-DNIS-MIB" ], "parameters": [ { "name": "cvDnisMappingName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cvDnisNumber", "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": { "cvDnisMappingName": { "type": "string", "description": "cvDnisMappingName", "x-yang-type": "leafref" }, "cvDnisNumber": { "type": "string", "description": "The individual DNIS name. It is unique within a DNIS\n mapping.", "x-yang-type": "CISCO-VOICE-DNIS-MIB:CvE164String" }, "cvDnisNodeUrl": { "type": "string", "description": "The url specifies a VXML page. This page contains\n voice XML links to play audio data.\n \n This url which is a VXML page is not read immediately\n when the row is made active(1), but only when a call that\n requires the use of this DNIS comes through.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvDnisNodeModifiable": { "type": "boolean", "description": "This object specifies whether the object in a particular\n row is modifiable. The object is set to true(1) if the\n corresponding map name (defined in cvDnisMappingTable)\n does not have any file name provided in the\n cvDnisMappingUrl object. Otherwise this object is set to\n false(2) and the row becomes read only." }, "cvDnisNodeStatus": { "type": "string", "description": "This object is used to create a new row or modify or\n delete an existing row in this table. The objects in a\n row can be modified or deleted while the row status is\n active(1) and cvDnisNodeModifiable is true(1). The row\n status cannot be set to notInService(2) or\n createAndWait(5).", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "CISCO-VOICE-DNIS-MIB:cvDnisNodeEntry": { "cvDnisMappingName": "interface-1", "cvDnisNumber": "example-string", "cvDnisNodeUrl": "example-string", "cvDnisNodeModifiable": true, "cvDnisNodeStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvDnisNodeEntry-4" }, "x-yang-path": "/cvDnisNodeEntry={cvDnisMappingName cvDnisNumber}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cvDnisMappingName cvDnisNumber" ] } }, "components": { "schemas": { "CISCO-VOICE-DNIS-MIB_CISCO-VOICE-DNIS-MIB": { "type": "object", "description": "The table contains the map name and a url specifying\n a file name. The file contains DNIS entries that belong\n to the DNIS mapping.", "properties": { "cvDnisMappingEntry": { "type": "array", "description": "cvDnisMappingEntry", "items": { "type": "object", "properties": { "cvDnisMappingName": { "type": "string", "description": "The name which uniquely identifies a DNIS mapping.", "x-yang-type": "CISCO-VOICE-DNIS-MIB:DnisMapname", "readOnly": true }, "cvDnisMappingUrl": { "type": "string", "description": "The url specifies a file location. The file contains\n individual DNIS entries that belong to the DNIS map \n name specified by cvDnisMappingName.\n \n Once a url is created and associated with a map name (the\n association is complete when the row is made active(1)),\n it cannot be modified while cvDnisMappingStatus is\n active. If a different url needs to be associated with\n the current map name, the row status should be made\n notInService(2) and this object has to be modified to\n associate a new url. When a new association is made all\n the DNIS entries corresponding to the old association\n will be deleted from the cvDnisNodeTable.\n \n The url is read when the row status is made active(1) or\n when the row status is active and the object \n cvDnisMappingRefresh is explicitly set to refresh(2). \n If the url is not accessible then a\n cvDnisMappingUrlInaccessible notification will be\n generted.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvDnisMappingRefresh": { "type": "string", "description": "Whenever there is a need to re-read the contents of the\n file specified by cvDnisMappingUrl, this object can be\n set to refresh(2). This will cause the contents of the\n file to be re-read and correspondingly update the\n cvDnisNodeTable. After the completion of this operation,\n the value of this object is reset to idle(1). The only\n operation allowed on this object is setting it to\n refresh(2). This can only be done when the current value\n is idle(1) and the rowstatus is active(1).\n \n idle - The refreshing process is idle and the user\n can modify this object to refresh.\n refresh - The refreshing process is currently busy and\n the user have to wait till the object\n becomes idle to issue new refresh.", "readOnly": true }, "cvDnisMappingUrlAccessError": { "type": "string", "description": "ASCII text describing the error on last access of the url\n specified in cvDnisMappingUrl.\n \n If the url access does not succeed, then this object is\n populated with an error message indicating the reason for\n failure. If the url access succeeds, this object is set\n to null string.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvDnisMappingStatus": { "type": "string", "description": "This object is used to create a new row or modify or\n delete an existing row in this table. When making the\n status active(1), if a valid cvDnisMappingUrl is present\n the contents of the url is downloaded and during that\n time cvDnisMappingRefresh is set to refresh(2). When\n cvDnisMappingRefresh is set to refresh(2), only the\n destroy(6) operation is allowed.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true }, "cvDnisNodeEntry": { "type": "array", "description": "cvDnisNodeEntry", "items": { "type": "object", "properties": { "cvDnisMappingName": { "type": "string", "description": "cvDnisMappingName", "x-yang-type": "leafref", "readOnly": true }, "cvDnisNumber": { "type": "string", "description": "The individual DNIS name. It is unique within a DNIS\n mapping.", "x-yang-type": "CISCO-VOICE-DNIS-MIB:CvE164String", "readOnly": true }, "cvDnisNodeUrl": { "type": "string", "description": "The url specifies a VXML page. This page contains\n voice XML links to play audio data.\n \n This url which is a VXML page is not read immediately\n when the row is made active(1), but only when a call that\n requires the use of this DNIS comes through.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvDnisNodeModifiable": { "type": "boolean", "description": "This object specifies whether the object in a particular\n row is modifiable. The object is set to true(1) if the\n corresponding map name (defined in cvDnisMappingTable)\n does not have any file name provided in the\n cvDnisMappingUrl object. Otherwise this object is set to\n false(2) and the row becomes read only.", "readOnly": true }, "cvDnisNodeStatus": { "type": "string", "description": "This object is used to create a new row or modify or\n delete an existing row in this table. The objects in a\n row can be modified or deleted while the row status is\n active(1) and cvDnisNodeModifiable is true(1). The row\n status cannot be set to notInService(2) or\n createAndWait(5).", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true }, "cvDnisMappingTable": { "type": "object", "description": "The table contains the map name and a url specifying\n a file name. The file contains DNIS entries that belong\n to the DNIS mapping.", "properties": { "cvDnisMappingEntry": { "type": "array", "description": "cvDnisMappingEntry", "items": { "type": "object", "properties": { "cvDnisMappingName": { "type": "string", "description": "The name which uniquely identifies a DNIS mapping.", "x-yang-type": "CISCO-VOICE-DNIS-MIB:DnisMapname", "readOnly": true }, "cvDnisMappingUrl": { "type": "string", "description": "The url specifies a file location. The file contains\n individual DNIS entries that belong to the DNIS map \n name specified by cvDnisMappingName.\n \n Once a url is created and associated with a map name (the\n association is complete when the row is made active(1)),\n it cannot be modified while cvDnisMappingStatus is\n active. If a different url needs to be associated with\n the current map name, the row status should be made\n notInService(2) and this object has to be modified to\n associate a new url. When a new association is made all\n the DNIS entries corresponding to the old association\n will be deleted from the cvDnisNodeTable.\n \n The url is read when the row status is made active(1) or\n when the row status is active and the object \n cvDnisMappingRefresh is explicitly set to refresh(2). \n If the url is not accessible then a\n cvDnisMappingUrlInaccessible notification will be\n generted.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvDnisMappingRefresh": { "type": "string", "description": "Whenever there is a need to re-read the contents of the\n file specified by cvDnisMappingUrl, this object can be\n set to refresh(2). This will cause the contents of the\n file to be re-read and correspondingly update the\n cvDnisNodeTable. After the completion of this operation,\n the value of this object is reset to idle(1). The only\n operation allowed on this object is setting it to\n refresh(2). This can only be done when the current value\n is idle(1) and the rowstatus is active(1).\n \n idle - The refreshing process is idle and the user\n can modify this object to refresh.\n refresh - The refreshing process is currently busy and\n the user have to wait till the object\n becomes idle to issue new refresh.", "readOnly": true }, "cvDnisMappingUrlAccessError": { "type": "string", "description": "ASCII text describing the error on last access of the url\n specified in cvDnisMappingUrl.\n \n If the url access does not succeed, then this object is\n populated with an error message indicating the reason for\n failure. If the url access succeeds, this object is set\n to null string.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvDnisMappingStatus": { "type": "string", "description": "This object is used to create a new row or modify or\n delete an existing row in this table. When making the\n status active(1), if a valid cvDnisMappingUrl is present\n the contents of the url is downloaded and during that\n time cvDnisMappingRefresh is set to refresh(2). When\n cvDnisMappingRefresh is set to refresh(2), only the\n destroy(6) operation is allowed.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cvDnisNodeTable": { "type": "object", "description": "The table contains a DNIS name and a url. The url is a\n pointer to a VXML page for the DNIS name.", "properties": { "cvDnisNodeEntry": { "type": "array", "description": "cvDnisNodeEntry", "items": { "type": "object", "properties": { "cvDnisMappingName": { "type": "string", "description": "cvDnisMappingName", "x-yang-type": "leafref", "readOnly": true }, "cvDnisNumber": { "type": "string", "description": "The individual DNIS name. It is unique within a DNIS\n mapping.", "x-yang-type": "CISCO-VOICE-DNIS-MIB:CvE164String", "readOnly": true }, "cvDnisNodeUrl": { "type": "string", "description": "The url specifies a VXML page. This page contains\n voice XML links to play audio data.\n \n This url which is a VXML page is not read immediately\n when the row is made active(1), but only when a call that\n requires the use of this DNIS comes through.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvDnisNodeModifiable": { "type": "boolean", "description": "This object specifies whether the object in a particular\n row is modifiable. The object is set to true(1) if the\n corresponding map name (defined in cvDnisMappingTable)\n does not have any file name provided in the\n cvDnisMappingUrl object. Otherwise this object is set to\n false(2) and the row becomes read only.", "readOnly": true }, "cvDnisNodeStatus": { "type": "string", "description": "This object is used to create a new row or modify or\n delete an existing row in this table. The objects in a\n row can be modified or deleted while the row status is\n active(1) and cvDnisNodeModifiable is true(1). The row\n status cannot be set to notInService(2) or\n createAndWait(5).", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true } }, "readOnly": true } } }, "CISCO-VOICE-DNIS-MIB_object-1": { "type": "object", "description": "object-1", "properties": { "cvDnisMappingName": { "type": "string", "description": "cvDnisMappingName", "x-yang-type": "leafref", "readOnly": true }, "cvDnisMappingUrl": { "type": "string", "description": "cvDnisMappingUrl", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-VOICE-DNIS-MIB_object-2": { "type": "object", "description": "object-2", "properties": { "cvDnisMappingName": { "type": "string", "description": "cvDnisMappingName", "x-yang-type": "leafref", "readOnly": true }, "cvDnisMappingUrlAccessError": { "type": "string", "description": "cvDnisMappingUrlAccessError", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-VOICE-DNIS-MIB_cvDnisMappingEntry": { "type": "array", "description": "cvDnisMappingEntry", "items": { "type": "object", "properties": { "cvDnisMappingName": { "type": "string", "description": "The name which uniquely identifies a DNIS mapping.", "x-yang-type": "CISCO-VOICE-DNIS-MIB:DnisMapname", "readOnly": true }, "cvDnisMappingUrl": { "type": "string", "description": "The url specifies a file location. The file contains\n individual DNIS entries that belong to the DNIS map \n name specified by cvDnisMappingName.\n \n Once a url is created and associated with a map name (the\n association is complete when the row is made active(1)),\n it cannot be modified while cvDnisMappingStatus is\n active. If a different url needs to be associated with\n the current map name, the row status should be made\n notInService(2) and this object has to be modified to\n associate a new url. When a new association is made all\n the DNIS entries corresponding to the old association\n will be deleted from the cvDnisNodeTable.\n \n The url is read when the row status is made active(1) or\n when the row status is active and the object \n cvDnisMappingRefresh is explicitly set to refresh(2). \n If the url is not accessible then a\n cvDnisMappingUrlInaccessible notification will be\n generted.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvDnisMappingRefresh": { "type": "string", "description": "Whenever there is a need to re-read the contents of the\n file specified by cvDnisMappingUrl, this object can be\n set to refresh(2). This will cause the contents of the\n file to be re-read and correspondingly update the\n cvDnisNodeTable. After the completion of this operation,\n the value of this object is reset to idle(1). The only\n operation allowed on this object is setting it to\n refresh(2). This can only be done when the current value\n is idle(1) and the rowstatus is active(1).\n \n idle - The refreshing process is idle and the user\n can modify this object to refresh.\n refresh - The refreshing process is currently busy and\n the user have to wait till the object\n becomes idle to issue new refresh.", "readOnly": true }, "cvDnisMappingUrlAccessError": { "type": "string", "description": "ASCII text describing the error on last access of the url\n specified in cvDnisMappingUrl.\n \n If the url access does not succeed, then this object is\n populated with an error message indicating the reason for\n failure. If the url access succeeds, this object is set\n to null string.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvDnisMappingStatus": { "type": "string", "description": "This object is used to create a new row or modify or\n delete an existing row in this table. When making the\n status active(1), if a valid cvDnisMappingUrl is present\n the contents of the url is downloaded and during that\n time cvDnisMappingRefresh is set to refresh(2). When\n cvDnisMappingRefresh is set to refresh(2), only the\n destroy(6) operation is allowed.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } } }, "CISCO-VOICE-DNIS-MIB_cvDnisNodeEntry": { "type": "array", "description": "cvDnisNodeEntry", "items": { "type": "object", "properties": { "cvDnisMappingName": { "type": "string", "description": "cvDnisMappingName", "x-yang-type": "leafref", "readOnly": true }, "cvDnisNumber": { "type": "string", "description": "The individual DNIS name. It is unique within a DNIS\n mapping.", "x-yang-type": "CISCO-VOICE-DNIS-MIB:CvE164String", "readOnly": true }, "cvDnisNodeUrl": { "type": "string", "description": "The url specifies a VXML page. This page contains\n voice XML links to play audio data.\n \n This url which is a VXML page is not read immediately\n when the row is made active(1), but only when a call that\n requires the use of this DNIS comes through.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvDnisNodeModifiable": { "type": "boolean", "description": "This object specifies whether the object in a particular\n row is modifiable. The object is set to true(1) if the\n corresponding map name (defined in cvDnisMappingTable)\n does not have any file name provided in the\n cvDnisMappingUrl object. Otherwise this object is set to\n false(2) and the row becomes read only.", "readOnly": true }, "cvDnisNodeStatus": { "type": "string", "description": "This object is used to create a new row or modify or\n delete an existing row in this table. The objects in a\n row can be modified or deleted while the row status is\n active(1) and cvDnisNodeModifiable is true(1). The row\n status cannot be set to notInService(2) or\n createAndWait(5).", "x-yang-type": "snmpv2-tc:RowStatus", "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-VOICE-DNIS-MIB", "description": "MIB operations for CISCO-VOICE-DNIS-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }