{ "openapi": "3.0.0", "info": { "title": "CISCO-AAA-SESSION-MIB MIB API", "version": "1.0.0", "description": "This MIB module provides data for accounting sessions\n based on Authentication, Authorization, Accounting\n (AAA) protocols.\n \n \n References:\n RFC 2139 RADIUS Accounting\n The TACACS+ Protocol Version 1.78, Internet Draft\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-AAA-SESSION-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/CISCO-AAA-SESSION-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "CISCO-AAA-SESSION-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-AAA-SESSION-MIB:casnActive": { "get": { "summary": "Get casnActive data", "description": "Retrieve casnActive operational data from MIB", "tags": [ "CISCO-AAA-SESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "Number of entries currently in casnActiveTable", "properties": { "casnActiveTableEntries": { "type": "integer", "description": "Number of entries currently in casnActiveTable", "minimum": 0, "maximum": 4294967295 }, "casnActiveTableHighWaterMark": { "type": "integer", "description": "Maximum number of entries present in casnActiveTable\n since last system re-initialization.\n \n This corresponds to the maximum value reported by\n casnActiveTableEntries.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-AAA-SESSION-MIB:casnActive": { "casnActiveTableEntries": 0, "casnActiveTableHighWaterMark": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-casnActive", "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": "/casnActive", "x-restconf-kind": "container" }, "/data/CISCO-AAA-SESSION-MIB:casnGeneral": { "get": { "summary": "Get casnGeneral data", "description": "Retrieve casnGeneral operational data from MIB", "tags": [ "CISCO-AAA-SESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "Total number of sessions since last system\n re-initialization.\n \n This value includes all sessions currently in the\n casnActiveTable and all previous sessions whether\n terminated via casnDisconnect or via other\n mechanisms.", "properties": { "casnTotalSessions": { "type": "integer", "description": "Total number of sessions since last system\n re-initialization.\n \n This value includes all sessions currently in the\n casnActiveTable and all previous sessions whether\n terminated via casnDisconnect or via other\n mechanisms.", "minimum": 0, "maximum": 4294967295 }, "casnDisconnectedSessions": { "type": "integer", "description": "Total number of sessions which have been disconnected using\n casnDisconnect since last system re-initialization.\n \n This value includes any sessions still in the\n casnActiveTable with a casnDisconnect value of true(1) and\n all previous sessions which terminated as a result of\n setting casnDisconnect.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-AAA-SESSION-MIB:casnGeneral": { "casnTotalSessions": 0, "casnDisconnectedSessions": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-casnGeneral", "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": "/casnGeneral", "x-restconf-kind": "container" }, "/data/CISCO-AAA-SESSION-MIB:casnActiveTable": { "get": { "summary": "Get casnActiveTable data", "description": "Retrieve casnActiveTable operational data from MIB", "tags": [ "CISCO-AAA-SESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table contains entries for active AAA accounting\n sessions in the system.", "properties": { "casnActiveEntry": { "type": "array", "description": "The information regarding a single accounting session.\n \n Entries are created when a new accounting session\n is begun.\n \n Entries are removed when the accounting session\n is ended.\n \n Initiating termination of a session with the object\n casnDisconnect will cause removal of the entry when\n the session completes termination.", "items": { "type": "object", "properties": { "casnSessionId": { "type": "string", "description": "This is the session identification used by the\n accounting protocol.\n \n This value is unique to a session within the system,\n even if multiple accounting protocols are in use.\n \n The value of this object corresponds to these\n accounting protocol attributes.\n RADIUS: attribute 44, Acct-Session-Id\n TACACS+: attribute 'task_id'", "x-yang-type": "CISCO-AAA-SESSION-MIB:CasnSessionId" }, "casnUserId": { "type": "string", "description": "The User login ID or zero length string if unavailable.\n \n The value of this object corresponds to these\n accounting protocol attributes.\n RADIUS: attribute 1, User-Name\n TACACS+: attribute 'user'", "x-yang-type": "snmpv2-tc:DisplayString" }, "casnIpAddr": { "type": "string", "description": "The IP address of the session or 0.0.0.0 if not\n applicable or unavailable.\n \n RADIUS: attribute 8, Framed-IP-Address\n TACACS+: attribute 'addr'", "format": "inet:ipv4-address" }, "casnIdleTime": { "type": "integer", "description": "The elapsed time that this session has been idle.\n \n This is the time since the last user-level data has been\n received or transmitted. Protocol level handshaking\n associated with the call is considered to be idle for\n this object.", "minimum": 0, "maximum": 4294967295 }, "casnDisconnect": { "type": "boolean", "description": "This object is used to terminate this session.\n \n Setting the value to true(1) will initiate termination\n of this session.\n \n The entry will be removed once the session has completed\n termination.\n \n Once this object has been set to true(1), the session\n termination process can not be cancelled by setting the\n value false(2)." }, "casnCallTrackerId": { "type": "string", "description": "The value of this object is the entry index in the\n CISCO-CALL-TRACKER-MIB cctActiveTable of the call\n corresponding to this accounting session.\n \n Using the value of this object to query the\n cctActiveTable will provide more detailed data regarding\n the session represented by this casnActiveEntry.", "x-yang-type": "CISCO-AAA-SESSION-MIB:CctCallId" }, "casnNasPort": { "type": "string", "description": "The value of this object identifies a particular\n conceptual row associated with the session identified by\n casnSessionId. The conceptual row that this object points\n to represents a port that is used to transport a session.\n \n If the port transporting the session cannot be determined,\n the value of this object will be zeroDotZero.\n \n For example, suppose a session is established using an ATM\n PVC. If the ifIndex of the ATM interface is 7, and the \n VPI/VCI values of the PVC are 1, 100 respectively, then\n the value of this object might be as follows:\n \n casnNasPort.15 = atmVclAdminStatus.7.1.100\n ^ ^ ^ ^\n | | | |\n casnSessionId --+ | | |\n ifIndex -------------------------+ | |\n atmVclVpi ---------------------------+ |\n atmVclVci ------------------------------+\n \n where atmVclAdminStatus is the first accessible object\n of the atmVclTable of the ATM-MIB.", "x-yang-type": "snmpv2-tc:RowPointer" }, "casnVaiIfIndex": { "type": "string", "description": "The ifIndex of the Virtual Access Interface (VAI)\n that is associated with the PPP session.\n \n This interface may not be represented in the IF-MIB in\n which case the value of this object will be zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero" } } } } } }, "example": { "CISCO-AAA-SESSION-MIB:casnActiveTable": { "casnActiveEntry": [ { "casnSessionId": "example-string", "casnUserId": "example-string", "casnIpAddr": "192.168.1.1", "casnIdleTime": 0, "casnDisconnect": true, "casnCallTrackerId": "example-string", "casnNasPort": "example-string", "casnVaiIfIndex": "1" }, { "casnSessionId": "example-string", "casnUserId": "example-string", "casnIpAddr": "192.168.1.1", "casnIdleTime": 0, "casnDisconnect": true, "casnCallTrackerId": "example-string", "casnNasPort": "example-string", "casnVaiIfIndex": "2" }, { "casnSessionId": "example-string", "casnUserId": "example-string", "casnIpAddr": "192.168.1.1", "casnIdleTime": 0, "casnDisconnect": true, "casnCallTrackerId": "example-string", "casnNasPort": "example-string", "casnVaiIfIndex": "3" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-casnActiveTable", "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": "/casnActiveTable", "x-restconf-kind": "container" }, "/data/CISCO-AAA-SESSION-MIB:casnActiveTable/casnActiveEntry": { "get": { "summary": "Get casnActiveEntry list", "description": "Retrieve list of casnActiveEntry entries from MIB", "tags": [ "CISCO-AAA-SESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "The information regarding a single accounting session.\n \n Entries are created when a new accounting session\n is begun.\n \n Entries are removed when the accounting session\n is ended.\n \n Initiating termination of a session with the object\n casnDisconnect will cause removal of the entry when\n the session completes termination.", "items": { "type": "object", "properties": { "casnSessionId": { "type": "string", "description": "This is the session identification used by the\n accounting protocol.\n \n This value is unique to a session within the system,\n even if multiple accounting protocols are in use.\n \n The value of this object corresponds to these\n accounting protocol attributes.\n RADIUS: attribute 44, Acct-Session-Id\n TACACS+: attribute 'task_id'", "x-yang-type": "CISCO-AAA-SESSION-MIB:CasnSessionId" }, "casnUserId": { "type": "string", "description": "The User login ID or zero length string if unavailable.\n \n The value of this object corresponds to these\n accounting protocol attributes.\n RADIUS: attribute 1, User-Name\n TACACS+: attribute 'user'", "x-yang-type": "snmpv2-tc:DisplayString" }, "casnIpAddr": { "type": "string", "description": "The IP address of the session or 0.0.0.0 if not\n applicable or unavailable.\n \n RADIUS: attribute 8, Framed-IP-Address\n TACACS+: attribute 'addr'", "format": "inet:ipv4-address" }, "casnIdleTime": { "type": "integer", "description": "The elapsed time that this session has been idle.\n \n This is the time since the last user-level data has been\n received or transmitted. Protocol level handshaking\n associated with the call is considered to be idle for\n this object.", "minimum": 0, "maximum": 4294967295 }, "casnDisconnect": { "type": "boolean", "description": "This object is used to terminate this session.\n \n Setting the value to true(1) will initiate termination\n of this session.\n \n The entry will be removed once the session has completed\n termination.\n \n Once this object has been set to true(1), the session\n termination process can not be cancelled by setting the\n value false(2)." }, "casnCallTrackerId": { "type": "string", "description": "The value of this object is the entry index in the\n CISCO-CALL-TRACKER-MIB cctActiveTable of the call\n corresponding to this accounting session.\n \n Using the value of this object to query the\n cctActiveTable will provide more detailed data regarding\n the session represented by this casnActiveEntry.", "x-yang-type": "CISCO-AAA-SESSION-MIB:CctCallId" }, "casnNasPort": { "type": "string", "description": "The value of this object identifies a particular\n conceptual row associated with the session identified by\n casnSessionId. The conceptual row that this object points\n to represents a port that is used to transport a session.\n \n If the port transporting the session cannot be determined,\n the value of this object will be zeroDotZero.\n \n For example, suppose a session is established using an ATM\n PVC. If the ifIndex of the ATM interface is 7, and the \n VPI/VCI values of the PVC are 1, 100 respectively, then\n the value of this object might be as follows:\n \n casnNasPort.15 = atmVclAdminStatus.7.1.100\n ^ ^ ^ ^\n | | | |\n casnSessionId --+ | | |\n ifIndex -------------------------+ | |\n atmVclVpi ---------------------------+ |\n atmVclVci ------------------------------+\n \n where atmVclAdminStatus is the first accessible object\n of the atmVclTable of the ATM-MIB.", "x-yang-type": "snmpv2-tc:RowPointer" }, "casnVaiIfIndex": { "type": "string", "description": "The ifIndex of the Virtual Access Interface (VAI)\n that is associated with the PPP session.\n \n This interface may not be represented in the IF-MIB in\n which case the value of this object will be zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero" } } } }, "example": { "CISCO-AAA-SESSION-MIB:casnActiveEntry": [ { "casnSessionId": "example-string", "casnUserId": "example-string", "casnIpAddr": "192.168.1.1", "casnIdleTime": 0, "casnDisconnect": true, "casnCallTrackerId": "example-string", "casnNasPort": "example-string", "casnVaiIfIndex": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-casnActiveEntry", "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": "/casnActiveTable/casnActiveEntry", "x-restconf-kind": "container" }, "/data/CISCO-AAA-SESSION-MIB:casnActiveTable/casnActiveEntry={casnSessionId}": { "get": { "summary": "Get casnActiveEntry entry", "description": "Retrieve specific casnActiveEntry entry by key from MIB", "tags": [ "CISCO-AAA-SESSION-MIB" ], "parameters": [ { "name": "casnSessionId", "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": { "casnSessionId": { "type": "string", "description": "This is the session identification used by the\n accounting protocol.\n \n This value is unique to a session within the system,\n even if multiple accounting protocols are in use.\n \n The value of this object corresponds to these\n accounting protocol attributes.\n RADIUS: attribute 44, Acct-Session-Id\n TACACS+: attribute 'task_id'", "x-yang-type": "CISCO-AAA-SESSION-MIB:CasnSessionId" }, "casnUserId": { "type": "string", "description": "The User login ID or zero length string if unavailable.\n \n The value of this object corresponds to these\n accounting protocol attributes.\n RADIUS: attribute 1, User-Name\n TACACS+: attribute 'user'", "x-yang-type": "snmpv2-tc:DisplayString" }, "casnIpAddr": { "type": "string", "description": "The IP address of the session or 0.0.0.0 if not\n applicable or unavailable.\n \n RADIUS: attribute 8, Framed-IP-Address\n TACACS+: attribute 'addr'", "format": "inet:ipv4-address" }, "casnIdleTime": { "type": "integer", "description": "The elapsed time that this session has been idle.\n \n This is the time since the last user-level data has been\n received or transmitted. Protocol level handshaking\n associated with the call is considered to be idle for\n this object.", "minimum": 0, "maximum": 4294967295 }, "casnDisconnect": { "type": "boolean", "description": "This object is used to terminate this session.\n \n Setting the value to true(1) will initiate termination\n of this session.\n \n The entry will be removed once the session has completed\n termination.\n \n Once this object has been set to true(1), the session\n termination process can not be cancelled by setting the\n value false(2)." }, "casnCallTrackerId": { "type": "string", "description": "The value of this object is the entry index in the\n CISCO-CALL-TRACKER-MIB cctActiveTable of the call\n corresponding to this accounting session.\n \n Using the value of this object to query the\n cctActiveTable will provide more detailed data regarding\n the session represented by this casnActiveEntry.", "x-yang-type": "CISCO-AAA-SESSION-MIB:CctCallId" }, "casnNasPort": { "type": "string", "description": "The value of this object identifies a particular\n conceptual row associated with the session identified by\n casnSessionId. The conceptual row that this object points\n to represents a port that is used to transport a session.\n \n If the port transporting the session cannot be determined,\n the value of this object will be zeroDotZero.\n \n For example, suppose a session is established using an ATM\n PVC. If the ifIndex of the ATM interface is 7, and the \n VPI/VCI values of the PVC are 1, 100 respectively, then\n the value of this object might be as follows:\n \n casnNasPort.15 = atmVclAdminStatus.7.1.100\n ^ ^ ^ ^\n | | | |\n casnSessionId --+ | | |\n ifIndex -------------------------+ | |\n atmVclVpi ---------------------------+ |\n atmVclVci ------------------------------+\n \n where atmVclAdminStatus is the first accessible object\n of the atmVclTable of the ATM-MIB.", "x-yang-type": "snmpv2-tc:RowPointer" }, "casnVaiIfIndex": { "type": "string", "description": "The ifIndex of the Virtual Access Interface (VAI)\n that is associated with the PPP session.\n \n This interface may not be represented in the IF-MIB in\n which case the value of this object will be zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero" } } }, "example": { "CISCO-AAA-SESSION-MIB:casnActiveEntry": { "casnSessionId": "example-string", "casnUserId": "example-string", "casnIpAddr": "192.168.1.1", "casnIdleTime": 0, "casnDisconnect": true, "casnCallTrackerId": "example-string", "casnNasPort": "example-string", "casnVaiIfIndex": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-casnActiveEntry-2" }, "x-yang-path": "/casnActiveTable/casnActiveEntry={casnSessionId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "casnSessionId" ] }, "/data/CISCO-AAA-SESSION-MIB:casnActiveEntry": { "get": { "summary": "Get casnActiveEntry list", "description": "Retrieve list of casnActiveEntry entries from MIB", "tags": [ "CISCO-AAA-SESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "The information regarding a single accounting session.\n \n Entries are created when a new accounting session\n is begun.\n \n Entries are removed when the accounting session\n is ended.\n \n Initiating termination of a session with the object\n casnDisconnect will cause removal of the entry when\n the session completes termination.", "items": { "type": "object", "properties": { "casnSessionId": { "type": "string", "description": "This is the session identification used by the\n accounting protocol.\n \n This value is unique to a session within the system,\n even if multiple accounting protocols are in use.\n \n The value of this object corresponds to these\n accounting protocol attributes.\n RADIUS: attribute 44, Acct-Session-Id\n TACACS+: attribute 'task_id'", "x-yang-type": "CISCO-AAA-SESSION-MIB:CasnSessionId" }, "casnUserId": { "type": "string", "description": "The User login ID or zero length string if unavailable.\n \n The value of this object corresponds to these\n accounting protocol attributes.\n RADIUS: attribute 1, User-Name\n TACACS+: attribute 'user'", "x-yang-type": "snmpv2-tc:DisplayString" }, "casnIpAddr": { "type": "string", "description": "The IP address of the session or 0.0.0.0 if not\n applicable or unavailable.\n \n RADIUS: attribute 8, Framed-IP-Address\n TACACS+: attribute 'addr'", "format": "inet:ipv4-address" }, "casnIdleTime": { "type": "integer", "description": "The elapsed time that this session has been idle.\n \n This is the time since the last user-level data has been\n received or transmitted. Protocol level handshaking\n associated with the call is considered to be idle for\n this object.", "minimum": 0, "maximum": 4294967295 }, "casnDisconnect": { "type": "boolean", "description": "This object is used to terminate this session.\n \n Setting the value to true(1) will initiate termination\n of this session.\n \n The entry will be removed once the session has completed\n termination.\n \n Once this object has been set to true(1), the session\n termination process can not be cancelled by setting the\n value false(2)." }, "casnCallTrackerId": { "type": "string", "description": "The value of this object is the entry index in the\n CISCO-CALL-TRACKER-MIB cctActiveTable of the call\n corresponding to this accounting session.\n \n Using the value of this object to query the\n cctActiveTable will provide more detailed data regarding\n the session represented by this casnActiveEntry.", "x-yang-type": "CISCO-AAA-SESSION-MIB:CctCallId" }, "casnNasPort": { "type": "string", "description": "The value of this object identifies a particular\n conceptual row associated with the session identified by\n casnSessionId. The conceptual row that this object points\n to represents a port that is used to transport a session.\n \n If the port transporting the session cannot be determined,\n the value of this object will be zeroDotZero.\n \n For example, suppose a session is established using an ATM\n PVC. If the ifIndex of the ATM interface is 7, and the \n VPI/VCI values of the PVC are 1, 100 respectively, then\n the value of this object might be as follows:\n \n casnNasPort.15 = atmVclAdminStatus.7.1.100\n ^ ^ ^ ^\n | | | |\n casnSessionId --+ | | |\n ifIndex -------------------------+ | |\n atmVclVpi ---------------------------+ |\n atmVclVci ------------------------------+\n \n where atmVclAdminStatus is the first accessible object\n of the atmVclTable of the ATM-MIB.", "x-yang-type": "snmpv2-tc:RowPointer" }, "casnVaiIfIndex": { "type": "string", "description": "The ifIndex of the Virtual Access Interface (VAI)\n that is associated with the PPP session.\n \n This interface may not be represented in the IF-MIB in\n which case the value of this object will be zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero" } } } }, "example": { "CISCO-AAA-SESSION-MIB:casnActiveEntry": [ { "casnSessionId": "example-string", "casnUserId": "example-string", "casnIpAddr": "192.168.1.1", "casnIdleTime": 0, "casnDisconnect": true, "casnCallTrackerId": "example-string", "casnNasPort": "example-string", "casnVaiIfIndex": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-casnActiveEntry-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": "/casnActiveEntry", "x-restconf-kind": "container" }, "/data/CISCO-AAA-SESSION-MIB:casnActiveEntry={casnSessionId}": { "get": { "summary": "Get casnActiveEntry entry", "description": "Retrieve specific casnActiveEntry entry by key from MIB", "tags": [ "CISCO-AAA-SESSION-MIB" ], "parameters": [ { "name": "casnSessionId", "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": { "casnSessionId": { "type": "string", "description": "This is the session identification used by the\n accounting protocol.\n \n This value is unique to a session within the system,\n even if multiple accounting protocols are in use.\n \n The value of this object corresponds to these\n accounting protocol attributes.\n RADIUS: attribute 44, Acct-Session-Id\n TACACS+: attribute 'task_id'", "x-yang-type": "CISCO-AAA-SESSION-MIB:CasnSessionId" }, "casnUserId": { "type": "string", "description": "The User login ID or zero length string if unavailable.\n \n The value of this object corresponds to these\n accounting protocol attributes.\n RADIUS: attribute 1, User-Name\n TACACS+: attribute 'user'", "x-yang-type": "snmpv2-tc:DisplayString" }, "casnIpAddr": { "type": "string", "description": "The IP address of the session or 0.0.0.0 if not\n applicable or unavailable.\n \n RADIUS: attribute 8, Framed-IP-Address\n TACACS+: attribute 'addr'", "format": "inet:ipv4-address" }, "casnIdleTime": { "type": "integer", "description": "The elapsed time that this session has been idle.\n \n This is the time since the last user-level data has been\n received or transmitted. Protocol level handshaking\n associated with the call is considered to be idle for\n this object.", "minimum": 0, "maximum": 4294967295 }, "casnDisconnect": { "type": "boolean", "description": "This object is used to terminate this session.\n \n Setting the value to true(1) will initiate termination\n of this session.\n \n The entry will be removed once the session has completed\n termination.\n \n Once this object has been set to true(1), the session\n termination process can not be cancelled by setting the\n value false(2)." }, "casnCallTrackerId": { "type": "string", "description": "The value of this object is the entry index in the\n CISCO-CALL-TRACKER-MIB cctActiveTable of the call\n corresponding to this accounting session.\n \n Using the value of this object to query the\n cctActiveTable will provide more detailed data regarding\n the session represented by this casnActiveEntry.", "x-yang-type": "CISCO-AAA-SESSION-MIB:CctCallId" }, "casnNasPort": { "type": "string", "description": "The value of this object identifies a particular\n conceptual row associated with the session identified by\n casnSessionId. The conceptual row that this object points\n to represents a port that is used to transport a session.\n \n If the port transporting the session cannot be determined,\n the value of this object will be zeroDotZero.\n \n For example, suppose a session is established using an ATM\n PVC. If the ifIndex of the ATM interface is 7, and the \n VPI/VCI values of the PVC are 1, 100 respectively, then\n the value of this object might be as follows:\n \n casnNasPort.15 = atmVclAdminStatus.7.1.100\n ^ ^ ^ ^\n | | | |\n casnSessionId --+ | | |\n ifIndex -------------------------+ | |\n atmVclVpi ---------------------------+ |\n atmVclVci ------------------------------+\n \n where atmVclAdminStatus is the first accessible object\n of the atmVclTable of the ATM-MIB.", "x-yang-type": "snmpv2-tc:RowPointer" }, "casnVaiIfIndex": { "type": "string", "description": "The ifIndex of the Virtual Access Interface (VAI)\n that is associated with the PPP session.\n \n This interface may not be represented in the IF-MIB in\n which case the value of this object will be zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero" } } }, "example": { "CISCO-AAA-SESSION-MIB:casnActiveEntry": { "casnSessionId": "example-string", "casnUserId": "example-string", "casnIpAddr": "192.168.1.1", "casnIdleTime": 0, "casnDisconnect": true, "casnCallTrackerId": "example-string", "casnNasPort": "example-string", "casnVaiIfIndex": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-casnActiveEntry-4" }, "x-yang-path": "/casnActiveEntry={casnSessionId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "casnSessionId" ] } }, "components": { "schemas": { "CISCO-AAA-SESSION-MIB_CISCO-AAA-SESSION-MIB": { "type": "object", "description": "Number of entries currently in casnActiveTable", "properties": { "casnActiveEntry": { "type": "array", "description": "The information regarding a single accounting session.\n \n Entries are created when a new accounting session\n is begun.\n \n Entries are removed when the accounting session\n is ended.\n \n Initiating termination of a session with the object\n casnDisconnect will cause removal of the entry when\n the session completes termination.", "items": { "type": "object", "properties": { "casnSessionId": { "type": "string", "description": "This is the session identification used by the\n accounting protocol.\n \n This value is unique to a session within the system,\n even if multiple accounting protocols are in use.\n \n The value of this object corresponds to these\n accounting protocol attributes.\n RADIUS: attribute 44, Acct-Session-Id\n TACACS+: attribute 'task_id'", "x-yang-type": "CISCO-AAA-SESSION-MIB:CasnSessionId", "readOnly": true }, "casnUserId": { "type": "string", "description": "The User login ID or zero length string if unavailable.\n \n The value of this object corresponds to these\n accounting protocol attributes.\n RADIUS: attribute 1, User-Name\n TACACS+: attribute 'user'", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "casnIpAddr": { "type": "string", "description": "The IP address of the session or 0.0.0.0 if not\n applicable or unavailable.\n \n RADIUS: attribute 8, Framed-IP-Address\n TACACS+: attribute 'addr'", "format": "inet:ipv4-address", "readOnly": true }, "casnIdleTime": { "type": "integer", "description": "The elapsed time that this session has been idle.\n \n This is the time since the last user-level data has been\n received or transmitted. Protocol level handshaking\n associated with the call is considered to be idle for\n this object.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "casnDisconnect": { "type": "boolean", "description": "This object is used to terminate this session.\n \n Setting the value to true(1) will initiate termination\n of this session.\n \n The entry will be removed once the session has completed\n termination.\n \n Once this object has been set to true(1), the session\n termination process can not be cancelled by setting the\n value false(2).", "readOnly": true }, "casnCallTrackerId": { "type": "string", "description": "The value of this object is the entry index in the\n CISCO-CALL-TRACKER-MIB cctActiveTable of the call\n corresponding to this accounting session.\n \n Using the value of this object to query the\n cctActiveTable will provide more detailed data regarding\n the session represented by this casnActiveEntry.", "x-yang-type": "CISCO-AAA-SESSION-MIB:CctCallId", "readOnly": true }, "casnNasPort": { "type": "string", "description": "The value of this object identifies a particular\n conceptual row associated with the session identified by\n casnSessionId. The conceptual row that this object points\n to represents a port that is used to transport a session.\n \n If the port transporting the session cannot be determined,\n the value of this object will be zeroDotZero.\n \n For example, suppose a session is established using an ATM\n PVC. If the ifIndex of the ATM interface is 7, and the \n VPI/VCI values of the PVC are 1, 100 respectively, then\n the value of this object might be as follows:\n \n casnNasPort.15 = atmVclAdminStatus.7.1.100\n ^ ^ ^ ^\n | | | |\n casnSessionId --+ | | |\n ifIndex -------------------------+ | |\n atmVclVpi ---------------------------+ |\n atmVclVci ------------------------------+\n \n where atmVclAdminStatus is the first accessible object\n of the atmVclTable of the ATM-MIB.", "x-yang-type": "snmpv2-tc:RowPointer", "readOnly": true }, "casnVaiIfIndex": { "type": "string", "description": "The ifIndex of the Virtual Access Interface (VAI)\n that is associated with the PPP session.\n \n This interface may not be represented in the IF-MIB in\n which case the value of this object will be zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true } } }, "readOnly": true }, "casnActive": { "type": "object", "description": "Number of entries currently in casnActiveTable", "properties": { "casnActiveTableEntries": { "type": "integer", "description": "Number of entries currently in casnActiveTable", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "casnActiveTableHighWaterMark": { "type": "integer", "description": "Maximum number of entries present in casnActiveTable\n since last system re-initialization.\n \n This corresponds to the maximum value reported by\n casnActiveTableEntries.", "minimum": 0, "maximum": 4294967295, "readOnly": true } }, "readOnly": true }, "casnGeneral": { "type": "object", "description": "Total number of sessions since last system\n re-initialization.\n \n This value includes all sessions currently in the\n casnActiveTable and all previous sessions whether\n terminated via casnDisconnect or via other\n mechanisms.", "properties": { "casnTotalSessions": { "type": "integer", "description": "Total number of sessions since last system\n re-initialization.\n \n This value includes all sessions currently in the\n casnActiveTable and all previous sessions whether\n terminated via casnDisconnect or via other\n mechanisms.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "casnDisconnectedSessions": { "type": "integer", "description": "Total number of sessions which have been disconnected using\n casnDisconnect since last system re-initialization.\n \n This value includes any sessions still in the\n casnActiveTable with a casnDisconnect value of true(1) and\n all previous sessions which terminated as a result of\n setting casnDisconnect.", "minimum": 0, "maximum": 4294967295, "readOnly": true } }, "readOnly": true }, "casnActiveTable": { "type": "object", "description": "This table contains entries for active AAA accounting\n sessions in the system.", "properties": { "casnActiveEntry": { "type": "array", "description": "The information regarding a single accounting session.\n \n Entries are created when a new accounting session\n is begun.\n \n Entries are removed when the accounting session\n is ended.\n \n Initiating termination of a session with the object\n casnDisconnect will cause removal of the entry when\n the session completes termination.", "items": { "type": "object", "properties": { "casnSessionId": { "type": "string", "description": "This is the session identification used by the\n accounting protocol.\n \n This value is unique to a session within the system,\n even if multiple accounting protocols are in use.\n \n The value of this object corresponds to these\n accounting protocol attributes.\n RADIUS: attribute 44, Acct-Session-Id\n TACACS+: attribute 'task_id'", "x-yang-type": "CISCO-AAA-SESSION-MIB:CasnSessionId", "readOnly": true }, "casnUserId": { "type": "string", "description": "The User login ID or zero length string if unavailable.\n \n The value of this object corresponds to these\n accounting protocol attributes.\n RADIUS: attribute 1, User-Name\n TACACS+: attribute 'user'", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "casnIpAddr": { "type": "string", "description": "The IP address of the session or 0.0.0.0 if not\n applicable or unavailable.\n \n RADIUS: attribute 8, Framed-IP-Address\n TACACS+: attribute 'addr'", "format": "inet:ipv4-address", "readOnly": true }, "casnIdleTime": { "type": "integer", "description": "The elapsed time that this session has been idle.\n \n This is the time since the last user-level data has been\n received or transmitted. Protocol level handshaking\n associated with the call is considered to be idle for\n this object.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "casnDisconnect": { "type": "boolean", "description": "This object is used to terminate this session.\n \n Setting the value to true(1) will initiate termination\n of this session.\n \n The entry will be removed once the session has completed\n termination.\n \n Once this object has been set to true(1), the session\n termination process can not be cancelled by setting the\n value false(2).", "readOnly": true }, "casnCallTrackerId": { "type": "string", "description": "The value of this object is the entry index in the\n CISCO-CALL-TRACKER-MIB cctActiveTable of the call\n corresponding to this accounting session.\n \n Using the value of this object to query the\n cctActiveTable will provide more detailed data regarding\n the session represented by this casnActiveEntry.", "x-yang-type": "CISCO-AAA-SESSION-MIB:CctCallId", "readOnly": true }, "casnNasPort": { "type": "string", "description": "The value of this object identifies a particular\n conceptual row associated with the session identified by\n casnSessionId. The conceptual row that this object points\n to represents a port that is used to transport a session.\n \n If the port transporting the session cannot be determined,\n the value of this object will be zeroDotZero.\n \n For example, suppose a session is established using an ATM\n PVC. If the ifIndex of the ATM interface is 7, and the \n VPI/VCI values of the PVC are 1, 100 respectively, then\n the value of this object might be as follows:\n \n casnNasPort.15 = atmVclAdminStatus.7.1.100\n ^ ^ ^ ^\n | | | |\n casnSessionId --+ | | |\n ifIndex -------------------------+ | |\n atmVclVpi ---------------------------+ |\n atmVclVci ------------------------------+\n \n where atmVclAdminStatus is the first accessible object\n of the atmVclTable of the ATM-MIB.", "x-yang-type": "snmpv2-tc:RowPointer", "readOnly": true }, "casnVaiIfIndex": { "type": "string", "description": "The ifIndex of the Virtual Access Interface (VAI)\n that is associated with the PPP session.\n \n This interface may not be represented in the IF-MIB in\n which case the value of this object will be zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true } } }, "readOnly": true } }, "readOnly": true } } }, "CISCO-AAA-SESSION-MIB_casnActiveEntry": { "type": "array", "description": "The information regarding a single accounting session.\n \n Entries are created when a new accounting session\n is begun.\n \n Entries are removed when the accounting session\n is ended.\n \n Initiating termination of a session with the object\n casnDisconnect will cause removal of the entry when\n the session completes termination.", "items": { "type": "object", "properties": { "casnSessionId": { "type": "string", "description": "This is the session identification used by the\n accounting protocol.\n \n This value is unique to a session within the system,\n even if multiple accounting protocols are in use.\n \n The value of this object corresponds to these\n accounting protocol attributes.\n RADIUS: attribute 44, Acct-Session-Id\n TACACS+: attribute 'task_id'", "x-yang-type": "CISCO-AAA-SESSION-MIB:CasnSessionId", "readOnly": true }, "casnUserId": { "type": "string", "description": "The User login ID or zero length string if unavailable.\n \n The value of this object corresponds to these\n accounting protocol attributes.\n RADIUS: attribute 1, User-Name\n TACACS+: attribute 'user'", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "casnIpAddr": { "type": "string", "description": "The IP address of the session or 0.0.0.0 if not\n applicable or unavailable.\n \n RADIUS: attribute 8, Framed-IP-Address\n TACACS+: attribute 'addr'", "format": "inet:ipv4-address", "readOnly": true }, "casnIdleTime": { "type": "integer", "description": "The elapsed time that this session has been idle.\n \n This is the time since the last user-level data has been\n received or transmitted. Protocol level handshaking\n associated with the call is considered to be idle for\n this object.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "casnDisconnect": { "type": "boolean", "description": "This object is used to terminate this session.\n \n Setting the value to true(1) will initiate termination\n of this session.\n \n The entry will be removed once the session has completed\n termination.\n \n Once this object has been set to true(1), the session\n termination process can not be cancelled by setting the\n value false(2).", "readOnly": true }, "casnCallTrackerId": { "type": "string", "description": "The value of this object is the entry index in the\n CISCO-CALL-TRACKER-MIB cctActiveTable of the call\n corresponding to this accounting session.\n \n Using the value of this object to query the\n cctActiveTable will provide more detailed data regarding\n the session represented by this casnActiveEntry.", "x-yang-type": "CISCO-AAA-SESSION-MIB:CctCallId", "readOnly": true }, "casnNasPort": { "type": "string", "description": "The value of this object identifies a particular\n conceptual row associated with the session identified by\n casnSessionId. The conceptual row that this object points\n to represents a port that is used to transport a session.\n \n If the port transporting the session cannot be determined,\n the value of this object will be zeroDotZero.\n \n For example, suppose a session is established using an ATM\n PVC. If the ifIndex of the ATM interface is 7, and the \n VPI/VCI values of the PVC are 1, 100 respectively, then\n the value of this object might be as follows:\n \n casnNasPort.15 = atmVclAdminStatus.7.1.100\n ^ ^ ^ ^\n | | | |\n casnSessionId --+ | | |\n ifIndex -------------------------+ | |\n atmVclVpi ---------------------------+ |\n atmVclVci ------------------------------+\n \n where atmVclAdminStatus is the first accessible object\n of the atmVclTable of the ATM-MIB.", "x-yang-type": "snmpv2-tc:RowPointer", "readOnly": true }, "casnVaiIfIndex": { "type": "string", "description": "The ifIndex of the Virtual Access Interface (VAI)\n that is associated with the PPP session.\n \n This interface may not be represented in the IF-MIB in\n which case the value of this object will be zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero", "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-AAA-SESSION-MIB", "description": "MIB operations for CISCO-AAA-SESSION-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }