{ "openapi": "3.0.0", "info": { "title": "CISCO-VPDN-MGMT-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-VPDN-MGMT-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/CISCO-VPDN-MGMT-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "CISCO-VPDN-MGMT-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-VPDN-MGMT-MIB:ciscoVpdnMgmtMIBNotifs": { "get": { "summary": "Get ciscoVpdnMgmtMIBNotifs data", "description": "Retrieve ciscoVpdnMgmtMIBNotifs operational data from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This object contains the local session ID of the L2X\n session for which this notification has been\n generated.", "properties": { "cvpdnNotifSessionID": { "type": "integer", "description": "This object contains the local session ID of the L2X\n session for which this notification has been\n generated.", "minimum": -2147483648, "maximum": 2147483647 }, "cvpdnNotifSessionEvent": { "type": "string", "description": "Indicates the event that generated the L2X session\n notification.\n \n The events are represented as follows:\n \n up: Session has come up.\n \n down: Session has gone down.\n \n pwUp: Pseudowire associated with this \n session has come up.\n \n pwDown: Pseudowire associated with this \n session has gone down." } } }, "example": { "CISCO-VPDN-MGMT-MIB:ciscoVpdnMgmtMIBNotifs": { "cvpdnNotifSessionID": -2147483648, "cvpdnNotifSessionEvent": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoVpdnMgmtMIBNotifs", "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": "/ciscoVpdnMgmtMIBNotifs", "x-restconf-kind": "container" }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnSystemInfo": { "get": { "summary": "Get cvpdnSystemInfo data", "description": "Retrieve cvpdnSystemInfo operational data from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The total number of VPDN tunnels that are currently\n active within this system.", "properties": { "cvpdnTunnelTotal": { "type": "integer", "description": "The total number of VPDN tunnels that are currently\n active within this system.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionTotal": { "type": "integer", "description": "The total number of active users in all the active VPDN\n tunnels within this system.", "minimum": 0, "maximum": 4294967295 }, "cvpdnDeniedUsersTotal": { "type": "integer", "description": "The total number of denied user attempts to all the\n active VPDN tunnels within this system.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSystemNotifSessionEnabled": { "type": "boolean", "description": "Indicates whether Layer 2 VPN session notifications are\n enabled." }, "cvpdnSystemClearSessions": { "type": "string", "description": "Clears all the sessions in a given tunnel type. When\n reading this object, the value of 'none' will always be\n returned.\n \n When setting these values, the following operations will be\n performed:\n \n none: no operation.\n \n all: clears all the sessions in all the tunnels.\n \n l2f: clears all the L2F sessions.\n \n l2tp: clears all the L2TP sessions.\n \n pptp: clears all the PPTP sessions." } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnSystemInfo": { "cvpdnTunnelTotal": 0, "cvpdnSessionTotal": 0, "cvpdnDeniedUsersTotal": 0, "cvpdnSystemNotifSessionEnabled": true, "cvpdnSystemClearSessions": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnSystemInfo", "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": "/cvpdnSystemInfo", "x-restconf-kind": "container" }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnMultilinkInfo": { "get": { "summary": "Get cvpdnMultilinkInfo data", "description": "Retrieve cvpdnMultilinkInfo operational data from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The total number of bundles comprised of a single link.", "properties": { "cvpdnBundlesWithOneLink": { "type": "integer", "description": "The total number of bundles comprised of a single link.", "minimum": 0, "maximum": 4294967295 }, "cvpdnBundlesWithTwoLinks": { "type": "integer", "description": "The total number of bundles comprised of two links.", "minimum": 0, "maximum": 4294967295 }, "cvpdnBundlesWithMoreThanTwoLinks": { "type": "integer", "description": "The total number of bundles comprised of more than two\n links.", "minimum": 0, "maximum": 4294967295 }, "cvpdnBundleLastChanged": { "type": "string", "description": "The value of the sysUpTime object when the contents of\n cvpdnBundleTable last changed.", "x-yang-type": "yang:timestamp" } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnMultilinkInfo": { "cvpdnBundlesWithOneLink": 0, "cvpdnBundlesWithTwoLinks": 0, "cvpdnBundlesWithMoreThanTwoLinks": 0, "cvpdnBundleLastChanged": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnMultilinkInfo", "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": "/cvpdnMultilinkInfo", "x-restconf-kind": "container" }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnSystemTable": { "get": { "summary": "Get cvpdnSystemTable data", "description": "Retrieve cvpdnSystemTable operational data from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "Table of information about the VPDN system for all tunnel\n types.", "properties": { "cvpdnSystemEntry": { "type": "array", "description": "An entry in the table, containing information about a\n single type of VPDN tunnel.", "items": { "type": "object", "properties": { "cvpdnSystemTunnelType": { "type": "string", "description": "The tunnel type. This is the tunnel protocol.", "x-yang-type": "CISCO-VPDN-MGMT-MIB:TunnelType" }, "cvpdnSystemTunnelTotal": { "type": "integer", "description": "The total number of VPDN tunnels that are currently active\n of this tunnel type.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSystemSessionTotal": { "type": "integer", "description": "The total number of active sessions in all the active VPDN\n tunnels of this tunnel type.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSystemDeniedUsersTotal": { "type": "integer", "description": "The total number of denied user attempts to all the VPDN\n tunnels of this tunnel type since last system\n re-initialization.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSystemInitialConnReq": { "type": "integer", "description": "The total number tunnel connection attempts on all the VPDN\n tunnels of this tunnel type since last system\n re-initialization.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSystemSuccessConnReq": { "type": "integer", "description": "The total number tunnel Successful connection attempts in VPDN\n tunnels of this tunnel type since last system\n re-initialization.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSystemFailedConnReq": { "type": "integer", "description": "The total number tunnel Failed connection attempts in VPDN\n tunnels of this tunnel type since last system\n re-initialization.", "minimum": 0, "maximum": 4294967295 } } } } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnSystemTable": { "cvpdnSystemEntry": [ { "cvpdnSystemTunnelType": "ethernetCsmacd(6)", "cvpdnSystemTunnelTotal": 1500, "cvpdnSystemSessionTotal": 0, "cvpdnSystemDeniedUsersTotal": 0, "cvpdnSystemInitialConnReq": 0, "cvpdnSystemSuccessConnReq": 0, "cvpdnSystemFailedConnReq": 0 }, { "cvpdnSystemTunnelType": "ethernetCsmacd(6)", "cvpdnSystemTunnelTotal": 1500, "cvpdnSystemSessionTotal": 0, "cvpdnSystemDeniedUsersTotal": 0, "cvpdnSystemInitialConnReq": 0, "cvpdnSystemSuccessConnReq": 0, "cvpdnSystemFailedConnReq": 0 }, { "cvpdnSystemTunnelType": "ethernetCsmacd(6)", "cvpdnSystemTunnelTotal": 1500, "cvpdnSystemSessionTotal": 0, "cvpdnSystemDeniedUsersTotal": 0, "cvpdnSystemInitialConnReq": 0, "cvpdnSystemSuccessConnReq": 0, "cvpdnSystemFailedConnReq": 0 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnSystemTable", "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": "/cvpdnSystemTable", "x-restconf-kind": "container" }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnSystemTable/cvpdnSystemEntry": { "get": { "summary": "Get cvpdnSystemEntry list", "description": "Retrieve list of cvpdnSystemEntry entries from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in the table, containing information about a\n single type of VPDN tunnel.", "items": { "type": "object", "properties": { "cvpdnSystemTunnelType": { "type": "string", "description": "The tunnel type. This is the tunnel protocol.", "x-yang-type": "CISCO-VPDN-MGMT-MIB:TunnelType" }, "cvpdnSystemTunnelTotal": { "type": "integer", "description": "The total number of VPDN tunnels that are currently active\n of this tunnel type.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSystemSessionTotal": { "type": "integer", "description": "The total number of active sessions in all the active VPDN\n tunnels of this tunnel type.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSystemDeniedUsersTotal": { "type": "integer", "description": "The total number of denied user attempts to all the VPDN\n tunnels of this tunnel type since last system\n re-initialization.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSystemInitialConnReq": { "type": "integer", "description": "The total number tunnel connection attempts on all the VPDN\n tunnels of this tunnel type since last system\n re-initialization.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSystemSuccessConnReq": { "type": "integer", "description": "The total number tunnel Successful connection attempts in VPDN\n tunnels of this tunnel type since last system\n re-initialization.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSystemFailedConnReq": { "type": "integer", "description": "The total number tunnel Failed connection attempts in VPDN\n tunnels of this tunnel type since last system\n re-initialization.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnSystemEntry": [ { "cvpdnSystemTunnelType": "ethernetCsmacd(6)", "cvpdnSystemTunnelTotal": 1500, "cvpdnSystemSessionTotal": 0, "cvpdnSystemDeniedUsersTotal": 0, "cvpdnSystemInitialConnReq": 0, "cvpdnSystemSuccessConnReq": 0, "cvpdnSystemFailedConnReq": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnSystemEntry", "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": "/cvpdnSystemTable/cvpdnSystemEntry", "x-restconf-kind": "container" }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnSystemTable/cvpdnSystemEntry={cvpdnSystemTunnelType}": { "get": { "summary": "Get cvpdnSystemEntry entry", "description": "Retrieve specific cvpdnSystemEntry entry by key from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "parameters": [ { "name": "cvpdnSystemTunnelType", "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": { "cvpdnSystemTunnelType": { "type": "string", "description": "The tunnel type. This is the tunnel protocol.", "x-yang-type": "CISCO-VPDN-MGMT-MIB:TunnelType" }, "cvpdnSystemTunnelTotal": { "type": "integer", "description": "The total number of VPDN tunnels that are currently active\n of this tunnel type.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSystemSessionTotal": { "type": "integer", "description": "The total number of active sessions in all the active VPDN\n tunnels of this tunnel type.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSystemDeniedUsersTotal": { "type": "integer", "description": "The total number of denied user attempts to all the VPDN\n tunnels of this tunnel type since last system\n re-initialization.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSystemInitialConnReq": { "type": "integer", "description": "The total number tunnel connection attempts on all the VPDN\n tunnels of this tunnel type since last system\n re-initialization.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSystemSuccessConnReq": { "type": "integer", "description": "The total number tunnel Successful connection attempts in VPDN\n tunnels of this tunnel type since last system\n re-initialization.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSystemFailedConnReq": { "type": "integer", "description": "The total number tunnel Failed connection attempts in VPDN\n tunnels of this tunnel type since last system\n re-initialization.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnSystemEntry": { "cvpdnSystemTunnelType": "ethernetCsmacd(6)", "cvpdnSystemTunnelTotal": 1500, "cvpdnSystemSessionTotal": 0, "cvpdnSystemDeniedUsersTotal": 0, "cvpdnSystemInitialConnReq": 0, "cvpdnSystemSuccessConnReq": 0, "cvpdnSystemFailedConnReq": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnSystemEntry-2" }, "x-yang-path": "/cvpdnSystemTable/cvpdnSystemEntry={cvpdnSystemTunnelType}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cvpdnSystemTunnelType" ] }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnTunnelTable": { "get": { "summary": "Get cvpdnTunnelTable data", "description": "Retrieve cvpdnTunnelTable operational data from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "Table of information about the active VPDN tunnels.", "properties": { "cvpdnTunnelEntry": { "type": "array", "description": "An entry in the table, containing information about a\n single active VPDN tunnel.", "items": { "type": "object", "properties": { "cvpdnTunnelTunnelId": { "type": "integer", "description": "The Tunnel ID of an active VPDN tunnel. If it is the\n instigator of the tunnel, the ID is the HGW/LNS tunnel\n ID, otherwise it is the NAS/LAC tunnel ID.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelRemoteTunnelId": { "type": "integer", "description": "The remote Tunnel ID of an active VPDN tunnel. If it\n is the instigator of the tunnel, the ID is the NAS/LAC\n tunnel ID, otherwise it is the HGW/LNS tunnel ID.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelLocalName": { "type": "string", "description": "The local name of an active VPDN tunnel. It will be\n the NAS/LAC name of the tunnel if the router serves as\n the NAS/LAC, or the HGW/LNS name of the tunnel if the\n system serves as the home gateway. Typically, the\n local name is the configured host name of the router.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnTunnelRemoteName": { "type": "string", "description": "The remote name of an active VPDN tunnel. It will be\n the home gateway name of the tunnel if the system is a\n NAS/LAC, or the NAS/LAC name of the tunnel if the\n system serves as the home gateway.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnTunnelRemoteEndpointName": { "type": "string", "description": "The remote end point name of an active VPDN tunnel.\n This name is either the domain name or the DNIS that\n this tunnel is projected with.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnTunnelLocalInitConnection": { "type": "boolean", "description": "This object indicates whether the tunnel was generated\n locally or not." }, "cvpdnTunnelOrigCause": { "type": "string", "description": "The cause which originated an active VPDN tunnel. The\n tunnel can be projected via domain name, DNIS or a\n stack group (SGBP)." }, "cvpdnTunnelState": { "type": "string", "description": "The current state of an active VPDN tunnel. Each state\n code is explained below:\n \n unknown: The current state of the tunnel is\n unknown.\n \n opening: The tunnel has just been instigated and\n is pending for a remote end reply to\n complete the process.\n \n open: The tunnel is active.\n \n closing: The tunnel has just been shut down and\n is pending for the remote end to reply\n to complete the process." }, "cvpdnTunnelActiveSessions": { "type": "integer", "description": "The total number of active session currently in the\n tunnel.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelDeniedUsers": { "type": "integer", "description": "A count of the accumulated total of denied users for\n the tunnel.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSoftshut": { "type": "boolean", "description": "A VPDN tunnel can be put into a soft shut state to\n prevent any new user session to be added. This object\n specifies whether this tunnel has been soft shut." }, "cvpdnTunnelNetworkServiceType": { "type": "string", "description": "The type of network service used in the active tunnel.\n For now it is IP only." }, "cvpdnTunnelLocalIpAddress": { "type": "string", "description": "The local IP address of the tunnel. This IP address is\n that of the interface at the local end of the tunnel.", "format": "inet:ipv4-address" }, "cvpdnTunnelSourceIpAddress": { "type": "string", "description": "The source IP address of the tunnel. This IP address\n is the user configurable IP address for Stack Group\n Biding Protocol (SGBP) via the CLI command:\n vpdn source-ip", "format": "inet:ipv4-address" }, "cvpdnTunnelRemoteIpAddress": { "type": "string", "description": "The remote IP address of the tunnel. This IP address\n is that of the interface at the remote end of the\n tunnel.", "format": "inet:ipv4-address" } } } } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnTunnelTable": { "cvpdnTunnelEntry": [ { "cvpdnTunnelTunnelId": 0, "cvpdnTunnelRemoteTunnelId": 0, "cvpdnTunnelLocalName": "interface-1", "cvpdnTunnelRemoteName": "interface-1", "cvpdnTunnelRemoteEndpointName": "interface-1", "cvpdnTunnelLocalInitConnection": true, "cvpdnTunnelOrigCause": "example-string", "cvpdnTunnelState": "up(1)", "cvpdnTunnelActiveSessions": 0, "cvpdnTunnelDeniedUsers": 0, "cvpdnTunnelSoftshut": true, "cvpdnTunnelNetworkServiceType": "ethernetCsmacd(6)", "cvpdnTunnelLocalIpAddress": "192.168.1.1", "cvpdnTunnelSourceIpAddress": "192.168.1.1", "cvpdnTunnelRemoteIpAddress": "192.168.1.1" }, { "cvpdnTunnelTunnelId": 0, "cvpdnTunnelRemoteTunnelId": 0, "cvpdnTunnelLocalName": "interface-1", "cvpdnTunnelRemoteName": "interface-1", "cvpdnTunnelRemoteEndpointName": "interface-1", "cvpdnTunnelLocalInitConnection": true, "cvpdnTunnelOrigCause": "example-string", "cvpdnTunnelState": "up(1)", "cvpdnTunnelActiveSessions": 0, "cvpdnTunnelDeniedUsers": 0, "cvpdnTunnelSoftshut": true, "cvpdnTunnelNetworkServiceType": "ethernetCsmacd(6)", "cvpdnTunnelLocalIpAddress": "192.168.1.1", "cvpdnTunnelSourceIpAddress": "192.168.1.1", "cvpdnTunnelRemoteIpAddress": "192.168.1.1" }, { "cvpdnTunnelTunnelId": 0, "cvpdnTunnelRemoteTunnelId": 0, "cvpdnTunnelLocalName": "interface-1", "cvpdnTunnelRemoteName": "interface-1", "cvpdnTunnelRemoteEndpointName": "interface-1", "cvpdnTunnelLocalInitConnection": true, "cvpdnTunnelOrigCause": "example-string", "cvpdnTunnelState": "up(1)", "cvpdnTunnelActiveSessions": 0, "cvpdnTunnelDeniedUsers": 0, "cvpdnTunnelSoftshut": true, "cvpdnTunnelNetworkServiceType": "ethernetCsmacd(6)", "cvpdnTunnelLocalIpAddress": "192.168.1.1", "cvpdnTunnelSourceIpAddress": "192.168.1.1", "cvpdnTunnelRemoteIpAddress": "192.168.1.1" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnTunnelTable", "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": "/cvpdnTunnelTable", "x-restconf-kind": "container" }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnTunnelTable/cvpdnTunnelEntry": { "get": { "summary": "Get cvpdnTunnelEntry list", "description": "Retrieve list of cvpdnTunnelEntry entries from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in the table, containing information about a\n single active VPDN tunnel.", "items": { "type": "object", "properties": { "cvpdnTunnelTunnelId": { "type": "integer", "description": "The Tunnel ID of an active VPDN tunnel. If it is the\n instigator of the tunnel, the ID is the HGW/LNS tunnel\n ID, otherwise it is the NAS/LAC tunnel ID.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelRemoteTunnelId": { "type": "integer", "description": "The remote Tunnel ID of an active VPDN tunnel. If it\n is the instigator of the tunnel, the ID is the NAS/LAC\n tunnel ID, otherwise it is the HGW/LNS tunnel ID.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelLocalName": { "type": "string", "description": "The local name of an active VPDN tunnel. It will be\n the NAS/LAC name of the tunnel if the router serves as\n the NAS/LAC, or the HGW/LNS name of the tunnel if the\n system serves as the home gateway. Typically, the\n local name is the configured host name of the router.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnTunnelRemoteName": { "type": "string", "description": "The remote name of an active VPDN tunnel. It will be\n the home gateway name of the tunnel if the system is a\n NAS/LAC, or the NAS/LAC name of the tunnel if the\n system serves as the home gateway.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnTunnelRemoteEndpointName": { "type": "string", "description": "The remote end point name of an active VPDN tunnel.\n This name is either the domain name or the DNIS that\n this tunnel is projected with.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnTunnelLocalInitConnection": { "type": "boolean", "description": "This object indicates whether the tunnel was generated\n locally or not." }, "cvpdnTunnelOrigCause": { "type": "string", "description": "The cause which originated an active VPDN tunnel. The\n tunnel can be projected via domain name, DNIS or a\n stack group (SGBP)." }, "cvpdnTunnelState": { "type": "string", "description": "The current state of an active VPDN tunnel. Each state\n code is explained below:\n \n unknown: The current state of the tunnel is\n unknown.\n \n opening: The tunnel has just been instigated and\n is pending for a remote end reply to\n complete the process.\n \n open: The tunnel is active.\n \n closing: The tunnel has just been shut down and\n is pending for the remote end to reply\n to complete the process." }, "cvpdnTunnelActiveSessions": { "type": "integer", "description": "The total number of active session currently in the\n tunnel.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelDeniedUsers": { "type": "integer", "description": "A count of the accumulated total of denied users for\n the tunnel.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSoftshut": { "type": "boolean", "description": "A VPDN tunnel can be put into a soft shut state to\n prevent any new user session to be added. This object\n specifies whether this tunnel has been soft shut." }, "cvpdnTunnelNetworkServiceType": { "type": "string", "description": "The type of network service used in the active tunnel.\n For now it is IP only." }, "cvpdnTunnelLocalIpAddress": { "type": "string", "description": "The local IP address of the tunnel. This IP address is\n that of the interface at the local end of the tunnel.", "format": "inet:ipv4-address" }, "cvpdnTunnelSourceIpAddress": { "type": "string", "description": "The source IP address of the tunnel. This IP address\n is the user configurable IP address for Stack Group\n Biding Protocol (SGBP) via the CLI command:\n vpdn source-ip", "format": "inet:ipv4-address" }, "cvpdnTunnelRemoteIpAddress": { "type": "string", "description": "The remote IP address of the tunnel. This IP address\n is that of the interface at the remote end of the\n tunnel.", "format": "inet:ipv4-address" } } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnTunnelEntry": [ { "cvpdnTunnelTunnelId": 0, "cvpdnTunnelRemoteTunnelId": 0, "cvpdnTunnelLocalName": "interface-1", "cvpdnTunnelRemoteName": "interface-1", "cvpdnTunnelRemoteEndpointName": "interface-1", "cvpdnTunnelLocalInitConnection": true, "cvpdnTunnelOrigCause": "example-string", "cvpdnTunnelState": "up(1)", "cvpdnTunnelActiveSessions": 0, "cvpdnTunnelDeniedUsers": 0, "cvpdnTunnelSoftshut": true, "cvpdnTunnelNetworkServiceType": "ethernetCsmacd(6)", "cvpdnTunnelLocalIpAddress": "192.168.1.1", "cvpdnTunnelSourceIpAddress": "192.168.1.1", "cvpdnTunnelRemoteIpAddress": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnTunnelEntry", "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": "/cvpdnTunnelTable/cvpdnTunnelEntry", "x-restconf-kind": "container" }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnTunnelTable/cvpdnTunnelEntry={cvpdnTunnelTunnelId}": { "get": { "summary": "Get cvpdnTunnelEntry entry", "description": "Retrieve specific cvpdnTunnelEntry entry by key from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "parameters": [ { "name": "cvpdnTunnelTunnelId", "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": { "cvpdnTunnelTunnelId": { "type": "integer", "description": "The Tunnel ID of an active VPDN tunnel. If it is the\n instigator of the tunnel, the ID is the HGW/LNS tunnel\n ID, otherwise it is the NAS/LAC tunnel ID.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelRemoteTunnelId": { "type": "integer", "description": "The remote Tunnel ID of an active VPDN tunnel. If it\n is the instigator of the tunnel, the ID is the NAS/LAC\n tunnel ID, otherwise it is the HGW/LNS tunnel ID.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelLocalName": { "type": "string", "description": "The local name of an active VPDN tunnel. It will be\n the NAS/LAC name of the tunnel if the router serves as\n the NAS/LAC, or the HGW/LNS name of the tunnel if the\n system serves as the home gateway. Typically, the\n local name is the configured host name of the router.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnTunnelRemoteName": { "type": "string", "description": "The remote name of an active VPDN tunnel. It will be\n the home gateway name of the tunnel if the system is a\n NAS/LAC, or the NAS/LAC name of the tunnel if the\n system serves as the home gateway.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnTunnelRemoteEndpointName": { "type": "string", "description": "The remote end point name of an active VPDN tunnel.\n This name is either the domain name or the DNIS that\n this tunnel is projected with.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnTunnelLocalInitConnection": { "type": "boolean", "description": "This object indicates whether the tunnel was generated\n locally or not." }, "cvpdnTunnelOrigCause": { "type": "string", "description": "The cause which originated an active VPDN tunnel. The\n tunnel can be projected via domain name, DNIS or a\n stack group (SGBP)." }, "cvpdnTunnelState": { "type": "string", "description": "The current state of an active VPDN tunnel. Each state\n code is explained below:\n \n unknown: The current state of the tunnel is\n unknown.\n \n opening: The tunnel has just been instigated and\n is pending for a remote end reply to\n complete the process.\n \n open: The tunnel is active.\n \n closing: The tunnel has just been shut down and\n is pending for the remote end to reply\n to complete the process." }, "cvpdnTunnelActiveSessions": { "type": "integer", "description": "The total number of active session currently in the\n tunnel.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelDeniedUsers": { "type": "integer", "description": "A count of the accumulated total of denied users for\n the tunnel.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSoftshut": { "type": "boolean", "description": "A VPDN tunnel can be put into a soft shut state to\n prevent any new user session to be added. This object\n specifies whether this tunnel has been soft shut." }, "cvpdnTunnelNetworkServiceType": { "type": "string", "description": "The type of network service used in the active tunnel.\n For now it is IP only." }, "cvpdnTunnelLocalIpAddress": { "type": "string", "description": "The local IP address of the tunnel. This IP address is\n that of the interface at the local end of the tunnel.", "format": "inet:ipv4-address" }, "cvpdnTunnelSourceIpAddress": { "type": "string", "description": "The source IP address of the tunnel. This IP address\n is the user configurable IP address for Stack Group\n Biding Protocol (SGBP) via the CLI command:\n vpdn source-ip", "format": "inet:ipv4-address" }, "cvpdnTunnelRemoteIpAddress": { "type": "string", "description": "The remote IP address of the tunnel. This IP address\n is that of the interface at the remote end of the\n tunnel.", "format": "inet:ipv4-address" } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnTunnelEntry": { "cvpdnTunnelTunnelId": 0, "cvpdnTunnelRemoteTunnelId": 0, "cvpdnTunnelLocalName": "interface-1", "cvpdnTunnelRemoteName": "interface-1", "cvpdnTunnelRemoteEndpointName": "interface-1", "cvpdnTunnelLocalInitConnection": true, "cvpdnTunnelOrigCause": "example-string", "cvpdnTunnelState": "up(1)", "cvpdnTunnelActiveSessions": 0, "cvpdnTunnelDeniedUsers": 0, "cvpdnTunnelSoftshut": true, "cvpdnTunnelNetworkServiceType": "ethernetCsmacd(6)", "cvpdnTunnelLocalIpAddress": "192.168.1.1", "cvpdnTunnelSourceIpAddress": "192.168.1.1", "cvpdnTunnelRemoteIpAddress": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnTunnelEntry-2" }, "x-yang-path": "/cvpdnTunnelTable/cvpdnTunnelEntry={cvpdnTunnelTunnelId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cvpdnTunnelTunnelId" ] }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnTunnelAttrTable": { "get": { "summary": "Get cvpdnTunnelAttrTable data", "description": "Retrieve cvpdnTunnelAttrTable operational data from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "Table of information about the active VPDN tunnels. An\n entry is added to the table when a new tunnel is initiated\n and removed from the table when the tunnel is terminated.", "properties": { "cvpdnTunnelAttrEntry": { "type": "array", "description": "An entry in the table, containing information about a\n single active VPDN tunnel.", "items": { "type": "object", "properties": { "cvpdnSystemTunnelType": { "type": "string", "description": "cvpdnSystemTunnelType", "x-yang-type": "leafref" }, "cvpdnTunnelAttrTunnelId": { "type": "integer", "description": "The Tunnel ID of an active VPDN tunnel. If this end is the\n instigator of the tunnel, the ID is the TS tunnel ID,\n otherwise it is the NAS tunnel ID.\n \n Two distinct tunnels with the same tunnel ID may exist, but\n with different tunnel types.", "minimum": -2147483648, "maximum": 2147483647 }, "cvpdnTunnelAttrRemoteTunnelId": { "type": "integer", "description": "The remote Tunnel ID of an active VPDN tunnel. If this end\n is the instigator of the tunnel, the ID is the NAS tunnel\n ID, otherwise it is the TS tunnel ID.", "minimum": -2147483648, "maximum": 2147483647 }, "cvpdnTunnelAttrLocalName": { "type": "string", "description": "The local name of an active VPDN tunnel. It will be the\n NAS name of the tunnel if the system serves as the NAS, or\n the TS name of the tunnel if the system serves as the\n tunnel server. Typically, the local name is the configured\n host name of the system.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnTunnelAttrRemoteName": { "type": "string", "description": "The remote name of an active VPDN tunnel. It will be the\n tunnel server name of the tunnel if the system is a NAS,\n or the NAS name of the tunnel if the system serves as the\n tunnel server.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnTunnelAttrRemoteEndpointName": { "type": "string", "description": "The remote end point name of an active VPDN tunnel. This\n name is either the domain name or the DNIS that this tunnel\n is projected with.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnTunnelAttrLocalInitConnection": { "type": "boolean", "description": "This object indicates whether the tunnel was originated\n locally or not. If it's true, the tunnel was originated\n locally." }, "cvpdnTunnelAttrOrigCause": { "type": "string", "description": "The cause which originated an active VPDN tunnel. The\n tunnel can be projected via domain name, DNIS, stack group,\n or L2 Xconnect." }, "cvpdnTunnelAttrState": { "type": "string", "description": "The current state of an active VPDN tunnel.\n Tunnels of type l2f will have states with the 'l2f' prefix.\n Tunnels of type l2tp will have states with the 'l2tp'\n prefix.\n Tunnels of type pptp will have states with the 'pptp'\n prefix.\n \n Each state code is explained below:\n \n unknown: The current state of the tunnel is\n unknown.\n \n l2fOpening: The tunnel has just been initiated\n and is pending for a remote end\n reply to complete the process.\n \n l2fOpenWait: This end received a tunnel open\n request from the remote end and is\n waiting for the tunnel to be\n established.\n \n l2fOpen: The tunnel is active.\n \n l2fClosing: This end received a tunnel close\n request.\n \n l2fCloseWait: The tunnel has just been shut down\n and is pending for the remote end\n to reply to complete the process.\n \n l2tpIdle: No tunnel is initiated yet.\n \n l2tpWaitCtlReply: The tunnel has been initiated and\n is pending for a remote end reply\n to complete the process.\n \n l2tpEstablished: The tunnel is active.\n \n l2tpShuttingDown: The tunnel is in progress of\n shutting down.\n \n l2tpNoSessionLeft: There is no session left in the\n tunnel.\n \n pptpIdle: No tunnel is initiated yet.\n \n pptpWaitConnect: The tunnel is waiting for a TCP\n connection.\n \n pptpWaitCtlRequest: The tunnel has been initiated and\n is pending for a remote end\n request.\n \n pptpWaitCtlReply: The tunnel has been initiated and\n is pending for a remote end reply.\n \n pptpEstablished: The tunnel is active.\n \n pptpWaitStopReply: The tunnel is being shut down and\n is pending for a remote end reply.\n \n pptpTerminal: The tunnel has been shut down." }, "cvpdnTunnelAttrActiveSessions": { "type": "integer", "description": "The total number of active session currently in the\n tunnel.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelAttrDeniedUsers": { "type": "integer", "description": "A count of the accumulated total of denied users for the\n tunnel.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelAttrSoftshut": { "type": "boolean", "description": "A VPDN tunnel can be put into a soft shut state to prevent\n any new session to be added. This object specifies whether\n this tunnel has been soft shut. If its true, it has been\n soft shut." }, "cvpdnTunnelAttrNetworkServiceType": { "type": "string", "description": "The type of network service used in the active tunnel." }, "cvpdnTunnelAttrLocalIpAddress": { "type": "string", "description": "The local IP address of the tunnel. This IP address is\n that of the interface at the local end of the tunnel.", "format": "inet:ipv4-address" }, "cvpdnTunnelAttrSourceIpAddress": { "type": "string", "description": "The source IP address of the tunnel. This IP address is\n the user configurable IP address for Stack Group Biding\n Protocol.", "format": "inet:ipv4-address" }, "cvpdnTunnelAttrRemoteIpAddress": { "type": "string", "description": "The remote IP address of the tunnel. This IP address is\n that of the interface at the remote end of the tunnel.", "format": "inet:ipv4-address" }, "cvpdnTunnelAttrLocalInetAddressType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnTunnelAttrLocalInetAddress", "x-yang-type": "inet-address:InetAddressType" }, "cvpdnTunnelAttrLocalInetAddress": { "type": "string", "description": "The local IP address of the tunnel. This IP address is\n that of the interface at the local end of the tunnel.\n The type of this address is determined by the value of \n cvpdnTunnelAttrLocalInetAddressType.", "x-yang-type": "inet-address:InetAddress" }, "cvpdnTunnelAttrSourceInetAddressType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnTunnelAttrSourceInetAddress", "x-yang-type": "inet-address:InetAddressType" }, "cvpdnTunnelAttrSourceInetAddress": { "type": "string", "description": "The source IP address of the tunnel. This IP address is\n the user configurable IP address for Stack Group Biding\n Protocol. The type of this address is determined by the \n value of cvpdnTunnelAttrSourceInetAddressType.", "x-yang-type": "inet-address:InetAddress" }, "cvpdnTunnelAttrRemoteInetAddressType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnTunnelAttrRemoteInetAddress", "x-yang-type": "inet-address:InetAddressType" }, "cvpdnTunnelAttrRemoteInetAddress": { "type": "string", "description": "The remote IP address of the tunnel. This IP address is\n that of the interface at the remote end of the tunnel.\n The type of this address is determined by the value of \n cvpdnTunnelAttrRemoteInetAddressType.", "x-yang-type": "inet-address:InetAddress" } } } } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnTunnelAttrTable": { "cvpdnTunnelAttrEntry": [ { "cvpdnSystemTunnelType": "ethernetCsmacd(6)", "cvpdnTunnelAttrTunnelId": -2147483648, "cvpdnTunnelAttrRemoteTunnelId": -2147483648, "cvpdnTunnelAttrLocalName": "interface-1", "cvpdnTunnelAttrRemoteName": "interface-1", "cvpdnTunnelAttrRemoteEndpointName": "interface-1", "cvpdnTunnelAttrLocalInitConnection": true, "cvpdnTunnelAttrOrigCause": "example-string", "cvpdnTunnelAttrState": "up(1)", "cvpdnTunnelAttrActiveSessions": 0, "cvpdnTunnelAttrDeniedUsers": 0, "cvpdnTunnelAttrSoftshut": true, "cvpdnTunnelAttrNetworkServiceType": "ethernetCsmacd(6)", "cvpdnTunnelAttrLocalIpAddress": "192.168.1.1", "cvpdnTunnelAttrSourceIpAddress": "192.168.1.1", "cvpdnTunnelAttrRemoteIpAddress": "192.168.1.1", "cvpdnTunnelAttrLocalInetAddressType": "192.168.1.1", "cvpdnTunnelAttrLocalInetAddress": "192.168.1.1", "cvpdnTunnelAttrSourceInetAddressType": "192.168.1.1", "cvpdnTunnelAttrSourceInetAddress": "192.168.1.1", "cvpdnTunnelAttrRemoteInetAddressType": "192.168.1.1", "cvpdnTunnelAttrRemoteInetAddress": "192.168.1.1" }, { "cvpdnSystemTunnelType": "ethernetCsmacd(6)", "cvpdnTunnelAttrTunnelId": -2147483648, "cvpdnTunnelAttrRemoteTunnelId": -2147483648, "cvpdnTunnelAttrLocalName": "interface-1", "cvpdnTunnelAttrRemoteName": "interface-1", "cvpdnTunnelAttrRemoteEndpointName": "interface-1", "cvpdnTunnelAttrLocalInitConnection": true, "cvpdnTunnelAttrOrigCause": "example-string", "cvpdnTunnelAttrState": "up(1)", "cvpdnTunnelAttrActiveSessions": 0, "cvpdnTunnelAttrDeniedUsers": 0, "cvpdnTunnelAttrSoftshut": true, "cvpdnTunnelAttrNetworkServiceType": "ethernetCsmacd(6)", "cvpdnTunnelAttrLocalIpAddress": "192.168.1.1", "cvpdnTunnelAttrSourceIpAddress": "192.168.1.1", "cvpdnTunnelAttrRemoteIpAddress": "192.168.1.1", "cvpdnTunnelAttrLocalInetAddressType": "192.168.1.1", "cvpdnTunnelAttrLocalInetAddress": "192.168.1.1", "cvpdnTunnelAttrSourceInetAddressType": "192.168.1.1", "cvpdnTunnelAttrSourceInetAddress": "192.168.1.1", "cvpdnTunnelAttrRemoteInetAddressType": "192.168.1.1", "cvpdnTunnelAttrRemoteInetAddress": "192.168.1.1" }, { "cvpdnSystemTunnelType": "ethernetCsmacd(6)", "cvpdnTunnelAttrTunnelId": -2147483648, "cvpdnTunnelAttrRemoteTunnelId": -2147483648, "cvpdnTunnelAttrLocalName": "interface-1", "cvpdnTunnelAttrRemoteName": "interface-1", "cvpdnTunnelAttrRemoteEndpointName": "interface-1", "cvpdnTunnelAttrLocalInitConnection": true, "cvpdnTunnelAttrOrigCause": "example-string", "cvpdnTunnelAttrState": "up(1)", "cvpdnTunnelAttrActiveSessions": 0, "cvpdnTunnelAttrDeniedUsers": 0, "cvpdnTunnelAttrSoftshut": true, "cvpdnTunnelAttrNetworkServiceType": "ethernetCsmacd(6)", "cvpdnTunnelAttrLocalIpAddress": "192.168.1.1", "cvpdnTunnelAttrSourceIpAddress": "192.168.1.1", "cvpdnTunnelAttrRemoteIpAddress": "192.168.1.1", "cvpdnTunnelAttrLocalInetAddressType": "192.168.1.1", "cvpdnTunnelAttrLocalInetAddress": "192.168.1.1", "cvpdnTunnelAttrSourceInetAddressType": "192.168.1.1", "cvpdnTunnelAttrSourceInetAddress": "192.168.1.1", "cvpdnTunnelAttrRemoteInetAddressType": "192.168.1.1", "cvpdnTunnelAttrRemoteInetAddress": "192.168.1.1" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnTunnelAttrTable", "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": "/cvpdnTunnelAttrTable", "x-restconf-kind": "container" }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnTunnelAttrTable/cvpdnTunnelAttrEntry": { "get": { "summary": "Get cvpdnTunnelAttrEntry list", "description": "Retrieve list of cvpdnTunnelAttrEntry entries from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in the table, containing information about a\n single active VPDN tunnel.", "items": { "type": "object", "properties": { "cvpdnSystemTunnelType": { "type": "string", "description": "cvpdnSystemTunnelType", "x-yang-type": "leafref" }, "cvpdnTunnelAttrTunnelId": { "type": "integer", "description": "The Tunnel ID of an active VPDN tunnel. If this end is the\n instigator of the tunnel, the ID is the TS tunnel ID,\n otherwise it is the NAS tunnel ID.\n \n Two distinct tunnels with the same tunnel ID may exist, but\n with different tunnel types.", "minimum": -2147483648, "maximum": 2147483647 }, "cvpdnTunnelAttrRemoteTunnelId": { "type": "integer", "description": "The remote Tunnel ID of an active VPDN tunnel. If this end\n is the instigator of the tunnel, the ID is the NAS tunnel\n ID, otherwise it is the TS tunnel ID.", "minimum": -2147483648, "maximum": 2147483647 }, "cvpdnTunnelAttrLocalName": { "type": "string", "description": "The local name of an active VPDN tunnel. It will be the\n NAS name of the tunnel if the system serves as the NAS, or\n the TS name of the tunnel if the system serves as the\n tunnel server. Typically, the local name is the configured\n host name of the system.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnTunnelAttrRemoteName": { "type": "string", "description": "The remote name of an active VPDN tunnel. It will be the\n tunnel server name of the tunnel if the system is a NAS,\n or the NAS name of the tunnel if the system serves as the\n tunnel server.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnTunnelAttrRemoteEndpointName": { "type": "string", "description": "The remote end point name of an active VPDN tunnel. This\n name is either the domain name or the DNIS that this tunnel\n is projected with.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnTunnelAttrLocalInitConnection": { "type": "boolean", "description": "This object indicates whether the tunnel was originated\n locally or not. If it's true, the tunnel was originated\n locally." }, "cvpdnTunnelAttrOrigCause": { "type": "string", "description": "The cause which originated an active VPDN tunnel. The\n tunnel can be projected via domain name, DNIS, stack group,\n or L2 Xconnect." }, "cvpdnTunnelAttrState": { "type": "string", "description": "The current state of an active VPDN tunnel.\n Tunnels of type l2f will have states with the 'l2f' prefix.\n Tunnels of type l2tp will have states with the 'l2tp'\n prefix.\n Tunnels of type pptp will have states with the 'pptp'\n prefix.\n \n Each state code is explained below:\n \n unknown: The current state of the tunnel is\n unknown.\n \n l2fOpening: The tunnel has just been initiated\n and is pending for a remote end\n reply to complete the process.\n \n l2fOpenWait: This end received a tunnel open\n request from the remote end and is\n waiting for the tunnel to be\n established.\n \n l2fOpen: The tunnel is active.\n \n l2fClosing: This end received a tunnel close\n request.\n \n l2fCloseWait: The tunnel has just been shut down\n and is pending for the remote end\n to reply to complete the process.\n \n l2tpIdle: No tunnel is initiated yet.\n \n l2tpWaitCtlReply: The tunnel has been initiated and\n is pending for a remote end reply\n to complete the process.\n \n l2tpEstablished: The tunnel is active.\n \n l2tpShuttingDown: The tunnel is in progress of\n shutting down.\n \n l2tpNoSessionLeft: There is no session left in the\n tunnel.\n \n pptpIdle: No tunnel is initiated yet.\n \n pptpWaitConnect: The tunnel is waiting for a TCP\n connection.\n \n pptpWaitCtlRequest: The tunnel has been initiated and\n is pending for a remote end\n request.\n \n pptpWaitCtlReply: The tunnel has been initiated and\n is pending for a remote end reply.\n \n pptpEstablished: The tunnel is active.\n \n pptpWaitStopReply: The tunnel is being shut down and\n is pending for a remote end reply.\n \n pptpTerminal: The tunnel has been shut down." }, "cvpdnTunnelAttrActiveSessions": { "type": "integer", "description": "The total number of active session currently in the\n tunnel.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelAttrDeniedUsers": { "type": "integer", "description": "A count of the accumulated total of denied users for the\n tunnel.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelAttrSoftshut": { "type": "boolean", "description": "A VPDN tunnel can be put into a soft shut state to prevent\n any new session to be added. This object specifies whether\n this tunnel has been soft shut. If its true, it has been\n soft shut." }, "cvpdnTunnelAttrNetworkServiceType": { "type": "string", "description": "The type of network service used in the active tunnel." }, "cvpdnTunnelAttrLocalIpAddress": { "type": "string", "description": "The local IP address of the tunnel. This IP address is\n that of the interface at the local end of the tunnel.", "format": "inet:ipv4-address" }, "cvpdnTunnelAttrSourceIpAddress": { "type": "string", "description": "The source IP address of the tunnel. This IP address is\n the user configurable IP address for Stack Group Biding\n Protocol.", "format": "inet:ipv4-address" }, "cvpdnTunnelAttrRemoteIpAddress": { "type": "string", "description": "The remote IP address of the tunnel. This IP address is\n that of the interface at the remote end of the tunnel.", "format": "inet:ipv4-address" }, "cvpdnTunnelAttrLocalInetAddressType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnTunnelAttrLocalInetAddress", "x-yang-type": "inet-address:InetAddressType" }, "cvpdnTunnelAttrLocalInetAddress": { "type": "string", "description": "The local IP address of the tunnel. This IP address is\n that of the interface at the local end of the tunnel.\n The type of this address is determined by the value of \n cvpdnTunnelAttrLocalInetAddressType.", "x-yang-type": "inet-address:InetAddress" }, "cvpdnTunnelAttrSourceInetAddressType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnTunnelAttrSourceInetAddress", "x-yang-type": "inet-address:InetAddressType" }, "cvpdnTunnelAttrSourceInetAddress": { "type": "string", "description": "The source IP address of the tunnel. This IP address is\n the user configurable IP address for Stack Group Biding\n Protocol. The type of this address is determined by the \n value of cvpdnTunnelAttrSourceInetAddressType.", "x-yang-type": "inet-address:InetAddress" }, "cvpdnTunnelAttrRemoteInetAddressType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnTunnelAttrRemoteInetAddress", "x-yang-type": "inet-address:InetAddressType" }, "cvpdnTunnelAttrRemoteInetAddress": { "type": "string", "description": "The remote IP address of the tunnel. This IP address is\n that of the interface at the remote end of the tunnel.\n The type of this address is determined by the value of \n cvpdnTunnelAttrRemoteInetAddressType.", "x-yang-type": "inet-address:InetAddress" } } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnTunnelAttrEntry": [ { "cvpdnSystemTunnelType": "ethernetCsmacd(6)", "cvpdnTunnelAttrTunnelId": -2147483648, "cvpdnTunnelAttrRemoteTunnelId": -2147483648, "cvpdnTunnelAttrLocalName": "interface-1", "cvpdnTunnelAttrRemoteName": "interface-1", "cvpdnTunnelAttrRemoteEndpointName": "interface-1", "cvpdnTunnelAttrLocalInitConnection": true, "cvpdnTunnelAttrOrigCause": "example-string", "cvpdnTunnelAttrState": "up(1)", "cvpdnTunnelAttrActiveSessions": 0, "cvpdnTunnelAttrDeniedUsers": 0, "cvpdnTunnelAttrSoftshut": true, "cvpdnTunnelAttrNetworkServiceType": "ethernetCsmacd(6)", "cvpdnTunnelAttrLocalIpAddress": "192.168.1.1", "cvpdnTunnelAttrSourceIpAddress": "192.168.1.1", "cvpdnTunnelAttrRemoteIpAddress": "192.168.1.1", "cvpdnTunnelAttrLocalInetAddressType": "192.168.1.1", "cvpdnTunnelAttrLocalInetAddress": "192.168.1.1", "cvpdnTunnelAttrSourceInetAddressType": "192.168.1.1", "cvpdnTunnelAttrSourceInetAddress": "192.168.1.1", "cvpdnTunnelAttrRemoteInetAddressType": "192.168.1.1", "cvpdnTunnelAttrRemoteInetAddress": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnTunnelAttrEntry", "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": "/cvpdnTunnelAttrTable/cvpdnTunnelAttrEntry", "x-restconf-kind": "container" }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnTunnelSessionTable": { "get": { "summary": "Get cvpdnTunnelSessionTable data", "description": "Retrieve cvpdnTunnelSessionTable operational data from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "Table of information about individual user sessions\n within the active tunnels. Entry is added to the table\n when new user session is initiated and be removed from\n the table when the user session is terminated.", "properties": { "cvpdnTunnelSessionEntry": { "type": "array", "description": "An entry in the table, containing information about a\n single user session within the tunnel.", "items": { "type": "object", "properties": { "cvpdnTunnelTunnelId": { "type": "string", "description": "cvpdnTunnelTunnelId", "x-yang-type": "leafref" }, "cvpdnTunnelSessionId": { "type": "integer", "description": "The ID of an active VPDN tunnel user session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionUserName": { "type": "string", "description": "The name of the user of the user session.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnTunnelSessionState": { "type": "string", "description": "The current state of an active user session. Each state\n code is explained below:\n \n unknown: The current state of the tunnel's\n session is unknown.\n \n opening: The user session has just been\n initiated through a tunnel and is\n pending for the remote end reply\n to complete the process.\n \n open: The user session is active.\n \n closing: The user session has just been\n closed and is pending for the\n remote end reply to complete the\n process.\n \n waitingForTunnel: The user session is in this state\n when the tunnel which this session\n is going through is still in\n CLOSED state. It waits for the\n tunnel to become OPEN before the\n session is allow to be fully\n established." }, "cvpdnTunnelSessionCallDuration": { "type": "string", "description": "This object specifies the call duration of the current\n active user session in value of system uptime.", "x-yang-type": "yang:timeticks" }, "cvpdnTunnelSessionPacketsOut": { "type": "integer", "description": "The total number of output packets through this active\n user session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionBytesOut": { "type": "integer", "description": "The total number of output bytes through this active\n user session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionPacketsIn": { "type": "integer", "description": "The total number of input packets through this active\n user session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionBytesIn": { "type": "integer", "description": "The total number of input bytes through this active\n user session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionDeviceType": { "type": "string", "description": "The type of physical devices that this user session\n is attached to for the local end of the tunnel. The\n meaning of each device type is explained below:\n \n other: Any device that has not been\n defined.\n \n asyncInternalModem: Modem Pool device of an access\n server.\n \n async: A regular asynchronous serial\n interface.\n \n sync: A regular synchronous serial\n interface.\n \n bchan: An ISDN call.\n \n xdsl: Future application with xDSL\n devices.\n \n cable: Future application with Cable\n modem devices." }, "cvpdnTunnelSessionDeviceCallerId": { "type": "string", "description": "The incoming caller identification of the user. It is\n the originating number that called into the device that\n initiates the user session. This object can be empty\n since not all dial device can provide caller ID\n information.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnTunnelSessionDevicePhyId": { "type": "string", "description": "The device ID of the physical interface for the user\n session. The object is the the interface index which\n points to the ifTable. For virtual interface that is\n not in the ifTable, it will have zero value.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "cvpdnTunnelSessionMultilink": { "type": "boolean", "description": "This object indicates whether the session is part of a\n multilink or not." }, "cvpdnTunnelSessionModemSlotIndex": { "type": "integer", "description": "The Modem Pool database slot index if it is associated\n with this user session. Only a session with device of\n type asyncInternalModem will have a valid value for\n this object.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionModemPortIndex": { "type": "integer", "description": "The Modem Pool database port index if it is associated\n with this user session. Only a session with a device\n of type asyncInternalModem will have a valid value for\n this object.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionDS1SlotIndex": { "type": "integer", "description": "The DS1 database slot index if it is associated with\n this user session. Only a session with a device of\n type asyncInternalModem will have a valid value for\n this object.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionDS1PortIndex": { "type": "integer", "description": "The DS1 database port index if it is associated with\n this user session. Only a session with a device of\n type asyncInternalModem will have a a valid value for\n this object.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionDS1ChannelIndex": { "type": "integer", "description": "The DS1 database channel index if it is associated with\n this user session. Only a session over a device of\n type asyncInternalModem will have a valid value for\n this object.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionModemCallStartTime": { "type": "string", "description": "The start time of the current modem call. Only a\n session with a device of type asyncInternalModem will\n have a valid value for this object.", "x-yang-type": "yang:timestamp" }, "cvpdnTunnelSessionModemCallStartIndex": { "type": "integer", "description": "Arbitrary small integer to distinguish modem calls that\n occurred at the same time tick. Only session over\n device asyncInternalModem will have a valid value for\n this object.", "minimum": 0, "maximum": 4294967295 } } } } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnTunnelSessionTable": { "cvpdnTunnelSessionEntry": [ { "cvpdnTunnelTunnelId": "example-string", "cvpdnTunnelSessionId": 0, "cvpdnTunnelSessionUserName": "interface-1", "cvpdnTunnelSessionState": "up(1)", "cvpdnTunnelSessionCallDuration": "example-string", "cvpdnTunnelSessionPacketsOut": 1234567890, "cvpdnTunnelSessionBytesOut": 0, "cvpdnTunnelSessionPacketsIn": 1234567890, "cvpdnTunnelSessionBytesIn": 0, "cvpdnTunnelSessionDeviceType": "ethernetCsmacd(6)", "cvpdnTunnelSessionDeviceCallerId": "example-string", "cvpdnTunnelSessionDevicePhyId": "example-string", "cvpdnTunnelSessionMultilink": true, "cvpdnTunnelSessionModemSlotIndex": 1, "cvpdnTunnelSessionModemPortIndex": 1, "cvpdnTunnelSessionDS1SlotIndex": 1, "cvpdnTunnelSessionDS1PortIndex": 1, "cvpdnTunnelSessionDS1ChannelIndex": 1, "cvpdnTunnelSessionModemCallStartTime": "example-string", "cvpdnTunnelSessionModemCallStartIndex": 1 }, { "cvpdnTunnelTunnelId": "example-string", "cvpdnTunnelSessionId": 0, "cvpdnTunnelSessionUserName": "interface-1", "cvpdnTunnelSessionState": "up(1)", "cvpdnTunnelSessionCallDuration": "example-string", "cvpdnTunnelSessionPacketsOut": 1234567890, "cvpdnTunnelSessionBytesOut": 0, "cvpdnTunnelSessionPacketsIn": 1234567890, "cvpdnTunnelSessionBytesIn": 0, "cvpdnTunnelSessionDeviceType": "ethernetCsmacd(6)", "cvpdnTunnelSessionDeviceCallerId": "example-string", "cvpdnTunnelSessionDevicePhyId": "example-string", "cvpdnTunnelSessionMultilink": true, "cvpdnTunnelSessionModemSlotIndex": 2, "cvpdnTunnelSessionModemPortIndex": 2, "cvpdnTunnelSessionDS1SlotIndex": 2, "cvpdnTunnelSessionDS1PortIndex": 2, "cvpdnTunnelSessionDS1ChannelIndex": 2, "cvpdnTunnelSessionModemCallStartTime": "example-string", "cvpdnTunnelSessionModemCallStartIndex": 2 }, { "cvpdnTunnelTunnelId": "example-string", "cvpdnTunnelSessionId": 0, "cvpdnTunnelSessionUserName": "interface-1", "cvpdnTunnelSessionState": "up(1)", "cvpdnTunnelSessionCallDuration": "example-string", "cvpdnTunnelSessionPacketsOut": 1234567890, "cvpdnTunnelSessionBytesOut": 0, "cvpdnTunnelSessionPacketsIn": 1234567890, "cvpdnTunnelSessionBytesIn": 0, "cvpdnTunnelSessionDeviceType": "ethernetCsmacd(6)", "cvpdnTunnelSessionDeviceCallerId": "example-string", "cvpdnTunnelSessionDevicePhyId": "example-string", "cvpdnTunnelSessionMultilink": true, "cvpdnTunnelSessionModemSlotIndex": 3, "cvpdnTunnelSessionModemPortIndex": 3, "cvpdnTunnelSessionDS1SlotIndex": 3, "cvpdnTunnelSessionDS1PortIndex": 3, "cvpdnTunnelSessionDS1ChannelIndex": 3, "cvpdnTunnelSessionModemCallStartTime": "example-string", "cvpdnTunnelSessionModemCallStartIndex": 3 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnTunnelSessionTable", "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": "/cvpdnTunnelSessionTable", "x-restconf-kind": "container" }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnTunnelSessionTable/cvpdnTunnelSessionEntry": { "get": { "summary": "Get cvpdnTunnelSessionEntry list", "description": "Retrieve list of cvpdnTunnelSessionEntry entries from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in the table, containing information about a\n single user session within the tunnel.", "items": { "type": "object", "properties": { "cvpdnTunnelTunnelId": { "type": "string", "description": "cvpdnTunnelTunnelId", "x-yang-type": "leafref" }, "cvpdnTunnelSessionId": { "type": "integer", "description": "The ID of an active VPDN tunnel user session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionUserName": { "type": "string", "description": "The name of the user of the user session.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnTunnelSessionState": { "type": "string", "description": "The current state of an active user session. Each state\n code is explained below:\n \n unknown: The current state of the tunnel's\n session is unknown.\n \n opening: The user session has just been\n initiated through a tunnel and is\n pending for the remote end reply\n to complete the process.\n \n open: The user session is active.\n \n closing: The user session has just been\n closed and is pending for the\n remote end reply to complete the\n process.\n \n waitingForTunnel: The user session is in this state\n when the tunnel which this session\n is going through is still in\n CLOSED state. It waits for the\n tunnel to become OPEN before the\n session is allow to be fully\n established." }, "cvpdnTunnelSessionCallDuration": { "type": "string", "description": "This object specifies the call duration of the current\n active user session in value of system uptime.", "x-yang-type": "yang:timeticks" }, "cvpdnTunnelSessionPacketsOut": { "type": "integer", "description": "The total number of output packets through this active\n user session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionBytesOut": { "type": "integer", "description": "The total number of output bytes through this active\n user session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionPacketsIn": { "type": "integer", "description": "The total number of input packets through this active\n user session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionBytesIn": { "type": "integer", "description": "The total number of input bytes through this active\n user session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionDeviceType": { "type": "string", "description": "The type of physical devices that this user session\n is attached to for the local end of the tunnel. The\n meaning of each device type is explained below:\n \n other: Any device that has not been\n defined.\n \n asyncInternalModem: Modem Pool device of an access\n server.\n \n async: A regular asynchronous serial\n interface.\n \n sync: A regular synchronous serial\n interface.\n \n bchan: An ISDN call.\n \n xdsl: Future application with xDSL\n devices.\n \n cable: Future application with Cable\n modem devices." }, "cvpdnTunnelSessionDeviceCallerId": { "type": "string", "description": "The incoming caller identification of the user. It is\n the originating number that called into the device that\n initiates the user session. This object can be empty\n since not all dial device can provide caller ID\n information.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnTunnelSessionDevicePhyId": { "type": "string", "description": "The device ID of the physical interface for the user\n session. The object is the the interface index which\n points to the ifTable. For virtual interface that is\n not in the ifTable, it will have zero value.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "cvpdnTunnelSessionMultilink": { "type": "boolean", "description": "This object indicates whether the session is part of a\n multilink or not." }, "cvpdnTunnelSessionModemSlotIndex": { "type": "integer", "description": "The Modem Pool database slot index if it is associated\n with this user session. Only a session with device of\n type asyncInternalModem will have a valid value for\n this object.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionModemPortIndex": { "type": "integer", "description": "The Modem Pool database port index if it is associated\n with this user session. Only a session with a device\n of type asyncInternalModem will have a valid value for\n this object.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionDS1SlotIndex": { "type": "integer", "description": "The DS1 database slot index if it is associated with\n this user session. Only a session with a device of\n type asyncInternalModem will have a valid value for\n this object.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionDS1PortIndex": { "type": "integer", "description": "The DS1 database port index if it is associated with\n this user session. Only a session with a device of\n type asyncInternalModem will have a a valid value for\n this object.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionDS1ChannelIndex": { "type": "integer", "description": "The DS1 database channel index if it is associated with\n this user session. Only a session over a device of\n type asyncInternalModem will have a valid value for\n this object.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionModemCallStartTime": { "type": "string", "description": "The start time of the current modem call. Only a\n session with a device of type asyncInternalModem will\n have a valid value for this object.", "x-yang-type": "yang:timestamp" }, "cvpdnTunnelSessionModemCallStartIndex": { "type": "integer", "description": "Arbitrary small integer to distinguish modem calls that\n occurred at the same time tick. Only session over\n device asyncInternalModem will have a valid value for\n this object.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnTunnelSessionEntry": [ { "cvpdnTunnelTunnelId": "example-string", "cvpdnTunnelSessionId": 0, "cvpdnTunnelSessionUserName": "interface-1", "cvpdnTunnelSessionState": "up(1)", "cvpdnTunnelSessionCallDuration": "example-string", "cvpdnTunnelSessionPacketsOut": 1234567890, "cvpdnTunnelSessionBytesOut": 0, "cvpdnTunnelSessionPacketsIn": 1234567890, "cvpdnTunnelSessionBytesIn": 0, "cvpdnTunnelSessionDeviceType": "ethernetCsmacd(6)", "cvpdnTunnelSessionDeviceCallerId": "example-string", "cvpdnTunnelSessionDevicePhyId": "example-string", "cvpdnTunnelSessionMultilink": true, "cvpdnTunnelSessionModemSlotIndex": 1, "cvpdnTunnelSessionModemPortIndex": 1, "cvpdnTunnelSessionDS1SlotIndex": 1, "cvpdnTunnelSessionDS1PortIndex": 1, "cvpdnTunnelSessionDS1ChannelIndex": 1, "cvpdnTunnelSessionModemCallStartTime": "example-string", "cvpdnTunnelSessionModemCallStartIndex": 1 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnTunnelSessionEntry", "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": "/cvpdnTunnelSessionTable/cvpdnTunnelSessionEntry", "x-restconf-kind": "container" }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnSessionAttrTable": { "get": { "summary": "Get cvpdnSessionAttrTable data", "description": "Retrieve cvpdnSessionAttrTable operational data from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "Table of information about individual sessions within the\n active tunnels. An entry is added to the table when a new\n session is initiated and removed from the table when the\n session is terminated.", "properties": { "cvpdnSessionAttrEntry": { "type": "array", "description": "An entry in the table, containing information about a\n single session within the tunnel.", "items": { "type": "object", "properties": { "cvpdnSystemTunnelType": { "type": "string", "description": "cvpdnSystemTunnelType", "x-yang-type": "leafref" }, "cvpdnTunnelAttrTunnelId": { "type": "string", "description": "cvpdnTunnelAttrTunnelId", "x-yang-type": "leafref" }, "cvpdnSessionAttrSessionId": { "type": "integer", "description": "The ID of an active VPDN session.", "minimum": -2147483648, "maximum": 2147483647 }, "cvpdnSessionAttrUserName": { "type": "string", "description": "The name of the user of the session.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnSessionAttrState": { "type": "string", "description": "The current state of a tunnel session.\n L2F tunnel sessions will have states with the 'l2f' prefix.\n L2TP tunnel sessions will have states with the 'l2tp'\n prefix.\n \n Each state code is explained below:\n \n unknown: The current state of the tunnel's\n session is unknown.\n \n l2fOpening: The session has just been\n initiated through a tunnel and is\n pending for the remote end reply\n to complete the process.\n \n l2fOpen: The session is active.\n \n l2fCloseWait: The session has just been closed\n and is pending for the remote end\n reply to complete the process.\n \n l2fWaitingForTunnel: The session is in this state when\n the tunnel which this session is\n going through is still in CLOSED\n state. It waits for the tunnel to\n become OPEN before the session is\n allowed to be fully established.\n \n l2tpIdle: No session is initiated yet.\n \n l2tpWaitingTunnel: The session is waiting for the\n tunnel to be established.\n \n l2tpWaitReply: The session has been initiated and\n is pending for the remote end\n reply to complete the process.\n \n l2tpWaitConnect: This end has acknowledged a\n connection request and is waiting\n for the remote end to connect.\n \n l2tpEstablished: The session is active.\n \n l2tpShuttingDown: The session is in progress of\n shutting down.\n \n pptpWaitVAccess: The session is waiting for the\n creation of a virtual access\n interface.\n \n pptpPacEstablished: The session is active.\n \n pptpWaitTunnel: The session is waiting for the\n tunnel to be established.\n \n pptpWaitOCRP: The session has been initiated and\n is pending for the remote end\n reply to complete the process.\n \n pptpPnsEstablished: The session is active.\n \n pptpWaitCallDisc: Session shutdown is in progress." }, "cvpdnSessionAttrCallDuration": { "type": "string", "description": "This object specifies the call duration of the current\n active session.", "x-yang-type": "yang:timeticks" }, "cvpdnSessionAttrPacketsOut": { "type": "integer", "description": "The total number of output packets through this active\n session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrBytesOut": { "type": "integer", "description": "The total number of output bytes through this active\n session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrPacketsIn": { "type": "integer", "description": "The total number of input packets through this active\n session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrBytesIn": { "type": "integer", "description": "The total number of input bytes through this active\n session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrDeviceType": { "type": "string", "description": "The type of physical devices that this session is attached\n to for the local end of the tunnel. The meaning of each\n device type is explained below:\n \n other: Any device that has not been\n defined.\n \n asyncInternalModem: Modem Pool device of an access\n server.\n \n async: A regular asynchronous serial\n interface.\n \n sync: A regular synchronous serial\n interface.\n \n bchan: An ISDN call.\n \n xdsl: xDSL interface.\n \n cable: cable modem interface." }, "cvpdnSessionAttrDeviceCallerId": { "type": "string", "description": "The incoming caller identification of the user. It is the\n originating number that called into the device that\n initiates the session. This object can be empty since not\n all dial devices can provide caller ID information.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnSessionAttrDevicePhyId": { "type": "string", "description": "The device ID of the physical interface for the session.\n The object is the the interface index which points to the\n ifTable. For virtual interfaces that are not in the\n ifTable, the value will be zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "cvpdnSessionAttrMultilink": { "type": "boolean", "description": "This object indicates whether the session is part of a\n multilink PPP bundle, even if there is only one link or\n session in the bundle. If it is multilink PPP, the value\n is true." }, "cvpdnSessionAttrModemSlotIndex": { "type": "integer", "description": "The Modem Pool database slot index if it is associated with\n this session. Only a session with device of type\n 'asyncInternalModem' will have a valid value for this\n object; otherwise, it is not instantiated.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrModemPortIndex": { "type": "integer", "description": "The Modem Pool database port index if it is associated with\n this session. Only a session with a device of type\n 'asyncInternalModem' will have a valid value for this\n object; otherwise, it is not instantiated.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrDS1SlotIndex": { "type": "integer", "description": "The DS1 database slot index if it is associated with this\n session. Only a session with a device of type\n 'asyncInternalModem' will have a valid value for this\n object; otherwise it is not instantiated.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrDS1PortIndex": { "type": "integer", "description": "The DS1 database port index if it is associated with this\n session. Only a session with a device of type\n 'asyncInternalModem' will have a valid value for this\n object; otherwise it is not instantiated.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrDS1ChannelIndex": { "type": "integer", "description": "The DS1 database channel index if it is associated with\n this session. Only a session over a device of type\n 'asyncInternalModem' will have a valid value for this\n object; otherwise it is not instantiated.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrModemCallStartTime": { "type": "string", "description": "The start time of the current modem call. Only a session\n with a device of type 'asyncInternalModem' will have a\n valid value for this object; otherwise, it is not\n instantiated.", "x-yang-type": "yang:timestamp" }, "cvpdnSessionAttrModemCallStartIndex": { "type": "integer", "description": "Arbitrary small integer to distinguish modem calls that\n occurred at the same time tick. Only session over device\n 'asyncInternalModem' will have a valid value for this\n object; otherwise, it is not instantiated.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrVirtualCircuitID": { "type": "integer", "description": "The virtual circuit ID of an active Layer 2 VPN session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrSentPktsDropped": { "type": "integer", "description": "The total number of dropped packets that could not be sent\n into this active session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrRecvPktsDropped": { "type": "integer", "description": "The total number of dropped packets that were received from\n this active session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrMultilinkBundle": { "type": "string", "description": "This object specifies the name of the multilink bundle to\n which this session belongs. The value of this object is\n only valid when the value of cvpdnSessionAttrMultilink is\n 'true'. If the value of cvpdnSessionAttrMultilink is\n 'false', then the value of this object will be the empty\n string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cvpdnSessionAttrMultilinkIfIndex": { "type": "string", "description": "This object specifies the ifIndex of the multilink bundle\n to which this session belongs. The value of this object is\n only valid when the value of cvpdnSessionAttrMultilink is\n 'true'. If the value of cvpdnSessionAttrMultilink is\n 'false', then the value of this object will be zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero" } } } } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnSessionAttrTable": { "cvpdnSessionAttrEntry": [ { "cvpdnSystemTunnelType": "ethernetCsmacd(6)", "cvpdnTunnelAttrTunnelId": "example-string", "cvpdnSessionAttrSessionId": -2147483648, "cvpdnSessionAttrUserName": "interface-1", "cvpdnSessionAttrState": "up(1)", "cvpdnSessionAttrCallDuration": "example-string", "cvpdnSessionAttrPacketsOut": 1234567890, "cvpdnSessionAttrBytesOut": 0, "cvpdnSessionAttrPacketsIn": 1234567890, "cvpdnSessionAttrBytesIn": 0, "cvpdnSessionAttrDeviceType": "ethernetCsmacd(6)", "cvpdnSessionAttrDeviceCallerId": "example-string", "cvpdnSessionAttrDevicePhyId": "example-string", "cvpdnSessionAttrMultilink": true, "cvpdnSessionAttrModemSlotIndex": 1, "cvpdnSessionAttrModemPortIndex": 1, "cvpdnSessionAttrDS1SlotIndex": 1, "cvpdnSessionAttrDS1PortIndex": 1, "cvpdnSessionAttrDS1ChannelIndex": 1, "cvpdnSessionAttrModemCallStartTime": "example-string", "cvpdnSessionAttrModemCallStartIndex": 1, "cvpdnSessionAttrVirtualCircuitID": 0, "cvpdnSessionAttrSentPktsDropped": 0, "cvpdnSessionAttrRecvPktsDropped": 0, "cvpdnSessionAttrMultilinkBundle": "example-string", "cvpdnSessionAttrMultilinkIfIndex": "1" }, { "cvpdnSystemTunnelType": "ethernetCsmacd(6)", "cvpdnTunnelAttrTunnelId": "example-string", "cvpdnSessionAttrSessionId": -2147483648, "cvpdnSessionAttrUserName": "interface-1", "cvpdnSessionAttrState": "up(1)", "cvpdnSessionAttrCallDuration": "example-string", "cvpdnSessionAttrPacketsOut": 1234567890, "cvpdnSessionAttrBytesOut": 0, "cvpdnSessionAttrPacketsIn": 1234567890, "cvpdnSessionAttrBytesIn": 0, "cvpdnSessionAttrDeviceType": "ethernetCsmacd(6)", "cvpdnSessionAttrDeviceCallerId": "example-string", "cvpdnSessionAttrDevicePhyId": "example-string", "cvpdnSessionAttrMultilink": true, "cvpdnSessionAttrModemSlotIndex": 2, "cvpdnSessionAttrModemPortIndex": 2, "cvpdnSessionAttrDS1SlotIndex": 2, "cvpdnSessionAttrDS1PortIndex": 2, "cvpdnSessionAttrDS1ChannelIndex": 2, "cvpdnSessionAttrModemCallStartTime": "example-string", "cvpdnSessionAttrModemCallStartIndex": 2, "cvpdnSessionAttrVirtualCircuitID": 0, "cvpdnSessionAttrSentPktsDropped": 0, "cvpdnSessionAttrRecvPktsDropped": 0, "cvpdnSessionAttrMultilinkBundle": "example-string", "cvpdnSessionAttrMultilinkIfIndex": "2" }, { "cvpdnSystemTunnelType": "ethernetCsmacd(6)", "cvpdnTunnelAttrTunnelId": "example-string", "cvpdnSessionAttrSessionId": -2147483648, "cvpdnSessionAttrUserName": "interface-1", "cvpdnSessionAttrState": "up(1)", "cvpdnSessionAttrCallDuration": "example-string", "cvpdnSessionAttrPacketsOut": 1234567890, "cvpdnSessionAttrBytesOut": 0, "cvpdnSessionAttrPacketsIn": 1234567890, "cvpdnSessionAttrBytesIn": 0, "cvpdnSessionAttrDeviceType": "ethernetCsmacd(6)", "cvpdnSessionAttrDeviceCallerId": "example-string", "cvpdnSessionAttrDevicePhyId": "example-string", "cvpdnSessionAttrMultilink": true, "cvpdnSessionAttrModemSlotIndex": 3, "cvpdnSessionAttrModemPortIndex": 3, "cvpdnSessionAttrDS1SlotIndex": 3, "cvpdnSessionAttrDS1PortIndex": 3, "cvpdnSessionAttrDS1ChannelIndex": 3, "cvpdnSessionAttrModemCallStartTime": "example-string", "cvpdnSessionAttrModemCallStartIndex": 3, "cvpdnSessionAttrVirtualCircuitID": 0, "cvpdnSessionAttrSentPktsDropped": 0, "cvpdnSessionAttrRecvPktsDropped": 0, "cvpdnSessionAttrMultilinkBundle": "example-string", "cvpdnSessionAttrMultilinkIfIndex": "3" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnSessionAttrTable", "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": "/cvpdnSessionAttrTable", "x-restconf-kind": "container" }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnSessionAttrTable/cvpdnSessionAttrEntry": { "get": { "summary": "Get cvpdnSessionAttrEntry list", "description": "Retrieve list of cvpdnSessionAttrEntry entries from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in the table, containing information about a\n single session within the tunnel.", "items": { "type": "object", "properties": { "cvpdnSystemTunnelType": { "type": "string", "description": "cvpdnSystemTunnelType", "x-yang-type": "leafref" }, "cvpdnTunnelAttrTunnelId": { "type": "string", "description": "cvpdnTunnelAttrTunnelId", "x-yang-type": "leafref" }, "cvpdnSessionAttrSessionId": { "type": "integer", "description": "The ID of an active VPDN session.", "minimum": -2147483648, "maximum": 2147483647 }, "cvpdnSessionAttrUserName": { "type": "string", "description": "The name of the user of the session.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnSessionAttrState": { "type": "string", "description": "The current state of a tunnel session.\n L2F tunnel sessions will have states with the 'l2f' prefix.\n L2TP tunnel sessions will have states with the 'l2tp'\n prefix.\n \n Each state code is explained below:\n \n unknown: The current state of the tunnel's\n session is unknown.\n \n l2fOpening: The session has just been\n initiated through a tunnel and is\n pending for the remote end reply\n to complete the process.\n \n l2fOpen: The session is active.\n \n l2fCloseWait: The session has just been closed\n and is pending for the remote end\n reply to complete the process.\n \n l2fWaitingForTunnel: The session is in this state when\n the tunnel which this session is\n going through is still in CLOSED\n state. It waits for the tunnel to\n become OPEN before the session is\n allowed to be fully established.\n \n l2tpIdle: No session is initiated yet.\n \n l2tpWaitingTunnel: The session is waiting for the\n tunnel to be established.\n \n l2tpWaitReply: The session has been initiated and\n is pending for the remote end\n reply to complete the process.\n \n l2tpWaitConnect: This end has acknowledged a\n connection request and is waiting\n for the remote end to connect.\n \n l2tpEstablished: The session is active.\n \n l2tpShuttingDown: The session is in progress of\n shutting down.\n \n pptpWaitVAccess: The session is waiting for the\n creation of a virtual access\n interface.\n \n pptpPacEstablished: The session is active.\n \n pptpWaitTunnel: The session is waiting for the\n tunnel to be established.\n \n pptpWaitOCRP: The session has been initiated and\n is pending for the remote end\n reply to complete the process.\n \n pptpPnsEstablished: The session is active.\n \n pptpWaitCallDisc: Session shutdown is in progress." }, "cvpdnSessionAttrCallDuration": { "type": "string", "description": "This object specifies the call duration of the current\n active session.", "x-yang-type": "yang:timeticks" }, "cvpdnSessionAttrPacketsOut": { "type": "integer", "description": "The total number of output packets through this active\n session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrBytesOut": { "type": "integer", "description": "The total number of output bytes through this active\n session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrPacketsIn": { "type": "integer", "description": "The total number of input packets through this active\n session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrBytesIn": { "type": "integer", "description": "The total number of input bytes through this active\n session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrDeviceType": { "type": "string", "description": "The type of physical devices that this session is attached\n to for the local end of the tunnel. The meaning of each\n device type is explained below:\n \n other: Any device that has not been\n defined.\n \n asyncInternalModem: Modem Pool device of an access\n server.\n \n async: A regular asynchronous serial\n interface.\n \n sync: A regular synchronous serial\n interface.\n \n bchan: An ISDN call.\n \n xdsl: xDSL interface.\n \n cable: cable modem interface." }, "cvpdnSessionAttrDeviceCallerId": { "type": "string", "description": "The incoming caller identification of the user. It is the\n originating number that called into the device that\n initiates the session. This object can be empty since not\n all dial devices can provide caller ID information.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnSessionAttrDevicePhyId": { "type": "string", "description": "The device ID of the physical interface for the session.\n The object is the the interface index which points to the\n ifTable. For virtual interfaces that are not in the\n ifTable, the value will be zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "cvpdnSessionAttrMultilink": { "type": "boolean", "description": "This object indicates whether the session is part of a\n multilink PPP bundle, even if there is only one link or\n session in the bundle. If it is multilink PPP, the value\n is true." }, "cvpdnSessionAttrModemSlotIndex": { "type": "integer", "description": "The Modem Pool database slot index if it is associated with\n this session. Only a session with device of type\n 'asyncInternalModem' will have a valid value for this\n object; otherwise, it is not instantiated.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrModemPortIndex": { "type": "integer", "description": "The Modem Pool database port index if it is associated with\n this session. Only a session with a device of type\n 'asyncInternalModem' will have a valid value for this\n object; otherwise, it is not instantiated.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrDS1SlotIndex": { "type": "integer", "description": "The DS1 database slot index if it is associated with this\n session. Only a session with a device of type\n 'asyncInternalModem' will have a valid value for this\n object; otherwise it is not instantiated.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrDS1PortIndex": { "type": "integer", "description": "The DS1 database port index if it is associated with this\n session. Only a session with a device of type\n 'asyncInternalModem' will have a valid value for this\n object; otherwise it is not instantiated.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrDS1ChannelIndex": { "type": "integer", "description": "The DS1 database channel index if it is associated with\n this session. Only a session over a device of type\n 'asyncInternalModem' will have a valid value for this\n object; otherwise it is not instantiated.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrModemCallStartTime": { "type": "string", "description": "The start time of the current modem call. Only a session\n with a device of type 'asyncInternalModem' will have a\n valid value for this object; otherwise, it is not\n instantiated.", "x-yang-type": "yang:timestamp" }, "cvpdnSessionAttrModemCallStartIndex": { "type": "integer", "description": "Arbitrary small integer to distinguish modem calls that\n occurred at the same time tick. Only session over device\n 'asyncInternalModem' will have a valid value for this\n object; otherwise, it is not instantiated.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrVirtualCircuitID": { "type": "integer", "description": "The virtual circuit ID of an active Layer 2 VPN session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrSentPktsDropped": { "type": "integer", "description": "The total number of dropped packets that could not be sent\n into this active session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrRecvPktsDropped": { "type": "integer", "description": "The total number of dropped packets that were received from\n this active session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrMultilinkBundle": { "type": "string", "description": "This object specifies the name of the multilink bundle to\n which this session belongs. The value of this object is\n only valid when the value of cvpdnSessionAttrMultilink is\n 'true'. If the value of cvpdnSessionAttrMultilink is\n 'false', then the value of this object will be the empty\n string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cvpdnSessionAttrMultilinkIfIndex": { "type": "string", "description": "This object specifies the ifIndex of the multilink bundle\n to which this session belongs. The value of this object is\n only valid when the value of cvpdnSessionAttrMultilink is\n 'true'. If the value of cvpdnSessionAttrMultilink is\n 'false', then the value of this object will be zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero" } } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnSessionAttrEntry": [ { "cvpdnSystemTunnelType": "ethernetCsmacd(6)", "cvpdnTunnelAttrTunnelId": "example-string", "cvpdnSessionAttrSessionId": -2147483648, "cvpdnSessionAttrUserName": "interface-1", "cvpdnSessionAttrState": "up(1)", "cvpdnSessionAttrCallDuration": "example-string", "cvpdnSessionAttrPacketsOut": 1234567890, "cvpdnSessionAttrBytesOut": 0, "cvpdnSessionAttrPacketsIn": 1234567890, "cvpdnSessionAttrBytesIn": 0, "cvpdnSessionAttrDeviceType": "ethernetCsmacd(6)", "cvpdnSessionAttrDeviceCallerId": "example-string", "cvpdnSessionAttrDevicePhyId": "example-string", "cvpdnSessionAttrMultilink": true, "cvpdnSessionAttrModemSlotIndex": 1, "cvpdnSessionAttrModemPortIndex": 1, "cvpdnSessionAttrDS1SlotIndex": 1, "cvpdnSessionAttrDS1PortIndex": 1, "cvpdnSessionAttrDS1ChannelIndex": 1, "cvpdnSessionAttrModemCallStartTime": "example-string", "cvpdnSessionAttrModemCallStartIndex": 1, "cvpdnSessionAttrVirtualCircuitID": 0, "cvpdnSessionAttrSentPktsDropped": 0, "cvpdnSessionAttrRecvPktsDropped": 0, "cvpdnSessionAttrMultilinkBundle": "example-string", "cvpdnSessionAttrMultilinkIfIndex": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnSessionAttrEntry", "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": "/cvpdnSessionAttrTable/cvpdnSessionAttrEntry", "x-restconf-kind": "container" }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnUserToFailHistInfoTable": { "get": { "summary": "Get cvpdnUserToFailHistInfoTable data", "description": "Retrieve cvpdnUserToFailHistInfoTable operational data from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "Table of the record of failure objects which can be\n referenced by an user name. Only a name that has a\n valid item in the Cisco IOS VPDN failure history table\n will yield a valid entry in this table. The table has\n a maximum size of 50 entries. Only the newest 50\n entries will be kept in the table.", "properties": { "cvpdnUserToFailHistInfoEntry": { "type": "array", "description": "An entry in the table, containing failure history\n relevant to an user name.", "items": { "type": "object", "properties": { "cvpdnUnameToFailHistUname": { "type": "string", "description": "The user name for this failure entry.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnUnameToFailHistTunnelId": { "type": "integer", "description": "The Tunnel ID for this failure entry. If it is the\n instigator of the tunnel, the ID is the TS tunnel ID,\n otherwise it is the NAS tunnel ID.", "minimum": 0, "maximum": 4294967295 }, "cvpdnUnameToFailHistUserId": { "type": "integer", "description": "The user ID of this failure entry.", "minimum": 0, "maximum": 4294967295 }, "cvpdnUnameToFailHistLocalInitConn": { "type": "boolean", "description": "This object indicates whether the tunnel in which the\n failure occurred was generated locally or not." }, "cvpdnUnameToFailHistLocalName": { "type": "string", "description": "The local name of the VPDN tunnel in which the failure\n occurred. It will be the NAS name of the tunnel if the\n system serves as the NAS, or the TS name of the tunnel\n if the system serves as the tunnel server. The local\n name is the configured host name of the system. This\n object can be empty if the failure occurred prior to\n successful tunnel projection, thus no source name will\n be available.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnUnameToFailHistRemoteName": { "type": "string", "description": "The remote name of the VPDN tunnel in which the failure\n occurred. It will be the tunnel server name of the\n tunnel if the system is a NAS, or the NAS name of the\n tunnel if the system serves as the tunnel server. This\n object can be empty if the failure occurred prior to\n successful tunnel projection, thus no source name will\n be available.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnUnameToFailHistSourceIp": { "type": "string", "description": "The source IP address of the tunnel in which the\n failure occurred. This IP address is that of the\n interface at the instigator end of the tunnel.", "format": "inet:ipv4-address" }, "cvpdnUnameToFailHistDestIp": { "type": "string", "description": "The destination IP address of the tunnel in which the\n failure occurred. This IP address is that of the\n interface at the receiver end of the tunnel.", "format": "inet:ipv4-address" }, "cvpdnUnameToFailHistCount": { "type": "integer", "description": "This object is incremented when multiple failures has\n been experienced by this user on this tunnel. Seeing a\n delta of >1 is an indication that the current failure\n record is the latest of a series of failures that has\n been recorded.", "minimum": 0, "maximum": 4294967295 }, "cvpdnUnameToFailHistFailTime": { "type": "string", "description": "This object specifies the time when the failure is\n occurred.", "x-yang-type": "yang:timestamp" }, "cvpdnUnameToFailHistFailType": { "type": "string", "description": "The type of failure for the current failure record. It\n comes in a form of a an ASCII string which describes\n the type of failure.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnUnameToFailHistFailReason": { "type": "string", "description": "The reason of failure for the current failure record.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnUnameToFailHistSourceInetType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnUnameToFailHistSourceInetAddr.", "x-yang-type": "inet-address:InetAddressType" }, "cvpdnUnameToFailHistSourceInetAddr": { "type": "string", "description": "The source IP address of the tunnel in which the\n failure occurred. This IP address is that of the\n interface at the instigator end of the tunnel. The\n instigator end is the peer which initiates the tunnel\n estalishment. The type of this address is determined\n by the value of cvpdnUnameToFailHistSourceInetType.", "x-yang-type": "inet-address:InetAddress" }, "cvpdnUnameToFailHistDestInetType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnUnameToFailHistDestInetAddr.", "x-yang-type": "inet-address:InetAddressType" }, "cvpdnUnameToFailHistDestInetAddr": { "type": "string", "description": "The destination IP address of the tunnel in which the\n failure occurred. This IP address is that of the\n interface at the receiver end of the tunnel. The type \n of this address is determined by the value of \n cvpdnUnameToFailHistDestInetType.", "x-yang-type": "inet-address:InetAddress" } } } } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnUserToFailHistInfoTable": { "cvpdnUserToFailHistInfoEntry": [ { "cvpdnUnameToFailHistUname": "interface-1", "cvpdnUnameToFailHistTunnelId": 0, "cvpdnUnameToFailHistUserId": 0, "cvpdnUnameToFailHistLocalInitConn": true, "cvpdnUnameToFailHistLocalName": "interface-1", "cvpdnUnameToFailHistRemoteName": "interface-1", "cvpdnUnameToFailHistSourceIp": "192.168.1.1", "cvpdnUnameToFailHistDestIp": "192.168.1.1", "cvpdnUnameToFailHistCount": 0, "cvpdnUnameToFailHistFailTime": "interface-1", "cvpdnUnameToFailHistFailType": "ethernetCsmacd(6)", "cvpdnUnameToFailHistFailReason": "interface-1", "cvpdnUnameToFailHistSourceInetType": "ethernetCsmacd(6)", "cvpdnUnameToFailHistSourceInetAddr": "192.168.1.1", "cvpdnUnameToFailHistDestInetType": "ethernetCsmacd(6)", "cvpdnUnameToFailHistDestInetAddr": "192.168.1.1" }, { "cvpdnUnameToFailHistUname": "interface-1", "cvpdnUnameToFailHistTunnelId": 0, "cvpdnUnameToFailHistUserId": 0, "cvpdnUnameToFailHistLocalInitConn": true, "cvpdnUnameToFailHistLocalName": "interface-1", "cvpdnUnameToFailHistRemoteName": "interface-1", "cvpdnUnameToFailHistSourceIp": "192.168.1.1", "cvpdnUnameToFailHistDestIp": "192.168.1.1", "cvpdnUnameToFailHistCount": 0, "cvpdnUnameToFailHistFailTime": "interface-1", "cvpdnUnameToFailHistFailType": "ethernetCsmacd(6)", "cvpdnUnameToFailHistFailReason": "interface-1", "cvpdnUnameToFailHistSourceInetType": "ethernetCsmacd(6)", "cvpdnUnameToFailHistSourceInetAddr": "192.168.1.1", "cvpdnUnameToFailHistDestInetType": "ethernetCsmacd(6)", "cvpdnUnameToFailHistDestInetAddr": "192.168.1.1" }, { "cvpdnUnameToFailHistUname": "interface-1", "cvpdnUnameToFailHistTunnelId": 0, "cvpdnUnameToFailHistUserId": 0, "cvpdnUnameToFailHistLocalInitConn": true, "cvpdnUnameToFailHistLocalName": "interface-1", "cvpdnUnameToFailHistRemoteName": "interface-1", "cvpdnUnameToFailHistSourceIp": "192.168.1.1", "cvpdnUnameToFailHistDestIp": "192.168.1.1", "cvpdnUnameToFailHistCount": 0, "cvpdnUnameToFailHistFailTime": "interface-1", "cvpdnUnameToFailHistFailType": "ethernetCsmacd(6)", "cvpdnUnameToFailHistFailReason": "interface-1", "cvpdnUnameToFailHistSourceInetType": "ethernetCsmacd(6)", "cvpdnUnameToFailHistSourceInetAddr": "192.168.1.1", "cvpdnUnameToFailHistDestInetType": "ethernetCsmacd(6)", "cvpdnUnameToFailHistDestInetAddr": "192.168.1.1" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnUserToFailHistInfoTable", "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": "/cvpdnUserToFailHistInfoTable", "x-restconf-kind": "container" }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnUserToFailHistInfoTable/cvpdnUserToFailHistInfoEntry": { "get": { "summary": "Get cvpdnUserToFailHistInfoEntry list", "description": "Retrieve list of cvpdnUserToFailHistInfoEntry entries from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in the table, containing failure history\n relevant to an user name.", "items": { "type": "object", "properties": { "cvpdnUnameToFailHistUname": { "type": "string", "description": "The user name for this failure entry.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnUnameToFailHistTunnelId": { "type": "integer", "description": "The Tunnel ID for this failure entry. If it is the\n instigator of the tunnel, the ID is the TS tunnel ID,\n otherwise it is the NAS tunnel ID.", "minimum": 0, "maximum": 4294967295 }, "cvpdnUnameToFailHistUserId": { "type": "integer", "description": "The user ID of this failure entry.", "minimum": 0, "maximum": 4294967295 }, "cvpdnUnameToFailHistLocalInitConn": { "type": "boolean", "description": "This object indicates whether the tunnel in which the\n failure occurred was generated locally or not." }, "cvpdnUnameToFailHistLocalName": { "type": "string", "description": "The local name of the VPDN tunnel in which the failure\n occurred. It will be the NAS name of the tunnel if the\n system serves as the NAS, or the TS name of the tunnel\n if the system serves as the tunnel server. The local\n name is the configured host name of the system. This\n object can be empty if the failure occurred prior to\n successful tunnel projection, thus no source name will\n be available.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnUnameToFailHistRemoteName": { "type": "string", "description": "The remote name of the VPDN tunnel in which the failure\n occurred. It will be the tunnel server name of the\n tunnel if the system is a NAS, or the NAS name of the\n tunnel if the system serves as the tunnel server. This\n object can be empty if the failure occurred prior to\n successful tunnel projection, thus no source name will\n be available.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnUnameToFailHistSourceIp": { "type": "string", "description": "The source IP address of the tunnel in which the\n failure occurred. This IP address is that of the\n interface at the instigator end of the tunnel.", "format": "inet:ipv4-address" }, "cvpdnUnameToFailHistDestIp": { "type": "string", "description": "The destination IP address of the tunnel in which the\n failure occurred. This IP address is that of the\n interface at the receiver end of the tunnel.", "format": "inet:ipv4-address" }, "cvpdnUnameToFailHistCount": { "type": "integer", "description": "This object is incremented when multiple failures has\n been experienced by this user on this tunnel. Seeing a\n delta of >1 is an indication that the current failure\n record is the latest of a series of failures that has\n been recorded.", "minimum": 0, "maximum": 4294967295 }, "cvpdnUnameToFailHistFailTime": { "type": "string", "description": "This object specifies the time when the failure is\n occurred.", "x-yang-type": "yang:timestamp" }, "cvpdnUnameToFailHistFailType": { "type": "string", "description": "The type of failure for the current failure record. It\n comes in a form of a an ASCII string which describes\n the type of failure.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnUnameToFailHistFailReason": { "type": "string", "description": "The reason of failure for the current failure record.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnUnameToFailHistSourceInetType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnUnameToFailHistSourceInetAddr.", "x-yang-type": "inet-address:InetAddressType" }, "cvpdnUnameToFailHistSourceInetAddr": { "type": "string", "description": "The source IP address of the tunnel in which the\n failure occurred. This IP address is that of the\n interface at the instigator end of the tunnel. The\n instigator end is the peer which initiates the tunnel\n estalishment. The type of this address is determined\n by the value of cvpdnUnameToFailHistSourceInetType.", "x-yang-type": "inet-address:InetAddress" }, "cvpdnUnameToFailHistDestInetType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnUnameToFailHistDestInetAddr.", "x-yang-type": "inet-address:InetAddressType" }, "cvpdnUnameToFailHistDestInetAddr": { "type": "string", "description": "The destination IP address of the tunnel in which the\n failure occurred. This IP address is that of the\n interface at the receiver end of the tunnel. The type \n of this address is determined by the value of \n cvpdnUnameToFailHistDestInetType.", "x-yang-type": "inet-address:InetAddress" } } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnUserToFailHistInfoEntry": [ { "cvpdnUnameToFailHistUname": "interface-1", "cvpdnUnameToFailHistTunnelId": 0, "cvpdnUnameToFailHistUserId": 0, "cvpdnUnameToFailHistLocalInitConn": true, "cvpdnUnameToFailHistLocalName": "interface-1", "cvpdnUnameToFailHistRemoteName": "interface-1", "cvpdnUnameToFailHistSourceIp": "192.168.1.1", "cvpdnUnameToFailHistDestIp": "192.168.1.1", "cvpdnUnameToFailHistCount": 0, "cvpdnUnameToFailHistFailTime": "interface-1", "cvpdnUnameToFailHistFailType": "ethernetCsmacd(6)", "cvpdnUnameToFailHistFailReason": "interface-1", "cvpdnUnameToFailHistSourceInetType": "ethernetCsmacd(6)", "cvpdnUnameToFailHistSourceInetAddr": "192.168.1.1", "cvpdnUnameToFailHistDestInetType": "ethernetCsmacd(6)", "cvpdnUnameToFailHistDestInetAddr": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnUserToFailHistInfoEntry", "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": "/cvpdnUserToFailHistInfoTable/cvpdnUserToFailHistInfoEntry", "x-restconf-kind": "container" }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnTemplateTable": { "get": { "summary": "Get cvpdnTemplateTable data", "description": "Retrieve cvpdnTemplateTable operational data from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "Table of information about the VPDN templates. The\n VPDN template is a grouping mechanism that allows\n configuration settings to be shared among multiple VPDN\n groups. One such setting is a limit on the number of\n active sessions across all VPDN groups associated with\n the template. The template table allows customers to\n monitor template-wide information such as tracking the\n allocation of sessions across templates.", "properties": { "cvpdnTemplateEntry": { "type": "array", "description": "An entry in the table, containing information about a\n single VPDN template.", "items": { "type": "object", "properties": { "cvpdnTemplateName": { "type": "string", "description": "The name of the VPDN template.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cvpdnTemplateActiveSessions": { "type": "integer", "description": "The total number of active session in all groups\n associated with the template.", "minimum": 0, "maximum": 4294967295 } } } } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnTemplateTable": { "cvpdnTemplateEntry": [ { "cvpdnTemplateName": "interface-1", "cvpdnTemplateActiveSessions": 0 }, { "cvpdnTemplateName": "interface-1", "cvpdnTemplateActiveSessions": 0 }, { "cvpdnTemplateName": "interface-1", "cvpdnTemplateActiveSessions": 0 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnTemplateTable", "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": "/cvpdnTemplateTable", "x-restconf-kind": "container" }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnTemplateTable/cvpdnTemplateEntry": { "get": { "summary": "Get cvpdnTemplateEntry list", "description": "Retrieve list of cvpdnTemplateEntry entries from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in the table, containing information about a\n single VPDN template.", "items": { "type": "object", "properties": { "cvpdnTemplateName": { "type": "string", "description": "The name of the VPDN template.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cvpdnTemplateActiveSessions": { "type": "integer", "description": "The total number of active session in all groups\n associated with the template.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnTemplateEntry": [ { "cvpdnTemplateName": "interface-1", "cvpdnTemplateActiveSessions": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnTemplateEntry", "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": "/cvpdnTemplateTable/cvpdnTemplateEntry", "x-restconf-kind": "container" }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnTemplateTable/cvpdnTemplateEntry={cvpdnTemplateName}": { "get": { "summary": "Get cvpdnTemplateEntry entry", "description": "Retrieve specific cvpdnTemplateEntry entry by key from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "parameters": [ { "name": "cvpdnTemplateName", "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": { "cvpdnTemplateName": { "type": "string", "description": "The name of the VPDN template.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cvpdnTemplateActiveSessions": { "type": "integer", "description": "The total number of active session in all groups\n associated with the template.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnTemplateEntry": { "cvpdnTemplateName": "interface-1", "cvpdnTemplateActiveSessions": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnTemplateEntry-2" }, "x-yang-path": "/cvpdnTemplateTable/cvpdnTemplateEntry={cvpdnTemplateName}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cvpdnTemplateName" ] }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnBundleTable": { "get": { "summary": "Get cvpdnBundleTable data", "description": "Retrieve cvpdnBundleTable operational data from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "Table that describes the multilink PPP attributes of the\n active VPDN sessions.", "properties": { "cvpdnBundleEntry": { "type": "array", "description": "An entry in this table represents an active multilink PPP\n bundle that belongs to a VPDN tunnel.", "items": { "type": "object", "properties": { "cvpdnBundleName": { "type": "string", "description": "The name of the multilink PPP bundle associated with a VPDN\n tunnel.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cvpdnBundleLinkCount": { "type": "integer", "description": "The total number of active links in a multilink PPP bundle\n associated with a VPDN tunnel.", "minimum": 0, "maximum": 4294967295 }, "cvpdnBundleEndpointType": { "type": "string", "description": "The multilink PPP bundle discriminator type associated with\n a VPDN tunnel. The value of this object represents the type\n of discriminator used in cvpdnBundleEndpoint.\n \n none: No endpoint discriminator was supplied, the\n default value is being used.\n \n hostname: The router's hostname is being used as\n discriminator.\n \n string: User specified string is being used as\n discriminator.\n \n macAddress: A MAC address as defined by the MacAddress\n textual convention is being used as\n discriminator.\n \n ipV4Address: An IP address as defined by the\n InetAddressIPv4 textual convention is being\n used as discriminator.\n \n ipV6Address: An IP address as defined by the\n InetAddressIPv6 textual convention is being\n used as discriminator.\n \n phone: The PSTN phone number is being used as\n discriminator.\n \n magicNumber: A magic number is being used as\n discriminator." }, "cvpdnBundleEndpoint": { "type": "string", "description": "Indicates the discriminator used in this bundle that is\n associated with a VPDN tunnel.", "format": "binary" }, "cvpdnBundlePeerIpAddrType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnBundlePeerIpAddr.", "x-yang-type": "inet-address:InetAddressType" }, "cvpdnBundlePeerIpAddr": { "type": "string", "description": "The IP address of the multilink PPP peer in a VPDN tunnel.", "x-yang-type": "inet-address:InetAddress" }, "cvpdnBundleEndpointClass": { "type": "string", "description": "The multilink PPP bundle discriminator class associated\n with a VPDN tunnel. The value of this object represents the\n type of discriminator used in cvpdnBundleEndpoint.", "x-yang-type": "CISCO-VPDN-MGMT-MIB:EndpointClass" } } } } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnBundleTable": { "cvpdnBundleEntry": [ { "cvpdnBundleName": "interface-1", "cvpdnBundleLinkCount": 0, "cvpdnBundleEndpointType": "ethernetCsmacd(6)", "cvpdnBundleEndpoint": "example-string", "cvpdnBundlePeerIpAddrType": "192.168.1.1", "cvpdnBundlePeerIpAddr": "192.168.1.1", "cvpdnBundleEndpointClass": "example-string" }, { "cvpdnBundleName": "interface-1", "cvpdnBundleLinkCount": 0, "cvpdnBundleEndpointType": "ethernetCsmacd(6)", "cvpdnBundleEndpoint": "example-string", "cvpdnBundlePeerIpAddrType": "192.168.1.1", "cvpdnBundlePeerIpAddr": "192.168.1.1", "cvpdnBundleEndpointClass": "example-string" }, { "cvpdnBundleName": "interface-1", "cvpdnBundleLinkCount": 0, "cvpdnBundleEndpointType": "ethernetCsmacd(6)", "cvpdnBundleEndpoint": "example-string", "cvpdnBundlePeerIpAddrType": "192.168.1.1", "cvpdnBundlePeerIpAddr": "192.168.1.1", "cvpdnBundleEndpointClass": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnBundleTable", "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": "/cvpdnBundleTable", "x-restconf-kind": "container" }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnBundleTable/cvpdnBundleEntry": { "get": { "summary": "Get cvpdnBundleEntry list", "description": "Retrieve list of cvpdnBundleEntry entries from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in this table represents an active multilink PPP\n bundle that belongs to a VPDN tunnel.", "items": { "type": "object", "properties": { "cvpdnBundleName": { "type": "string", "description": "The name of the multilink PPP bundle associated with a VPDN\n tunnel.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cvpdnBundleLinkCount": { "type": "integer", "description": "The total number of active links in a multilink PPP bundle\n associated with a VPDN tunnel.", "minimum": 0, "maximum": 4294967295 }, "cvpdnBundleEndpointType": { "type": "string", "description": "The multilink PPP bundle discriminator type associated with\n a VPDN tunnel. The value of this object represents the type\n of discriminator used in cvpdnBundleEndpoint.\n \n none: No endpoint discriminator was supplied, the\n default value is being used.\n \n hostname: The router's hostname is being used as\n discriminator.\n \n string: User specified string is being used as\n discriminator.\n \n macAddress: A MAC address as defined by the MacAddress\n textual convention is being used as\n discriminator.\n \n ipV4Address: An IP address as defined by the\n InetAddressIPv4 textual convention is being\n used as discriminator.\n \n ipV6Address: An IP address as defined by the\n InetAddressIPv6 textual convention is being\n used as discriminator.\n \n phone: The PSTN phone number is being used as\n discriminator.\n \n magicNumber: A magic number is being used as\n discriminator." }, "cvpdnBundleEndpoint": { "type": "string", "description": "Indicates the discriminator used in this bundle that is\n associated with a VPDN tunnel.", "format": "binary" }, "cvpdnBundlePeerIpAddrType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnBundlePeerIpAddr.", "x-yang-type": "inet-address:InetAddressType" }, "cvpdnBundlePeerIpAddr": { "type": "string", "description": "The IP address of the multilink PPP peer in a VPDN tunnel.", "x-yang-type": "inet-address:InetAddress" }, "cvpdnBundleEndpointClass": { "type": "string", "description": "The multilink PPP bundle discriminator class associated\n with a VPDN tunnel. The value of this object represents the\n type of discriminator used in cvpdnBundleEndpoint.", "x-yang-type": "CISCO-VPDN-MGMT-MIB:EndpointClass" } } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnBundleEntry": [ { "cvpdnBundleName": "interface-1", "cvpdnBundleLinkCount": 0, "cvpdnBundleEndpointType": "ethernetCsmacd(6)", "cvpdnBundleEndpoint": "example-string", "cvpdnBundlePeerIpAddrType": "192.168.1.1", "cvpdnBundlePeerIpAddr": "192.168.1.1", "cvpdnBundleEndpointClass": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnBundleEntry", "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": "/cvpdnBundleTable/cvpdnBundleEntry", "x-restconf-kind": "container" }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnBundleTable/cvpdnBundleEntry={cvpdnBundleName}": { "get": { "summary": "Get cvpdnBundleEntry entry", "description": "Retrieve specific cvpdnBundleEntry entry by key from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "parameters": [ { "name": "cvpdnBundleName", "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": { "cvpdnBundleName": { "type": "string", "description": "The name of the multilink PPP bundle associated with a VPDN\n tunnel.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cvpdnBundleLinkCount": { "type": "integer", "description": "The total number of active links in a multilink PPP bundle\n associated with a VPDN tunnel.", "minimum": 0, "maximum": 4294967295 }, "cvpdnBundleEndpointType": { "type": "string", "description": "The multilink PPP bundle discriminator type associated with\n a VPDN tunnel. The value of this object represents the type\n of discriminator used in cvpdnBundleEndpoint.\n \n none: No endpoint discriminator was supplied, the\n default value is being used.\n \n hostname: The router's hostname is being used as\n discriminator.\n \n string: User specified string is being used as\n discriminator.\n \n macAddress: A MAC address as defined by the MacAddress\n textual convention is being used as\n discriminator.\n \n ipV4Address: An IP address as defined by the\n InetAddressIPv4 textual convention is being\n used as discriminator.\n \n ipV6Address: An IP address as defined by the\n InetAddressIPv6 textual convention is being\n used as discriminator.\n \n phone: The PSTN phone number is being used as\n discriminator.\n \n magicNumber: A magic number is being used as\n discriminator." }, "cvpdnBundleEndpoint": { "type": "string", "description": "Indicates the discriminator used in this bundle that is\n associated with a VPDN tunnel.", "format": "binary" }, "cvpdnBundlePeerIpAddrType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnBundlePeerIpAddr.", "x-yang-type": "inet-address:InetAddressType" }, "cvpdnBundlePeerIpAddr": { "type": "string", "description": "The IP address of the multilink PPP peer in a VPDN tunnel.", "x-yang-type": "inet-address:InetAddress" }, "cvpdnBundleEndpointClass": { "type": "string", "description": "The multilink PPP bundle discriminator class associated\n with a VPDN tunnel. The value of this object represents the\n type of discriminator used in cvpdnBundleEndpoint.", "x-yang-type": "CISCO-VPDN-MGMT-MIB:EndpointClass" } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnBundleEntry": { "cvpdnBundleName": "interface-1", "cvpdnBundleLinkCount": 0, "cvpdnBundleEndpointType": "ethernetCsmacd(6)", "cvpdnBundleEndpoint": "example-string", "cvpdnBundlePeerIpAddrType": "192.168.1.1", "cvpdnBundlePeerIpAddr": "192.168.1.1", "cvpdnBundleEndpointClass": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnBundleEntry-2" }, "x-yang-path": "/cvpdnBundleTable/cvpdnBundleEntry={cvpdnBundleName}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cvpdnBundleName" ] }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnBundleChildTable": { "get": { "summary": "Get cvpdnBundleChildTable data", "description": "Retrieve cvpdnBundleChildTable operational data from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "A table that exposes the containment relationship between a\n multilink PPP bundle and a VPDN tunnel.", "properties": { "cvpdnBundleChildEntry": { "type": "array", "description": "An entry in this table represents a session that belongs to\n a VPDN tunnel and to a multilink PPP bundle.", "items": { "type": "object", "properties": { "cvpdnBundleName": { "type": "string", "description": "cvpdnBundleName", "x-yang-type": "leafref" }, "cvpdnBundleChildTunnelType": { "type": "string", "description": "The tunnel type. This is the tunnel protocol of an active\n VPDN session that is associated with a multilink PPP\n bundle.", "x-yang-type": "CISCO-VPDN-MGMT-MIB:TunnelType" }, "cvpdnBundleChildTunnelId": { "type": "integer", "description": "The Tunnel ID of an active VPDN session that is associated\n with a multilink PPP bundle.", "minimum": 0, "maximum": 4294967295 }, "cvpdnBundleChildSessionId": { "type": "integer", "description": "The ID of an active VPDN session that is associated with a\n multilink PPP bundle.", "minimum": 0, "maximum": 4294967295 } } } } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnBundleChildTable": { "cvpdnBundleChildEntry": [ { "cvpdnBundleName": "interface-1", "cvpdnBundleChildTunnelType": "ethernetCsmacd(6)", "cvpdnBundleChildTunnelId": 0, "cvpdnBundleChildSessionId": 0 }, { "cvpdnBundleName": "interface-1", "cvpdnBundleChildTunnelType": "ethernetCsmacd(6)", "cvpdnBundleChildTunnelId": 0, "cvpdnBundleChildSessionId": 0 }, { "cvpdnBundleName": "interface-1", "cvpdnBundleChildTunnelType": "ethernetCsmacd(6)", "cvpdnBundleChildTunnelId": 0, "cvpdnBundleChildSessionId": 0 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnBundleChildTable", "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": "/cvpdnBundleChildTable", "x-restconf-kind": "container" }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnBundleChildTable/cvpdnBundleChildEntry": { "get": { "summary": "Get cvpdnBundleChildEntry list", "description": "Retrieve list of cvpdnBundleChildEntry entries from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in this table represents a session that belongs to\n a VPDN tunnel and to a multilink PPP bundle.", "items": { "type": "object", "properties": { "cvpdnBundleName": { "type": "string", "description": "cvpdnBundleName", "x-yang-type": "leafref" }, "cvpdnBundleChildTunnelType": { "type": "string", "description": "The tunnel type. This is the tunnel protocol of an active\n VPDN session that is associated with a multilink PPP\n bundle.", "x-yang-type": "CISCO-VPDN-MGMT-MIB:TunnelType" }, "cvpdnBundleChildTunnelId": { "type": "integer", "description": "The Tunnel ID of an active VPDN session that is associated\n with a multilink PPP bundle.", "minimum": 0, "maximum": 4294967295 }, "cvpdnBundleChildSessionId": { "type": "integer", "description": "The ID of an active VPDN session that is associated with a\n multilink PPP bundle.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnBundleChildEntry": [ { "cvpdnBundleName": "interface-1", "cvpdnBundleChildTunnelType": "ethernetCsmacd(6)", "cvpdnBundleChildTunnelId": 0, "cvpdnBundleChildSessionId": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnBundleChildEntry", "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": "/cvpdnBundleChildTable/cvpdnBundleChildEntry", "x-restconf-kind": "container" }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnSystemEntry": { "get": { "summary": "Get cvpdnSystemEntry list", "description": "Retrieve list of cvpdnSystemEntry entries from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in the table, containing information about a\n single type of VPDN tunnel.", "items": { "type": "object", "properties": { "cvpdnSystemTunnelType": { "type": "string", "description": "The tunnel type. This is the tunnel protocol.", "x-yang-type": "CISCO-VPDN-MGMT-MIB:TunnelType" }, "cvpdnSystemTunnelTotal": { "type": "integer", "description": "The total number of VPDN tunnels that are currently active\n of this tunnel type.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSystemSessionTotal": { "type": "integer", "description": "The total number of active sessions in all the active VPDN\n tunnels of this tunnel type.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSystemDeniedUsersTotal": { "type": "integer", "description": "The total number of denied user attempts to all the VPDN\n tunnels of this tunnel type since last system\n re-initialization.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSystemInitialConnReq": { "type": "integer", "description": "The total number tunnel connection attempts on all the VPDN\n tunnels of this tunnel type since last system\n re-initialization.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSystemSuccessConnReq": { "type": "integer", "description": "The total number tunnel Successful connection attempts in VPDN\n tunnels of this tunnel type since last system\n re-initialization.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSystemFailedConnReq": { "type": "integer", "description": "The total number tunnel Failed connection attempts in VPDN\n tunnels of this tunnel type since last system\n re-initialization.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnSystemEntry": [ { "cvpdnSystemTunnelType": "ethernetCsmacd(6)", "cvpdnSystemTunnelTotal": 1500, "cvpdnSystemSessionTotal": 0, "cvpdnSystemDeniedUsersTotal": 0, "cvpdnSystemInitialConnReq": 0, "cvpdnSystemSuccessConnReq": 0, "cvpdnSystemFailedConnReq": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnSystemEntry-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": "/cvpdnSystemEntry", "x-restconf-kind": "container" }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnSystemEntry={cvpdnSystemTunnelType}": { "get": { "summary": "Get cvpdnSystemEntry entry", "description": "Retrieve specific cvpdnSystemEntry entry by key from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "parameters": [ { "name": "cvpdnSystemTunnelType", "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": { "cvpdnSystemTunnelType": { "type": "string", "description": "The tunnel type. This is the tunnel protocol.", "x-yang-type": "CISCO-VPDN-MGMT-MIB:TunnelType" }, "cvpdnSystemTunnelTotal": { "type": "integer", "description": "The total number of VPDN tunnels that are currently active\n of this tunnel type.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSystemSessionTotal": { "type": "integer", "description": "The total number of active sessions in all the active VPDN\n tunnels of this tunnel type.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSystemDeniedUsersTotal": { "type": "integer", "description": "The total number of denied user attempts to all the VPDN\n tunnels of this tunnel type since last system\n re-initialization.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSystemInitialConnReq": { "type": "integer", "description": "The total number tunnel connection attempts on all the VPDN\n tunnels of this tunnel type since last system\n re-initialization.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSystemSuccessConnReq": { "type": "integer", "description": "The total number tunnel Successful connection attempts in VPDN\n tunnels of this tunnel type since last system\n re-initialization.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSystemFailedConnReq": { "type": "integer", "description": "The total number tunnel Failed connection attempts in VPDN\n tunnels of this tunnel type since last system\n re-initialization.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnSystemEntry": { "cvpdnSystemTunnelType": "ethernetCsmacd(6)", "cvpdnSystemTunnelTotal": 1500, "cvpdnSystemSessionTotal": 0, "cvpdnSystemDeniedUsersTotal": 0, "cvpdnSystemInitialConnReq": 0, "cvpdnSystemSuccessConnReq": 0, "cvpdnSystemFailedConnReq": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnSystemEntry-4" }, "x-yang-path": "/cvpdnSystemEntry={cvpdnSystemTunnelType}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cvpdnSystemTunnelType" ] }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnTunnelEntry": { "get": { "summary": "Get cvpdnTunnelEntry list", "description": "Retrieve list of cvpdnTunnelEntry entries from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in the table, containing information about a\n single active VPDN tunnel.", "items": { "type": "object", "properties": { "cvpdnTunnelTunnelId": { "type": "integer", "description": "The Tunnel ID of an active VPDN tunnel. If it is the\n instigator of the tunnel, the ID is the HGW/LNS tunnel\n ID, otherwise it is the NAS/LAC tunnel ID.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelRemoteTunnelId": { "type": "integer", "description": "The remote Tunnel ID of an active VPDN tunnel. If it\n is the instigator of the tunnel, the ID is the NAS/LAC\n tunnel ID, otherwise it is the HGW/LNS tunnel ID.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelLocalName": { "type": "string", "description": "The local name of an active VPDN tunnel. It will be\n the NAS/LAC name of the tunnel if the router serves as\n the NAS/LAC, or the HGW/LNS name of the tunnel if the\n system serves as the home gateway. Typically, the\n local name is the configured host name of the router.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnTunnelRemoteName": { "type": "string", "description": "The remote name of an active VPDN tunnel. It will be\n the home gateway name of the tunnel if the system is a\n NAS/LAC, or the NAS/LAC name of the tunnel if the\n system serves as the home gateway.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnTunnelRemoteEndpointName": { "type": "string", "description": "The remote end point name of an active VPDN tunnel.\n This name is either the domain name or the DNIS that\n this tunnel is projected with.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnTunnelLocalInitConnection": { "type": "boolean", "description": "This object indicates whether the tunnel was generated\n locally or not." }, "cvpdnTunnelOrigCause": { "type": "string", "description": "The cause which originated an active VPDN tunnel. The\n tunnel can be projected via domain name, DNIS or a\n stack group (SGBP)." }, "cvpdnTunnelState": { "type": "string", "description": "The current state of an active VPDN tunnel. Each state\n code is explained below:\n \n unknown: The current state of the tunnel is\n unknown.\n \n opening: The tunnel has just been instigated and\n is pending for a remote end reply to\n complete the process.\n \n open: The tunnel is active.\n \n closing: The tunnel has just been shut down and\n is pending for the remote end to reply\n to complete the process." }, "cvpdnTunnelActiveSessions": { "type": "integer", "description": "The total number of active session currently in the\n tunnel.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelDeniedUsers": { "type": "integer", "description": "A count of the accumulated total of denied users for\n the tunnel.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSoftshut": { "type": "boolean", "description": "A VPDN tunnel can be put into a soft shut state to\n prevent any new user session to be added. This object\n specifies whether this tunnel has been soft shut." }, "cvpdnTunnelNetworkServiceType": { "type": "string", "description": "The type of network service used in the active tunnel.\n For now it is IP only." }, "cvpdnTunnelLocalIpAddress": { "type": "string", "description": "The local IP address of the tunnel. This IP address is\n that of the interface at the local end of the tunnel.", "format": "inet:ipv4-address" }, "cvpdnTunnelSourceIpAddress": { "type": "string", "description": "The source IP address of the tunnel. This IP address\n is the user configurable IP address for Stack Group\n Biding Protocol (SGBP) via the CLI command:\n vpdn source-ip", "format": "inet:ipv4-address" }, "cvpdnTunnelRemoteIpAddress": { "type": "string", "description": "The remote IP address of the tunnel. This IP address\n is that of the interface at the remote end of the\n tunnel.", "format": "inet:ipv4-address" } } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnTunnelEntry": [ { "cvpdnTunnelTunnelId": 0, "cvpdnTunnelRemoteTunnelId": 0, "cvpdnTunnelLocalName": "interface-1", "cvpdnTunnelRemoteName": "interface-1", "cvpdnTunnelRemoteEndpointName": "interface-1", "cvpdnTunnelLocalInitConnection": true, "cvpdnTunnelOrigCause": "example-string", "cvpdnTunnelState": "up(1)", "cvpdnTunnelActiveSessions": 0, "cvpdnTunnelDeniedUsers": 0, "cvpdnTunnelSoftshut": true, "cvpdnTunnelNetworkServiceType": "ethernetCsmacd(6)", "cvpdnTunnelLocalIpAddress": "192.168.1.1", "cvpdnTunnelSourceIpAddress": "192.168.1.1", "cvpdnTunnelRemoteIpAddress": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnTunnelEntry-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": "/cvpdnTunnelEntry", "x-restconf-kind": "container" }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnTunnelEntry={cvpdnTunnelTunnelId}": { "get": { "summary": "Get cvpdnTunnelEntry entry", "description": "Retrieve specific cvpdnTunnelEntry entry by key from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "parameters": [ { "name": "cvpdnTunnelTunnelId", "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": { "cvpdnTunnelTunnelId": { "type": "integer", "description": "The Tunnel ID of an active VPDN tunnel. If it is the\n instigator of the tunnel, the ID is the HGW/LNS tunnel\n ID, otherwise it is the NAS/LAC tunnel ID.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelRemoteTunnelId": { "type": "integer", "description": "The remote Tunnel ID of an active VPDN tunnel. If it\n is the instigator of the tunnel, the ID is the NAS/LAC\n tunnel ID, otherwise it is the HGW/LNS tunnel ID.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelLocalName": { "type": "string", "description": "The local name of an active VPDN tunnel. It will be\n the NAS/LAC name of the tunnel if the router serves as\n the NAS/LAC, or the HGW/LNS name of the tunnel if the\n system serves as the home gateway. Typically, the\n local name is the configured host name of the router.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnTunnelRemoteName": { "type": "string", "description": "The remote name of an active VPDN tunnel. It will be\n the home gateway name of the tunnel if the system is a\n NAS/LAC, or the NAS/LAC name of the tunnel if the\n system serves as the home gateway.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnTunnelRemoteEndpointName": { "type": "string", "description": "The remote end point name of an active VPDN tunnel.\n This name is either the domain name or the DNIS that\n this tunnel is projected with.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnTunnelLocalInitConnection": { "type": "boolean", "description": "This object indicates whether the tunnel was generated\n locally or not." }, "cvpdnTunnelOrigCause": { "type": "string", "description": "The cause which originated an active VPDN tunnel. The\n tunnel can be projected via domain name, DNIS or a\n stack group (SGBP)." }, "cvpdnTunnelState": { "type": "string", "description": "The current state of an active VPDN tunnel. Each state\n code is explained below:\n \n unknown: The current state of the tunnel is\n unknown.\n \n opening: The tunnel has just been instigated and\n is pending for a remote end reply to\n complete the process.\n \n open: The tunnel is active.\n \n closing: The tunnel has just been shut down and\n is pending for the remote end to reply\n to complete the process." }, "cvpdnTunnelActiveSessions": { "type": "integer", "description": "The total number of active session currently in the\n tunnel.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelDeniedUsers": { "type": "integer", "description": "A count of the accumulated total of denied users for\n the tunnel.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSoftshut": { "type": "boolean", "description": "A VPDN tunnel can be put into a soft shut state to\n prevent any new user session to be added. This object\n specifies whether this tunnel has been soft shut." }, "cvpdnTunnelNetworkServiceType": { "type": "string", "description": "The type of network service used in the active tunnel.\n For now it is IP only." }, "cvpdnTunnelLocalIpAddress": { "type": "string", "description": "The local IP address of the tunnel. This IP address is\n that of the interface at the local end of the tunnel.", "format": "inet:ipv4-address" }, "cvpdnTunnelSourceIpAddress": { "type": "string", "description": "The source IP address of the tunnel. This IP address\n is the user configurable IP address for Stack Group\n Biding Protocol (SGBP) via the CLI command:\n vpdn source-ip", "format": "inet:ipv4-address" }, "cvpdnTunnelRemoteIpAddress": { "type": "string", "description": "The remote IP address of the tunnel. This IP address\n is that of the interface at the remote end of the\n tunnel.", "format": "inet:ipv4-address" } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnTunnelEntry": { "cvpdnTunnelTunnelId": 0, "cvpdnTunnelRemoteTunnelId": 0, "cvpdnTunnelLocalName": "interface-1", "cvpdnTunnelRemoteName": "interface-1", "cvpdnTunnelRemoteEndpointName": "interface-1", "cvpdnTunnelLocalInitConnection": true, "cvpdnTunnelOrigCause": "example-string", "cvpdnTunnelState": "up(1)", "cvpdnTunnelActiveSessions": 0, "cvpdnTunnelDeniedUsers": 0, "cvpdnTunnelSoftshut": true, "cvpdnTunnelNetworkServiceType": "ethernetCsmacd(6)", "cvpdnTunnelLocalIpAddress": "192.168.1.1", "cvpdnTunnelSourceIpAddress": "192.168.1.1", "cvpdnTunnelRemoteIpAddress": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnTunnelEntry-4" }, "x-yang-path": "/cvpdnTunnelEntry={cvpdnTunnelTunnelId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cvpdnTunnelTunnelId" ] }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnTunnelAttrEntry": { "get": { "summary": "Get cvpdnTunnelAttrEntry list", "description": "Retrieve list of cvpdnTunnelAttrEntry entries from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in the table, containing information about a\n single active VPDN tunnel.", "items": { "type": "object", "properties": { "cvpdnSystemTunnelType": { "type": "string", "description": "cvpdnSystemTunnelType", "x-yang-type": "leafref" }, "cvpdnTunnelAttrTunnelId": { "type": "integer", "description": "The Tunnel ID of an active VPDN tunnel. If this end is the\n instigator of the tunnel, the ID is the TS tunnel ID,\n otherwise it is the NAS tunnel ID.\n \n Two distinct tunnels with the same tunnel ID may exist, but\n with different tunnel types.", "minimum": -2147483648, "maximum": 2147483647 }, "cvpdnTunnelAttrRemoteTunnelId": { "type": "integer", "description": "The remote Tunnel ID of an active VPDN tunnel. If this end\n is the instigator of the tunnel, the ID is the NAS tunnel\n ID, otherwise it is the TS tunnel ID.", "minimum": -2147483648, "maximum": 2147483647 }, "cvpdnTunnelAttrLocalName": { "type": "string", "description": "The local name of an active VPDN tunnel. It will be the\n NAS name of the tunnel if the system serves as the NAS, or\n the TS name of the tunnel if the system serves as the\n tunnel server. Typically, the local name is the configured\n host name of the system.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnTunnelAttrRemoteName": { "type": "string", "description": "The remote name of an active VPDN tunnel. It will be the\n tunnel server name of the tunnel if the system is a NAS,\n or the NAS name of the tunnel if the system serves as the\n tunnel server.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnTunnelAttrRemoteEndpointName": { "type": "string", "description": "The remote end point name of an active VPDN tunnel. This\n name is either the domain name or the DNIS that this tunnel\n is projected with.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnTunnelAttrLocalInitConnection": { "type": "boolean", "description": "This object indicates whether the tunnel was originated\n locally or not. If it's true, the tunnel was originated\n locally." }, "cvpdnTunnelAttrOrigCause": { "type": "string", "description": "The cause which originated an active VPDN tunnel. The\n tunnel can be projected via domain name, DNIS, stack group,\n or L2 Xconnect." }, "cvpdnTunnelAttrState": { "type": "string", "description": "The current state of an active VPDN tunnel.\n Tunnels of type l2f will have states with the 'l2f' prefix.\n Tunnels of type l2tp will have states with the 'l2tp'\n prefix.\n Tunnels of type pptp will have states with the 'pptp'\n prefix.\n \n Each state code is explained below:\n \n unknown: The current state of the tunnel is\n unknown.\n \n l2fOpening: The tunnel has just been initiated\n and is pending for a remote end\n reply to complete the process.\n \n l2fOpenWait: This end received a tunnel open\n request from the remote end and is\n waiting for the tunnel to be\n established.\n \n l2fOpen: The tunnel is active.\n \n l2fClosing: This end received a tunnel close\n request.\n \n l2fCloseWait: The tunnel has just been shut down\n and is pending for the remote end\n to reply to complete the process.\n \n l2tpIdle: No tunnel is initiated yet.\n \n l2tpWaitCtlReply: The tunnel has been initiated and\n is pending for a remote end reply\n to complete the process.\n \n l2tpEstablished: The tunnel is active.\n \n l2tpShuttingDown: The tunnel is in progress of\n shutting down.\n \n l2tpNoSessionLeft: There is no session left in the\n tunnel.\n \n pptpIdle: No tunnel is initiated yet.\n \n pptpWaitConnect: The tunnel is waiting for a TCP\n connection.\n \n pptpWaitCtlRequest: The tunnel has been initiated and\n is pending for a remote end\n request.\n \n pptpWaitCtlReply: The tunnel has been initiated and\n is pending for a remote end reply.\n \n pptpEstablished: The tunnel is active.\n \n pptpWaitStopReply: The tunnel is being shut down and\n is pending for a remote end reply.\n \n pptpTerminal: The tunnel has been shut down." }, "cvpdnTunnelAttrActiveSessions": { "type": "integer", "description": "The total number of active session currently in the\n tunnel.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelAttrDeniedUsers": { "type": "integer", "description": "A count of the accumulated total of denied users for the\n tunnel.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelAttrSoftshut": { "type": "boolean", "description": "A VPDN tunnel can be put into a soft shut state to prevent\n any new session to be added. This object specifies whether\n this tunnel has been soft shut. If its true, it has been\n soft shut." }, "cvpdnTunnelAttrNetworkServiceType": { "type": "string", "description": "The type of network service used in the active tunnel." }, "cvpdnTunnelAttrLocalIpAddress": { "type": "string", "description": "The local IP address of the tunnel. This IP address is\n that of the interface at the local end of the tunnel.", "format": "inet:ipv4-address" }, "cvpdnTunnelAttrSourceIpAddress": { "type": "string", "description": "The source IP address of the tunnel. This IP address is\n the user configurable IP address for Stack Group Biding\n Protocol.", "format": "inet:ipv4-address" }, "cvpdnTunnelAttrRemoteIpAddress": { "type": "string", "description": "The remote IP address of the tunnel. This IP address is\n that of the interface at the remote end of the tunnel.", "format": "inet:ipv4-address" }, "cvpdnTunnelAttrLocalInetAddressType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnTunnelAttrLocalInetAddress", "x-yang-type": "inet-address:InetAddressType" }, "cvpdnTunnelAttrLocalInetAddress": { "type": "string", "description": "The local IP address of the tunnel. This IP address is\n that of the interface at the local end of the tunnel.\n The type of this address is determined by the value of \n cvpdnTunnelAttrLocalInetAddressType.", "x-yang-type": "inet-address:InetAddress" }, "cvpdnTunnelAttrSourceInetAddressType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnTunnelAttrSourceInetAddress", "x-yang-type": "inet-address:InetAddressType" }, "cvpdnTunnelAttrSourceInetAddress": { "type": "string", "description": "The source IP address of the tunnel. This IP address is\n the user configurable IP address for Stack Group Biding\n Protocol. The type of this address is determined by the \n value of cvpdnTunnelAttrSourceInetAddressType.", "x-yang-type": "inet-address:InetAddress" }, "cvpdnTunnelAttrRemoteInetAddressType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnTunnelAttrRemoteInetAddress", "x-yang-type": "inet-address:InetAddressType" }, "cvpdnTunnelAttrRemoteInetAddress": { "type": "string", "description": "The remote IP address of the tunnel. This IP address is\n that of the interface at the remote end of the tunnel.\n The type of this address is determined by the value of \n cvpdnTunnelAttrRemoteInetAddressType.", "x-yang-type": "inet-address:InetAddress" } } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnTunnelAttrEntry": [ { "cvpdnSystemTunnelType": "ethernetCsmacd(6)", "cvpdnTunnelAttrTunnelId": -2147483648, "cvpdnTunnelAttrRemoteTunnelId": -2147483648, "cvpdnTunnelAttrLocalName": "interface-1", "cvpdnTunnelAttrRemoteName": "interface-1", "cvpdnTunnelAttrRemoteEndpointName": "interface-1", "cvpdnTunnelAttrLocalInitConnection": true, "cvpdnTunnelAttrOrigCause": "example-string", "cvpdnTunnelAttrState": "up(1)", "cvpdnTunnelAttrActiveSessions": 0, "cvpdnTunnelAttrDeniedUsers": 0, "cvpdnTunnelAttrSoftshut": true, "cvpdnTunnelAttrNetworkServiceType": "ethernetCsmacd(6)", "cvpdnTunnelAttrLocalIpAddress": "192.168.1.1", "cvpdnTunnelAttrSourceIpAddress": "192.168.1.1", "cvpdnTunnelAttrRemoteIpAddress": "192.168.1.1", "cvpdnTunnelAttrLocalInetAddressType": "192.168.1.1", "cvpdnTunnelAttrLocalInetAddress": "192.168.1.1", "cvpdnTunnelAttrSourceInetAddressType": "192.168.1.1", "cvpdnTunnelAttrSourceInetAddress": "192.168.1.1", "cvpdnTunnelAttrRemoteInetAddressType": "192.168.1.1", "cvpdnTunnelAttrRemoteInetAddress": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnTunnelAttrEntry-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": "/cvpdnTunnelAttrEntry", "x-restconf-kind": "container" }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnTunnelSessionEntry": { "get": { "summary": "Get cvpdnTunnelSessionEntry list", "description": "Retrieve list of cvpdnTunnelSessionEntry entries from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in the table, containing information about a\n single user session within the tunnel.", "items": { "type": "object", "properties": { "cvpdnTunnelTunnelId": { "type": "string", "description": "cvpdnTunnelTunnelId", "x-yang-type": "leafref" }, "cvpdnTunnelSessionId": { "type": "integer", "description": "The ID of an active VPDN tunnel user session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionUserName": { "type": "string", "description": "The name of the user of the user session.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnTunnelSessionState": { "type": "string", "description": "The current state of an active user session. Each state\n code is explained below:\n \n unknown: The current state of the tunnel's\n session is unknown.\n \n opening: The user session has just been\n initiated through a tunnel and is\n pending for the remote end reply\n to complete the process.\n \n open: The user session is active.\n \n closing: The user session has just been\n closed and is pending for the\n remote end reply to complete the\n process.\n \n waitingForTunnel: The user session is in this state\n when the tunnel which this session\n is going through is still in\n CLOSED state. It waits for the\n tunnel to become OPEN before the\n session is allow to be fully\n established." }, "cvpdnTunnelSessionCallDuration": { "type": "string", "description": "This object specifies the call duration of the current\n active user session in value of system uptime.", "x-yang-type": "yang:timeticks" }, "cvpdnTunnelSessionPacketsOut": { "type": "integer", "description": "The total number of output packets through this active\n user session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionBytesOut": { "type": "integer", "description": "The total number of output bytes through this active\n user session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionPacketsIn": { "type": "integer", "description": "The total number of input packets through this active\n user session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionBytesIn": { "type": "integer", "description": "The total number of input bytes through this active\n user session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionDeviceType": { "type": "string", "description": "The type of physical devices that this user session\n is attached to for the local end of the tunnel. The\n meaning of each device type is explained below:\n \n other: Any device that has not been\n defined.\n \n asyncInternalModem: Modem Pool device of an access\n server.\n \n async: A regular asynchronous serial\n interface.\n \n sync: A regular synchronous serial\n interface.\n \n bchan: An ISDN call.\n \n xdsl: Future application with xDSL\n devices.\n \n cable: Future application with Cable\n modem devices." }, "cvpdnTunnelSessionDeviceCallerId": { "type": "string", "description": "The incoming caller identification of the user. It is\n the originating number that called into the device that\n initiates the user session. This object can be empty\n since not all dial device can provide caller ID\n information.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnTunnelSessionDevicePhyId": { "type": "string", "description": "The device ID of the physical interface for the user\n session. The object is the the interface index which\n points to the ifTable. For virtual interface that is\n not in the ifTable, it will have zero value.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "cvpdnTunnelSessionMultilink": { "type": "boolean", "description": "This object indicates whether the session is part of a\n multilink or not." }, "cvpdnTunnelSessionModemSlotIndex": { "type": "integer", "description": "The Modem Pool database slot index if it is associated\n with this user session. Only a session with device of\n type asyncInternalModem will have a valid value for\n this object.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionModemPortIndex": { "type": "integer", "description": "The Modem Pool database port index if it is associated\n with this user session. Only a session with a device\n of type asyncInternalModem will have a valid value for\n this object.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionDS1SlotIndex": { "type": "integer", "description": "The DS1 database slot index if it is associated with\n this user session. Only a session with a device of\n type asyncInternalModem will have a valid value for\n this object.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionDS1PortIndex": { "type": "integer", "description": "The DS1 database port index if it is associated with\n this user session. Only a session with a device of\n type asyncInternalModem will have a a valid value for\n this object.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionDS1ChannelIndex": { "type": "integer", "description": "The DS1 database channel index if it is associated with\n this user session. Only a session over a device of\n type asyncInternalModem will have a valid value for\n this object.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionModemCallStartTime": { "type": "string", "description": "The start time of the current modem call. Only a\n session with a device of type asyncInternalModem will\n have a valid value for this object.", "x-yang-type": "yang:timestamp" }, "cvpdnTunnelSessionModemCallStartIndex": { "type": "integer", "description": "Arbitrary small integer to distinguish modem calls that\n occurred at the same time tick. Only session over\n device asyncInternalModem will have a valid value for\n this object.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnTunnelSessionEntry": [ { "cvpdnTunnelTunnelId": "example-string", "cvpdnTunnelSessionId": 0, "cvpdnTunnelSessionUserName": "interface-1", "cvpdnTunnelSessionState": "up(1)", "cvpdnTunnelSessionCallDuration": "example-string", "cvpdnTunnelSessionPacketsOut": 1234567890, "cvpdnTunnelSessionBytesOut": 0, "cvpdnTunnelSessionPacketsIn": 1234567890, "cvpdnTunnelSessionBytesIn": 0, "cvpdnTunnelSessionDeviceType": "ethernetCsmacd(6)", "cvpdnTunnelSessionDeviceCallerId": "example-string", "cvpdnTunnelSessionDevicePhyId": "example-string", "cvpdnTunnelSessionMultilink": true, "cvpdnTunnelSessionModemSlotIndex": 1, "cvpdnTunnelSessionModemPortIndex": 1, "cvpdnTunnelSessionDS1SlotIndex": 1, "cvpdnTunnelSessionDS1PortIndex": 1, "cvpdnTunnelSessionDS1ChannelIndex": 1, "cvpdnTunnelSessionModemCallStartTime": "example-string", "cvpdnTunnelSessionModemCallStartIndex": 1 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnTunnelSessionEntry-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": "/cvpdnTunnelSessionEntry", "x-restconf-kind": "container" }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnSessionAttrEntry": { "get": { "summary": "Get cvpdnSessionAttrEntry list", "description": "Retrieve list of cvpdnSessionAttrEntry entries from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in the table, containing information about a\n single session within the tunnel.", "items": { "type": "object", "properties": { "cvpdnSystemTunnelType": { "type": "string", "description": "cvpdnSystemTunnelType", "x-yang-type": "leafref" }, "cvpdnTunnelAttrTunnelId": { "type": "string", "description": "cvpdnTunnelAttrTunnelId", "x-yang-type": "leafref" }, "cvpdnSessionAttrSessionId": { "type": "integer", "description": "The ID of an active VPDN session.", "minimum": -2147483648, "maximum": 2147483647 }, "cvpdnSessionAttrUserName": { "type": "string", "description": "The name of the user of the session.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnSessionAttrState": { "type": "string", "description": "The current state of a tunnel session.\n L2F tunnel sessions will have states with the 'l2f' prefix.\n L2TP tunnel sessions will have states with the 'l2tp'\n prefix.\n \n Each state code is explained below:\n \n unknown: The current state of the tunnel's\n session is unknown.\n \n l2fOpening: The session has just been\n initiated through a tunnel and is\n pending for the remote end reply\n to complete the process.\n \n l2fOpen: The session is active.\n \n l2fCloseWait: The session has just been closed\n and is pending for the remote end\n reply to complete the process.\n \n l2fWaitingForTunnel: The session is in this state when\n the tunnel which this session is\n going through is still in CLOSED\n state. It waits for the tunnel to\n become OPEN before the session is\n allowed to be fully established.\n \n l2tpIdle: No session is initiated yet.\n \n l2tpWaitingTunnel: The session is waiting for the\n tunnel to be established.\n \n l2tpWaitReply: The session has been initiated and\n is pending for the remote end\n reply to complete the process.\n \n l2tpWaitConnect: This end has acknowledged a\n connection request and is waiting\n for the remote end to connect.\n \n l2tpEstablished: The session is active.\n \n l2tpShuttingDown: The session is in progress of\n shutting down.\n \n pptpWaitVAccess: The session is waiting for the\n creation of a virtual access\n interface.\n \n pptpPacEstablished: The session is active.\n \n pptpWaitTunnel: The session is waiting for the\n tunnel to be established.\n \n pptpWaitOCRP: The session has been initiated and\n is pending for the remote end\n reply to complete the process.\n \n pptpPnsEstablished: The session is active.\n \n pptpWaitCallDisc: Session shutdown is in progress." }, "cvpdnSessionAttrCallDuration": { "type": "string", "description": "This object specifies the call duration of the current\n active session.", "x-yang-type": "yang:timeticks" }, "cvpdnSessionAttrPacketsOut": { "type": "integer", "description": "The total number of output packets through this active\n session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrBytesOut": { "type": "integer", "description": "The total number of output bytes through this active\n session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrPacketsIn": { "type": "integer", "description": "The total number of input packets through this active\n session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrBytesIn": { "type": "integer", "description": "The total number of input bytes through this active\n session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrDeviceType": { "type": "string", "description": "The type of physical devices that this session is attached\n to for the local end of the tunnel. The meaning of each\n device type is explained below:\n \n other: Any device that has not been\n defined.\n \n asyncInternalModem: Modem Pool device of an access\n server.\n \n async: A regular asynchronous serial\n interface.\n \n sync: A regular synchronous serial\n interface.\n \n bchan: An ISDN call.\n \n xdsl: xDSL interface.\n \n cable: cable modem interface." }, "cvpdnSessionAttrDeviceCallerId": { "type": "string", "description": "The incoming caller identification of the user. It is the\n originating number that called into the device that\n initiates the session. This object can be empty since not\n all dial devices can provide caller ID information.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnSessionAttrDevicePhyId": { "type": "string", "description": "The device ID of the physical interface for the session.\n The object is the the interface index which points to the\n ifTable. For virtual interfaces that are not in the\n ifTable, the value will be zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "cvpdnSessionAttrMultilink": { "type": "boolean", "description": "This object indicates whether the session is part of a\n multilink PPP bundle, even if there is only one link or\n session in the bundle. If it is multilink PPP, the value\n is true." }, "cvpdnSessionAttrModemSlotIndex": { "type": "integer", "description": "The Modem Pool database slot index if it is associated with\n this session. Only a session with device of type\n 'asyncInternalModem' will have a valid value for this\n object; otherwise, it is not instantiated.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrModemPortIndex": { "type": "integer", "description": "The Modem Pool database port index if it is associated with\n this session. Only a session with a device of type\n 'asyncInternalModem' will have a valid value for this\n object; otherwise, it is not instantiated.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrDS1SlotIndex": { "type": "integer", "description": "The DS1 database slot index if it is associated with this\n session. Only a session with a device of type\n 'asyncInternalModem' will have a valid value for this\n object; otherwise it is not instantiated.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrDS1PortIndex": { "type": "integer", "description": "The DS1 database port index if it is associated with this\n session. Only a session with a device of type\n 'asyncInternalModem' will have a valid value for this\n object; otherwise it is not instantiated.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrDS1ChannelIndex": { "type": "integer", "description": "The DS1 database channel index if it is associated with\n this session. Only a session over a device of type\n 'asyncInternalModem' will have a valid value for this\n object; otherwise it is not instantiated.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrModemCallStartTime": { "type": "string", "description": "The start time of the current modem call. Only a session\n with a device of type 'asyncInternalModem' will have a\n valid value for this object; otherwise, it is not\n instantiated.", "x-yang-type": "yang:timestamp" }, "cvpdnSessionAttrModemCallStartIndex": { "type": "integer", "description": "Arbitrary small integer to distinguish modem calls that\n occurred at the same time tick. Only session over device\n 'asyncInternalModem' will have a valid value for this\n object; otherwise, it is not instantiated.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrVirtualCircuitID": { "type": "integer", "description": "The virtual circuit ID of an active Layer 2 VPN session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrSentPktsDropped": { "type": "integer", "description": "The total number of dropped packets that could not be sent\n into this active session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrRecvPktsDropped": { "type": "integer", "description": "The total number of dropped packets that were received from\n this active session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrMultilinkBundle": { "type": "string", "description": "This object specifies the name of the multilink bundle to\n which this session belongs. The value of this object is\n only valid when the value of cvpdnSessionAttrMultilink is\n 'true'. If the value of cvpdnSessionAttrMultilink is\n 'false', then the value of this object will be the empty\n string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cvpdnSessionAttrMultilinkIfIndex": { "type": "string", "description": "This object specifies the ifIndex of the multilink bundle\n to which this session belongs. The value of this object is\n only valid when the value of cvpdnSessionAttrMultilink is\n 'true'. If the value of cvpdnSessionAttrMultilink is\n 'false', then the value of this object will be zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero" } } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnSessionAttrEntry": [ { "cvpdnSystemTunnelType": "ethernetCsmacd(6)", "cvpdnTunnelAttrTunnelId": "example-string", "cvpdnSessionAttrSessionId": -2147483648, "cvpdnSessionAttrUserName": "interface-1", "cvpdnSessionAttrState": "up(1)", "cvpdnSessionAttrCallDuration": "example-string", "cvpdnSessionAttrPacketsOut": 1234567890, "cvpdnSessionAttrBytesOut": 0, "cvpdnSessionAttrPacketsIn": 1234567890, "cvpdnSessionAttrBytesIn": 0, "cvpdnSessionAttrDeviceType": "ethernetCsmacd(6)", "cvpdnSessionAttrDeviceCallerId": "example-string", "cvpdnSessionAttrDevicePhyId": "example-string", "cvpdnSessionAttrMultilink": true, "cvpdnSessionAttrModemSlotIndex": 1, "cvpdnSessionAttrModemPortIndex": 1, "cvpdnSessionAttrDS1SlotIndex": 1, "cvpdnSessionAttrDS1PortIndex": 1, "cvpdnSessionAttrDS1ChannelIndex": 1, "cvpdnSessionAttrModemCallStartTime": "example-string", "cvpdnSessionAttrModemCallStartIndex": 1, "cvpdnSessionAttrVirtualCircuitID": 0, "cvpdnSessionAttrSentPktsDropped": 0, "cvpdnSessionAttrRecvPktsDropped": 0, "cvpdnSessionAttrMultilinkBundle": "example-string", "cvpdnSessionAttrMultilinkIfIndex": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnSessionAttrEntry-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": "/cvpdnSessionAttrEntry", "x-restconf-kind": "container" }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnUserToFailHistInfoEntry": { "get": { "summary": "Get cvpdnUserToFailHistInfoEntry list", "description": "Retrieve list of cvpdnUserToFailHistInfoEntry entries from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in the table, containing failure history\n relevant to an user name.", "items": { "type": "object", "properties": { "cvpdnUnameToFailHistUname": { "type": "string", "description": "The user name for this failure entry.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnUnameToFailHistTunnelId": { "type": "integer", "description": "The Tunnel ID for this failure entry. If it is the\n instigator of the tunnel, the ID is the TS tunnel ID,\n otherwise it is the NAS tunnel ID.", "minimum": 0, "maximum": 4294967295 }, "cvpdnUnameToFailHistUserId": { "type": "integer", "description": "The user ID of this failure entry.", "minimum": 0, "maximum": 4294967295 }, "cvpdnUnameToFailHistLocalInitConn": { "type": "boolean", "description": "This object indicates whether the tunnel in which the\n failure occurred was generated locally or not." }, "cvpdnUnameToFailHistLocalName": { "type": "string", "description": "The local name of the VPDN tunnel in which the failure\n occurred. It will be the NAS name of the tunnel if the\n system serves as the NAS, or the TS name of the tunnel\n if the system serves as the tunnel server. The local\n name is the configured host name of the system. This\n object can be empty if the failure occurred prior to\n successful tunnel projection, thus no source name will\n be available.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnUnameToFailHistRemoteName": { "type": "string", "description": "The remote name of the VPDN tunnel in which the failure\n occurred. It will be the tunnel server name of the\n tunnel if the system is a NAS, or the NAS name of the\n tunnel if the system serves as the tunnel server. This\n object can be empty if the failure occurred prior to\n successful tunnel projection, thus no source name will\n be available.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnUnameToFailHistSourceIp": { "type": "string", "description": "The source IP address of the tunnel in which the\n failure occurred. This IP address is that of the\n interface at the instigator end of the tunnel.", "format": "inet:ipv4-address" }, "cvpdnUnameToFailHistDestIp": { "type": "string", "description": "The destination IP address of the tunnel in which the\n failure occurred. This IP address is that of the\n interface at the receiver end of the tunnel.", "format": "inet:ipv4-address" }, "cvpdnUnameToFailHistCount": { "type": "integer", "description": "This object is incremented when multiple failures has\n been experienced by this user on this tunnel. Seeing a\n delta of >1 is an indication that the current failure\n record is the latest of a series of failures that has\n been recorded.", "minimum": 0, "maximum": 4294967295 }, "cvpdnUnameToFailHistFailTime": { "type": "string", "description": "This object specifies the time when the failure is\n occurred.", "x-yang-type": "yang:timestamp" }, "cvpdnUnameToFailHistFailType": { "type": "string", "description": "The type of failure for the current failure record. It\n comes in a form of a an ASCII string which describes\n the type of failure.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnUnameToFailHistFailReason": { "type": "string", "description": "The reason of failure for the current failure record.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnUnameToFailHistSourceInetType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnUnameToFailHistSourceInetAddr.", "x-yang-type": "inet-address:InetAddressType" }, "cvpdnUnameToFailHistSourceInetAddr": { "type": "string", "description": "The source IP address of the tunnel in which the\n failure occurred. This IP address is that of the\n interface at the instigator end of the tunnel. The\n instigator end is the peer which initiates the tunnel\n estalishment. The type of this address is determined\n by the value of cvpdnUnameToFailHistSourceInetType.", "x-yang-type": "inet-address:InetAddress" }, "cvpdnUnameToFailHistDestInetType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnUnameToFailHistDestInetAddr.", "x-yang-type": "inet-address:InetAddressType" }, "cvpdnUnameToFailHistDestInetAddr": { "type": "string", "description": "The destination IP address of the tunnel in which the\n failure occurred. This IP address is that of the\n interface at the receiver end of the tunnel. The type \n of this address is determined by the value of \n cvpdnUnameToFailHistDestInetType.", "x-yang-type": "inet-address:InetAddress" } } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnUserToFailHistInfoEntry": [ { "cvpdnUnameToFailHistUname": "interface-1", "cvpdnUnameToFailHistTunnelId": 0, "cvpdnUnameToFailHistUserId": 0, "cvpdnUnameToFailHistLocalInitConn": true, "cvpdnUnameToFailHistLocalName": "interface-1", "cvpdnUnameToFailHistRemoteName": "interface-1", "cvpdnUnameToFailHistSourceIp": "192.168.1.1", "cvpdnUnameToFailHistDestIp": "192.168.1.1", "cvpdnUnameToFailHistCount": 0, "cvpdnUnameToFailHistFailTime": "interface-1", "cvpdnUnameToFailHistFailType": "ethernetCsmacd(6)", "cvpdnUnameToFailHistFailReason": "interface-1", "cvpdnUnameToFailHistSourceInetType": "ethernetCsmacd(6)", "cvpdnUnameToFailHistSourceInetAddr": "192.168.1.1", "cvpdnUnameToFailHistDestInetType": "ethernetCsmacd(6)", "cvpdnUnameToFailHistDestInetAddr": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnUserToFailHistInfoEntry-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": "/cvpdnUserToFailHistInfoEntry", "x-restconf-kind": "container" }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnTemplateEntry": { "get": { "summary": "Get cvpdnTemplateEntry list", "description": "Retrieve list of cvpdnTemplateEntry entries from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in the table, containing information about a\n single VPDN template.", "items": { "type": "object", "properties": { "cvpdnTemplateName": { "type": "string", "description": "The name of the VPDN template.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cvpdnTemplateActiveSessions": { "type": "integer", "description": "The total number of active session in all groups\n associated with the template.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnTemplateEntry": [ { "cvpdnTemplateName": "interface-1", "cvpdnTemplateActiveSessions": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnTemplateEntry-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": "/cvpdnTemplateEntry", "x-restconf-kind": "container" }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnTemplateEntry={cvpdnTemplateName}": { "get": { "summary": "Get cvpdnTemplateEntry entry", "description": "Retrieve specific cvpdnTemplateEntry entry by key from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "parameters": [ { "name": "cvpdnTemplateName", "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": { "cvpdnTemplateName": { "type": "string", "description": "The name of the VPDN template.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cvpdnTemplateActiveSessions": { "type": "integer", "description": "The total number of active session in all groups\n associated with the template.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnTemplateEntry": { "cvpdnTemplateName": "interface-1", "cvpdnTemplateActiveSessions": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnTemplateEntry-4" }, "x-yang-path": "/cvpdnTemplateEntry={cvpdnTemplateName}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cvpdnTemplateName" ] }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnBundleEntry": { "get": { "summary": "Get cvpdnBundleEntry list", "description": "Retrieve list of cvpdnBundleEntry entries from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in this table represents an active multilink PPP\n bundle that belongs to a VPDN tunnel.", "items": { "type": "object", "properties": { "cvpdnBundleName": { "type": "string", "description": "The name of the multilink PPP bundle associated with a VPDN\n tunnel.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cvpdnBundleLinkCount": { "type": "integer", "description": "The total number of active links in a multilink PPP bundle\n associated with a VPDN tunnel.", "minimum": 0, "maximum": 4294967295 }, "cvpdnBundleEndpointType": { "type": "string", "description": "The multilink PPP bundle discriminator type associated with\n a VPDN tunnel. The value of this object represents the type\n of discriminator used in cvpdnBundleEndpoint.\n \n none: No endpoint discriminator was supplied, the\n default value is being used.\n \n hostname: The router's hostname is being used as\n discriminator.\n \n string: User specified string is being used as\n discriminator.\n \n macAddress: A MAC address as defined by the MacAddress\n textual convention is being used as\n discriminator.\n \n ipV4Address: An IP address as defined by the\n InetAddressIPv4 textual convention is being\n used as discriminator.\n \n ipV6Address: An IP address as defined by the\n InetAddressIPv6 textual convention is being\n used as discriminator.\n \n phone: The PSTN phone number is being used as\n discriminator.\n \n magicNumber: A magic number is being used as\n discriminator." }, "cvpdnBundleEndpoint": { "type": "string", "description": "Indicates the discriminator used in this bundle that is\n associated with a VPDN tunnel.", "format": "binary" }, "cvpdnBundlePeerIpAddrType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnBundlePeerIpAddr.", "x-yang-type": "inet-address:InetAddressType" }, "cvpdnBundlePeerIpAddr": { "type": "string", "description": "The IP address of the multilink PPP peer in a VPDN tunnel.", "x-yang-type": "inet-address:InetAddress" }, "cvpdnBundleEndpointClass": { "type": "string", "description": "The multilink PPP bundle discriminator class associated\n with a VPDN tunnel. The value of this object represents the\n type of discriminator used in cvpdnBundleEndpoint.", "x-yang-type": "CISCO-VPDN-MGMT-MIB:EndpointClass" } } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnBundleEntry": [ { "cvpdnBundleName": "interface-1", "cvpdnBundleLinkCount": 0, "cvpdnBundleEndpointType": "ethernetCsmacd(6)", "cvpdnBundleEndpoint": "example-string", "cvpdnBundlePeerIpAddrType": "192.168.1.1", "cvpdnBundlePeerIpAddr": "192.168.1.1", "cvpdnBundleEndpointClass": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnBundleEntry-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": "/cvpdnBundleEntry", "x-restconf-kind": "container" }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnBundleEntry={cvpdnBundleName}": { "get": { "summary": "Get cvpdnBundleEntry entry", "description": "Retrieve specific cvpdnBundleEntry entry by key from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "parameters": [ { "name": "cvpdnBundleName", "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": { "cvpdnBundleName": { "type": "string", "description": "The name of the multilink PPP bundle associated with a VPDN\n tunnel.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cvpdnBundleLinkCount": { "type": "integer", "description": "The total number of active links in a multilink PPP bundle\n associated with a VPDN tunnel.", "minimum": 0, "maximum": 4294967295 }, "cvpdnBundleEndpointType": { "type": "string", "description": "The multilink PPP bundle discriminator type associated with\n a VPDN tunnel. The value of this object represents the type\n of discriminator used in cvpdnBundleEndpoint.\n \n none: No endpoint discriminator was supplied, the\n default value is being used.\n \n hostname: The router's hostname is being used as\n discriminator.\n \n string: User specified string is being used as\n discriminator.\n \n macAddress: A MAC address as defined by the MacAddress\n textual convention is being used as\n discriminator.\n \n ipV4Address: An IP address as defined by the\n InetAddressIPv4 textual convention is being\n used as discriminator.\n \n ipV6Address: An IP address as defined by the\n InetAddressIPv6 textual convention is being\n used as discriminator.\n \n phone: The PSTN phone number is being used as\n discriminator.\n \n magicNumber: A magic number is being used as\n discriminator." }, "cvpdnBundleEndpoint": { "type": "string", "description": "Indicates the discriminator used in this bundle that is\n associated with a VPDN tunnel.", "format": "binary" }, "cvpdnBundlePeerIpAddrType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnBundlePeerIpAddr.", "x-yang-type": "inet-address:InetAddressType" }, "cvpdnBundlePeerIpAddr": { "type": "string", "description": "The IP address of the multilink PPP peer in a VPDN tunnel.", "x-yang-type": "inet-address:InetAddress" }, "cvpdnBundleEndpointClass": { "type": "string", "description": "The multilink PPP bundle discriminator class associated\n with a VPDN tunnel. The value of this object represents the\n type of discriminator used in cvpdnBundleEndpoint.", "x-yang-type": "CISCO-VPDN-MGMT-MIB:EndpointClass" } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnBundleEntry": { "cvpdnBundleName": "interface-1", "cvpdnBundleLinkCount": 0, "cvpdnBundleEndpointType": "ethernetCsmacd(6)", "cvpdnBundleEndpoint": "example-string", "cvpdnBundlePeerIpAddrType": "192.168.1.1", "cvpdnBundlePeerIpAddr": "192.168.1.1", "cvpdnBundleEndpointClass": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnBundleEntry-4" }, "x-yang-path": "/cvpdnBundleEntry={cvpdnBundleName}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cvpdnBundleName" ] }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnBundleChildEntry": { "get": { "summary": "Get cvpdnBundleChildEntry list", "description": "Retrieve list of cvpdnBundleChildEntry entries from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in this table represents a session that belongs to\n a VPDN tunnel and to a multilink PPP bundle.", "items": { "type": "object", "properties": { "cvpdnBundleName": { "type": "string", "description": "cvpdnBundleName", "x-yang-type": "leafref" }, "cvpdnBundleChildTunnelType": { "type": "string", "description": "The tunnel type. This is the tunnel protocol of an active\n VPDN session that is associated with a multilink PPP\n bundle.", "x-yang-type": "CISCO-VPDN-MGMT-MIB:TunnelType" }, "cvpdnBundleChildTunnelId": { "type": "integer", "description": "The Tunnel ID of an active VPDN session that is associated\n with a multilink PPP bundle.", "minimum": 0, "maximum": 4294967295 }, "cvpdnBundleChildSessionId": { "type": "integer", "description": "The ID of an active VPDN session that is associated with a\n multilink PPP bundle.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnBundleChildEntry": [ { "cvpdnBundleName": "interface-1", "cvpdnBundleChildTunnelType": "ethernetCsmacd(6)", "cvpdnBundleChildTunnelId": 0, "cvpdnBundleChildSessionId": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnBundleChildEntry-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": "/cvpdnBundleChildEntry", "x-restconf-kind": "container" }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnTunnelAttrTable/cvpdnTunnelAttrEntry={cvpdnSystemTunnelType},{cvpdnTunnelAttrTunnelId}": { "get": { "summary": "Get cvpdnTunnelAttrEntry entry", "description": "Retrieve specific cvpdnTunnelAttrEntry entry by key from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "parameters": [ { "name": "cvpdnSystemTunnelType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cvpdnTunnelAttrTunnelId", "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": { "cvpdnSystemTunnelType": { "type": "string", "description": "cvpdnSystemTunnelType", "x-yang-type": "leafref" }, "cvpdnTunnelAttrTunnelId": { "type": "integer", "description": "The Tunnel ID of an active VPDN tunnel. If this end is the\n instigator of the tunnel, the ID is the TS tunnel ID,\n otherwise it is the NAS tunnel ID.\n \n Two distinct tunnels with the same tunnel ID may exist, but\n with different tunnel types.", "minimum": -2147483648, "maximum": 2147483647 }, "cvpdnTunnelAttrRemoteTunnelId": { "type": "integer", "description": "The remote Tunnel ID of an active VPDN tunnel. If this end\n is the instigator of the tunnel, the ID is the NAS tunnel\n ID, otherwise it is the TS tunnel ID.", "minimum": -2147483648, "maximum": 2147483647 }, "cvpdnTunnelAttrLocalName": { "type": "string", "description": "The local name of an active VPDN tunnel. It will be the\n NAS name of the tunnel if the system serves as the NAS, or\n the TS name of the tunnel if the system serves as the\n tunnel server. Typically, the local name is the configured\n host name of the system.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnTunnelAttrRemoteName": { "type": "string", "description": "The remote name of an active VPDN tunnel. It will be the\n tunnel server name of the tunnel if the system is a NAS,\n or the NAS name of the tunnel if the system serves as the\n tunnel server.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnTunnelAttrRemoteEndpointName": { "type": "string", "description": "The remote end point name of an active VPDN tunnel. This\n name is either the domain name or the DNIS that this tunnel\n is projected with.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnTunnelAttrLocalInitConnection": { "type": "boolean", "description": "This object indicates whether the tunnel was originated\n locally or not. If it's true, the tunnel was originated\n locally." }, "cvpdnTunnelAttrOrigCause": { "type": "string", "description": "The cause which originated an active VPDN tunnel. The\n tunnel can be projected via domain name, DNIS, stack group,\n or L2 Xconnect." }, "cvpdnTunnelAttrState": { "type": "string", "description": "The current state of an active VPDN tunnel.\n Tunnels of type l2f will have states with the 'l2f' prefix.\n Tunnels of type l2tp will have states with the 'l2tp'\n prefix.\n Tunnels of type pptp will have states with the 'pptp'\n prefix.\n \n Each state code is explained below:\n \n unknown: The current state of the tunnel is\n unknown.\n \n l2fOpening: The tunnel has just been initiated\n and is pending for a remote end\n reply to complete the process.\n \n l2fOpenWait: This end received a tunnel open\n request from the remote end and is\n waiting for the tunnel to be\n established.\n \n l2fOpen: The tunnel is active.\n \n l2fClosing: This end received a tunnel close\n request.\n \n l2fCloseWait: The tunnel has just been shut down\n and is pending for the remote end\n to reply to complete the process.\n \n l2tpIdle: No tunnel is initiated yet.\n \n l2tpWaitCtlReply: The tunnel has been initiated and\n is pending for a remote end reply\n to complete the process.\n \n l2tpEstablished: The tunnel is active.\n \n l2tpShuttingDown: The tunnel is in progress of\n shutting down.\n \n l2tpNoSessionLeft: There is no session left in the\n tunnel.\n \n pptpIdle: No tunnel is initiated yet.\n \n pptpWaitConnect: The tunnel is waiting for a TCP\n connection.\n \n pptpWaitCtlRequest: The tunnel has been initiated and\n is pending for a remote end\n request.\n \n pptpWaitCtlReply: The tunnel has been initiated and\n is pending for a remote end reply.\n \n pptpEstablished: The tunnel is active.\n \n pptpWaitStopReply: The tunnel is being shut down and\n is pending for a remote end reply.\n \n pptpTerminal: The tunnel has been shut down." }, "cvpdnTunnelAttrActiveSessions": { "type": "integer", "description": "The total number of active session currently in the\n tunnel.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelAttrDeniedUsers": { "type": "integer", "description": "A count of the accumulated total of denied users for the\n tunnel.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelAttrSoftshut": { "type": "boolean", "description": "A VPDN tunnel can be put into a soft shut state to prevent\n any new session to be added. This object specifies whether\n this tunnel has been soft shut. If its true, it has been\n soft shut." }, "cvpdnTunnelAttrNetworkServiceType": { "type": "string", "description": "The type of network service used in the active tunnel." }, "cvpdnTunnelAttrLocalIpAddress": { "type": "string", "description": "The local IP address of the tunnel. This IP address is\n that of the interface at the local end of the tunnel.", "format": "inet:ipv4-address" }, "cvpdnTunnelAttrSourceIpAddress": { "type": "string", "description": "The source IP address of the tunnel. This IP address is\n the user configurable IP address for Stack Group Biding\n Protocol.", "format": "inet:ipv4-address" }, "cvpdnTunnelAttrRemoteIpAddress": { "type": "string", "description": "The remote IP address of the tunnel. This IP address is\n that of the interface at the remote end of the tunnel.", "format": "inet:ipv4-address" }, "cvpdnTunnelAttrLocalInetAddressType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnTunnelAttrLocalInetAddress", "x-yang-type": "inet-address:InetAddressType" }, "cvpdnTunnelAttrLocalInetAddress": { "type": "string", "description": "The local IP address of the tunnel. This IP address is\n that of the interface at the local end of the tunnel.\n The type of this address is determined by the value of \n cvpdnTunnelAttrLocalInetAddressType.", "x-yang-type": "inet-address:InetAddress" }, "cvpdnTunnelAttrSourceInetAddressType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnTunnelAttrSourceInetAddress", "x-yang-type": "inet-address:InetAddressType" }, "cvpdnTunnelAttrSourceInetAddress": { "type": "string", "description": "The source IP address of the tunnel. This IP address is\n the user configurable IP address for Stack Group Biding\n Protocol. The type of this address is determined by the \n value of cvpdnTunnelAttrSourceInetAddressType.", "x-yang-type": "inet-address:InetAddress" }, "cvpdnTunnelAttrRemoteInetAddressType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnTunnelAttrRemoteInetAddress", "x-yang-type": "inet-address:InetAddressType" }, "cvpdnTunnelAttrRemoteInetAddress": { "type": "string", "description": "The remote IP address of the tunnel. This IP address is\n that of the interface at the remote end of the tunnel.\n The type of this address is determined by the value of \n cvpdnTunnelAttrRemoteInetAddressType.", "x-yang-type": "inet-address:InetAddress" } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnTunnelAttrEntry": { "cvpdnSystemTunnelType": "ethernetCsmacd(6)", "cvpdnTunnelAttrTunnelId": -2147483648, "cvpdnTunnelAttrRemoteTunnelId": -2147483648, "cvpdnTunnelAttrLocalName": "interface-1", "cvpdnTunnelAttrRemoteName": "interface-1", "cvpdnTunnelAttrRemoteEndpointName": "interface-1", "cvpdnTunnelAttrLocalInitConnection": true, "cvpdnTunnelAttrOrigCause": "example-string", "cvpdnTunnelAttrState": "up(1)", "cvpdnTunnelAttrActiveSessions": 0, "cvpdnTunnelAttrDeniedUsers": 0, "cvpdnTunnelAttrSoftshut": true, "cvpdnTunnelAttrNetworkServiceType": "ethernetCsmacd(6)", "cvpdnTunnelAttrLocalIpAddress": "192.168.1.1", "cvpdnTunnelAttrSourceIpAddress": "192.168.1.1", "cvpdnTunnelAttrRemoteIpAddress": "192.168.1.1", "cvpdnTunnelAttrLocalInetAddressType": "192.168.1.1", "cvpdnTunnelAttrLocalInetAddress": "192.168.1.1", "cvpdnTunnelAttrSourceInetAddressType": "192.168.1.1", "cvpdnTunnelAttrSourceInetAddress": "192.168.1.1", "cvpdnTunnelAttrRemoteInetAddressType": "192.168.1.1", "cvpdnTunnelAttrRemoteInetAddress": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnTunnelAttrEntry-2" }, "x-yang-path": "/cvpdnTunnelAttrTable/cvpdnTunnelAttrEntry={cvpdnSystemTunnelType cvpdnTunnelAttrTunnelId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cvpdnSystemTunnelType cvpdnTunnelAttrTunnelId" ] }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnTunnelSessionTable/cvpdnTunnelSessionEntry={cvpdnTunnelTunnelId},{cvpdnTunnelSessionId}": { "get": { "summary": "Get cvpdnTunnelSessionEntry entry", "description": "Retrieve specific cvpdnTunnelSessionEntry entry by key from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "parameters": [ { "name": "cvpdnTunnelTunnelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cvpdnTunnelSessionId", "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": { "cvpdnTunnelTunnelId": { "type": "string", "description": "cvpdnTunnelTunnelId", "x-yang-type": "leafref" }, "cvpdnTunnelSessionId": { "type": "integer", "description": "The ID of an active VPDN tunnel user session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionUserName": { "type": "string", "description": "The name of the user of the user session.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnTunnelSessionState": { "type": "string", "description": "The current state of an active user session. Each state\n code is explained below:\n \n unknown: The current state of the tunnel's\n session is unknown.\n \n opening: The user session has just been\n initiated through a tunnel and is\n pending for the remote end reply\n to complete the process.\n \n open: The user session is active.\n \n closing: The user session has just been\n closed and is pending for the\n remote end reply to complete the\n process.\n \n waitingForTunnel: The user session is in this state\n when the tunnel which this session\n is going through is still in\n CLOSED state. It waits for the\n tunnel to become OPEN before the\n session is allow to be fully\n established." }, "cvpdnTunnelSessionCallDuration": { "type": "string", "description": "This object specifies the call duration of the current\n active user session in value of system uptime.", "x-yang-type": "yang:timeticks" }, "cvpdnTunnelSessionPacketsOut": { "type": "integer", "description": "The total number of output packets through this active\n user session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionBytesOut": { "type": "integer", "description": "The total number of output bytes through this active\n user session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionPacketsIn": { "type": "integer", "description": "The total number of input packets through this active\n user session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionBytesIn": { "type": "integer", "description": "The total number of input bytes through this active\n user session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionDeviceType": { "type": "string", "description": "The type of physical devices that this user session\n is attached to for the local end of the tunnel. The\n meaning of each device type is explained below:\n \n other: Any device that has not been\n defined.\n \n asyncInternalModem: Modem Pool device of an access\n server.\n \n async: A regular asynchronous serial\n interface.\n \n sync: A regular synchronous serial\n interface.\n \n bchan: An ISDN call.\n \n xdsl: Future application with xDSL\n devices.\n \n cable: Future application with Cable\n modem devices." }, "cvpdnTunnelSessionDeviceCallerId": { "type": "string", "description": "The incoming caller identification of the user. It is\n the originating number that called into the device that\n initiates the user session. This object can be empty\n since not all dial device can provide caller ID\n information.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnTunnelSessionDevicePhyId": { "type": "string", "description": "The device ID of the physical interface for the user\n session. The object is the the interface index which\n points to the ifTable. For virtual interface that is\n not in the ifTable, it will have zero value.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "cvpdnTunnelSessionMultilink": { "type": "boolean", "description": "This object indicates whether the session is part of a\n multilink or not." }, "cvpdnTunnelSessionModemSlotIndex": { "type": "integer", "description": "The Modem Pool database slot index if it is associated\n with this user session. Only a session with device of\n type asyncInternalModem will have a valid value for\n this object.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionModemPortIndex": { "type": "integer", "description": "The Modem Pool database port index if it is associated\n with this user session. Only a session with a device\n of type asyncInternalModem will have a valid value for\n this object.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionDS1SlotIndex": { "type": "integer", "description": "The DS1 database slot index if it is associated with\n this user session. Only a session with a device of\n type asyncInternalModem will have a valid value for\n this object.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionDS1PortIndex": { "type": "integer", "description": "The DS1 database port index if it is associated with\n this user session. Only a session with a device of\n type asyncInternalModem will have a a valid value for\n this object.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionDS1ChannelIndex": { "type": "integer", "description": "The DS1 database channel index if it is associated with\n this user session. Only a session over a device of\n type asyncInternalModem will have a valid value for\n this object.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionModemCallStartTime": { "type": "string", "description": "The start time of the current modem call. Only a\n session with a device of type asyncInternalModem will\n have a valid value for this object.", "x-yang-type": "yang:timestamp" }, "cvpdnTunnelSessionModemCallStartIndex": { "type": "integer", "description": "Arbitrary small integer to distinguish modem calls that\n occurred at the same time tick. Only session over\n device asyncInternalModem will have a valid value for\n this object.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnTunnelSessionEntry": { "cvpdnTunnelTunnelId": "example-string", "cvpdnTunnelSessionId": 0, "cvpdnTunnelSessionUserName": "interface-1", "cvpdnTunnelSessionState": "up(1)", "cvpdnTunnelSessionCallDuration": "example-string", "cvpdnTunnelSessionPacketsOut": 1234567890, "cvpdnTunnelSessionBytesOut": 0, "cvpdnTunnelSessionPacketsIn": 1234567890, "cvpdnTunnelSessionBytesIn": 0, "cvpdnTunnelSessionDeviceType": "ethernetCsmacd(6)", "cvpdnTunnelSessionDeviceCallerId": "example-string", "cvpdnTunnelSessionDevicePhyId": "example-string", "cvpdnTunnelSessionMultilink": true, "cvpdnTunnelSessionModemSlotIndex": 1, "cvpdnTunnelSessionModemPortIndex": 1, "cvpdnTunnelSessionDS1SlotIndex": 1, "cvpdnTunnelSessionDS1PortIndex": 1, "cvpdnTunnelSessionDS1ChannelIndex": 1, "cvpdnTunnelSessionModemCallStartTime": "example-string", "cvpdnTunnelSessionModemCallStartIndex": 1 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnTunnelSessionEntry-2" }, "x-yang-path": "/cvpdnTunnelSessionTable/cvpdnTunnelSessionEntry={cvpdnTunnelTunnelId cvpdnTunnelSessionId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cvpdnTunnelTunnelId cvpdnTunnelSessionId" ] }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnSessionAttrTable/cvpdnSessionAttrEntry={cvpdnSystemTunnelType},{cvpdnTunnelAttrTunnelId},{cvpdnSessionAttrSessionId}": { "get": { "summary": "Get cvpdnSessionAttrEntry entry", "description": "Retrieve specific cvpdnSessionAttrEntry entry by key from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "parameters": [ { "name": "cvpdnSystemTunnelType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cvpdnTunnelAttrTunnelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cvpdnSessionAttrSessionId", "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": { "cvpdnSystemTunnelType": { "type": "string", "description": "cvpdnSystemTunnelType", "x-yang-type": "leafref" }, "cvpdnTunnelAttrTunnelId": { "type": "string", "description": "cvpdnTunnelAttrTunnelId", "x-yang-type": "leafref" }, "cvpdnSessionAttrSessionId": { "type": "integer", "description": "The ID of an active VPDN session.", "minimum": -2147483648, "maximum": 2147483647 }, "cvpdnSessionAttrUserName": { "type": "string", "description": "The name of the user of the session.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnSessionAttrState": { "type": "string", "description": "The current state of a tunnel session.\n L2F tunnel sessions will have states with the 'l2f' prefix.\n L2TP tunnel sessions will have states with the 'l2tp'\n prefix.\n \n Each state code is explained below:\n \n unknown: The current state of the tunnel's\n session is unknown.\n \n l2fOpening: The session has just been\n initiated through a tunnel and is\n pending for the remote end reply\n to complete the process.\n \n l2fOpen: The session is active.\n \n l2fCloseWait: The session has just been closed\n and is pending for the remote end\n reply to complete the process.\n \n l2fWaitingForTunnel: The session is in this state when\n the tunnel which this session is\n going through is still in CLOSED\n state. It waits for the tunnel to\n become OPEN before the session is\n allowed to be fully established.\n \n l2tpIdle: No session is initiated yet.\n \n l2tpWaitingTunnel: The session is waiting for the\n tunnel to be established.\n \n l2tpWaitReply: The session has been initiated and\n is pending for the remote end\n reply to complete the process.\n \n l2tpWaitConnect: This end has acknowledged a\n connection request and is waiting\n for the remote end to connect.\n \n l2tpEstablished: The session is active.\n \n l2tpShuttingDown: The session is in progress of\n shutting down.\n \n pptpWaitVAccess: The session is waiting for the\n creation of a virtual access\n interface.\n \n pptpPacEstablished: The session is active.\n \n pptpWaitTunnel: The session is waiting for the\n tunnel to be established.\n \n pptpWaitOCRP: The session has been initiated and\n is pending for the remote end\n reply to complete the process.\n \n pptpPnsEstablished: The session is active.\n \n pptpWaitCallDisc: Session shutdown is in progress." }, "cvpdnSessionAttrCallDuration": { "type": "string", "description": "This object specifies the call duration of the current\n active session.", "x-yang-type": "yang:timeticks" }, "cvpdnSessionAttrPacketsOut": { "type": "integer", "description": "The total number of output packets through this active\n session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrBytesOut": { "type": "integer", "description": "The total number of output bytes through this active\n session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrPacketsIn": { "type": "integer", "description": "The total number of input packets through this active\n session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrBytesIn": { "type": "integer", "description": "The total number of input bytes through this active\n session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrDeviceType": { "type": "string", "description": "The type of physical devices that this session is attached\n to for the local end of the tunnel. The meaning of each\n device type is explained below:\n \n other: Any device that has not been\n defined.\n \n asyncInternalModem: Modem Pool device of an access\n server.\n \n async: A regular asynchronous serial\n interface.\n \n sync: A regular synchronous serial\n interface.\n \n bchan: An ISDN call.\n \n xdsl: xDSL interface.\n \n cable: cable modem interface." }, "cvpdnSessionAttrDeviceCallerId": { "type": "string", "description": "The incoming caller identification of the user. It is the\n originating number that called into the device that\n initiates the session. This object can be empty since not\n all dial devices can provide caller ID information.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnSessionAttrDevicePhyId": { "type": "string", "description": "The device ID of the physical interface for the session.\n The object is the the interface index which points to the\n ifTable. For virtual interfaces that are not in the\n ifTable, the value will be zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "cvpdnSessionAttrMultilink": { "type": "boolean", "description": "This object indicates whether the session is part of a\n multilink PPP bundle, even if there is only one link or\n session in the bundle. If it is multilink PPP, the value\n is true." }, "cvpdnSessionAttrModemSlotIndex": { "type": "integer", "description": "The Modem Pool database slot index if it is associated with\n this session. Only a session with device of type\n 'asyncInternalModem' will have a valid value for this\n object; otherwise, it is not instantiated.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrModemPortIndex": { "type": "integer", "description": "The Modem Pool database port index if it is associated with\n this session. Only a session with a device of type\n 'asyncInternalModem' will have a valid value for this\n object; otherwise, it is not instantiated.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrDS1SlotIndex": { "type": "integer", "description": "The DS1 database slot index if it is associated with this\n session. Only a session with a device of type\n 'asyncInternalModem' will have a valid value for this\n object; otherwise it is not instantiated.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrDS1PortIndex": { "type": "integer", "description": "The DS1 database port index if it is associated with this\n session. Only a session with a device of type\n 'asyncInternalModem' will have a valid value for this\n object; otherwise it is not instantiated.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrDS1ChannelIndex": { "type": "integer", "description": "The DS1 database channel index if it is associated with\n this session. Only a session over a device of type\n 'asyncInternalModem' will have a valid value for this\n object; otherwise it is not instantiated.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrModemCallStartTime": { "type": "string", "description": "The start time of the current modem call. Only a session\n with a device of type 'asyncInternalModem' will have a\n valid value for this object; otherwise, it is not\n instantiated.", "x-yang-type": "yang:timestamp" }, "cvpdnSessionAttrModemCallStartIndex": { "type": "integer", "description": "Arbitrary small integer to distinguish modem calls that\n occurred at the same time tick. Only session over device\n 'asyncInternalModem' will have a valid value for this\n object; otherwise, it is not instantiated.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrVirtualCircuitID": { "type": "integer", "description": "The virtual circuit ID of an active Layer 2 VPN session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrSentPktsDropped": { "type": "integer", "description": "The total number of dropped packets that could not be sent\n into this active session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrRecvPktsDropped": { "type": "integer", "description": "The total number of dropped packets that were received from\n this active session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrMultilinkBundle": { "type": "string", "description": "This object specifies the name of the multilink bundle to\n which this session belongs. The value of this object is\n only valid when the value of cvpdnSessionAttrMultilink is\n 'true'. If the value of cvpdnSessionAttrMultilink is\n 'false', then the value of this object will be the empty\n string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cvpdnSessionAttrMultilinkIfIndex": { "type": "string", "description": "This object specifies the ifIndex of the multilink bundle\n to which this session belongs. The value of this object is\n only valid when the value of cvpdnSessionAttrMultilink is\n 'true'. If the value of cvpdnSessionAttrMultilink is\n 'false', then the value of this object will be zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero" } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnSessionAttrEntry": { "cvpdnSystemTunnelType": "ethernetCsmacd(6)", "cvpdnTunnelAttrTunnelId": "example-string", "cvpdnSessionAttrSessionId": -2147483648, "cvpdnSessionAttrUserName": "interface-1", "cvpdnSessionAttrState": "up(1)", "cvpdnSessionAttrCallDuration": "example-string", "cvpdnSessionAttrPacketsOut": 1234567890, "cvpdnSessionAttrBytesOut": 0, "cvpdnSessionAttrPacketsIn": 1234567890, "cvpdnSessionAttrBytesIn": 0, "cvpdnSessionAttrDeviceType": "ethernetCsmacd(6)", "cvpdnSessionAttrDeviceCallerId": "example-string", "cvpdnSessionAttrDevicePhyId": "example-string", "cvpdnSessionAttrMultilink": true, "cvpdnSessionAttrModemSlotIndex": 1, "cvpdnSessionAttrModemPortIndex": 1, "cvpdnSessionAttrDS1SlotIndex": 1, "cvpdnSessionAttrDS1PortIndex": 1, "cvpdnSessionAttrDS1ChannelIndex": 1, "cvpdnSessionAttrModemCallStartTime": "example-string", "cvpdnSessionAttrModemCallStartIndex": 1, "cvpdnSessionAttrVirtualCircuitID": 0, "cvpdnSessionAttrSentPktsDropped": 0, "cvpdnSessionAttrRecvPktsDropped": 0, "cvpdnSessionAttrMultilinkBundle": "example-string", "cvpdnSessionAttrMultilinkIfIndex": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnSessionAttrEntry-2" }, "x-yang-path": "/cvpdnSessionAttrTable/cvpdnSessionAttrEntry={cvpdnSystemTunnelType cvpdnTunnelAttrTunnelId cvpdnSessionAttrSessionId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cvpdnSystemTunnelType cvpdnTunnelAttrTunnelId cvpdnSessionAttrSessionId" ] }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnUserToFailHistInfoTable/cvpdnUserToFailHistInfoEntry={cvpdnUnameToFailHistUname},{cvpdnUnameToFailHistTunnelId}": { "get": { "summary": "Get cvpdnUserToFailHistInfoEntry entry", "description": "Retrieve specific cvpdnUserToFailHistInfoEntry entry by key from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "parameters": [ { "name": "cvpdnUnameToFailHistUname", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cvpdnUnameToFailHistTunnelId", "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": { "cvpdnUnameToFailHistUname": { "type": "string", "description": "The user name for this failure entry.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnUnameToFailHistTunnelId": { "type": "integer", "description": "The Tunnel ID for this failure entry. If it is the\n instigator of the tunnel, the ID is the TS tunnel ID,\n otherwise it is the NAS tunnel ID.", "minimum": 0, "maximum": 4294967295 }, "cvpdnUnameToFailHistUserId": { "type": "integer", "description": "The user ID of this failure entry.", "minimum": 0, "maximum": 4294967295 }, "cvpdnUnameToFailHistLocalInitConn": { "type": "boolean", "description": "This object indicates whether the tunnel in which the\n failure occurred was generated locally or not." }, "cvpdnUnameToFailHistLocalName": { "type": "string", "description": "The local name of the VPDN tunnel in which the failure\n occurred. It will be the NAS name of the tunnel if the\n system serves as the NAS, or the TS name of the tunnel\n if the system serves as the tunnel server. The local\n name is the configured host name of the system. This\n object can be empty if the failure occurred prior to\n successful tunnel projection, thus no source name will\n be available.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnUnameToFailHistRemoteName": { "type": "string", "description": "The remote name of the VPDN tunnel in which the failure\n occurred. It will be the tunnel server name of the\n tunnel if the system is a NAS, or the NAS name of the\n tunnel if the system serves as the tunnel server. This\n object can be empty if the failure occurred prior to\n successful tunnel projection, thus no source name will\n be available.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnUnameToFailHistSourceIp": { "type": "string", "description": "The source IP address of the tunnel in which the\n failure occurred. This IP address is that of the\n interface at the instigator end of the tunnel.", "format": "inet:ipv4-address" }, "cvpdnUnameToFailHistDestIp": { "type": "string", "description": "The destination IP address of the tunnel in which the\n failure occurred. This IP address is that of the\n interface at the receiver end of the tunnel.", "format": "inet:ipv4-address" }, "cvpdnUnameToFailHistCount": { "type": "integer", "description": "This object is incremented when multiple failures has\n been experienced by this user on this tunnel. Seeing a\n delta of >1 is an indication that the current failure\n record is the latest of a series of failures that has\n been recorded.", "minimum": 0, "maximum": 4294967295 }, "cvpdnUnameToFailHistFailTime": { "type": "string", "description": "This object specifies the time when the failure is\n occurred.", "x-yang-type": "yang:timestamp" }, "cvpdnUnameToFailHistFailType": { "type": "string", "description": "The type of failure for the current failure record. It\n comes in a form of a an ASCII string which describes\n the type of failure.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnUnameToFailHistFailReason": { "type": "string", "description": "The reason of failure for the current failure record.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnUnameToFailHistSourceInetType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnUnameToFailHistSourceInetAddr.", "x-yang-type": "inet-address:InetAddressType" }, "cvpdnUnameToFailHistSourceInetAddr": { "type": "string", "description": "The source IP address of the tunnel in which the\n failure occurred. This IP address is that of the\n interface at the instigator end of the tunnel. The\n instigator end is the peer which initiates the tunnel\n estalishment. The type of this address is determined\n by the value of cvpdnUnameToFailHistSourceInetType.", "x-yang-type": "inet-address:InetAddress" }, "cvpdnUnameToFailHistDestInetType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnUnameToFailHistDestInetAddr.", "x-yang-type": "inet-address:InetAddressType" }, "cvpdnUnameToFailHistDestInetAddr": { "type": "string", "description": "The destination IP address of the tunnel in which the\n failure occurred. This IP address is that of the\n interface at the receiver end of the tunnel. The type \n of this address is determined by the value of \n cvpdnUnameToFailHistDestInetType.", "x-yang-type": "inet-address:InetAddress" } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnUserToFailHistInfoEntry": { "cvpdnUnameToFailHistUname": "interface-1", "cvpdnUnameToFailHistTunnelId": 0, "cvpdnUnameToFailHistUserId": 0, "cvpdnUnameToFailHistLocalInitConn": true, "cvpdnUnameToFailHistLocalName": "interface-1", "cvpdnUnameToFailHistRemoteName": "interface-1", "cvpdnUnameToFailHistSourceIp": "192.168.1.1", "cvpdnUnameToFailHistDestIp": "192.168.1.1", "cvpdnUnameToFailHistCount": 0, "cvpdnUnameToFailHistFailTime": "interface-1", "cvpdnUnameToFailHistFailType": "ethernetCsmacd(6)", "cvpdnUnameToFailHistFailReason": "interface-1", "cvpdnUnameToFailHistSourceInetType": "ethernetCsmacd(6)", "cvpdnUnameToFailHistSourceInetAddr": "192.168.1.1", "cvpdnUnameToFailHistDestInetType": "ethernetCsmacd(6)", "cvpdnUnameToFailHistDestInetAddr": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnUserToFailHistInfoEntry-2" }, "x-yang-path": "/cvpdnUserToFailHistInfoTable/cvpdnUserToFailHistInfoEntry={cvpdnUnameToFailHistUname cvpdnUnameToFailHistTunnelId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cvpdnUnameToFailHistUname cvpdnUnameToFailHistTunnelId" ] }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnBundleChildTable/cvpdnBundleChildEntry={cvpdnBundleName},{cvpdnBundleChildTunnelType},{cvpdnBundleChildTunnelId},{cvpdnBundleChildSessionId}": { "get": { "summary": "Get cvpdnBundleChildEntry entry", "description": "Retrieve specific cvpdnBundleChildEntry entry by key from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "parameters": [ { "name": "cvpdnBundleName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cvpdnBundleChildTunnelType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cvpdnBundleChildTunnelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cvpdnBundleChildSessionId", "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": { "cvpdnBundleName": { "type": "string", "description": "cvpdnBundleName", "x-yang-type": "leafref" }, "cvpdnBundleChildTunnelType": { "type": "string", "description": "The tunnel type. This is the tunnel protocol of an active\n VPDN session that is associated with a multilink PPP\n bundle.", "x-yang-type": "CISCO-VPDN-MGMT-MIB:TunnelType" }, "cvpdnBundleChildTunnelId": { "type": "integer", "description": "The Tunnel ID of an active VPDN session that is associated\n with a multilink PPP bundle.", "minimum": 0, "maximum": 4294967295 }, "cvpdnBundleChildSessionId": { "type": "integer", "description": "The ID of an active VPDN session that is associated with a\n multilink PPP bundle.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnBundleChildEntry": { "cvpdnBundleName": "interface-1", "cvpdnBundleChildTunnelType": "ethernetCsmacd(6)", "cvpdnBundleChildTunnelId": 0, "cvpdnBundleChildSessionId": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnBundleChildEntry-2" }, "x-yang-path": "/cvpdnBundleChildTable/cvpdnBundleChildEntry={cvpdnBundleName cvpdnBundleChildTunnelType cvpdnBundleChildTunnelId cvpdnBundleChildSessionId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cvpdnBundleName cvpdnBundleChildTunnelType cvpdnBundleChildTunnelId cvpdnBundleChildSessionId" ] }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnTunnelAttrEntry={cvpdnSystemTunnelType},{cvpdnTunnelAttrTunnelId}": { "get": { "summary": "Get cvpdnTunnelAttrEntry entry", "description": "Retrieve specific cvpdnTunnelAttrEntry entry by key from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "parameters": [ { "name": "cvpdnSystemTunnelType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cvpdnTunnelAttrTunnelId", "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": { "cvpdnSystemTunnelType": { "type": "string", "description": "cvpdnSystemTunnelType", "x-yang-type": "leafref" }, "cvpdnTunnelAttrTunnelId": { "type": "integer", "description": "The Tunnel ID of an active VPDN tunnel. If this end is the\n instigator of the tunnel, the ID is the TS tunnel ID,\n otherwise it is the NAS tunnel ID.\n \n Two distinct tunnels with the same tunnel ID may exist, but\n with different tunnel types.", "minimum": -2147483648, "maximum": 2147483647 }, "cvpdnTunnelAttrRemoteTunnelId": { "type": "integer", "description": "The remote Tunnel ID of an active VPDN tunnel. If this end\n is the instigator of the tunnel, the ID is the NAS tunnel\n ID, otherwise it is the TS tunnel ID.", "minimum": -2147483648, "maximum": 2147483647 }, "cvpdnTunnelAttrLocalName": { "type": "string", "description": "The local name of an active VPDN tunnel. It will be the\n NAS name of the tunnel if the system serves as the NAS, or\n the TS name of the tunnel if the system serves as the\n tunnel server. Typically, the local name is the configured\n host name of the system.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnTunnelAttrRemoteName": { "type": "string", "description": "The remote name of an active VPDN tunnel. It will be the\n tunnel server name of the tunnel if the system is a NAS,\n or the NAS name of the tunnel if the system serves as the\n tunnel server.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnTunnelAttrRemoteEndpointName": { "type": "string", "description": "The remote end point name of an active VPDN tunnel. This\n name is either the domain name or the DNIS that this tunnel\n is projected with.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnTunnelAttrLocalInitConnection": { "type": "boolean", "description": "This object indicates whether the tunnel was originated\n locally or not. If it's true, the tunnel was originated\n locally." }, "cvpdnTunnelAttrOrigCause": { "type": "string", "description": "The cause which originated an active VPDN tunnel. The\n tunnel can be projected via domain name, DNIS, stack group,\n or L2 Xconnect." }, "cvpdnTunnelAttrState": { "type": "string", "description": "The current state of an active VPDN tunnel.\n Tunnels of type l2f will have states with the 'l2f' prefix.\n Tunnels of type l2tp will have states with the 'l2tp'\n prefix.\n Tunnels of type pptp will have states with the 'pptp'\n prefix.\n \n Each state code is explained below:\n \n unknown: The current state of the tunnel is\n unknown.\n \n l2fOpening: The tunnel has just been initiated\n and is pending for a remote end\n reply to complete the process.\n \n l2fOpenWait: This end received a tunnel open\n request from the remote end and is\n waiting for the tunnel to be\n established.\n \n l2fOpen: The tunnel is active.\n \n l2fClosing: This end received a tunnel close\n request.\n \n l2fCloseWait: The tunnel has just been shut down\n and is pending for the remote end\n to reply to complete the process.\n \n l2tpIdle: No tunnel is initiated yet.\n \n l2tpWaitCtlReply: The tunnel has been initiated and\n is pending for a remote end reply\n to complete the process.\n \n l2tpEstablished: The tunnel is active.\n \n l2tpShuttingDown: The tunnel is in progress of\n shutting down.\n \n l2tpNoSessionLeft: There is no session left in the\n tunnel.\n \n pptpIdle: No tunnel is initiated yet.\n \n pptpWaitConnect: The tunnel is waiting for a TCP\n connection.\n \n pptpWaitCtlRequest: The tunnel has been initiated and\n is pending for a remote end\n request.\n \n pptpWaitCtlReply: The tunnel has been initiated and\n is pending for a remote end reply.\n \n pptpEstablished: The tunnel is active.\n \n pptpWaitStopReply: The tunnel is being shut down and\n is pending for a remote end reply.\n \n pptpTerminal: The tunnel has been shut down." }, "cvpdnTunnelAttrActiveSessions": { "type": "integer", "description": "The total number of active session currently in the\n tunnel.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelAttrDeniedUsers": { "type": "integer", "description": "A count of the accumulated total of denied users for the\n tunnel.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelAttrSoftshut": { "type": "boolean", "description": "A VPDN tunnel can be put into a soft shut state to prevent\n any new session to be added. This object specifies whether\n this tunnel has been soft shut. If its true, it has been\n soft shut." }, "cvpdnTunnelAttrNetworkServiceType": { "type": "string", "description": "The type of network service used in the active tunnel." }, "cvpdnTunnelAttrLocalIpAddress": { "type": "string", "description": "The local IP address of the tunnel. This IP address is\n that of the interface at the local end of the tunnel.", "format": "inet:ipv4-address" }, "cvpdnTunnelAttrSourceIpAddress": { "type": "string", "description": "The source IP address of the tunnel. This IP address is\n the user configurable IP address for Stack Group Biding\n Protocol.", "format": "inet:ipv4-address" }, "cvpdnTunnelAttrRemoteIpAddress": { "type": "string", "description": "The remote IP address of the tunnel. This IP address is\n that of the interface at the remote end of the tunnel.", "format": "inet:ipv4-address" }, "cvpdnTunnelAttrLocalInetAddressType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnTunnelAttrLocalInetAddress", "x-yang-type": "inet-address:InetAddressType" }, "cvpdnTunnelAttrLocalInetAddress": { "type": "string", "description": "The local IP address of the tunnel. This IP address is\n that of the interface at the local end of the tunnel.\n The type of this address is determined by the value of \n cvpdnTunnelAttrLocalInetAddressType.", "x-yang-type": "inet-address:InetAddress" }, "cvpdnTunnelAttrSourceInetAddressType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnTunnelAttrSourceInetAddress", "x-yang-type": "inet-address:InetAddressType" }, "cvpdnTunnelAttrSourceInetAddress": { "type": "string", "description": "The source IP address of the tunnel. This IP address is\n the user configurable IP address for Stack Group Biding\n Protocol. The type of this address is determined by the \n value of cvpdnTunnelAttrSourceInetAddressType.", "x-yang-type": "inet-address:InetAddress" }, "cvpdnTunnelAttrRemoteInetAddressType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnTunnelAttrRemoteInetAddress", "x-yang-type": "inet-address:InetAddressType" }, "cvpdnTunnelAttrRemoteInetAddress": { "type": "string", "description": "The remote IP address of the tunnel. This IP address is\n that of the interface at the remote end of the tunnel.\n The type of this address is determined by the value of \n cvpdnTunnelAttrRemoteInetAddressType.", "x-yang-type": "inet-address:InetAddress" } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnTunnelAttrEntry": { "cvpdnSystemTunnelType": "ethernetCsmacd(6)", "cvpdnTunnelAttrTunnelId": -2147483648, "cvpdnTunnelAttrRemoteTunnelId": -2147483648, "cvpdnTunnelAttrLocalName": "interface-1", "cvpdnTunnelAttrRemoteName": "interface-1", "cvpdnTunnelAttrRemoteEndpointName": "interface-1", "cvpdnTunnelAttrLocalInitConnection": true, "cvpdnTunnelAttrOrigCause": "example-string", "cvpdnTunnelAttrState": "up(1)", "cvpdnTunnelAttrActiveSessions": 0, "cvpdnTunnelAttrDeniedUsers": 0, "cvpdnTunnelAttrSoftshut": true, "cvpdnTunnelAttrNetworkServiceType": "ethernetCsmacd(6)", "cvpdnTunnelAttrLocalIpAddress": "192.168.1.1", "cvpdnTunnelAttrSourceIpAddress": "192.168.1.1", "cvpdnTunnelAttrRemoteIpAddress": "192.168.1.1", "cvpdnTunnelAttrLocalInetAddressType": "192.168.1.1", "cvpdnTunnelAttrLocalInetAddress": "192.168.1.1", "cvpdnTunnelAttrSourceInetAddressType": "192.168.1.1", "cvpdnTunnelAttrSourceInetAddress": "192.168.1.1", "cvpdnTunnelAttrRemoteInetAddressType": "192.168.1.1", "cvpdnTunnelAttrRemoteInetAddress": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnTunnelAttrEntry-4" }, "x-yang-path": "/cvpdnTunnelAttrEntry={cvpdnSystemTunnelType cvpdnTunnelAttrTunnelId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cvpdnSystemTunnelType cvpdnTunnelAttrTunnelId" ] }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnTunnelSessionEntry={cvpdnTunnelTunnelId},{cvpdnTunnelSessionId}": { "get": { "summary": "Get cvpdnTunnelSessionEntry entry", "description": "Retrieve specific cvpdnTunnelSessionEntry entry by key from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "parameters": [ { "name": "cvpdnTunnelTunnelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cvpdnTunnelSessionId", "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": { "cvpdnTunnelTunnelId": { "type": "string", "description": "cvpdnTunnelTunnelId", "x-yang-type": "leafref" }, "cvpdnTunnelSessionId": { "type": "integer", "description": "The ID of an active VPDN tunnel user session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionUserName": { "type": "string", "description": "The name of the user of the user session.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnTunnelSessionState": { "type": "string", "description": "The current state of an active user session. Each state\n code is explained below:\n \n unknown: The current state of the tunnel's\n session is unknown.\n \n opening: The user session has just been\n initiated through a tunnel and is\n pending for the remote end reply\n to complete the process.\n \n open: The user session is active.\n \n closing: The user session has just been\n closed and is pending for the\n remote end reply to complete the\n process.\n \n waitingForTunnel: The user session is in this state\n when the tunnel which this session\n is going through is still in\n CLOSED state. It waits for the\n tunnel to become OPEN before the\n session is allow to be fully\n established." }, "cvpdnTunnelSessionCallDuration": { "type": "string", "description": "This object specifies the call duration of the current\n active user session in value of system uptime.", "x-yang-type": "yang:timeticks" }, "cvpdnTunnelSessionPacketsOut": { "type": "integer", "description": "The total number of output packets through this active\n user session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionBytesOut": { "type": "integer", "description": "The total number of output bytes through this active\n user session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionPacketsIn": { "type": "integer", "description": "The total number of input packets through this active\n user session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionBytesIn": { "type": "integer", "description": "The total number of input bytes through this active\n user session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionDeviceType": { "type": "string", "description": "The type of physical devices that this user session\n is attached to for the local end of the tunnel. The\n meaning of each device type is explained below:\n \n other: Any device that has not been\n defined.\n \n asyncInternalModem: Modem Pool device of an access\n server.\n \n async: A regular asynchronous serial\n interface.\n \n sync: A regular synchronous serial\n interface.\n \n bchan: An ISDN call.\n \n xdsl: Future application with xDSL\n devices.\n \n cable: Future application with Cable\n modem devices." }, "cvpdnTunnelSessionDeviceCallerId": { "type": "string", "description": "The incoming caller identification of the user. It is\n the originating number that called into the device that\n initiates the user session. This object can be empty\n since not all dial device can provide caller ID\n information.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnTunnelSessionDevicePhyId": { "type": "string", "description": "The device ID of the physical interface for the user\n session. The object is the the interface index which\n points to the ifTable. For virtual interface that is\n not in the ifTable, it will have zero value.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "cvpdnTunnelSessionMultilink": { "type": "boolean", "description": "This object indicates whether the session is part of a\n multilink or not." }, "cvpdnTunnelSessionModemSlotIndex": { "type": "integer", "description": "The Modem Pool database slot index if it is associated\n with this user session. Only a session with device of\n type asyncInternalModem will have a valid value for\n this object.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionModemPortIndex": { "type": "integer", "description": "The Modem Pool database port index if it is associated\n with this user session. Only a session with a device\n of type asyncInternalModem will have a valid value for\n this object.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionDS1SlotIndex": { "type": "integer", "description": "The DS1 database slot index if it is associated with\n this user session. Only a session with a device of\n type asyncInternalModem will have a valid value for\n this object.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionDS1PortIndex": { "type": "integer", "description": "The DS1 database port index if it is associated with\n this user session. Only a session with a device of\n type asyncInternalModem will have a a valid value for\n this object.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionDS1ChannelIndex": { "type": "integer", "description": "The DS1 database channel index if it is associated with\n this user session. Only a session over a device of\n type asyncInternalModem will have a valid value for\n this object.", "minimum": 0, "maximum": 4294967295 }, "cvpdnTunnelSessionModemCallStartTime": { "type": "string", "description": "The start time of the current modem call. Only a\n session with a device of type asyncInternalModem will\n have a valid value for this object.", "x-yang-type": "yang:timestamp" }, "cvpdnTunnelSessionModemCallStartIndex": { "type": "integer", "description": "Arbitrary small integer to distinguish modem calls that\n occurred at the same time tick. Only session over\n device asyncInternalModem will have a valid value for\n this object.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnTunnelSessionEntry": { "cvpdnTunnelTunnelId": "example-string", "cvpdnTunnelSessionId": 0, "cvpdnTunnelSessionUserName": "interface-1", "cvpdnTunnelSessionState": "up(1)", "cvpdnTunnelSessionCallDuration": "example-string", "cvpdnTunnelSessionPacketsOut": 1234567890, "cvpdnTunnelSessionBytesOut": 0, "cvpdnTunnelSessionPacketsIn": 1234567890, "cvpdnTunnelSessionBytesIn": 0, "cvpdnTunnelSessionDeviceType": "ethernetCsmacd(6)", "cvpdnTunnelSessionDeviceCallerId": "example-string", "cvpdnTunnelSessionDevicePhyId": "example-string", "cvpdnTunnelSessionMultilink": true, "cvpdnTunnelSessionModemSlotIndex": 1, "cvpdnTunnelSessionModemPortIndex": 1, "cvpdnTunnelSessionDS1SlotIndex": 1, "cvpdnTunnelSessionDS1PortIndex": 1, "cvpdnTunnelSessionDS1ChannelIndex": 1, "cvpdnTunnelSessionModemCallStartTime": "example-string", "cvpdnTunnelSessionModemCallStartIndex": 1 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnTunnelSessionEntry-4" }, "x-yang-path": "/cvpdnTunnelSessionEntry={cvpdnTunnelTunnelId cvpdnTunnelSessionId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cvpdnTunnelTunnelId cvpdnTunnelSessionId" ] }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnSessionAttrEntry={cvpdnSystemTunnelType},{cvpdnTunnelAttrTunnelId},{cvpdnSessionAttrSessionId}": { "get": { "summary": "Get cvpdnSessionAttrEntry entry", "description": "Retrieve specific cvpdnSessionAttrEntry entry by key from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "parameters": [ { "name": "cvpdnSystemTunnelType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cvpdnTunnelAttrTunnelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cvpdnSessionAttrSessionId", "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": { "cvpdnSystemTunnelType": { "type": "string", "description": "cvpdnSystemTunnelType", "x-yang-type": "leafref" }, "cvpdnTunnelAttrTunnelId": { "type": "string", "description": "cvpdnTunnelAttrTunnelId", "x-yang-type": "leafref" }, "cvpdnSessionAttrSessionId": { "type": "integer", "description": "The ID of an active VPDN session.", "minimum": -2147483648, "maximum": 2147483647 }, "cvpdnSessionAttrUserName": { "type": "string", "description": "The name of the user of the session.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnSessionAttrState": { "type": "string", "description": "The current state of a tunnel session.\n L2F tunnel sessions will have states with the 'l2f' prefix.\n L2TP tunnel sessions will have states with the 'l2tp'\n prefix.\n \n Each state code is explained below:\n \n unknown: The current state of the tunnel's\n session is unknown.\n \n l2fOpening: The session has just been\n initiated through a tunnel and is\n pending for the remote end reply\n to complete the process.\n \n l2fOpen: The session is active.\n \n l2fCloseWait: The session has just been closed\n and is pending for the remote end\n reply to complete the process.\n \n l2fWaitingForTunnel: The session is in this state when\n the tunnel which this session is\n going through is still in CLOSED\n state. It waits for the tunnel to\n become OPEN before the session is\n allowed to be fully established.\n \n l2tpIdle: No session is initiated yet.\n \n l2tpWaitingTunnel: The session is waiting for the\n tunnel to be established.\n \n l2tpWaitReply: The session has been initiated and\n is pending for the remote end\n reply to complete the process.\n \n l2tpWaitConnect: This end has acknowledged a\n connection request and is waiting\n for the remote end to connect.\n \n l2tpEstablished: The session is active.\n \n l2tpShuttingDown: The session is in progress of\n shutting down.\n \n pptpWaitVAccess: The session is waiting for the\n creation of a virtual access\n interface.\n \n pptpPacEstablished: The session is active.\n \n pptpWaitTunnel: The session is waiting for the\n tunnel to be established.\n \n pptpWaitOCRP: The session has been initiated and\n is pending for the remote end\n reply to complete the process.\n \n pptpPnsEstablished: The session is active.\n \n pptpWaitCallDisc: Session shutdown is in progress." }, "cvpdnSessionAttrCallDuration": { "type": "string", "description": "This object specifies the call duration of the current\n active session.", "x-yang-type": "yang:timeticks" }, "cvpdnSessionAttrPacketsOut": { "type": "integer", "description": "The total number of output packets through this active\n session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrBytesOut": { "type": "integer", "description": "The total number of output bytes through this active\n session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrPacketsIn": { "type": "integer", "description": "The total number of input packets through this active\n session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrBytesIn": { "type": "integer", "description": "The total number of input bytes through this active\n session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrDeviceType": { "type": "string", "description": "The type of physical devices that this session is attached\n to for the local end of the tunnel. The meaning of each\n device type is explained below:\n \n other: Any device that has not been\n defined.\n \n asyncInternalModem: Modem Pool device of an access\n server.\n \n async: A regular asynchronous serial\n interface.\n \n sync: A regular synchronous serial\n interface.\n \n bchan: An ISDN call.\n \n xdsl: xDSL interface.\n \n cable: cable modem interface." }, "cvpdnSessionAttrDeviceCallerId": { "type": "string", "description": "The incoming caller identification of the user. It is the\n originating number that called into the device that\n initiates the session. This object can be empty since not\n all dial devices can provide caller ID information.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnSessionAttrDevicePhyId": { "type": "string", "description": "The device ID of the physical interface for the session.\n The object is the the interface index which points to the\n ifTable. For virtual interfaces that are not in the\n ifTable, the value will be zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "cvpdnSessionAttrMultilink": { "type": "boolean", "description": "This object indicates whether the session is part of a\n multilink PPP bundle, even if there is only one link or\n session in the bundle. If it is multilink PPP, the value\n is true." }, "cvpdnSessionAttrModemSlotIndex": { "type": "integer", "description": "The Modem Pool database slot index if it is associated with\n this session. Only a session with device of type\n 'asyncInternalModem' will have a valid value for this\n object; otherwise, it is not instantiated.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrModemPortIndex": { "type": "integer", "description": "The Modem Pool database port index if it is associated with\n this session. Only a session with a device of type\n 'asyncInternalModem' will have a valid value for this\n object; otherwise, it is not instantiated.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrDS1SlotIndex": { "type": "integer", "description": "The DS1 database slot index if it is associated with this\n session. Only a session with a device of type\n 'asyncInternalModem' will have a valid value for this\n object; otherwise it is not instantiated.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrDS1PortIndex": { "type": "integer", "description": "The DS1 database port index if it is associated with this\n session. Only a session with a device of type\n 'asyncInternalModem' will have a valid value for this\n object; otherwise it is not instantiated.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrDS1ChannelIndex": { "type": "integer", "description": "The DS1 database channel index if it is associated with\n this session. Only a session over a device of type\n 'asyncInternalModem' will have a valid value for this\n object; otherwise it is not instantiated.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrModemCallStartTime": { "type": "string", "description": "The start time of the current modem call. Only a session\n with a device of type 'asyncInternalModem' will have a\n valid value for this object; otherwise, it is not\n instantiated.", "x-yang-type": "yang:timestamp" }, "cvpdnSessionAttrModemCallStartIndex": { "type": "integer", "description": "Arbitrary small integer to distinguish modem calls that\n occurred at the same time tick. Only session over device\n 'asyncInternalModem' will have a valid value for this\n object; otherwise, it is not instantiated.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrVirtualCircuitID": { "type": "integer", "description": "The virtual circuit ID of an active Layer 2 VPN session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrSentPktsDropped": { "type": "integer", "description": "The total number of dropped packets that could not be sent\n into this active session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrRecvPktsDropped": { "type": "integer", "description": "The total number of dropped packets that were received from\n this active session.", "minimum": 0, "maximum": 4294967295 }, "cvpdnSessionAttrMultilinkBundle": { "type": "string", "description": "This object specifies the name of the multilink bundle to\n which this session belongs. The value of this object is\n only valid when the value of cvpdnSessionAttrMultilink is\n 'true'. If the value of cvpdnSessionAttrMultilink is\n 'false', then the value of this object will be the empty\n string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cvpdnSessionAttrMultilinkIfIndex": { "type": "string", "description": "This object specifies the ifIndex of the multilink bundle\n to which this session belongs. The value of this object is\n only valid when the value of cvpdnSessionAttrMultilink is\n 'true'. If the value of cvpdnSessionAttrMultilink is\n 'false', then the value of this object will be zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero" } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnSessionAttrEntry": { "cvpdnSystemTunnelType": "ethernetCsmacd(6)", "cvpdnTunnelAttrTunnelId": "example-string", "cvpdnSessionAttrSessionId": -2147483648, "cvpdnSessionAttrUserName": "interface-1", "cvpdnSessionAttrState": "up(1)", "cvpdnSessionAttrCallDuration": "example-string", "cvpdnSessionAttrPacketsOut": 1234567890, "cvpdnSessionAttrBytesOut": 0, "cvpdnSessionAttrPacketsIn": 1234567890, "cvpdnSessionAttrBytesIn": 0, "cvpdnSessionAttrDeviceType": "ethernetCsmacd(6)", "cvpdnSessionAttrDeviceCallerId": "example-string", "cvpdnSessionAttrDevicePhyId": "example-string", "cvpdnSessionAttrMultilink": true, "cvpdnSessionAttrModemSlotIndex": 1, "cvpdnSessionAttrModemPortIndex": 1, "cvpdnSessionAttrDS1SlotIndex": 1, "cvpdnSessionAttrDS1PortIndex": 1, "cvpdnSessionAttrDS1ChannelIndex": 1, "cvpdnSessionAttrModemCallStartTime": "example-string", "cvpdnSessionAttrModemCallStartIndex": 1, "cvpdnSessionAttrVirtualCircuitID": 0, "cvpdnSessionAttrSentPktsDropped": 0, "cvpdnSessionAttrRecvPktsDropped": 0, "cvpdnSessionAttrMultilinkBundle": "example-string", "cvpdnSessionAttrMultilinkIfIndex": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnSessionAttrEntry-4" }, "x-yang-path": "/cvpdnSessionAttrEntry={cvpdnSystemTunnelType cvpdnTunnelAttrTunnelId cvpdnSessionAttrSessionId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cvpdnSystemTunnelType cvpdnTunnelAttrTunnelId cvpdnSessionAttrSessionId" ] }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnUserToFailHistInfoEntry={cvpdnUnameToFailHistUname},{cvpdnUnameToFailHistTunnelId}": { "get": { "summary": "Get cvpdnUserToFailHistInfoEntry entry", "description": "Retrieve specific cvpdnUserToFailHistInfoEntry entry by key from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "parameters": [ { "name": "cvpdnUnameToFailHistUname", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cvpdnUnameToFailHistTunnelId", "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": { "cvpdnUnameToFailHistUname": { "type": "string", "description": "The user name for this failure entry.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnUnameToFailHistTunnelId": { "type": "integer", "description": "The Tunnel ID for this failure entry. If it is the\n instigator of the tunnel, the ID is the TS tunnel ID,\n otherwise it is the NAS tunnel ID.", "minimum": 0, "maximum": 4294967295 }, "cvpdnUnameToFailHistUserId": { "type": "integer", "description": "The user ID of this failure entry.", "minimum": 0, "maximum": 4294967295 }, "cvpdnUnameToFailHistLocalInitConn": { "type": "boolean", "description": "This object indicates whether the tunnel in which the\n failure occurred was generated locally or not." }, "cvpdnUnameToFailHistLocalName": { "type": "string", "description": "The local name of the VPDN tunnel in which the failure\n occurred. It will be the NAS name of the tunnel if the\n system serves as the NAS, or the TS name of the tunnel\n if the system serves as the tunnel server. The local\n name is the configured host name of the system. This\n object can be empty if the failure occurred prior to\n successful tunnel projection, thus no source name will\n be available.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnUnameToFailHistRemoteName": { "type": "string", "description": "The remote name of the VPDN tunnel in which the failure\n occurred. It will be the tunnel server name of the\n tunnel if the system is a NAS, or the NAS name of the\n tunnel if the system serves as the tunnel server. This\n object can be empty if the failure occurred prior to\n successful tunnel projection, thus no source name will\n be available.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnUnameToFailHistSourceIp": { "type": "string", "description": "The source IP address of the tunnel in which the\n failure occurred. This IP address is that of the\n interface at the instigator end of the tunnel.", "format": "inet:ipv4-address" }, "cvpdnUnameToFailHistDestIp": { "type": "string", "description": "The destination IP address of the tunnel in which the\n failure occurred. This IP address is that of the\n interface at the receiver end of the tunnel.", "format": "inet:ipv4-address" }, "cvpdnUnameToFailHistCount": { "type": "integer", "description": "This object is incremented when multiple failures has\n been experienced by this user on this tunnel. Seeing a\n delta of >1 is an indication that the current failure\n record is the latest of a series of failures that has\n been recorded.", "minimum": 0, "maximum": 4294967295 }, "cvpdnUnameToFailHistFailTime": { "type": "string", "description": "This object specifies the time when the failure is\n occurred.", "x-yang-type": "yang:timestamp" }, "cvpdnUnameToFailHistFailType": { "type": "string", "description": "The type of failure for the current failure record. It\n comes in a form of a an ASCII string which describes\n the type of failure.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnUnameToFailHistFailReason": { "type": "string", "description": "The reason of failure for the current failure record.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cvpdnUnameToFailHistSourceInetType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnUnameToFailHistSourceInetAddr.", "x-yang-type": "inet-address:InetAddressType" }, "cvpdnUnameToFailHistSourceInetAddr": { "type": "string", "description": "The source IP address of the tunnel in which the\n failure occurred. This IP address is that of the\n interface at the instigator end of the tunnel. The\n instigator end is the peer which initiates the tunnel\n estalishment. The type of this address is determined\n by the value of cvpdnUnameToFailHistSourceInetType.", "x-yang-type": "inet-address:InetAddress" }, "cvpdnUnameToFailHistDestInetType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnUnameToFailHistDestInetAddr.", "x-yang-type": "inet-address:InetAddressType" }, "cvpdnUnameToFailHistDestInetAddr": { "type": "string", "description": "The destination IP address of the tunnel in which the\n failure occurred. This IP address is that of the\n interface at the receiver end of the tunnel. The type \n of this address is determined by the value of \n cvpdnUnameToFailHistDestInetType.", "x-yang-type": "inet-address:InetAddress" } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnUserToFailHistInfoEntry": { "cvpdnUnameToFailHistUname": "interface-1", "cvpdnUnameToFailHistTunnelId": 0, "cvpdnUnameToFailHistUserId": 0, "cvpdnUnameToFailHistLocalInitConn": true, "cvpdnUnameToFailHistLocalName": "interface-1", "cvpdnUnameToFailHistRemoteName": "interface-1", "cvpdnUnameToFailHistSourceIp": "192.168.1.1", "cvpdnUnameToFailHistDestIp": "192.168.1.1", "cvpdnUnameToFailHistCount": 0, "cvpdnUnameToFailHistFailTime": "interface-1", "cvpdnUnameToFailHistFailType": "ethernetCsmacd(6)", "cvpdnUnameToFailHistFailReason": "interface-1", "cvpdnUnameToFailHistSourceInetType": "ethernetCsmacd(6)", "cvpdnUnameToFailHistSourceInetAddr": "192.168.1.1", "cvpdnUnameToFailHistDestInetType": "ethernetCsmacd(6)", "cvpdnUnameToFailHistDestInetAddr": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnUserToFailHistInfoEntry-4" }, "x-yang-path": "/cvpdnUserToFailHistInfoEntry={cvpdnUnameToFailHistUname cvpdnUnameToFailHistTunnelId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cvpdnUnameToFailHistUname cvpdnUnameToFailHistTunnelId" ] }, "/data/CISCO-VPDN-MGMT-MIB:cvpdnBundleChildEntry={cvpdnBundleName},{cvpdnBundleChildTunnelType},{cvpdnBundleChildTunnelId},{cvpdnBundleChildSessionId}": { "get": { "summary": "Get cvpdnBundleChildEntry entry", "description": "Retrieve specific cvpdnBundleChildEntry entry by key from MIB", "tags": [ "CISCO-VPDN-MGMT-MIB" ], "parameters": [ { "name": "cvpdnBundleName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cvpdnBundleChildTunnelType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cvpdnBundleChildTunnelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cvpdnBundleChildSessionId", "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": { "cvpdnBundleName": { "type": "string", "description": "cvpdnBundleName", "x-yang-type": "leafref" }, "cvpdnBundleChildTunnelType": { "type": "string", "description": "The tunnel type. This is the tunnel protocol of an active\n VPDN session that is associated with a multilink PPP\n bundle.", "x-yang-type": "CISCO-VPDN-MGMT-MIB:TunnelType" }, "cvpdnBundleChildTunnelId": { "type": "integer", "description": "The Tunnel ID of an active VPDN session that is associated\n with a multilink PPP bundle.", "minimum": 0, "maximum": 4294967295 }, "cvpdnBundleChildSessionId": { "type": "integer", "description": "The ID of an active VPDN session that is associated with a\n multilink PPP bundle.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-VPDN-MGMT-MIB:cvpdnBundleChildEntry": { "cvpdnBundleName": "interface-1", "cvpdnBundleChildTunnelType": "ethernetCsmacd(6)", "cvpdnBundleChildTunnelId": 0, "cvpdnBundleChildSessionId": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cvpdnBundleChildEntry-4" }, "x-yang-path": "/cvpdnBundleChildEntry={cvpdnBundleName cvpdnBundleChildTunnelType cvpdnBundleChildTunnelId cvpdnBundleChildSessionId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cvpdnBundleName cvpdnBundleChildTunnelType cvpdnBundleChildTunnelId cvpdnBundleChildSessionId" ] } }, "components": { "schemas": { "CISCO-VPDN-MGMT-MIB_CISCO-VPDN-MGMT-MIB": { "type": "object", "description": "This object contains the local session ID of the L2X\n session for which this notification has been\n generated.", "properties": { "cvpdnSystemEntry": { "type": "array", "description": "An entry in the table, containing information about a\n single type of VPDN tunnel.", "items": { "type": "object", "properties": { "cvpdnSystemTunnelType": { "type": "string", "description": "The tunnel type. This is the tunnel protocol.", "x-yang-type": "CISCO-VPDN-MGMT-MIB:TunnelType", "readOnly": true }, "cvpdnSystemTunnelTotal": { "type": "integer", "description": "The total number of VPDN tunnels that are currently active\n of this tunnel type.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSystemSessionTotal": { "type": "integer", "description": "The total number of active sessions in all the active VPDN\n tunnels of this tunnel type.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSystemDeniedUsersTotal": { "type": "integer", "description": "The total number of denied user attempts to all the VPDN\n tunnels of this tunnel type since last system\n re-initialization.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSystemInitialConnReq": { "type": "integer", "description": "The total number tunnel connection attempts on all the VPDN\n tunnels of this tunnel type since last system\n re-initialization.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSystemSuccessConnReq": { "type": "integer", "description": "The total number tunnel Successful connection attempts in VPDN\n tunnels of this tunnel type since last system\n re-initialization.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSystemFailedConnReq": { "type": "integer", "description": "The total number tunnel Failed connection attempts in VPDN\n tunnels of this tunnel type since last system\n re-initialization.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true }, "cvpdnTunnelEntry": { "type": "array", "description": "An entry in the table, containing information about a\n single active VPDN tunnel.", "items": { "type": "object", "properties": { "cvpdnTunnelTunnelId": { "type": "integer", "description": "The Tunnel ID of an active VPDN tunnel. If it is the\n instigator of the tunnel, the ID is the HGW/LNS tunnel\n ID, otherwise it is the NAS/LAC tunnel ID.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelRemoteTunnelId": { "type": "integer", "description": "The remote Tunnel ID of an active VPDN tunnel. If it\n is the instigator of the tunnel, the ID is the NAS/LAC\n tunnel ID, otherwise it is the HGW/LNS tunnel ID.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelLocalName": { "type": "string", "description": "The local name of an active VPDN tunnel. It will be\n the NAS/LAC name of the tunnel if the router serves as\n the NAS/LAC, or the HGW/LNS name of the tunnel if the\n system serves as the home gateway. Typically, the\n local name is the configured host name of the router.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvpdnTunnelRemoteName": { "type": "string", "description": "The remote name of an active VPDN tunnel. It will be\n the home gateway name of the tunnel if the system is a\n NAS/LAC, or the NAS/LAC name of the tunnel if the\n system serves as the home gateway.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvpdnTunnelRemoteEndpointName": { "type": "string", "description": "The remote end point name of an active VPDN tunnel.\n This name is either the domain name or the DNIS that\n this tunnel is projected with.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvpdnTunnelLocalInitConnection": { "type": "boolean", "description": "This object indicates whether the tunnel was generated\n locally or not.", "readOnly": true }, "cvpdnTunnelOrigCause": { "type": "string", "description": "The cause which originated an active VPDN tunnel. The\n tunnel can be projected via domain name, DNIS or a\n stack group (SGBP).", "readOnly": true }, "cvpdnTunnelState": { "type": "string", "description": "The current state of an active VPDN tunnel. Each state\n code is explained below:\n \n unknown: The current state of the tunnel is\n unknown.\n \n opening: The tunnel has just been instigated and\n is pending for a remote end reply to\n complete the process.\n \n open: The tunnel is active.\n \n closing: The tunnel has just been shut down and\n is pending for the remote end to reply\n to complete the process.", "readOnly": true }, "cvpdnTunnelActiveSessions": { "type": "integer", "description": "The total number of active session currently in the\n tunnel.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelDeniedUsers": { "type": "integer", "description": "A count of the accumulated total of denied users for\n the tunnel.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelSoftshut": { "type": "boolean", "description": "A VPDN tunnel can be put into a soft shut state to\n prevent any new user session to be added. This object\n specifies whether this tunnel has been soft shut.", "readOnly": true }, "cvpdnTunnelNetworkServiceType": { "type": "string", "description": "The type of network service used in the active tunnel.\n For now it is IP only.", "readOnly": true }, "cvpdnTunnelLocalIpAddress": { "type": "string", "description": "The local IP address of the tunnel. This IP address is\n that of the interface at the local end of the tunnel.", "format": "inet:ipv4-address", "readOnly": true }, "cvpdnTunnelSourceIpAddress": { "type": "string", "description": "The source IP address of the tunnel. This IP address\n is the user configurable IP address for Stack Group\n Biding Protocol (SGBP) via the CLI command:\n vpdn source-ip", "format": "inet:ipv4-address", "readOnly": true }, "cvpdnTunnelRemoteIpAddress": { "type": "string", "description": "The remote IP address of the tunnel. This IP address\n is that of the interface at the remote end of the\n tunnel.", "format": "inet:ipv4-address", "readOnly": true } } }, "readOnly": true }, "cvpdnTunnelAttrEntry": { "type": "array", "description": "An entry in the table, containing information about a\n single active VPDN tunnel.", "items": { "type": "object", "properties": { "cvpdnSystemTunnelType": { "type": "string", "description": "cvpdnSystemTunnelType", "x-yang-type": "leafref", "readOnly": true }, "cvpdnTunnelAttrTunnelId": { "type": "integer", "description": "The Tunnel ID of an active VPDN tunnel. If this end is the\n instigator of the tunnel, the ID is the TS tunnel ID,\n otherwise it is the NAS tunnel ID.\n \n Two distinct tunnels with the same tunnel ID may exist, but\n with different tunnel types.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cvpdnTunnelAttrRemoteTunnelId": { "type": "integer", "description": "The remote Tunnel ID of an active VPDN tunnel. If this end\n is the instigator of the tunnel, the ID is the NAS tunnel\n ID, otherwise it is the TS tunnel ID.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cvpdnTunnelAttrLocalName": { "type": "string", "description": "The local name of an active VPDN tunnel. It will be the\n NAS name of the tunnel if the system serves as the NAS, or\n the TS name of the tunnel if the system serves as the\n tunnel server. Typically, the local name is the configured\n host name of the system.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvpdnTunnelAttrRemoteName": { "type": "string", "description": "The remote name of an active VPDN tunnel. It will be the\n tunnel server name of the tunnel if the system is a NAS,\n or the NAS name of the tunnel if the system serves as the\n tunnel server.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvpdnTunnelAttrRemoteEndpointName": { "type": "string", "description": "The remote end point name of an active VPDN tunnel. This\n name is either the domain name or the DNIS that this tunnel\n is projected with.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvpdnTunnelAttrLocalInitConnection": { "type": "boolean", "description": "This object indicates whether the tunnel was originated\n locally or not. If it's true, the tunnel was originated\n locally.", "readOnly": true }, "cvpdnTunnelAttrOrigCause": { "type": "string", "description": "The cause which originated an active VPDN tunnel. The\n tunnel can be projected via domain name, DNIS, stack group,\n or L2 Xconnect.", "readOnly": true }, "cvpdnTunnelAttrState": { "type": "string", "description": "The current state of an active VPDN tunnel.\n Tunnels of type l2f will have states with the 'l2f' prefix.\n Tunnels of type l2tp will have states with the 'l2tp'\n prefix.\n Tunnels of type pptp will have states with the 'pptp'\n prefix.\n \n Each state code is explained below:\n \n unknown: The current state of the tunnel is\n unknown.\n \n l2fOpening: The tunnel has just been initiated\n and is pending for a remote end\n reply to complete the process.\n \n l2fOpenWait: This end received a tunnel open\n request from the remote end and is\n waiting for the tunnel to be\n established.\n \n l2fOpen: The tunnel is active.\n \n l2fClosing: This end received a tunnel close\n request.\n \n l2fCloseWait: The tunnel has just been shut down\n and is pending for the remote end\n to reply to complete the process.\n \n l2tpIdle: No tunnel is initiated yet.\n \n l2tpWaitCtlReply: The tunnel has been initiated and\n is pending for a remote end reply\n to complete the process.\n \n l2tpEstablished: The tunnel is active.\n \n l2tpShuttingDown: The tunnel is in progress of\n shutting down.\n \n l2tpNoSessionLeft: There is no session left in the\n tunnel.\n \n pptpIdle: No tunnel is initiated yet.\n \n pptpWaitConnect: The tunnel is waiting for a TCP\n connection.\n \n pptpWaitCtlRequest: The tunnel has been initiated and\n is pending for a remote end\n request.\n \n pptpWaitCtlReply: The tunnel has been initiated and\n is pending for a remote end reply.\n \n pptpEstablished: The tunnel is active.\n \n pptpWaitStopReply: The tunnel is being shut down and\n is pending for a remote end reply.\n \n pptpTerminal: The tunnel has been shut down.", "readOnly": true }, "cvpdnTunnelAttrActiveSessions": { "type": "integer", "description": "The total number of active session currently in the\n tunnel.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelAttrDeniedUsers": { "type": "integer", "description": "A count of the accumulated total of denied users for the\n tunnel.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelAttrSoftshut": { "type": "boolean", "description": "A VPDN tunnel can be put into a soft shut state to prevent\n any new session to be added. This object specifies whether\n this tunnel has been soft shut. If its true, it has been\n soft shut.", "readOnly": true }, "cvpdnTunnelAttrNetworkServiceType": { "type": "string", "description": "The type of network service used in the active tunnel.", "readOnly": true }, "cvpdnTunnelAttrLocalIpAddress": { "type": "string", "description": "The local IP address of the tunnel. This IP address is\n that of the interface at the local end of the tunnel.", "format": "inet:ipv4-address", "readOnly": true }, "cvpdnTunnelAttrSourceIpAddress": { "type": "string", "description": "The source IP address of the tunnel. This IP address is\n the user configurable IP address for Stack Group Biding\n Protocol.", "format": "inet:ipv4-address", "readOnly": true }, "cvpdnTunnelAttrRemoteIpAddress": { "type": "string", "description": "The remote IP address of the tunnel. This IP address is\n that of the interface at the remote end of the tunnel.", "format": "inet:ipv4-address", "readOnly": true }, "cvpdnTunnelAttrLocalInetAddressType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnTunnelAttrLocalInetAddress", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cvpdnTunnelAttrLocalInetAddress": { "type": "string", "description": "The local IP address of the tunnel. This IP address is\n that of the interface at the local end of the tunnel.\n The type of this address is determined by the value of \n cvpdnTunnelAttrLocalInetAddressType.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cvpdnTunnelAttrSourceInetAddressType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnTunnelAttrSourceInetAddress", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cvpdnTunnelAttrSourceInetAddress": { "type": "string", "description": "The source IP address of the tunnel. This IP address is\n the user configurable IP address for Stack Group Biding\n Protocol. The type of this address is determined by the \n value of cvpdnTunnelAttrSourceInetAddressType.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cvpdnTunnelAttrRemoteInetAddressType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnTunnelAttrRemoteInetAddress", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cvpdnTunnelAttrRemoteInetAddress": { "type": "string", "description": "The remote IP address of the tunnel. This IP address is\n that of the interface at the remote end of the tunnel.\n The type of this address is determined by the value of \n cvpdnTunnelAttrRemoteInetAddressType.", "x-yang-type": "inet-address:InetAddress", "readOnly": true } } }, "readOnly": true }, "cvpdnTunnelSessionEntry": { "type": "array", "description": "An entry in the table, containing information about a\n single user session within the tunnel.", "items": { "type": "object", "properties": { "cvpdnTunnelTunnelId": { "type": "string", "description": "cvpdnTunnelTunnelId", "x-yang-type": "leafref", "readOnly": true }, "cvpdnTunnelSessionId": { "type": "integer", "description": "The ID of an active VPDN tunnel user session.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelSessionUserName": { "type": "string", "description": "The name of the user of the user session.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvpdnTunnelSessionState": { "type": "string", "description": "The current state of an active user session. Each state\n code is explained below:\n \n unknown: The current state of the tunnel's\n session is unknown.\n \n opening: The user session has just been\n initiated through a tunnel and is\n pending for the remote end reply\n to complete the process.\n \n open: The user session is active.\n \n closing: The user session has just been\n closed and is pending for the\n remote end reply to complete the\n process.\n \n waitingForTunnel: The user session is in this state\n when the tunnel which this session\n is going through is still in\n CLOSED state. It waits for the\n tunnel to become OPEN before the\n session is allow to be fully\n established.", "readOnly": true }, "cvpdnTunnelSessionCallDuration": { "type": "string", "description": "This object specifies the call duration of the current\n active user session in value of system uptime.", "x-yang-type": "yang:timeticks", "readOnly": true }, "cvpdnTunnelSessionPacketsOut": { "type": "integer", "description": "The total number of output packets through this active\n user session.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelSessionBytesOut": { "type": "integer", "description": "The total number of output bytes through this active\n user session.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelSessionPacketsIn": { "type": "integer", "description": "The total number of input packets through this active\n user session.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelSessionBytesIn": { "type": "integer", "description": "The total number of input bytes through this active\n user session.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelSessionDeviceType": { "type": "string", "description": "The type of physical devices that this user session\n is attached to for the local end of the tunnel. The\n meaning of each device type is explained below:\n \n other: Any device that has not been\n defined.\n \n asyncInternalModem: Modem Pool device of an access\n server.\n \n async: A regular asynchronous serial\n interface.\n \n sync: A regular synchronous serial\n interface.\n \n bchan: An ISDN call.\n \n xdsl: Future application with xDSL\n devices.\n \n cable: Future application with Cable\n modem devices.", "readOnly": true }, "cvpdnTunnelSessionDeviceCallerId": { "type": "string", "description": "The incoming caller identification of the user. It is\n the originating number that called into the device that\n initiates the user session. This object can be empty\n since not all dial device can provide caller ID\n information.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvpdnTunnelSessionDevicePhyId": { "type": "string", "description": "The device ID of the physical interface for the user\n session. The object is the the interface index which\n points to the ifTable. For virtual interface that is\n not in the ifTable, it will have zero value.", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true }, "cvpdnTunnelSessionMultilink": { "type": "boolean", "description": "This object indicates whether the session is part of a\n multilink or not.", "readOnly": true }, "cvpdnTunnelSessionModemSlotIndex": { "type": "integer", "description": "The Modem Pool database slot index if it is associated\n with this user session. Only a session with device of\n type asyncInternalModem will have a valid value for\n this object.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelSessionModemPortIndex": { "type": "integer", "description": "The Modem Pool database port index if it is associated\n with this user session. Only a session with a device\n of type asyncInternalModem will have a valid value for\n this object.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelSessionDS1SlotIndex": { "type": "integer", "description": "The DS1 database slot index if it is associated with\n this user session. Only a session with a device of\n type asyncInternalModem will have a valid value for\n this object.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelSessionDS1PortIndex": { "type": "integer", "description": "The DS1 database port index if it is associated with\n this user session. Only a session with a device of\n type asyncInternalModem will have a a valid value for\n this object.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelSessionDS1ChannelIndex": { "type": "integer", "description": "The DS1 database channel index if it is associated with\n this user session. Only a session over a device of\n type asyncInternalModem will have a valid value for\n this object.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelSessionModemCallStartTime": { "type": "string", "description": "The start time of the current modem call. Only a\n session with a device of type asyncInternalModem will\n have a valid value for this object.", "x-yang-type": "yang:timestamp", "readOnly": true }, "cvpdnTunnelSessionModemCallStartIndex": { "type": "integer", "description": "Arbitrary small integer to distinguish modem calls that\n occurred at the same time tick. Only session over\n device asyncInternalModem will have a valid value for\n this object.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true }, "cvpdnSessionAttrEntry": { "type": "array", "description": "An entry in the table, containing information about a\n single session within the tunnel.", "items": { "type": "object", "properties": { "cvpdnSystemTunnelType": { "type": "string", "description": "cvpdnSystemTunnelType", "x-yang-type": "leafref", "readOnly": true }, "cvpdnTunnelAttrTunnelId": { "type": "string", "description": "cvpdnTunnelAttrTunnelId", "x-yang-type": "leafref", "readOnly": true }, "cvpdnSessionAttrSessionId": { "type": "integer", "description": "The ID of an active VPDN session.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cvpdnSessionAttrUserName": { "type": "string", "description": "The name of the user of the session.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvpdnSessionAttrState": { "type": "string", "description": "The current state of a tunnel session.\n L2F tunnel sessions will have states with the 'l2f' prefix.\n L2TP tunnel sessions will have states with the 'l2tp'\n prefix.\n \n Each state code is explained below:\n \n unknown: The current state of the tunnel's\n session is unknown.\n \n l2fOpening: The session has just been\n initiated through a tunnel and is\n pending for the remote end reply\n to complete the process.\n \n l2fOpen: The session is active.\n \n l2fCloseWait: The session has just been closed\n and is pending for the remote end\n reply to complete the process.\n \n l2fWaitingForTunnel: The session is in this state when\n the tunnel which this session is\n going through is still in CLOSED\n state. It waits for the tunnel to\n become OPEN before the session is\n allowed to be fully established.\n \n l2tpIdle: No session is initiated yet.\n \n l2tpWaitingTunnel: The session is waiting for the\n tunnel to be established.\n \n l2tpWaitReply: The session has been initiated and\n is pending for the remote end\n reply to complete the process.\n \n l2tpWaitConnect: This end has acknowledged a\n connection request and is waiting\n for the remote end to connect.\n \n l2tpEstablished: The session is active.\n \n l2tpShuttingDown: The session is in progress of\n shutting down.\n \n pptpWaitVAccess: The session is waiting for the\n creation of a virtual access\n interface.\n \n pptpPacEstablished: The session is active.\n \n pptpWaitTunnel: The session is waiting for the\n tunnel to be established.\n \n pptpWaitOCRP: The session has been initiated and\n is pending for the remote end\n reply to complete the process.\n \n pptpPnsEstablished: The session is active.\n \n pptpWaitCallDisc: Session shutdown is in progress.", "readOnly": true }, "cvpdnSessionAttrCallDuration": { "type": "string", "description": "This object specifies the call duration of the current\n active session.", "x-yang-type": "yang:timeticks", "readOnly": true }, "cvpdnSessionAttrPacketsOut": { "type": "integer", "description": "The total number of output packets through this active\n session.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSessionAttrBytesOut": { "type": "integer", "description": "The total number of output bytes through this active\n session.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSessionAttrPacketsIn": { "type": "integer", "description": "The total number of input packets through this active\n session.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSessionAttrBytesIn": { "type": "integer", "description": "The total number of input bytes through this active\n session.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSessionAttrDeviceType": { "type": "string", "description": "The type of physical devices that this session is attached\n to for the local end of the tunnel. The meaning of each\n device type is explained below:\n \n other: Any device that has not been\n defined.\n \n asyncInternalModem: Modem Pool device of an access\n server.\n \n async: A regular asynchronous serial\n interface.\n \n sync: A regular synchronous serial\n interface.\n \n bchan: An ISDN call.\n \n xdsl: xDSL interface.\n \n cable: cable modem interface.", "readOnly": true }, "cvpdnSessionAttrDeviceCallerId": { "type": "string", "description": "The incoming caller identification of the user. It is the\n originating number that called into the device that\n initiates the session. This object can be empty since not\n all dial devices can provide caller ID information.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvpdnSessionAttrDevicePhyId": { "type": "string", "description": "The device ID of the physical interface for the session.\n The object is the the interface index which points to the\n ifTable. For virtual interfaces that are not in the\n ifTable, the value will be zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true }, "cvpdnSessionAttrMultilink": { "type": "boolean", "description": "This object indicates whether the session is part of a\n multilink PPP bundle, even if there is only one link or\n session in the bundle. If it is multilink PPP, the value\n is true.", "readOnly": true }, "cvpdnSessionAttrModemSlotIndex": { "type": "integer", "description": "The Modem Pool database slot index if it is associated with\n this session. Only a session with device of type\n 'asyncInternalModem' will have a valid value for this\n object; otherwise, it is not instantiated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSessionAttrModemPortIndex": { "type": "integer", "description": "The Modem Pool database port index if it is associated with\n this session. Only a session with a device of type\n 'asyncInternalModem' will have a valid value for this\n object; otherwise, it is not instantiated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSessionAttrDS1SlotIndex": { "type": "integer", "description": "The DS1 database slot index if it is associated with this\n session. Only a session with a device of type\n 'asyncInternalModem' will have a valid value for this\n object; otherwise it is not instantiated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSessionAttrDS1PortIndex": { "type": "integer", "description": "The DS1 database port index if it is associated with this\n session. Only a session with a device of type\n 'asyncInternalModem' will have a valid value for this\n object; otherwise it is not instantiated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSessionAttrDS1ChannelIndex": { "type": "integer", "description": "The DS1 database channel index if it is associated with\n this session. Only a session over a device of type\n 'asyncInternalModem' will have a valid value for this\n object; otherwise it is not instantiated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSessionAttrModemCallStartTime": { "type": "string", "description": "The start time of the current modem call. Only a session\n with a device of type 'asyncInternalModem' will have a\n valid value for this object; otherwise, it is not\n instantiated.", "x-yang-type": "yang:timestamp", "readOnly": true }, "cvpdnSessionAttrModemCallStartIndex": { "type": "integer", "description": "Arbitrary small integer to distinguish modem calls that\n occurred at the same time tick. Only session over device\n 'asyncInternalModem' will have a valid value for this\n object; otherwise, it is not instantiated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSessionAttrVirtualCircuitID": { "type": "integer", "description": "The virtual circuit ID of an active Layer 2 VPN session.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSessionAttrSentPktsDropped": { "type": "integer", "description": "The total number of dropped packets that could not be sent\n into this active session.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSessionAttrRecvPktsDropped": { "type": "integer", "description": "The total number of dropped packets that were received from\n this active session.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSessionAttrMultilinkBundle": { "type": "string", "description": "This object specifies the name of the multilink bundle to\n which this session belongs. The value of this object is\n only valid when the value of cvpdnSessionAttrMultilink is\n 'true'. If the value of cvpdnSessionAttrMultilink is\n 'false', then the value of this object will be the empty\n string.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cvpdnSessionAttrMultilinkIfIndex": { "type": "string", "description": "This object specifies the ifIndex of the multilink bundle\n to which this session belongs. The value of this object is\n only valid when the value of cvpdnSessionAttrMultilink is\n 'true'. If the value of cvpdnSessionAttrMultilink is\n 'false', then the value of this object will be zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true } } }, "readOnly": true }, "cvpdnUserToFailHistInfoEntry": { "type": "array", "description": "An entry in the table, containing failure history\n relevant to an user name.", "items": { "type": "object", "properties": { "cvpdnUnameToFailHistUname": { "type": "string", "description": "The user name for this failure entry.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvpdnUnameToFailHistTunnelId": { "type": "integer", "description": "The Tunnel ID for this failure entry. If it is the\n instigator of the tunnel, the ID is the TS tunnel ID,\n otherwise it is the NAS tunnel ID.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnUnameToFailHistUserId": { "type": "integer", "description": "The user ID of this failure entry.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnUnameToFailHistLocalInitConn": { "type": "boolean", "description": "This object indicates whether the tunnel in which the\n failure occurred was generated locally or not.", "readOnly": true }, "cvpdnUnameToFailHistLocalName": { "type": "string", "description": "The local name of the VPDN tunnel in which the failure\n occurred. It will be the NAS name of the tunnel if the\n system serves as the NAS, or the TS name of the tunnel\n if the system serves as the tunnel server. The local\n name is the configured host name of the system. This\n object can be empty if the failure occurred prior to\n successful tunnel projection, thus no source name will\n be available.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvpdnUnameToFailHistRemoteName": { "type": "string", "description": "The remote name of the VPDN tunnel in which the failure\n occurred. It will be the tunnel server name of the\n tunnel if the system is a NAS, or the NAS name of the\n tunnel if the system serves as the tunnel server. This\n object can be empty if the failure occurred prior to\n successful tunnel projection, thus no source name will\n be available.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvpdnUnameToFailHistSourceIp": { "type": "string", "description": "The source IP address of the tunnel in which the\n failure occurred. This IP address is that of the\n interface at the instigator end of the tunnel.", "format": "inet:ipv4-address", "readOnly": true }, "cvpdnUnameToFailHistDestIp": { "type": "string", "description": "The destination IP address of the tunnel in which the\n failure occurred. This IP address is that of the\n interface at the receiver end of the tunnel.", "format": "inet:ipv4-address", "readOnly": true }, "cvpdnUnameToFailHistCount": { "type": "integer", "description": "This object is incremented when multiple failures has\n been experienced by this user on this tunnel. Seeing a\n delta of >1 is an indication that the current failure\n record is the latest of a series of failures that has\n been recorded.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnUnameToFailHistFailTime": { "type": "string", "description": "This object specifies the time when the failure is\n occurred.", "x-yang-type": "yang:timestamp", "readOnly": true }, "cvpdnUnameToFailHistFailType": { "type": "string", "description": "The type of failure for the current failure record. It\n comes in a form of a an ASCII string which describes\n the type of failure.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvpdnUnameToFailHistFailReason": { "type": "string", "description": "The reason of failure for the current failure record.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvpdnUnameToFailHistSourceInetType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnUnameToFailHistSourceInetAddr.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cvpdnUnameToFailHistSourceInetAddr": { "type": "string", "description": "The source IP address of the tunnel in which the\n failure occurred. This IP address is that of the\n interface at the instigator end of the tunnel. The\n instigator end is the peer which initiates the tunnel\n estalishment. The type of this address is determined\n by the value of cvpdnUnameToFailHistSourceInetType.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cvpdnUnameToFailHistDestInetType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnUnameToFailHistDestInetAddr.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cvpdnUnameToFailHistDestInetAddr": { "type": "string", "description": "The destination IP address of the tunnel in which the\n failure occurred. This IP address is that of the\n interface at the receiver end of the tunnel. The type \n of this address is determined by the value of \n cvpdnUnameToFailHistDestInetType.", "x-yang-type": "inet-address:InetAddress", "readOnly": true } } }, "readOnly": true }, "cvpdnTemplateEntry": { "type": "array", "description": "An entry in the table, containing information about a\n single VPDN template.", "items": { "type": "object", "properties": { "cvpdnTemplateName": { "type": "string", "description": "The name of the VPDN template.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cvpdnTemplateActiveSessions": { "type": "integer", "description": "The total number of active session in all groups\n associated with the template.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true }, "cvpdnBundleEntry": { "type": "array", "description": "An entry in this table represents an active multilink PPP\n bundle that belongs to a VPDN tunnel.", "items": { "type": "object", "properties": { "cvpdnBundleName": { "type": "string", "description": "The name of the multilink PPP bundle associated with a VPDN\n tunnel.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cvpdnBundleLinkCount": { "type": "integer", "description": "The total number of active links in a multilink PPP bundle\n associated with a VPDN tunnel.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnBundleEndpointType": { "type": "string", "description": "The multilink PPP bundle discriminator type associated with\n a VPDN tunnel. The value of this object represents the type\n of discriminator used in cvpdnBundleEndpoint.\n \n none: No endpoint discriminator was supplied, the\n default value is being used.\n \n hostname: The router's hostname is being used as\n discriminator.\n \n string: User specified string is being used as\n discriminator.\n \n macAddress: A MAC address as defined by the MacAddress\n textual convention is being used as\n discriminator.\n \n ipV4Address: An IP address as defined by the\n InetAddressIPv4 textual convention is being\n used as discriminator.\n \n ipV6Address: An IP address as defined by the\n InetAddressIPv6 textual convention is being\n used as discriminator.\n \n phone: The PSTN phone number is being used as\n discriminator.\n \n magicNumber: A magic number is being used as\n discriminator.", "readOnly": true }, "cvpdnBundleEndpoint": { "type": "string", "description": "Indicates the discriminator used in this bundle that is\n associated with a VPDN tunnel.", "format": "binary", "readOnly": true }, "cvpdnBundlePeerIpAddrType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnBundlePeerIpAddr.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cvpdnBundlePeerIpAddr": { "type": "string", "description": "The IP address of the multilink PPP peer in a VPDN tunnel.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cvpdnBundleEndpointClass": { "type": "string", "description": "The multilink PPP bundle discriminator class associated\n with a VPDN tunnel. The value of this object represents the\n type of discriminator used in cvpdnBundleEndpoint.", "x-yang-type": "CISCO-VPDN-MGMT-MIB:EndpointClass", "readOnly": true } } }, "readOnly": true }, "cvpdnBundleChildEntry": { "type": "array", "description": "An entry in this table represents a session that belongs to\n a VPDN tunnel and to a multilink PPP bundle.", "items": { "type": "object", "properties": { "cvpdnBundleName": { "type": "string", "description": "cvpdnBundleName", "x-yang-type": "leafref", "readOnly": true }, "cvpdnBundleChildTunnelType": { "type": "string", "description": "The tunnel type. This is the tunnel protocol of an active\n VPDN session that is associated with a multilink PPP\n bundle.", "x-yang-type": "CISCO-VPDN-MGMT-MIB:TunnelType", "readOnly": true }, "cvpdnBundleChildTunnelId": { "type": "integer", "description": "The Tunnel ID of an active VPDN session that is associated\n with a multilink PPP bundle.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnBundleChildSessionId": { "type": "integer", "description": "The ID of an active VPDN session that is associated with a\n multilink PPP bundle.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true }, "ciscoVpdnMgmtMIBNotifs": { "type": "object", "description": "This object contains the local session ID of the L2X\n session for which this notification has been\n generated.", "properties": { "cvpdnNotifSessionID": { "type": "integer", "description": "This object contains the local session ID of the L2X\n session for which this notification has been\n generated.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cvpdnNotifSessionEvent": { "type": "string", "description": "Indicates the event that generated the L2X session\n notification.\n \n The events are represented as follows:\n \n up: Session has come up.\n \n down: Session has gone down.\n \n pwUp: Pseudowire associated with this \n session has come up.\n \n pwDown: Pseudowire associated with this \n session has gone down.", "readOnly": true } }, "readOnly": true }, "cvpdnSystemInfo": { "type": "object", "description": "The total number of VPDN tunnels that are currently\n active within this system.", "properties": { "cvpdnTunnelTotal": { "type": "integer", "description": "The total number of VPDN tunnels that are currently\n active within this system.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSessionTotal": { "type": "integer", "description": "The total number of active users in all the active VPDN\n tunnels within this system.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnDeniedUsersTotal": { "type": "integer", "description": "The total number of denied user attempts to all the\n active VPDN tunnels within this system.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSystemNotifSessionEnabled": { "type": "boolean", "description": "Indicates whether Layer 2 VPN session notifications are\n enabled.", "readOnly": true }, "cvpdnSystemClearSessions": { "type": "string", "description": "Clears all the sessions in a given tunnel type. When\n reading this object, the value of 'none' will always be\n returned.\n \n When setting these values, the following operations will be\n performed:\n \n none: no operation.\n \n all: clears all the sessions in all the tunnels.\n \n l2f: clears all the L2F sessions.\n \n l2tp: clears all the L2TP sessions.\n \n pptp: clears all the PPTP sessions.", "readOnly": true } }, "readOnly": true }, "cvpdnMultilinkInfo": { "type": "object", "description": "The total number of bundles comprised of a single link.", "properties": { "cvpdnBundlesWithOneLink": { "type": "integer", "description": "The total number of bundles comprised of a single link.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnBundlesWithTwoLinks": { "type": "integer", "description": "The total number of bundles comprised of two links.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnBundlesWithMoreThanTwoLinks": { "type": "integer", "description": "The total number of bundles comprised of more than two\n links.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnBundleLastChanged": { "type": "string", "description": "The value of the sysUpTime object when the contents of\n cvpdnBundleTable last changed.", "x-yang-type": "yang:timestamp", "readOnly": true } }, "readOnly": true }, "cvpdnSystemTable": { "type": "object", "description": "Table of information about the VPDN system for all tunnel\n types.", "properties": { "cvpdnSystemEntry": { "type": "array", "description": "An entry in the table, containing information about a\n single type of VPDN tunnel.", "items": { "type": "object", "properties": { "cvpdnSystemTunnelType": { "type": "string", "description": "The tunnel type. This is the tunnel protocol.", "x-yang-type": "CISCO-VPDN-MGMT-MIB:TunnelType", "readOnly": true }, "cvpdnSystemTunnelTotal": { "type": "integer", "description": "The total number of VPDN tunnels that are currently active\n of this tunnel type.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSystemSessionTotal": { "type": "integer", "description": "The total number of active sessions in all the active VPDN\n tunnels of this tunnel type.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSystemDeniedUsersTotal": { "type": "integer", "description": "The total number of denied user attempts to all the VPDN\n tunnels of this tunnel type since last system\n re-initialization.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSystemInitialConnReq": { "type": "integer", "description": "The total number tunnel connection attempts on all the VPDN\n tunnels of this tunnel type since last system\n re-initialization.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSystemSuccessConnReq": { "type": "integer", "description": "The total number tunnel Successful connection attempts in VPDN\n tunnels of this tunnel type since last system\n re-initialization.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSystemFailedConnReq": { "type": "integer", "description": "The total number tunnel Failed connection attempts in VPDN\n tunnels of this tunnel type since last system\n re-initialization.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cvpdnTunnelTable": { "type": "object", "description": "Table of information about the active VPDN tunnels.", "properties": { "cvpdnTunnelEntry": { "type": "array", "description": "An entry in the table, containing information about a\n single active VPDN tunnel.", "items": { "type": "object", "properties": { "cvpdnTunnelTunnelId": { "type": "integer", "description": "The Tunnel ID of an active VPDN tunnel. If it is the\n instigator of the tunnel, the ID is the HGW/LNS tunnel\n ID, otherwise it is the NAS/LAC tunnel ID.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelRemoteTunnelId": { "type": "integer", "description": "The remote Tunnel ID of an active VPDN tunnel. If it\n is the instigator of the tunnel, the ID is the NAS/LAC\n tunnel ID, otherwise it is the HGW/LNS tunnel ID.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelLocalName": { "type": "string", "description": "The local name of an active VPDN tunnel. It will be\n the NAS/LAC name of the tunnel if the router serves as\n the NAS/LAC, or the HGW/LNS name of the tunnel if the\n system serves as the home gateway. Typically, the\n local name is the configured host name of the router.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvpdnTunnelRemoteName": { "type": "string", "description": "The remote name of an active VPDN tunnel. It will be\n the home gateway name of the tunnel if the system is a\n NAS/LAC, or the NAS/LAC name of the tunnel if the\n system serves as the home gateway.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvpdnTunnelRemoteEndpointName": { "type": "string", "description": "The remote end point name of an active VPDN tunnel.\n This name is either the domain name or the DNIS that\n this tunnel is projected with.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvpdnTunnelLocalInitConnection": { "type": "boolean", "description": "This object indicates whether the tunnel was generated\n locally or not.", "readOnly": true }, "cvpdnTunnelOrigCause": { "type": "string", "description": "The cause which originated an active VPDN tunnel. The\n tunnel can be projected via domain name, DNIS or a\n stack group (SGBP).", "readOnly": true }, "cvpdnTunnelState": { "type": "string", "description": "The current state of an active VPDN tunnel. Each state\n code is explained below:\n \n unknown: The current state of the tunnel is\n unknown.\n \n opening: The tunnel has just been instigated and\n is pending for a remote end reply to\n complete the process.\n \n open: The tunnel is active.\n \n closing: The tunnel has just been shut down and\n is pending for the remote end to reply\n to complete the process.", "readOnly": true }, "cvpdnTunnelActiveSessions": { "type": "integer", "description": "The total number of active session currently in the\n tunnel.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelDeniedUsers": { "type": "integer", "description": "A count of the accumulated total of denied users for\n the tunnel.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelSoftshut": { "type": "boolean", "description": "A VPDN tunnel can be put into a soft shut state to\n prevent any new user session to be added. This object\n specifies whether this tunnel has been soft shut.", "readOnly": true }, "cvpdnTunnelNetworkServiceType": { "type": "string", "description": "The type of network service used in the active tunnel.\n For now it is IP only.", "readOnly": true }, "cvpdnTunnelLocalIpAddress": { "type": "string", "description": "The local IP address of the tunnel. This IP address is\n that of the interface at the local end of the tunnel.", "format": "inet:ipv4-address", "readOnly": true }, "cvpdnTunnelSourceIpAddress": { "type": "string", "description": "The source IP address of the tunnel. This IP address\n is the user configurable IP address for Stack Group\n Biding Protocol (SGBP) via the CLI command:\n vpdn source-ip", "format": "inet:ipv4-address", "readOnly": true }, "cvpdnTunnelRemoteIpAddress": { "type": "string", "description": "The remote IP address of the tunnel. This IP address\n is that of the interface at the remote end of the\n tunnel.", "format": "inet:ipv4-address", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cvpdnTunnelAttrTable": { "type": "object", "description": "Table of information about the active VPDN tunnels. An\n entry is added to the table when a new tunnel is initiated\n and removed from the table when the tunnel is terminated.", "properties": { "cvpdnTunnelAttrEntry": { "type": "array", "description": "An entry in the table, containing information about a\n single active VPDN tunnel.", "items": { "type": "object", "properties": { "cvpdnSystemTunnelType": { "type": "string", "description": "cvpdnSystemTunnelType", "x-yang-type": "leafref", "readOnly": true }, "cvpdnTunnelAttrTunnelId": { "type": "integer", "description": "The Tunnel ID of an active VPDN tunnel. If this end is the\n instigator of the tunnel, the ID is the TS tunnel ID,\n otherwise it is the NAS tunnel ID.\n \n Two distinct tunnels with the same tunnel ID may exist, but\n with different tunnel types.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cvpdnTunnelAttrRemoteTunnelId": { "type": "integer", "description": "The remote Tunnel ID of an active VPDN tunnel. If this end\n is the instigator of the tunnel, the ID is the NAS tunnel\n ID, otherwise it is the TS tunnel ID.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cvpdnTunnelAttrLocalName": { "type": "string", "description": "The local name of an active VPDN tunnel. It will be the\n NAS name of the tunnel if the system serves as the NAS, or\n the TS name of the tunnel if the system serves as the\n tunnel server. Typically, the local name is the configured\n host name of the system.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvpdnTunnelAttrRemoteName": { "type": "string", "description": "The remote name of an active VPDN tunnel. It will be the\n tunnel server name of the tunnel if the system is a NAS,\n or the NAS name of the tunnel if the system serves as the\n tunnel server.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvpdnTunnelAttrRemoteEndpointName": { "type": "string", "description": "The remote end point name of an active VPDN tunnel. This\n name is either the domain name or the DNIS that this tunnel\n is projected with.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvpdnTunnelAttrLocalInitConnection": { "type": "boolean", "description": "This object indicates whether the tunnel was originated\n locally or not. If it's true, the tunnel was originated\n locally.", "readOnly": true }, "cvpdnTunnelAttrOrigCause": { "type": "string", "description": "The cause which originated an active VPDN tunnel. The\n tunnel can be projected via domain name, DNIS, stack group,\n or L2 Xconnect.", "readOnly": true }, "cvpdnTunnelAttrState": { "type": "string", "description": "The current state of an active VPDN tunnel.\n Tunnels of type l2f will have states with the 'l2f' prefix.\n Tunnels of type l2tp will have states with the 'l2tp'\n prefix.\n Tunnels of type pptp will have states with the 'pptp'\n prefix.\n \n Each state code is explained below:\n \n unknown: The current state of the tunnel is\n unknown.\n \n l2fOpening: The tunnel has just been initiated\n and is pending for a remote end\n reply to complete the process.\n \n l2fOpenWait: This end received a tunnel open\n request from the remote end and is\n waiting for the tunnel to be\n established.\n \n l2fOpen: The tunnel is active.\n \n l2fClosing: This end received a tunnel close\n request.\n \n l2fCloseWait: The tunnel has just been shut down\n and is pending for the remote end\n to reply to complete the process.\n \n l2tpIdle: No tunnel is initiated yet.\n \n l2tpWaitCtlReply: The tunnel has been initiated and\n is pending for a remote end reply\n to complete the process.\n \n l2tpEstablished: The tunnel is active.\n \n l2tpShuttingDown: The tunnel is in progress of\n shutting down.\n \n l2tpNoSessionLeft: There is no session left in the\n tunnel.\n \n pptpIdle: No tunnel is initiated yet.\n \n pptpWaitConnect: The tunnel is waiting for a TCP\n connection.\n \n pptpWaitCtlRequest: The tunnel has been initiated and\n is pending for a remote end\n request.\n \n pptpWaitCtlReply: The tunnel has been initiated and\n is pending for a remote end reply.\n \n pptpEstablished: The tunnel is active.\n \n pptpWaitStopReply: The tunnel is being shut down and\n is pending for a remote end reply.\n \n pptpTerminal: The tunnel has been shut down.", "readOnly": true }, "cvpdnTunnelAttrActiveSessions": { "type": "integer", "description": "The total number of active session currently in the\n tunnel.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelAttrDeniedUsers": { "type": "integer", "description": "A count of the accumulated total of denied users for the\n tunnel.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelAttrSoftshut": { "type": "boolean", "description": "A VPDN tunnel can be put into a soft shut state to prevent\n any new session to be added. This object specifies whether\n this tunnel has been soft shut. If its true, it has been\n soft shut.", "readOnly": true }, "cvpdnTunnelAttrNetworkServiceType": { "type": "string", "description": "The type of network service used in the active tunnel.", "readOnly": true }, "cvpdnTunnelAttrLocalIpAddress": { "type": "string", "description": "The local IP address of the tunnel. This IP address is\n that of the interface at the local end of the tunnel.", "format": "inet:ipv4-address", "readOnly": true }, "cvpdnTunnelAttrSourceIpAddress": { "type": "string", "description": "The source IP address of the tunnel. This IP address is\n the user configurable IP address for Stack Group Biding\n Protocol.", "format": "inet:ipv4-address", "readOnly": true }, "cvpdnTunnelAttrRemoteIpAddress": { "type": "string", "description": "The remote IP address of the tunnel. This IP address is\n that of the interface at the remote end of the tunnel.", "format": "inet:ipv4-address", "readOnly": true }, "cvpdnTunnelAttrLocalInetAddressType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnTunnelAttrLocalInetAddress", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cvpdnTunnelAttrLocalInetAddress": { "type": "string", "description": "The local IP address of the tunnel. This IP address is\n that of the interface at the local end of the tunnel.\n The type of this address is determined by the value of \n cvpdnTunnelAttrLocalInetAddressType.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cvpdnTunnelAttrSourceInetAddressType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnTunnelAttrSourceInetAddress", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cvpdnTunnelAttrSourceInetAddress": { "type": "string", "description": "The source IP address of the tunnel. This IP address is\n the user configurable IP address for Stack Group Biding\n Protocol. The type of this address is determined by the \n value of cvpdnTunnelAttrSourceInetAddressType.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cvpdnTunnelAttrRemoteInetAddressType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnTunnelAttrRemoteInetAddress", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cvpdnTunnelAttrRemoteInetAddress": { "type": "string", "description": "The remote IP address of the tunnel. This IP address is\n that of the interface at the remote end of the tunnel.\n The type of this address is determined by the value of \n cvpdnTunnelAttrRemoteInetAddressType.", "x-yang-type": "inet-address:InetAddress", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cvpdnTunnelSessionTable": { "type": "object", "description": "Table of information about individual user sessions\n within the active tunnels. Entry is added to the table\n when new user session is initiated and be removed from\n the table when the user session is terminated.", "properties": { "cvpdnTunnelSessionEntry": { "type": "array", "description": "An entry in the table, containing information about a\n single user session within the tunnel.", "items": { "type": "object", "properties": { "cvpdnTunnelTunnelId": { "type": "string", "description": "cvpdnTunnelTunnelId", "x-yang-type": "leafref", "readOnly": true }, "cvpdnTunnelSessionId": { "type": "integer", "description": "The ID of an active VPDN tunnel user session.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelSessionUserName": { "type": "string", "description": "The name of the user of the user session.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvpdnTunnelSessionState": { "type": "string", "description": "The current state of an active user session. Each state\n code is explained below:\n \n unknown: The current state of the tunnel's\n session is unknown.\n \n opening: The user session has just been\n initiated through a tunnel and is\n pending for the remote end reply\n to complete the process.\n \n open: The user session is active.\n \n closing: The user session has just been\n closed and is pending for the\n remote end reply to complete the\n process.\n \n waitingForTunnel: The user session is in this state\n when the tunnel which this session\n is going through is still in\n CLOSED state. It waits for the\n tunnel to become OPEN before the\n session is allow to be fully\n established.", "readOnly": true }, "cvpdnTunnelSessionCallDuration": { "type": "string", "description": "This object specifies the call duration of the current\n active user session in value of system uptime.", "x-yang-type": "yang:timeticks", "readOnly": true }, "cvpdnTunnelSessionPacketsOut": { "type": "integer", "description": "The total number of output packets through this active\n user session.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelSessionBytesOut": { "type": "integer", "description": "The total number of output bytes through this active\n user session.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelSessionPacketsIn": { "type": "integer", "description": "The total number of input packets through this active\n user session.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelSessionBytesIn": { "type": "integer", "description": "The total number of input bytes through this active\n user session.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelSessionDeviceType": { "type": "string", "description": "The type of physical devices that this user session\n is attached to for the local end of the tunnel. The\n meaning of each device type is explained below:\n \n other: Any device that has not been\n defined.\n \n asyncInternalModem: Modem Pool device of an access\n server.\n \n async: A regular asynchronous serial\n interface.\n \n sync: A regular synchronous serial\n interface.\n \n bchan: An ISDN call.\n \n xdsl: Future application with xDSL\n devices.\n \n cable: Future application with Cable\n modem devices.", "readOnly": true }, "cvpdnTunnelSessionDeviceCallerId": { "type": "string", "description": "The incoming caller identification of the user. It is\n the originating number that called into the device that\n initiates the user session. This object can be empty\n since not all dial device can provide caller ID\n information.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvpdnTunnelSessionDevicePhyId": { "type": "string", "description": "The device ID of the physical interface for the user\n session. The object is the the interface index which\n points to the ifTable. For virtual interface that is\n not in the ifTable, it will have zero value.", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true }, "cvpdnTunnelSessionMultilink": { "type": "boolean", "description": "This object indicates whether the session is part of a\n multilink or not.", "readOnly": true }, "cvpdnTunnelSessionModemSlotIndex": { "type": "integer", "description": "The Modem Pool database slot index if it is associated\n with this user session. Only a session with device of\n type asyncInternalModem will have a valid value for\n this object.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelSessionModemPortIndex": { "type": "integer", "description": "The Modem Pool database port index if it is associated\n with this user session. Only a session with a device\n of type asyncInternalModem will have a valid value for\n this object.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelSessionDS1SlotIndex": { "type": "integer", "description": "The DS1 database slot index if it is associated with\n this user session. Only a session with a device of\n type asyncInternalModem will have a valid value for\n this object.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelSessionDS1PortIndex": { "type": "integer", "description": "The DS1 database port index if it is associated with\n this user session. Only a session with a device of\n type asyncInternalModem will have a a valid value for\n this object.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelSessionDS1ChannelIndex": { "type": "integer", "description": "The DS1 database channel index if it is associated with\n this user session. Only a session over a device of\n type asyncInternalModem will have a valid value for\n this object.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelSessionModemCallStartTime": { "type": "string", "description": "The start time of the current modem call. Only a\n session with a device of type asyncInternalModem will\n have a valid value for this object.", "x-yang-type": "yang:timestamp", "readOnly": true }, "cvpdnTunnelSessionModemCallStartIndex": { "type": "integer", "description": "Arbitrary small integer to distinguish modem calls that\n occurred at the same time tick. Only session over\n device asyncInternalModem will have a valid value for\n this object.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cvpdnSessionAttrTable": { "type": "object", "description": "Table of information about individual sessions within the\n active tunnels. An entry is added to the table when a new\n session is initiated and removed from the table when the\n session is terminated.", "properties": { "cvpdnSessionAttrEntry": { "type": "array", "description": "An entry in the table, containing information about a\n single session within the tunnel.", "items": { "type": "object", "properties": { "cvpdnSystemTunnelType": { "type": "string", "description": "cvpdnSystemTunnelType", "x-yang-type": "leafref", "readOnly": true }, "cvpdnTunnelAttrTunnelId": { "type": "string", "description": "cvpdnTunnelAttrTunnelId", "x-yang-type": "leafref", "readOnly": true }, "cvpdnSessionAttrSessionId": { "type": "integer", "description": "The ID of an active VPDN session.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cvpdnSessionAttrUserName": { "type": "string", "description": "The name of the user of the session.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvpdnSessionAttrState": { "type": "string", "description": "The current state of a tunnel session.\n L2F tunnel sessions will have states with the 'l2f' prefix.\n L2TP tunnel sessions will have states with the 'l2tp'\n prefix.\n \n Each state code is explained below:\n \n unknown: The current state of the tunnel's\n session is unknown.\n \n l2fOpening: The session has just been\n initiated through a tunnel and is\n pending for the remote end reply\n to complete the process.\n \n l2fOpen: The session is active.\n \n l2fCloseWait: The session has just been closed\n and is pending for the remote end\n reply to complete the process.\n \n l2fWaitingForTunnel: The session is in this state when\n the tunnel which this session is\n going through is still in CLOSED\n state. It waits for the tunnel to\n become OPEN before the session is\n allowed to be fully established.\n \n l2tpIdle: No session is initiated yet.\n \n l2tpWaitingTunnel: The session is waiting for the\n tunnel to be established.\n \n l2tpWaitReply: The session has been initiated and\n is pending for the remote end\n reply to complete the process.\n \n l2tpWaitConnect: This end has acknowledged a\n connection request and is waiting\n for the remote end to connect.\n \n l2tpEstablished: The session is active.\n \n l2tpShuttingDown: The session is in progress of\n shutting down.\n \n pptpWaitVAccess: The session is waiting for the\n creation of a virtual access\n interface.\n \n pptpPacEstablished: The session is active.\n \n pptpWaitTunnel: The session is waiting for the\n tunnel to be established.\n \n pptpWaitOCRP: The session has been initiated and\n is pending for the remote end\n reply to complete the process.\n \n pptpPnsEstablished: The session is active.\n \n pptpWaitCallDisc: Session shutdown is in progress.", "readOnly": true }, "cvpdnSessionAttrCallDuration": { "type": "string", "description": "This object specifies the call duration of the current\n active session.", "x-yang-type": "yang:timeticks", "readOnly": true }, "cvpdnSessionAttrPacketsOut": { "type": "integer", "description": "The total number of output packets through this active\n session.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSessionAttrBytesOut": { "type": "integer", "description": "The total number of output bytes through this active\n session.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSessionAttrPacketsIn": { "type": "integer", "description": "The total number of input packets through this active\n session.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSessionAttrBytesIn": { "type": "integer", "description": "The total number of input bytes through this active\n session.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSessionAttrDeviceType": { "type": "string", "description": "The type of physical devices that this session is attached\n to for the local end of the tunnel. The meaning of each\n device type is explained below:\n \n other: Any device that has not been\n defined.\n \n asyncInternalModem: Modem Pool device of an access\n server.\n \n async: A regular asynchronous serial\n interface.\n \n sync: A regular synchronous serial\n interface.\n \n bchan: An ISDN call.\n \n xdsl: xDSL interface.\n \n cable: cable modem interface.", "readOnly": true }, "cvpdnSessionAttrDeviceCallerId": { "type": "string", "description": "The incoming caller identification of the user. It is the\n originating number that called into the device that\n initiates the session. This object can be empty since not\n all dial devices can provide caller ID information.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvpdnSessionAttrDevicePhyId": { "type": "string", "description": "The device ID of the physical interface for the session.\n The object is the the interface index which points to the\n ifTable. For virtual interfaces that are not in the\n ifTable, the value will be zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true }, "cvpdnSessionAttrMultilink": { "type": "boolean", "description": "This object indicates whether the session is part of a\n multilink PPP bundle, even if there is only one link or\n session in the bundle. If it is multilink PPP, the value\n is true.", "readOnly": true }, "cvpdnSessionAttrModemSlotIndex": { "type": "integer", "description": "The Modem Pool database slot index if it is associated with\n this session. Only a session with device of type\n 'asyncInternalModem' will have a valid value for this\n object; otherwise, it is not instantiated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSessionAttrModemPortIndex": { "type": "integer", "description": "The Modem Pool database port index if it is associated with\n this session. Only a session with a device of type\n 'asyncInternalModem' will have a valid value for this\n object; otherwise, it is not instantiated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSessionAttrDS1SlotIndex": { "type": "integer", "description": "The DS1 database slot index if it is associated with this\n session. Only a session with a device of type\n 'asyncInternalModem' will have a valid value for this\n object; otherwise it is not instantiated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSessionAttrDS1PortIndex": { "type": "integer", "description": "The DS1 database port index if it is associated with this\n session. Only a session with a device of type\n 'asyncInternalModem' will have a valid value for this\n object; otherwise it is not instantiated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSessionAttrDS1ChannelIndex": { "type": "integer", "description": "The DS1 database channel index if it is associated with\n this session. Only a session over a device of type\n 'asyncInternalModem' will have a valid value for this\n object; otherwise it is not instantiated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSessionAttrModemCallStartTime": { "type": "string", "description": "The start time of the current modem call. Only a session\n with a device of type 'asyncInternalModem' will have a\n valid value for this object; otherwise, it is not\n instantiated.", "x-yang-type": "yang:timestamp", "readOnly": true }, "cvpdnSessionAttrModemCallStartIndex": { "type": "integer", "description": "Arbitrary small integer to distinguish modem calls that\n occurred at the same time tick. Only session over device\n 'asyncInternalModem' will have a valid value for this\n object; otherwise, it is not instantiated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSessionAttrVirtualCircuitID": { "type": "integer", "description": "The virtual circuit ID of an active Layer 2 VPN session.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSessionAttrSentPktsDropped": { "type": "integer", "description": "The total number of dropped packets that could not be sent\n into this active session.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSessionAttrRecvPktsDropped": { "type": "integer", "description": "The total number of dropped packets that were received from\n this active session.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSessionAttrMultilinkBundle": { "type": "string", "description": "This object specifies the name of the multilink bundle to\n which this session belongs. The value of this object is\n only valid when the value of cvpdnSessionAttrMultilink is\n 'true'. If the value of cvpdnSessionAttrMultilink is\n 'false', then the value of this object will be the empty\n string.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cvpdnSessionAttrMultilinkIfIndex": { "type": "string", "description": "This object specifies the ifIndex of the multilink bundle\n to which this session belongs. The value of this object is\n only valid when the value of cvpdnSessionAttrMultilink is\n 'true'. If the value of cvpdnSessionAttrMultilink is\n 'false', then the value of this object will be zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cvpdnUserToFailHistInfoTable": { "type": "object", "description": "Table of the record of failure objects which can be\n referenced by an user name. Only a name that has a\n valid item in the Cisco IOS VPDN failure history table\n will yield a valid entry in this table. The table has\n a maximum size of 50 entries. Only the newest 50\n entries will be kept in the table.", "properties": { "cvpdnUserToFailHistInfoEntry": { "type": "array", "description": "An entry in the table, containing failure history\n relevant to an user name.", "items": { "type": "object", "properties": { "cvpdnUnameToFailHistUname": { "type": "string", "description": "The user name for this failure entry.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvpdnUnameToFailHistTunnelId": { "type": "integer", "description": "The Tunnel ID for this failure entry. If it is the\n instigator of the tunnel, the ID is the TS tunnel ID,\n otherwise it is the NAS tunnel ID.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnUnameToFailHistUserId": { "type": "integer", "description": "The user ID of this failure entry.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnUnameToFailHistLocalInitConn": { "type": "boolean", "description": "This object indicates whether the tunnel in which the\n failure occurred was generated locally or not.", "readOnly": true }, "cvpdnUnameToFailHistLocalName": { "type": "string", "description": "The local name of the VPDN tunnel in which the failure\n occurred. It will be the NAS name of the tunnel if the\n system serves as the NAS, or the TS name of the tunnel\n if the system serves as the tunnel server. The local\n name is the configured host name of the system. This\n object can be empty if the failure occurred prior to\n successful tunnel projection, thus no source name will\n be available.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvpdnUnameToFailHistRemoteName": { "type": "string", "description": "The remote name of the VPDN tunnel in which the failure\n occurred. It will be the tunnel server name of the\n tunnel if the system is a NAS, or the NAS name of the\n tunnel if the system serves as the tunnel server. This\n object can be empty if the failure occurred prior to\n successful tunnel projection, thus no source name will\n be available.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvpdnUnameToFailHistSourceIp": { "type": "string", "description": "The source IP address of the tunnel in which the\n failure occurred. This IP address is that of the\n interface at the instigator end of the tunnel.", "format": "inet:ipv4-address", "readOnly": true }, "cvpdnUnameToFailHistDestIp": { "type": "string", "description": "The destination IP address of the tunnel in which the\n failure occurred. This IP address is that of the\n interface at the receiver end of the tunnel.", "format": "inet:ipv4-address", "readOnly": true }, "cvpdnUnameToFailHistCount": { "type": "integer", "description": "This object is incremented when multiple failures has\n been experienced by this user on this tunnel. Seeing a\n delta of >1 is an indication that the current failure\n record is the latest of a series of failures that has\n been recorded.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnUnameToFailHistFailTime": { "type": "string", "description": "This object specifies the time when the failure is\n occurred.", "x-yang-type": "yang:timestamp", "readOnly": true }, "cvpdnUnameToFailHistFailType": { "type": "string", "description": "The type of failure for the current failure record. It\n comes in a form of a an ASCII string which describes\n the type of failure.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvpdnUnameToFailHistFailReason": { "type": "string", "description": "The reason of failure for the current failure record.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvpdnUnameToFailHistSourceInetType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnUnameToFailHistSourceInetAddr.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cvpdnUnameToFailHistSourceInetAddr": { "type": "string", "description": "The source IP address of the tunnel in which the\n failure occurred. This IP address is that of the\n interface at the instigator end of the tunnel. The\n instigator end is the peer which initiates the tunnel\n estalishment. The type of this address is determined\n by the value of cvpdnUnameToFailHistSourceInetType.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cvpdnUnameToFailHistDestInetType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnUnameToFailHistDestInetAddr.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cvpdnUnameToFailHistDestInetAddr": { "type": "string", "description": "The destination IP address of the tunnel in which the\n failure occurred. This IP address is that of the\n interface at the receiver end of the tunnel. The type \n of this address is determined by the value of \n cvpdnUnameToFailHistDestInetType.", "x-yang-type": "inet-address:InetAddress", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cvpdnTemplateTable": { "type": "object", "description": "Table of information about the VPDN templates. The\n VPDN template is a grouping mechanism that allows\n configuration settings to be shared among multiple VPDN\n groups. One such setting is a limit on the number of\n active sessions across all VPDN groups associated with\n the template. The template table allows customers to\n monitor template-wide information such as tracking the\n allocation of sessions across templates.", "properties": { "cvpdnTemplateEntry": { "type": "array", "description": "An entry in the table, containing information about a\n single VPDN template.", "items": { "type": "object", "properties": { "cvpdnTemplateName": { "type": "string", "description": "The name of the VPDN template.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cvpdnTemplateActiveSessions": { "type": "integer", "description": "The total number of active session in all groups\n associated with the template.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cvpdnBundleTable": { "type": "object", "description": "Table that describes the multilink PPP attributes of the\n active VPDN sessions.", "properties": { "cvpdnBundleEntry": { "type": "array", "description": "An entry in this table represents an active multilink PPP\n bundle that belongs to a VPDN tunnel.", "items": { "type": "object", "properties": { "cvpdnBundleName": { "type": "string", "description": "The name of the multilink PPP bundle associated with a VPDN\n tunnel.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cvpdnBundleLinkCount": { "type": "integer", "description": "The total number of active links in a multilink PPP bundle\n associated with a VPDN tunnel.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnBundleEndpointType": { "type": "string", "description": "The multilink PPP bundle discriminator type associated with\n a VPDN tunnel. The value of this object represents the type\n of discriminator used in cvpdnBundleEndpoint.\n \n none: No endpoint discriminator was supplied, the\n default value is being used.\n \n hostname: The router's hostname is being used as\n discriminator.\n \n string: User specified string is being used as\n discriminator.\n \n macAddress: A MAC address as defined by the MacAddress\n textual convention is being used as\n discriminator.\n \n ipV4Address: An IP address as defined by the\n InetAddressIPv4 textual convention is being\n used as discriminator.\n \n ipV6Address: An IP address as defined by the\n InetAddressIPv6 textual convention is being\n used as discriminator.\n \n phone: The PSTN phone number is being used as\n discriminator.\n \n magicNumber: A magic number is being used as\n discriminator.", "readOnly": true }, "cvpdnBundleEndpoint": { "type": "string", "description": "Indicates the discriminator used in this bundle that is\n associated with a VPDN tunnel.", "format": "binary", "readOnly": true }, "cvpdnBundlePeerIpAddrType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnBundlePeerIpAddr.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cvpdnBundlePeerIpAddr": { "type": "string", "description": "The IP address of the multilink PPP peer in a VPDN tunnel.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cvpdnBundleEndpointClass": { "type": "string", "description": "The multilink PPP bundle discriminator class associated\n with a VPDN tunnel. The value of this object represents the\n type of discriminator used in cvpdnBundleEndpoint.", "x-yang-type": "CISCO-VPDN-MGMT-MIB:EndpointClass", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cvpdnBundleChildTable": { "type": "object", "description": "A table that exposes the containment relationship between a\n multilink PPP bundle and a VPDN tunnel.", "properties": { "cvpdnBundleChildEntry": { "type": "array", "description": "An entry in this table represents a session that belongs to\n a VPDN tunnel and to a multilink PPP bundle.", "items": { "type": "object", "properties": { "cvpdnBundleName": { "type": "string", "description": "cvpdnBundleName", "x-yang-type": "leafref", "readOnly": true }, "cvpdnBundleChildTunnelType": { "type": "string", "description": "The tunnel type. This is the tunnel protocol of an active\n VPDN session that is associated with a multilink PPP\n bundle.", "x-yang-type": "CISCO-VPDN-MGMT-MIB:TunnelType", "readOnly": true }, "cvpdnBundleChildTunnelId": { "type": "integer", "description": "The Tunnel ID of an active VPDN session that is associated\n with a multilink PPP bundle.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnBundleChildSessionId": { "type": "integer", "description": "The ID of an active VPDN session that is associated with a\n multilink PPP bundle.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true } }, "readOnly": true } } }, "CISCO-VPDN-MGMT-MIB_object-1": { "type": "object", "description": "object-1", "properties": { "cvpdnNotifSessionID": { "type": "string", "description": "cvpdnNotifSessionID", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-VPDN-MGMT-MIB_object-2": { "type": "object", "description": "object-2", "properties": { "cvpdnNotifSessionEvent": { "type": "string", "description": "cvpdnNotifSessionEvent", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-VPDN-MGMT-MIB_object-3": { "type": "object", "description": "object-3", "properties": { "cvpdnSystemTunnelType": { "type": "string", "description": "cvpdnSystemTunnelType", "x-yang-type": "leafref", "readOnly": true }, "cvpdnTunnelAttrTunnelId": { "type": "string", "description": "cvpdnTunnelAttrTunnelId", "x-yang-type": "leafref", "readOnly": true }, "cvpdnSessionAttrSessionId": { "type": "string", "description": "cvpdnSessionAttrSessionId", "x-yang-type": "leafref", "readOnly": true }, "cvpdnSessionAttrDevicePhyId": { "type": "string", "description": "cvpdnSessionAttrDevicePhyId", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-VPDN-MGMT-MIB_object-4": { "type": "object", "description": "object-4", "properties": { "cvpdnSystemTunnelType": { "type": "string", "description": "cvpdnSystemTunnelType", "x-yang-type": "leafref", "readOnly": true }, "cvpdnTunnelAttrTunnelId": { "type": "string", "description": "cvpdnTunnelAttrTunnelId", "x-yang-type": "leafref", "readOnly": true }, "cvpdnSessionAttrSessionId": { "type": "string", "description": "cvpdnSessionAttrSessionId", "x-yang-type": "leafref", "readOnly": true }, "cvpdnSessionAttrVirtualCircuitID": { "type": "string", "description": "cvpdnSessionAttrVirtualCircuitID", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-VPDN-MGMT-MIB_cvpdnSystemEntry": { "type": "array", "description": "An entry in the table, containing information about a\n single type of VPDN tunnel.", "items": { "type": "object", "properties": { "cvpdnSystemTunnelType": { "type": "string", "description": "The tunnel type. This is the tunnel protocol.", "x-yang-type": "CISCO-VPDN-MGMT-MIB:TunnelType", "readOnly": true }, "cvpdnSystemTunnelTotal": { "type": "integer", "description": "The total number of VPDN tunnels that are currently active\n of this tunnel type.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSystemSessionTotal": { "type": "integer", "description": "The total number of active sessions in all the active VPDN\n tunnels of this tunnel type.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSystemDeniedUsersTotal": { "type": "integer", "description": "The total number of denied user attempts to all the VPDN\n tunnels of this tunnel type since last system\n re-initialization.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSystemInitialConnReq": { "type": "integer", "description": "The total number tunnel connection attempts on all the VPDN\n tunnels of this tunnel type since last system\n re-initialization.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSystemSuccessConnReq": { "type": "integer", "description": "The total number tunnel Successful connection attempts in VPDN\n tunnels of this tunnel type since last system\n re-initialization.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSystemFailedConnReq": { "type": "integer", "description": "The total number tunnel Failed connection attempts in VPDN\n tunnels of this tunnel type since last system\n re-initialization.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } } }, "CISCO-VPDN-MGMT-MIB_cvpdnTunnelEntry": { "type": "array", "description": "An entry in the table, containing information about a\n single active VPDN tunnel.", "items": { "type": "object", "properties": { "cvpdnTunnelTunnelId": { "type": "integer", "description": "The Tunnel ID of an active VPDN tunnel. If it is the\n instigator of the tunnel, the ID is the HGW/LNS tunnel\n ID, otherwise it is the NAS/LAC tunnel ID.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelRemoteTunnelId": { "type": "integer", "description": "The remote Tunnel ID of an active VPDN tunnel. If it\n is the instigator of the tunnel, the ID is the NAS/LAC\n tunnel ID, otherwise it is the HGW/LNS tunnel ID.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelLocalName": { "type": "string", "description": "The local name of an active VPDN tunnel. It will be\n the NAS/LAC name of the tunnel if the router serves as\n the NAS/LAC, or the HGW/LNS name of the tunnel if the\n system serves as the home gateway. Typically, the\n local name is the configured host name of the router.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvpdnTunnelRemoteName": { "type": "string", "description": "The remote name of an active VPDN tunnel. It will be\n the home gateway name of the tunnel if the system is a\n NAS/LAC, or the NAS/LAC name of the tunnel if the\n system serves as the home gateway.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvpdnTunnelRemoteEndpointName": { "type": "string", "description": "The remote end point name of an active VPDN tunnel.\n This name is either the domain name or the DNIS that\n this tunnel is projected with.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvpdnTunnelLocalInitConnection": { "type": "boolean", "description": "This object indicates whether the tunnel was generated\n locally or not.", "readOnly": true }, "cvpdnTunnelOrigCause": { "type": "string", "description": "The cause which originated an active VPDN tunnel. The\n tunnel can be projected via domain name, DNIS or a\n stack group (SGBP).", "readOnly": true }, "cvpdnTunnelState": { "type": "string", "description": "The current state of an active VPDN tunnel. Each state\n code is explained below:\n \n unknown: The current state of the tunnel is\n unknown.\n \n opening: The tunnel has just been instigated and\n is pending for a remote end reply to\n complete the process.\n \n open: The tunnel is active.\n \n closing: The tunnel has just been shut down and\n is pending for the remote end to reply\n to complete the process.", "readOnly": true }, "cvpdnTunnelActiveSessions": { "type": "integer", "description": "The total number of active session currently in the\n tunnel.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelDeniedUsers": { "type": "integer", "description": "A count of the accumulated total of denied users for\n the tunnel.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelSoftshut": { "type": "boolean", "description": "A VPDN tunnel can be put into a soft shut state to\n prevent any new user session to be added. This object\n specifies whether this tunnel has been soft shut.", "readOnly": true }, "cvpdnTunnelNetworkServiceType": { "type": "string", "description": "The type of network service used in the active tunnel.\n For now it is IP only.", "readOnly": true }, "cvpdnTunnelLocalIpAddress": { "type": "string", "description": "The local IP address of the tunnel. This IP address is\n that of the interface at the local end of the tunnel.", "format": "inet:ipv4-address", "readOnly": true }, "cvpdnTunnelSourceIpAddress": { "type": "string", "description": "The source IP address of the tunnel. This IP address\n is the user configurable IP address for Stack Group\n Biding Protocol (SGBP) via the CLI command:\n vpdn source-ip", "format": "inet:ipv4-address", "readOnly": true }, "cvpdnTunnelRemoteIpAddress": { "type": "string", "description": "The remote IP address of the tunnel. This IP address\n is that of the interface at the remote end of the\n tunnel.", "format": "inet:ipv4-address", "readOnly": true } } } }, "CISCO-VPDN-MGMT-MIB_cvpdnTunnelAttrEntry": { "type": "array", "description": "An entry in the table, containing information about a\n single active VPDN tunnel.", "items": { "type": "object", "properties": { "cvpdnSystemTunnelType": { "type": "string", "description": "cvpdnSystemTunnelType", "x-yang-type": "leafref", "readOnly": true }, "cvpdnTunnelAttrTunnelId": { "type": "integer", "description": "The Tunnel ID of an active VPDN tunnel. If this end is the\n instigator of the tunnel, the ID is the TS tunnel ID,\n otherwise it is the NAS tunnel ID.\n \n Two distinct tunnels with the same tunnel ID may exist, but\n with different tunnel types.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cvpdnTunnelAttrRemoteTunnelId": { "type": "integer", "description": "The remote Tunnel ID of an active VPDN tunnel. If this end\n is the instigator of the tunnel, the ID is the NAS tunnel\n ID, otherwise it is the TS tunnel ID.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cvpdnTunnelAttrLocalName": { "type": "string", "description": "The local name of an active VPDN tunnel. It will be the\n NAS name of the tunnel if the system serves as the NAS, or\n the TS name of the tunnel if the system serves as the\n tunnel server. Typically, the local name is the configured\n host name of the system.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvpdnTunnelAttrRemoteName": { "type": "string", "description": "The remote name of an active VPDN tunnel. It will be the\n tunnel server name of the tunnel if the system is a NAS,\n or the NAS name of the tunnel if the system serves as the\n tunnel server.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvpdnTunnelAttrRemoteEndpointName": { "type": "string", "description": "The remote end point name of an active VPDN tunnel. This\n name is either the domain name or the DNIS that this tunnel\n is projected with.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvpdnTunnelAttrLocalInitConnection": { "type": "boolean", "description": "This object indicates whether the tunnel was originated\n locally or not. If it's true, the tunnel was originated\n locally.", "readOnly": true }, "cvpdnTunnelAttrOrigCause": { "type": "string", "description": "The cause which originated an active VPDN tunnel. The\n tunnel can be projected via domain name, DNIS, stack group,\n or L2 Xconnect.", "readOnly": true }, "cvpdnTunnelAttrState": { "type": "string", "description": "The current state of an active VPDN tunnel.\n Tunnels of type l2f will have states with the 'l2f' prefix.\n Tunnels of type l2tp will have states with the 'l2tp'\n prefix.\n Tunnels of type pptp will have states with the 'pptp'\n prefix.\n \n Each state code is explained below:\n \n unknown: The current state of the tunnel is\n unknown.\n \n l2fOpening: The tunnel has just been initiated\n and is pending for a remote end\n reply to complete the process.\n \n l2fOpenWait: This end received a tunnel open\n request from the remote end and is\n waiting for the tunnel to be\n established.\n \n l2fOpen: The tunnel is active.\n \n l2fClosing: This end received a tunnel close\n request.\n \n l2fCloseWait: The tunnel has just been shut down\n and is pending for the remote end\n to reply to complete the process.\n \n l2tpIdle: No tunnel is initiated yet.\n \n l2tpWaitCtlReply: The tunnel has been initiated and\n is pending for a remote end reply\n to complete the process.\n \n l2tpEstablished: The tunnel is active.\n \n l2tpShuttingDown: The tunnel is in progress of\n shutting down.\n \n l2tpNoSessionLeft: There is no session left in the\n tunnel.\n \n pptpIdle: No tunnel is initiated yet.\n \n pptpWaitConnect: The tunnel is waiting for a TCP\n connection.\n \n pptpWaitCtlRequest: The tunnel has been initiated and\n is pending for a remote end\n request.\n \n pptpWaitCtlReply: The tunnel has been initiated and\n is pending for a remote end reply.\n \n pptpEstablished: The tunnel is active.\n \n pptpWaitStopReply: The tunnel is being shut down and\n is pending for a remote end reply.\n \n pptpTerminal: The tunnel has been shut down.", "readOnly": true }, "cvpdnTunnelAttrActiveSessions": { "type": "integer", "description": "The total number of active session currently in the\n tunnel.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelAttrDeniedUsers": { "type": "integer", "description": "A count of the accumulated total of denied users for the\n tunnel.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelAttrSoftshut": { "type": "boolean", "description": "A VPDN tunnel can be put into a soft shut state to prevent\n any new session to be added. This object specifies whether\n this tunnel has been soft shut. If its true, it has been\n soft shut.", "readOnly": true }, "cvpdnTunnelAttrNetworkServiceType": { "type": "string", "description": "The type of network service used in the active tunnel.", "readOnly": true }, "cvpdnTunnelAttrLocalIpAddress": { "type": "string", "description": "The local IP address of the tunnel. This IP address is\n that of the interface at the local end of the tunnel.", "format": "inet:ipv4-address", "readOnly": true }, "cvpdnTunnelAttrSourceIpAddress": { "type": "string", "description": "The source IP address of the tunnel. This IP address is\n the user configurable IP address for Stack Group Biding\n Protocol.", "format": "inet:ipv4-address", "readOnly": true }, "cvpdnTunnelAttrRemoteIpAddress": { "type": "string", "description": "The remote IP address of the tunnel. This IP address is\n that of the interface at the remote end of the tunnel.", "format": "inet:ipv4-address", "readOnly": true }, "cvpdnTunnelAttrLocalInetAddressType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnTunnelAttrLocalInetAddress", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cvpdnTunnelAttrLocalInetAddress": { "type": "string", "description": "The local IP address of the tunnel. This IP address is\n that of the interface at the local end of the tunnel.\n The type of this address is determined by the value of \n cvpdnTunnelAttrLocalInetAddressType.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cvpdnTunnelAttrSourceInetAddressType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnTunnelAttrSourceInetAddress", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cvpdnTunnelAttrSourceInetAddress": { "type": "string", "description": "The source IP address of the tunnel. This IP address is\n the user configurable IP address for Stack Group Biding\n Protocol. The type of this address is determined by the \n value of cvpdnTunnelAttrSourceInetAddressType.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cvpdnTunnelAttrRemoteInetAddressType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnTunnelAttrRemoteInetAddress", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cvpdnTunnelAttrRemoteInetAddress": { "type": "string", "description": "The remote IP address of the tunnel. This IP address is\n that of the interface at the remote end of the tunnel.\n The type of this address is determined by the value of \n cvpdnTunnelAttrRemoteInetAddressType.", "x-yang-type": "inet-address:InetAddress", "readOnly": true } } } }, "CISCO-VPDN-MGMT-MIB_cvpdnTunnelSessionEntry": { "type": "array", "description": "An entry in the table, containing information about a\n single user session within the tunnel.", "items": { "type": "object", "properties": { "cvpdnTunnelTunnelId": { "type": "string", "description": "cvpdnTunnelTunnelId", "x-yang-type": "leafref", "readOnly": true }, "cvpdnTunnelSessionId": { "type": "integer", "description": "The ID of an active VPDN tunnel user session.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelSessionUserName": { "type": "string", "description": "The name of the user of the user session.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvpdnTunnelSessionState": { "type": "string", "description": "The current state of an active user session. Each state\n code is explained below:\n \n unknown: The current state of the tunnel's\n session is unknown.\n \n opening: The user session has just been\n initiated through a tunnel and is\n pending for the remote end reply\n to complete the process.\n \n open: The user session is active.\n \n closing: The user session has just been\n closed and is pending for the\n remote end reply to complete the\n process.\n \n waitingForTunnel: The user session is in this state\n when the tunnel which this session\n is going through is still in\n CLOSED state. It waits for the\n tunnel to become OPEN before the\n session is allow to be fully\n established.", "readOnly": true }, "cvpdnTunnelSessionCallDuration": { "type": "string", "description": "This object specifies the call duration of the current\n active user session in value of system uptime.", "x-yang-type": "yang:timeticks", "readOnly": true }, "cvpdnTunnelSessionPacketsOut": { "type": "integer", "description": "The total number of output packets through this active\n user session.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelSessionBytesOut": { "type": "integer", "description": "The total number of output bytes through this active\n user session.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelSessionPacketsIn": { "type": "integer", "description": "The total number of input packets through this active\n user session.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelSessionBytesIn": { "type": "integer", "description": "The total number of input bytes through this active\n user session.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelSessionDeviceType": { "type": "string", "description": "The type of physical devices that this user session\n is attached to for the local end of the tunnel. The\n meaning of each device type is explained below:\n \n other: Any device that has not been\n defined.\n \n asyncInternalModem: Modem Pool device of an access\n server.\n \n async: A regular asynchronous serial\n interface.\n \n sync: A regular synchronous serial\n interface.\n \n bchan: An ISDN call.\n \n xdsl: Future application with xDSL\n devices.\n \n cable: Future application with Cable\n modem devices.", "readOnly": true }, "cvpdnTunnelSessionDeviceCallerId": { "type": "string", "description": "The incoming caller identification of the user. It is\n the originating number that called into the device that\n initiates the user session. This object can be empty\n since not all dial device can provide caller ID\n information.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvpdnTunnelSessionDevicePhyId": { "type": "string", "description": "The device ID of the physical interface for the user\n session. The object is the the interface index which\n points to the ifTable. For virtual interface that is\n not in the ifTable, it will have zero value.", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true }, "cvpdnTunnelSessionMultilink": { "type": "boolean", "description": "This object indicates whether the session is part of a\n multilink or not.", "readOnly": true }, "cvpdnTunnelSessionModemSlotIndex": { "type": "integer", "description": "The Modem Pool database slot index if it is associated\n with this user session. Only a session with device of\n type asyncInternalModem will have a valid value for\n this object.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelSessionModemPortIndex": { "type": "integer", "description": "The Modem Pool database port index if it is associated\n with this user session. Only a session with a device\n of type asyncInternalModem will have a valid value for\n this object.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelSessionDS1SlotIndex": { "type": "integer", "description": "The DS1 database slot index if it is associated with\n this user session. Only a session with a device of\n type asyncInternalModem will have a valid value for\n this object.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelSessionDS1PortIndex": { "type": "integer", "description": "The DS1 database port index if it is associated with\n this user session. Only a session with a device of\n type asyncInternalModem will have a a valid value for\n this object.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelSessionDS1ChannelIndex": { "type": "integer", "description": "The DS1 database channel index if it is associated with\n this user session. Only a session over a device of\n type asyncInternalModem will have a valid value for\n this object.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnTunnelSessionModemCallStartTime": { "type": "string", "description": "The start time of the current modem call. Only a\n session with a device of type asyncInternalModem will\n have a valid value for this object.", "x-yang-type": "yang:timestamp", "readOnly": true }, "cvpdnTunnelSessionModemCallStartIndex": { "type": "integer", "description": "Arbitrary small integer to distinguish modem calls that\n occurred at the same time tick. Only session over\n device asyncInternalModem will have a valid value for\n this object.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } } }, "CISCO-VPDN-MGMT-MIB_cvpdnSessionAttrEntry": { "type": "array", "description": "An entry in the table, containing information about a\n single session within the tunnel.", "items": { "type": "object", "properties": { "cvpdnSystemTunnelType": { "type": "string", "description": "cvpdnSystemTunnelType", "x-yang-type": "leafref", "readOnly": true }, "cvpdnTunnelAttrTunnelId": { "type": "string", "description": "cvpdnTunnelAttrTunnelId", "x-yang-type": "leafref", "readOnly": true }, "cvpdnSessionAttrSessionId": { "type": "integer", "description": "The ID of an active VPDN session.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cvpdnSessionAttrUserName": { "type": "string", "description": "The name of the user of the session.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvpdnSessionAttrState": { "type": "string", "description": "The current state of a tunnel session.\n L2F tunnel sessions will have states with the 'l2f' prefix.\n L2TP tunnel sessions will have states with the 'l2tp'\n prefix.\n \n Each state code is explained below:\n \n unknown: The current state of the tunnel's\n session is unknown.\n \n l2fOpening: The session has just been\n initiated through a tunnel and is\n pending for the remote end reply\n to complete the process.\n \n l2fOpen: The session is active.\n \n l2fCloseWait: The session has just been closed\n and is pending for the remote end\n reply to complete the process.\n \n l2fWaitingForTunnel: The session is in this state when\n the tunnel which this session is\n going through is still in CLOSED\n state. It waits for the tunnel to\n become OPEN before the session is\n allowed to be fully established.\n \n l2tpIdle: No session is initiated yet.\n \n l2tpWaitingTunnel: The session is waiting for the\n tunnel to be established.\n \n l2tpWaitReply: The session has been initiated and\n is pending for the remote end\n reply to complete the process.\n \n l2tpWaitConnect: This end has acknowledged a\n connection request and is waiting\n for the remote end to connect.\n \n l2tpEstablished: The session is active.\n \n l2tpShuttingDown: The session is in progress of\n shutting down.\n \n pptpWaitVAccess: The session is waiting for the\n creation of a virtual access\n interface.\n \n pptpPacEstablished: The session is active.\n \n pptpWaitTunnel: The session is waiting for the\n tunnel to be established.\n \n pptpWaitOCRP: The session has been initiated and\n is pending for the remote end\n reply to complete the process.\n \n pptpPnsEstablished: The session is active.\n \n pptpWaitCallDisc: Session shutdown is in progress.", "readOnly": true }, "cvpdnSessionAttrCallDuration": { "type": "string", "description": "This object specifies the call duration of the current\n active session.", "x-yang-type": "yang:timeticks", "readOnly": true }, "cvpdnSessionAttrPacketsOut": { "type": "integer", "description": "The total number of output packets through this active\n session.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSessionAttrBytesOut": { "type": "integer", "description": "The total number of output bytes through this active\n session.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSessionAttrPacketsIn": { "type": "integer", "description": "The total number of input packets through this active\n session.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSessionAttrBytesIn": { "type": "integer", "description": "The total number of input bytes through this active\n session.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSessionAttrDeviceType": { "type": "string", "description": "The type of physical devices that this session is attached\n to for the local end of the tunnel. The meaning of each\n device type is explained below:\n \n other: Any device that has not been\n defined.\n \n asyncInternalModem: Modem Pool device of an access\n server.\n \n async: A regular asynchronous serial\n interface.\n \n sync: A regular synchronous serial\n interface.\n \n bchan: An ISDN call.\n \n xdsl: xDSL interface.\n \n cable: cable modem interface.", "readOnly": true }, "cvpdnSessionAttrDeviceCallerId": { "type": "string", "description": "The incoming caller identification of the user. It is the\n originating number that called into the device that\n initiates the session. This object can be empty since not\n all dial devices can provide caller ID information.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvpdnSessionAttrDevicePhyId": { "type": "string", "description": "The device ID of the physical interface for the session.\n The object is the the interface index which points to the\n ifTable. For virtual interfaces that are not in the\n ifTable, the value will be zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true }, "cvpdnSessionAttrMultilink": { "type": "boolean", "description": "This object indicates whether the session is part of a\n multilink PPP bundle, even if there is only one link or\n session in the bundle. If it is multilink PPP, the value\n is true.", "readOnly": true }, "cvpdnSessionAttrModemSlotIndex": { "type": "integer", "description": "The Modem Pool database slot index if it is associated with\n this session. Only a session with device of type\n 'asyncInternalModem' will have a valid value for this\n object; otherwise, it is not instantiated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSessionAttrModemPortIndex": { "type": "integer", "description": "The Modem Pool database port index if it is associated with\n this session. Only a session with a device of type\n 'asyncInternalModem' will have a valid value for this\n object; otherwise, it is not instantiated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSessionAttrDS1SlotIndex": { "type": "integer", "description": "The DS1 database slot index if it is associated with this\n session. Only a session with a device of type\n 'asyncInternalModem' will have a valid value for this\n object; otherwise it is not instantiated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSessionAttrDS1PortIndex": { "type": "integer", "description": "The DS1 database port index if it is associated with this\n session. Only a session with a device of type\n 'asyncInternalModem' will have a valid value for this\n object; otherwise it is not instantiated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSessionAttrDS1ChannelIndex": { "type": "integer", "description": "The DS1 database channel index if it is associated with\n this session. Only a session over a device of type\n 'asyncInternalModem' will have a valid value for this\n object; otherwise it is not instantiated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSessionAttrModemCallStartTime": { "type": "string", "description": "The start time of the current modem call. Only a session\n with a device of type 'asyncInternalModem' will have a\n valid value for this object; otherwise, it is not\n instantiated.", "x-yang-type": "yang:timestamp", "readOnly": true }, "cvpdnSessionAttrModemCallStartIndex": { "type": "integer", "description": "Arbitrary small integer to distinguish modem calls that\n occurred at the same time tick. Only session over device\n 'asyncInternalModem' will have a valid value for this\n object; otherwise, it is not instantiated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSessionAttrVirtualCircuitID": { "type": "integer", "description": "The virtual circuit ID of an active Layer 2 VPN session.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSessionAttrSentPktsDropped": { "type": "integer", "description": "The total number of dropped packets that could not be sent\n into this active session.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSessionAttrRecvPktsDropped": { "type": "integer", "description": "The total number of dropped packets that were received from\n this active session.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnSessionAttrMultilinkBundle": { "type": "string", "description": "This object specifies the name of the multilink bundle to\n which this session belongs. The value of this object is\n only valid when the value of cvpdnSessionAttrMultilink is\n 'true'. If the value of cvpdnSessionAttrMultilink is\n 'false', then the value of this object will be the empty\n string.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cvpdnSessionAttrMultilinkIfIndex": { "type": "string", "description": "This object specifies the ifIndex of the multilink bundle\n to which this session belongs. The value of this object is\n only valid when the value of cvpdnSessionAttrMultilink is\n 'true'. If the value of cvpdnSessionAttrMultilink is\n 'false', then the value of this object will be zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true } } } }, "CISCO-VPDN-MGMT-MIB_cvpdnUserToFailHistInfoEntry": { "type": "array", "description": "An entry in the table, containing failure history\n relevant to an user name.", "items": { "type": "object", "properties": { "cvpdnUnameToFailHistUname": { "type": "string", "description": "The user name for this failure entry.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvpdnUnameToFailHistTunnelId": { "type": "integer", "description": "The Tunnel ID for this failure entry. If it is the\n instigator of the tunnel, the ID is the TS tunnel ID,\n otherwise it is the NAS tunnel ID.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnUnameToFailHistUserId": { "type": "integer", "description": "The user ID of this failure entry.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnUnameToFailHistLocalInitConn": { "type": "boolean", "description": "This object indicates whether the tunnel in which the\n failure occurred was generated locally or not.", "readOnly": true }, "cvpdnUnameToFailHistLocalName": { "type": "string", "description": "The local name of the VPDN tunnel in which the failure\n occurred. It will be the NAS name of the tunnel if the\n system serves as the NAS, or the TS name of the tunnel\n if the system serves as the tunnel server. The local\n name is the configured host name of the system. This\n object can be empty if the failure occurred prior to\n successful tunnel projection, thus no source name will\n be available.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvpdnUnameToFailHistRemoteName": { "type": "string", "description": "The remote name of the VPDN tunnel in which the failure\n occurred. It will be the tunnel server name of the\n tunnel if the system is a NAS, or the NAS name of the\n tunnel if the system serves as the tunnel server. This\n object can be empty if the failure occurred prior to\n successful tunnel projection, thus no source name will\n be available.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvpdnUnameToFailHistSourceIp": { "type": "string", "description": "The source IP address of the tunnel in which the\n failure occurred. This IP address is that of the\n interface at the instigator end of the tunnel.", "format": "inet:ipv4-address", "readOnly": true }, "cvpdnUnameToFailHistDestIp": { "type": "string", "description": "The destination IP address of the tunnel in which the\n failure occurred. This IP address is that of the\n interface at the receiver end of the tunnel.", "format": "inet:ipv4-address", "readOnly": true }, "cvpdnUnameToFailHistCount": { "type": "integer", "description": "This object is incremented when multiple failures has\n been experienced by this user on this tunnel. Seeing a\n delta of >1 is an indication that the current failure\n record is the latest of a series of failures that has\n been recorded.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnUnameToFailHistFailTime": { "type": "string", "description": "This object specifies the time when the failure is\n occurred.", "x-yang-type": "yang:timestamp", "readOnly": true }, "cvpdnUnameToFailHistFailType": { "type": "string", "description": "The type of failure for the current failure record. It\n comes in a form of a an ASCII string which describes\n the type of failure.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvpdnUnameToFailHistFailReason": { "type": "string", "description": "The reason of failure for the current failure record.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cvpdnUnameToFailHistSourceInetType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnUnameToFailHistSourceInetAddr.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cvpdnUnameToFailHistSourceInetAddr": { "type": "string", "description": "The source IP address of the tunnel in which the\n failure occurred. This IP address is that of the\n interface at the instigator end of the tunnel. The\n instigator end is the peer which initiates the tunnel\n estalishment. The type of this address is determined\n by the value of cvpdnUnameToFailHistSourceInetType.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cvpdnUnameToFailHistDestInetType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnUnameToFailHistDestInetAddr.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cvpdnUnameToFailHistDestInetAddr": { "type": "string", "description": "The destination IP address of the tunnel in which the\n failure occurred. This IP address is that of the\n interface at the receiver end of the tunnel. The type \n of this address is determined by the value of \n cvpdnUnameToFailHistDestInetType.", "x-yang-type": "inet-address:InetAddress", "readOnly": true } } } }, "CISCO-VPDN-MGMT-MIB_cvpdnTemplateEntry": { "type": "array", "description": "An entry in the table, containing information about a\n single VPDN template.", "items": { "type": "object", "properties": { "cvpdnTemplateName": { "type": "string", "description": "The name of the VPDN template.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cvpdnTemplateActiveSessions": { "type": "integer", "description": "The total number of active session in all groups\n associated with the template.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } } }, "CISCO-VPDN-MGMT-MIB_cvpdnBundleEntry": { "type": "array", "description": "An entry in this table represents an active multilink PPP\n bundle that belongs to a VPDN tunnel.", "items": { "type": "object", "properties": { "cvpdnBundleName": { "type": "string", "description": "The name of the multilink PPP bundle associated with a VPDN\n tunnel.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cvpdnBundleLinkCount": { "type": "integer", "description": "The total number of active links in a multilink PPP bundle\n associated with a VPDN tunnel.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnBundleEndpointType": { "type": "string", "description": "The multilink PPP bundle discriminator type associated with\n a VPDN tunnel. The value of this object represents the type\n of discriminator used in cvpdnBundleEndpoint.\n \n none: No endpoint discriminator was supplied, the\n default value is being used.\n \n hostname: The router's hostname is being used as\n discriminator.\n \n string: User specified string is being used as\n discriminator.\n \n macAddress: A MAC address as defined by the MacAddress\n textual convention is being used as\n discriminator.\n \n ipV4Address: An IP address as defined by the\n InetAddressIPv4 textual convention is being\n used as discriminator.\n \n ipV6Address: An IP address as defined by the\n InetAddressIPv6 textual convention is being\n used as discriminator.\n \n phone: The PSTN phone number is being used as\n discriminator.\n \n magicNumber: A magic number is being used as\n discriminator.", "readOnly": true }, "cvpdnBundleEndpoint": { "type": "string", "description": "Indicates the discriminator used in this bundle that is\n associated with a VPDN tunnel.", "format": "binary", "readOnly": true }, "cvpdnBundlePeerIpAddrType": { "type": "string", "description": "Indicates the type of address contained in\n cvpdnBundlePeerIpAddr.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cvpdnBundlePeerIpAddr": { "type": "string", "description": "The IP address of the multilink PPP peer in a VPDN tunnel.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cvpdnBundleEndpointClass": { "type": "string", "description": "The multilink PPP bundle discriminator class associated\n with a VPDN tunnel. The value of this object represents the\n type of discriminator used in cvpdnBundleEndpoint.", "x-yang-type": "CISCO-VPDN-MGMT-MIB:EndpointClass", "readOnly": true } } } }, "CISCO-VPDN-MGMT-MIB_cvpdnBundleChildEntry": { "type": "array", "description": "An entry in this table represents a session that belongs to\n a VPDN tunnel and to a multilink PPP bundle.", "items": { "type": "object", "properties": { "cvpdnBundleName": { "type": "string", "description": "cvpdnBundleName", "x-yang-type": "leafref", "readOnly": true }, "cvpdnBundleChildTunnelType": { "type": "string", "description": "The tunnel type. This is the tunnel protocol of an active\n VPDN session that is associated with a multilink PPP\n bundle.", "x-yang-type": "CISCO-VPDN-MGMT-MIB:TunnelType", "readOnly": true }, "cvpdnBundleChildTunnelId": { "type": "integer", "description": "The Tunnel ID of an active VPDN session that is associated\n with a multilink PPP bundle.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cvpdnBundleChildSessionId": { "type": "integer", "description": "The ID of an active VPDN session that is associated with a\n multilink PPP bundle.", "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-VPDN-MGMT-MIB", "description": "MIB operations for CISCO-VPDN-MGMT-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }