{ "openapi": "3.0.0", "info": { "title": "CISCO-SUBSCRIBER-SESSION-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-SUBSCRIBER-SESSION-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/CISCO-SUBSCRIBER-SESSION-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "CISCO-SUBSCRIBER-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-SUBSCRIBER-SESSION-MIB:csubJob": { "get": { "summary": "Get csubJob data", "description": "Retrieve csubJob operational data from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This object specifies whether the system generates a\n csubJobFinishedNotify notification when the system finishes\n processing a subscriber session job.", "properties": { "csubJobFinishedNotifyEnable": { "type": "boolean", "description": "This object specifies whether the system generates a\n csubJobFinishedNotify notification when the system finishes\n processing a subscriber session job." }, "csubJobIndexedAttributes": { "type": "string", "description": "This object indicates which subscriber session identities the\n system maintains as searchable keys. This value serves the\n EMS/NMS in configuring a subscriber session query, as at least\n one match criteria must be an 'indexed attribute'.", "x-yang-type": "cisco-subscriber-identity:SubSessionIdentities" }, "csubJobIdNext": { "type": "string", "description": "This object indicates the next available identifier for the\n creation of a new row in the csubJobTable. If no available\n identifier exists, then this object has the value '0'.", "x-yang-type": "CISCO-SUBSCRIBER-SESSION-MIB:SubscriberJobIdentifierOrZero" }, "csubJobMaxNumber": { "type": "integer", "description": "This object indicates the maximum number of outstanding\n subscriber session jobs the system can support. If the\n csubJobTable contains a number of rows (i.e., the value of\n csubJobCount) equal to this value, then any attempt to create a\n new row will result in a response with an error-status of\n 'resourceUnavailable'.", "minimum": 0, "maximum": 4294967295 }, "csubJobMaxLife": { "type": "integer", "description": "This object specifies the maximum life a subscriber session\n report corresponding to a subscriber session job having a\n csubJobType of 'query'. The system tracks the time elapsed\n after it finishes processing a query. When the time elapsed\n reaches the value specified by this column, the system\n automatically destroys the report. A value of '0' disables the\n automatic destruction of reports.", "minimum": 0, "maximum": 4294967295 }, "csubJobCount": { "type": "integer", "description": "This object indicates the number of subscriber session jobs\n currently maintained by the csubJobTable.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubJob": { "csubJobFinishedNotifyEnable": true, "csubJobIndexedAttributes": "example-string", "csubJobIdNext": "example-string", "csubJobMaxNumber": 0, "csubJobMaxLife": 0, "csubJobCount": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubJob", "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": "/csubJob", "x-restconf-kind": "container" }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubAggThresh": { "get": { "summary": "Get csubAggThresh data", "description": "Retrieve csubAggThresh operational data from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This object enables or disables the generation of any of the\n csubAggStats* threshold notifications.", "properties": { "csubAggStatsThreshNotifEnable": { "type": "boolean", "description": "This object enables or disables the generation of any of the\n csubAggStats* threshold notifications." } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubAggThresh": { "csubAggStatsThreshNotifEnable": true } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubAggThresh", "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": "/csubAggThresh", "x-restconf-kind": "container" }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubSessionTable": { "get": { "summary": "Get csubSessionTable data", "description": "Retrieve csubSessionTable operational data from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table describes a list of subscriber sessions currently\n maintained by the system.\n \n This table has a sparse dependent relationship on the ifTable,\n containing a row for each interface having an interface type\n describing a subscriber session.", "properties": { "csubSessionEntry": { "type": "array", "description": "csubSessionEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "csubSessionType": { "type": "string", "description": "This object indicates the type of subscriber session.", "x-yang-type": "cisco-subscriber:SubSessionType" }, "csubSessionIpAddrAssignment": { "type": "string", "description": "This object indicates how the system assigns IP addresses to\n the subscriber:\n \n 'none'\n The system does not an involvement in (or is it aware\n of) the assignment an subscriber IP addresses. For\n example, a system does not have an involvement in the\n assignment of subscriber IP addresses for IP interface\n subscriber sessions.\n \n 'other'\n The system assigns subscriber IP addresses using a\n method not recognized by this MIB module.\n \n 'static'\n Subscriber IP addresses have been configured correctly\n for the service domain. The system does not have an\n involvement in the assignment of the IP address.\n \n 'localPool'\n The system assigns subscriber IP addresses from a\n locally configured pool of IP addresses.\n \n 'dhcpv4'\n The system assigns subscriber IP addresses are using the\n DHCPv4.\n \n 'dhcpv6'\n The system assigns subscriber IP addresses using the\n DHCPv6.\n \n 'userProfileIpAddr'\n The system assigns subscriber IP addresses from a user\n profile.\n \n 'userProfileIpSubnet'\n The system assigns the subscriber an IP subnet from a\n user profile.\n \n 'userProfileNamedPool'\n The system assigns subscriber IP addresses from a\n locally configured named pool specified by a user\n profile." }, "csubSessionState": { "type": "string", "description": "This object indicates the operational state of the subscriber\n session.", "x-yang-type": "cisco-subscriber:SubSessionState" }, "csubSessionAuthenticated": { "type": "boolean", "description": "This object indicates whether the system has successfully\n authenticated the subscriber session.\n \n 'false'\n The subscriber session is operationally up, but in the\n UNAUTHENTICATED state.\n \n 'true'\n The subscriber session is operationally up, but in the\n AUTHENTICATED state." }, "csubSessionRedundancyMode": { "type": "string", "description": "This object indicates the redundancy mode in which the\n subscriber session is operating.", "x-yang-type": "cisco-subscriber:SubSessionRedundancyMode" }, "csubSessionCreationTime": { "type": "string", "description": "This object indicates when the subscriber session was created\n (i.e., when the subscriber session was initiated).", "x-yang-type": "snmpv2-tc:DateAndTime" }, "csubSessionDerivedCfg": { "type": "string", "description": "This object indicates the row in the cdtTemplateTable (defined\n by the CISCO-DYNAMIC-TEMPLATE-MIB) describing the derived\n configuration for the subscriber session.\n \n Observe that the value of cdtTemplateType corresponding to the\n referenced row must be 'derived'.", "x-yang-type": "cisco-dynamic:DynamicTemplateName" }, "csubSessionAvailableIdentities": { "type": "string", "description": "This object indicates the subscriber identities that the system\n has successfully collected for the subscriber session.\n \n Each bit in this bit string corresponds to a column in this\n table. If the bit is '0', then the value of the corresponding\n column is invalid. If the bit is '1', then the value of the\n corresponding column represents the value of the subscriber\n identity collected by the system.\n \n The following list specifies the mappings between the bits and\n the columns:\n \n 'subscriberLabel' => csubSessionSubscriberLabel\n 'macAddress' => csubSessionMacAddress\n 'nativeVrf' => csubSessionNativeVrf\n 'nativeIpAddress' => csubSessionNativeIpAddrType,\n csubSessionNativeIpAddr,\n csubSessionNativeIpMask\n 'nativeIpAddress2'=> csubSessionNativeIpAddrType2,\n csubSessionNativeIpAddr2,\n csubSessionNativeIpMask2 \n 'domainVrf' => csubSessionDomainVrf\n 'domainIpAddress' => csubSessionDomainIpAddrType,\n csubSessionDomainIpAddr,\n csubSessionDomainIpMask\n 'pbhk' => csubSessionPbhk\n 'remoteId' => csubSessionRemoteId\n 'circuitId' => csubSessionCircuitId\n 'nasPort' => csubSessionNasPort\n 'domain' => csubSessionDomain\n 'username' => csubSessionUsername\n 'acctSessionId' => csubSessionAcctSessionId\n 'dnis' => csubSessionDnis\n 'media' => csubSessionMedia\n 'mlpNegotiated' => csubSessionMlpNegotiated\n 'protocol' => csubSessionProtocol\n 'dhcpClass' => csubSessionDhcpClass\n 'tunnelName' => csubSessionTunnelName\n \n Observe that the bit 'ifIndex' should always be '1'. This\n identity maps to the ifIndex assigned to the subscriber\n session.\n \n Observe that the bit 'serviceName' maps to one or more instance\n of ccbptPolicyMap (defined by the CISCO-CBP-TARGET-MIB).", "x-yang-type": "cisco-subscriber-identity:SubSessionIdentities" }, "csubSessionSubscriberLabel": { "type": "string", "description": "This object indicates a positive integer-value uniquely\n identifying the subscriber session within the scope of\n the system.\n \n This column is valid only if the 'subscriberLabel' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberLabel" }, "csubSessionMacAddress": { "type": "string", "description": "This object indicates the MAC address of the subscriber.\n \n This column is valid only if the 'macAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "yang:mac-address" }, "csubSessionNativeVrf": { "type": "string", "description": "This object indicates the VRF originating the subscriber\n session.\n \n This column is valid only if the 'nativeVrf' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberVRF" }, "csubSessionNativeIpAddrType": { "type": "string", "description": "This object indicates the type of IP address assigned to the\n subscriber on the customer-facing side of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddressType" }, "csubSessionNativeIpAddr": { "type": "string", "description": "This object indicates the IP address assigned to the\n subscriber on the customer-facing side of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress" }, "csubSessionNativeIpMask": { "type": "string", "description": "This object indicates the corresponding mask for the IP\n address assigned to the subscriber on the customer-facing side\n of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress" }, "csubSessionDomainVrf": { "type": "string", "description": "This object indicates the VRF to which the system transfers\n the subscriber session's traffic.\n \n This column is valid only if the 'domainVrf' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberVRF" }, "csubSessionDomainIpAddrType": { "type": "string", "description": "This object indicates the type of IP address assigned to the\n subscriber on the service-facing side of the system.\n \n This column is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddressType" }, "csubSessionDomainIpAddr": { "type": "string", "description": "This object indicates the IP address assigned to the\n subscriber on the service-facing side of the system.\n \n This column is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress" }, "csubSessionDomainIpMask": { "type": "string", "description": "This object indicates the corresponding mask for the IP\n address assigned to the subscriber on the service-facing side of\n the system.\n \n This column is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress" }, "csubSessionPbhk": { "type": "string", "description": "This object indicates the PBHK identifying the subscriber.\n \n This column is valid only if the 'pbhk' bit of the corresponding\n instance of csubSessionAvailableIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberPbhk" }, "csubSessionRemoteId": { "type": "string", "description": "This object indicates the Remote-Id identifying the 'calling\n station' or AN supporting the circuit that provides access to\n the subscriber.\n \n This column is valid only if the 'remoteId' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberRemoteId" }, "csubSessionCircuitId": { "type": "string", "description": "This object indicates the Circuit-Id identifying the circuit\n supported by the 'calling station' or AN providing access to\n the subscriber.\n \n This column is valid only if the 'circuitId' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberCircuitId" }, "csubSessionNasPort": { "type": "string", "description": "This object indicates the NAS port-identifier identifying the\n port on the NAS providing access to the subscriber.\n \n This column is valid only if the 'nasPort' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberNasPort" }, "csubSessionDomain": { "type": "string", "description": "This object indicates the domain associated with the\n subscriber.\n \n This column is valid only if the 'domain' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDomain" }, "csubSessionUsername": { "type": "string", "description": "This object indicates the username identifying the subscriber.\n \n This column is valid only if the 'username' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberUsername" }, "csubSessionAcctSessionId": { "type": "string", "description": "This object indicates the accounting session identifier\n assigned to the subscriber session.\n \n This column is valid only if the 'accountingSid' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberAcctSessionId" }, "csubSessionDnis": { "type": "string", "description": "This object indicates the DNIS number dialed by the\n subscriber to access the 'calling station' or AN.\n \n This column is valid only if the 'dnis' bit of the corresponding\n instance of csubSessionAvailableIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDnis" }, "csubSessionMedia": { "type": "string", "description": "This object indicates the type of media providing access to\n the subscriber.\n \n This column is valid only if the 'media' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberMediaType" }, "csubSessionMlpNegotiated": { "type": "boolean", "description": "This object indicates whether the subscriber session was\n established using multi-link PPP negotiation.\n \n This column is valid only if the 'mlpNegotiated' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'." }, "csubSessionProtocol": { "type": "string", "description": "This object indicates the type of protocol providing access to\n the subscriber.\n \n This column is valid only if the 'protocol' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberProtocolType" }, "csubSessionDhcpClass": { "type": "string", "description": "This object indicates the name of the class matching the DHCP\n DISCOVER message received from the subscriber.\n \n This column is valid only if the 'dhcpClass' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDhcpClass" }, "csubSessionTunnelName": { "type": "string", "description": "This object indicates the name of the VPDN used to carry the\n subscriber session to the system.\n \n This column is valid only if the 'tunnelName' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberTunnelName" }, "csubSessionLocationIdentifier": { "type": "string", "description": "This object indicates the location of the\n subscriber", "x-yang-type": "cisco-subscriber-identity:SubscriberLocationName" }, "csubSessionServiceIdentifier": { "type": "string", "description": "This object indicates the name used to identify the services\n subscribed by a particular session.", "x-yang-type": "cisco-subscriber-identity:SubscriberServiceName" }, "csubSessionLastChanged": { "type": "string", "description": "This object indicates when the subscriber session is updated\n with new policy information.", "x-yang-type": "snmpv2-tc:DateAndTime" }, "csubSessionNativeIpAddrType2": { "type": "string", "description": "This object indicates the type of IP address assigned to the\n subscriber on the customer-facing side of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.\n \n In Dual stack scenarios both 'csubSessionNativeIpAddrType' and \n 'csubSessionNativeIpAddrType2' will be valid", "x-yang-type": "inet-address:InetAddressType" }, "csubSessionNativeIpAddr2": { "type": "string", "description": "This object indicates the IP address assigned to the\n subscriber on the customer-facing side of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress" }, "csubSessionNativeIpMask2": { "type": "string", "description": "This object indicates the corresponding mask for the IP\n address assigned to the subscriber on the customer-facing side\n of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress" } } } } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubSessionTable": { "csubSessionEntry": [ { "ifIndex": "1", "csubSessionType": "ethernetCsmacd(6)", "csubSessionIpAddrAssignment": "192.168.1.1", "csubSessionState": "up(1)", "csubSessionAuthenticated": true, "csubSessionRedundancyMode": "example-string", "csubSessionCreationTime": "example-string", "csubSessionDerivedCfg": "example-string", "csubSessionAvailableIdentities": "example-string", "csubSessionSubscriberLabel": "example-string", "csubSessionMacAddress": "00:11:22:33:44:55", "csubSessionNativeVrf": "example-string", "csubSessionNativeIpAddrType": "192.168.1.1", "csubSessionNativeIpAddr": "192.168.1.1", "csubSessionNativeIpMask": "192.168.1.1", "csubSessionDomainVrf": "example-string", "csubSessionDomainIpAddrType": "192.168.1.1", "csubSessionDomainIpAddr": "192.168.1.1", "csubSessionDomainIpMask": "192.168.1.1", "csubSessionPbhk": "example-string", "csubSessionRemoteId": "example-string", "csubSessionCircuitId": "example-string", "csubSessionNasPort": "example-string", "csubSessionDomain": "example-string", "csubSessionUsername": "interface-1", "csubSessionAcctSessionId": "example-string", "csubSessionDnis": "example-string", "csubSessionMedia": "example-string", "csubSessionMlpNegotiated": true, "csubSessionProtocol": "example-string", "csubSessionDhcpClass": "example-string", "csubSessionTunnelName": "interface-1", "csubSessionLocationIdentifier": "example-string", "csubSessionServiceIdentifier": "example-string", "csubSessionLastChanged": "example-string", "csubSessionNativeIpAddrType2": "192.168.1.1", "csubSessionNativeIpAddr2": "192.168.1.1", "csubSessionNativeIpMask2": "192.168.1.1" }, { "ifIndex": "2", "csubSessionType": "ethernetCsmacd(6)", "csubSessionIpAddrAssignment": "192.168.1.1", "csubSessionState": "up(1)", "csubSessionAuthenticated": true, "csubSessionRedundancyMode": "example-string", "csubSessionCreationTime": "example-string", "csubSessionDerivedCfg": "example-string", "csubSessionAvailableIdentities": "example-string", "csubSessionSubscriberLabel": "example-string", "csubSessionMacAddress": "00:11:22:33:44:55", "csubSessionNativeVrf": "example-string", "csubSessionNativeIpAddrType": "192.168.1.1", "csubSessionNativeIpAddr": "192.168.1.1", "csubSessionNativeIpMask": "192.168.1.1", "csubSessionDomainVrf": "example-string", "csubSessionDomainIpAddrType": "192.168.1.1", "csubSessionDomainIpAddr": "192.168.1.1", "csubSessionDomainIpMask": "192.168.1.1", "csubSessionPbhk": "example-string", "csubSessionRemoteId": "example-string", "csubSessionCircuitId": "example-string", "csubSessionNasPort": "example-string", "csubSessionDomain": "example-string", "csubSessionUsername": "interface-1", "csubSessionAcctSessionId": "example-string", "csubSessionDnis": "example-string", "csubSessionMedia": "example-string", "csubSessionMlpNegotiated": true, "csubSessionProtocol": "example-string", "csubSessionDhcpClass": "example-string", "csubSessionTunnelName": "interface-1", "csubSessionLocationIdentifier": "example-string", "csubSessionServiceIdentifier": "example-string", "csubSessionLastChanged": "example-string", "csubSessionNativeIpAddrType2": "192.168.1.1", "csubSessionNativeIpAddr2": "192.168.1.1", "csubSessionNativeIpMask2": "192.168.1.1" }, { "ifIndex": "3", "csubSessionType": "ethernetCsmacd(6)", "csubSessionIpAddrAssignment": "192.168.1.1", "csubSessionState": "up(1)", "csubSessionAuthenticated": true, "csubSessionRedundancyMode": "example-string", "csubSessionCreationTime": "example-string", "csubSessionDerivedCfg": "example-string", "csubSessionAvailableIdentities": "example-string", "csubSessionSubscriberLabel": "example-string", "csubSessionMacAddress": "00:11:22:33:44:55", "csubSessionNativeVrf": "example-string", "csubSessionNativeIpAddrType": "192.168.1.1", "csubSessionNativeIpAddr": "192.168.1.1", "csubSessionNativeIpMask": "192.168.1.1", "csubSessionDomainVrf": "example-string", "csubSessionDomainIpAddrType": "192.168.1.1", "csubSessionDomainIpAddr": "192.168.1.1", "csubSessionDomainIpMask": "192.168.1.1", "csubSessionPbhk": "example-string", "csubSessionRemoteId": "example-string", "csubSessionCircuitId": "example-string", "csubSessionNasPort": "example-string", "csubSessionDomain": "example-string", "csubSessionUsername": "interface-1", "csubSessionAcctSessionId": "example-string", "csubSessionDnis": "example-string", "csubSessionMedia": "example-string", "csubSessionMlpNegotiated": true, "csubSessionProtocol": "example-string", "csubSessionDhcpClass": "example-string", "csubSessionTunnelName": "interface-1", "csubSessionLocationIdentifier": "example-string", "csubSessionServiceIdentifier": "example-string", "csubSessionLastChanged": "example-string", "csubSessionNativeIpAddrType2": "192.168.1.1", "csubSessionNativeIpAddr2": "192.168.1.1", "csubSessionNativeIpMask2": "192.168.1.1" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubSessionTable", "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": "/csubSessionTable", "x-restconf-kind": "container" }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubSessionTable/csubSessionEntry": { "get": { "summary": "Get csubSessionEntry list", "description": "Retrieve list of csubSessionEntry entries from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "csubSessionEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "csubSessionType": { "type": "string", "description": "This object indicates the type of subscriber session.", "x-yang-type": "cisco-subscriber:SubSessionType" }, "csubSessionIpAddrAssignment": { "type": "string", "description": "This object indicates how the system assigns IP addresses to\n the subscriber:\n \n 'none'\n The system does not an involvement in (or is it aware\n of) the assignment an subscriber IP addresses. For\n example, a system does not have an involvement in the\n assignment of subscriber IP addresses for IP interface\n subscriber sessions.\n \n 'other'\n The system assigns subscriber IP addresses using a\n method not recognized by this MIB module.\n \n 'static'\n Subscriber IP addresses have been configured correctly\n for the service domain. The system does not have an\n involvement in the assignment of the IP address.\n \n 'localPool'\n The system assigns subscriber IP addresses from a\n locally configured pool of IP addresses.\n \n 'dhcpv4'\n The system assigns subscriber IP addresses are using the\n DHCPv4.\n \n 'dhcpv6'\n The system assigns subscriber IP addresses using the\n DHCPv6.\n \n 'userProfileIpAddr'\n The system assigns subscriber IP addresses from a user\n profile.\n \n 'userProfileIpSubnet'\n The system assigns the subscriber an IP subnet from a\n user profile.\n \n 'userProfileNamedPool'\n The system assigns subscriber IP addresses from a\n locally configured named pool specified by a user\n profile." }, "csubSessionState": { "type": "string", "description": "This object indicates the operational state of the subscriber\n session.", "x-yang-type": "cisco-subscriber:SubSessionState" }, "csubSessionAuthenticated": { "type": "boolean", "description": "This object indicates whether the system has successfully\n authenticated the subscriber session.\n \n 'false'\n The subscriber session is operationally up, but in the\n UNAUTHENTICATED state.\n \n 'true'\n The subscriber session is operationally up, but in the\n AUTHENTICATED state." }, "csubSessionRedundancyMode": { "type": "string", "description": "This object indicates the redundancy mode in which the\n subscriber session is operating.", "x-yang-type": "cisco-subscriber:SubSessionRedundancyMode" }, "csubSessionCreationTime": { "type": "string", "description": "This object indicates when the subscriber session was created\n (i.e., when the subscriber session was initiated).", "x-yang-type": "snmpv2-tc:DateAndTime" }, "csubSessionDerivedCfg": { "type": "string", "description": "This object indicates the row in the cdtTemplateTable (defined\n by the CISCO-DYNAMIC-TEMPLATE-MIB) describing the derived\n configuration for the subscriber session.\n \n Observe that the value of cdtTemplateType corresponding to the\n referenced row must be 'derived'.", "x-yang-type": "cisco-dynamic:DynamicTemplateName" }, "csubSessionAvailableIdentities": { "type": "string", "description": "This object indicates the subscriber identities that the system\n has successfully collected for the subscriber session.\n \n Each bit in this bit string corresponds to a column in this\n table. If the bit is '0', then the value of the corresponding\n column is invalid. If the bit is '1', then the value of the\n corresponding column represents the value of the subscriber\n identity collected by the system.\n \n The following list specifies the mappings between the bits and\n the columns:\n \n 'subscriberLabel' => csubSessionSubscriberLabel\n 'macAddress' => csubSessionMacAddress\n 'nativeVrf' => csubSessionNativeVrf\n 'nativeIpAddress' => csubSessionNativeIpAddrType,\n csubSessionNativeIpAddr,\n csubSessionNativeIpMask\n 'nativeIpAddress2'=> csubSessionNativeIpAddrType2,\n csubSessionNativeIpAddr2,\n csubSessionNativeIpMask2 \n 'domainVrf' => csubSessionDomainVrf\n 'domainIpAddress' => csubSessionDomainIpAddrType,\n csubSessionDomainIpAddr,\n csubSessionDomainIpMask\n 'pbhk' => csubSessionPbhk\n 'remoteId' => csubSessionRemoteId\n 'circuitId' => csubSessionCircuitId\n 'nasPort' => csubSessionNasPort\n 'domain' => csubSessionDomain\n 'username' => csubSessionUsername\n 'acctSessionId' => csubSessionAcctSessionId\n 'dnis' => csubSessionDnis\n 'media' => csubSessionMedia\n 'mlpNegotiated' => csubSessionMlpNegotiated\n 'protocol' => csubSessionProtocol\n 'dhcpClass' => csubSessionDhcpClass\n 'tunnelName' => csubSessionTunnelName\n \n Observe that the bit 'ifIndex' should always be '1'. This\n identity maps to the ifIndex assigned to the subscriber\n session.\n \n Observe that the bit 'serviceName' maps to one or more instance\n of ccbptPolicyMap (defined by the CISCO-CBP-TARGET-MIB).", "x-yang-type": "cisco-subscriber-identity:SubSessionIdentities" }, "csubSessionSubscriberLabel": { "type": "string", "description": "This object indicates a positive integer-value uniquely\n identifying the subscriber session within the scope of\n the system.\n \n This column is valid only if the 'subscriberLabel' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberLabel" }, "csubSessionMacAddress": { "type": "string", "description": "This object indicates the MAC address of the subscriber.\n \n This column is valid only if the 'macAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "yang:mac-address" }, "csubSessionNativeVrf": { "type": "string", "description": "This object indicates the VRF originating the subscriber\n session.\n \n This column is valid only if the 'nativeVrf' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberVRF" }, "csubSessionNativeIpAddrType": { "type": "string", "description": "This object indicates the type of IP address assigned to the\n subscriber on the customer-facing side of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddressType" }, "csubSessionNativeIpAddr": { "type": "string", "description": "This object indicates the IP address assigned to the\n subscriber on the customer-facing side of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress" }, "csubSessionNativeIpMask": { "type": "string", "description": "This object indicates the corresponding mask for the IP\n address assigned to the subscriber on the customer-facing side\n of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress" }, "csubSessionDomainVrf": { "type": "string", "description": "This object indicates the VRF to which the system transfers\n the subscriber session's traffic.\n \n This column is valid only if the 'domainVrf' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberVRF" }, "csubSessionDomainIpAddrType": { "type": "string", "description": "This object indicates the type of IP address assigned to the\n subscriber on the service-facing side of the system.\n \n This column is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddressType" }, "csubSessionDomainIpAddr": { "type": "string", "description": "This object indicates the IP address assigned to the\n subscriber on the service-facing side of the system.\n \n This column is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress" }, "csubSessionDomainIpMask": { "type": "string", "description": "This object indicates the corresponding mask for the IP\n address assigned to the subscriber on the service-facing side of\n the system.\n \n This column is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress" }, "csubSessionPbhk": { "type": "string", "description": "This object indicates the PBHK identifying the subscriber.\n \n This column is valid only if the 'pbhk' bit of the corresponding\n instance of csubSessionAvailableIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberPbhk" }, "csubSessionRemoteId": { "type": "string", "description": "This object indicates the Remote-Id identifying the 'calling\n station' or AN supporting the circuit that provides access to\n the subscriber.\n \n This column is valid only if the 'remoteId' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberRemoteId" }, "csubSessionCircuitId": { "type": "string", "description": "This object indicates the Circuit-Id identifying the circuit\n supported by the 'calling station' or AN providing access to\n the subscriber.\n \n This column is valid only if the 'circuitId' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberCircuitId" }, "csubSessionNasPort": { "type": "string", "description": "This object indicates the NAS port-identifier identifying the\n port on the NAS providing access to the subscriber.\n \n This column is valid only if the 'nasPort' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberNasPort" }, "csubSessionDomain": { "type": "string", "description": "This object indicates the domain associated with the\n subscriber.\n \n This column is valid only if the 'domain' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDomain" }, "csubSessionUsername": { "type": "string", "description": "This object indicates the username identifying the subscriber.\n \n This column is valid only if the 'username' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberUsername" }, "csubSessionAcctSessionId": { "type": "string", "description": "This object indicates the accounting session identifier\n assigned to the subscriber session.\n \n This column is valid only if the 'accountingSid' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberAcctSessionId" }, "csubSessionDnis": { "type": "string", "description": "This object indicates the DNIS number dialed by the\n subscriber to access the 'calling station' or AN.\n \n This column is valid only if the 'dnis' bit of the corresponding\n instance of csubSessionAvailableIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDnis" }, "csubSessionMedia": { "type": "string", "description": "This object indicates the type of media providing access to\n the subscriber.\n \n This column is valid only if the 'media' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberMediaType" }, "csubSessionMlpNegotiated": { "type": "boolean", "description": "This object indicates whether the subscriber session was\n established using multi-link PPP negotiation.\n \n This column is valid only if the 'mlpNegotiated' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'." }, "csubSessionProtocol": { "type": "string", "description": "This object indicates the type of protocol providing access to\n the subscriber.\n \n This column is valid only if the 'protocol' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberProtocolType" }, "csubSessionDhcpClass": { "type": "string", "description": "This object indicates the name of the class matching the DHCP\n DISCOVER message received from the subscriber.\n \n This column is valid only if the 'dhcpClass' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDhcpClass" }, "csubSessionTunnelName": { "type": "string", "description": "This object indicates the name of the VPDN used to carry the\n subscriber session to the system.\n \n This column is valid only if the 'tunnelName' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberTunnelName" }, "csubSessionLocationIdentifier": { "type": "string", "description": "This object indicates the location of the\n subscriber", "x-yang-type": "cisco-subscriber-identity:SubscriberLocationName" }, "csubSessionServiceIdentifier": { "type": "string", "description": "This object indicates the name used to identify the services\n subscribed by a particular session.", "x-yang-type": "cisco-subscriber-identity:SubscriberServiceName" }, "csubSessionLastChanged": { "type": "string", "description": "This object indicates when the subscriber session is updated\n with new policy information.", "x-yang-type": "snmpv2-tc:DateAndTime" }, "csubSessionNativeIpAddrType2": { "type": "string", "description": "This object indicates the type of IP address assigned to the\n subscriber on the customer-facing side of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.\n \n In Dual stack scenarios both 'csubSessionNativeIpAddrType' and \n 'csubSessionNativeIpAddrType2' will be valid", "x-yang-type": "inet-address:InetAddressType" }, "csubSessionNativeIpAddr2": { "type": "string", "description": "This object indicates the IP address assigned to the\n subscriber on the customer-facing side of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress" }, "csubSessionNativeIpMask2": { "type": "string", "description": "This object indicates the corresponding mask for the IP\n address assigned to the subscriber on the customer-facing side\n of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress" } } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubSessionEntry": [ { "ifIndex": "example-string", "csubSessionType": "ethernetCsmacd(6)", "csubSessionIpAddrAssignment": "192.168.1.1", "csubSessionState": "up(1)", "csubSessionAuthenticated": true, "csubSessionRedundancyMode": "example-string", "csubSessionCreationTime": "example-string", "csubSessionDerivedCfg": "example-string", "csubSessionAvailableIdentities": "example-string", "csubSessionSubscriberLabel": "example-string", "csubSessionMacAddress": "00:11:22:33:44:55", "csubSessionNativeVrf": "example-string", "csubSessionNativeIpAddrType": "192.168.1.1", "csubSessionNativeIpAddr": "192.168.1.1", "csubSessionNativeIpMask": "192.168.1.1", "csubSessionDomainVrf": "example-string", "csubSessionDomainIpAddrType": "192.168.1.1", "csubSessionDomainIpAddr": "192.168.1.1", "csubSessionDomainIpMask": "192.168.1.1", "csubSessionPbhk": "example-string", "csubSessionRemoteId": "example-string", "csubSessionCircuitId": "example-string", "csubSessionNasPort": "example-string", "csubSessionDomain": "example-string", "csubSessionUsername": "interface-1", "csubSessionAcctSessionId": "example-string", "csubSessionDnis": "example-string", "csubSessionMedia": "example-string", "csubSessionMlpNegotiated": true, "csubSessionProtocol": "example-string", "csubSessionDhcpClass": "example-string", "csubSessionTunnelName": "interface-1", "csubSessionLocationIdentifier": "example-string", "csubSessionServiceIdentifier": "example-string", "csubSessionLastChanged": "example-string", "csubSessionNativeIpAddrType2": "192.168.1.1", "csubSessionNativeIpAddr2": "192.168.1.1", "csubSessionNativeIpMask2": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubSessionEntry", "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": "/csubSessionTable/csubSessionEntry", "x-restconf-kind": "container" }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubSessionTable/csubSessionEntry={ifIndex}": { "get": { "summary": "Get csubSessionEntry entry", "description": "Retrieve specific csubSessionEntry entry by key from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "parameters": [ { "name": "ifIndex", "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": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "csubSessionType": { "type": "string", "description": "This object indicates the type of subscriber session.", "x-yang-type": "cisco-subscriber:SubSessionType" }, "csubSessionIpAddrAssignment": { "type": "string", "description": "This object indicates how the system assigns IP addresses to\n the subscriber:\n \n 'none'\n The system does not an involvement in (or is it aware\n of) the assignment an subscriber IP addresses. For\n example, a system does not have an involvement in the\n assignment of subscriber IP addresses for IP interface\n subscriber sessions.\n \n 'other'\n The system assigns subscriber IP addresses using a\n method not recognized by this MIB module.\n \n 'static'\n Subscriber IP addresses have been configured correctly\n for the service domain. The system does not have an\n involvement in the assignment of the IP address.\n \n 'localPool'\n The system assigns subscriber IP addresses from a\n locally configured pool of IP addresses.\n \n 'dhcpv4'\n The system assigns subscriber IP addresses are using the\n DHCPv4.\n \n 'dhcpv6'\n The system assigns subscriber IP addresses using the\n DHCPv6.\n \n 'userProfileIpAddr'\n The system assigns subscriber IP addresses from a user\n profile.\n \n 'userProfileIpSubnet'\n The system assigns the subscriber an IP subnet from a\n user profile.\n \n 'userProfileNamedPool'\n The system assigns subscriber IP addresses from a\n locally configured named pool specified by a user\n profile." }, "csubSessionState": { "type": "string", "description": "This object indicates the operational state of the subscriber\n session.", "x-yang-type": "cisco-subscriber:SubSessionState" }, "csubSessionAuthenticated": { "type": "boolean", "description": "This object indicates whether the system has successfully\n authenticated the subscriber session.\n \n 'false'\n The subscriber session is operationally up, but in the\n UNAUTHENTICATED state.\n \n 'true'\n The subscriber session is operationally up, but in the\n AUTHENTICATED state." }, "csubSessionRedundancyMode": { "type": "string", "description": "This object indicates the redundancy mode in which the\n subscriber session is operating.", "x-yang-type": "cisco-subscriber:SubSessionRedundancyMode" }, "csubSessionCreationTime": { "type": "string", "description": "This object indicates when the subscriber session was created\n (i.e., when the subscriber session was initiated).", "x-yang-type": "snmpv2-tc:DateAndTime" }, "csubSessionDerivedCfg": { "type": "string", "description": "This object indicates the row in the cdtTemplateTable (defined\n by the CISCO-DYNAMIC-TEMPLATE-MIB) describing the derived\n configuration for the subscriber session.\n \n Observe that the value of cdtTemplateType corresponding to the\n referenced row must be 'derived'.", "x-yang-type": "cisco-dynamic:DynamicTemplateName" }, "csubSessionAvailableIdentities": { "type": "string", "description": "This object indicates the subscriber identities that the system\n has successfully collected for the subscriber session.\n \n Each bit in this bit string corresponds to a column in this\n table. If the bit is '0', then the value of the corresponding\n column is invalid. If the bit is '1', then the value of the\n corresponding column represents the value of the subscriber\n identity collected by the system.\n \n The following list specifies the mappings between the bits and\n the columns:\n \n 'subscriberLabel' => csubSessionSubscriberLabel\n 'macAddress' => csubSessionMacAddress\n 'nativeVrf' => csubSessionNativeVrf\n 'nativeIpAddress' => csubSessionNativeIpAddrType,\n csubSessionNativeIpAddr,\n csubSessionNativeIpMask\n 'nativeIpAddress2'=> csubSessionNativeIpAddrType2,\n csubSessionNativeIpAddr2,\n csubSessionNativeIpMask2 \n 'domainVrf' => csubSessionDomainVrf\n 'domainIpAddress' => csubSessionDomainIpAddrType,\n csubSessionDomainIpAddr,\n csubSessionDomainIpMask\n 'pbhk' => csubSessionPbhk\n 'remoteId' => csubSessionRemoteId\n 'circuitId' => csubSessionCircuitId\n 'nasPort' => csubSessionNasPort\n 'domain' => csubSessionDomain\n 'username' => csubSessionUsername\n 'acctSessionId' => csubSessionAcctSessionId\n 'dnis' => csubSessionDnis\n 'media' => csubSessionMedia\n 'mlpNegotiated' => csubSessionMlpNegotiated\n 'protocol' => csubSessionProtocol\n 'dhcpClass' => csubSessionDhcpClass\n 'tunnelName' => csubSessionTunnelName\n \n Observe that the bit 'ifIndex' should always be '1'. This\n identity maps to the ifIndex assigned to the subscriber\n session.\n \n Observe that the bit 'serviceName' maps to one or more instance\n of ccbptPolicyMap (defined by the CISCO-CBP-TARGET-MIB).", "x-yang-type": "cisco-subscriber-identity:SubSessionIdentities" }, "csubSessionSubscriberLabel": { "type": "string", "description": "This object indicates a positive integer-value uniquely\n identifying the subscriber session within the scope of\n the system.\n \n This column is valid only if the 'subscriberLabel' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberLabel" }, "csubSessionMacAddress": { "type": "string", "description": "This object indicates the MAC address of the subscriber.\n \n This column is valid only if the 'macAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "yang:mac-address" }, "csubSessionNativeVrf": { "type": "string", "description": "This object indicates the VRF originating the subscriber\n session.\n \n This column is valid only if the 'nativeVrf' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberVRF" }, "csubSessionNativeIpAddrType": { "type": "string", "description": "This object indicates the type of IP address assigned to the\n subscriber on the customer-facing side of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddressType" }, "csubSessionNativeIpAddr": { "type": "string", "description": "This object indicates the IP address assigned to the\n subscriber on the customer-facing side of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress" }, "csubSessionNativeIpMask": { "type": "string", "description": "This object indicates the corresponding mask for the IP\n address assigned to the subscriber on the customer-facing side\n of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress" }, "csubSessionDomainVrf": { "type": "string", "description": "This object indicates the VRF to which the system transfers\n the subscriber session's traffic.\n \n This column is valid only if the 'domainVrf' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberVRF" }, "csubSessionDomainIpAddrType": { "type": "string", "description": "This object indicates the type of IP address assigned to the\n subscriber on the service-facing side of the system.\n \n This column is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddressType" }, "csubSessionDomainIpAddr": { "type": "string", "description": "This object indicates the IP address assigned to the\n subscriber on the service-facing side of the system.\n \n This column is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress" }, "csubSessionDomainIpMask": { "type": "string", "description": "This object indicates the corresponding mask for the IP\n address assigned to the subscriber on the service-facing side of\n the system.\n \n This column is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress" }, "csubSessionPbhk": { "type": "string", "description": "This object indicates the PBHK identifying the subscriber.\n \n This column is valid only if the 'pbhk' bit of the corresponding\n instance of csubSessionAvailableIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberPbhk" }, "csubSessionRemoteId": { "type": "string", "description": "This object indicates the Remote-Id identifying the 'calling\n station' or AN supporting the circuit that provides access to\n the subscriber.\n \n This column is valid only if the 'remoteId' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberRemoteId" }, "csubSessionCircuitId": { "type": "string", "description": "This object indicates the Circuit-Id identifying the circuit\n supported by the 'calling station' or AN providing access to\n the subscriber.\n \n This column is valid only if the 'circuitId' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberCircuitId" }, "csubSessionNasPort": { "type": "string", "description": "This object indicates the NAS port-identifier identifying the\n port on the NAS providing access to the subscriber.\n \n This column is valid only if the 'nasPort' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberNasPort" }, "csubSessionDomain": { "type": "string", "description": "This object indicates the domain associated with the\n subscriber.\n \n This column is valid only if the 'domain' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDomain" }, "csubSessionUsername": { "type": "string", "description": "This object indicates the username identifying the subscriber.\n \n This column is valid only if the 'username' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberUsername" }, "csubSessionAcctSessionId": { "type": "string", "description": "This object indicates the accounting session identifier\n assigned to the subscriber session.\n \n This column is valid only if the 'accountingSid' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberAcctSessionId" }, "csubSessionDnis": { "type": "string", "description": "This object indicates the DNIS number dialed by the\n subscriber to access the 'calling station' or AN.\n \n This column is valid only if the 'dnis' bit of the corresponding\n instance of csubSessionAvailableIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDnis" }, "csubSessionMedia": { "type": "string", "description": "This object indicates the type of media providing access to\n the subscriber.\n \n This column is valid only if the 'media' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberMediaType" }, "csubSessionMlpNegotiated": { "type": "boolean", "description": "This object indicates whether the subscriber session was\n established using multi-link PPP negotiation.\n \n This column is valid only if the 'mlpNegotiated' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'." }, "csubSessionProtocol": { "type": "string", "description": "This object indicates the type of protocol providing access to\n the subscriber.\n \n This column is valid only if the 'protocol' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberProtocolType" }, "csubSessionDhcpClass": { "type": "string", "description": "This object indicates the name of the class matching the DHCP\n DISCOVER message received from the subscriber.\n \n This column is valid only if the 'dhcpClass' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDhcpClass" }, "csubSessionTunnelName": { "type": "string", "description": "This object indicates the name of the VPDN used to carry the\n subscriber session to the system.\n \n This column is valid only if the 'tunnelName' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberTunnelName" }, "csubSessionLocationIdentifier": { "type": "string", "description": "This object indicates the location of the\n subscriber", "x-yang-type": "cisco-subscriber-identity:SubscriberLocationName" }, "csubSessionServiceIdentifier": { "type": "string", "description": "This object indicates the name used to identify the services\n subscribed by a particular session.", "x-yang-type": "cisco-subscriber-identity:SubscriberServiceName" }, "csubSessionLastChanged": { "type": "string", "description": "This object indicates when the subscriber session is updated\n with new policy information.", "x-yang-type": "snmpv2-tc:DateAndTime" }, "csubSessionNativeIpAddrType2": { "type": "string", "description": "This object indicates the type of IP address assigned to the\n subscriber on the customer-facing side of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.\n \n In Dual stack scenarios both 'csubSessionNativeIpAddrType' and \n 'csubSessionNativeIpAddrType2' will be valid", "x-yang-type": "inet-address:InetAddressType" }, "csubSessionNativeIpAddr2": { "type": "string", "description": "This object indicates the IP address assigned to the\n subscriber on the customer-facing side of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress" }, "csubSessionNativeIpMask2": { "type": "string", "description": "This object indicates the corresponding mask for the IP\n address assigned to the subscriber on the customer-facing side\n of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress" } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubSessionEntry": { "ifIndex": "example-string", "csubSessionType": "ethernetCsmacd(6)", "csubSessionIpAddrAssignment": "192.168.1.1", "csubSessionState": "up(1)", "csubSessionAuthenticated": true, "csubSessionRedundancyMode": "example-string", "csubSessionCreationTime": "example-string", "csubSessionDerivedCfg": "example-string", "csubSessionAvailableIdentities": "example-string", "csubSessionSubscriberLabel": "example-string", "csubSessionMacAddress": "00:11:22:33:44:55", "csubSessionNativeVrf": "example-string", "csubSessionNativeIpAddrType": "192.168.1.1", "csubSessionNativeIpAddr": "192.168.1.1", "csubSessionNativeIpMask": "192.168.1.1", "csubSessionDomainVrf": "example-string", "csubSessionDomainIpAddrType": "192.168.1.1", "csubSessionDomainIpAddr": "192.168.1.1", "csubSessionDomainIpMask": "192.168.1.1", "csubSessionPbhk": "example-string", "csubSessionRemoteId": "example-string", "csubSessionCircuitId": "example-string", "csubSessionNasPort": "example-string", "csubSessionDomain": "example-string", "csubSessionUsername": "interface-1", "csubSessionAcctSessionId": "example-string", "csubSessionDnis": "example-string", "csubSessionMedia": "example-string", "csubSessionMlpNegotiated": true, "csubSessionProtocol": "example-string", "csubSessionDhcpClass": "example-string", "csubSessionTunnelName": "interface-1", "csubSessionLocationIdentifier": "example-string", "csubSessionServiceIdentifier": "example-string", "csubSessionLastChanged": "example-string", "csubSessionNativeIpAddrType2": "192.168.1.1", "csubSessionNativeIpAddr2": "192.168.1.1", "csubSessionNativeIpMask2": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubSessionEntry-2" }, "x-yang-path": "/csubSessionTable/csubSessionEntry={ifIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ifIndex" ] }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubSessionByTypeTable": { "get": { "summary": "Get csubSessionByTypeTable data", "description": "Retrieve csubSessionByTypeTable operational data from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table describes a list of subscriber sessions currently\n maintained by the system. The tables sorts the subscriber\n sessions first by the subscriber session's type and second by\n the ifIndex assigned to the subscriber session.", "properties": { "csubSessionByTypeEntry": { "type": "array", "description": "csubSessionByTypeEntry", "items": { "type": "object", "properties": { "csubSessionByType": { "type": "string", "description": "This object indicates the type of the subscriber session.", "x-yang-type": "cisco-subscriber:SubSessionType" }, "csubSessionIfIndex": { "type": "string", "description": "This object indicates the ifIndex assigned to the subscriber\n session.", "x-yang-type": "if-mib:InterfaceIndex" } } } } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubSessionByTypeTable": { "csubSessionByTypeEntry": [ { "csubSessionByType": "ethernetCsmacd(6)", "csubSessionIfIndex": "1" }, { "csubSessionByType": "ethernetCsmacd(6)", "csubSessionIfIndex": "2" }, { "csubSessionByType": "ethernetCsmacd(6)", "csubSessionIfIndex": "3" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubSessionByTypeTable", "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": "/csubSessionByTypeTable", "x-restconf-kind": "container" }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubSessionByTypeTable/csubSessionByTypeEntry": { "get": { "summary": "Get csubSessionByTypeEntry list", "description": "Retrieve list of csubSessionByTypeEntry entries from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "csubSessionByTypeEntry", "items": { "type": "object", "properties": { "csubSessionByType": { "type": "string", "description": "This object indicates the type of the subscriber session.", "x-yang-type": "cisco-subscriber:SubSessionType" }, "csubSessionIfIndex": { "type": "string", "description": "This object indicates the ifIndex assigned to the subscriber\n session.", "x-yang-type": "if-mib:InterfaceIndex" } } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubSessionByTypeEntry": [ { "csubSessionByType": "ethernetCsmacd(6)", "csubSessionIfIndex": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubSessionByTypeEntry", "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": "/csubSessionByTypeTable/csubSessionByTypeEntry", "x-restconf-kind": "container" }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubAggStatsTable": { "get": { "summary": "Get csubAggStatsTable data", "description": "Retrieve csubAggStatsTable operational data from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table contains sets of aggregated statistics relating to\n subscriber sessions, where each set has a unique scope of\n aggregation.", "properties": { "csubAggStatsEntry": { "type": "array", "description": "csubAggStatsEntry", "items": { "type": "object", "properties": { "csubAggStatsPointType": { "type": "string", "description": "This object indicates format of the csubAggStatsPoint\n for this entry. \n \n The format for the csubAggStatsPoint is as follows: \n \n csubAggStatsPointType csubAggStatsPoint \n ---------------------- ------------------ \n 'physical' PhysicalIndex \n 'interface' InterfaceIndex" }, "csubAggStatsPoint": { "type": "integer", "description": "This object should be read with csubAggStatsPointType always.\n \n This object indicates one of the determining factors affecting \n the 'scope of aggregation' for the set of statistics contained \n by the row. \n \n The value indicated by this object should be interpreted as the \n identifier for the point type specific base table. \n \n For point types of 'physical', the type specific base table is \n the entPhysicalTable and this value is a PhysicalIndex. For \n point types of 'interface', the type specific base table is \n the ifTable and this value is an InterfaceIndex. \n \n If this column indicates a physical entity which has an \n entPhysicalClass of 'chassis', then the 'scope of aggregation' \n may includes those subscriber sessions maintained by all nodes \n contained by the system. \n \n If this column indicates a physical entity which has an \n entPhysicalClass of 'module' (e.g., a line card), then the \n 'scope of aggregation' may include those subscriber sessions \n maintained by the nodes contained by the module. \n \n If this column indicates a physical entity which has an \n entPhysicalClass of 'cpu', then the 'scope of aggregation' may \n include those subscriber sessions maintained by the node \n running on the processor. \n \n Aggregation points with entPhysicalTable / ifTable overlap: \n For interfaces which map directly to physical 'port' class \n entities in the entPhysicalTable, the preferred representation \n as aggregation points is the 'physical' point type and \n PhysicalIndex identifier.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsSessionType": { "type": "string", "description": "This object indicates one of the determining factors affecting\n the 'scope of aggregation' for the statistics contained by the\n row.\n \n If the value of this column is 'all', then the 'scope of\n aggregation' may include all subscriber sessions, regardless of\n type.\n \n If the value of this column is not 'all', then the 'scope of\n aggregation' may include subscriber sessions of the indicated\n subscriber session type.", "x-yang-type": "cisco-subscriber:SubSessionType" }, "csubAggStatsPendingSessions": { "type": "integer", "description": "This object indicates the current number of subscriber sessions\n within the 'scope of aggregation' that are in the PENDING\n state.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsUpSessions": { "type": "integer", "description": "This object indicates the current number of subscriber sessions\n within the 'scope of aggregation' that are in the UP state.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsAuthSessions": { "type": "integer", "description": "This object indicates the current number of subscriber session\n within the 'scope of aggregation' that have been authenticated.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsUnAuthSessions": { "type": "integer", "description": "This object indicates the current number of subscriber session\n within the 'scope of aggregation' that have not been authenticated.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsLightWeightSessions": { "type": "integer", "description": "This object indicates the current number of subscriber\n sessions within the 'scope of aggregation' that are less resource intensive.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsRedSessions": { "type": "integer", "description": "This object indicates the current number of subscriber sessions\n within the 'scope of aggregation' that are redundant (i.e., \n sessions with a csubSessionRedundancyMode of 'standby').", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsHighUpSessions": { "type": "integer", "description": "This object indicates the highest number of subscriber sessions\n within the 'scope of aggregation' observed simultaneously in the UP\n state since the last discontinuity time.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsAvgSessionUptime": { "type": "integer", "description": "This object indicates the average time subscriber sessions\n within the 'scope of aggregation' spent in the UP state.\n \n The system calculates this average over all subscriber\n sessions maintained by all nodes contained by the 'scope of\n aggregation' since the last discontinuity time.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsAvgSessionRPM": { "type": "integer", "description": "This object indicates the average rate (per minute) at which\n the nodes contained by the 'scope of aggregation' have\n established new subscriber sessions.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsAvgSessionRPH": { "type": "integer", "description": "This object indicates the average rate (per hour) at which the\n nodes contained by the 'scope of aggregation' have established new\n subscriber sessions.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsThrottleEngagements": { "type": "integer", "description": "This object indicates the number of times that nodes contained\n within the 'scope of aggregation' have engaged the subscriber\n session throttle since the last discontinuity time.\n \n The mechanics of a subscriber session throttle vary with\n subscriber session type and implementation. However, the\n general concept of the throttle prevents a node from having\n to deal with more than a configured number of requests to\n establish subscriber sessions from the same CPE within the a\n configured interval of time. When the number of requests\n exceeds the configured threshold within the configured interval,\n then the node processing the requests engages the throttle.\n Typically, when a node engages a throttle, it drops requests\n from the CPE for some period of time, after which the node\n disengages the throttle.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime.", "minimum": 0 }, "csubAggStatsTotalCreatedSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' created since the\n discontinuity time.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime.", "minimum": 0 }, "csubAggStatsTotalFailedSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that were in the PENDING state\n and terminated for reasons other than disconnect since the last\n discontinuity time.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime.", "minimum": 0 }, "csubAggStatsTotalUpSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned to the UP\n state since the last discontinuity time.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime", "minimum": 0 }, "csubAggStatsTotalAuthSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned from the\n UNAUTHENTICATED to the AUTHENTICATED state since the last\n discontinuity time.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime", "minimum": 0 }, "csubAggStatsTotalDiscSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n terminated due to a disconnect event since the last\n discontinuity time.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime", "minimum": 0 }, "csubAggStatsTotalLightWeightSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n that are less resource intensive", "minimum": 0 }, "csubAggStatsTotalFlowsUp": { "type": "integer", "description": "This object indicates the total number of differential traffic classes\n on subscriber sessions. IP ACLs are used to create differential flows(Traffic Classes). \n Each Traffic Class can have a different set of features applied.", "minimum": 0 }, "csubAggStatsDayCreatedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' created during the last 24\n hours.\n \n The system calculates the value of this column by summing the\n values of all instances of csubAggStatsIntCreatedSessions that\n expand this row and have a corresponding csubAggStatsIntValid of\n 'true'.", "x-yang-type": "perfhist-tc:PerfTotalCount" }, "csubAggStatsDayFailedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that were in the PENDING state\n and terminated for reasons other than disconnect during the\n last 24 hours.\n \n The system calculates the value of this column by summing the\n values of all instances of csubAggStatsIntFailedSessions that\n expand this row and have a corresponding csubAggStatsIntValid\n of 'true'.", "x-yang-type": "perfhist-tc:PerfTotalCount" }, "csubAggStatsDayUpSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned to the UP\n state during the last 24 hours.\n \n The system calculates the value of this column by summing the\n values of all instances of csubAggStatsIntUpSessions that\n expand this row and have a corresponding csubAggStatsIntValid\n of 'true'.", "x-yang-type": "perfhist-tc:PerfTotalCount" }, "csubAggStatsDayAuthSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned from the\n UNAUTHENTICATED to the AUTHENTICATED state during the last 24\n hours.\n \n The system calculates the value of this column by summing the\n values of all instances of csubAggStatsIntAuthSessions that\n expand this row and have a corresponding csubAggStatsIntValid of\n 'true'.", "x-yang-type": "perfhist-tc:PerfTotalCount" }, "csubAggStatsDayDiscSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n terminated due to a disconnect event during the last 24 hours.\n \n The system calculates the value of this column by summing the\n values of all instances of csubAggStatsIntDiscSessions that\n expand this row and have a corresponding csubAggStatsIntValid of\n 'true'.", "x-yang-type": "perfhist-tc:PerfTotalCount" }, "csubAggStatsCurrTimeElapsed": { "type": "integer", "description": "This object indicates the time that has elapsed since the\n beginning of the current 15-minute measurement interval. If,\n for some reason, such as an adjustment in the system's\n time-of-day clock, the current interval exceeds the maximum\n value, then the value of this column will be the maximum value.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsCurrValidIntervals": { "type": "integer", "description": "This object indicates the number of intervals for which data\n was collected. The value of this column will be '96' unless the\n measurement was started (or restarted) within 1,440 minutes, in\n which case the value will be the number of complete 15-minute\n intervals for which the system has at least some data.\n \n In certain cases it is possible that some intervals are\n unavailable, in which case the value of this column will\n be maximum interval number for which data is available.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsCurrInvalidIntervals": { "type": "integer", "description": "This object indicates the number of intervals in the range\n from 0 to csubCurrValidIntervals for which no data is\n available. This object will typically be '0' except in certain\n circumstances when some intervals are unavailable.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsCurrFlowsUp": { "type": "integer", "description": "This object indicates the current number of differential traffic classes\n on subscriber sessions currently UP. IP ACLs are used to create differential flows\n (Traffic Classes).Each Traffic Class can have a different set of features applied.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsCurrCreatedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' created during the current\n 15-minute interval.", "x-yang-type": "perfhist-tc:PerfCurrentCount" }, "csubAggStatsCurrFailedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that were in the PENDING state\n and terminated for reasons other than disconnect during the\n current 15-minute interval.", "x-yang-type": "perfhist-tc:PerfCurrentCount" }, "csubAggStatsCurrUpSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned to the UP\n state during the current 15-minute interval.", "x-yang-type": "perfhist-tc:PerfCurrentCount" }, "csubAggStatsCurrAuthSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned from the\n UNAUTHENTICATED to the AUTHENTICATED state during the current\n 15-minute interval.", "x-yang-type": "perfhist-tc:PerfCurrentCount" }, "csubAggStatsCurrDiscSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n terminated due to a disconnect event during the current\n 15-minute interval.", "x-yang-type": "perfhist-tc:PerfCurrentCount" }, "csubAggStatsDiscontinuityTime": { "type": "string", "description": "The date and time (as determined by the system's clock) of\n the most recent occurrence of an event affecting the \n continuity of the aggregation statistics for this aggregation \n point.", "x-yang-type": "snmpv2-tc:DateAndTime" } } } } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubAggStatsTable": { "csubAggStatsEntry": [ { "csubAggStatsPointType": "ethernetCsmacd(6)", "csubAggStatsPoint": 0, "csubAggStatsSessionType": "ethernetCsmacd(6)", "csubAggStatsPendingSessions": 0, "csubAggStatsUpSessions": 0, "csubAggStatsAuthSessions": 0, "csubAggStatsUnAuthSessions": 0, "csubAggStatsLightWeightSessions": 0, "csubAggStatsRedSessions": 0, "csubAggStatsHighUpSessions": 0, "csubAggStatsAvgSessionUptime": 0, "csubAggStatsAvgSessionRPM": 0, "csubAggStatsAvgSessionRPH": 0, "csubAggStatsThrottleEngagements": 0, "csubAggStatsTotalCreatedSessions": 0, "csubAggStatsTotalFailedSessions": 0, "csubAggStatsTotalUpSessions": 0, "csubAggStatsTotalAuthSessions": 0, "csubAggStatsTotalDiscSessions": 0, "csubAggStatsTotalLightWeightSessions": 0, "csubAggStatsTotalFlowsUp": 0, "csubAggStatsDayCreatedSessions": "example-string", "csubAggStatsDayFailedSessions": "example-string", "csubAggStatsDayUpSessions": "example-string", "csubAggStatsDayAuthSessions": "example-string", "csubAggStatsDayDiscSessions": "example-string", "csubAggStatsCurrTimeElapsed": 0, "csubAggStatsCurrValidIntervals": 0, "csubAggStatsCurrInvalidIntervals": 0, "csubAggStatsCurrFlowsUp": 0, "csubAggStatsCurrCreatedSessions": "example-string", "csubAggStatsCurrFailedSessions": "example-string", "csubAggStatsCurrUpSessions": "example-string", "csubAggStatsCurrAuthSessions": "example-string", "csubAggStatsCurrDiscSessions": "example-string", "csubAggStatsDiscontinuityTime": "example-string" }, { "csubAggStatsPointType": "ethernetCsmacd(6)", "csubAggStatsPoint": 0, "csubAggStatsSessionType": "ethernetCsmacd(6)", "csubAggStatsPendingSessions": 0, "csubAggStatsUpSessions": 0, "csubAggStatsAuthSessions": 0, "csubAggStatsUnAuthSessions": 0, "csubAggStatsLightWeightSessions": 0, "csubAggStatsRedSessions": 0, "csubAggStatsHighUpSessions": 0, "csubAggStatsAvgSessionUptime": 0, "csubAggStatsAvgSessionRPM": 0, "csubAggStatsAvgSessionRPH": 0, "csubAggStatsThrottleEngagements": 0, "csubAggStatsTotalCreatedSessions": 0, "csubAggStatsTotalFailedSessions": 0, "csubAggStatsTotalUpSessions": 0, "csubAggStatsTotalAuthSessions": 0, "csubAggStatsTotalDiscSessions": 0, "csubAggStatsTotalLightWeightSessions": 0, "csubAggStatsTotalFlowsUp": 0, "csubAggStatsDayCreatedSessions": "example-string", "csubAggStatsDayFailedSessions": "example-string", "csubAggStatsDayUpSessions": "example-string", "csubAggStatsDayAuthSessions": "example-string", "csubAggStatsDayDiscSessions": "example-string", "csubAggStatsCurrTimeElapsed": 0, "csubAggStatsCurrValidIntervals": 0, "csubAggStatsCurrInvalidIntervals": 0, "csubAggStatsCurrFlowsUp": 0, "csubAggStatsCurrCreatedSessions": "example-string", "csubAggStatsCurrFailedSessions": "example-string", "csubAggStatsCurrUpSessions": "example-string", "csubAggStatsCurrAuthSessions": "example-string", "csubAggStatsCurrDiscSessions": "example-string", "csubAggStatsDiscontinuityTime": "example-string" }, { "csubAggStatsPointType": "ethernetCsmacd(6)", "csubAggStatsPoint": 0, "csubAggStatsSessionType": "ethernetCsmacd(6)", "csubAggStatsPendingSessions": 0, "csubAggStatsUpSessions": 0, "csubAggStatsAuthSessions": 0, "csubAggStatsUnAuthSessions": 0, "csubAggStatsLightWeightSessions": 0, "csubAggStatsRedSessions": 0, "csubAggStatsHighUpSessions": 0, "csubAggStatsAvgSessionUptime": 0, "csubAggStatsAvgSessionRPM": 0, "csubAggStatsAvgSessionRPH": 0, "csubAggStatsThrottleEngagements": 0, "csubAggStatsTotalCreatedSessions": 0, "csubAggStatsTotalFailedSessions": 0, "csubAggStatsTotalUpSessions": 0, "csubAggStatsTotalAuthSessions": 0, "csubAggStatsTotalDiscSessions": 0, "csubAggStatsTotalLightWeightSessions": 0, "csubAggStatsTotalFlowsUp": 0, "csubAggStatsDayCreatedSessions": "example-string", "csubAggStatsDayFailedSessions": "example-string", "csubAggStatsDayUpSessions": "example-string", "csubAggStatsDayAuthSessions": "example-string", "csubAggStatsDayDiscSessions": "example-string", "csubAggStatsCurrTimeElapsed": 0, "csubAggStatsCurrValidIntervals": 0, "csubAggStatsCurrInvalidIntervals": 0, "csubAggStatsCurrFlowsUp": 0, "csubAggStatsCurrCreatedSessions": "example-string", "csubAggStatsCurrFailedSessions": "example-string", "csubAggStatsCurrUpSessions": "example-string", "csubAggStatsCurrAuthSessions": "example-string", "csubAggStatsCurrDiscSessions": "example-string", "csubAggStatsDiscontinuityTime": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubAggStatsTable", "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": "/csubAggStatsTable", "x-restconf-kind": "container" }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubAggStatsTable/csubAggStatsEntry": { "get": { "summary": "Get csubAggStatsEntry list", "description": "Retrieve list of csubAggStatsEntry entries from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "csubAggStatsEntry", "items": { "type": "object", "properties": { "csubAggStatsPointType": { "type": "string", "description": "This object indicates format of the csubAggStatsPoint\n for this entry. \n \n The format for the csubAggStatsPoint is as follows: \n \n csubAggStatsPointType csubAggStatsPoint \n ---------------------- ------------------ \n 'physical' PhysicalIndex \n 'interface' InterfaceIndex" }, "csubAggStatsPoint": { "type": "integer", "description": "This object should be read with csubAggStatsPointType always.\n \n This object indicates one of the determining factors affecting \n the 'scope of aggregation' for the set of statistics contained \n by the row. \n \n The value indicated by this object should be interpreted as the \n identifier for the point type specific base table. \n \n For point types of 'physical', the type specific base table is \n the entPhysicalTable and this value is a PhysicalIndex. For \n point types of 'interface', the type specific base table is \n the ifTable and this value is an InterfaceIndex. \n \n If this column indicates a physical entity which has an \n entPhysicalClass of 'chassis', then the 'scope of aggregation' \n may includes those subscriber sessions maintained by all nodes \n contained by the system. \n \n If this column indicates a physical entity which has an \n entPhysicalClass of 'module' (e.g., a line card), then the \n 'scope of aggregation' may include those subscriber sessions \n maintained by the nodes contained by the module. \n \n If this column indicates a physical entity which has an \n entPhysicalClass of 'cpu', then the 'scope of aggregation' may \n include those subscriber sessions maintained by the node \n running on the processor. \n \n Aggregation points with entPhysicalTable / ifTable overlap: \n For interfaces which map directly to physical 'port' class \n entities in the entPhysicalTable, the preferred representation \n as aggregation points is the 'physical' point type and \n PhysicalIndex identifier.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsSessionType": { "type": "string", "description": "This object indicates one of the determining factors affecting\n the 'scope of aggregation' for the statistics contained by the\n row.\n \n If the value of this column is 'all', then the 'scope of\n aggregation' may include all subscriber sessions, regardless of\n type.\n \n If the value of this column is not 'all', then the 'scope of\n aggregation' may include subscriber sessions of the indicated\n subscriber session type.", "x-yang-type": "cisco-subscriber:SubSessionType" }, "csubAggStatsPendingSessions": { "type": "integer", "description": "This object indicates the current number of subscriber sessions\n within the 'scope of aggregation' that are in the PENDING\n state.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsUpSessions": { "type": "integer", "description": "This object indicates the current number of subscriber sessions\n within the 'scope of aggregation' that are in the UP state.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsAuthSessions": { "type": "integer", "description": "This object indicates the current number of subscriber session\n within the 'scope of aggregation' that have been authenticated.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsUnAuthSessions": { "type": "integer", "description": "This object indicates the current number of subscriber session\n within the 'scope of aggregation' that have not been authenticated.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsLightWeightSessions": { "type": "integer", "description": "This object indicates the current number of subscriber\n sessions within the 'scope of aggregation' that are less resource intensive.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsRedSessions": { "type": "integer", "description": "This object indicates the current number of subscriber sessions\n within the 'scope of aggregation' that are redundant (i.e., \n sessions with a csubSessionRedundancyMode of 'standby').", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsHighUpSessions": { "type": "integer", "description": "This object indicates the highest number of subscriber sessions\n within the 'scope of aggregation' observed simultaneously in the UP\n state since the last discontinuity time.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsAvgSessionUptime": { "type": "integer", "description": "This object indicates the average time subscriber sessions\n within the 'scope of aggregation' spent in the UP state.\n \n The system calculates this average over all subscriber\n sessions maintained by all nodes contained by the 'scope of\n aggregation' since the last discontinuity time.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsAvgSessionRPM": { "type": "integer", "description": "This object indicates the average rate (per minute) at which\n the nodes contained by the 'scope of aggregation' have\n established new subscriber sessions.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsAvgSessionRPH": { "type": "integer", "description": "This object indicates the average rate (per hour) at which the\n nodes contained by the 'scope of aggregation' have established new\n subscriber sessions.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsThrottleEngagements": { "type": "integer", "description": "This object indicates the number of times that nodes contained\n within the 'scope of aggregation' have engaged the subscriber\n session throttle since the last discontinuity time.\n \n The mechanics of a subscriber session throttle vary with\n subscriber session type and implementation. However, the\n general concept of the throttle prevents a node from having\n to deal with more than a configured number of requests to\n establish subscriber sessions from the same CPE within the a\n configured interval of time. When the number of requests\n exceeds the configured threshold within the configured interval,\n then the node processing the requests engages the throttle.\n Typically, when a node engages a throttle, it drops requests\n from the CPE for some period of time, after which the node\n disengages the throttle.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime.", "minimum": 0 }, "csubAggStatsTotalCreatedSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' created since the\n discontinuity time.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime.", "minimum": 0 }, "csubAggStatsTotalFailedSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that were in the PENDING state\n and terminated for reasons other than disconnect since the last\n discontinuity time.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime.", "minimum": 0 }, "csubAggStatsTotalUpSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned to the UP\n state since the last discontinuity time.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime", "minimum": 0 }, "csubAggStatsTotalAuthSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned from the\n UNAUTHENTICATED to the AUTHENTICATED state since the last\n discontinuity time.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime", "minimum": 0 }, "csubAggStatsTotalDiscSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n terminated due to a disconnect event since the last\n discontinuity time.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime", "minimum": 0 }, "csubAggStatsTotalLightWeightSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n that are less resource intensive", "minimum": 0 }, "csubAggStatsTotalFlowsUp": { "type": "integer", "description": "This object indicates the total number of differential traffic classes\n on subscriber sessions. IP ACLs are used to create differential flows(Traffic Classes). \n Each Traffic Class can have a different set of features applied.", "minimum": 0 }, "csubAggStatsDayCreatedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' created during the last 24\n hours.\n \n The system calculates the value of this column by summing the\n values of all instances of csubAggStatsIntCreatedSessions that\n expand this row and have a corresponding csubAggStatsIntValid of\n 'true'.", "x-yang-type": "perfhist-tc:PerfTotalCount" }, "csubAggStatsDayFailedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that were in the PENDING state\n and terminated for reasons other than disconnect during the\n last 24 hours.\n \n The system calculates the value of this column by summing the\n values of all instances of csubAggStatsIntFailedSessions that\n expand this row and have a corresponding csubAggStatsIntValid\n of 'true'.", "x-yang-type": "perfhist-tc:PerfTotalCount" }, "csubAggStatsDayUpSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned to the UP\n state during the last 24 hours.\n \n The system calculates the value of this column by summing the\n values of all instances of csubAggStatsIntUpSessions that\n expand this row and have a corresponding csubAggStatsIntValid\n of 'true'.", "x-yang-type": "perfhist-tc:PerfTotalCount" }, "csubAggStatsDayAuthSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned from the\n UNAUTHENTICATED to the AUTHENTICATED state during the last 24\n hours.\n \n The system calculates the value of this column by summing the\n values of all instances of csubAggStatsIntAuthSessions that\n expand this row and have a corresponding csubAggStatsIntValid of\n 'true'.", "x-yang-type": "perfhist-tc:PerfTotalCount" }, "csubAggStatsDayDiscSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n terminated due to a disconnect event during the last 24 hours.\n \n The system calculates the value of this column by summing the\n values of all instances of csubAggStatsIntDiscSessions that\n expand this row and have a corresponding csubAggStatsIntValid of\n 'true'.", "x-yang-type": "perfhist-tc:PerfTotalCount" }, "csubAggStatsCurrTimeElapsed": { "type": "integer", "description": "This object indicates the time that has elapsed since the\n beginning of the current 15-minute measurement interval. If,\n for some reason, such as an adjustment in the system's\n time-of-day clock, the current interval exceeds the maximum\n value, then the value of this column will be the maximum value.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsCurrValidIntervals": { "type": "integer", "description": "This object indicates the number of intervals for which data\n was collected. The value of this column will be '96' unless the\n measurement was started (or restarted) within 1,440 minutes, in\n which case the value will be the number of complete 15-minute\n intervals for which the system has at least some data.\n \n In certain cases it is possible that some intervals are\n unavailable, in which case the value of this column will\n be maximum interval number for which data is available.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsCurrInvalidIntervals": { "type": "integer", "description": "This object indicates the number of intervals in the range\n from 0 to csubCurrValidIntervals for which no data is\n available. This object will typically be '0' except in certain\n circumstances when some intervals are unavailable.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsCurrFlowsUp": { "type": "integer", "description": "This object indicates the current number of differential traffic classes\n on subscriber sessions currently UP. IP ACLs are used to create differential flows\n (Traffic Classes).Each Traffic Class can have a different set of features applied.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsCurrCreatedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' created during the current\n 15-minute interval.", "x-yang-type": "perfhist-tc:PerfCurrentCount" }, "csubAggStatsCurrFailedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that were in the PENDING state\n and terminated for reasons other than disconnect during the\n current 15-minute interval.", "x-yang-type": "perfhist-tc:PerfCurrentCount" }, "csubAggStatsCurrUpSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned to the UP\n state during the current 15-minute interval.", "x-yang-type": "perfhist-tc:PerfCurrentCount" }, "csubAggStatsCurrAuthSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned from the\n UNAUTHENTICATED to the AUTHENTICATED state during the current\n 15-minute interval.", "x-yang-type": "perfhist-tc:PerfCurrentCount" }, "csubAggStatsCurrDiscSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n terminated due to a disconnect event during the current\n 15-minute interval.", "x-yang-type": "perfhist-tc:PerfCurrentCount" }, "csubAggStatsDiscontinuityTime": { "type": "string", "description": "The date and time (as determined by the system's clock) of\n the most recent occurrence of an event affecting the \n continuity of the aggregation statistics for this aggregation \n point.", "x-yang-type": "snmpv2-tc:DateAndTime" } } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubAggStatsEntry": [ { "csubAggStatsPointType": "ethernetCsmacd(6)", "csubAggStatsPoint": 0, "csubAggStatsSessionType": "ethernetCsmacd(6)", "csubAggStatsPendingSessions": 0, "csubAggStatsUpSessions": 0, "csubAggStatsAuthSessions": 0, "csubAggStatsUnAuthSessions": 0, "csubAggStatsLightWeightSessions": 0, "csubAggStatsRedSessions": 0, "csubAggStatsHighUpSessions": 0, "csubAggStatsAvgSessionUptime": 0, "csubAggStatsAvgSessionRPM": 0, "csubAggStatsAvgSessionRPH": 0, "csubAggStatsThrottleEngagements": 0, "csubAggStatsTotalCreatedSessions": 0, "csubAggStatsTotalFailedSessions": 0, "csubAggStatsTotalUpSessions": 0, "csubAggStatsTotalAuthSessions": 0, "csubAggStatsTotalDiscSessions": 0, "csubAggStatsTotalLightWeightSessions": 0, "csubAggStatsTotalFlowsUp": 0, "csubAggStatsDayCreatedSessions": "example-string", "csubAggStatsDayFailedSessions": "example-string", "csubAggStatsDayUpSessions": "example-string", "csubAggStatsDayAuthSessions": "example-string", "csubAggStatsDayDiscSessions": "example-string", "csubAggStatsCurrTimeElapsed": 0, "csubAggStatsCurrValidIntervals": 0, "csubAggStatsCurrInvalidIntervals": 0, "csubAggStatsCurrFlowsUp": 0, "csubAggStatsCurrCreatedSessions": "example-string", "csubAggStatsCurrFailedSessions": "example-string", "csubAggStatsCurrUpSessions": "example-string", "csubAggStatsCurrAuthSessions": "example-string", "csubAggStatsCurrDiscSessions": "example-string", "csubAggStatsDiscontinuityTime": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubAggStatsEntry", "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": "/csubAggStatsTable/csubAggStatsEntry", "x-restconf-kind": "container" }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubAggStatsIntTable": { "get": { "summary": "Get csubAggStatsIntTable data", "description": "Retrieve csubAggStatsIntTable operational data from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "csubAggStatsIntTable", "properties": { "csubAggStatsIntEntry": { "type": "array", "description": "An entry contains the aggregated subscriber session performance\n data collected over a single 15-minute measurement interval\n within a 'scope of aggregation'. For further details regarding\n 'scope of aggregation', see the descriptive text associated with\n the csubAggStatsEntry.", "items": { "type": "object", "properties": { "csubAggStatsPointType": { "type": "string", "description": "csubAggStatsPointType", "x-yang-type": "leafref" }, "csubAggStatsPoint": { "type": "string", "description": "csubAggStatsPoint", "x-yang-type": "leafref" }, "csubAggStatsSessionType": { "type": "string", "description": "csubAggStatsSessionType", "x-yang-type": "leafref" }, "csubAggStatsIntNumber": { "type": "integer", "description": "This object indicates the interval number identifying the\n 15-minute measurement interval for which aggregated subscriber\n session performance data was successfully collected by the\n system.\n \n The interval identified by the value '1' represents the most\n recent 15-minute measurement interval, and the interval\n identified by the value (n) represents the interval immediately\n preceding the interval identified by the value (n-1).", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsIntValid": { "type": "boolean", "description": "This object indicates whether the data for the 15-minute\n measurement interval is valid." }, "csubAggStatsIntCreatedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' created during the 15-minute\n measurement interval.", "x-yang-type": "perfhist-tc:PerfIntervalCount" }, "csubAggStatsIntFailedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that were in the PENDING state\n and terminated for reasons other than disconnect during the\n 15-minute measurement interval.", "x-yang-type": "perfhist-tc:PerfIntervalCount" }, "csubAggStatsIntUpSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned to the UP\n state during the 15-minute measurement interval.", "x-yang-type": "perfhist-tc:PerfIntervalCount" }, "csubAggStatsIntAuthSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned from the\n UNAUTHENTICATED to the AUTHENTICATED state during the\n 15-minute measurement interval.", "x-yang-type": "perfhist-tc:PerfIntervalCount" }, "csubAggStatsIntDiscSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n terminated due to a disconnect event during the 15-minute\n measurement interval.", "x-yang-type": "perfhist-tc:PerfIntervalCount" } } } } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubAggStatsIntTable": { "csubAggStatsIntEntry": [ { "csubAggStatsPointType": "ethernetCsmacd(6)", "csubAggStatsPoint": "example-string", "csubAggStatsSessionType": "ethernetCsmacd(6)", "csubAggStatsIntNumber": 0, "csubAggStatsIntValid": true, "csubAggStatsIntCreatedSessions": "example-string", "csubAggStatsIntFailedSessions": "example-string", "csubAggStatsIntUpSessions": "example-string", "csubAggStatsIntAuthSessions": "example-string", "csubAggStatsIntDiscSessions": "example-string" }, { "csubAggStatsPointType": "ethernetCsmacd(6)", "csubAggStatsPoint": "example-string", "csubAggStatsSessionType": "ethernetCsmacd(6)", "csubAggStatsIntNumber": 0, "csubAggStatsIntValid": true, "csubAggStatsIntCreatedSessions": "example-string", "csubAggStatsIntFailedSessions": "example-string", "csubAggStatsIntUpSessions": "example-string", "csubAggStatsIntAuthSessions": "example-string", "csubAggStatsIntDiscSessions": "example-string" }, { "csubAggStatsPointType": "ethernetCsmacd(6)", "csubAggStatsPoint": "example-string", "csubAggStatsSessionType": "ethernetCsmacd(6)", "csubAggStatsIntNumber": 0, "csubAggStatsIntValid": true, "csubAggStatsIntCreatedSessions": "example-string", "csubAggStatsIntFailedSessions": "example-string", "csubAggStatsIntUpSessions": "example-string", "csubAggStatsIntAuthSessions": "example-string", "csubAggStatsIntDiscSessions": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubAggStatsIntTable", "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": "/csubAggStatsIntTable", "x-restconf-kind": "container" }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubAggStatsIntTable/csubAggStatsIntEntry": { "get": { "summary": "Get csubAggStatsIntEntry list", "description": "Retrieve list of csubAggStatsIntEntry entries from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry contains the aggregated subscriber session performance\n data collected over a single 15-minute measurement interval\n within a 'scope of aggregation'. For further details regarding\n 'scope of aggregation', see the descriptive text associated with\n the csubAggStatsEntry.", "items": { "type": "object", "properties": { "csubAggStatsPointType": { "type": "string", "description": "csubAggStatsPointType", "x-yang-type": "leafref" }, "csubAggStatsPoint": { "type": "string", "description": "csubAggStatsPoint", "x-yang-type": "leafref" }, "csubAggStatsSessionType": { "type": "string", "description": "csubAggStatsSessionType", "x-yang-type": "leafref" }, "csubAggStatsIntNumber": { "type": "integer", "description": "This object indicates the interval number identifying the\n 15-minute measurement interval for which aggregated subscriber\n session performance data was successfully collected by the\n system.\n \n The interval identified by the value '1' represents the most\n recent 15-minute measurement interval, and the interval\n identified by the value (n) represents the interval immediately\n preceding the interval identified by the value (n-1).", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsIntValid": { "type": "boolean", "description": "This object indicates whether the data for the 15-minute\n measurement interval is valid." }, "csubAggStatsIntCreatedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' created during the 15-minute\n measurement interval.", "x-yang-type": "perfhist-tc:PerfIntervalCount" }, "csubAggStatsIntFailedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that were in the PENDING state\n and terminated for reasons other than disconnect during the\n 15-minute measurement interval.", "x-yang-type": "perfhist-tc:PerfIntervalCount" }, "csubAggStatsIntUpSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned to the UP\n state during the 15-minute measurement interval.", "x-yang-type": "perfhist-tc:PerfIntervalCount" }, "csubAggStatsIntAuthSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned from the\n UNAUTHENTICATED to the AUTHENTICATED state during the\n 15-minute measurement interval.", "x-yang-type": "perfhist-tc:PerfIntervalCount" }, "csubAggStatsIntDiscSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n terminated due to a disconnect event during the 15-minute\n measurement interval.", "x-yang-type": "perfhist-tc:PerfIntervalCount" } } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubAggStatsIntEntry": [ { "csubAggStatsPointType": "ethernetCsmacd(6)", "csubAggStatsPoint": "example-string", "csubAggStatsSessionType": "ethernetCsmacd(6)", "csubAggStatsIntNumber": 0, "csubAggStatsIntValid": true, "csubAggStatsIntCreatedSessions": "example-string", "csubAggStatsIntFailedSessions": "example-string", "csubAggStatsIntUpSessions": "example-string", "csubAggStatsIntAuthSessions": "example-string", "csubAggStatsIntDiscSessions": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubAggStatsIntEntry", "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": "/csubAggStatsIntTable/csubAggStatsIntEntry", "x-restconf-kind": "container" }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubAggStatsThreshTable": { "get": { "summary": "Get csubAggStatsThreshTable data", "description": "Retrieve csubAggStatsThreshTable operational data from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "Please enter the Table Description here.", "properties": { "csubAggStatsThreshEntry": { "type": "array", "description": "A row in this table exists for each row in the\n csubAggStatsTable.\n Each row defines the set of thresholds and evaluation attributes\n for an aggregation point.", "items": { "type": "object", "properties": { "csubSessionRisingThresh": { "type": "integer", "description": "This threshold, if non-zero, indicates the rising threshold\n for the value of csubAggStatsUpSessions for the aggregation\n point,\n When the current sample of csubAggStatsUpSessions is greater\n than\n or equal to this threshold, and the value of\n csubAggStatsUpSessions\n for the last sample interval was less than this thershold, the\n csubSessionRisingNotif is triggered.\n \n If the value of this threshold is 0, the threshold is\n not evaluated.", "minimum": 0, "maximum": 4294967295 }, "csubSessionFallingThresh": { "type": "integer", "description": "This threshold, if non-zero, indicates the falling threshold\n for the value of csubAggStatsUpSessions for the aggregation\n point,\n When the current sample of csubAggStatsUpSessions is less than\n or equal to this threshold, and the value of\n csubAggStatsUpSessions\n for the last sample interval was greater than this thershold,\n the\n csubSessionFallingNotif is triggered.\n \n If the value of this threshold is 0, the threshold is\n not evaluated.", "minimum": 0, "maximum": 4294967295 }, "csubSessionDeltaPercentFallingThresh": { "type": "integer", "description": "This threshold, if non-zero, indicates the delta falling\n threshold\n as a percentage of the value of csubAggStatsUpSessions for the\n aggregation point, The delta as a percentage of\n csubAggStatsUpSessions (delta_percent) is calculated as\n follows:\n current value of csubAggStatsUpSessions = value(n)\n previous sampled value of csubAggStatsUpSessions =\n value(n-1)\n \n delta_percent = ((value(n-1) - value(n)) /\n value(n-1)) * 100\n \n If the delta_percent value of the current evaluation\n interval is\n greater than the value of this threshold, a\n csubSessionDeltaPercentLossNotif is triggered.\n \n If the value of this threshold is 0, the threshold is\n not evaluated.", "minimum": 0, "maximum": 4294967295 }, "csubSessionThreshEvalInterval": { "type": "integer", "description": "The value of this object sets the number of seconds between\n samples\n for threshold evaluation. For implementations capable of\n per-session event evaluation of thresholds this object\n represents the maximum number of seconds between samples.", "minimum": 0, "maximum": 4294967295 } } } } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubAggStatsThreshTable": { "csubAggStatsThreshEntry": [ { "csubSessionRisingThresh": 0, "csubSessionFallingThresh": 0, "csubSessionDeltaPercentFallingThresh": 0, "csubSessionThreshEvalInterval": 0 }, { "csubSessionRisingThresh": 0, "csubSessionFallingThresh": 0, "csubSessionDeltaPercentFallingThresh": 0, "csubSessionThreshEvalInterval": 0 }, { "csubSessionRisingThresh": 0, "csubSessionFallingThresh": 0, "csubSessionDeltaPercentFallingThresh": 0, "csubSessionThreshEvalInterval": 0 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubAggStatsThreshTable", "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": "/csubAggStatsThreshTable", "x-restconf-kind": "container" }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubAggStatsThreshTable/csubAggStatsThreshEntry": { "get": { "summary": "Get csubAggStatsThreshEntry list", "description": "Retrieve list of csubAggStatsThreshEntry entries from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A row in this table exists for each row in the\n csubAggStatsTable.\n Each row defines the set of thresholds and evaluation attributes\n for an aggregation point.", "items": { "type": "object", "properties": { "csubSessionRisingThresh": { "type": "integer", "description": "This threshold, if non-zero, indicates the rising threshold\n for the value of csubAggStatsUpSessions for the aggregation\n point,\n When the current sample of csubAggStatsUpSessions is greater\n than\n or equal to this threshold, and the value of\n csubAggStatsUpSessions\n for the last sample interval was less than this thershold, the\n csubSessionRisingNotif is triggered.\n \n If the value of this threshold is 0, the threshold is\n not evaluated.", "minimum": 0, "maximum": 4294967295 }, "csubSessionFallingThresh": { "type": "integer", "description": "This threshold, if non-zero, indicates the falling threshold\n for the value of csubAggStatsUpSessions for the aggregation\n point,\n When the current sample of csubAggStatsUpSessions is less than\n or equal to this threshold, and the value of\n csubAggStatsUpSessions\n for the last sample interval was greater than this thershold,\n the\n csubSessionFallingNotif is triggered.\n \n If the value of this threshold is 0, the threshold is\n not evaluated.", "minimum": 0, "maximum": 4294967295 }, "csubSessionDeltaPercentFallingThresh": { "type": "integer", "description": "This threshold, if non-zero, indicates the delta falling\n threshold\n as a percentage of the value of csubAggStatsUpSessions for the\n aggregation point, The delta as a percentage of\n csubAggStatsUpSessions (delta_percent) is calculated as\n follows:\n current value of csubAggStatsUpSessions = value(n)\n previous sampled value of csubAggStatsUpSessions =\n value(n-1)\n \n delta_percent = ((value(n-1) - value(n)) /\n value(n-1)) * 100\n \n If the delta_percent value of the current evaluation\n interval is\n greater than the value of this threshold, a\n csubSessionDeltaPercentLossNotif is triggered.\n \n If the value of this threshold is 0, the threshold is\n not evaluated.", "minimum": 0, "maximum": 4294967295 }, "csubSessionThreshEvalInterval": { "type": "integer", "description": "The value of this object sets the number of seconds between\n samples\n for threshold evaluation. For implementations capable of\n per-session event evaluation of thresholds this object\n represents the maximum number of seconds between samples.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubAggStatsThreshEntry": [ { "csubSessionRisingThresh": 0, "csubSessionFallingThresh": 0, "csubSessionDeltaPercentFallingThresh": 0, "csubSessionThreshEvalInterval": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubAggStatsThreshEntry", "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": "/csubAggStatsThreshTable/csubAggStatsThreshEntry", "x-restconf-kind": "container" }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubAggStatsThreshTable/csubAggStatsThreshEntry={csubSessionRisingThresh}": { "get": { "summary": "Get csubAggStatsThreshEntry entry", "description": "Retrieve specific csubAggStatsThreshEntry entry by key from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "parameters": [ { "name": "csubSessionRisingThresh", "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": { "csubSessionRisingThresh": { "type": "integer", "description": "This threshold, if non-zero, indicates the rising threshold\n for the value of csubAggStatsUpSessions for the aggregation\n point,\n When the current sample of csubAggStatsUpSessions is greater\n than\n or equal to this threshold, and the value of\n csubAggStatsUpSessions\n for the last sample interval was less than this thershold, the\n csubSessionRisingNotif is triggered.\n \n If the value of this threshold is 0, the threshold is\n not evaluated.", "minimum": 0, "maximum": 4294967295 }, "csubSessionFallingThresh": { "type": "integer", "description": "This threshold, if non-zero, indicates the falling threshold\n for the value of csubAggStatsUpSessions for the aggregation\n point,\n When the current sample of csubAggStatsUpSessions is less than\n or equal to this threshold, and the value of\n csubAggStatsUpSessions\n for the last sample interval was greater than this thershold,\n the\n csubSessionFallingNotif is triggered.\n \n If the value of this threshold is 0, the threshold is\n not evaluated.", "minimum": 0, "maximum": 4294967295 }, "csubSessionDeltaPercentFallingThresh": { "type": "integer", "description": "This threshold, if non-zero, indicates the delta falling\n threshold\n as a percentage of the value of csubAggStatsUpSessions for the\n aggregation point, The delta as a percentage of\n csubAggStatsUpSessions (delta_percent) is calculated as\n follows:\n current value of csubAggStatsUpSessions = value(n)\n previous sampled value of csubAggStatsUpSessions =\n value(n-1)\n \n delta_percent = ((value(n-1) - value(n)) /\n value(n-1)) * 100\n \n If the delta_percent value of the current evaluation\n interval is\n greater than the value of this threshold, a\n csubSessionDeltaPercentLossNotif is triggered.\n \n If the value of this threshold is 0, the threshold is\n not evaluated.", "minimum": 0, "maximum": 4294967295 }, "csubSessionThreshEvalInterval": { "type": "integer", "description": "The value of this object sets the number of seconds between\n samples\n for threshold evaluation. For implementations capable of\n per-session event evaluation of thresholds this object\n represents the maximum number of seconds between samples.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubAggStatsThreshEntry": { "csubSessionRisingThresh": 0, "csubSessionFallingThresh": 0, "csubSessionDeltaPercentFallingThresh": 0, "csubSessionThreshEvalInterval": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubAggStatsThreshEntry-2" }, "x-yang-path": "/csubAggStatsThreshTable/csubAggStatsThreshEntry={csubSessionRisingThresh}", "x-restconf-kind": "list-instance", "x-list-keys": [ "csubSessionRisingThresh" ] }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubJobTable": { "get": { "summary": "Get csubJobTable data", "description": "Retrieve csubJobTable operational data from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table contains the subscriber session jobs submitted by\n the EMS/NMS.", "properties": { "csubJobEntry": { "type": "array", "description": "csubJobEntry", "items": { "type": "object", "properties": { "csubJobId": { "type": "string", "description": "This object indicates an arbitrary, positive integer-value\n uniquely identifying the subscriber session job.", "x-yang-type": "CISCO-SUBSCRIBER-SESSION-MIB:SubscriberJobIdentifier" }, "csubJobStatus": { "type": "string", "description": "This object specifies the status of the subscriber session\n job. The following columns must be valid before activating a\n subscriber session job:\n \n - csubJobStorage\n - csubJobType\n - csubJobControl\n \n However, these objects specify a default value. Thus, it is\n possible to use create-and-go semantics without setting any\n additional columns.\n \n An implementation must allow the EMS/NMS to modify any column\n when this column is 'active', including columns defined in\n tables that have a one-to-one or sparse dependent relationship\n on this table.", "x-yang-type": "snmpv2-tc:RowStatus" }, "csubJobStorage": { "type": "string", "description": "This object specifies what happens to the subscriber session\n job upon restart.", "x-yang-type": "snmpv2-tc:StorageType" }, "csubJobType": { "type": "string", "description": "This object specifies the type of subscriber session job:\n \n 'noop'\n This type of job does nothing and simply serves as a\n convenient default value for newly created jobs, thereby\n allowing create-and-go row creation without having to\n specify the type of job.\n \n 'query'\n This type of job starts a subscriber session query. The\n system searches for any subscriber sessions matching the\n configured criteria and sorts them into a resulting\n report.\n \n Upon activation of a subscriber session with this value,\n the system automatically creates corresponding rows in\n the csubJobMatchParamsTable and csubQueryParamsTable.\n \n 'clear'\n This type of job causes the system to terminated all\n subscriber sessions matching configured criteria.\n \n Upon activation of a subscriber session with this value,\n the system automatically creates a corresponding row in\n the csubJobMatchParamsTable." }, "csubJobControl": { "type": "string", "description": "This object specifies an action relating to the subscriber\n session job:\n \n 'noop'\n This action does nothing.\n \n 'start'\n If the corresponding instance of csubJobType is 'noop',\n then this action simply causes the system to set the\n corresponding instances of csubJobState and\n csubJobFinishedReason to 'finished' and 'normal',\n respectively.\n \n If the corresponding instance of csubJobType is not\n 'noop' and the system is not executing a subscriber\n session job, then this action causes the system\n immediately execute the subscriber session job.\n \n If the corresponding instance of csubJobType is not\n 'noop' and the system is already executing a subscriber\n session job, then this action causes the system to put\n the job on the subscriber session job queue.\n \n 'abort'\n If the subscriber session job is in the subscriber\n session job queue, then this action causes the system to\n remove the job from the queue.\n \n If the system is executing the subscriber session job,\n then this action causes the system to stop the job.\n \n 'release'\n This action causes the system to destroy any\n corresponding rows in the csubJobReportTable.\n \n The system only accepts this action for a previously\n executed subscriber session job having a corresponding\n instance of csubJobType set to 'query'. Any attempt to\n issue this action under other circumstances will result\n in a response indicating an error-status of\n 'inconsistentValue'.\n \n When read, this column is always 'noop'." }, "csubJobState": { "type": "string", "description": "This object indicates the current state of the subscriber\n session job:\n \n 'idle'\n This state indicates that the system has not executed\n the subscriber session job since it was created.\n \n 'pending'\n This state indicates that the subscriber session job is\n waiting in the subscriber session job queue.\n \n 'inProgress'\n This state indicates that the system is executing the\n subscriber session job. Observe that the system may\n execute more than one subscriber session job at a time.\n \n 'finished'\n This state indicates that the system has executed the\n subscriber session job and it has finished. The\n corresponding instance of csubJobFinishedReason\n indicates further details regarding the reason why the\n job finished." }, "csubJobStartedTime": { "type": "string", "description": "This object indicates the value of sysUpTime when the system\n started executing the subscriber session job. This value will\n be '0' when the corresponding instance of csubJobState is 'idle'\n or 'pending'.", "x-yang-type": "yang:timestamp" }, "csubJobFinishedTime": { "type": "string", "description": "This object indicates the value of sysUpTime when the system\n finished executing the subscriber session job, for whatever\n reason. This value will be '0' when the corresponding instance\n of csubJobState is 'idle', 'pending', or 'inProgress'.", "x-yang-type": "yang:timestamp" }, "csubJobFinishedReason": { "type": "string", "description": "This object indicates the reason why the system finished\n executing the subscriber session job:\n \n 'invalid'\n Indicates that the corresponding instance of\n csubJobState is either 'idle', 'pending', or\n 'inProgress'.\n \n 'other'\n Indicates that the system finished executing the\n subscriber session job abnormally for a reason not\n recognized by this MIB module.\n \n 'normal'\n Indicates that the system finished executing the\n subscriber session job with no problems.\n \n 'aborted'\n Indicates that the system finished executing the\n subscriber session job as the result of the EMS/NMS\n writing 'abort' to the corresponding instance of\n csubJobControl.\n \n 'insufficientResources'\n Indicates that the system finished executing the\n subscriber session job abnormally due to insufficient\n resources to continue.\n \n 'error'\n Indicates that the system encountered an error that\n prevented it from completing the job." } } } } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubJobTable": { "csubJobEntry": [ { "csubJobId": "example-string", "csubJobStatus": "up(1)", "csubJobStorage": "example-string", "csubJobType": "ethernetCsmacd(6)", "csubJobControl": "example-string", "csubJobState": "up(1)", "csubJobStartedTime": "example-string", "csubJobFinishedTime": "example-string", "csubJobFinishedReason": "example-string" }, { "csubJobId": "example-string", "csubJobStatus": "up(1)", "csubJobStorage": "example-string", "csubJobType": "ethernetCsmacd(6)", "csubJobControl": "example-string", "csubJobState": "up(1)", "csubJobStartedTime": "example-string", "csubJobFinishedTime": "example-string", "csubJobFinishedReason": "example-string" }, { "csubJobId": "example-string", "csubJobStatus": "up(1)", "csubJobStorage": "example-string", "csubJobType": "ethernetCsmacd(6)", "csubJobControl": "example-string", "csubJobState": "up(1)", "csubJobStartedTime": "example-string", "csubJobFinishedTime": "example-string", "csubJobFinishedReason": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubJobTable", "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": "/csubJobTable", "x-restconf-kind": "container" }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubJobTable/csubJobEntry": { "get": { "summary": "Get csubJobEntry list", "description": "Retrieve list of csubJobEntry entries from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "csubJobEntry", "items": { "type": "object", "properties": { "csubJobId": { "type": "string", "description": "This object indicates an arbitrary, positive integer-value\n uniquely identifying the subscriber session job.", "x-yang-type": "CISCO-SUBSCRIBER-SESSION-MIB:SubscriberJobIdentifier" }, "csubJobStatus": { "type": "string", "description": "This object specifies the status of the subscriber session\n job. The following columns must be valid before activating a\n subscriber session job:\n \n - csubJobStorage\n - csubJobType\n - csubJobControl\n \n However, these objects specify a default value. Thus, it is\n possible to use create-and-go semantics without setting any\n additional columns.\n \n An implementation must allow the EMS/NMS to modify any column\n when this column is 'active', including columns defined in\n tables that have a one-to-one or sparse dependent relationship\n on this table.", "x-yang-type": "snmpv2-tc:RowStatus" }, "csubJobStorage": { "type": "string", "description": "This object specifies what happens to the subscriber session\n job upon restart.", "x-yang-type": "snmpv2-tc:StorageType" }, "csubJobType": { "type": "string", "description": "This object specifies the type of subscriber session job:\n \n 'noop'\n This type of job does nothing and simply serves as a\n convenient default value for newly created jobs, thereby\n allowing create-and-go row creation without having to\n specify the type of job.\n \n 'query'\n This type of job starts a subscriber session query. The\n system searches for any subscriber sessions matching the\n configured criteria and sorts them into a resulting\n report.\n \n Upon activation of a subscriber session with this value,\n the system automatically creates corresponding rows in\n the csubJobMatchParamsTable and csubQueryParamsTable.\n \n 'clear'\n This type of job causes the system to terminated all\n subscriber sessions matching configured criteria.\n \n Upon activation of a subscriber session with this value,\n the system automatically creates a corresponding row in\n the csubJobMatchParamsTable." }, "csubJobControl": { "type": "string", "description": "This object specifies an action relating to the subscriber\n session job:\n \n 'noop'\n This action does nothing.\n \n 'start'\n If the corresponding instance of csubJobType is 'noop',\n then this action simply causes the system to set the\n corresponding instances of csubJobState and\n csubJobFinishedReason to 'finished' and 'normal',\n respectively.\n \n If the corresponding instance of csubJobType is not\n 'noop' and the system is not executing a subscriber\n session job, then this action causes the system\n immediately execute the subscriber session job.\n \n If the corresponding instance of csubJobType is not\n 'noop' and the system is already executing a subscriber\n session job, then this action causes the system to put\n the job on the subscriber session job queue.\n \n 'abort'\n If the subscriber session job is in the subscriber\n session job queue, then this action causes the system to\n remove the job from the queue.\n \n If the system is executing the subscriber session job,\n then this action causes the system to stop the job.\n \n 'release'\n This action causes the system to destroy any\n corresponding rows in the csubJobReportTable.\n \n The system only accepts this action for a previously\n executed subscriber session job having a corresponding\n instance of csubJobType set to 'query'. Any attempt to\n issue this action under other circumstances will result\n in a response indicating an error-status of\n 'inconsistentValue'.\n \n When read, this column is always 'noop'." }, "csubJobState": { "type": "string", "description": "This object indicates the current state of the subscriber\n session job:\n \n 'idle'\n This state indicates that the system has not executed\n the subscriber session job since it was created.\n \n 'pending'\n This state indicates that the subscriber session job is\n waiting in the subscriber session job queue.\n \n 'inProgress'\n This state indicates that the system is executing the\n subscriber session job. Observe that the system may\n execute more than one subscriber session job at a time.\n \n 'finished'\n This state indicates that the system has executed the\n subscriber session job and it has finished. The\n corresponding instance of csubJobFinishedReason\n indicates further details regarding the reason why the\n job finished." }, "csubJobStartedTime": { "type": "string", "description": "This object indicates the value of sysUpTime when the system\n started executing the subscriber session job. This value will\n be '0' when the corresponding instance of csubJobState is 'idle'\n or 'pending'.", "x-yang-type": "yang:timestamp" }, "csubJobFinishedTime": { "type": "string", "description": "This object indicates the value of sysUpTime when the system\n finished executing the subscriber session job, for whatever\n reason. This value will be '0' when the corresponding instance\n of csubJobState is 'idle', 'pending', or 'inProgress'.", "x-yang-type": "yang:timestamp" }, "csubJobFinishedReason": { "type": "string", "description": "This object indicates the reason why the system finished\n executing the subscriber session job:\n \n 'invalid'\n Indicates that the corresponding instance of\n csubJobState is either 'idle', 'pending', or\n 'inProgress'.\n \n 'other'\n Indicates that the system finished executing the\n subscriber session job abnormally for a reason not\n recognized by this MIB module.\n \n 'normal'\n Indicates that the system finished executing the\n subscriber session job with no problems.\n \n 'aborted'\n Indicates that the system finished executing the\n subscriber session job as the result of the EMS/NMS\n writing 'abort' to the corresponding instance of\n csubJobControl.\n \n 'insufficientResources'\n Indicates that the system finished executing the\n subscriber session job abnormally due to insufficient\n resources to continue.\n \n 'error'\n Indicates that the system encountered an error that\n prevented it from completing the job." } } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubJobEntry": [ { "csubJobId": "example-string", "csubJobStatus": "up(1)", "csubJobStorage": "example-string", "csubJobType": "ethernetCsmacd(6)", "csubJobControl": "example-string", "csubJobState": "up(1)", "csubJobStartedTime": "example-string", "csubJobFinishedTime": "example-string", "csubJobFinishedReason": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubJobEntry", "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": "/csubJobTable/csubJobEntry", "x-restconf-kind": "container" }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubJobTable/csubJobEntry={csubJobId}": { "get": { "summary": "Get csubJobEntry entry", "description": "Retrieve specific csubJobEntry entry by key from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "parameters": [ { "name": "csubJobId", "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": { "csubJobId": { "type": "string", "description": "This object indicates an arbitrary, positive integer-value\n uniquely identifying the subscriber session job.", "x-yang-type": "CISCO-SUBSCRIBER-SESSION-MIB:SubscriberJobIdentifier" }, "csubJobStatus": { "type": "string", "description": "This object specifies the status of the subscriber session\n job. The following columns must be valid before activating a\n subscriber session job:\n \n - csubJobStorage\n - csubJobType\n - csubJobControl\n \n However, these objects specify a default value. Thus, it is\n possible to use create-and-go semantics without setting any\n additional columns.\n \n An implementation must allow the EMS/NMS to modify any column\n when this column is 'active', including columns defined in\n tables that have a one-to-one or sparse dependent relationship\n on this table.", "x-yang-type": "snmpv2-tc:RowStatus" }, "csubJobStorage": { "type": "string", "description": "This object specifies what happens to the subscriber session\n job upon restart.", "x-yang-type": "snmpv2-tc:StorageType" }, "csubJobType": { "type": "string", "description": "This object specifies the type of subscriber session job:\n \n 'noop'\n This type of job does nothing and simply serves as a\n convenient default value for newly created jobs, thereby\n allowing create-and-go row creation without having to\n specify the type of job.\n \n 'query'\n This type of job starts a subscriber session query. The\n system searches for any subscriber sessions matching the\n configured criteria and sorts them into a resulting\n report.\n \n Upon activation of a subscriber session with this value,\n the system automatically creates corresponding rows in\n the csubJobMatchParamsTable and csubQueryParamsTable.\n \n 'clear'\n This type of job causes the system to terminated all\n subscriber sessions matching configured criteria.\n \n Upon activation of a subscriber session with this value,\n the system automatically creates a corresponding row in\n the csubJobMatchParamsTable." }, "csubJobControl": { "type": "string", "description": "This object specifies an action relating to the subscriber\n session job:\n \n 'noop'\n This action does nothing.\n \n 'start'\n If the corresponding instance of csubJobType is 'noop',\n then this action simply causes the system to set the\n corresponding instances of csubJobState and\n csubJobFinishedReason to 'finished' and 'normal',\n respectively.\n \n If the corresponding instance of csubJobType is not\n 'noop' and the system is not executing a subscriber\n session job, then this action causes the system\n immediately execute the subscriber session job.\n \n If the corresponding instance of csubJobType is not\n 'noop' and the system is already executing a subscriber\n session job, then this action causes the system to put\n the job on the subscriber session job queue.\n \n 'abort'\n If the subscriber session job is in the subscriber\n session job queue, then this action causes the system to\n remove the job from the queue.\n \n If the system is executing the subscriber session job,\n then this action causes the system to stop the job.\n \n 'release'\n This action causes the system to destroy any\n corresponding rows in the csubJobReportTable.\n \n The system only accepts this action for a previously\n executed subscriber session job having a corresponding\n instance of csubJobType set to 'query'. Any attempt to\n issue this action under other circumstances will result\n in a response indicating an error-status of\n 'inconsistentValue'.\n \n When read, this column is always 'noop'." }, "csubJobState": { "type": "string", "description": "This object indicates the current state of the subscriber\n session job:\n \n 'idle'\n This state indicates that the system has not executed\n the subscriber session job since it was created.\n \n 'pending'\n This state indicates that the subscriber session job is\n waiting in the subscriber session job queue.\n \n 'inProgress'\n This state indicates that the system is executing the\n subscriber session job. Observe that the system may\n execute more than one subscriber session job at a time.\n \n 'finished'\n This state indicates that the system has executed the\n subscriber session job and it has finished. The\n corresponding instance of csubJobFinishedReason\n indicates further details regarding the reason why the\n job finished." }, "csubJobStartedTime": { "type": "string", "description": "This object indicates the value of sysUpTime when the system\n started executing the subscriber session job. This value will\n be '0' when the corresponding instance of csubJobState is 'idle'\n or 'pending'.", "x-yang-type": "yang:timestamp" }, "csubJobFinishedTime": { "type": "string", "description": "This object indicates the value of sysUpTime when the system\n finished executing the subscriber session job, for whatever\n reason. This value will be '0' when the corresponding instance\n of csubJobState is 'idle', 'pending', or 'inProgress'.", "x-yang-type": "yang:timestamp" }, "csubJobFinishedReason": { "type": "string", "description": "This object indicates the reason why the system finished\n executing the subscriber session job:\n \n 'invalid'\n Indicates that the corresponding instance of\n csubJobState is either 'idle', 'pending', or\n 'inProgress'.\n \n 'other'\n Indicates that the system finished executing the\n subscriber session job abnormally for a reason not\n recognized by this MIB module.\n \n 'normal'\n Indicates that the system finished executing the\n subscriber session job with no problems.\n \n 'aborted'\n Indicates that the system finished executing the\n subscriber session job as the result of the EMS/NMS\n writing 'abort' to the corresponding instance of\n csubJobControl.\n \n 'insufficientResources'\n Indicates that the system finished executing the\n subscriber session job abnormally due to insufficient\n resources to continue.\n \n 'error'\n Indicates that the system encountered an error that\n prevented it from completing the job." } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubJobEntry": { "csubJobId": "example-string", "csubJobStatus": "up(1)", "csubJobStorage": "example-string", "csubJobType": "ethernetCsmacd(6)", "csubJobControl": "example-string", "csubJobState": "up(1)", "csubJobStartedTime": "example-string", "csubJobFinishedTime": "example-string", "csubJobFinishedReason": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubJobEntry-2" }, "x-yang-path": "/csubJobTable/csubJobEntry={csubJobId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "csubJobId" ] }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubJobMatchParamsTable": { "get": { "summary": "Get csubJobMatchParamsTable data", "description": "Retrieve csubJobMatchParamsTable operational data from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table contains subscriber session job parameters\n describing match criteria.\n \n This table has a sparse-dependent relationship on the\n csubJobTable, containing a row for each job having a\n csubJobType of 'query' or 'clear'.", "properties": { "csubJobMatchParamsEntry": { "type": "array", "description": "csubJobMatchParamsEntry", "items": { "type": "object", "properties": { "csubJobId": { "type": "string", "description": "csubJobId", "x-yang-type": "leafref" }, "csubJobMatchIdentities": { "type": "string", "description": "This object specifies the subscriber identities that the\n system uses to determine the subscriber sessions the job\n executes on.\n \n Each bit in this bit string corresponds to one or more columns\n in this table. If the bit is '0', then the value of the\n corresponding columns are invalid. If the bit is '1', then the\n value of corresponding columns are valid.\n \n The following list specifies the mappings between the bits and\n the columns:\n \n 'subscriberLabel' => csubJobMatchSubscriberLabel\n 'macAddress' => csubJobMatchMacAddress\n 'nativeVrf' => csubJobMatchNativeVrf\n 'nativeIpAddress' => csubJobMatchNativeIpAddrType,\n csubJobMatchNativeIpAddr,\n csubJobMatchNativeIpMask,\n 'domainVrf' => csubJobMatchDomainVrf\n 'domainIpAddress' => csubJobMatchDomainIpAddrType,\n csubJobMatchDomainIpAddr,\n csubJobMatchDomainIpMask\n 'pbhk' => csubJobMatchPbhk\n 'remoteId' => csubJobMatchRemoteId\n 'circuitId' => csubJobMatchCircuitId\n 'nasPort' => csubJobMatchNasPort\n 'domain' => csubJobMatchDomain\n 'username' => csubJobMatchUsername\n 'acctSessionId' => csubJobMatchAcctSessionId\n 'dnis' => csubJobMatchDnis\n 'media' => csubJobMatchMedia\n 'mlpNegotiated' => csubJobMatchMlpNegotiated\n 'protocol' => csubJobMatchProtocol\n 'serviceName' => csubJobMatchServiceName\n 'dhcpClass' => csubJobMatchDhcpClass\n 'tunnelName' => csubJobMatchTunnelName\n \n Observe that the bit 'ifIndex' has no meaning, as subscriber\n session jobs do not match against this subscriber session\n identity.", "x-yang-type": "cisco-subscriber-identity:SubSessionIdentities" }, "csubJobMatchOtherParams": { "type": "string", "description": "This object specifies other parameters relating to subscriber\n sessions a subscriber session job may match against.\n \n Each bit in this bit string corresponds to a column in this\n table. If the bit is '0', then the value of the corresponding\n column is invalid. If the bit is '1', then the value of the\n corresponding column represents the value of the parameter\n identity the system should match against for the corresponding\n subscriber session job.\n \n The following list specifies the mappings between bits and the\n columns:\n \n 'danglingDuration' => csubJobMatchDanglingDuration\n 'state' => csubJobMatchState\n 'authenticated' => csubJobMatchAuthenticated\n 'redundancyMode' => csubJobMatchRedundancyMode" }, "csubJobMatchSubscriberLabel": { "type": "string", "description": "This object specifies the subscriber label that the system\n matches against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'subscriberLabel' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberLabel" }, "csubJobMatchMacAddress": { "type": "string", "description": "This object specifies the MAC address that the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'macAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "yang:mac-address" }, "csubJobMatchNativeVrf": { "type": "string", "description": "This object specifies the native VRF the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'nativeVrf' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberVRF" }, "csubJobMatchNativeIpAddrType": { "type": "string", "description": "This object specifies the type of Internet address specified\n by csubJobMatchNativeIpAddr and csubJobMatchNativeIpMask.\n \n This value is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddressType" }, "csubJobMatchNativeIpAddr": { "type": "string", "description": "This object specifies the native IP address that the system\n matches against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddress" }, "csubJobMatchNativeIpMask": { "type": "string", "description": "This object specifies the mask used when matching the native IP\n address against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddress" }, "csubJobMatchDomainVrf": { "type": "string", "description": "This object specifies the domain VRF the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'domainVrf' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberVRF" }, "csubJobMatchDomainIpAddrType": { "type": "string", "description": "This object specifies the type of Internet address specified\n by csubJobMatchDomainIpAddr and csubJobMatchDomainIpMask.\n \n This value is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddressType" }, "csubJobMatchDomainIpAddr": { "type": "string", "description": "This object specifies the domain IP address that the system\n matches against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddress" }, "csubJobMatchDomainIpMask": { "type": "string", "description": "This object specifies the mask used when matching the domain IP\n address against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddress" }, "csubJobMatchPbhk": { "type": "string", "description": "This object specifies the PBHK that the system matches against\n subscriber sessions in the process of executing a subscriber\n session job.\n \n This value is valid only if the 'pbhk' bit of the corresponding\n instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberPbhk" }, "csubJobMatchRemoteId": { "type": "string", "description": "This object specifies the Remote-Id the system matches against\n subscriber sessions in the process of executing a subscriber\n session job.\n \n This value is valid only if the 'remoteId' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberRemoteId" }, "csubJobMatchCircuitId": { "type": "string", "description": "This object specifies the Circuit-Id the system matches against\n subscriber sessions in the process of executing a subscriber\n session job.\n \n This value is valid only if the 'circuitId' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberCircuitId" }, "csubJobMatchNasPort": { "type": "string", "description": "This object specifies the NAS port-identifier the system\n matches against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'nasPort' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberNasPort" }, "csubJobMatchDomain": { "type": "string", "description": "This object specifies the domain the system matches against\n subscriber sessions in the process of executing a subscriber\n session job.\n \n This value is valid only if the 'domain' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDomain" }, "csubJobMatchUsername": { "type": "string", "description": "This object specifies the username the system matches against\n subscriber sessions in the process of executing a subscriber\n session job.\n \n This value is valid only if the 'username' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberUsername" }, "csubJobMatchAcctSessionId": { "type": "string", "description": "This object specifies the accounting session identifier the\n system matches against subscriber sessions in the process of\n executing a subscriber session job.\n \n This value is valid only if the 'accountingSid' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberAcctSessionId" }, "csubJobMatchDnis": { "type": "string", "description": "This object specifies the DNIS number the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'dnis' bit of the corresponding\n instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDnis" }, "csubJobMatchMedia": { "type": "string", "description": "This object specifies the media type the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'media' bit of the corresponding\n instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberMediaType" }, "csubJobMatchMlpNegotiated": { "type": "boolean", "description": "This object specifies the MLP negotiated flag the system\n matches against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'mlpNegotiated' bit of the\n corresponding instance of csubJobMatchIdentities is '1'." }, "csubJobMatchProtocol": { "type": "string", "description": "This object specifies the protocol type the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'protocol' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberProtocolType" }, "csubJobMatchServiceName": { "type": "string", "description": "This object specifies the service name the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'serviceName' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-cbp:CbpElementName" }, "csubJobMatchDhcpClass": { "type": "string", "description": "This object specifies the DHCP class name the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'dhcpClass' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDhcpClass" }, "csubJobMatchTunnelName": { "type": "string", "description": "This object specifies the tunnel name the system matches\n against subscriber session in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'tunnelName' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberTunnelName" }, "csubJobMatchDanglingDuration": { "type": "integer", "description": "This object specifies the minimum interval of time a subscriber\n session can remain dangling in order for the system to consider\n it a match in the process of executing a subscriber session job.\n A 'dangling' subscriber session is one in the PENDING state.\n \n The value '0' cannot be written to an instance of this object.\n However, it serves as a convenient value when the column is not\n valid.\n \n This value is valid only if the 'danglingDuration' bit of the\n corresponding instance of csubJobMatchOtherParams is '1'.", "minimum": 0, "maximum": 4294967295 }, "csubJobMatchState": { "type": "string", "description": "This object specifies the state of a subscriber session in\n order for the system to consider a match in the process of\n executing a subscriber session job.\n \n The value 'other' is not valid and an implementation should\n not allow it to be written to this column.\n \n This value is valid only if the 'state' bit of the\n corresponding instance of csubJobMatchOtherParams is '1'.", "x-yang-type": "cisco-subscriber:SubSessionState" }, "csubJobMatchAuthenticated": { "type": "boolean", "description": "This object specifies whether a subscriber session should be\n unauthenticated for the system to consider a match in the\n process of executing a subscriber session job.\n \n If this column is 'false', then the subscriber session job\n matches subscriber sessions that are unauthenticated.\n \n If this column is 'true', then the subscriber session job\n matches subscriber session that are authenticated.\n \n This value is valid only if the 'authenticated' bit of the\n corresponding instance of csubJobMatchParams is '1'." }, "csubJobMatchRedundancyMode": { "type": "string", "description": "This object specifies the redudancy mode of the subscriber\n session in order for the system to consider a match in the\n process of executing a subscriber session job.\n \n The value 'other' is not valid and an implementation should not\n allow it to be written to this column.\n \n This value is valid only if the 'redundancyMode' bit of the\n corresponding instance of csubJobMatchOtherParams is '1'.", "x-yang-type": "cisco-subscriber:SubSessionRedundancyMode" } } } } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubJobMatchParamsTable": { "csubJobMatchParamsEntry": [ { "csubJobId": "example-string", "csubJobMatchIdentities": "example-string", "csubJobMatchOtherParams": "example-string", "csubJobMatchSubscriberLabel": "example-string", "csubJobMatchMacAddress": "00:11:22:33:44:55", "csubJobMatchNativeVrf": "example-string", "csubJobMatchNativeIpAddrType": "192.168.1.1", "csubJobMatchNativeIpAddr": "192.168.1.1", "csubJobMatchNativeIpMask": "192.168.1.1", "csubJobMatchDomainVrf": "example-string", "csubJobMatchDomainIpAddrType": "192.168.1.1", "csubJobMatchDomainIpAddr": "192.168.1.1", "csubJobMatchDomainIpMask": "192.168.1.1", "csubJobMatchPbhk": "example-string", "csubJobMatchRemoteId": "example-string", "csubJobMatchCircuitId": "example-string", "csubJobMatchNasPort": "example-string", "csubJobMatchDomain": "example-string", "csubJobMatchUsername": "interface-1", "csubJobMatchAcctSessionId": "example-string", "csubJobMatchDnis": "example-string", "csubJobMatchMedia": "example-string", "csubJobMatchMlpNegotiated": true, "csubJobMatchProtocol": "example-string", "csubJobMatchServiceName": "interface-1", "csubJobMatchDhcpClass": "example-string", "csubJobMatchTunnelName": "interface-1", "csubJobMatchDanglingDuration": 0, "csubJobMatchState": "up(1)", "csubJobMatchAuthenticated": true, "csubJobMatchRedundancyMode": "example-string" }, { "csubJobId": "example-string", "csubJobMatchIdentities": "example-string", "csubJobMatchOtherParams": "example-string", "csubJobMatchSubscriberLabel": "example-string", "csubJobMatchMacAddress": "00:11:22:33:44:55", "csubJobMatchNativeVrf": "example-string", "csubJobMatchNativeIpAddrType": "192.168.1.1", "csubJobMatchNativeIpAddr": "192.168.1.1", "csubJobMatchNativeIpMask": "192.168.1.1", "csubJobMatchDomainVrf": "example-string", "csubJobMatchDomainIpAddrType": "192.168.1.1", "csubJobMatchDomainIpAddr": "192.168.1.1", "csubJobMatchDomainIpMask": "192.168.1.1", "csubJobMatchPbhk": "example-string", "csubJobMatchRemoteId": "example-string", "csubJobMatchCircuitId": "example-string", "csubJobMatchNasPort": "example-string", "csubJobMatchDomain": "example-string", "csubJobMatchUsername": "interface-1", "csubJobMatchAcctSessionId": "example-string", "csubJobMatchDnis": "example-string", "csubJobMatchMedia": "example-string", "csubJobMatchMlpNegotiated": true, "csubJobMatchProtocol": "example-string", "csubJobMatchServiceName": "interface-1", "csubJobMatchDhcpClass": "example-string", "csubJobMatchTunnelName": "interface-1", "csubJobMatchDanglingDuration": 0, "csubJobMatchState": "up(1)", "csubJobMatchAuthenticated": true, "csubJobMatchRedundancyMode": "example-string" }, { "csubJobId": "example-string", "csubJobMatchIdentities": "example-string", "csubJobMatchOtherParams": "example-string", "csubJobMatchSubscriberLabel": "example-string", "csubJobMatchMacAddress": "00:11:22:33:44:55", "csubJobMatchNativeVrf": "example-string", "csubJobMatchNativeIpAddrType": "192.168.1.1", "csubJobMatchNativeIpAddr": "192.168.1.1", "csubJobMatchNativeIpMask": "192.168.1.1", "csubJobMatchDomainVrf": "example-string", "csubJobMatchDomainIpAddrType": "192.168.1.1", "csubJobMatchDomainIpAddr": "192.168.1.1", "csubJobMatchDomainIpMask": "192.168.1.1", "csubJobMatchPbhk": "example-string", "csubJobMatchRemoteId": "example-string", "csubJobMatchCircuitId": "example-string", "csubJobMatchNasPort": "example-string", "csubJobMatchDomain": "example-string", "csubJobMatchUsername": "interface-1", "csubJobMatchAcctSessionId": "example-string", "csubJobMatchDnis": "example-string", "csubJobMatchMedia": "example-string", "csubJobMatchMlpNegotiated": true, "csubJobMatchProtocol": "example-string", "csubJobMatchServiceName": "interface-1", "csubJobMatchDhcpClass": "example-string", "csubJobMatchTunnelName": "interface-1", "csubJobMatchDanglingDuration": 0, "csubJobMatchState": "up(1)", "csubJobMatchAuthenticated": true, "csubJobMatchRedundancyMode": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubJobMatchParamsTable", "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": "/csubJobMatchParamsTable", "x-restconf-kind": "container" }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubJobMatchParamsTable/csubJobMatchParamsEntry": { "get": { "summary": "Get csubJobMatchParamsEntry list", "description": "Retrieve list of csubJobMatchParamsEntry entries from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "csubJobMatchParamsEntry", "items": { "type": "object", "properties": { "csubJobId": { "type": "string", "description": "csubJobId", "x-yang-type": "leafref" }, "csubJobMatchIdentities": { "type": "string", "description": "This object specifies the subscriber identities that the\n system uses to determine the subscriber sessions the job\n executes on.\n \n Each bit in this bit string corresponds to one or more columns\n in this table. If the bit is '0', then the value of the\n corresponding columns are invalid. If the bit is '1', then the\n value of corresponding columns are valid.\n \n The following list specifies the mappings between the bits and\n the columns:\n \n 'subscriberLabel' => csubJobMatchSubscriberLabel\n 'macAddress' => csubJobMatchMacAddress\n 'nativeVrf' => csubJobMatchNativeVrf\n 'nativeIpAddress' => csubJobMatchNativeIpAddrType,\n csubJobMatchNativeIpAddr,\n csubJobMatchNativeIpMask,\n 'domainVrf' => csubJobMatchDomainVrf\n 'domainIpAddress' => csubJobMatchDomainIpAddrType,\n csubJobMatchDomainIpAddr,\n csubJobMatchDomainIpMask\n 'pbhk' => csubJobMatchPbhk\n 'remoteId' => csubJobMatchRemoteId\n 'circuitId' => csubJobMatchCircuitId\n 'nasPort' => csubJobMatchNasPort\n 'domain' => csubJobMatchDomain\n 'username' => csubJobMatchUsername\n 'acctSessionId' => csubJobMatchAcctSessionId\n 'dnis' => csubJobMatchDnis\n 'media' => csubJobMatchMedia\n 'mlpNegotiated' => csubJobMatchMlpNegotiated\n 'protocol' => csubJobMatchProtocol\n 'serviceName' => csubJobMatchServiceName\n 'dhcpClass' => csubJobMatchDhcpClass\n 'tunnelName' => csubJobMatchTunnelName\n \n Observe that the bit 'ifIndex' has no meaning, as subscriber\n session jobs do not match against this subscriber session\n identity.", "x-yang-type": "cisco-subscriber-identity:SubSessionIdentities" }, "csubJobMatchOtherParams": { "type": "string", "description": "This object specifies other parameters relating to subscriber\n sessions a subscriber session job may match against.\n \n Each bit in this bit string corresponds to a column in this\n table. If the bit is '0', then the value of the corresponding\n column is invalid. If the bit is '1', then the value of the\n corresponding column represents the value of the parameter\n identity the system should match against for the corresponding\n subscriber session job.\n \n The following list specifies the mappings between bits and the\n columns:\n \n 'danglingDuration' => csubJobMatchDanglingDuration\n 'state' => csubJobMatchState\n 'authenticated' => csubJobMatchAuthenticated\n 'redundancyMode' => csubJobMatchRedundancyMode" }, "csubJobMatchSubscriberLabel": { "type": "string", "description": "This object specifies the subscriber label that the system\n matches against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'subscriberLabel' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberLabel" }, "csubJobMatchMacAddress": { "type": "string", "description": "This object specifies the MAC address that the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'macAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "yang:mac-address" }, "csubJobMatchNativeVrf": { "type": "string", "description": "This object specifies the native VRF the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'nativeVrf' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberVRF" }, "csubJobMatchNativeIpAddrType": { "type": "string", "description": "This object specifies the type of Internet address specified\n by csubJobMatchNativeIpAddr and csubJobMatchNativeIpMask.\n \n This value is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddressType" }, "csubJobMatchNativeIpAddr": { "type": "string", "description": "This object specifies the native IP address that the system\n matches against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddress" }, "csubJobMatchNativeIpMask": { "type": "string", "description": "This object specifies the mask used when matching the native IP\n address against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddress" }, "csubJobMatchDomainVrf": { "type": "string", "description": "This object specifies the domain VRF the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'domainVrf' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberVRF" }, "csubJobMatchDomainIpAddrType": { "type": "string", "description": "This object specifies the type of Internet address specified\n by csubJobMatchDomainIpAddr and csubJobMatchDomainIpMask.\n \n This value is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddressType" }, "csubJobMatchDomainIpAddr": { "type": "string", "description": "This object specifies the domain IP address that the system\n matches against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddress" }, "csubJobMatchDomainIpMask": { "type": "string", "description": "This object specifies the mask used when matching the domain IP\n address against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddress" }, "csubJobMatchPbhk": { "type": "string", "description": "This object specifies the PBHK that the system matches against\n subscriber sessions in the process of executing a subscriber\n session job.\n \n This value is valid only if the 'pbhk' bit of the corresponding\n instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberPbhk" }, "csubJobMatchRemoteId": { "type": "string", "description": "This object specifies the Remote-Id the system matches against\n subscriber sessions in the process of executing a subscriber\n session job.\n \n This value is valid only if the 'remoteId' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberRemoteId" }, "csubJobMatchCircuitId": { "type": "string", "description": "This object specifies the Circuit-Id the system matches against\n subscriber sessions in the process of executing a subscriber\n session job.\n \n This value is valid only if the 'circuitId' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberCircuitId" }, "csubJobMatchNasPort": { "type": "string", "description": "This object specifies the NAS port-identifier the system\n matches against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'nasPort' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberNasPort" }, "csubJobMatchDomain": { "type": "string", "description": "This object specifies the domain the system matches against\n subscriber sessions in the process of executing a subscriber\n session job.\n \n This value is valid only if the 'domain' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDomain" }, "csubJobMatchUsername": { "type": "string", "description": "This object specifies the username the system matches against\n subscriber sessions in the process of executing a subscriber\n session job.\n \n This value is valid only if the 'username' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberUsername" }, "csubJobMatchAcctSessionId": { "type": "string", "description": "This object specifies the accounting session identifier the\n system matches against subscriber sessions in the process of\n executing a subscriber session job.\n \n This value is valid only if the 'accountingSid' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberAcctSessionId" }, "csubJobMatchDnis": { "type": "string", "description": "This object specifies the DNIS number the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'dnis' bit of the corresponding\n instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDnis" }, "csubJobMatchMedia": { "type": "string", "description": "This object specifies the media type the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'media' bit of the corresponding\n instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberMediaType" }, "csubJobMatchMlpNegotiated": { "type": "boolean", "description": "This object specifies the MLP negotiated flag the system\n matches against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'mlpNegotiated' bit of the\n corresponding instance of csubJobMatchIdentities is '1'." }, "csubJobMatchProtocol": { "type": "string", "description": "This object specifies the protocol type the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'protocol' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberProtocolType" }, "csubJobMatchServiceName": { "type": "string", "description": "This object specifies the service name the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'serviceName' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-cbp:CbpElementName" }, "csubJobMatchDhcpClass": { "type": "string", "description": "This object specifies the DHCP class name the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'dhcpClass' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDhcpClass" }, "csubJobMatchTunnelName": { "type": "string", "description": "This object specifies the tunnel name the system matches\n against subscriber session in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'tunnelName' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberTunnelName" }, "csubJobMatchDanglingDuration": { "type": "integer", "description": "This object specifies the minimum interval of time a subscriber\n session can remain dangling in order for the system to consider\n it a match in the process of executing a subscriber session job.\n A 'dangling' subscriber session is one in the PENDING state.\n \n The value '0' cannot be written to an instance of this object.\n However, it serves as a convenient value when the column is not\n valid.\n \n This value is valid only if the 'danglingDuration' bit of the\n corresponding instance of csubJobMatchOtherParams is '1'.", "minimum": 0, "maximum": 4294967295 }, "csubJobMatchState": { "type": "string", "description": "This object specifies the state of a subscriber session in\n order for the system to consider a match in the process of\n executing a subscriber session job.\n \n The value 'other' is not valid and an implementation should\n not allow it to be written to this column.\n \n This value is valid only if the 'state' bit of the\n corresponding instance of csubJobMatchOtherParams is '1'.", "x-yang-type": "cisco-subscriber:SubSessionState" }, "csubJobMatchAuthenticated": { "type": "boolean", "description": "This object specifies whether a subscriber session should be\n unauthenticated for the system to consider a match in the\n process of executing a subscriber session job.\n \n If this column is 'false', then the subscriber session job\n matches subscriber sessions that are unauthenticated.\n \n If this column is 'true', then the subscriber session job\n matches subscriber session that are authenticated.\n \n This value is valid only if the 'authenticated' bit of the\n corresponding instance of csubJobMatchParams is '1'." }, "csubJobMatchRedundancyMode": { "type": "string", "description": "This object specifies the redudancy mode of the subscriber\n session in order for the system to consider a match in the\n process of executing a subscriber session job.\n \n The value 'other' is not valid and an implementation should not\n allow it to be written to this column.\n \n This value is valid only if the 'redundancyMode' bit of the\n corresponding instance of csubJobMatchOtherParams is '1'.", "x-yang-type": "cisco-subscriber:SubSessionRedundancyMode" } } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubJobMatchParamsEntry": [ { "csubJobId": "example-string", "csubJobMatchIdentities": "example-string", "csubJobMatchOtherParams": "example-string", "csubJobMatchSubscriberLabel": "example-string", "csubJobMatchMacAddress": "00:11:22:33:44:55", "csubJobMatchNativeVrf": "example-string", "csubJobMatchNativeIpAddrType": "192.168.1.1", "csubJobMatchNativeIpAddr": "192.168.1.1", "csubJobMatchNativeIpMask": "192.168.1.1", "csubJobMatchDomainVrf": "example-string", "csubJobMatchDomainIpAddrType": "192.168.1.1", "csubJobMatchDomainIpAddr": "192.168.1.1", "csubJobMatchDomainIpMask": "192.168.1.1", "csubJobMatchPbhk": "example-string", "csubJobMatchRemoteId": "example-string", "csubJobMatchCircuitId": "example-string", "csubJobMatchNasPort": "example-string", "csubJobMatchDomain": "example-string", "csubJobMatchUsername": "interface-1", "csubJobMatchAcctSessionId": "example-string", "csubJobMatchDnis": "example-string", "csubJobMatchMedia": "example-string", "csubJobMatchMlpNegotiated": true, "csubJobMatchProtocol": "example-string", "csubJobMatchServiceName": "interface-1", "csubJobMatchDhcpClass": "example-string", "csubJobMatchTunnelName": "interface-1", "csubJobMatchDanglingDuration": 0, "csubJobMatchState": "up(1)", "csubJobMatchAuthenticated": true, "csubJobMatchRedundancyMode": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubJobMatchParamsEntry", "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": "/csubJobMatchParamsTable/csubJobMatchParamsEntry", "x-restconf-kind": "container" }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubJobMatchParamsTable/csubJobMatchParamsEntry={csubJobId}": { "get": { "summary": "Get csubJobMatchParamsEntry entry", "description": "Retrieve specific csubJobMatchParamsEntry entry by key from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "parameters": [ { "name": "csubJobId", "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": { "csubJobId": { "type": "string", "description": "csubJobId", "x-yang-type": "leafref" }, "csubJobMatchIdentities": { "type": "string", "description": "This object specifies the subscriber identities that the\n system uses to determine the subscriber sessions the job\n executes on.\n \n Each bit in this bit string corresponds to one or more columns\n in this table. If the bit is '0', then the value of the\n corresponding columns are invalid. If the bit is '1', then the\n value of corresponding columns are valid.\n \n The following list specifies the mappings between the bits and\n the columns:\n \n 'subscriberLabel' => csubJobMatchSubscriberLabel\n 'macAddress' => csubJobMatchMacAddress\n 'nativeVrf' => csubJobMatchNativeVrf\n 'nativeIpAddress' => csubJobMatchNativeIpAddrType,\n csubJobMatchNativeIpAddr,\n csubJobMatchNativeIpMask,\n 'domainVrf' => csubJobMatchDomainVrf\n 'domainIpAddress' => csubJobMatchDomainIpAddrType,\n csubJobMatchDomainIpAddr,\n csubJobMatchDomainIpMask\n 'pbhk' => csubJobMatchPbhk\n 'remoteId' => csubJobMatchRemoteId\n 'circuitId' => csubJobMatchCircuitId\n 'nasPort' => csubJobMatchNasPort\n 'domain' => csubJobMatchDomain\n 'username' => csubJobMatchUsername\n 'acctSessionId' => csubJobMatchAcctSessionId\n 'dnis' => csubJobMatchDnis\n 'media' => csubJobMatchMedia\n 'mlpNegotiated' => csubJobMatchMlpNegotiated\n 'protocol' => csubJobMatchProtocol\n 'serviceName' => csubJobMatchServiceName\n 'dhcpClass' => csubJobMatchDhcpClass\n 'tunnelName' => csubJobMatchTunnelName\n \n Observe that the bit 'ifIndex' has no meaning, as subscriber\n session jobs do not match against this subscriber session\n identity.", "x-yang-type": "cisco-subscriber-identity:SubSessionIdentities" }, "csubJobMatchOtherParams": { "type": "string", "description": "This object specifies other parameters relating to subscriber\n sessions a subscriber session job may match against.\n \n Each bit in this bit string corresponds to a column in this\n table. If the bit is '0', then the value of the corresponding\n column is invalid. If the bit is '1', then the value of the\n corresponding column represents the value of the parameter\n identity the system should match against for the corresponding\n subscriber session job.\n \n The following list specifies the mappings between bits and the\n columns:\n \n 'danglingDuration' => csubJobMatchDanglingDuration\n 'state' => csubJobMatchState\n 'authenticated' => csubJobMatchAuthenticated\n 'redundancyMode' => csubJobMatchRedundancyMode" }, "csubJobMatchSubscriberLabel": { "type": "string", "description": "This object specifies the subscriber label that the system\n matches against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'subscriberLabel' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberLabel" }, "csubJobMatchMacAddress": { "type": "string", "description": "This object specifies the MAC address that the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'macAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "yang:mac-address" }, "csubJobMatchNativeVrf": { "type": "string", "description": "This object specifies the native VRF the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'nativeVrf' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberVRF" }, "csubJobMatchNativeIpAddrType": { "type": "string", "description": "This object specifies the type of Internet address specified\n by csubJobMatchNativeIpAddr and csubJobMatchNativeIpMask.\n \n This value is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddressType" }, "csubJobMatchNativeIpAddr": { "type": "string", "description": "This object specifies the native IP address that the system\n matches against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddress" }, "csubJobMatchNativeIpMask": { "type": "string", "description": "This object specifies the mask used when matching the native IP\n address against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddress" }, "csubJobMatchDomainVrf": { "type": "string", "description": "This object specifies the domain VRF the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'domainVrf' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberVRF" }, "csubJobMatchDomainIpAddrType": { "type": "string", "description": "This object specifies the type of Internet address specified\n by csubJobMatchDomainIpAddr and csubJobMatchDomainIpMask.\n \n This value is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddressType" }, "csubJobMatchDomainIpAddr": { "type": "string", "description": "This object specifies the domain IP address that the system\n matches against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddress" }, "csubJobMatchDomainIpMask": { "type": "string", "description": "This object specifies the mask used when matching the domain IP\n address against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddress" }, "csubJobMatchPbhk": { "type": "string", "description": "This object specifies the PBHK that the system matches against\n subscriber sessions in the process of executing a subscriber\n session job.\n \n This value is valid only if the 'pbhk' bit of the corresponding\n instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberPbhk" }, "csubJobMatchRemoteId": { "type": "string", "description": "This object specifies the Remote-Id the system matches against\n subscriber sessions in the process of executing a subscriber\n session job.\n \n This value is valid only if the 'remoteId' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberRemoteId" }, "csubJobMatchCircuitId": { "type": "string", "description": "This object specifies the Circuit-Id the system matches against\n subscriber sessions in the process of executing a subscriber\n session job.\n \n This value is valid only if the 'circuitId' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberCircuitId" }, "csubJobMatchNasPort": { "type": "string", "description": "This object specifies the NAS port-identifier the system\n matches against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'nasPort' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberNasPort" }, "csubJobMatchDomain": { "type": "string", "description": "This object specifies the domain the system matches against\n subscriber sessions in the process of executing a subscriber\n session job.\n \n This value is valid only if the 'domain' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDomain" }, "csubJobMatchUsername": { "type": "string", "description": "This object specifies the username the system matches against\n subscriber sessions in the process of executing a subscriber\n session job.\n \n This value is valid only if the 'username' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberUsername" }, "csubJobMatchAcctSessionId": { "type": "string", "description": "This object specifies the accounting session identifier the\n system matches against subscriber sessions in the process of\n executing a subscriber session job.\n \n This value is valid only if the 'accountingSid' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberAcctSessionId" }, "csubJobMatchDnis": { "type": "string", "description": "This object specifies the DNIS number the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'dnis' bit of the corresponding\n instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDnis" }, "csubJobMatchMedia": { "type": "string", "description": "This object specifies the media type the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'media' bit of the corresponding\n instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberMediaType" }, "csubJobMatchMlpNegotiated": { "type": "boolean", "description": "This object specifies the MLP negotiated flag the system\n matches against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'mlpNegotiated' bit of the\n corresponding instance of csubJobMatchIdentities is '1'." }, "csubJobMatchProtocol": { "type": "string", "description": "This object specifies the protocol type the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'protocol' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberProtocolType" }, "csubJobMatchServiceName": { "type": "string", "description": "This object specifies the service name the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'serviceName' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-cbp:CbpElementName" }, "csubJobMatchDhcpClass": { "type": "string", "description": "This object specifies the DHCP class name the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'dhcpClass' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDhcpClass" }, "csubJobMatchTunnelName": { "type": "string", "description": "This object specifies the tunnel name the system matches\n against subscriber session in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'tunnelName' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberTunnelName" }, "csubJobMatchDanglingDuration": { "type": "integer", "description": "This object specifies the minimum interval of time a subscriber\n session can remain dangling in order for the system to consider\n it a match in the process of executing a subscriber session job.\n A 'dangling' subscriber session is one in the PENDING state.\n \n The value '0' cannot be written to an instance of this object.\n However, it serves as a convenient value when the column is not\n valid.\n \n This value is valid only if the 'danglingDuration' bit of the\n corresponding instance of csubJobMatchOtherParams is '1'.", "minimum": 0, "maximum": 4294967295 }, "csubJobMatchState": { "type": "string", "description": "This object specifies the state of a subscriber session in\n order for the system to consider a match in the process of\n executing a subscriber session job.\n \n The value 'other' is not valid and an implementation should\n not allow it to be written to this column.\n \n This value is valid only if the 'state' bit of the\n corresponding instance of csubJobMatchOtherParams is '1'.", "x-yang-type": "cisco-subscriber:SubSessionState" }, "csubJobMatchAuthenticated": { "type": "boolean", "description": "This object specifies whether a subscriber session should be\n unauthenticated for the system to consider a match in the\n process of executing a subscriber session job.\n \n If this column is 'false', then the subscriber session job\n matches subscriber sessions that are unauthenticated.\n \n If this column is 'true', then the subscriber session job\n matches subscriber session that are authenticated.\n \n This value is valid only if the 'authenticated' bit of the\n corresponding instance of csubJobMatchParams is '1'." }, "csubJobMatchRedundancyMode": { "type": "string", "description": "This object specifies the redudancy mode of the subscriber\n session in order for the system to consider a match in the\n process of executing a subscriber session job.\n \n The value 'other' is not valid and an implementation should not\n allow it to be written to this column.\n \n This value is valid only if the 'redundancyMode' bit of the\n corresponding instance of csubJobMatchOtherParams is '1'.", "x-yang-type": "cisco-subscriber:SubSessionRedundancyMode" } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubJobMatchParamsEntry": { "csubJobId": "example-string", "csubJobMatchIdentities": "example-string", "csubJobMatchOtherParams": "example-string", "csubJobMatchSubscriberLabel": "example-string", "csubJobMatchMacAddress": "00:11:22:33:44:55", "csubJobMatchNativeVrf": "example-string", "csubJobMatchNativeIpAddrType": "192.168.1.1", "csubJobMatchNativeIpAddr": "192.168.1.1", "csubJobMatchNativeIpMask": "192.168.1.1", "csubJobMatchDomainVrf": "example-string", "csubJobMatchDomainIpAddrType": "192.168.1.1", "csubJobMatchDomainIpAddr": "192.168.1.1", "csubJobMatchDomainIpMask": "192.168.1.1", "csubJobMatchPbhk": "example-string", "csubJobMatchRemoteId": "example-string", "csubJobMatchCircuitId": "example-string", "csubJobMatchNasPort": "example-string", "csubJobMatchDomain": "example-string", "csubJobMatchUsername": "interface-1", "csubJobMatchAcctSessionId": "example-string", "csubJobMatchDnis": "example-string", "csubJobMatchMedia": "example-string", "csubJobMatchMlpNegotiated": true, "csubJobMatchProtocol": "example-string", "csubJobMatchServiceName": "interface-1", "csubJobMatchDhcpClass": "example-string", "csubJobMatchTunnelName": "interface-1", "csubJobMatchDanglingDuration": 0, "csubJobMatchState": "up(1)", "csubJobMatchAuthenticated": true, "csubJobMatchRedundancyMode": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubJobMatchParamsEntry-2" }, "x-yang-path": "/csubJobMatchParamsTable/csubJobMatchParamsEntry={csubJobId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "csubJobId" ] }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubJobQueryParamsTable": { "get": { "summary": "Get csubJobQueryParamsTable data", "description": "Retrieve csubJobQueryParamsTable operational data from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table contains subscriber session job parameters\n describing query parameters.\n \n This table has a sparse-dependent relationship on the\n csubJobTable, containing a row for each job having a\n csubJobType of 'query'.", "properties": { "csubJobQueryParamsEntry": { "type": "array", "description": "csubJobQueryParamsEntry", "items": { "type": "object", "properties": { "csubJobId": { "type": "string", "description": "csubJobId", "x-yang-type": "leafref" }, "csubJobQuerySortKey1": { "type": "string", "description": "This object specifies the first subscriber identity that the\n system uses when sorting subscriber sessions into the final\n report corresponding to a subscriber session query.\n \n It is not valid to set this column to 'other' or 'ifIndex'.", "x-yang-type": "cisco-subscriber-identity:SubSessionIdentity" }, "csubJobQuerySortKey2": { "type": "string", "description": "This object specifies the second subscriber identity that the\n system uses when sorting subscriber sessions into the final\n report corresponding to a subscriber session query.\n \n If it is the desire to have the final report sorted on a single\n subscriber identity, then this column should be 'other'.", "x-yang-type": "cisco-subscriber-identity:SubSessionIdentity" }, "csubJobQuerySortKey3": { "type": "string", "description": "This object specifies the third subscriber identity that the\n system uses when sorting subscriber sessions into the final\n report corresponding to a subscriber session query.\n \n If it is the desire to have the final report sorted on one or\n two subscriber identities, then this column should be 'other'.", "x-yang-type": "cisco-subscriber-identity:SubSessionIdentity" }, "csubJobQueryResultingReportSize": { "type": "integer", "description": "This object indicates the number of subscriber sessions that\n matched the corresponding subscriber session query.\n \n The value of this column should be '0' unless the corresponding\n value of csubJobState is 'finished'.\n \n The value of this column should be '0' after the EMS/NMS sets\n the corresponding csubJobControl to 'release'.", "minimum": 0, "maximum": 4294967295 } } } } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubJobQueryParamsTable": { "csubJobQueryParamsEntry": [ { "csubJobId": "example-string", "csubJobQuerySortKey1": "example-string", "csubJobQuerySortKey2": "example-string", "csubJobQuerySortKey3": "example-string", "csubJobQueryResultingReportSize": 0 }, { "csubJobId": "example-string", "csubJobQuerySortKey1": "example-string", "csubJobQuerySortKey2": "example-string", "csubJobQuerySortKey3": "example-string", "csubJobQueryResultingReportSize": 0 }, { "csubJobId": "example-string", "csubJobQuerySortKey1": "example-string", "csubJobQuerySortKey2": "example-string", "csubJobQuerySortKey3": "example-string", "csubJobQueryResultingReportSize": 0 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubJobQueryParamsTable", "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": "/csubJobQueryParamsTable", "x-restconf-kind": "container" }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubJobQueryParamsTable/csubJobQueryParamsEntry": { "get": { "summary": "Get csubJobQueryParamsEntry list", "description": "Retrieve list of csubJobQueryParamsEntry entries from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "csubJobQueryParamsEntry", "items": { "type": "object", "properties": { "csubJobId": { "type": "string", "description": "csubJobId", "x-yang-type": "leafref" }, "csubJobQuerySortKey1": { "type": "string", "description": "This object specifies the first subscriber identity that the\n system uses when sorting subscriber sessions into the final\n report corresponding to a subscriber session query.\n \n It is not valid to set this column to 'other' or 'ifIndex'.", "x-yang-type": "cisco-subscriber-identity:SubSessionIdentity" }, "csubJobQuerySortKey2": { "type": "string", "description": "This object specifies the second subscriber identity that the\n system uses when sorting subscriber sessions into the final\n report corresponding to a subscriber session query.\n \n If it is the desire to have the final report sorted on a single\n subscriber identity, then this column should be 'other'.", "x-yang-type": "cisco-subscriber-identity:SubSessionIdentity" }, "csubJobQuerySortKey3": { "type": "string", "description": "This object specifies the third subscriber identity that the\n system uses when sorting subscriber sessions into the final\n report corresponding to a subscriber session query.\n \n If it is the desire to have the final report sorted on one or\n two subscriber identities, then this column should be 'other'.", "x-yang-type": "cisco-subscriber-identity:SubSessionIdentity" }, "csubJobQueryResultingReportSize": { "type": "integer", "description": "This object indicates the number of subscriber sessions that\n matched the corresponding subscriber session query.\n \n The value of this column should be '0' unless the corresponding\n value of csubJobState is 'finished'.\n \n The value of this column should be '0' after the EMS/NMS sets\n the corresponding csubJobControl to 'release'.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubJobQueryParamsEntry": [ { "csubJobId": "example-string", "csubJobQuerySortKey1": "example-string", "csubJobQuerySortKey2": "example-string", "csubJobQuerySortKey3": "example-string", "csubJobQueryResultingReportSize": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubJobQueryParamsEntry", "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": "/csubJobQueryParamsTable/csubJobQueryParamsEntry", "x-restconf-kind": "container" }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubJobQueryParamsTable/csubJobQueryParamsEntry={csubJobId}": { "get": { "summary": "Get csubJobQueryParamsEntry entry", "description": "Retrieve specific csubJobQueryParamsEntry entry by key from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "parameters": [ { "name": "csubJobId", "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": { "csubJobId": { "type": "string", "description": "csubJobId", "x-yang-type": "leafref" }, "csubJobQuerySortKey1": { "type": "string", "description": "This object specifies the first subscriber identity that the\n system uses when sorting subscriber sessions into the final\n report corresponding to a subscriber session query.\n \n It is not valid to set this column to 'other' or 'ifIndex'.", "x-yang-type": "cisco-subscriber-identity:SubSessionIdentity" }, "csubJobQuerySortKey2": { "type": "string", "description": "This object specifies the second subscriber identity that the\n system uses when sorting subscriber sessions into the final\n report corresponding to a subscriber session query.\n \n If it is the desire to have the final report sorted on a single\n subscriber identity, then this column should be 'other'.", "x-yang-type": "cisco-subscriber-identity:SubSessionIdentity" }, "csubJobQuerySortKey3": { "type": "string", "description": "This object specifies the third subscriber identity that the\n system uses when sorting subscriber sessions into the final\n report corresponding to a subscriber session query.\n \n If it is the desire to have the final report sorted on one or\n two subscriber identities, then this column should be 'other'.", "x-yang-type": "cisco-subscriber-identity:SubSessionIdentity" }, "csubJobQueryResultingReportSize": { "type": "integer", "description": "This object indicates the number of subscriber sessions that\n matched the corresponding subscriber session query.\n \n The value of this column should be '0' unless the corresponding\n value of csubJobState is 'finished'.\n \n The value of this column should be '0' after the EMS/NMS sets\n the corresponding csubJobControl to 'release'.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubJobQueryParamsEntry": { "csubJobId": "example-string", "csubJobQuerySortKey1": "example-string", "csubJobQuerySortKey2": "example-string", "csubJobQuerySortKey3": "example-string", "csubJobQueryResultingReportSize": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubJobQueryParamsEntry-2" }, "x-yang-path": "/csubJobQueryParamsTable/csubJobQueryParamsEntry={csubJobId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "csubJobId" ] }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubJobQueueTable": { "get": { "summary": "Get csubJobQueueTable data", "description": "Retrieve csubJobQueueTable operational data from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table lists the subscriber session jobs currently pending\n in the subscriber session job queue.", "properties": { "csubJobQueueEntry": { "type": "array", "description": "csubJobQueueEntry", "items": { "type": "object", "properties": { "csubJobQueueNumber": { "type": "integer", "description": "This object indicates an positive, integer-value that uniquely\n identifies the entry in the table. The value of this object\n starts at '1' and monotonically increases for each subscriber\n session job inserted into the subscriber session job queue. If\n the value of this object is '4294967295', the system will reset\n it to '1' when it inserts the next subscriber session job into\n the subscriber session job queue.", "minimum": 0, "maximum": 4294967295 }, "csubJobQueueJobId": { "type": "string", "description": "This object indicates the identifier associated with the\n subscriber session job.", "x-yang-type": "CISCO-SUBSCRIBER-SESSION-MIB:SubscriberJobIdentifier" } } } } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubJobQueueTable": { "csubJobQueueEntry": [ { "csubJobQueueNumber": 0, "csubJobQueueJobId": "example-string" }, { "csubJobQueueNumber": 0, "csubJobQueueJobId": "example-string" }, { "csubJobQueueNumber": 0, "csubJobQueueJobId": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubJobQueueTable", "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": "/csubJobQueueTable", "x-restconf-kind": "container" }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubJobQueueTable/csubJobQueueEntry": { "get": { "summary": "Get csubJobQueueEntry list", "description": "Retrieve list of csubJobQueueEntry entries from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "csubJobQueueEntry", "items": { "type": "object", "properties": { "csubJobQueueNumber": { "type": "integer", "description": "This object indicates an positive, integer-value that uniquely\n identifies the entry in the table. The value of this object\n starts at '1' and monotonically increases for each subscriber\n session job inserted into the subscriber session job queue. If\n the value of this object is '4294967295', the system will reset\n it to '1' when it inserts the next subscriber session job into\n the subscriber session job queue.", "minimum": 0, "maximum": 4294967295 }, "csubJobQueueJobId": { "type": "string", "description": "This object indicates the identifier associated with the\n subscriber session job.", "x-yang-type": "CISCO-SUBSCRIBER-SESSION-MIB:SubscriberJobIdentifier" } } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubJobQueueEntry": [ { "csubJobQueueNumber": 0, "csubJobQueueJobId": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubJobQueueEntry", "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": "/csubJobQueueTable/csubJobQueueEntry", "x-restconf-kind": "container" }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubJobQueueTable/csubJobQueueEntry={csubJobQueueNumber}": { "get": { "summary": "Get csubJobQueueEntry entry", "description": "Retrieve specific csubJobQueueEntry entry by key from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "parameters": [ { "name": "csubJobQueueNumber", "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": { "csubJobQueueNumber": { "type": "integer", "description": "This object indicates an positive, integer-value that uniquely\n identifies the entry in the table. The value of this object\n starts at '1' and monotonically increases for each subscriber\n session job inserted into the subscriber session job queue. If\n the value of this object is '4294967295', the system will reset\n it to '1' when it inserts the next subscriber session job into\n the subscriber session job queue.", "minimum": 0, "maximum": 4294967295 }, "csubJobQueueJobId": { "type": "string", "description": "This object indicates the identifier associated with the\n subscriber session job.", "x-yang-type": "CISCO-SUBSCRIBER-SESSION-MIB:SubscriberJobIdentifier" } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubJobQueueEntry": { "csubJobQueueNumber": 0, "csubJobQueueJobId": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubJobQueueEntry-2" }, "x-yang-path": "/csubJobQueueTable/csubJobQueueEntry={csubJobQueueNumber}", "x-restconf-kind": "list-instance", "x-list-keys": [ "csubJobQueueNumber" ] }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubJobReportTable": { "get": { "summary": "Get csubJobReportTable data", "description": "Retrieve csubJobReportTable operational data from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table contains the reports corresponding to subscriber\n session jobs that have a csubJobType of 'query' and\n csubJobState of 'finished'.\n \n This table has an expansion dependent relationship on the\n csubJobTable, containing zero or more rows for each job.", "properties": { "csubJobReportEntry": { "type": "array", "description": "csubJobReportEntry", "items": { "type": "object", "properties": { "csubJobId": { "type": "string", "description": "csubJobId", "x-yang-type": "leafref" }, "csubJobReportId": { "type": "integer", "description": "This object indicates an arbitrary, positive, integer-value\n that uniquely identifies this entry in a report. This auxiliary\n value is necessary, as the corresponding subscriber session job\n can specify up to three subscriber identities on which to sort\n the subscriber sessions that end up in the final report.", "minimum": 0, "maximum": 4294967295 }, "csubJobReportSession": { "type": "string", "description": "This object indicates the ifIndex-value assigned to the\n subscriber session that satisfied the match criteria specified\n by the corresponding subscriber session job having a csubJobType\n of 'query'.", "x-yang-type": "if-mib:InterfaceIndex" } } } } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubJobReportTable": { "csubJobReportEntry": [ { "csubJobId": "example-string", "csubJobReportId": 0, "csubJobReportSession": "example-string" }, { "csubJobId": "example-string", "csubJobReportId": 0, "csubJobReportSession": "example-string" }, { "csubJobId": "example-string", "csubJobReportId": 0, "csubJobReportSession": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubJobReportTable", "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": "/csubJobReportTable", "x-restconf-kind": "container" }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubJobReportTable/csubJobReportEntry": { "get": { "summary": "Get csubJobReportEntry list", "description": "Retrieve list of csubJobReportEntry entries from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "csubJobReportEntry", "items": { "type": "object", "properties": { "csubJobId": { "type": "string", "description": "csubJobId", "x-yang-type": "leafref" }, "csubJobReportId": { "type": "integer", "description": "This object indicates an arbitrary, positive, integer-value\n that uniquely identifies this entry in a report. This auxiliary\n value is necessary, as the corresponding subscriber session job\n can specify up to three subscriber identities on which to sort\n the subscriber sessions that end up in the final report.", "minimum": 0, "maximum": 4294967295 }, "csubJobReportSession": { "type": "string", "description": "This object indicates the ifIndex-value assigned to the\n subscriber session that satisfied the match criteria specified\n by the corresponding subscriber session job having a csubJobType\n of 'query'.", "x-yang-type": "if-mib:InterfaceIndex" } } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubJobReportEntry": [ { "csubJobId": "example-string", "csubJobReportId": 0, "csubJobReportSession": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubJobReportEntry", "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": "/csubJobReportTable/csubJobReportEntry", "x-restconf-kind": "container" }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubSessionEntry": { "get": { "summary": "Get csubSessionEntry list", "description": "Retrieve list of csubSessionEntry entries from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "csubSessionEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "csubSessionType": { "type": "string", "description": "This object indicates the type of subscriber session.", "x-yang-type": "cisco-subscriber:SubSessionType" }, "csubSessionIpAddrAssignment": { "type": "string", "description": "This object indicates how the system assigns IP addresses to\n the subscriber:\n \n 'none'\n The system does not an involvement in (or is it aware\n of) the assignment an subscriber IP addresses. For\n example, a system does not have an involvement in the\n assignment of subscriber IP addresses for IP interface\n subscriber sessions.\n \n 'other'\n The system assigns subscriber IP addresses using a\n method not recognized by this MIB module.\n \n 'static'\n Subscriber IP addresses have been configured correctly\n for the service domain. The system does not have an\n involvement in the assignment of the IP address.\n \n 'localPool'\n The system assigns subscriber IP addresses from a\n locally configured pool of IP addresses.\n \n 'dhcpv4'\n The system assigns subscriber IP addresses are using the\n DHCPv4.\n \n 'dhcpv6'\n The system assigns subscriber IP addresses using the\n DHCPv6.\n \n 'userProfileIpAddr'\n The system assigns subscriber IP addresses from a user\n profile.\n \n 'userProfileIpSubnet'\n The system assigns the subscriber an IP subnet from a\n user profile.\n \n 'userProfileNamedPool'\n The system assigns subscriber IP addresses from a\n locally configured named pool specified by a user\n profile." }, "csubSessionState": { "type": "string", "description": "This object indicates the operational state of the subscriber\n session.", "x-yang-type": "cisco-subscriber:SubSessionState" }, "csubSessionAuthenticated": { "type": "boolean", "description": "This object indicates whether the system has successfully\n authenticated the subscriber session.\n \n 'false'\n The subscriber session is operationally up, but in the\n UNAUTHENTICATED state.\n \n 'true'\n The subscriber session is operationally up, but in the\n AUTHENTICATED state." }, "csubSessionRedundancyMode": { "type": "string", "description": "This object indicates the redundancy mode in which the\n subscriber session is operating.", "x-yang-type": "cisco-subscriber:SubSessionRedundancyMode" }, "csubSessionCreationTime": { "type": "string", "description": "This object indicates when the subscriber session was created\n (i.e., when the subscriber session was initiated).", "x-yang-type": "snmpv2-tc:DateAndTime" }, "csubSessionDerivedCfg": { "type": "string", "description": "This object indicates the row in the cdtTemplateTable (defined\n by the CISCO-DYNAMIC-TEMPLATE-MIB) describing the derived\n configuration for the subscriber session.\n \n Observe that the value of cdtTemplateType corresponding to the\n referenced row must be 'derived'.", "x-yang-type": "cisco-dynamic:DynamicTemplateName" }, "csubSessionAvailableIdentities": { "type": "string", "description": "This object indicates the subscriber identities that the system\n has successfully collected for the subscriber session.\n \n Each bit in this bit string corresponds to a column in this\n table. If the bit is '0', then the value of the corresponding\n column is invalid. If the bit is '1', then the value of the\n corresponding column represents the value of the subscriber\n identity collected by the system.\n \n The following list specifies the mappings between the bits and\n the columns:\n \n 'subscriberLabel' => csubSessionSubscriberLabel\n 'macAddress' => csubSessionMacAddress\n 'nativeVrf' => csubSessionNativeVrf\n 'nativeIpAddress' => csubSessionNativeIpAddrType,\n csubSessionNativeIpAddr,\n csubSessionNativeIpMask\n 'nativeIpAddress2'=> csubSessionNativeIpAddrType2,\n csubSessionNativeIpAddr2,\n csubSessionNativeIpMask2 \n 'domainVrf' => csubSessionDomainVrf\n 'domainIpAddress' => csubSessionDomainIpAddrType,\n csubSessionDomainIpAddr,\n csubSessionDomainIpMask\n 'pbhk' => csubSessionPbhk\n 'remoteId' => csubSessionRemoteId\n 'circuitId' => csubSessionCircuitId\n 'nasPort' => csubSessionNasPort\n 'domain' => csubSessionDomain\n 'username' => csubSessionUsername\n 'acctSessionId' => csubSessionAcctSessionId\n 'dnis' => csubSessionDnis\n 'media' => csubSessionMedia\n 'mlpNegotiated' => csubSessionMlpNegotiated\n 'protocol' => csubSessionProtocol\n 'dhcpClass' => csubSessionDhcpClass\n 'tunnelName' => csubSessionTunnelName\n \n Observe that the bit 'ifIndex' should always be '1'. This\n identity maps to the ifIndex assigned to the subscriber\n session.\n \n Observe that the bit 'serviceName' maps to one or more instance\n of ccbptPolicyMap (defined by the CISCO-CBP-TARGET-MIB).", "x-yang-type": "cisco-subscriber-identity:SubSessionIdentities" }, "csubSessionSubscriberLabel": { "type": "string", "description": "This object indicates a positive integer-value uniquely\n identifying the subscriber session within the scope of\n the system.\n \n This column is valid only if the 'subscriberLabel' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberLabel" }, "csubSessionMacAddress": { "type": "string", "description": "This object indicates the MAC address of the subscriber.\n \n This column is valid only if the 'macAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "yang:mac-address" }, "csubSessionNativeVrf": { "type": "string", "description": "This object indicates the VRF originating the subscriber\n session.\n \n This column is valid only if the 'nativeVrf' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberVRF" }, "csubSessionNativeIpAddrType": { "type": "string", "description": "This object indicates the type of IP address assigned to the\n subscriber on the customer-facing side of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddressType" }, "csubSessionNativeIpAddr": { "type": "string", "description": "This object indicates the IP address assigned to the\n subscriber on the customer-facing side of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress" }, "csubSessionNativeIpMask": { "type": "string", "description": "This object indicates the corresponding mask for the IP\n address assigned to the subscriber on the customer-facing side\n of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress" }, "csubSessionDomainVrf": { "type": "string", "description": "This object indicates the VRF to which the system transfers\n the subscriber session's traffic.\n \n This column is valid only if the 'domainVrf' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberVRF" }, "csubSessionDomainIpAddrType": { "type": "string", "description": "This object indicates the type of IP address assigned to the\n subscriber on the service-facing side of the system.\n \n This column is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddressType" }, "csubSessionDomainIpAddr": { "type": "string", "description": "This object indicates the IP address assigned to the\n subscriber on the service-facing side of the system.\n \n This column is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress" }, "csubSessionDomainIpMask": { "type": "string", "description": "This object indicates the corresponding mask for the IP\n address assigned to the subscriber on the service-facing side of\n the system.\n \n This column is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress" }, "csubSessionPbhk": { "type": "string", "description": "This object indicates the PBHK identifying the subscriber.\n \n This column is valid only if the 'pbhk' bit of the corresponding\n instance of csubSessionAvailableIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberPbhk" }, "csubSessionRemoteId": { "type": "string", "description": "This object indicates the Remote-Id identifying the 'calling\n station' or AN supporting the circuit that provides access to\n the subscriber.\n \n This column is valid only if the 'remoteId' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberRemoteId" }, "csubSessionCircuitId": { "type": "string", "description": "This object indicates the Circuit-Id identifying the circuit\n supported by the 'calling station' or AN providing access to\n the subscriber.\n \n This column is valid only if the 'circuitId' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberCircuitId" }, "csubSessionNasPort": { "type": "string", "description": "This object indicates the NAS port-identifier identifying the\n port on the NAS providing access to the subscriber.\n \n This column is valid only if the 'nasPort' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberNasPort" }, "csubSessionDomain": { "type": "string", "description": "This object indicates the domain associated with the\n subscriber.\n \n This column is valid only if the 'domain' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDomain" }, "csubSessionUsername": { "type": "string", "description": "This object indicates the username identifying the subscriber.\n \n This column is valid only if the 'username' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberUsername" }, "csubSessionAcctSessionId": { "type": "string", "description": "This object indicates the accounting session identifier\n assigned to the subscriber session.\n \n This column is valid only if the 'accountingSid' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberAcctSessionId" }, "csubSessionDnis": { "type": "string", "description": "This object indicates the DNIS number dialed by the\n subscriber to access the 'calling station' or AN.\n \n This column is valid only if the 'dnis' bit of the corresponding\n instance of csubSessionAvailableIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDnis" }, "csubSessionMedia": { "type": "string", "description": "This object indicates the type of media providing access to\n the subscriber.\n \n This column is valid only if the 'media' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberMediaType" }, "csubSessionMlpNegotiated": { "type": "boolean", "description": "This object indicates whether the subscriber session was\n established using multi-link PPP negotiation.\n \n This column is valid only if the 'mlpNegotiated' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'." }, "csubSessionProtocol": { "type": "string", "description": "This object indicates the type of protocol providing access to\n the subscriber.\n \n This column is valid only if the 'protocol' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberProtocolType" }, "csubSessionDhcpClass": { "type": "string", "description": "This object indicates the name of the class matching the DHCP\n DISCOVER message received from the subscriber.\n \n This column is valid only if the 'dhcpClass' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDhcpClass" }, "csubSessionTunnelName": { "type": "string", "description": "This object indicates the name of the VPDN used to carry the\n subscriber session to the system.\n \n This column is valid only if the 'tunnelName' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberTunnelName" }, "csubSessionLocationIdentifier": { "type": "string", "description": "This object indicates the location of the\n subscriber", "x-yang-type": "cisco-subscriber-identity:SubscriberLocationName" }, "csubSessionServiceIdentifier": { "type": "string", "description": "This object indicates the name used to identify the services\n subscribed by a particular session.", "x-yang-type": "cisco-subscriber-identity:SubscriberServiceName" }, "csubSessionLastChanged": { "type": "string", "description": "This object indicates when the subscriber session is updated\n with new policy information.", "x-yang-type": "snmpv2-tc:DateAndTime" }, "csubSessionNativeIpAddrType2": { "type": "string", "description": "This object indicates the type of IP address assigned to the\n subscriber on the customer-facing side of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.\n \n In Dual stack scenarios both 'csubSessionNativeIpAddrType' and \n 'csubSessionNativeIpAddrType2' will be valid", "x-yang-type": "inet-address:InetAddressType" }, "csubSessionNativeIpAddr2": { "type": "string", "description": "This object indicates the IP address assigned to the\n subscriber on the customer-facing side of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress" }, "csubSessionNativeIpMask2": { "type": "string", "description": "This object indicates the corresponding mask for the IP\n address assigned to the subscriber on the customer-facing side\n of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress" } } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubSessionEntry": [ { "ifIndex": "example-string", "csubSessionType": "ethernetCsmacd(6)", "csubSessionIpAddrAssignment": "192.168.1.1", "csubSessionState": "up(1)", "csubSessionAuthenticated": true, "csubSessionRedundancyMode": "example-string", "csubSessionCreationTime": "example-string", "csubSessionDerivedCfg": "example-string", "csubSessionAvailableIdentities": "example-string", "csubSessionSubscriberLabel": "example-string", "csubSessionMacAddress": "00:11:22:33:44:55", "csubSessionNativeVrf": "example-string", "csubSessionNativeIpAddrType": "192.168.1.1", "csubSessionNativeIpAddr": "192.168.1.1", "csubSessionNativeIpMask": "192.168.1.1", "csubSessionDomainVrf": "example-string", "csubSessionDomainIpAddrType": "192.168.1.1", "csubSessionDomainIpAddr": "192.168.1.1", "csubSessionDomainIpMask": "192.168.1.1", "csubSessionPbhk": "example-string", "csubSessionRemoteId": "example-string", "csubSessionCircuitId": "example-string", "csubSessionNasPort": "example-string", "csubSessionDomain": "example-string", "csubSessionUsername": "interface-1", "csubSessionAcctSessionId": "example-string", "csubSessionDnis": "example-string", "csubSessionMedia": "example-string", "csubSessionMlpNegotiated": true, "csubSessionProtocol": "example-string", "csubSessionDhcpClass": "example-string", "csubSessionTunnelName": "interface-1", "csubSessionLocationIdentifier": "example-string", "csubSessionServiceIdentifier": "example-string", "csubSessionLastChanged": "example-string", "csubSessionNativeIpAddrType2": "192.168.1.1", "csubSessionNativeIpAddr2": "192.168.1.1", "csubSessionNativeIpMask2": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubSessionEntry-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": "/csubSessionEntry", "x-restconf-kind": "container" }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubSessionEntry={ifIndex}": { "get": { "summary": "Get csubSessionEntry entry", "description": "Retrieve specific csubSessionEntry entry by key from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "parameters": [ { "name": "ifIndex", "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": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "csubSessionType": { "type": "string", "description": "This object indicates the type of subscriber session.", "x-yang-type": "cisco-subscriber:SubSessionType" }, "csubSessionIpAddrAssignment": { "type": "string", "description": "This object indicates how the system assigns IP addresses to\n the subscriber:\n \n 'none'\n The system does not an involvement in (or is it aware\n of) the assignment an subscriber IP addresses. For\n example, a system does not have an involvement in the\n assignment of subscriber IP addresses for IP interface\n subscriber sessions.\n \n 'other'\n The system assigns subscriber IP addresses using a\n method not recognized by this MIB module.\n \n 'static'\n Subscriber IP addresses have been configured correctly\n for the service domain. The system does not have an\n involvement in the assignment of the IP address.\n \n 'localPool'\n The system assigns subscriber IP addresses from a\n locally configured pool of IP addresses.\n \n 'dhcpv4'\n The system assigns subscriber IP addresses are using the\n DHCPv4.\n \n 'dhcpv6'\n The system assigns subscriber IP addresses using the\n DHCPv6.\n \n 'userProfileIpAddr'\n The system assigns subscriber IP addresses from a user\n profile.\n \n 'userProfileIpSubnet'\n The system assigns the subscriber an IP subnet from a\n user profile.\n \n 'userProfileNamedPool'\n The system assigns subscriber IP addresses from a\n locally configured named pool specified by a user\n profile." }, "csubSessionState": { "type": "string", "description": "This object indicates the operational state of the subscriber\n session.", "x-yang-type": "cisco-subscriber:SubSessionState" }, "csubSessionAuthenticated": { "type": "boolean", "description": "This object indicates whether the system has successfully\n authenticated the subscriber session.\n \n 'false'\n The subscriber session is operationally up, but in the\n UNAUTHENTICATED state.\n \n 'true'\n The subscriber session is operationally up, but in the\n AUTHENTICATED state." }, "csubSessionRedundancyMode": { "type": "string", "description": "This object indicates the redundancy mode in which the\n subscriber session is operating.", "x-yang-type": "cisco-subscriber:SubSessionRedundancyMode" }, "csubSessionCreationTime": { "type": "string", "description": "This object indicates when the subscriber session was created\n (i.e., when the subscriber session was initiated).", "x-yang-type": "snmpv2-tc:DateAndTime" }, "csubSessionDerivedCfg": { "type": "string", "description": "This object indicates the row in the cdtTemplateTable (defined\n by the CISCO-DYNAMIC-TEMPLATE-MIB) describing the derived\n configuration for the subscriber session.\n \n Observe that the value of cdtTemplateType corresponding to the\n referenced row must be 'derived'.", "x-yang-type": "cisco-dynamic:DynamicTemplateName" }, "csubSessionAvailableIdentities": { "type": "string", "description": "This object indicates the subscriber identities that the system\n has successfully collected for the subscriber session.\n \n Each bit in this bit string corresponds to a column in this\n table. If the bit is '0', then the value of the corresponding\n column is invalid. If the bit is '1', then the value of the\n corresponding column represents the value of the subscriber\n identity collected by the system.\n \n The following list specifies the mappings between the bits and\n the columns:\n \n 'subscriberLabel' => csubSessionSubscriberLabel\n 'macAddress' => csubSessionMacAddress\n 'nativeVrf' => csubSessionNativeVrf\n 'nativeIpAddress' => csubSessionNativeIpAddrType,\n csubSessionNativeIpAddr,\n csubSessionNativeIpMask\n 'nativeIpAddress2'=> csubSessionNativeIpAddrType2,\n csubSessionNativeIpAddr2,\n csubSessionNativeIpMask2 \n 'domainVrf' => csubSessionDomainVrf\n 'domainIpAddress' => csubSessionDomainIpAddrType,\n csubSessionDomainIpAddr,\n csubSessionDomainIpMask\n 'pbhk' => csubSessionPbhk\n 'remoteId' => csubSessionRemoteId\n 'circuitId' => csubSessionCircuitId\n 'nasPort' => csubSessionNasPort\n 'domain' => csubSessionDomain\n 'username' => csubSessionUsername\n 'acctSessionId' => csubSessionAcctSessionId\n 'dnis' => csubSessionDnis\n 'media' => csubSessionMedia\n 'mlpNegotiated' => csubSessionMlpNegotiated\n 'protocol' => csubSessionProtocol\n 'dhcpClass' => csubSessionDhcpClass\n 'tunnelName' => csubSessionTunnelName\n \n Observe that the bit 'ifIndex' should always be '1'. This\n identity maps to the ifIndex assigned to the subscriber\n session.\n \n Observe that the bit 'serviceName' maps to one or more instance\n of ccbptPolicyMap (defined by the CISCO-CBP-TARGET-MIB).", "x-yang-type": "cisco-subscriber-identity:SubSessionIdentities" }, "csubSessionSubscriberLabel": { "type": "string", "description": "This object indicates a positive integer-value uniquely\n identifying the subscriber session within the scope of\n the system.\n \n This column is valid only if the 'subscriberLabel' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberLabel" }, "csubSessionMacAddress": { "type": "string", "description": "This object indicates the MAC address of the subscriber.\n \n This column is valid only if the 'macAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "yang:mac-address" }, "csubSessionNativeVrf": { "type": "string", "description": "This object indicates the VRF originating the subscriber\n session.\n \n This column is valid only if the 'nativeVrf' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberVRF" }, "csubSessionNativeIpAddrType": { "type": "string", "description": "This object indicates the type of IP address assigned to the\n subscriber on the customer-facing side of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddressType" }, "csubSessionNativeIpAddr": { "type": "string", "description": "This object indicates the IP address assigned to the\n subscriber on the customer-facing side of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress" }, "csubSessionNativeIpMask": { "type": "string", "description": "This object indicates the corresponding mask for the IP\n address assigned to the subscriber on the customer-facing side\n of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress" }, "csubSessionDomainVrf": { "type": "string", "description": "This object indicates the VRF to which the system transfers\n the subscriber session's traffic.\n \n This column is valid only if the 'domainVrf' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberVRF" }, "csubSessionDomainIpAddrType": { "type": "string", "description": "This object indicates the type of IP address assigned to the\n subscriber on the service-facing side of the system.\n \n This column is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddressType" }, "csubSessionDomainIpAddr": { "type": "string", "description": "This object indicates the IP address assigned to the\n subscriber on the service-facing side of the system.\n \n This column is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress" }, "csubSessionDomainIpMask": { "type": "string", "description": "This object indicates the corresponding mask for the IP\n address assigned to the subscriber on the service-facing side of\n the system.\n \n This column is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress" }, "csubSessionPbhk": { "type": "string", "description": "This object indicates the PBHK identifying the subscriber.\n \n This column is valid only if the 'pbhk' bit of the corresponding\n instance of csubSessionAvailableIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberPbhk" }, "csubSessionRemoteId": { "type": "string", "description": "This object indicates the Remote-Id identifying the 'calling\n station' or AN supporting the circuit that provides access to\n the subscriber.\n \n This column is valid only if the 'remoteId' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberRemoteId" }, "csubSessionCircuitId": { "type": "string", "description": "This object indicates the Circuit-Id identifying the circuit\n supported by the 'calling station' or AN providing access to\n the subscriber.\n \n This column is valid only if the 'circuitId' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberCircuitId" }, "csubSessionNasPort": { "type": "string", "description": "This object indicates the NAS port-identifier identifying the\n port on the NAS providing access to the subscriber.\n \n This column is valid only if the 'nasPort' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberNasPort" }, "csubSessionDomain": { "type": "string", "description": "This object indicates the domain associated with the\n subscriber.\n \n This column is valid only if the 'domain' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDomain" }, "csubSessionUsername": { "type": "string", "description": "This object indicates the username identifying the subscriber.\n \n This column is valid only if the 'username' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberUsername" }, "csubSessionAcctSessionId": { "type": "string", "description": "This object indicates the accounting session identifier\n assigned to the subscriber session.\n \n This column is valid only if the 'accountingSid' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberAcctSessionId" }, "csubSessionDnis": { "type": "string", "description": "This object indicates the DNIS number dialed by the\n subscriber to access the 'calling station' or AN.\n \n This column is valid only if the 'dnis' bit of the corresponding\n instance of csubSessionAvailableIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDnis" }, "csubSessionMedia": { "type": "string", "description": "This object indicates the type of media providing access to\n the subscriber.\n \n This column is valid only if the 'media' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberMediaType" }, "csubSessionMlpNegotiated": { "type": "boolean", "description": "This object indicates whether the subscriber session was\n established using multi-link PPP negotiation.\n \n This column is valid only if the 'mlpNegotiated' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'." }, "csubSessionProtocol": { "type": "string", "description": "This object indicates the type of protocol providing access to\n the subscriber.\n \n This column is valid only if the 'protocol' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberProtocolType" }, "csubSessionDhcpClass": { "type": "string", "description": "This object indicates the name of the class matching the DHCP\n DISCOVER message received from the subscriber.\n \n This column is valid only if the 'dhcpClass' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDhcpClass" }, "csubSessionTunnelName": { "type": "string", "description": "This object indicates the name of the VPDN used to carry the\n subscriber session to the system.\n \n This column is valid only if the 'tunnelName' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberTunnelName" }, "csubSessionLocationIdentifier": { "type": "string", "description": "This object indicates the location of the\n subscriber", "x-yang-type": "cisco-subscriber-identity:SubscriberLocationName" }, "csubSessionServiceIdentifier": { "type": "string", "description": "This object indicates the name used to identify the services\n subscribed by a particular session.", "x-yang-type": "cisco-subscriber-identity:SubscriberServiceName" }, "csubSessionLastChanged": { "type": "string", "description": "This object indicates when the subscriber session is updated\n with new policy information.", "x-yang-type": "snmpv2-tc:DateAndTime" }, "csubSessionNativeIpAddrType2": { "type": "string", "description": "This object indicates the type of IP address assigned to the\n subscriber on the customer-facing side of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.\n \n In Dual stack scenarios both 'csubSessionNativeIpAddrType' and \n 'csubSessionNativeIpAddrType2' will be valid", "x-yang-type": "inet-address:InetAddressType" }, "csubSessionNativeIpAddr2": { "type": "string", "description": "This object indicates the IP address assigned to the\n subscriber on the customer-facing side of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress" }, "csubSessionNativeIpMask2": { "type": "string", "description": "This object indicates the corresponding mask for the IP\n address assigned to the subscriber on the customer-facing side\n of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress" } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubSessionEntry": { "ifIndex": "example-string", "csubSessionType": "ethernetCsmacd(6)", "csubSessionIpAddrAssignment": "192.168.1.1", "csubSessionState": "up(1)", "csubSessionAuthenticated": true, "csubSessionRedundancyMode": "example-string", "csubSessionCreationTime": "example-string", "csubSessionDerivedCfg": "example-string", "csubSessionAvailableIdentities": "example-string", "csubSessionSubscriberLabel": "example-string", "csubSessionMacAddress": "00:11:22:33:44:55", "csubSessionNativeVrf": "example-string", "csubSessionNativeIpAddrType": "192.168.1.1", "csubSessionNativeIpAddr": "192.168.1.1", "csubSessionNativeIpMask": "192.168.1.1", "csubSessionDomainVrf": "example-string", "csubSessionDomainIpAddrType": "192.168.1.1", "csubSessionDomainIpAddr": "192.168.1.1", "csubSessionDomainIpMask": "192.168.1.1", "csubSessionPbhk": "example-string", "csubSessionRemoteId": "example-string", "csubSessionCircuitId": "example-string", "csubSessionNasPort": "example-string", "csubSessionDomain": "example-string", "csubSessionUsername": "interface-1", "csubSessionAcctSessionId": "example-string", "csubSessionDnis": "example-string", "csubSessionMedia": "example-string", "csubSessionMlpNegotiated": true, "csubSessionProtocol": "example-string", "csubSessionDhcpClass": "example-string", "csubSessionTunnelName": "interface-1", "csubSessionLocationIdentifier": "example-string", "csubSessionServiceIdentifier": "example-string", "csubSessionLastChanged": "example-string", "csubSessionNativeIpAddrType2": "192.168.1.1", "csubSessionNativeIpAddr2": "192.168.1.1", "csubSessionNativeIpMask2": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubSessionEntry-4" }, "x-yang-path": "/csubSessionEntry={ifIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ifIndex" ] }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubSessionByTypeEntry": { "get": { "summary": "Get csubSessionByTypeEntry list", "description": "Retrieve list of csubSessionByTypeEntry entries from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "csubSessionByTypeEntry", "items": { "type": "object", "properties": { "csubSessionByType": { "type": "string", "description": "This object indicates the type of the subscriber session.", "x-yang-type": "cisco-subscriber:SubSessionType" }, "csubSessionIfIndex": { "type": "string", "description": "This object indicates the ifIndex assigned to the subscriber\n session.", "x-yang-type": "if-mib:InterfaceIndex" } } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubSessionByTypeEntry": [ { "csubSessionByType": "ethernetCsmacd(6)", "csubSessionIfIndex": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubSessionByTypeEntry-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": "/csubSessionByTypeEntry", "x-restconf-kind": "container" }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubAggStatsEntry": { "get": { "summary": "Get csubAggStatsEntry list", "description": "Retrieve list of csubAggStatsEntry entries from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "csubAggStatsEntry", "items": { "type": "object", "properties": { "csubAggStatsPointType": { "type": "string", "description": "This object indicates format of the csubAggStatsPoint\n for this entry. \n \n The format for the csubAggStatsPoint is as follows: \n \n csubAggStatsPointType csubAggStatsPoint \n ---------------------- ------------------ \n 'physical' PhysicalIndex \n 'interface' InterfaceIndex" }, "csubAggStatsPoint": { "type": "integer", "description": "This object should be read with csubAggStatsPointType always.\n \n This object indicates one of the determining factors affecting \n the 'scope of aggregation' for the set of statistics contained \n by the row. \n \n The value indicated by this object should be interpreted as the \n identifier for the point type specific base table. \n \n For point types of 'physical', the type specific base table is \n the entPhysicalTable and this value is a PhysicalIndex. For \n point types of 'interface', the type specific base table is \n the ifTable and this value is an InterfaceIndex. \n \n If this column indicates a physical entity which has an \n entPhysicalClass of 'chassis', then the 'scope of aggregation' \n may includes those subscriber sessions maintained by all nodes \n contained by the system. \n \n If this column indicates a physical entity which has an \n entPhysicalClass of 'module' (e.g., a line card), then the \n 'scope of aggregation' may include those subscriber sessions \n maintained by the nodes contained by the module. \n \n If this column indicates a physical entity which has an \n entPhysicalClass of 'cpu', then the 'scope of aggregation' may \n include those subscriber sessions maintained by the node \n running on the processor. \n \n Aggregation points with entPhysicalTable / ifTable overlap: \n For interfaces which map directly to physical 'port' class \n entities in the entPhysicalTable, the preferred representation \n as aggregation points is the 'physical' point type and \n PhysicalIndex identifier.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsSessionType": { "type": "string", "description": "This object indicates one of the determining factors affecting\n the 'scope of aggregation' for the statistics contained by the\n row.\n \n If the value of this column is 'all', then the 'scope of\n aggregation' may include all subscriber sessions, regardless of\n type.\n \n If the value of this column is not 'all', then the 'scope of\n aggregation' may include subscriber sessions of the indicated\n subscriber session type.", "x-yang-type": "cisco-subscriber:SubSessionType" }, "csubAggStatsPendingSessions": { "type": "integer", "description": "This object indicates the current number of subscriber sessions\n within the 'scope of aggregation' that are in the PENDING\n state.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsUpSessions": { "type": "integer", "description": "This object indicates the current number of subscriber sessions\n within the 'scope of aggregation' that are in the UP state.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsAuthSessions": { "type": "integer", "description": "This object indicates the current number of subscriber session\n within the 'scope of aggregation' that have been authenticated.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsUnAuthSessions": { "type": "integer", "description": "This object indicates the current number of subscriber session\n within the 'scope of aggregation' that have not been authenticated.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsLightWeightSessions": { "type": "integer", "description": "This object indicates the current number of subscriber\n sessions within the 'scope of aggregation' that are less resource intensive.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsRedSessions": { "type": "integer", "description": "This object indicates the current number of subscriber sessions\n within the 'scope of aggregation' that are redundant (i.e., \n sessions with a csubSessionRedundancyMode of 'standby').", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsHighUpSessions": { "type": "integer", "description": "This object indicates the highest number of subscriber sessions\n within the 'scope of aggregation' observed simultaneously in the UP\n state since the last discontinuity time.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsAvgSessionUptime": { "type": "integer", "description": "This object indicates the average time subscriber sessions\n within the 'scope of aggregation' spent in the UP state.\n \n The system calculates this average over all subscriber\n sessions maintained by all nodes contained by the 'scope of\n aggregation' since the last discontinuity time.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsAvgSessionRPM": { "type": "integer", "description": "This object indicates the average rate (per minute) at which\n the nodes contained by the 'scope of aggregation' have\n established new subscriber sessions.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsAvgSessionRPH": { "type": "integer", "description": "This object indicates the average rate (per hour) at which the\n nodes contained by the 'scope of aggregation' have established new\n subscriber sessions.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsThrottleEngagements": { "type": "integer", "description": "This object indicates the number of times that nodes contained\n within the 'scope of aggregation' have engaged the subscriber\n session throttle since the last discontinuity time.\n \n The mechanics of a subscriber session throttle vary with\n subscriber session type and implementation. However, the\n general concept of the throttle prevents a node from having\n to deal with more than a configured number of requests to\n establish subscriber sessions from the same CPE within the a\n configured interval of time. When the number of requests\n exceeds the configured threshold within the configured interval,\n then the node processing the requests engages the throttle.\n Typically, when a node engages a throttle, it drops requests\n from the CPE for some period of time, after which the node\n disengages the throttle.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime.", "minimum": 0 }, "csubAggStatsTotalCreatedSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' created since the\n discontinuity time.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime.", "minimum": 0 }, "csubAggStatsTotalFailedSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that were in the PENDING state\n and terminated for reasons other than disconnect since the last\n discontinuity time.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime.", "minimum": 0 }, "csubAggStatsTotalUpSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned to the UP\n state since the last discontinuity time.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime", "minimum": 0 }, "csubAggStatsTotalAuthSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned from the\n UNAUTHENTICATED to the AUTHENTICATED state since the last\n discontinuity time.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime", "minimum": 0 }, "csubAggStatsTotalDiscSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n terminated due to a disconnect event since the last\n discontinuity time.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime", "minimum": 0 }, "csubAggStatsTotalLightWeightSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n that are less resource intensive", "minimum": 0 }, "csubAggStatsTotalFlowsUp": { "type": "integer", "description": "This object indicates the total number of differential traffic classes\n on subscriber sessions. IP ACLs are used to create differential flows(Traffic Classes). \n Each Traffic Class can have a different set of features applied.", "minimum": 0 }, "csubAggStatsDayCreatedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' created during the last 24\n hours.\n \n The system calculates the value of this column by summing the\n values of all instances of csubAggStatsIntCreatedSessions that\n expand this row and have a corresponding csubAggStatsIntValid of\n 'true'.", "x-yang-type": "perfhist-tc:PerfTotalCount" }, "csubAggStatsDayFailedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that were in the PENDING state\n and terminated for reasons other than disconnect during the\n last 24 hours.\n \n The system calculates the value of this column by summing the\n values of all instances of csubAggStatsIntFailedSessions that\n expand this row and have a corresponding csubAggStatsIntValid\n of 'true'.", "x-yang-type": "perfhist-tc:PerfTotalCount" }, "csubAggStatsDayUpSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned to the UP\n state during the last 24 hours.\n \n The system calculates the value of this column by summing the\n values of all instances of csubAggStatsIntUpSessions that\n expand this row and have a corresponding csubAggStatsIntValid\n of 'true'.", "x-yang-type": "perfhist-tc:PerfTotalCount" }, "csubAggStatsDayAuthSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned from the\n UNAUTHENTICATED to the AUTHENTICATED state during the last 24\n hours.\n \n The system calculates the value of this column by summing the\n values of all instances of csubAggStatsIntAuthSessions that\n expand this row and have a corresponding csubAggStatsIntValid of\n 'true'.", "x-yang-type": "perfhist-tc:PerfTotalCount" }, "csubAggStatsDayDiscSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n terminated due to a disconnect event during the last 24 hours.\n \n The system calculates the value of this column by summing the\n values of all instances of csubAggStatsIntDiscSessions that\n expand this row and have a corresponding csubAggStatsIntValid of\n 'true'.", "x-yang-type": "perfhist-tc:PerfTotalCount" }, "csubAggStatsCurrTimeElapsed": { "type": "integer", "description": "This object indicates the time that has elapsed since the\n beginning of the current 15-minute measurement interval. If,\n for some reason, such as an adjustment in the system's\n time-of-day clock, the current interval exceeds the maximum\n value, then the value of this column will be the maximum value.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsCurrValidIntervals": { "type": "integer", "description": "This object indicates the number of intervals for which data\n was collected. The value of this column will be '96' unless the\n measurement was started (or restarted) within 1,440 minutes, in\n which case the value will be the number of complete 15-minute\n intervals for which the system has at least some data.\n \n In certain cases it is possible that some intervals are\n unavailable, in which case the value of this column will\n be maximum interval number for which data is available.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsCurrInvalidIntervals": { "type": "integer", "description": "This object indicates the number of intervals in the range\n from 0 to csubCurrValidIntervals for which no data is\n available. This object will typically be '0' except in certain\n circumstances when some intervals are unavailable.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsCurrFlowsUp": { "type": "integer", "description": "This object indicates the current number of differential traffic classes\n on subscriber sessions currently UP. IP ACLs are used to create differential flows\n (Traffic Classes).Each Traffic Class can have a different set of features applied.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsCurrCreatedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' created during the current\n 15-minute interval.", "x-yang-type": "perfhist-tc:PerfCurrentCount" }, "csubAggStatsCurrFailedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that were in the PENDING state\n and terminated for reasons other than disconnect during the\n current 15-minute interval.", "x-yang-type": "perfhist-tc:PerfCurrentCount" }, "csubAggStatsCurrUpSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned to the UP\n state during the current 15-minute interval.", "x-yang-type": "perfhist-tc:PerfCurrentCount" }, "csubAggStatsCurrAuthSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned from the\n UNAUTHENTICATED to the AUTHENTICATED state during the current\n 15-minute interval.", "x-yang-type": "perfhist-tc:PerfCurrentCount" }, "csubAggStatsCurrDiscSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n terminated due to a disconnect event during the current\n 15-minute interval.", "x-yang-type": "perfhist-tc:PerfCurrentCount" }, "csubAggStatsDiscontinuityTime": { "type": "string", "description": "The date and time (as determined by the system's clock) of\n the most recent occurrence of an event affecting the \n continuity of the aggregation statistics for this aggregation \n point.", "x-yang-type": "snmpv2-tc:DateAndTime" } } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubAggStatsEntry": [ { "csubAggStatsPointType": "ethernetCsmacd(6)", "csubAggStatsPoint": 0, "csubAggStatsSessionType": "ethernetCsmacd(6)", "csubAggStatsPendingSessions": 0, "csubAggStatsUpSessions": 0, "csubAggStatsAuthSessions": 0, "csubAggStatsUnAuthSessions": 0, "csubAggStatsLightWeightSessions": 0, "csubAggStatsRedSessions": 0, "csubAggStatsHighUpSessions": 0, "csubAggStatsAvgSessionUptime": 0, "csubAggStatsAvgSessionRPM": 0, "csubAggStatsAvgSessionRPH": 0, "csubAggStatsThrottleEngagements": 0, "csubAggStatsTotalCreatedSessions": 0, "csubAggStatsTotalFailedSessions": 0, "csubAggStatsTotalUpSessions": 0, "csubAggStatsTotalAuthSessions": 0, "csubAggStatsTotalDiscSessions": 0, "csubAggStatsTotalLightWeightSessions": 0, "csubAggStatsTotalFlowsUp": 0, "csubAggStatsDayCreatedSessions": "example-string", "csubAggStatsDayFailedSessions": "example-string", "csubAggStatsDayUpSessions": "example-string", "csubAggStatsDayAuthSessions": "example-string", "csubAggStatsDayDiscSessions": "example-string", "csubAggStatsCurrTimeElapsed": 0, "csubAggStatsCurrValidIntervals": 0, "csubAggStatsCurrInvalidIntervals": 0, "csubAggStatsCurrFlowsUp": 0, "csubAggStatsCurrCreatedSessions": "example-string", "csubAggStatsCurrFailedSessions": "example-string", "csubAggStatsCurrUpSessions": "example-string", "csubAggStatsCurrAuthSessions": "example-string", "csubAggStatsCurrDiscSessions": "example-string", "csubAggStatsDiscontinuityTime": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubAggStatsEntry-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": "/csubAggStatsEntry", "x-restconf-kind": "container" }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubAggStatsIntEntry": { "get": { "summary": "Get csubAggStatsIntEntry list", "description": "Retrieve list of csubAggStatsIntEntry entries from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry contains the aggregated subscriber session performance\n data collected over a single 15-minute measurement interval\n within a 'scope of aggregation'. For further details regarding\n 'scope of aggregation', see the descriptive text associated with\n the csubAggStatsEntry.", "items": { "type": "object", "properties": { "csubAggStatsPointType": { "type": "string", "description": "csubAggStatsPointType", "x-yang-type": "leafref" }, "csubAggStatsPoint": { "type": "string", "description": "csubAggStatsPoint", "x-yang-type": "leafref" }, "csubAggStatsSessionType": { "type": "string", "description": "csubAggStatsSessionType", "x-yang-type": "leafref" }, "csubAggStatsIntNumber": { "type": "integer", "description": "This object indicates the interval number identifying the\n 15-minute measurement interval for which aggregated subscriber\n session performance data was successfully collected by the\n system.\n \n The interval identified by the value '1' represents the most\n recent 15-minute measurement interval, and the interval\n identified by the value (n) represents the interval immediately\n preceding the interval identified by the value (n-1).", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsIntValid": { "type": "boolean", "description": "This object indicates whether the data for the 15-minute\n measurement interval is valid." }, "csubAggStatsIntCreatedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' created during the 15-minute\n measurement interval.", "x-yang-type": "perfhist-tc:PerfIntervalCount" }, "csubAggStatsIntFailedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that were in the PENDING state\n and terminated for reasons other than disconnect during the\n 15-minute measurement interval.", "x-yang-type": "perfhist-tc:PerfIntervalCount" }, "csubAggStatsIntUpSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned to the UP\n state during the 15-minute measurement interval.", "x-yang-type": "perfhist-tc:PerfIntervalCount" }, "csubAggStatsIntAuthSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned from the\n UNAUTHENTICATED to the AUTHENTICATED state during the\n 15-minute measurement interval.", "x-yang-type": "perfhist-tc:PerfIntervalCount" }, "csubAggStatsIntDiscSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n terminated due to a disconnect event during the 15-minute\n measurement interval.", "x-yang-type": "perfhist-tc:PerfIntervalCount" } } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubAggStatsIntEntry": [ { "csubAggStatsPointType": "ethernetCsmacd(6)", "csubAggStatsPoint": "example-string", "csubAggStatsSessionType": "ethernetCsmacd(6)", "csubAggStatsIntNumber": 0, "csubAggStatsIntValid": true, "csubAggStatsIntCreatedSessions": "example-string", "csubAggStatsIntFailedSessions": "example-string", "csubAggStatsIntUpSessions": "example-string", "csubAggStatsIntAuthSessions": "example-string", "csubAggStatsIntDiscSessions": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubAggStatsIntEntry-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": "/csubAggStatsIntEntry", "x-restconf-kind": "container" }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubAggStatsThreshEntry": { "get": { "summary": "Get csubAggStatsThreshEntry list", "description": "Retrieve list of csubAggStatsThreshEntry entries from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A row in this table exists for each row in the\n csubAggStatsTable.\n Each row defines the set of thresholds and evaluation attributes\n for an aggregation point.", "items": { "type": "object", "properties": { "csubSessionRisingThresh": { "type": "integer", "description": "This threshold, if non-zero, indicates the rising threshold\n for the value of csubAggStatsUpSessions for the aggregation\n point,\n When the current sample of csubAggStatsUpSessions is greater\n than\n or equal to this threshold, and the value of\n csubAggStatsUpSessions\n for the last sample interval was less than this thershold, the\n csubSessionRisingNotif is triggered.\n \n If the value of this threshold is 0, the threshold is\n not evaluated.", "minimum": 0, "maximum": 4294967295 }, "csubSessionFallingThresh": { "type": "integer", "description": "This threshold, if non-zero, indicates the falling threshold\n for the value of csubAggStatsUpSessions for the aggregation\n point,\n When the current sample of csubAggStatsUpSessions is less than\n or equal to this threshold, and the value of\n csubAggStatsUpSessions\n for the last sample interval was greater than this thershold,\n the\n csubSessionFallingNotif is triggered.\n \n If the value of this threshold is 0, the threshold is\n not evaluated.", "minimum": 0, "maximum": 4294967295 }, "csubSessionDeltaPercentFallingThresh": { "type": "integer", "description": "This threshold, if non-zero, indicates the delta falling\n threshold\n as a percentage of the value of csubAggStatsUpSessions for the\n aggregation point, The delta as a percentage of\n csubAggStatsUpSessions (delta_percent) is calculated as\n follows:\n current value of csubAggStatsUpSessions = value(n)\n previous sampled value of csubAggStatsUpSessions =\n value(n-1)\n \n delta_percent = ((value(n-1) - value(n)) /\n value(n-1)) * 100\n \n If the delta_percent value of the current evaluation\n interval is\n greater than the value of this threshold, a\n csubSessionDeltaPercentLossNotif is triggered.\n \n If the value of this threshold is 0, the threshold is\n not evaluated.", "minimum": 0, "maximum": 4294967295 }, "csubSessionThreshEvalInterval": { "type": "integer", "description": "The value of this object sets the number of seconds between\n samples\n for threshold evaluation. For implementations capable of\n per-session event evaluation of thresholds this object\n represents the maximum number of seconds between samples.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubAggStatsThreshEntry": [ { "csubSessionRisingThresh": 0, "csubSessionFallingThresh": 0, "csubSessionDeltaPercentFallingThresh": 0, "csubSessionThreshEvalInterval": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubAggStatsThreshEntry-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": "/csubAggStatsThreshEntry", "x-restconf-kind": "container" }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubAggStatsThreshEntry={csubSessionRisingThresh}": { "get": { "summary": "Get csubAggStatsThreshEntry entry", "description": "Retrieve specific csubAggStatsThreshEntry entry by key from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "parameters": [ { "name": "csubSessionRisingThresh", "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": { "csubSessionRisingThresh": { "type": "integer", "description": "This threshold, if non-zero, indicates the rising threshold\n for the value of csubAggStatsUpSessions for the aggregation\n point,\n When the current sample of csubAggStatsUpSessions is greater\n than\n or equal to this threshold, and the value of\n csubAggStatsUpSessions\n for the last sample interval was less than this thershold, the\n csubSessionRisingNotif is triggered.\n \n If the value of this threshold is 0, the threshold is\n not evaluated.", "minimum": 0, "maximum": 4294967295 }, "csubSessionFallingThresh": { "type": "integer", "description": "This threshold, if non-zero, indicates the falling threshold\n for the value of csubAggStatsUpSessions for the aggregation\n point,\n When the current sample of csubAggStatsUpSessions is less than\n or equal to this threshold, and the value of\n csubAggStatsUpSessions\n for the last sample interval was greater than this thershold,\n the\n csubSessionFallingNotif is triggered.\n \n If the value of this threshold is 0, the threshold is\n not evaluated.", "minimum": 0, "maximum": 4294967295 }, "csubSessionDeltaPercentFallingThresh": { "type": "integer", "description": "This threshold, if non-zero, indicates the delta falling\n threshold\n as a percentage of the value of csubAggStatsUpSessions for the\n aggregation point, The delta as a percentage of\n csubAggStatsUpSessions (delta_percent) is calculated as\n follows:\n current value of csubAggStatsUpSessions = value(n)\n previous sampled value of csubAggStatsUpSessions =\n value(n-1)\n \n delta_percent = ((value(n-1) - value(n)) /\n value(n-1)) * 100\n \n If the delta_percent value of the current evaluation\n interval is\n greater than the value of this threshold, a\n csubSessionDeltaPercentLossNotif is triggered.\n \n If the value of this threshold is 0, the threshold is\n not evaluated.", "minimum": 0, "maximum": 4294967295 }, "csubSessionThreshEvalInterval": { "type": "integer", "description": "The value of this object sets the number of seconds between\n samples\n for threshold evaluation. For implementations capable of\n per-session event evaluation of thresholds this object\n represents the maximum number of seconds between samples.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubAggStatsThreshEntry": { "csubSessionRisingThresh": 0, "csubSessionFallingThresh": 0, "csubSessionDeltaPercentFallingThresh": 0, "csubSessionThreshEvalInterval": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubAggStatsThreshEntry-4" }, "x-yang-path": "/csubAggStatsThreshEntry={csubSessionRisingThresh}", "x-restconf-kind": "list-instance", "x-list-keys": [ "csubSessionRisingThresh" ] }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubJobEntry": { "get": { "summary": "Get csubJobEntry list", "description": "Retrieve list of csubJobEntry entries from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "csubJobEntry", "items": { "type": "object", "properties": { "csubJobId": { "type": "string", "description": "This object indicates an arbitrary, positive integer-value\n uniquely identifying the subscriber session job.", "x-yang-type": "CISCO-SUBSCRIBER-SESSION-MIB:SubscriberJobIdentifier" }, "csubJobStatus": { "type": "string", "description": "This object specifies the status of the subscriber session\n job. The following columns must be valid before activating a\n subscriber session job:\n \n - csubJobStorage\n - csubJobType\n - csubJobControl\n \n However, these objects specify a default value. Thus, it is\n possible to use create-and-go semantics without setting any\n additional columns.\n \n An implementation must allow the EMS/NMS to modify any column\n when this column is 'active', including columns defined in\n tables that have a one-to-one or sparse dependent relationship\n on this table.", "x-yang-type": "snmpv2-tc:RowStatus" }, "csubJobStorage": { "type": "string", "description": "This object specifies what happens to the subscriber session\n job upon restart.", "x-yang-type": "snmpv2-tc:StorageType" }, "csubJobType": { "type": "string", "description": "This object specifies the type of subscriber session job:\n \n 'noop'\n This type of job does nothing and simply serves as a\n convenient default value for newly created jobs, thereby\n allowing create-and-go row creation without having to\n specify the type of job.\n \n 'query'\n This type of job starts a subscriber session query. The\n system searches for any subscriber sessions matching the\n configured criteria and sorts them into a resulting\n report.\n \n Upon activation of a subscriber session with this value,\n the system automatically creates corresponding rows in\n the csubJobMatchParamsTable and csubQueryParamsTable.\n \n 'clear'\n This type of job causes the system to terminated all\n subscriber sessions matching configured criteria.\n \n Upon activation of a subscriber session with this value,\n the system automatically creates a corresponding row in\n the csubJobMatchParamsTable." }, "csubJobControl": { "type": "string", "description": "This object specifies an action relating to the subscriber\n session job:\n \n 'noop'\n This action does nothing.\n \n 'start'\n If the corresponding instance of csubJobType is 'noop',\n then this action simply causes the system to set the\n corresponding instances of csubJobState and\n csubJobFinishedReason to 'finished' and 'normal',\n respectively.\n \n If the corresponding instance of csubJobType is not\n 'noop' and the system is not executing a subscriber\n session job, then this action causes the system\n immediately execute the subscriber session job.\n \n If the corresponding instance of csubJobType is not\n 'noop' and the system is already executing a subscriber\n session job, then this action causes the system to put\n the job on the subscriber session job queue.\n \n 'abort'\n If the subscriber session job is in the subscriber\n session job queue, then this action causes the system to\n remove the job from the queue.\n \n If the system is executing the subscriber session job,\n then this action causes the system to stop the job.\n \n 'release'\n This action causes the system to destroy any\n corresponding rows in the csubJobReportTable.\n \n The system only accepts this action for a previously\n executed subscriber session job having a corresponding\n instance of csubJobType set to 'query'. Any attempt to\n issue this action under other circumstances will result\n in a response indicating an error-status of\n 'inconsistentValue'.\n \n When read, this column is always 'noop'." }, "csubJobState": { "type": "string", "description": "This object indicates the current state of the subscriber\n session job:\n \n 'idle'\n This state indicates that the system has not executed\n the subscriber session job since it was created.\n \n 'pending'\n This state indicates that the subscriber session job is\n waiting in the subscriber session job queue.\n \n 'inProgress'\n This state indicates that the system is executing the\n subscriber session job. Observe that the system may\n execute more than one subscriber session job at a time.\n \n 'finished'\n This state indicates that the system has executed the\n subscriber session job and it has finished. The\n corresponding instance of csubJobFinishedReason\n indicates further details regarding the reason why the\n job finished." }, "csubJobStartedTime": { "type": "string", "description": "This object indicates the value of sysUpTime when the system\n started executing the subscriber session job. This value will\n be '0' when the corresponding instance of csubJobState is 'idle'\n or 'pending'.", "x-yang-type": "yang:timestamp" }, "csubJobFinishedTime": { "type": "string", "description": "This object indicates the value of sysUpTime when the system\n finished executing the subscriber session job, for whatever\n reason. This value will be '0' when the corresponding instance\n of csubJobState is 'idle', 'pending', or 'inProgress'.", "x-yang-type": "yang:timestamp" }, "csubJobFinishedReason": { "type": "string", "description": "This object indicates the reason why the system finished\n executing the subscriber session job:\n \n 'invalid'\n Indicates that the corresponding instance of\n csubJobState is either 'idle', 'pending', or\n 'inProgress'.\n \n 'other'\n Indicates that the system finished executing the\n subscriber session job abnormally for a reason not\n recognized by this MIB module.\n \n 'normal'\n Indicates that the system finished executing the\n subscriber session job with no problems.\n \n 'aborted'\n Indicates that the system finished executing the\n subscriber session job as the result of the EMS/NMS\n writing 'abort' to the corresponding instance of\n csubJobControl.\n \n 'insufficientResources'\n Indicates that the system finished executing the\n subscriber session job abnormally due to insufficient\n resources to continue.\n \n 'error'\n Indicates that the system encountered an error that\n prevented it from completing the job." } } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubJobEntry": [ { "csubJobId": "example-string", "csubJobStatus": "up(1)", "csubJobStorage": "example-string", "csubJobType": "ethernetCsmacd(6)", "csubJobControl": "example-string", "csubJobState": "up(1)", "csubJobStartedTime": "example-string", "csubJobFinishedTime": "example-string", "csubJobFinishedReason": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubJobEntry-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": "/csubJobEntry", "x-restconf-kind": "container" }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubJobEntry={csubJobId}": { "get": { "summary": "Get csubJobEntry entry", "description": "Retrieve specific csubJobEntry entry by key from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "parameters": [ { "name": "csubJobId", "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": { "csubJobId": { "type": "string", "description": "This object indicates an arbitrary, positive integer-value\n uniquely identifying the subscriber session job.", "x-yang-type": "CISCO-SUBSCRIBER-SESSION-MIB:SubscriberJobIdentifier" }, "csubJobStatus": { "type": "string", "description": "This object specifies the status of the subscriber session\n job. The following columns must be valid before activating a\n subscriber session job:\n \n - csubJobStorage\n - csubJobType\n - csubJobControl\n \n However, these objects specify a default value. Thus, it is\n possible to use create-and-go semantics without setting any\n additional columns.\n \n An implementation must allow the EMS/NMS to modify any column\n when this column is 'active', including columns defined in\n tables that have a one-to-one or sparse dependent relationship\n on this table.", "x-yang-type": "snmpv2-tc:RowStatus" }, "csubJobStorage": { "type": "string", "description": "This object specifies what happens to the subscriber session\n job upon restart.", "x-yang-type": "snmpv2-tc:StorageType" }, "csubJobType": { "type": "string", "description": "This object specifies the type of subscriber session job:\n \n 'noop'\n This type of job does nothing and simply serves as a\n convenient default value for newly created jobs, thereby\n allowing create-and-go row creation without having to\n specify the type of job.\n \n 'query'\n This type of job starts a subscriber session query. The\n system searches for any subscriber sessions matching the\n configured criteria and sorts them into a resulting\n report.\n \n Upon activation of a subscriber session with this value,\n the system automatically creates corresponding rows in\n the csubJobMatchParamsTable and csubQueryParamsTable.\n \n 'clear'\n This type of job causes the system to terminated all\n subscriber sessions matching configured criteria.\n \n Upon activation of a subscriber session with this value,\n the system automatically creates a corresponding row in\n the csubJobMatchParamsTable." }, "csubJobControl": { "type": "string", "description": "This object specifies an action relating to the subscriber\n session job:\n \n 'noop'\n This action does nothing.\n \n 'start'\n If the corresponding instance of csubJobType is 'noop',\n then this action simply causes the system to set the\n corresponding instances of csubJobState and\n csubJobFinishedReason to 'finished' and 'normal',\n respectively.\n \n If the corresponding instance of csubJobType is not\n 'noop' and the system is not executing a subscriber\n session job, then this action causes the system\n immediately execute the subscriber session job.\n \n If the corresponding instance of csubJobType is not\n 'noop' and the system is already executing a subscriber\n session job, then this action causes the system to put\n the job on the subscriber session job queue.\n \n 'abort'\n If the subscriber session job is in the subscriber\n session job queue, then this action causes the system to\n remove the job from the queue.\n \n If the system is executing the subscriber session job,\n then this action causes the system to stop the job.\n \n 'release'\n This action causes the system to destroy any\n corresponding rows in the csubJobReportTable.\n \n The system only accepts this action for a previously\n executed subscriber session job having a corresponding\n instance of csubJobType set to 'query'. Any attempt to\n issue this action under other circumstances will result\n in a response indicating an error-status of\n 'inconsistentValue'.\n \n When read, this column is always 'noop'." }, "csubJobState": { "type": "string", "description": "This object indicates the current state of the subscriber\n session job:\n \n 'idle'\n This state indicates that the system has not executed\n the subscriber session job since it was created.\n \n 'pending'\n This state indicates that the subscriber session job is\n waiting in the subscriber session job queue.\n \n 'inProgress'\n This state indicates that the system is executing the\n subscriber session job. Observe that the system may\n execute more than one subscriber session job at a time.\n \n 'finished'\n This state indicates that the system has executed the\n subscriber session job and it has finished. The\n corresponding instance of csubJobFinishedReason\n indicates further details regarding the reason why the\n job finished." }, "csubJobStartedTime": { "type": "string", "description": "This object indicates the value of sysUpTime when the system\n started executing the subscriber session job. This value will\n be '0' when the corresponding instance of csubJobState is 'idle'\n or 'pending'.", "x-yang-type": "yang:timestamp" }, "csubJobFinishedTime": { "type": "string", "description": "This object indicates the value of sysUpTime when the system\n finished executing the subscriber session job, for whatever\n reason. This value will be '0' when the corresponding instance\n of csubJobState is 'idle', 'pending', or 'inProgress'.", "x-yang-type": "yang:timestamp" }, "csubJobFinishedReason": { "type": "string", "description": "This object indicates the reason why the system finished\n executing the subscriber session job:\n \n 'invalid'\n Indicates that the corresponding instance of\n csubJobState is either 'idle', 'pending', or\n 'inProgress'.\n \n 'other'\n Indicates that the system finished executing the\n subscriber session job abnormally for a reason not\n recognized by this MIB module.\n \n 'normal'\n Indicates that the system finished executing the\n subscriber session job with no problems.\n \n 'aborted'\n Indicates that the system finished executing the\n subscriber session job as the result of the EMS/NMS\n writing 'abort' to the corresponding instance of\n csubJobControl.\n \n 'insufficientResources'\n Indicates that the system finished executing the\n subscriber session job abnormally due to insufficient\n resources to continue.\n \n 'error'\n Indicates that the system encountered an error that\n prevented it from completing the job." } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubJobEntry": { "csubJobId": "example-string", "csubJobStatus": "up(1)", "csubJobStorage": "example-string", "csubJobType": "ethernetCsmacd(6)", "csubJobControl": "example-string", "csubJobState": "up(1)", "csubJobStartedTime": "example-string", "csubJobFinishedTime": "example-string", "csubJobFinishedReason": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubJobEntry-4" }, "x-yang-path": "/csubJobEntry={csubJobId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "csubJobId" ] }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubJobMatchParamsEntry": { "get": { "summary": "Get csubJobMatchParamsEntry list", "description": "Retrieve list of csubJobMatchParamsEntry entries from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "csubJobMatchParamsEntry", "items": { "type": "object", "properties": { "csubJobId": { "type": "string", "description": "csubJobId", "x-yang-type": "leafref" }, "csubJobMatchIdentities": { "type": "string", "description": "This object specifies the subscriber identities that the\n system uses to determine the subscriber sessions the job\n executes on.\n \n Each bit in this bit string corresponds to one or more columns\n in this table. If the bit is '0', then the value of the\n corresponding columns are invalid. If the bit is '1', then the\n value of corresponding columns are valid.\n \n The following list specifies the mappings between the bits and\n the columns:\n \n 'subscriberLabel' => csubJobMatchSubscriberLabel\n 'macAddress' => csubJobMatchMacAddress\n 'nativeVrf' => csubJobMatchNativeVrf\n 'nativeIpAddress' => csubJobMatchNativeIpAddrType,\n csubJobMatchNativeIpAddr,\n csubJobMatchNativeIpMask,\n 'domainVrf' => csubJobMatchDomainVrf\n 'domainIpAddress' => csubJobMatchDomainIpAddrType,\n csubJobMatchDomainIpAddr,\n csubJobMatchDomainIpMask\n 'pbhk' => csubJobMatchPbhk\n 'remoteId' => csubJobMatchRemoteId\n 'circuitId' => csubJobMatchCircuitId\n 'nasPort' => csubJobMatchNasPort\n 'domain' => csubJobMatchDomain\n 'username' => csubJobMatchUsername\n 'acctSessionId' => csubJobMatchAcctSessionId\n 'dnis' => csubJobMatchDnis\n 'media' => csubJobMatchMedia\n 'mlpNegotiated' => csubJobMatchMlpNegotiated\n 'protocol' => csubJobMatchProtocol\n 'serviceName' => csubJobMatchServiceName\n 'dhcpClass' => csubJobMatchDhcpClass\n 'tunnelName' => csubJobMatchTunnelName\n \n Observe that the bit 'ifIndex' has no meaning, as subscriber\n session jobs do not match against this subscriber session\n identity.", "x-yang-type": "cisco-subscriber-identity:SubSessionIdentities" }, "csubJobMatchOtherParams": { "type": "string", "description": "This object specifies other parameters relating to subscriber\n sessions a subscriber session job may match against.\n \n Each bit in this bit string corresponds to a column in this\n table. If the bit is '0', then the value of the corresponding\n column is invalid. If the bit is '1', then the value of the\n corresponding column represents the value of the parameter\n identity the system should match against for the corresponding\n subscriber session job.\n \n The following list specifies the mappings between bits and the\n columns:\n \n 'danglingDuration' => csubJobMatchDanglingDuration\n 'state' => csubJobMatchState\n 'authenticated' => csubJobMatchAuthenticated\n 'redundancyMode' => csubJobMatchRedundancyMode" }, "csubJobMatchSubscriberLabel": { "type": "string", "description": "This object specifies the subscriber label that the system\n matches against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'subscriberLabel' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberLabel" }, "csubJobMatchMacAddress": { "type": "string", "description": "This object specifies the MAC address that the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'macAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "yang:mac-address" }, "csubJobMatchNativeVrf": { "type": "string", "description": "This object specifies the native VRF the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'nativeVrf' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberVRF" }, "csubJobMatchNativeIpAddrType": { "type": "string", "description": "This object specifies the type of Internet address specified\n by csubJobMatchNativeIpAddr and csubJobMatchNativeIpMask.\n \n This value is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddressType" }, "csubJobMatchNativeIpAddr": { "type": "string", "description": "This object specifies the native IP address that the system\n matches against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddress" }, "csubJobMatchNativeIpMask": { "type": "string", "description": "This object specifies the mask used when matching the native IP\n address against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddress" }, "csubJobMatchDomainVrf": { "type": "string", "description": "This object specifies the domain VRF the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'domainVrf' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberVRF" }, "csubJobMatchDomainIpAddrType": { "type": "string", "description": "This object specifies the type of Internet address specified\n by csubJobMatchDomainIpAddr and csubJobMatchDomainIpMask.\n \n This value is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddressType" }, "csubJobMatchDomainIpAddr": { "type": "string", "description": "This object specifies the domain IP address that the system\n matches against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddress" }, "csubJobMatchDomainIpMask": { "type": "string", "description": "This object specifies the mask used when matching the domain IP\n address against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddress" }, "csubJobMatchPbhk": { "type": "string", "description": "This object specifies the PBHK that the system matches against\n subscriber sessions in the process of executing a subscriber\n session job.\n \n This value is valid only if the 'pbhk' bit of the corresponding\n instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberPbhk" }, "csubJobMatchRemoteId": { "type": "string", "description": "This object specifies the Remote-Id the system matches against\n subscriber sessions in the process of executing a subscriber\n session job.\n \n This value is valid only if the 'remoteId' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberRemoteId" }, "csubJobMatchCircuitId": { "type": "string", "description": "This object specifies the Circuit-Id the system matches against\n subscriber sessions in the process of executing a subscriber\n session job.\n \n This value is valid only if the 'circuitId' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberCircuitId" }, "csubJobMatchNasPort": { "type": "string", "description": "This object specifies the NAS port-identifier the system\n matches against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'nasPort' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberNasPort" }, "csubJobMatchDomain": { "type": "string", "description": "This object specifies the domain the system matches against\n subscriber sessions in the process of executing a subscriber\n session job.\n \n This value is valid only if the 'domain' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDomain" }, "csubJobMatchUsername": { "type": "string", "description": "This object specifies the username the system matches against\n subscriber sessions in the process of executing a subscriber\n session job.\n \n This value is valid only if the 'username' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberUsername" }, "csubJobMatchAcctSessionId": { "type": "string", "description": "This object specifies the accounting session identifier the\n system matches against subscriber sessions in the process of\n executing a subscriber session job.\n \n This value is valid only if the 'accountingSid' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberAcctSessionId" }, "csubJobMatchDnis": { "type": "string", "description": "This object specifies the DNIS number the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'dnis' bit of the corresponding\n instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDnis" }, "csubJobMatchMedia": { "type": "string", "description": "This object specifies the media type the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'media' bit of the corresponding\n instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberMediaType" }, "csubJobMatchMlpNegotiated": { "type": "boolean", "description": "This object specifies the MLP negotiated flag the system\n matches against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'mlpNegotiated' bit of the\n corresponding instance of csubJobMatchIdentities is '1'." }, "csubJobMatchProtocol": { "type": "string", "description": "This object specifies the protocol type the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'protocol' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberProtocolType" }, "csubJobMatchServiceName": { "type": "string", "description": "This object specifies the service name the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'serviceName' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-cbp:CbpElementName" }, "csubJobMatchDhcpClass": { "type": "string", "description": "This object specifies the DHCP class name the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'dhcpClass' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDhcpClass" }, "csubJobMatchTunnelName": { "type": "string", "description": "This object specifies the tunnel name the system matches\n against subscriber session in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'tunnelName' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberTunnelName" }, "csubJobMatchDanglingDuration": { "type": "integer", "description": "This object specifies the minimum interval of time a subscriber\n session can remain dangling in order for the system to consider\n it a match in the process of executing a subscriber session job.\n A 'dangling' subscriber session is one in the PENDING state.\n \n The value '0' cannot be written to an instance of this object.\n However, it serves as a convenient value when the column is not\n valid.\n \n This value is valid only if the 'danglingDuration' bit of the\n corresponding instance of csubJobMatchOtherParams is '1'.", "minimum": 0, "maximum": 4294967295 }, "csubJobMatchState": { "type": "string", "description": "This object specifies the state of a subscriber session in\n order for the system to consider a match in the process of\n executing a subscriber session job.\n \n The value 'other' is not valid and an implementation should\n not allow it to be written to this column.\n \n This value is valid only if the 'state' bit of the\n corresponding instance of csubJobMatchOtherParams is '1'.", "x-yang-type": "cisco-subscriber:SubSessionState" }, "csubJobMatchAuthenticated": { "type": "boolean", "description": "This object specifies whether a subscriber session should be\n unauthenticated for the system to consider a match in the\n process of executing a subscriber session job.\n \n If this column is 'false', then the subscriber session job\n matches subscriber sessions that are unauthenticated.\n \n If this column is 'true', then the subscriber session job\n matches subscriber session that are authenticated.\n \n This value is valid only if the 'authenticated' bit of the\n corresponding instance of csubJobMatchParams is '1'." }, "csubJobMatchRedundancyMode": { "type": "string", "description": "This object specifies the redudancy mode of the subscriber\n session in order for the system to consider a match in the\n process of executing a subscriber session job.\n \n The value 'other' is not valid and an implementation should not\n allow it to be written to this column.\n \n This value is valid only if the 'redundancyMode' bit of the\n corresponding instance of csubJobMatchOtherParams is '1'.", "x-yang-type": "cisco-subscriber:SubSessionRedundancyMode" } } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubJobMatchParamsEntry": [ { "csubJobId": "example-string", "csubJobMatchIdentities": "example-string", "csubJobMatchOtherParams": "example-string", "csubJobMatchSubscriberLabel": "example-string", "csubJobMatchMacAddress": "00:11:22:33:44:55", "csubJobMatchNativeVrf": "example-string", "csubJobMatchNativeIpAddrType": "192.168.1.1", "csubJobMatchNativeIpAddr": "192.168.1.1", "csubJobMatchNativeIpMask": "192.168.1.1", "csubJobMatchDomainVrf": "example-string", "csubJobMatchDomainIpAddrType": "192.168.1.1", "csubJobMatchDomainIpAddr": "192.168.1.1", "csubJobMatchDomainIpMask": "192.168.1.1", "csubJobMatchPbhk": "example-string", "csubJobMatchRemoteId": "example-string", "csubJobMatchCircuitId": "example-string", "csubJobMatchNasPort": "example-string", "csubJobMatchDomain": "example-string", "csubJobMatchUsername": "interface-1", "csubJobMatchAcctSessionId": "example-string", "csubJobMatchDnis": "example-string", "csubJobMatchMedia": "example-string", "csubJobMatchMlpNegotiated": true, "csubJobMatchProtocol": "example-string", "csubJobMatchServiceName": "interface-1", "csubJobMatchDhcpClass": "example-string", "csubJobMatchTunnelName": "interface-1", "csubJobMatchDanglingDuration": 0, "csubJobMatchState": "up(1)", "csubJobMatchAuthenticated": true, "csubJobMatchRedundancyMode": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubJobMatchParamsEntry-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": "/csubJobMatchParamsEntry", "x-restconf-kind": "container" }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubJobMatchParamsEntry={csubJobId}": { "get": { "summary": "Get csubJobMatchParamsEntry entry", "description": "Retrieve specific csubJobMatchParamsEntry entry by key from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "parameters": [ { "name": "csubJobId", "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": { "csubJobId": { "type": "string", "description": "csubJobId", "x-yang-type": "leafref" }, "csubJobMatchIdentities": { "type": "string", "description": "This object specifies the subscriber identities that the\n system uses to determine the subscriber sessions the job\n executes on.\n \n Each bit in this bit string corresponds to one or more columns\n in this table. If the bit is '0', then the value of the\n corresponding columns are invalid. If the bit is '1', then the\n value of corresponding columns are valid.\n \n The following list specifies the mappings between the bits and\n the columns:\n \n 'subscriberLabel' => csubJobMatchSubscriberLabel\n 'macAddress' => csubJobMatchMacAddress\n 'nativeVrf' => csubJobMatchNativeVrf\n 'nativeIpAddress' => csubJobMatchNativeIpAddrType,\n csubJobMatchNativeIpAddr,\n csubJobMatchNativeIpMask,\n 'domainVrf' => csubJobMatchDomainVrf\n 'domainIpAddress' => csubJobMatchDomainIpAddrType,\n csubJobMatchDomainIpAddr,\n csubJobMatchDomainIpMask\n 'pbhk' => csubJobMatchPbhk\n 'remoteId' => csubJobMatchRemoteId\n 'circuitId' => csubJobMatchCircuitId\n 'nasPort' => csubJobMatchNasPort\n 'domain' => csubJobMatchDomain\n 'username' => csubJobMatchUsername\n 'acctSessionId' => csubJobMatchAcctSessionId\n 'dnis' => csubJobMatchDnis\n 'media' => csubJobMatchMedia\n 'mlpNegotiated' => csubJobMatchMlpNegotiated\n 'protocol' => csubJobMatchProtocol\n 'serviceName' => csubJobMatchServiceName\n 'dhcpClass' => csubJobMatchDhcpClass\n 'tunnelName' => csubJobMatchTunnelName\n \n Observe that the bit 'ifIndex' has no meaning, as subscriber\n session jobs do not match against this subscriber session\n identity.", "x-yang-type": "cisco-subscriber-identity:SubSessionIdentities" }, "csubJobMatchOtherParams": { "type": "string", "description": "This object specifies other parameters relating to subscriber\n sessions a subscriber session job may match against.\n \n Each bit in this bit string corresponds to a column in this\n table. If the bit is '0', then the value of the corresponding\n column is invalid. If the bit is '1', then the value of the\n corresponding column represents the value of the parameter\n identity the system should match against for the corresponding\n subscriber session job.\n \n The following list specifies the mappings between bits and the\n columns:\n \n 'danglingDuration' => csubJobMatchDanglingDuration\n 'state' => csubJobMatchState\n 'authenticated' => csubJobMatchAuthenticated\n 'redundancyMode' => csubJobMatchRedundancyMode" }, "csubJobMatchSubscriberLabel": { "type": "string", "description": "This object specifies the subscriber label that the system\n matches against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'subscriberLabel' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberLabel" }, "csubJobMatchMacAddress": { "type": "string", "description": "This object specifies the MAC address that the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'macAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "yang:mac-address" }, "csubJobMatchNativeVrf": { "type": "string", "description": "This object specifies the native VRF the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'nativeVrf' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberVRF" }, "csubJobMatchNativeIpAddrType": { "type": "string", "description": "This object specifies the type of Internet address specified\n by csubJobMatchNativeIpAddr and csubJobMatchNativeIpMask.\n \n This value is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddressType" }, "csubJobMatchNativeIpAddr": { "type": "string", "description": "This object specifies the native IP address that the system\n matches against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddress" }, "csubJobMatchNativeIpMask": { "type": "string", "description": "This object specifies the mask used when matching the native IP\n address against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddress" }, "csubJobMatchDomainVrf": { "type": "string", "description": "This object specifies the domain VRF the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'domainVrf' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberVRF" }, "csubJobMatchDomainIpAddrType": { "type": "string", "description": "This object specifies the type of Internet address specified\n by csubJobMatchDomainIpAddr and csubJobMatchDomainIpMask.\n \n This value is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddressType" }, "csubJobMatchDomainIpAddr": { "type": "string", "description": "This object specifies the domain IP address that the system\n matches against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddress" }, "csubJobMatchDomainIpMask": { "type": "string", "description": "This object specifies the mask used when matching the domain IP\n address against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddress" }, "csubJobMatchPbhk": { "type": "string", "description": "This object specifies the PBHK that the system matches against\n subscriber sessions in the process of executing a subscriber\n session job.\n \n This value is valid only if the 'pbhk' bit of the corresponding\n instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberPbhk" }, "csubJobMatchRemoteId": { "type": "string", "description": "This object specifies the Remote-Id the system matches against\n subscriber sessions in the process of executing a subscriber\n session job.\n \n This value is valid only if the 'remoteId' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberRemoteId" }, "csubJobMatchCircuitId": { "type": "string", "description": "This object specifies the Circuit-Id the system matches against\n subscriber sessions in the process of executing a subscriber\n session job.\n \n This value is valid only if the 'circuitId' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberCircuitId" }, "csubJobMatchNasPort": { "type": "string", "description": "This object specifies the NAS port-identifier the system\n matches against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'nasPort' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberNasPort" }, "csubJobMatchDomain": { "type": "string", "description": "This object specifies the domain the system matches against\n subscriber sessions in the process of executing a subscriber\n session job.\n \n This value is valid only if the 'domain' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDomain" }, "csubJobMatchUsername": { "type": "string", "description": "This object specifies the username the system matches against\n subscriber sessions in the process of executing a subscriber\n session job.\n \n This value is valid only if the 'username' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberUsername" }, "csubJobMatchAcctSessionId": { "type": "string", "description": "This object specifies the accounting session identifier the\n system matches against subscriber sessions in the process of\n executing a subscriber session job.\n \n This value is valid only if the 'accountingSid' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberAcctSessionId" }, "csubJobMatchDnis": { "type": "string", "description": "This object specifies the DNIS number the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'dnis' bit of the corresponding\n instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDnis" }, "csubJobMatchMedia": { "type": "string", "description": "This object specifies the media type the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'media' bit of the corresponding\n instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberMediaType" }, "csubJobMatchMlpNegotiated": { "type": "boolean", "description": "This object specifies the MLP negotiated flag the system\n matches against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'mlpNegotiated' bit of the\n corresponding instance of csubJobMatchIdentities is '1'." }, "csubJobMatchProtocol": { "type": "string", "description": "This object specifies the protocol type the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'protocol' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberProtocolType" }, "csubJobMatchServiceName": { "type": "string", "description": "This object specifies the service name the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'serviceName' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-cbp:CbpElementName" }, "csubJobMatchDhcpClass": { "type": "string", "description": "This object specifies the DHCP class name the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'dhcpClass' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDhcpClass" }, "csubJobMatchTunnelName": { "type": "string", "description": "This object specifies the tunnel name the system matches\n against subscriber session in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'tunnelName' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberTunnelName" }, "csubJobMatchDanglingDuration": { "type": "integer", "description": "This object specifies the minimum interval of time a subscriber\n session can remain dangling in order for the system to consider\n it a match in the process of executing a subscriber session job.\n A 'dangling' subscriber session is one in the PENDING state.\n \n The value '0' cannot be written to an instance of this object.\n However, it serves as a convenient value when the column is not\n valid.\n \n This value is valid only if the 'danglingDuration' bit of the\n corresponding instance of csubJobMatchOtherParams is '1'.", "minimum": 0, "maximum": 4294967295 }, "csubJobMatchState": { "type": "string", "description": "This object specifies the state of a subscriber session in\n order for the system to consider a match in the process of\n executing a subscriber session job.\n \n The value 'other' is not valid and an implementation should\n not allow it to be written to this column.\n \n This value is valid only if the 'state' bit of the\n corresponding instance of csubJobMatchOtherParams is '1'.", "x-yang-type": "cisco-subscriber:SubSessionState" }, "csubJobMatchAuthenticated": { "type": "boolean", "description": "This object specifies whether a subscriber session should be\n unauthenticated for the system to consider a match in the\n process of executing a subscriber session job.\n \n If this column is 'false', then the subscriber session job\n matches subscriber sessions that are unauthenticated.\n \n If this column is 'true', then the subscriber session job\n matches subscriber session that are authenticated.\n \n This value is valid only if the 'authenticated' bit of the\n corresponding instance of csubJobMatchParams is '1'." }, "csubJobMatchRedundancyMode": { "type": "string", "description": "This object specifies the redudancy mode of the subscriber\n session in order for the system to consider a match in the\n process of executing a subscriber session job.\n \n The value 'other' is not valid and an implementation should not\n allow it to be written to this column.\n \n This value is valid only if the 'redundancyMode' bit of the\n corresponding instance of csubJobMatchOtherParams is '1'.", "x-yang-type": "cisco-subscriber:SubSessionRedundancyMode" } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubJobMatchParamsEntry": { "csubJobId": "example-string", "csubJobMatchIdentities": "example-string", "csubJobMatchOtherParams": "example-string", "csubJobMatchSubscriberLabel": "example-string", "csubJobMatchMacAddress": "00:11:22:33:44:55", "csubJobMatchNativeVrf": "example-string", "csubJobMatchNativeIpAddrType": "192.168.1.1", "csubJobMatchNativeIpAddr": "192.168.1.1", "csubJobMatchNativeIpMask": "192.168.1.1", "csubJobMatchDomainVrf": "example-string", "csubJobMatchDomainIpAddrType": "192.168.1.1", "csubJobMatchDomainIpAddr": "192.168.1.1", "csubJobMatchDomainIpMask": "192.168.1.1", "csubJobMatchPbhk": "example-string", "csubJobMatchRemoteId": "example-string", "csubJobMatchCircuitId": "example-string", "csubJobMatchNasPort": "example-string", "csubJobMatchDomain": "example-string", "csubJobMatchUsername": "interface-1", "csubJobMatchAcctSessionId": "example-string", "csubJobMatchDnis": "example-string", "csubJobMatchMedia": "example-string", "csubJobMatchMlpNegotiated": true, "csubJobMatchProtocol": "example-string", "csubJobMatchServiceName": "interface-1", "csubJobMatchDhcpClass": "example-string", "csubJobMatchTunnelName": "interface-1", "csubJobMatchDanglingDuration": 0, "csubJobMatchState": "up(1)", "csubJobMatchAuthenticated": true, "csubJobMatchRedundancyMode": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubJobMatchParamsEntry-4" }, "x-yang-path": "/csubJobMatchParamsEntry={csubJobId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "csubJobId" ] }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubJobQueryParamsEntry": { "get": { "summary": "Get csubJobQueryParamsEntry list", "description": "Retrieve list of csubJobQueryParamsEntry entries from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "csubJobQueryParamsEntry", "items": { "type": "object", "properties": { "csubJobId": { "type": "string", "description": "csubJobId", "x-yang-type": "leafref" }, "csubJobQuerySortKey1": { "type": "string", "description": "This object specifies the first subscriber identity that the\n system uses when sorting subscriber sessions into the final\n report corresponding to a subscriber session query.\n \n It is not valid to set this column to 'other' or 'ifIndex'.", "x-yang-type": "cisco-subscriber-identity:SubSessionIdentity" }, "csubJobQuerySortKey2": { "type": "string", "description": "This object specifies the second subscriber identity that the\n system uses when sorting subscriber sessions into the final\n report corresponding to a subscriber session query.\n \n If it is the desire to have the final report sorted on a single\n subscriber identity, then this column should be 'other'.", "x-yang-type": "cisco-subscriber-identity:SubSessionIdentity" }, "csubJobQuerySortKey3": { "type": "string", "description": "This object specifies the third subscriber identity that the\n system uses when sorting subscriber sessions into the final\n report corresponding to a subscriber session query.\n \n If it is the desire to have the final report sorted on one or\n two subscriber identities, then this column should be 'other'.", "x-yang-type": "cisco-subscriber-identity:SubSessionIdentity" }, "csubJobQueryResultingReportSize": { "type": "integer", "description": "This object indicates the number of subscriber sessions that\n matched the corresponding subscriber session query.\n \n The value of this column should be '0' unless the corresponding\n value of csubJobState is 'finished'.\n \n The value of this column should be '0' after the EMS/NMS sets\n the corresponding csubJobControl to 'release'.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubJobQueryParamsEntry": [ { "csubJobId": "example-string", "csubJobQuerySortKey1": "example-string", "csubJobQuerySortKey2": "example-string", "csubJobQuerySortKey3": "example-string", "csubJobQueryResultingReportSize": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubJobQueryParamsEntry-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": "/csubJobQueryParamsEntry", "x-restconf-kind": "container" }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubJobQueryParamsEntry={csubJobId}": { "get": { "summary": "Get csubJobQueryParamsEntry entry", "description": "Retrieve specific csubJobQueryParamsEntry entry by key from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "parameters": [ { "name": "csubJobId", "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": { "csubJobId": { "type": "string", "description": "csubJobId", "x-yang-type": "leafref" }, "csubJobQuerySortKey1": { "type": "string", "description": "This object specifies the first subscriber identity that the\n system uses when sorting subscriber sessions into the final\n report corresponding to a subscriber session query.\n \n It is not valid to set this column to 'other' or 'ifIndex'.", "x-yang-type": "cisco-subscriber-identity:SubSessionIdentity" }, "csubJobQuerySortKey2": { "type": "string", "description": "This object specifies the second subscriber identity that the\n system uses when sorting subscriber sessions into the final\n report corresponding to a subscriber session query.\n \n If it is the desire to have the final report sorted on a single\n subscriber identity, then this column should be 'other'.", "x-yang-type": "cisco-subscriber-identity:SubSessionIdentity" }, "csubJobQuerySortKey3": { "type": "string", "description": "This object specifies the third subscriber identity that the\n system uses when sorting subscriber sessions into the final\n report corresponding to a subscriber session query.\n \n If it is the desire to have the final report sorted on one or\n two subscriber identities, then this column should be 'other'.", "x-yang-type": "cisco-subscriber-identity:SubSessionIdentity" }, "csubJobQueryResultingReportSize": { "type": "integer", "description": "This object indicates the number of subscriber sessions that\n matched the corresponding subscriber session query.\n \n The value of this column should be '0' unless the corresponding\n value of csubJobState is 'finished'.\n \n The value of this column should be '0' after the EMS/NMS sets\n the corresponding csubJobControl to 'release'.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubJobQueryParamsEntry": { "csubJobId": "example-string", "csubJobQuerySortKey1": "example-string", "csubJobQuerySortKey2": "example-string", "csubJobQuerySortKey3": "example-string", "csubJobQueryResultingReportSize": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubJobQueryParamsEntry-4" }, "x-yang-path": "/csubJobQueryParamsEntry={csubJobId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "csubJobId" ] }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubJobQueueEntry": { "get": { "summary": "Get csubJobQueueEntry list", "description": "Retrieve list of csubJobQueueEntry entries from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "csubJobQueueEntry", "items": { "type": "object", "properties": { "csubJobQueueNumber": { "type": "integer", "description": "This object indicates an positive, integer-value that uniquely\n identifies the entry in the table. The value of this object\n starts at '1' and monotonically increases for each subscriber\n session job inserted into the subscriber session job queue. If\n the value of this object is '4294967295', the system will reset\n it to '1' when it inserts the next subscriber session job into\n the subscriber session job queue.", "minimum": 0, "maximum": 4294967295 }, "csubJobQueueJobId": { "type": "string", "description": "This object indicates the identifier associated with the\n subscriber session job.", "x-yang-type": "CISCO-SUBSCRIBER-SESSION-MIB:SubscriberJobIdentifier" } } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubJobQueueEntry": [ { "csubJobQueueNumber": 0, "csubJobQueueJobId": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubJobQueueEntry-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": "/csubJobQueueEntry", "x-restconf-kind": "container" }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubJobQueueEntry={csubJobQueueNumber}": { "get": { "summary": "Get csubJobQueueEntry entry", "description": "Retrieve specific csubJobQueueEntry entry by key from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "parameters": [ { "name": "csubJobQueueNumber", "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": { "csubJobQueueNumber": { "type": "integer", "description": "This object indicates an positive, integer-value that uniquely\n identifies the entry in the table. The value of this object\n starts at '1' and monotonically increases for each subscriber\n session job inserted into the subscriber session job queue. If\n the value of this object is '4294967295', the system will reset\n it to '1' when it inserts the next subscriber session job into\n the subscriber session job queue.", "minimum": 0, "maximum": 4294967295 }, "csubJobQueueJobId": { "type": "string", "description": "This object indicates the identifier associated with the\n subscriber session job.", "x-yang-type": "CISCO-SUBSCRIBER-SESSION-MIB:SubscriberJobIdentifier" } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubJobQueueEntry": { "csubJobQueueNumber": 0, "csubJobQueueJobId": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubJobQueueEntry-4" }, "x-yang-path": "/csubJobQueueEntry={csubJobQueueNumber}", "x-restconf-kind": "list-instance", "x-list-keys": [ "csubJobQueueNumber" ] }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubJobReportEntry": { "get": { "summary": "Get csubJobReportEntry list", "description": "Retrieve list of csubJobReportEntry entries from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "csubJobReportEntry", "items": { "type": "object", "properties": { "csubJobId": { "type": "string", "description": "csubJobId", "x-yang-type": "leafref" }, "csubJobReportId": { "type": "integer", "description": "This object indicates an arbitrary, positive, integer-value\n that uniquely identifies this entry in a report. This auxiliary\n value is necessary, as the corresponding subscriber session job\n can specify up to three subscriber identities on which to sort\n the subscriber sessions that end up in the final report.", "minimum": 0, "maximum": 4294967295 }, "csubJobReportSession": { "type": "string", "description": "This object indicates the ifIndex-value assigned to the\n subscriber session that satisfied the match criteria specified\n by the corresponding subscriber session job having a csubJobType\n of 'query'.", "x-yang-type": "if-mib:InterfaceIndex" } } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubJobReportEntry": [ { "csubJobId": "example-string", "csubJobReportId": 0, "csubJobReportSession": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubJobReportEntry-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": "/csubJobReportEntry", "x-restconf-kind": "container" }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubSessionByTypeTable/csubSessionByTypeEntry={csubSessionByType},{csubSessionIfIndex}": { "get": { "summary": "Get csubSessionByTypeEntry entry", "description": "Retrieve specific csubSessionByTypeEntry entry by key from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "parameters": [ { "name": "csubSessionByType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "csubSessionIfIndex", "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": { "csubSessionByType": { "type": "string", "description": "This object indicates the type of the subscriber session.", "x-yang-type": "cisco-subscriber:SubSessionType" }, "csubSessionIfIndex": { "type": "string", "description": "This object indicates the ifIndex assigned to the subscriber\n session.", "x-yang-type": "if-mib:InterfaceIndex" } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubSessionByTypeEntry": { "csubSessionByType": "ethernetCsmacd(6)", "csubSessionIfIndex": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubSessionByTypeEntry-2" }, "x-yang-path": "/csubSessionByTypeTable/csubSessionByTypeEntry={csubSessionByType csubSessionIfIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "csubSessionByType csubSessionIfIndex" ] }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubAggStatsTable/csubAggStatsEntry={csubAggStatsPointType},{csubAggStatsPoint},{csubAggStatsSessionType}": { "get": { "summary": "Get csubAggStatsEntry entry", "description": "Retrieve specific csubAggStatsEntry entry by key from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "parameters": [ { "name": "csubAggStatsPointType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "csubAggStatsPoint", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "csubAggStatsSessionType", "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": { "csubAggStatsPointType": { "type": "string", "description": "This object indicates format of the csubAggStatsPoint\n for this entry. \n \n The format for the csubAggStatsPoint is as follows: \n \n csubAggStatsPointType csubAggStatsPoint \n ---------------------- ------------------ \n 'physical' PhysicalIndex \n 'interface' InterfaceIndex" }, "csubAggStatsPoint": { "type": "integer", "description": "This object should be read with csubAggStatsPointType always.\n \n This object indicates one of the determining factors affecting \n the 'scope of aggregation' for the set of statistics contained \n by the row. \n \n The value indicated by this object should be interpreted as the \n identifier for the point type specific base table. \n \n For point types of 'physical', the type specific base table is \n the entPhysicalTable and this value is a PhysicalIndex. For \n point types of 'interface', the type specific base table is \n the ifTable and this value is an InterfaceIndex. \n \n If this column indicates a physical entity which has an \n entPhysicalClass of 'chassis', then the 'scope of aggregation' \n may includes those subscriber sessions maintained by all nodes \n contained by the system. \n \n If this column indicates a physical entity which has an \n entPhysicalClass of 'module' (e.g., a line card), then the \n 'scope of aggregation' may include those subscriber sessions \n maintained by the nodes contained by the module. \n \n If this column indicates a physical entity which has an \n entPhysicalClass of 'cpu', then the 'scope of aggregation' may \n include those subscriber sessions maintained by the node \n running on the processor. \n \n Aggregation points with entPhysicalTable / ifTable overlap: \n For interfaces which map directly to physical 'port' class \n entities in the entPhysicalTable, the preferred representation \n as aggregation points is the 'physical' point type and \n PhysicalIndex identifier.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsSessionType": { "type": "string", "description": "This object indicates one of the determining factors affecting\n the 'scope of aggregation' for the statistics contained by the\n row.\n \n If the value of this column is 'all', then the 'scope of\n aggregation' may include all subscriber sessions, regardless of\n type.\n \n If the value of this column is not 'all', then the 'scope of\n aggregation' may include subscriber sessions of the indicated\n subscriber session type.", "x-yang-type": "cisco-subscriber:SubSessionType" }, "csubAggStatsPendingSessions": { "type": "integer", "description": "This object indicates the current number of subscriber sessions\n within the 'scope of aggregation' that are in the PENDING\n state.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsUpSessions": { "type": "integer", "description": "This object indicates the current number of subscriber sessions\n within the 'scope of aggregation' that are in the UP state.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsAuthSessions": { "type": "integer", "description": "This object indicates the current number of subscriber session\n within the 'scope of aggregation' that have been authenticated.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsUnAuthSessions": { "type": "integer", "description": "This object indicates the current number of subscriber session\n within the 'scope of aggregation' that have not been authenticated.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsLightWeightSessions": { "type": "integer", "description": "This object indicates the current number of subscriber\n sessions within the 'scope of aggregation' that are less resource intensive.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsRedSessions": { "type": "integer", "description": "This object indicates the current number of subscriber sessions\n within the 'scope of aggregation' that are redundant (i.e., \n sessions with a csubSessionRedundancyMode of 'standby').", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsHighUpSessions": { "type": "integer", "description": "This object indicates the highest number of subscriber sessions\n within the 'scope of aggregation' observed simultaneously in the UP\n state since the last discontinuity time.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsAvgSessionUptime": { "type": "integer", "description": "This object indicates the average time subscriber sessions\n within the 'scope of aggregation' spent in the UP state.\n \n The system calculates this average over all subscriber\n sessions maintained by all nodes contained by the 'scope of\n aggregation' since the last discontinuity time.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsAvgSessionRPM": { "type": "integer", "description": "This object indicates the average rate (per minute) at which\n the nodes contained by the 'scope of aggregation' have\n established new subscriber sessions.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsAvgSessionRPH": { "type": "integer", "description": "This object indicates the average rate (per hour) at which the\n nodes contained by the 'scope of aggregation' have established new\n subscriber sessions.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsThrottleEngagements": { "type": "integer", "description": "This object indicates the number of times that nodes contained\n within the 'scope of aggregation' have engaged the subscriber\n session throttle since the last discontinuity time.\n \n The mechanics of a subscriber session throttle vary with\n subscriber session type and implementation. However, the\n general concept of the throttle prevents a node from having\n to deal with more than a configured number of requests to\n establish subscriber sessions from the same CPE within the a\n configured interval of time. When the number of requests\n exceeds the configured threshold within the configured interval,\n then the node processing the requests engages the throttle.\n Typically, when a node engages a throttle, it drops requests\n from the CPE for some period of time, after which the node\n disengages the throttle.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime.", "minimum": 0 }, "csubAggStatsTotalCreatedSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' created since the\n discontinuity time.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime.", "minimum": 0 }, "csubAggStatsTotalFailedSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that were in the PENDING state\n and terminated for reasons other than disconnect since the last\n discontinuity time.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime.", "minimum": 0 }, "csubAggStatsTotalUpSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned to the UP\n state since the last discontinuity time.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime", "minimum": 0 }, "csubAggStatsTotalAuthSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned from the\n UNAUTHENTICATED to the AUTHENTICATED state since the last\n discontinuity time.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime", "minimum": 0 }, "csubAggStatsTotalDiscSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n terminated due to a disconnect event since the last\n discontinuity time.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime", "minimum": 0 }, "csubAggStatsTotalLightWeightSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n that are less resource intensive", "minimum": 0 }, "csubAggStatsTotalFlowsUp": { "type": "integer", "description": "This object indicates the total number of differential traffic classes\n on subscriber sessions. IP ACLs are used to create differential flows(Traffic Classes). \n Each Traffic Class can have a different set of features applied.", "minimum": 0 }, "csubAggStatsDayCreatedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' created during the last 24\n hours.\n \n The system calculates the value of this column by summing the\n values of all instances of csubAggStatsIntCreatedSessions that\n expand this row and have a corresponding csubAggStatsIntValid of\n 'true'.", "x-yang-type": "perfhist-tc:PerfTotalCount" }, "csubAggStatsDayFailedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that were in the PENDING state\n and terminated for reasons other than disconnect during the\n last 24 hours.\n \n The system calculates the value of this column by summing the\n values of all instances of csubAggStatsIntFailedSessions that\n expand this row and have a corresponding csubAggStatsIntValid\n of 'true'.", "x-yang-type": "perfhist-tc:PerfTotalCount" }, "csubAggStatsDayUpSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned to the UP\n state during the last 24 hours.\n \n The system calculates the value of this column by summing the\n values of all instances of csubAggStatsIntUpSessions that\n expand this row and have a corresponding csubAggStatsIntValid\n of 'true'.", "x-yang-type": "perfhist-tc:PerfTotalCount" }, "csubAggStatsDayAuthSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned from the\n UNAUTHENTICATED to the AUTHENTICATED state during the last 24\n hours.\n \n The system calculates the value of this column by summing the\n values of all instances of csubAggStatsIntAuthSessions that\n expand this row and have a corresponding csubAggStatsIntValid of\n 'true'.", "x-yang-type": "perfhist-tc:PerfTotalCount" }, "csubAggStatsDayDiscSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n terminated due to a disconnect event during the last 24 hours.\n \n The system calculates the value of this column by summing the\n values of all instances of csubAggStatsIntDiscSessions that\n expand this row and have a corresponding csubAggStatsIntValid of\n 'true'.", "x-yang-type": "perfhist-tc:PerfTotalCount" }, "csubAggStatsCurrTimeElapsed": { "type": "integer", "description": "This object indicates the time that has elapsed since the\n beginning of the current 15-minute measurement interval. If,\n for some reason, such as an adjustment in the system's\n time-of-day clock, the current interval exceeds the maximum\n value, then the value of this column will be the maximum value.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsCurrValidIntervals": { "type": "integer", "description": "This object indicates the number of intervals for which data\n was collected. The value of this column will be '96' unless the\n measurement was started (or restarted) within 1,440 minutes, in\n which case the value will be the number of complete 15-minute\n intervals for which the system has at least some data.\n \n In certain cases it is possible that some intervals are\n unavailable, in which case the value of this column will\n be maximum interval number for which data is available.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsCurrInvalidIntervals": { "type": "integer", "description": "This object indicates the number of intervals in the range\n from 0 to csubCurrValidIntervals for which no data is\n available. This object will typically be '0' except in certain\n circumstances when some intervals are unavailable.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsCurrFlowsUp": { "type": "integer", "description": "This object indicates the current number of differential traffic classes\n on subscriber sessions currently UP. IP ACLs are used to create differential flows\n (Traffic Classes).Each Traffic Class can have a different set of features applied.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsCurrCreatedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' created during the current\n 15-minute interval.", "x-yang-type": "perfhist-tc:PerfCurrentCount" }, "csubAggStatsCurrFailedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that were in the PENDING state\n and terminated for reasons other than disconnect during the\n current 15-minute interval.", "x-yang-type": "perfhist-tc:PerfCurrentCount" }, "csubAggStatsCurrUpSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned to the UP\n state during the current 15-minute interval.", "x-yang-type": "perfhist-tc:PerfCurrentCount" }, "csubAggStatsCurrAuthSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned from the\n UNAUTHENTICATED to the AUTHENTICATED state during the current\n 15-minute interval.", "x-yang-type": "perfhist-tc:PerfCurrentCount" }, "csubAggStatsCurrDiscSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n terminated due to a disconnect event during the current\n 15-minute interval.", "x-yang-type": "perfhist-tc:PerfCurrentCount" }, "csubAggStatsDiscontinuityTime": { "type": "string", "description": "The date and time (as determined by the system's clock) of\n the most recent occurrence of an event affecting the \n continuity of the aggregation statistics for this aggregation \n point.", "x-yang-type": "snmpv2-tc:DateAndTime" } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubAggStatsEntry": { "csubAggStatsPointType": "ethernetCsmacd(6)", "csubAggStatsPoint": 0, "csubAggStatsSessionType": "ethernetCsmacd(6)", "csubAggStatsPendingSessions": 0, "csubAggStatsUpSessions": 0, "csubAggStatsAuthSessions": 0, "csubAggStatsUnAuthSessions": 0, "csubAggStatsLightWeightSessions": 0, "csubAggStatsRedSessions": 0, "csubAggStatsHighUpSessions": 0, "csubAggStatsAvgSessionUptime": 0, "csubAggStatsAvgSessionRPM": 0, "csubAggStatsAvgSessionRPH": 0, "csubAggStatsThrottleEngagements": 0, "csubAggStatsTotalCreatedSessions": 0, "csubAggStatsTotalFailedSessions": 0, "csubAggStatsTotalUpSessions": 0, "csubAggStatsTotalAuthSessions": 0, "csubAggStatsTotalDiscSessions": 0, "csubAggStatsTotalLightWeightSessions": 0, "csubAggStatsTotalFlowsUp": 0, "csubAggStatsDayCreatedSessions": "example-string", "csubAggStatsDayFailedSessions": "example-string", "csubAggStatsDayUpSessions": "example-string", "csubAggStatsDayAuthSessions": "example-string", "csubAggStatsDayDiscSessions": "example-string", "csubAggStatsCurrTimeElapsed": 0, "csubAggStatsCurrValidIntervals": 0, "csubAggStatsCurrInvalidIntervals": 0, "csubAggStatsCurrFlowsUp": 0, "csubAggStatsCurrCreatedSessions": "example-string", "csubAggStatsCurrFailedSessions": "example-string", "csubAggStatsCurrUpSessions": "example-string", "csubAggStatsCurrAuthSessions": "example-string", "csubAggStatsCurrDiscSessions": "example-string", "csubAggStatsDiscontinuityTime": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubAggStatsEntry-2" }, "x-yang-path": "/csubAggStatsTable/csubAggStatsEntry={csubAggStatsPointType csubAggStatsPoint csubAggStatsSessionType}", "x-restconf-kind": "list-instance", "x-list-keys": [ "csubAggStatsPointType csubAggStatsPoint csubAggStatsSessionType" ] }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubAggStatsIntTable/csubAggStatsIntEntry={csubAggStatsPointType},{csubAggStatsPoint},{csubAggStatsSessionType},{csubAggStatsIntNumber}": { "get": { "summary": "Get csubAggStatsIntEntry entry", "description": "Retrieve specific csubAggStatsIntEntry entry by key from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "parameters": [ { "name": "csubAggStatsPointType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "csubAggStatsPoint", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "csubAggStatsSessionType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "csubAggStatsIntNumber", "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": { "csubAggStatsPointType": { "type": "string", "description": "csubAggStatsPointType", "x-yang-type": "leafref" }, "csubAggStatsPoint": { "type": "string", "description": "csubAggStatsPoint", "x-yang-type": "leafref" }, "csubAggStatsSessionType": { "type": "string", "description": "csubAggStatsSessionType", "x-yang-type": "leafref" }, "csubAggStatsIntNumber": { "type": "integer", "description": "This object indicates the interval number identifying the\n 15-minute measurement interval for which aggregated subscriber\n session performance data was successfully collected by the\n system.\n \n The interval identified by the value '1' represents the most\n recent 15-minute measurement interval, and the interval\n identified by the value (n) represents the interval immediately\n preceding the interval identified by the value (n-1).", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsIntValid": { "type": "boolean", "description": "This object indicates whether the data for the 15-minute\n measurement interval is valid." }, "csubAggStatsIntCreatedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' created during the 15-minute\n measurement interval.", "x-yang-type": "perfhist-tc:PerfIntervalCount" }, "csubAggStatsIntFailedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that were in the PENDING state\n and terminated for reasons other than disconnect during the\n 15-minute measurement interval.", "x-yang-type": "perfhist-tc:PerfIntervalCount" }, "csubAggStatsIntUpSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned to the UP\n state during the 15-minute measurement interval.", "x-yang-type": "perfhist-tc:PerfIntervalCount" }, "csubAggStatsIntAuthSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned from the\n UNAUTHENTICATED to the AUTHENTICATED state during the\n 15-minute measurement interval.", "x-yang-type": "perfhist-tc:PerfIntervalCount" }, "csubAggStatsIntDiscSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n terminated due to a disconnect event during the 15-minute\n measurement interval.", "x-yang-type": "perfhist-tc:PerfIntervalCount" } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubAggStatsIntEntry": { "csubAggStatsPointType": "ethernetCsmacd(6)", "csubAggStatsPoint": "example-string", "csubAggStatsSessionType": "ethernetCsmacd(6)", "csubAggStatsIntNumber": 0, "csubAggStatsIntValid": true, "csubAggStatsIntCreatedSessions": "example-string", "csubAggStatsIntFailedSessions": "example-string", "csubAggStatsIntUpSessions": "example-string", "csubAggStatsIntAuthSessions": "example-string", "csubAggStatsIntDiscSessions": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubAggStatsIntEntry-2" }, "x-yang-path": "/csubAggStatsIntTable/csubAggStatsIntEntry={csubAggStatsPointType csubAggStatsPoint csubAggStatsSessionType csubAggStatsIntNumber}", "x-restconf-kind": "list-instance", "x-list-keys": [ "csubAggStatsPointType csubAggStatsPoint csubAggStatsSessionType csubAggStatsIntNumber" ] }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubJobReportTable/csubJobReportEntry={csubJobId},{csubJobReportId}": { "get": { "summary": "Get csubJobReportEntry entry", "description": "Retrieve specific csubJobReportEntry entry by key from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "parameters": [ { "name": "csubJobId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "csubJobReportId", "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": { "csubJobId": { "type": "string", "description": "csubJobId", "x-yang-type": "leafref" }, "csubJobReportId": { "type": "integer", "description": "This object indicates an arbitrary, positive, integer-value\n that uniquely identifies this entry in a report. This auxiliary\n value is necessary, as the corresponding subscriber session job\n can specify up to three subscriber identities on which to sort\n the subscriber sessions that end up in the final report.", "minimum": 0, "maximum": 4294967295 }, "csubJobReportSession": { "type": "string", "description": "This object indicates the ifIndex-value assigned to the\n subscriber session that satisfied the match criteria specified\n by the corresponding subscriber session job having a csubJobType\n of 'query'.", "x-yang-type": "if-mib:InterfaceIndex" } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubJobReportEntry": { "csubJobId": "example-string", "csubJobReportId": 0, "csubJobReportSession": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubJobReportEntry-2" }, "x-yang-path": "/csubJobReportTable/csubJobReportEntry={csubJobId csubJobReportId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "csubJobId csubJobReportId" ] }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubSessionByTypeEntry={csubSessionByType},{csubSessionIfIndex}": { "get": { "summary": "Get csubSessionByTypeEntry entry", "description": "Retrieve specific csubSessionByTypeEntry entry by key from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "parameters": [ { "name": "csubSessionByType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "csubSessionIfIndex", "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": { "csubSessionByType": { "type": "string", "description": "This object indicates the type of the subscriber session.", "x-yang-type": "cisco-subscriber:SubSessionType" }, "csubSessionIfIndex": { "type": "string", "description": "This object indicates the ifIndex assigned to the subscriber\n session.", "x-yang-type": "if-mib:InterfaceIndex" } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubSessionByTypeEntry": { "csubSessionByType": "ethernetCsmacd(6)", "csubSessionIfIndex": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubSessionByTypeEntry-4" }, "x-yang-path": "/csubSessionByTypeEntry={csubSessionByType csubSessionIfIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "csubSessionByType csubSessionIfIndex" ] }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubAggStatsEntry={csubAggStatsPointType},{csubAggStatsPoint},{csubAggStatsSessionType}": { "get": { "summary": "Get csubAggStatsEntry entry", "description": "Retrieve specific csubAggStatsEntry entry by key from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "parameters": [ { "name": "csubAggStatsPointType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "csubAggStatsPoint", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "csubAggStatsSessionType", "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": { "csubAggStatsPointType": { "type": "string", "description": "This object indicates format of the csubAggStatsPoint\n for this entry. \n \n The format for the csubAggStatsPoint is as follows: \n \n csubAggStatsPointType csubAggStatsPoint \n ---------------------- ------------------ \n 'physical' PhysicalIndex \n 'interface' InterfaceIndex" }, "csubAggStatsPoint": { "type": "integer", "description": "This object should be read with csubAggStatsPointType always.\n \n This object indicates one of the determining factors affecting \n the 'scope of aggregation' for the set of statistics contained \n by the row. \n \n The value indicated by this object should be interpreted as the \n identifier for the point type specific base table. \n \n For point types of 'physical', the type specific base table is \n the entPhysicalTable and this value is a PhysicalIndex. For \n point types of 'interface', the type specific base table is \n the ifTable and this value is an InterfaceIndex. \n \n If this column indicates a physical entity which has an \n entPhysicalClass of 'chassis', then the 'scope of aggregation' \n may includes those subscriber sessions maintained by all nodes \n contained by the system. \n \n If this column indicates a physical entity which has an \n entPhysicalClass of 'module' (e.g., a line card), then the \n 'scope of aggregation' may include those subscriber sessions \n maintained by the nodes contained by the module. \n \n If this column indicates a physical entity which has an \n entPhysicalClass of 'cpu', then the 'scope of aggregation' may \n include those subscriber sessions maintained by the node \n running on the processor. \n \n Aggregation points with entPhysicalTable / ifTable overlap: \n For interfaces which map directly to physical 'port' class \n entities in the entPhysicalTable, the preferred representation \n as aggregation points is the 'physical' point type and \n PhysicalIndex identifier.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsSessionType": { "type": "string", "description": "This object indicates one of the determining factors affecting\n the 'scope of aggregation' for the statistics contained by the\n row.\n \n If the value of this column is 'all', then the 'scope of\n aggregation' may include all subscriber sessions, regardless of\n type.\n \n If the value of this column is not 'all', then the 'scope of\n aggregation' may include subscriber sessions of the indicated\n subscriber session type.", "x-yang-type": "cisco-subscriber:SubSessionType" }, "csubAggStatsPendingSessions": { "type": "integer", "description": "This object indicates the current number of subscriber sessions\n within the 'scope of aggregation' that are in the PENDING\n state.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsUpSessions": { "type": "integer", "description": "This object indicates the current number of subscriber sessions\n within the 'scope of aggregation' that are in the UP state.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsAuthSessions": { "type": "integer", "description": "This object indicates the current number of subscriber session\n within the 'scope of aggregation' that have been authenticated.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsUnAuthSessions": { "type": "integer", "description": "This object indicates the current number of subscriber session\n within the 'scope of aggregation' that have not been authenticated.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsLightWeightSessions": { "type": "integer", "description": "This object indicates the current number of subscriber\n sessions within the 'scope of aggregation' that are less resource intensive.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsRedSessions": { "type": "integer", "description": "This object indicates the current number of subscriber sessions\n within the 'scope of aggregation' that are redundant (i.e., \n sessions with a csubSessionRedundancyMode of 'standby').", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsHighUpSessions": { "type": "integer", "description": "This object indicates the highest number of subscriber sessions\n within the 'scope of aggregation' observed simultaneously in the UP\n state since the last discontinuity time.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsAvgSessionUptime": { "type": "integer", "description": "This object indicates the average time subscriber sessions\n within the 'scope of aggregation' spent in the UP state.\n \n The system calculates this average over all subscriber\n sessions maintained by all nodes contained by the 'scope of\n aggregation' since the last discontinuity time.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsAvgSessionRPM": { "type": "integer", "description": "This object indicates the average rate (per minute) at which\n the nodes contained by the 'scope of aggregation' have\n established new subscriber sessions.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsAvgSessionRPH": { "type": "integer", "description": "This object indicates the average rate (per hour) at which the\n nodes contained by the 'scope of aggregation' have established new\n subscriber sessions.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsThrottleEngagements": { "type": "integer", "description": "This object indicates the number of times that nodes contained\n within the 'scope of aggregation' have engaged the subscriber\n session throttle since the last discontinuity time.\n \n The mechanics of a subscriber session throttle vary with\n subscriber session type and implementation. However, the\n general concept of the throttle prevents a node from having\n to deal with more than a configured number of requests to\n establish subscriber sessions from the same CPE within the a\n configured interval of time. When the number of requests\n exceeds the configured threshold within the configured interval,\n then the node processing the requests engages the throttle.\n Typically, when a node engages a throttle, it drops requests\n from the CPE for some period of time, after which the node\n disengages the throttle.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime.", "minimum": 0 }, "csubAggStatsTotalCreatedSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' created since the\n discontinuity time.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime.", "minimum": 0 }, "csubAggStatsTotalFailedSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that were in the PENDING state\n and terminated for reasons other than disconnect since the last\n discontinuity time.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime.", "minimum": 0 }, "csubAggStatsTotalUpSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned to the UP\n state since the last discontinuity time.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime", "minimum": 0 }, "csubAggStatsTotalAuthSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned from the\n UNAUTHENTICATED to the AUTHENTICATED state since the last\n discontinuity time.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime", "minimum": 0 }, "csubAggStatsTotalDiscSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n terminated due to a disconnect event since the last\n discontinuity time.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime", "minimum": 0 }, "csubAggStatsTotalLightWeightSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n that are less resource intensive", "minimum": 0 }, "csubAggStatsTotalFlowsUp": { "type": "integer", "description": "This object indicates the total number of differential traffic classes\n on subscriber sessions. IP ACLs are used to create differential flows(Traffic Classes). \n Each Traffic Class can have a different set of features applied.", "minimum": 0 }, "csubAggStatsDayCreatedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' created during the last 24\n hours.\n \n The system calculates the value of this column by summing the\n values of all instances of csubAggStatsIntCreatedSessions that\n expand this row and have a corresponding csubAggStatsIntValid of\n 'true'.", "x-yang-type": "perfhist-tc:PerfTotalCount" }, "csubAggStatsDayFailedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that were in the PENDING state\n and terminated for reasons other than disconnect during the\n last 24 hours.\n \n The system calculates the value of this column by summing the\n values of all instances of csubAggStatsIntFailedSessions that\n expand this row and have a corresponding csubAggStatsIntValid\n of 'true'.", "x-yang-type": "perfhist-tc:PerfTotalCount" }, "csubAggStatsDayUpSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned to the UP\n state during the last 24 hours.\n \n The system calculates the value of this column by summing the\n values of all instances of csubAggStatsIntUpSessions that\n expand this row and have a corresponding csubAggStatsIntValid\n of 'true'.", "x-yang-type": "perfhist-tc:PerfTotalCount" }, "csubAggStatsDayAuthSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned from the\n UNAUTHENTICATED to the AUTHENTICATED state during the last 24\n hours.\n \n The system calculates the value of this column by summing the\n values of all instances of csubAggStatsIntAuthSessions that\n expand this row and have a corresponding csubAggStatsIntValid of\n 'true'.", "x-yang-type": "perfhist-tc:PerfTotalCount" }, "csubAggStatsDayDiscSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n terminated due to a disconnect event during the last 24 hours.\n \n The system calculates the value of this column by summing the\n values of all instances of csubAggStatsIntDiscSessions that\n expand this row and have a corresponding csubAggStatsIntValid of\n 'true'.", "x-yang-type": "perfhist-tc:PerfTotalCount" }, "csubAggStatsCurrTimeElapsed": { "type": "integer", "description": "This object indicates the time that has elapsed since the\n beginning of the current 15-minute measurement interval. If,\n for some reason, such as an adjustment in the system's\n time-of-day clock, the current interval exceeds the maximum\n value, then the value of this column will be the maximum value.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsCurrValidIntervals": { "type": "integer", "description": "This object indicates the number of intervals for which data\n was collected. The value of this column will be '96' unless the\n measurement was started (or restarted) within 1,440 minutes, in\n which case the value will be the number of complete 15-minute\n intervals for which the system has at least some data.\n \n In certain cases it is possible that some intervals are\n unavailable, in which case the value of this column will\n be maximum interval number for which data is available.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsCurrInvalidIntervals": { "type": "integer", "description": "This object indicates the number of intervals in the range\n from 0 to csubCurrValidIntervals for which no data is\n available. This object will typically be '0' except in certain\n circumstances when some intervals are unavailable.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsCurrFlowsUp": { "type": "integer", "description": "This object indicates the current number of differential traffic classes\n on subscriber sessions currently UP. IP ACLs are used to create differential flows\n (Traffic Classes).Each Traffic Class can have a different set of features applied.", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsCurrCreatedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' created during the current\n 15-minute interval.", "x-yang-type": "perfhist-tc:PerfCurrentCount" }, "csubAggStatsCurrFailedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that were in the PENDING state\n and terminated for reasons other than disconnect during the\n current 15-minute interval.", "x-yang-type": "perfhist-tc:PerfCurrentCount" }, "csubAggStatsCurrUpSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned to the UP\n state during the current 15-minute interval.", "x-yang-type": "perfhist-tc:PerfCurrentCount" }, "csubAggStatsCurrAuthSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned from the\n UNAUTHENTICATED to the AUTHENTICATED state during the current\n 15-minute interval.", "x-yang-type": "perfhist-tc:PerfCurrentCount" }, "csubAggStatsCurrDiscSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n terminated due to a disconnect event during the current\n 15-minute interval.", "x-yang-type": "perfhist-tc:PerfCurrentCount" }, "csubAggStatsDiscontinuityTime": { "type": "string", "description": "The date and time (as determined by the system's clock) of\n the most recent occurrence of an event affecting the \n continuity of the aggregation statistics for this aggregation \n point.", "x-yang-type": "snmpv2-tc:DateAndTime" } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubAggStatsEntry": { "csubAggStatsPointType": "ethernetCsmacd(6)", "csubAggStatsPoint": 0, "csubAggStatsSessionType": "ethernetCsmacd(6)", "csubAggStatsPendingSessions": 0, "csubAggStatsUpSessions": 0, "csubAggStatsAuthSessions": 0, "csubAggStatsUnAuthSessions": 0, "csubAggStatsLightWeightSessions": 0, "csubAggStatsRedSessions": 0, "csubAggStatsHighUpSessions": 0, "csubAggStatsAvgSessionUptime": 0, "csubAggStatsAvgSessionRPM": 0, "csubAggStatsAvgSessionRPH": 0, "csubAggStatsThrottleEngagements": 0, "csubAggStatsTotalCreatedSessions": 0, "csubAggStatsTotalFailedSessions": 0, "csubAggStatsTotalUpSessions": 0, "csubAggStatsTotalAuthSessions": 0, "csubAggStatsTotalDiscSessions": 0, "csubAggStatsTotalLightWeightSessions": 0, "csubAggStatsTotalFlowsUp": 0, "csubAggStatsDayCreatedSessions": "example-string", "csubAggStatsDayFailedSessions": "example-string", "csubAggStatsDayUpSessions": "example-string", "csubAggStatsDayAuthSessions": "example-string", "csubAggStatsDayDiscSessions": "example-string", "csubAggStatsCurrTimeElapsed": 0, "csubAggStatsCurrValidIntervals": 0, "csubAggStatsCurrInvalidIntervals": 0, "csubAggStatsCurrFlowsUp": 0, "csubAggStatsCurrCreatedSessions": "example-string", "csubAggStatsCurrFailedSessions": "example-string", "csubAggStatsCurrUpSessions": "example-string", "csubAggStatsCurrAuthSessions": "example-string", "csubAggStatsCurrDiscSessions": "example-string", "csubAggStatsDiscontinuityTime": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubAggStatsEntry-4" }, "x-yang-path": "/csubAggStatsEntry={csubAggStatsPointType csubAggStatsPoint csubAggStatsSessionType}", "x-restconf-kind": "list-instance", "x-list-keys": [ "csubAggStatsPointType csubAggStatsPoint csubAggStatsSessionType" ] }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubAggStatsIntEntry={csubAggStatsPointType},{csubAggStatsPoint},{csubAggStatsSessionType},{csubAggStatsIntNumber}": { "get": { "summary": "Get csubAggStatsIntEntry entry", "description": "Retrieve specific csubAggStatsIntEntry entry by key from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "parameters": [ { "name": "csubAggStatsPointType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "csubAggStatsPoint", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "csubAggStatsSessionType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "csubAggStatsIntNumber", "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": { "csubAggStatsPointType": { "type": "string", "description": "csubAggStatsPointType", "x-yang-type": "leafref" }, "csubAggStatsPoint": { "type": "string", "description": "csubAggStatsPoint", "x-yang-type": "leafref" }, "csubAggStatsSessionType": { "type": "string", "description": "csubAggStatsSessionType", "x-yang-type": "leafref" }, "csubAggStatsIntNumber": { "type": "integer", "description": "This object indicates the interval number identifying the\n 15-minute measurement interval for which aggregated subscriber\n session performance data was successfully collected by the\n system.\n \n The interval identified by the value '1' represents the most\n recent 15-minute measurement interval, and the interval\n identified by the value (n) represents the interval immediately\n preceding the interval identified by the value (n-1).", "minimum": 0, "maximum": 4294967295 }, "csubAggStatsIntValid": { "type": "boolean", "description": "This object indicates whether the data for the 15-minute\n measurement interval is valid." }, "csubAggStatsIntCreatedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' created during the 15-minute\n measurement interval.", "x-yang-type": "perfhist-tc:PerfIntervalCount" }, "csubAggStatsIntFailedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that were in the PENDING state\n and terminated for reasons other than disconnect during the\n 15-minute measurement interval.", "x-yang-type": "perfhist-tc:PerfIntervalCount" }, "csubAggStatsIntUpSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned to the UP\n state during the 15-minute measurement interval.", "x-yang-type": "perfhist-tc:PerfIntervalCount" }, "csubAggStatsIntAuthSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned from the\n UNAUTHENTICATED to the AUTHENTICATED state during the\n 15-minute measurement interval.", "x-yang-type": "perfhist-tc:PerfIntervalCount" }, "csubAggStatsIntDiscSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n terminated due to a disconnect event during the 15-minute\n measurement interval.", "x-yang-type": "perfhist-tc:PerfIntervalCount" } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubAggStatsIntEntry": { "csubAggStatsPointType": "ethernetCsmacd(6)", "csubAggStatsPoint": "example-string", "csubAggStatsSessionType": "ethernetCsmacd(6)", "csubAggStatsIntNumber": 0, "csubAggStatsIntValid": true, "csubAggStatsIntCreatedSessions": "example-string", "csubAggStatsIntFailedSessions": "example-string", "csubAggStatsIntUpSessions": "example-string", "csubAggStatsIntAuthSessions": "example-string", "csubAggStatsIntDiscSessions": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubAggStatsIntEntry-4" }, "x-yang-path": "/csubAggStatsIntEntry={csubAggStatsPointType csubAggStatsPoint csubAggStatsSessionType csubAggStatsIntNumber}", "x-restconf-kind": "list-instance", "x-list-keys": [ "csubAggStatsPointType csubAggStatsPoint csubAggStatsSessionType csubAggStatsIntNumber" ] }, "/data/CISCO-SUBSCRIBER-SESSION-MIB:csubJobReportEntry={csubJobId},{csubJobReportId}": { "get": { "summary": "Get csubJobReportEntry entry", "description": "Retrieve specific csubJobReportEntry entry by key from MIB", "tags": [ "CISCO-SUBSCRIBER-SESSION-MIB" ], "parameters": [ { "name": "csubJobId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "csubJobReportId", "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": { "csubJobId": { "type": "string", "description": "csubJobId", "x-yang-type": "leafref" }, "csubJobReportId": { "type": "integer", "description": "This object indicates an arbitrary, positive, integer-value\n that uniquely identifies this entry in a report. This auxiliary\n value is necessary, as the corresponding subscriber session job\n can specify up to three subscriber identities on which to sort\n the subscriber sessions that end up in the final report.", "minimum": 0, "maximum": 4294967295 }, "csubJobReportSession": { "type": "string", "description": "This object indicates the ifIndex-value assigned to the\n subscriber session that satisfied the match criteria specified\n by the corresponding subscriber session job having a csubJobType\n of 'query'.", "x-yang-type": "if-mib:InterfaceIndex" } } }, "example": { "CISCO-SUBSCRIBER-SESSION-MIB:csubJobReportEntry": { "csubJobId": "example-string", "csubJobReportId": 0, "csubJobReportSession": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-csubJobReportEntry-4" }, "x-yang-path": "/csubJobReportEntry={csubJobId csubJobReportId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "csubJobId csubJobReportId" ] } }, "components": { "schemas": { "CISCO-SUBSCRIBER-SESSION-MIB_CISCO-SUBSCRIBER-SESSION-MIB": { "type": "object", "description": "This object specifies whether the system generates a\n csubJobFinishedNotify notification when the system finishes\n processing a subscriber session job.", "properties": { "csubSessionEntry": { "type": "array", "description": "csubSessionEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "csubSessionType": { "type": "string", "description": "This object indicates the type of subscriber session.", "x-yang-type": "cisco-subscriber:SubSessionType", "readOnly": true }, "csubSessionIpAddrAssignment": { "type": "string", "description": "This object indicates how the system assigns IP addresses to\n the subscriber:\n \n 'none'\n The system does not an involvement in (or is it aware\n of) the assignment an subscriber IP addresses. For\n example, a system does not have an involvement in the\n assignment of subscriber IP addresses for IP interface\n subscriber sessions.\n \n 'other'\n The system assigns subscriber IP addresses using a\n method not recognized by this MIB module.\n \n 'static'\n Subscriber IP addresses have been configured correctly\n for the service domain. The system does not have an\n involvement in the assignment of the IP address.\n \n 'localPool'\n The system assigns subscriber IP addresses from a\n locally configured pool of IP addresses.\n \n 'dhcpv4'\n The system assigns subscriber IP addresses are using the\n DHCPv4.\n \n 'dhcpv6'\n The system assigns subscriber IP addresses using the\n DHCPv6.\n \n 'userProfileIpAddr'\n The system assigns subscriber IP addresses from a user\n profile.\n \n 'userProfileIpSubnet'\n The system assigns the subscriber an IP subnet from a\n user profile.\n \n 'userProfileNamedPool'\n The system assigns subscriber IP addresses from a\n locally configured named pool specified by a user\n profile.", "readOnly": true }, "csubSessionState": { "type": "string", "description": "This object indicates the operational state of the subscriber\n session.", "x-yang-type": "cisco-subscriber:SubSessionState", "readOnly": true }, "csubSessionAuthenticated": { "type": "boolean", "description": "This object indicates whether the system has successfully\n authenticated the subscriber session.\n \n 'false'\n The subscriber session is operationally up, but in the\n UNAUTHENTICATED state.\n \n 'true'\n The subscriber session is operationally up, but in the\n AUTHENTICATED state.", "readOnly": true }, "csubSessionRedundancyMode": { "type": "string", "description": "This object indicates the redundancy mode in which the\n subscriber session is operating.", "x-yang-type": "cisco-subscriber:SubSessionRedundancyMode", "readOnly": true }, "csubSessionCreationTime": { "type": "string", "description": "This object indicates when the subscriber session was created\n (i.e., when the subscriber session was initiated).", "x-yang-type": "snmpv2-tc:DateAndTime", "readOnly": true }, "csubSessionDerivedCfg": { "type": "string", "description": "This object indicates the row in the cdtTemplateTable (defined\n by the CISCO-DYNAMIC-TEMPLATE-MIB) describing the derived\n configuration for the subscriber session.\n \n Observe that the value of cdtTemplateType corresponding to the\n referenced row must be 'derived'.", "x-yang-type": "cisco-dynamic:DynamicTemplateName", "readOnly": true }, "csubSessionAvailableIdentities": { "type": "string", "description": "This object indicates the subscriber identities that the system\n has successfully collected for the subscriber session.\n \n Each bit in this bit string corresponds to a column in this\n table. If the bit is '0', then the value of the corresponding\n column is invalid. If the bit is '1', then the value of the\n corresponding column represents the value of the subscriber\n identity collected by the system.\n \n The following list specifies the mappings between the bits and\n the columns:\n \n 'subscriberLabel' => csubSessionSubscriberLabel\n 'macAddress' => csubSessionMacAddress\n 'nativeVrf' => csubSessionNativeVrf\n 'nativeIpAddress' => csubSessionNativeIpAddrType,\n csubSessionNativeIpAddr,\n csubSessionNativeIpMask\n 'nativeIpAddress2'=> csubSessionNativeIpAddrType2,\n csubSessionNativeIpAddr2,\n csubSessionNativeIpMask2 \n 'domainVrf' => csubSessionDomainVrf\n 'domainIpAddress' => csubSessionDomainIpAddrType,\n csubSessionDomainIpAddr,\n csubSessionDomainIpMask\n 'pbhk' => csubSessionPbhk\n 'remoteId' => csubSessionRemoteId\n 'circuitId' => csubSessionCircuitId\n 'nasPort' => csubSessionNasPort\n 'domain' => csubSessionDomain\n 'username' => csubSessionUsername\n 'acctSessionId' => csubSessionAcctSessionId\n 'dnis' => csubSessionDnis\n 'media' => csubSessionMedia\n 'mlpNegotiated' => csubSessionMlpNegotiated\n 'protocol' => csubSessionProtocol\n 'dhcpClass' => csubSessionDhcpClass\n 'tunnelName' => csubSessionTunnelName\n \n Observe that the bit 'ifIndex' should always be '1'. This\n identity maps to the ifIndex assigned to the subscriber\n session.\n \n Observe that the bit 'serviceName' maps to one or more instance\n of ccbptPolicyMap (defined by the CISCO-CBP-TARGET-MIB).", "x-yang-type": "cisco-subscriber-identity:SubSessionIdentities", "readOnly": true }, "csubSessionSubscriberLabel": { "type": "string", "description": "This object indicates a positive integer-value uniquely\n identifying the subscriber session within the scope of\n the system.\n \n This column is valid only if the 'subscriberLabel' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberLabel", "readOnly": true }, "csubSessionMacAddress": { "type": "string", "description": "This object indicates the MAC address of the subscriber.\n \n This column is valid only if the 'macAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "yang:mac-address", "readOnly": true }, "csubSessionNativeVrf": { "type": "string", "description": "This object indicates the VRF originating the subscriber\n session.\n \n This column is valid only if the 'nativeVrf' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberVRF", "readOnly": true }, "csubSessionNativeIpAddrType": { "type": "string", "description": "This object indicates the type of IP address assigned to the\n subscriber on the customer-facing side of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "csubSessionNativeIpAddr": { "type": "string", "description": "This object indicates the IP address assigned to the\n subscriber on the customer-facing side of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "csubSessionNativeIpMask": { "type": "string", "description": "This object indicates the corresponding mask for the IP\n address assigned to the subscriber on the customer-facing side\n of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "csubSessionDomainVrf": { "type": "string", "description": "This object indicates the VRF to which the system transfers\n the subscriber session's traffic.\n \n This column is valid only if the 'domainVrf' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberVRF", "readOnly": true }, "csubSessionDomainIpAddrType": { "type": "string", "description": "This object indicates the type of IP address assigned to the\n subscriber on the service-facing side of the system.\n \n This column is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "csubSessionDomainIpAddr": { "type": "string", "description": "This object indicates the IP address assigned to the\n subscriber on the service-facing side of the system.\n \n This column is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "csubSessionDomainIpMask": { "type": "string", "description": "This object indicates the corresponding mask for the IP\n address assigned to the subscriber on the service-facing side of\n the system.\n \n This column is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "csubSessionPbhk": { "type": "string", "description": "This object indicates the PBHK identifying the subscriber.\n \n This column is valid only if the 'pbhk' bit of the corresponding\n instance of csubSessionAvailableIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberPbhk", "readOnly": true }, "csubSessionRemoteId": { "type": "string", "description": "This object indicates the Remote-Id identifying the 'calling\n station' or AN supporting the circuit that provides access to\n the subscriber.\n \n This column is valid only if the 'remoteId' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberRemoteId", "readOnly": true }, "csubSessionCircuitId": { "type": "string", "description": "This object indicates the Circuit-Id identifying the circuit\n supported by the 'calling station' or AN providing access to\n the subscriber.\n \n This column is valid only if the 'circuitId' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberCircuitId", "readOnly": true }, "csubSessionNasPort": { "type": "string", "description": "This object indicates the NAS port-identifier identifying the\n port on the NAS providing access to the subscriber.\n \n This column is valid only if the 'nasPort' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberNasPort", "readOnly": true }, "csubSessionDomain": { "type": "string", "description": "This object indicates the domain associated with the\n subscriber.\n \n This column is valid only if the 'domain' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDomain", "readOnly": true }, "csubSessionUsername": { "type": "string", "description": "This object indicates the username identifying the subscriber.\n \n This column is valid only if the 'username' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberUsername", "readOnly": true }, "csubSessionAcctSessionId": { "type": "string", "description": "This object indicates the accounting session identifier\n assigned to the subscriber session.\n \n This column is valid only if the 'accountingSid' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberAcctSessionId", "readOnly": true }, "csubSessionDnis": { "type": "string", "description": "This object indicates the DNIS number dialed by the\n subscriber to access the 'calling station' or AN.\n \n This column is valid only if the 'dnis' bit of the corresponding\n instance of csubSessionAvailableIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDnis", "readOnly": true }, "csubSessionMedia": { "type": "string", "description": "This object indicates the type of media providing access to\n the subscriber.\n \n This column is valid only if the 'media' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberMediaType", "readOnly": true }, "csubSessionMlpNegotiated": { "type": "boolean", "description": "This object indicates whether the subscriber session was\n established using multi-link PPP negotiation.\n \n This column is valid only if the 'mlpNegotiated' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "readOnly": true }, "csubSessionProtocol": { "type": "string", "description": "This object indicates the type of protocol providing access to\n the subscriber.\n \n This column is valid only if the 'protocol' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberProtocolType", "readOnly": true }, "csubSessionDhcpClass": { "type": "string", "description": "This object indicates the name of the class matching the DHCP\n DISCOVER message received from the subscriber.\n \n This column is valid only if the 'dhcpClass' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDhcpClass", "readOnly": true }, "csubSessionTunnelName": { "type": "string", "description": "This object indicates the name of the VPDN used to carry the\n subscriber session to the system.\n \n This column is valid only if the 'tunnelName' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberTunnelName", "readOnly": true }, "csubSessionLocationIdentifier": { "type": "string", "description": "This object indicates the location of the\n subscriber", "x-yang-type": "cisco-subscriber-identity:SubscriberLocationName", "readOnly": true }, "csubSessionServiceIdentifier": { "type": "string", "description": "This object indicates the name used to identify the services\n subscribed by a particular session.", "x-yang-type": "cisco-subscriber-identity:SubscriberServiceName", "readOnly": true }, "csubSessionLastChanged": { "type": "string", "description": "This object indicates when the subscriber session is updated\n with new policy information.", "x-yang-type": "snmpv2-tc:DateAndTime", "readOnly": true }, "csubSessionNativeIpAddrType2": { "type": "string", "description": "This object indicates the type of IP address assigned to the\n subscriber on the customer-facing side of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.\n \n In Dual stack scenarios both 'csubSessionNativeIpAddrType' and \n 'csubSessionNativeIpAddrType2' will be valid", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "csubSessionNativeIpAddr2": { "type": "string", "description": "This object indicates the IP address assigned to the\n subscriber on the customer-facing side of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "csubSessionNativeIpMask2": { "type": "string", "description": "This object indicates the corresponding mask for the IP\n address assigned to the subscriber on the customer-facing side\n of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress", "readOnly": true } } }, "readOnly": true }, "csubSessionByTypeEntry": { "type": "array", "description": "csubSessionByTypeEntry", "items": { "type": "object", "properties": { "csubSessionByType": { "type": "string", "description": "This object indicates the type of the subscriber session.", "x-yang-type": "cisco-subscriber:SubSessionType", "readOnly": true }, "csubSessionIfIndex": { "type": "string", "description": "This object indicates the ifIndex assigned to the subscriber\n session.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true } } }, "readOnly": true }, "csubAggStatsEntry": { "type": "array", "description": "csubAggStatsEntry", "items": { "type": "object", "properties": { "csubAggStatsPointType": { "type": "string", "description": "This object indicates format of the csubAggStatsPoint\n for this entry. \n \n The format for the csubAggStatsPoint is as follows: \n \n csubAggStatsPointType csubAggStatsPoint \n ---------------------- ------------------ \n 'physical' PhysicalIndex \n 'interface' InterfaceIndex", "readOnly": true }, "csubAggStatsPoint": { "type": "integer", "description": "This object should be read with csubAggStatsPointType always.\n \n This object indicates one of the determining factors affecting \n the 'scope of aggregation' for the set of statistics contained \n by the row. \n \n The value indicated by this object should be interpreted as the \n identifier for the point type specific base table. \n \n For point types of 'physical', the type specific base table is \n the entPhysicalTable and this value is a PhysicalIndex. For \n point types of 'interface', the type specific base table is \n the ifTable and this value is an InterfaceIndex. \n \n If this column indicates a physical entity which has an \n entPhysicalClass of 'chassis', then the 'scope of aggregation' \n may includes those subscriber sessions maintained by all nodes \n contained by the system. \n \n If this column indicates a physical entity which has an \n entPhysicalClass of 'module' (e.g., a line card), then the \n 'scope of aggregation' may include those subscriber sessions \n maintained by the nodes contained by the module. \n \n If this column indicates a physical entity which has an \n entPhysicalClass of 'cpu', then the 'scope of aggregation' may \n include those subscriber sessions maintained by the node \n running on the processor. \n \n Aggregation points with entPhysicalTable / ifTable overlap: \n For interfaces which map directly to physical 'port' class \n entities in the entPhysicalTable, the preferred representation \n as aggregation points is the 'physical' point type and \n PhysicalIndex identifier.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsSessionType": { "type": "string", "description": "This object indicates one of the determining factors affecting\n the 'scope of aggregation' for the statistics contained by the\n row.\n \n If the value of this column is 'all', then the 'scope of\n aggregation' may include all subscriber sessions, regardless of\n type.\n \n If the value of this column is not 'all', then the 'scope of\n aggregation' may include subscriber sessions of the indicated\n subscriber session type.", "x-yang-type": "cisco-subscriber:SubSessionType", "readOnly": true }, "csubAggStatsPendingSessions": { "type": "integer", "description": "This object indicates the current number of subscriber sessions\n within the 'scope of aggregation' that are in the PENDING\n state.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsUpSessions": { "type": "integer", "description": "This object indicates the current number of subscriber sessions\n within the 'scope of aggregation' that are in the UP state.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsAuthSessions": { "type": "integer", "description": "This object indicates the current number of subscriber session\n within the 'scope of aggregation' that have been authenticated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsUnAuthSessions": { "type": "integer", "description": "This object indicates the current number of subscriber session\n within the 'scope of aggregation' that have not been authenticated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsLightWeightSessions": { "type": "integer", "description": "This object indicates the current number of subscriber\n sessions within the 'scope of aggregation' that are less resource intensive.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsRedSessions": { "type": "integer", "description": "This object indicates the current number of subscriber sessions\n within the 'scope of aggregation' that are redundant (i.e., \n sessions with a csubSessionRedundancyMode of 'standby').", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsHighUpSessions": { "type": "integer", "description": "This object indicates the highest number of subscriber sessions\n within the 'scope of aggregation' observed simultaneously in the UP\n state since the last discontinuity time.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsAvgSessionUptime": { "type": "integer", "description": "This object indicates the average time subscriber sessions\n within the 'scope of aggregation' spent in the UP state.\n \n The system calculates this average over all subscriber\n sessions maintained by all nodes contained by the 'scope of\n aggregation' since the last discontinuity time.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsAvgSessionRPM": { "type": "integer", "description": "This object indicates the average rate (per minute) at which\n the nodes contained by the 'scope of aggregation' have\n established new subscriber sessions.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsAvgSessionRPH": { "type": "integer", "description": "This object indicates the average rate (per hour) at which the\n nodes contained by the 'scope of aggregation' have established new\n subscriber sessions.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsThrottleEngagements": { "type": "integer", "description": "This object indicates the number of times that nodes contained\n within the 'scope of aggregation' have engaged the subscriber\n session throttle since the last discontinuity time.\n \n The mechanics of a subscriber session throttle vary with\n subscriber session type and implementation. However, the\n general concept of the throttle prevents a node from having\n to deal with more than a configured number of requests to\n establish subscriber sessions from the same CPE within the a\n configured interval of time. When the number of requests\n exceeds the configured threshold within the configured interval,\n then the node processing the requests engages the throttle.\n Typically, when a node engages a throttle, it drops requests\n from the CPE for some period of time, after which the node\n disengages the throttle.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime.", "minimum": 0, "readOnly": true }, "csubAggStatsTotalCreatedSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' created since the\n discontinuity time.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime.", "minimum": 0, "readOnly": true }, "csubAggStatsTotalFailedSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that were in the PENDING state\n and terminated for reasons other than disconnect since the last\n discontinuity time.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime.", "minimum": 0, "readOnly": true }, "csubAggStatsTotalUpSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned to the UP\n state since the last discontinuity time.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime", "minimum": 0, "readOnly": true }, "csubAggStatsTotalAuthSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned from the\n UNAUTHENTICATED to the AUTHENTICATED state since the last\n discontinuity time.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime", "minimum": 0, "readOnly": true }, "csubAggStatsTotalDiscSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n terminated due to a disconnect event since the last\n discontinuity time.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime", "minimum": 0, "readOnly": true }, "csubAggStatsTotalLightWeightSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n that are less resource intensive", "minimum": 0, "readOnly": true }, "csubAggStatsTotalFlowsUp": { "type": "integer", "description": "This object indicates the total number of differential traffic classes\n on subscriber sessions. IP ACLs are used to create differential flows(Traffic Classes). \n Each Traffic Class can have a different set of features applied.", "minimum": 0, "readOnly": true }, "csubAggStatsDayCreatedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' created during the last 24\n hours.\n \n The system calculates the value of this column by summing the\n values of all instances of csubAggStatsIntCreatedSessions that\n expand this row and have a corresponding csubAggStatsIntValid of\n 'true'.", "x-yang-type": "perfhist-tc:PerfTotalCount", "readOnly": true }, "csubAggStatsDayFailedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that were in the PENDING state\n and terminated for reasons other than disconnect during the\n last 24 hours.\n \n The system calculates the value of this column by summing the\n values of all instances of csubAggStatsIntFailedSessions that\n expand this row and have a corresponding csubAggStatsIntValid\n of 'true'.", "x-yang-type": "perfhist-tc:PerfTotalCount", "readOnly": true }, "csubAggStatsDayUpSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned to the UP\n state during the last 24 hours.\n \n The system calculates the value of this column by summing the\n values of all instances of csubAggStatsIntUpSessions that\n expand this row and have a corresponding csubAggStatsIntValid\n of 'true'.", "x-yang-type": "perfhist-tc:PerfTotalCount", "readOnly": true }, "csubAggStatsDayAuthSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned from the\n UNAUTHENTICATED to the AUTHENTICATED state during the last 24\n hours.\n \n The system calculates the value of this column by summing the\n values of all instances of csubAggStatsIntAuthSessions that\n expand this row and have a corresponding csubAggStatsIntValid of\n 'true'.", "x-yang-type": "perfhist-tc:PerfTotalCount", "readOnly": true }, "csubAggStatsDayDiscSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n terminated due to a disconnect event during the last 24 hours.\n \n The system calculates the value of this column by summing the\n values of all instances of csubAggStatsIntDiscSessions that\n expand this row and have a corresponding csubAggStatsIntValid of\n 'true'.", "x-yang-type": "perfhist-tc:PerfTotalCount", "readOnly": true }, "csubAggStatsCurrTimeElapsed": { "type": "integer", "description": "This object indicates the time that has elapsed since the\n beginning of the current 15-minute measurement interval. If,\n for some reason, such as an adjustment in the system's\n time-of-day clock, the current interval exceeds the maximum\n value, then the value of this column will be the maximum value.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsCurrValidIntervals": { "type": "integer", "description": "This object indicates the number of intervals for which data\n was collected. The value of this column will be '96' unless the\n measurement was started (or restarted) within 1,440 minutes, in\n which case the value will be the number of complete 15-minute\n intervals for which the system has at least some data.\n \n In certain cases it is possible that some intervals are\n unavailable, in which case the value of this column will\n be maximum interval number for which data is available.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsCurrInvalidIntervals": { "type": "integer", "description": "This object indicates the number of intervals in the range\n from 0 to csubCurrValidIntervals for which no data is\n available. This object will typically be '0' except in certain\n circumstances when some intervals are unavailable.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsCurrFlowsUp": { "type": "integer", "description": "This object indicates the current number of differential traffic classes\n on subscriber sessions currently UP. IP ACLs are used to create differential flows\n (Traffic Classes).Each Traffic Class can have a different set of features applied.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsCurrCreatedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' created during the current\n 15-minute interval.", "x-yang-type": "perfhist-tc:PerfCurrentCount", "readOnly": true }, "csubAggStatsCurrFailedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that were in the PENDING state\n and terminated for reasons other than disconnect during the\n current 15-minute interval.", "x-yang-type": "perfhist-tc:PerfCurrentCount", "readOnly": true }, "csubAggStatsCurrUpSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned to the UP\n state during the current 15-minute interval.", "x-yang-type": "perfhist-tc:PerfCurrentCount", "readOnly": true }, "csubAggStatsCurrAuthSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned from the\n UNAUTHENTICATED to the AUTHENTICATED state during the current\n 15-minute interval.", "x-yang-type": "perfhist-tc:PerfCurrentCount", "readOnly": true }, "csubAggStatsCurrDiscSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n terminated due to a disconnect event during the current\n 15-minute interval.", "x-yang-type": "perfhist-tc:PerfCurrentCount", "readOnly": true }, "csubAggStatsDiscontinuityTime": { "type": "string", "description": "The date and time (as determined by the system's clock) of\n the most recent occurrence of an event affecting the \n continuity of the aggregation statistics for this aggregation \n point.", "x-yang-type": "snmpv2-tc:DateAndTime", "readOnly": true } } }, "readOnly": true }, "csubAggStatsIntEntry": { "type": "array", "description": "An entry contains the aggregated subscriber session performance\n data collected over a single 15-minute measurement interval\n within a 'scope of aggregation'. For further details regarding\n 'scope of aggregation', see the descriptive text associated with\n the csubAggStatsEntry.", "items": { "type": "object", "properties": { "csubAggStatsPointType": { "type": "string", "description": "csubAggStatsPointType", "x-yang-type": "leafref", "readOnly": true }, "csubAggStatsPoint": { "type": "string", "description": "csubAggStatsPoint", "x-yang-type": "leafref", "readOnly": true }, "csubAggStatsSessionType": { "type": "string", "description": "csubAggStatsSessionType", "x-yang-type": "leafref", "readOnly": true }, "csubAggStatsIntNumber": { "type": "integer", "description": "This object indicates the interval number identifying the\n 15-minute measurement interval for which aggregated subscriber\n session performance data was successfully collected by the\n system.\n \n The interval identified by the value '1' represents the most\n recent 15-minute measurement interval, and the interval\n identified by the value (n) represents the interval immediately\n preceding the interval identified by the value (n-1).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsIntValid": { "type": "boolean", "description": "This object indicates whether the data for the 15-minute\n measurement interval is valid.", "readOnly": true }, "csubAggStatsIntCreatedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' created during the 15-minute\n measurement interval.", "x-yang-type": "perfhist-tc:PerfIntervalCount", "readOnly": true }, "csubAggStatsIntFailedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that were in the PENDING state\n and terminated for reasons other than disconnect during the\n 15-minute measurement interval.", "x-yang-type": "perfhist-tc:PerfIntervalCount", "readOnly": true }, "csubAggStatsIntUpSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned to the UP\n state during the 15-minute measurement interval.", "x-yang-type": "perfhist-tc:PerfIntervalCount", "readOnly": true }, "csubAggStatsIntAuthSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned from the\n UNAUTHENTICATED to the AUTHENTICATED state during the\n 15-minute measurement interval.", "x-yang-type": "perfhist-tc:PerfIntervalCount", "readOnly": true }, "csubAggStatsIntDiscSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n terminated due to a disconnect event during the 15-minute\n measurement interval.", "x-yang-type": "perfhist-tc:PerfIntervalCount", "readOnly": true } } }, "readOnly": true }, "csubAggStatsThreshEntry": { "type": "array", "description": "A row in this table exists for each row in the\n csubAggStatsTable.\n Each row defines the set of thresholds and evaluation attributes\n for an aggregation point.", "items": { "type": "object", "properties": { "csubSessionRisingThresh": { "type": "integer", "description": "This threshold, if non-zero, indicates the rising threshold\n for the value of csubAggStatsUpSessions for the aggregation\n point,\n When the current sample of csubAggStatsUpSessions is greater\n than\n or equal to this threshold, and the value of\n csubAggStatsUpSessions\n for the last sample interval was less than this thershold, the\n csubSessionRisingNotif is triggered.\n \n If the value of this threshold is 0, the threshold is\n not evaluated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubSessionFallingThresh": { "type": "integer", "description": "This threshold, if non-zero, indicates the falling threshold\n for the value of csubAggStatsUpSessions for the aggregation\n point,\n When the current sample of csubAggStatsUpSessions is less than\n or equal to this threshold, and the value of\n csubAggStatsUpSessions\n for the last sample interval was greater than this thershold,\n the\n csubSessionFallingNotif is triggered.\n \n If the value of this threshold is 0, the threshold is\n not evaluated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubSessionDeltaPercentFallingThresh": { "type": "integer", "description": "This threshold, if non-zero, indicates the delta falling\n threshold\n as a percentage of the value of csubAggStatsUpSessions for the\n aggregation point, The delta as a percentage of\n csubAggStatsUpSessions (delta_percent) is calculated as\n follows:\n current value of csubAggStatsUpSessions = value(n)\n previous sampled value of csubAggStatsUpSessions =\n value(n-1)\n \n delta_percent = ((value(n-1) - value(n)) /\n value(n-1)) * 100\n \n If the delta_percent value of the current evaluation\n interval is\n greater than the value of this threshold, a\n csubSessionDeltaPercentLossNotif is triggered.\n \n If the value of this threshold is 0, the threshold is\n not evaluated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubSessionThreshEvalInterval": { "type": "integer", "description": "The value of this object sets the number of seconds between\n samples\n for threshold evaluation. For implementations capable of\n per-session event evaluation of thresholds this object\n represents the maximum number of seconds between samples.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true }, "csubJobEntry": { "type": "array", "description": "csubJobEntry", "items": { "type": "object", "properties": { "csubJobId": { "type": "string", "description": "This object indicates an arbitrary, positive integer-value\n uniquely identifying the subscriber session job.", "x-yang-type": "CISCO-SUBSCRIBER-SESSION-MIB:SubscriberJobIdentifier", "readOnly": true }, "csubJobStatus": { "type": "string", "description": "This object specifies the status of the subscriber session\n job. The following columns must be valid before activating a\n subscriber session job:\n \n - csubJobStorage\n - csubJobType\n - csubJobControl\n \n However, these objects specify a default value. Thus, it is\n possible to use create-and-go semantics without setting any\n additional columns.\n \n An implementation must allow the EMS/NMS to modify any column\n when this column is 'active', including columns defined in\n tables that have a one-to-one or sparse dependent relationship\n on this table.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "csubJobStorage": { "type": "string", "description": "This object specifies what happens to the subscriber session\n job upon restart.", "x-yang-type": "snmpv2-tc:StorageType", "readOnly": true }, "csubJobType": { "type": "string", "description": "This object specifies the type of subscriber session job:\n \n 'noop'\n This type of job does nothing and simply serves as a\n convenient default value for newly created jobs, thereby\n allowing create-and-go row creation without having to\n specify the type of job.\n \n 'query'\n This type of job starts a subscriber session query. The\n system searches for any subscriber sessions matching the\n configured criteria and sorts them into a resulting\n report.\n \n Upon activation of a subscriber session with this value,\n the system automatically creates corresponding rows in\n the csubJobMatchParamsTable and csubQueryParamsTable.\n \n 'clear'\n This type of job causes the system to terminated all\n subscriber sessions matching configured criteria.\n \n Upon activation of a subscriber session with this value,\n the system automatically creates a corresponding row in\n the csubJobMatchParamsTable.", "readOnly": true }, "csubJobControl": { "type": "string", "description": "This object specifies an action relating to the subscriber\n session job:\n \n 'noop'\n This action does nothing.\n \n 'start'\n If the corresponding instance of csubJobType is 'noop',\n then this action simply causes the system to set the\n corresponding instances of csubJobState and\n csubJobFinishedReason to 'finished' and 'normal',\n respectively.\n \n If the corresponding instance of csubJobType is not\n 'noop' and the system is not executing a subscriber\n session job, then this action causes the system\n immediately execute the subscriber session job.\n \n If the corresponding instance of csubJobType is not\n 'noop' and the system is already executing a subscriber\n session job, then this action causes the system to put\n the job on the subscriber session job queue.\n \n 'abort'\n If the subscriber session job is in the subscriber\n session job queue, then this action causes the system to\n remove the job from the queue.\n \n If the system is executing the subscriber session job,\n then this action causes the system to stop the job.\n \n 'release'\n This action causes the system to destroy any\n corresponding rows in the csubJobReportTable.\n \n The system only accepts this action for a previously\n executed subscriber session job having a corresponding\n instance of csubJobType set to 'query'. Any attempt to\n issue this action under other circumstances will result\n in a response indicating an error-status of\n 'inconsistentValue'.\n \n When read, this column is always 'noop'.", "readOnly": true }, "csubJobState": { "type": "string", "description": "This object indicates the current state of the subscriber\n session job:\n \n 'idle'\n This state indicates that the system has not executed\n the subscriber session job since it was created.\n \n 'pending'\n This state indicates that the subscriber session job is\n waiting in the subscriber session job queue.\n \n 'inProgress'\n This state indicates that the system is executing the\n subscriber session job. Observe that the system may\n execute more than one subscriber session job at a time.\n \n 'finished'\n This state indicates that the system has executed the\n subscriber session job and it has finished. The\n corresponding instance of csubJobFinishedReason\n indicates further details regarding the reason why the\n job finished.", "readOnly": true }, "csubJobStartedTime": { "type": "string", "description": "This object indicates the value of sysUpTime when the system\n started executing the subscriber session job. This value will\n be '0' when the corresponding instance of csubJobState is 'idle'\n or 'pending'.", "x-yang-type": "yang:timestamp", "readOnly": true }, "csubJobFinishedTime": { "type": "string", "description": "This object indicates the value of sysUpTime when the system\n finished executing the subscriber session job, for whatever\n reason. This value will be '0' when the corresponding instance\n of csubJobState is 'idle', 'pending', or 'inProgress'.", "x-yang-type": "yang:timestamp", "readOnly": true }, "csubJobFinishedReason": { "type": "string", "description": "This object indicates the reason why the system finished\n executing the subscriber session job:\n \n 'invalid'\n Indicates that the corresponding instance of\n csubJobState is either 'idle', 'pending', or\n 'inProgress'.\n \n 'other'\n Indicates that the system finished executing the\n subscriber session job abnormally for a reason not\n recognized by this MIB module.\n \n 'normal'\n Indicates that the system finished executing the\n subscriber session job with no problems.\n \n 'aborted'\n Indicates that the system finished executing the\n subscriber session job as the result of the EMS/NMS\n writing 'abort' to the corresponding instance of\n csubJobControl.\n \n 'insufficientResources'\n Indicates that the system finished executing the\n subscriber session job abnormally due to insufficient\n resources to continue.\n \n 'error'\n Indicates that the system encountered an error that\n prevented it from completing the job.", "readOnly": true } } }, "readOnly": true }, "csubJobMatchParamsEntry": { "type": "array", "description": "csubJobMatchParamsEntry", "items": { "type": "object", "properties": { "csubJobId": { "type": "string", "description": "csubJobId", "x-yang-type": "leafref", "readOnly": true }, "csubJobMatchIdentities": { "type": "string", "description": "This object specifies the subscriber identities that the\n system uses to determine the subscriber sessions the job\n executes on.\n \n Each bit in this bit string corresponds to one or more columns\n in this table. If the bit is '0', then the value of the\n corresponding columns are invalid. If the bit is '1', then the\n value of corresponding columns are valid.\n \n The following list specifies the mappings between the bits and\n the columns:\n \n 'subscriberLabel' => csubJobMatchSubscriberLabel\n 'macAddress' => csubJobMatchMacAddress\n 'nativeVrf' => csubJobMatchNativeVrf\n 'nativeIpAddress' => csubJobMatchNativeIpAddrType,\n csubJobMatchNativeIpAddr,\n csubJobMatchNativeIpMask,\n 'domainVrf' => csubJobMatchDomainVrf\n 'domainIpAddress' => csubJobMatchDomainIpAddrType,\n csubJobMatchDomainIpAddr,\n csubJobMatchDomainIpMask\n 'pbhk' => csubJobMatchPbhk\n 'remoteId' => csubJobMatchRemoteId\n 'circuitId' => csubJobMatchCircuitId\n 'nasPort' => csubJobMatchNasPort\n 'domain' => csubJobMatchDomain\n 'username' => csubJobMatchUsername\n 'acctSessionId' => csubJobMatchAcctSessionId\n 'dnis' => csubJobMatchDnis\n 'media' => csubJobMatchMedia\n 'mlpNegotiated' => csubJobMatchMlpNegotiated\n 'protocol' => csubJobMatchProtocol\n 'serviceName' => csubJobMatchServiceName\n 'dhcpClass' => csubJobMatchDhcpClass\n 'tunnelName' => csubJobMatchTunnelName\n \n Observe that the bit 'ifIndex' has no meaning, as subscriber\n session jobs do not match against this subscriber session\n identity.", "x-yang-type": "cisco-subscriber-identity:SubSessionIdentities", "readOnly": true }, "csubJobMatchOtherParams": { "type": "string", "description": "This object specifies other parameters relating to subscriber\n sessions a subscriber session job may match against.\n \n Each bit in this bit string corresponds to a column in this\n table. If the bit is '0', then the value of the corresponding\n column is invalid. If the bit is '1', then the value of the\n corresponding column represents the value of the parameter\n identity the system should match against for the corresponding\n subscriber session job.\n \n The following list specifies the mappings between bits and the\n columns:\n \n 'danglingDuration' => csubJobMatchDanglingDuration\n 'state' => csubJobMatchState\n 'authenticated' => csubJobMatchAuthenticated\n 'redundancyMode' => csubJobMatchRedundancyMode", "readOnly": true }, "csubJobMatchSubscriberLabel": { "type": "string", "description": "This object specifies the subscriber label that the system\n matches against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'subscriberLabel' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberLabel", "readOnly": true }, "csubJobMatchMacAddress": { "type": "string", "description": "This object specifies the MAC address that the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'macAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "yang:mac-address", "readOnly": true }, "csubJobMatchNativeVrf": { "type": "string", "description": "This object specifies the native VRF the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'nativeVrf' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberVRF", "readOnly": true }, "csubJobMatchNativeIpAddrType": { "type": "string", "description": "This object specifies the type of Internet address specified\n by csubJobMatchNativeIpAddr and csubJobMatchNativeIpMask.\n \n This value is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "csubJobMatchNativeIpAddr": { "type": "string", "description": "This object specifies the native IP address that the system\n matches against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "csubJobMatchNativeIpMask": { "type": "string", "description": "This object specifies the mask used when matching the native IP\n address against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "csubJobMatchDomainVrf": { "type": "string", "description": "This object specifies the domain VRF the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'domainVrf' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberVRF", "readOnly": true }, "csubJobMatchDomainIpAddrType": { "type": "string", "description": "This object specifies the type of Internet address specified\n by csubJobMatchDomainIpAddr and csubJobMatchDomainIpMask.\n \n This value is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "csubJobMatchDomainIpAddr": { "type": "string", "description": "This object specifies the domain IP address that the system\n matches against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "csubJobMatchDomainIpMask": { "type": "string", "description": "This object specifies the mask used when matching the domain IP\n address against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "csubJobMatchPbhk": { "type": "string", "description": "This object specifies the PBHK that the system matches against\n subscriber sessions in the process of executing a subscriber\n session job.\n \n This value is valid only if the 'pbhk' bit of the corresponding\n instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberPbhk", "readOnly": true }, "csubJobMatchRemoteId": { "type": "string", "description": "This object specifies the Remote-Id the system matches against\n subscriber sessions in the process of executing a subscriber\n session job.\n \n This value is valid only if the 'remoteId' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberRemoteId", "readOnly": true }, "csubJobMatchCircuitId": { "type": "string", "description": "This object specifies the Circuit-Id the system matches against\n subscriber sessions in the process of executing a subscriber\n session job.\n \n This value is valid only if the 'circuitId' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberCircuitId", "readOnly": true }, "csubJobMatchNasPort": { "type": "string", "description": "This object specifies the NAS port-identifier the system\n matches against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'nasPort' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberNasPort", "readOnly": true }, "csubJobMatchDomain": { "type": "string", "description": "This object specifies the domain the system matches against\n subscriber sessions in the process of executing a subscriber\n session job.\n \n This value is valid only if the 'domain' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDomain", "readOnly": true }, "csubJobMatchUsername": { "type": "string", "description": "This object specifies the username the system matches against\n subscriber sessions in the process of executing a subscriber\n session job.\n \n This value is valid only if the 'username' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberUsername", "readOnly": true }, "csubJobMatchAcctSessionId": { "type": "string", "description": "This object specifies the accounting session identifier the\n system matches against subscriber sessions in the process of\n executing a subscriber session job.\n \n This value is valid only if the 'accountingSid' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberAcctSessionId", "readOnly": true }, "csubJobMatchDnis": { "type": "string", "description": "This object specifies the DNIS number the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'dnis' bit of the corresponding\n instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDnis", "readOnly": true }, "csubJobMatchMedia": { "type": "string", "description": "This object specifies the media type the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'media' bit of the corresponding\n instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberMediaType", "readOnly": true }, "csubJobMatchMlpNegotiated": { "type": "boolean", "description": "This object specifies the MLP negotiated flag the system\n matches against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'mlpNegotiated' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "readOnly": true }, "csubJobMatchProtocol": { "type": "string", "description": "This object specifies the protocol type the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'protocol' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberProtocolType", "readOnly": true }, "csubJobMatchServiceName": { "type": "string", "description": "This object specifies the service name the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'serviceName' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-cbp:CbpElementName", "readOnly": true }, "csubJobMatchDhcpClass": { "type": "string", "description": "This object specifies the DHCP class name the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'dhcpClass' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDhcpClass", "readOnly": true }, "csubJobMatchTunnelName": { "type": "string", "description": "This object specifies the tunnel name the system matches\n against subscriber session in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'tunnelName' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberTunnelName", "readOnly": true }, "csubJobMatchDanglingDuration": { "type": "integer", "description": "This object specifies the minimum interval of time a subscriber\n session can remain dangling in order for the system to consider\n it a match in the process of executing a subscriber session job.\n A 'dangling' subscriber session is one in the PENDING state.\n \n The value '0' cannot be written to an instance of this object.\n However, it serves as a convenient value when the column is not\n valid.\n \n This value is valid only if the 'danglingDuration' bit of the\n corresponding instance of csubJobMatchOtherParams is '1'.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubJobMatchState": { "type": "string", "description": "This object specifies the state of a subscriber session in\n order for the system to consider a match in the process of\n executing a subscriber session job.\n \n The value 'other' is not valid and an implementation should\n not allow it to be written to this column.\n \n This value is valid only if the 'state' bit of the\n corresponding instance of csubJobMatchOtherParams is '1'.", "x-yang-type": "cisco-subscriber:SubSessionState", "readOnly": true }, "csubJobMatchAuthenticated": { "type": "boolean", "description": "This object specifies whether a subscriber session should be\n unauthenticated for the system to consider a match in the\n process of executing a subscriber session job.\n \n If this column is 'false', then the subscriber session job\n matches subscriber sessions that are unauthenticated.\n \n If this column is 'true', then the subscriber session job\n matches subscriber session that are authenticated.\n \n This value is valid only if the 'authenticated' bit of the\n corresponding instance of csubJobMatchParams is '1'.", "readOnly": true }, "csubJobMatchRedundancyMode": { "type": "string", "description": "This object specifies the redudancy mode of the subscriber\n session in order for the system to consider a match in the\n process of executing a subscriber session job.\n \n The value 'other' is not valid and an implementation should not\n allow it to be written to this column.\n \n This value is valid only if the 'redundancyMode' bit of the\n corresponding instance of csubJobMatchOtherParams is '1'.", "x-yang-type": "cisco-subscriber:SubSessionRedundancyMode", "readOnly": true } } }, "readOnly": true }, "csubJobQueryParamsEntry": { "type": "array", "description": "csubJobQueryParamsEntry", "items": { "type": "object", "properties": { "csubJobId": { "type": "string", "description": "csubJobId", "x-yang-type": "leafref", "readOnly": true }, "csubJobQuerySortKey1": { "type": "string", "description": "This object specifies the first subscriber identity that the\n system uses when sorting subscriber sessions into the final\n report corresponding to a subscriber session query.\n \n It is not valid to set this column to 'other' or 'ifIndex'.", "x-yang-type": "cisco-subscriber-identity:SubSessionIdentity", "readOnly": true }, "csubJobQuerySortKey2": { "type": "string", "description": "This object specifies the second subscriber identity that the\n system uses when sorting subscriber sessions into the final\n report corresponding to a subscriber session query.\n \n If it is the desire to have the final report sorted on a single\n subscriber identity, then this column should be 'other'.", "x-yang-type": "cisco-subscriber-identity:SubSessionIdentity", "readOnly": true }, "csubJobQuerySortKey3": { "type": "string", "description": "This object specifies the third subscriber identity that the\n system uses when sorting subscriber sessions into the final\n report corresponding to a subscriber session query.\n \n If it is the desire to have the final report sorted on one or\n two subscriber identities, then this column should be 'other'.", "x-yang-type": "cisco-subscriber-identity:SubSessionIdentity", "readOnly": true }, "csubJobQueryResultingReportSize": { "type": "integer", "description": "This object indicates the number of subscriber sessions that\n matched the corresponding subscriber session query.\n \n The value of this column should be '0' unless the corresponding\n value of csubJobState is 'finished'.\n \n The value of this column should be '0' after the EMS/NMS sets\n the corresponding csubJobControl to 'release'.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true }, "csubJobQueueEntry": { "type": "array", "description": "csubJobQueueEntry", "items": { "type": "object", "properties": { "csubJobQueueNumber": { "type": "integer", "description": "This object indicates an positive, integer-value that uniquely\n identifies the entry in the table. The value of this object\n starts at '1' and monotonically increases for each subscriber\n session job inserted into the subscriber session job queue. If\n the value of this object is '4294967295', the system will reset\n it to '1' when it inserts the next subscriber session job into\n the subscriber session job queue.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubJobQueueJobId": { "type": "string", "description": "This object indicates the identifier associated with the\n subscriber session job.", "x-yang-type": "CISCO-SUBSCRIBER-SESSION-MIB:SubscriberJobIdentifier", "readOnly": true } } }, "readOnly": true }, "csubJobReportEntry": { "type": "array", "description": "csubJobReportEntry", "items": { "type": "object", "properties": { "csubJobId": { "type": "string", "description": "csubJobId", "x-yang-type": "leafref", "readOnly": true }, "csubJobReportId": { "type": "integer", "description": "This object indicates an arbitrary, positive, integer-value\n that uniquely identifies this entry in a report. This auxiliary\n value is necessary, as the corresponding subscriber session job\n can specify up to three subscriber identities on which to sort\n the subscriber sessions that end up in the final report.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubJobReportSession": { "type": "string", "description": "This object indicates the ifIndex-value assigned to the\n subscriber session that satisfied the match criteria specified\n by the corresponding subscriber session job having a csubJobType\n of 'query'.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true } } }, "readOnly": true }, "csubJob": { "type": "object", "description": "This object specifies whether the system generates a\n csubJobFinishedNotify notification when the system finishes\n processing a subscriber session job.", "properties": { "csubJobFinishedNotifyEnable": { "type": "boolean", "description": "This object specifies whether the system generates a\n csubJobFinishedNotify notification when the system finishes\n processing a subscriber session job.", "readOnly": true }, "csubJobIndexedAttributes": { "type": "string", "description": "This object indicates which subscriber session identities the\n system maintains as searchable keys. This value serves the\n EMS/NMS in configuring a subscriber session query, as at least\n one match criteria must be an 'indexed attribute'.", "x-yang-type": "cisco-subscriber-identity:SubSessionIdentities", "readOnly": true }, "csubJobIdNext": { "type": "string", "description": "This object indicates the next available identifier for the\n creation of a new row in the csubJobTable. If no available\n identifier exists, then this object has the value '0'.", "x-yang-type": "CISCO-SUBSCRIBER-SESSION-MIB:SubscriberJobIdentifierOrZero", "readOnly": true }, "csubJobMaxNumber": { "type": "integer", "description": "This object indicates the maximum number of outstanding\n subscriber session jobs the system can support. If the\n csubJobTable contains a number of rows (i.e., the value of\n csubJobCount) equal to this value, then any attempt to create a\n new row will result in a response with an error-status of\n 'resourceUnavailable'.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubJobMaxLife": { "type": "integer", "description": "This object specifies the maximum life a subscriber session\n report corresponding to a subscriber session job having a\n csubJobType of 'query'. The system tracks the time elapsed\n after it finishes processing a query. When the time elapsed\n reaches the value specified by this column, the system\n automatically destroys the report. A value of '0' disables the\n automatic destruction of reports.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubJobCount": { "type": "integer", "description": "This object indicates the number of subscriber session jobs\n currently maintained by the csubJobTable.", "minimum": 0, "maximum": 4294967295, "readOnly": true } }, "readOnly": true }, "csubAggThresh": { "type": "object", "description": "This object enables or disables the generation of any of the\n csubAggStats* threshold notifications.", "properties": { "csubAggStatsThreshNotifEnable": { "type": "boolean", "description": "This object enables or disables the generation of any of the\n csubAggStats* threshold notifications.", "readOnly": true } }, "readOnly": true }, "csubSessionTable": { "type": "object", "description": "This table describes a list of subscriber sessions currently\n maintained by the system.\n \n This table has a sparse dependent relationship on the ifTable,\n containing a row for each interface having an interface type\n describing a subscriber session.", "properties": { "csubSessionEntry": { "type": "array", "description": "csubSessionEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "csubSessionType": { "type": "string", "description": "This object indicates the type of subscriber session.", "x-yang-type": "cisco-subscriber:SubSessionType", "readOnly": true }, "csubSessionIpAddrAssignment": { "type": "string", "description": "This object indicates how the system assigns IP addresses to\n the subscriber:\n \n 'none'\n The system does not an involvement in (or is it aware\n of) the assignment an subscriber IP addresses. For\n example, a system does not have an involvement in the\n assignment of subscriber IP addresses for IP interface\n subscriber sessions.\n \n 'other'\n The system assigns subscriber IP addresses using a\n method not recognized by this MIB module.\n \n 'static'\n Subscriber IP addresses have been configured correctly\n for the service domain. The system does not have an\n involvement in the assignment of the IP address.\n \n 'localPool'\n The system assigns subscriber IP addresses from a\n locally configured pool of IP addresses.\n \n 'dhcpv4'\n The system assigns subscriber IP addresses are using the\n DHCPv4.\n \n 'dhcpv6'\n The system assigns subscriber IP addresses using the\n DHCPv6.\n \n 'userProfileIpAddr'\n The system assigns subscriber IP addresses from a user\n profile.\n \n 'userProfileIpSubnet'\n The system assigns the subscriber an IP subnet from a\n user profile.\n \n 'userProfileNamedPool'\n The system assigns subscriber IP addresses from a\n locally configured named pool specified by a user\n profile.", "readOnly": true }, "csubSessionState": { "type": "string", "description": "This object indicates the operational state of the subscriber\n session.", "x-yang-type": "cisco-subscriber:SubSessionState", "readOnly": true }, "csubSessionAuthenticated": { "type": "boolean", "description": "This object indicates whether the system has successfully\n authenticated the subscriber session.\n \n 'false'\n The subscriber session is operationally up, but in the\n UNAUTHENTICATED state.\n \n 'true'\n The subscriber session is operationally up, but in the\n AUTHENTICATED state.", "readOnly": true }, "csubSessionRedundancyMode": { "type": "string", "description": "This object indicates the redundancy mode in which the\n subscriber session is operating.", "x-yang-type": "cisco-subscriber:SubSessionRedundancyMode", "readOnly": true }, "csubSessionCreationTime": { "type": "string", "description": "This object indicates when the subscriber session was created\n (i.e., when the subscriber session was initiated).", "x-yang-type": "snmpv2-tc:DateAndTime", "readOnly": true }, "csubSessionDerivedCfg": { "type": "string", "description": "This object indicates the row in the cdtTemplateTable (defined\n by the CISCO-DYNAMIC-TEMPLATE-MIB) describing the derived\n configuration for the subscriber session.\n \n Observe that the value of cdtTemplateType corresponding to the\n referenced row must be 'derived'.", "x-yang-type": "cisco-dynamic:DynamicTemplateName", "readOnly": true }, "csubSessionAvailableIdentities": { "type": "string", "description": "This object indicates the subscriber identities that the system\n has successfully collected for the subscriber session.\n \n Each bit in this bit string corresponds to a column in this\n table. If the bit is '0', then the value of the corresponding\n column is invalid. If the bit is '1', then the value of the\n corresponding column represents the value of the subscriber\n identity collected by the system.\n \n The following list specifies the mappings between the bits and\n the columns:\n \n 'subscriberLabel' => csubSessionSubscriberLabel\n 'macAddress' => csubSessionMacAddress\n 'nativeVrf' => csubSessionNativeVrf\n 'nativeIpAddress' => csubSessionNativeIpAddrType,\n csubSessionNativeIpAddr,\n csubSessionNativeIpMask\n 'nativeIpAddress2'=> csubSessionNativeIpAddrType2,\n csubSessionNativeIpAddr2,\n csubSessionNativeIpMask2 \n 'domainVrf' => csubSessionDomainVrf\n 'domainIpAddress' => csubSessionDomainIpAddrType,\n csubSessionDomainIpAddr,\n csubSessionDomainIpMask\n 'pbhk' => csubSessionPbhk\n 'remoteId' => csubSessionRemoteId\n 'circuitId' => csubSessionCircuitId\n 'nasPort' => csubSessionNasPort\n 'domain' => csubSessionDomain\n 'username' => csubSessionUsername\n 'acctSessionId' => csubSessionAcctSessionId\n 'dnis' => csubSessionDnis\n 'media' => csubSessionMedia\n 'mlpNegotiated' => csubSessionMlpNegotiated\n 'protocol' => csubSessionProtocol\n 'dhcpClass' => csubSessionDhcpClass\n 'tunnelName' => csubSessionTunnelName\n \n Observe that the bit 'ifIndex' should always be '1'. This\n identity maps to the ifIndex assigned to the subscriber\n session.\n \n Observe that the bit 'serviceName' maps to one or more instance\n of ccbptPolicyMap (defined by the CISCO-CBP-TARGET-MIB).", "x-yang-type": "cisco-subscriber-identity:SubSessionIdentities", "readOnly": true }, "csubSessionSubscriberLabel": { "type": "string", "description": "This object indicates a positive integer-value uniquely\n identifying the subscriber session within the scope of\n the system.\n \n This column is valid only if the 'subscriberLabel' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberLabel", "readOnly": true }, "csubSessionMacAddress": { "type": "string", "description": "This object indicates the MAC address of the subscriber.\n \n This column is valid only if the 'macAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "yang:mac-address", "readOnly": true }, "csubSessionNativeVrf": { "type": "string", "description": "This object indicates the VRF originating the subscriber\n session.\n \n This column is valid only if the 'nativeVrf' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberVRF", "readOnly": true }, "csubSessionNativeIpAddrType": { "type": "string", "description": "This object indicates the type of IP address assigned to the\n subscriber on the customer-facing side of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "csubSessionNativeIpAddr": { "type": "string", "description": "This object indicates the IP address assigned to the\n subscriber on the customer-facing side of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "csubSessionNativeIpMask": { "type": "string", "description": "This object indicates the corresponding mask for the IP\n address assigned to the subscriber on the customer-facing side\n of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "csubSessionDomainVrf": { "type": "string", "description": "This object indicates the VRF to which the system transfers\n the subscriber session's traffic.\n \n This column is valid only if the 'domainVrf' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberVRF", "readOnly": true }, "csubSessionDomainIpAddrType": { "type": "string", "description": "This object indicates the type of IP address assigned to the\n subscriber on the service-facing side of the system.\n \n This column is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "csubSessionDomainIpAddr": { "type": "string", "description": "This object indicates the IP address assigned to the\n subscriber on the service-facing side of the system.\n \n This column is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "csubSessionDomainIpMask": { "type": "string", "description": "This object indicates the corresponding mask for the IP\n address assigned to the subscriber on the service-facing side of\n the system.\n \n This column is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "csubSessionPbhk": { "type": "string", "description": "This object indicates the PBHK identifying the subscriber.\n \n This column is valid only if the 'pbhk' bit of the corresponding\n instance of csubSessionAvailableIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberPbhk", "readOnly": true }, "csubSessionRemoteId": { "type": "string", "description": "This object indicates the Remote-Id identifying the 'calling\n station' or AN supporting the circuit that provides access to\n the subscriber.\n \n This column is valid only if the 'remoteId' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberRemoteId", "readOnly": true }, "csubSessionCircuitId": { "type": "string", "description": "This object indicates the Circuit-Id identifying the circuit\n supported by the 'calling station' or AN providing access to\n the subscriber.\n \n This column is valid only if the 'circuitId' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberCircuitId", "readOnly": true }, "csubSessionNasPort": { "type": "string", "description": "This object indicates the NAS port-identifier identifying the\n port on the NAS providing access to the subscriber.\n \n This column is valid only if the 'nasPort' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberNasPort", "readOnly": true }, "csubSessionDomain": { "type": "string", "description": "This object indicates the domain associated with the\n subscriber.\n \n This column is valid only if the 'domain' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDomain", "readOnly": true }, "csubSessionUsername": { "type": "string", "description": "This object indicates the username identifying the subscriber.\n \n This column is valid only if the 'username' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberUsername", "readOnly": true }, "csubSessionAcctSessionId": { "type": "string", "description": "This object indicates the accounting session identifier\n assigned to the subscriber session.\n \n This column is valid only if the 'accountingSid' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberAcctSessionId", "readOnly": true }, "csubSessionDnis": { "type": "string", "description": "This object indicates the DNIS number dialed by the\n subscriber to access the 'calling station' or AN.\n \n This column is valid only if the 'dnis' bit of the corresponding\n instance of csubSessionAvailableIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDnis", "readOnly": true }, "csubSessionMedia": { "type": "string", "description": "This object indicates the type of media providing access to\n the subscriber.\n \n This column is valid only if the 'media' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberMediaType", "readOnly": true }, "csubSessionMlpNegotiated": { "type": "boolean", "description": "This object indicates whether the subscriber session was\n established using multi-link PPP negotiation.\n \n This column is valid only if the 'mlpNegotiated' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "readOnly": true }, "csubSessionProtocol": { "type": "string", "description": "This object indicates the type of protocol providing access to\n the subscriber.\n \n This column is valid only if the 'protocol' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberProtocolType", "readOnly": true }, "csubSessionDhcpClass": { "type": "string", "description": "This object indicates the name of the class matching the DHCP\n DISCOVER message received from the subscriber.\n \n This column is valid only if the 'dhcpClass' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDhcpClass", "readOnly": true }, "csubSessionTunnelName": { "type": "string", "description": "This object indicates the name of the VPDN used to carry the\n subscriber session to the system.\n \n This column is valid only if the 'tunnelName' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberTunnelName", "readOnly": true }, "csubSessionLocationIdentifier": { "type": "string", "description": "This object indicates the location of the\n subscriber", "x-yang-type": "cisco-subscriber-identity:SubscriberLocationName", "readOnly": true }, "csubSessionServiceIdentifier": { "type": "string", "description": "This object indicates the name used to identify the services\n subscribed by a particular session.", "x-yang-type": "cisco-subscriber-identity:SubscriberServiceName", "readOnly": true }, "csubSessionLastChanged": { "type": "string", "description": "This object indicates when the subscriber session is updated\n with new policy information.", "x-yang-type": "snmpv2-tc:DateAndTime", "readOnly": true }, "csubSessionNativeIpAddrType2": { "type": "string", "description": "This object indicates the type of IP address assigned to the\n subscriber on the customer-facing side of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.\n \n In Dual stack scenarios both 'csubSessionNativeIpAddrType' and \n 'csubSessionNativeIpAddrType2' will be valid", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "csubSessionNativeIpAddr2": { "type": "string", "description": "This object indicates the IP address assigned to the\n subscriber on the customer-facing side of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "csubSessionNativeIpMask2": { "type": "string", "description": "This object indicates the corresponding mask for the IP\n address assigned to the subscriber on the customer-facing side\n of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "csubSessionByTypeTable": { "type": "object", "description": "This table describes a list of subscriber sessions currently\n maintained by the system. The tables sorts the subscriber\n sessions first by the subscriber session's type and second by\n the ifIndex assigned to the subscriber session.", "properties": { "csubSessionByTypeEntry": { "type": "array", "description": "csubSessionByTypeEntry", "items": { "type": "object", "properties": { "csubSessionByType": { "type": "string", "description": "This object indicates the type of the subscriber session.", "x-yang-type": "cisco-subscriber:SubSessionType", "readOnly": true }, "csubSessionIfIndex": { "type": "string", "description": "This object indicates the ifIndex assigned to the subscriber\n session.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "csubAggStatsTable": { "type": "object", "description": "This table contains sets of aggregated statistics relating to\n subscriber sessions, where each set has a unique scope of\n aggregation.", "properties": { "csubAggStatsEntry": { "type": "array", "description": "csubAggStatsEntry", "items": { "type": "object", "properties": { "csubAggStatsPointType": { "type": "string", "description": "This object indicates format of the csubAggStatsPoint\n for this entry. \n \n The format for the csubAggStatsPoint is as follows: \n \n csubAggStatsPointType csubAggStatsPoint \n ---------------------- ------------------ \n 'physical' PhysicalIndex \n 'interface' InterfaceIndex", "readOnly": true }, "csubAggStatsPoint": { "type": "integer", "description": "This object should be read with csubAggStatsPointType always.\n \n This object indicates one of the determining factors affecting \n the 'scope of aggregation' for the set of statistics contained \n by the row. \n \n The value indicated by this object should be interpreted as the \n identifier for the point type specific base table. \n \n For point types of 'physical', the type specific base table is \n the entPhysicalTable and this value is a PhysicalIndex. For \n point types of 'interface', the type specific base table is \n the ifTable and this value is an InterfaceIndex. \n \n If this column indicates a physical entity which has an \n entPhysicalClass of 'chassis', then the 'scope of aggregation' \n may includes those subscriber sessions maintained by all nodes \n contained by the system. \n \n If this column indicates a physical entity which has an \n entPhysicalClass of 'module' (e.g., a line card), then the \n 'scope of aggregation' may include those subscriber sessions \n maintained by the nodes contained by the module. \n \n If this column indicates a physical entity which has an \n entPhysicalClass of 'cpu', then the 'scope of aggregation' may \n include those subscriber sessions maintained by the node \n running on the processor. \n \n Aggregation points with entPhysicalTable / ifTable overlap: \n For interfaces which map directly to physical 'port' class \n entities in the entPhysicalTable, the preferred representation \n as aggregation points is the 'physical' point type and \n PhysicalIndex identifier.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsSessionType": { "type": "string", "description": "This object indicates one of the determining factors affecting\n the 'scope of aggregation' for the statistics contained by the\n row.\n \n If the value of this column is 'all', then the 'scope of\n aggregation' may include all subscriber sessions, regardless of\n type.\n \n If the value of this column is not 'all', then the 'scope of\n aggregation' may include subscriber sessions of the indicated\n subscriber session type.", "x-yang-type": "cisco-subscriber:SubSessionType", "readOnly": true }, "csubAggStatsPendingSessions": { "type": "integer", "description": "This object indicates the current number of subscriber sessions\n within the 'scope of aggregation' that are in the PENDING\n state.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsUpSessions": { "type": "integer", "description": "This object indicates the current number of subscriber sessions\n within the 'scope of aggregation' that are in the UP state.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsAuthSessions": { "type": "integer", "description": "This object indicates the current number of subscriber session\n within the 'scope of aggregation' that have been authenticated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsUnAuthSessions": { "type": "integer", "description": "This object indicates the current number of subscriber session\n within the 'scope of aggregation' that have not been authenticated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsLightWeightSessions": { "type": "integer", "description": "This object indicates the current number of subscriber\n sessions within the 'scope of aggregation' that are less resource intensive.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsRedSessions": { "type": "integer", "description": "This object indicates the current number of subscriber sessions\n within the 'scope of aggregation' that are redundant (i.e., \n sessions with a csubSessionRedundancyMode of 'standby').", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsHighUpSessions": { "type": "integer", "description": "This object indicates the highest number of subscriber sessions\n within the 'scope of aggregation' observed simultaneously in the UP\n state since the last discontinuity time.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsAvgSessionUptime": { "type": "integer", "description": "This object indicates the average time subscriber sessions\n within the 'scope of aggregation' spent in the UP state.\n \n The system calculates this average over all subscriber\n sessions maintained by all nodes contained by the 'scope of\n aggregation' since the last discontinuity time.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsAvgSessionRPM": { "type": "integer", "description": "This object indicates the average rate (per minute) at which\n the nodes contained by the 'scope of aggregation' have\n established new subscriber sessions.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsAvgSessionRPH": { "type": "integer", "description": "This object indicates the average rate (per hour) at which the\n nodes contained by the 'scope of aggregation' have established new\n subscriber sessions.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsThrottleEngagements": { "type": "integer", "description": "This object indicates the number of times that nodes contained\n within the 'scope of aggregation' have engaged the subscriber\n session throttle since the last discontinuity time.\n \n The mechanics of a subscriber session throttle vary with\n subscriber session type and implementation. However, the\n general concept of the throttle prevents a node from having\n to deal with more than a configured number of requests to\n establish subscriber sessions from the same CPE within the a\n configured interval of time. When the number of requests\n exceeds the configured threshold within the configured interval,\n then the node processing the requests engages the throttle.\n Typically, when a node engages a throttle, it drops requests\n from the CPE for some period of time, after which the node\n disengages the throttle.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime.", "minimum": 0, "readOnly": true }, "csubAggStatsTotalCreatedSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' created since the\n discontinuity time.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime.", "minimum": 0, "readOnly": true }, "csubAggStatsTotalFailedSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that were in the PENDING state\n and terminated for reasons other than disconnect since the last\n discontinuity time.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime.", "minimum": 0, "readOnly": true }, "csubAggStatsTotalUpSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned to the UP\n state since the last discontinuity time.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime", "minimum": 0, "readOnly": true }, "csubAggStatsTotalAuthSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned from the\n UNAUTHENTICATED to the AUTHENTICATED state since the last\n discontinuity time.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime", "minimum": 0, "readOnly": true }, "csubAggStatsTotalDiscSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n terminated due to a disconnect event since the last\n discontinuity time.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime", "minimum": 0, "readOnly": true }, "csubAggStatsTotalLightWeightSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n that are less resource intensive", "minimum": 0, "readOnly": true }, "csubAggStatsTotalFlowsUp": { "type": "integer", "description": "This object indicates the total number of differential traffic classes\n on subscriber sessions. IP ACLs are used to create differential flows(Traffic Classes). \n Each Traffic Class can have a different set of features applied.", "minimum": 0, "readOnly": true }, "csubAggStatsDayCreatedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' created during the last 24\n hours.\n \n The system calculates the value of this column by summing the\n values of all instances of csubAggStatsIntCreatedSessions that\n expand this row and have a corresponding csubAggStatsIntValid of\n 'true'.", "x-yang-type": "perfhist-tc:PerfTotalCount", "readOnly": true }, "csubAggStatsDayFailedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that were in the PENDING state\n and terminated for reasons other than disconnect during the\n last 24 hours.\n \n The system calculates the value of this column by summing the\n values of all instances of csubAggStatsIntFailedSessions that\n expand this row and have a corresponding csubAggStatsIntValid\n of 'true'.", "x-yang-type": "perfhist-tc:PerfTotalCount", "readOnly": true }, "csubAggStatsDayUpSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned to the UP\n state during the last 24 hours.\n \n The system calculates the value of this column by summing the\n values of all instances of csubAggStatsIntUpSessions that\n expand this row and have a corresponding csubAggStatsIntValid\n of 'true'.", "x-yang-type": "perfhist-tc:PerfTotalCount", "readOnly": true }, "csubAggStatsDayAuthSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned from the\n UNAUTHENTICATED to the AUTHENTICATED state during the last 24\n hours.\n \n The system calculates the value of this column by summing the\n values of all instances of csubAggStatsIntAuthSessions that\n expand this row and have a corresponding csubAggStatsIntValid of\n 'true'.", "x-yang-type": "perfhist-tc:PerfTotalCount", "readOnly": true }, "csubAggStatsDayDiscSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n terminated due to a disconnect event during the last 24 hours.\n \n The system calculates the value of this column by summing the\n values of all instances of csubAggStatsIntDiscSessions that\n expand this row and have a corresponding csubAggStatsIntValid of\n 'true'.", "x-yang-type": "perfhist-tc:PerfTotalCount", "readOnly": true }, "csubAggStatsCurrTimeElapsed": { "type": "integer", "description": "This object indicates the time that has elapsed since the\n beginning of the current 15-minute measurement interval. If,\n for some reason, such as an adjustment in the system's\n time-of-day clock, the current interval exceeds the maximum\n value, then the value of this column will be the maximum value.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsCurrValidIntervals": { "type": "integer", "description": "This object indicates the number of intervals for which data\n was collected. The value of this column will be '96' unless the\n measurement was started (or restarted) within 1,440 minutes, in\n which case the value will be the number of complete 15-minute\n intervals for which the system has at least some data.\n \n In certain cases it is possible that some intervals are\n unavailable, in which case the value of this column will\n be maximum interval number for which data is available.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsCurrInvalidIntervals": { "type": "integer", "description": "This object indicates the number of intervals in the range\n from 0 to csubCurrValidIntervals for which no data is\n available. This object will typically be '0' except in certain\n circumstances when some intervals are unavailable.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsCurrFlowsUp": { "type": "integer", "description": "This object indicates the current number of differential traffic classes\n on subscriber sessions currently UP. IP ACLs are used to create differential flows\n (Traffic Classes).Each Traffic Class can have a different set of features applied.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsCurrCreatedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' created during the current\n 15-minute interval.", "x-yang-type": "perfhist-tc:PerfCurrentCount", "readOnly": true }, "csubAggStatsCurrFailedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that were in the PENDING state\n and terminated for reasons other than disconnect during the\n current 15-minute interval.", "x-yang-type": "perfhist-tc:PerfCurrentCount", "readOnly": true }, "csubAggStatsCurrUpSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned to the UP\n state during the current 15-minute interval.", "x-yang-type": "perfhist-tc:PerfCurrentCount", "readOnly": true }, "csubAggStatsCurrAuthSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned from the\n UNAUTHENTICATED to the AUTHENTICATED state during the current\n 15-minute interval.", "x-yang-type": "perfhist-tc:PerfCurrentCount", "readOnly": true }, "csubAggStatsCurrDiscSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n terminated due to a disconnect event during the current\n 15-minute interval.", "x-yang-type": "perfhist-tc:PerfCurrentCount", "readOnly": true }, "csubAggStatsDiscontinuityTime": { "type": "string", "description": "The date and time (as determined by the system's clock) of\n the most recent occurrence of an event affecting the \n continuity of the aggregation statistics for this aggregation \n point.", "x-yang-type": "snmpv2-tc:DateAndTime", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "csubAggStatsIntTable": { "type": "object", "description": "csubAggStatsIntTable", "properties": { "csubAggStatsIntEntry": { "type": "array", "description": "An entry contains the aggregated subscriber session performance\n data collected over a single 15-minute measurement interval\n within a 'scope of aggregation'. For further details regarding\n 'scope of aggregation', see the descriptive text associated with\n the csubAggStatsEntry.", "items": { "type": "object", "properties": { "csubAggStatsPointType": { "type": "string", "description": "csubAggStatsPointType", "x-yang-type": "leafref", "readOnly": true }, "csubAggStatsPoint": { "type": "string", "description": "csubAggStatsPoint", "x-yang-type": "leafref", "readOnly": true }, "csubAggStatsSessionType": { "type": "string", "description": "csubAggStatsSessionType", "x-yang-type": "leafref", "readOnly": true }, "csubAggStatsIntNumber": { "type": "integer", "description": "This object indicates the interval number identifying the\n 15-minute measurement interval for which aggregated subscriber\n session performance data was successfully collected by the\n system.\n \n The interval identified by the value '1' represents the most\n recent 15-minute measurement interval, and the interval\n identified by the value (n) represents the interval immediately\n preceding the interval identified by the value (n-1).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsIntValid": { "type": "boolean", "description": "This object indicates whether the data for the 15-minute\n measurement interval is valid.", "readOnly": true }, "csubAggStatsIntCreatedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' created during the 15-minute\n measurement interval.", "x-yang-type": "perfhist-tc:PerfIntervalCount", "readOnly": true }, "csubAggStatsIntFailedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that were in the PENDING state\n and terminated for reasons other than disconnect during the\n 15-minute measurement interval.", "x-yang-type": "perfhist-tc:PerfIntervalCount", "readOnly": true }, "csubAggStatsIntUpSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned to the UP\n state during the 15-minute measurement interval.", "x-yang-type": "perfhist-tc:PerfIntervalCount", "readOnly": true }, "csubAggStatsIntAuthSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned from the\n UNAUTHENTICATED to the AUTHENTICATED state during the\n 15-minute measurement interval.", "x-yang-type": "perfhist-tc:PerfIntervalCount", "readOnly": true }, "csubAggStatsIntDiscSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n terminated due to a disconnect event during the 15-minute\n measurement interval.", "x-yang-type": "perfhist-tc:PerfIntervalCount", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "csubAggStatsThreshTable": { "type": "object", "description": "Please enter the Table Description here.", "properties": { "csubAggStatsThreshEntry": { "type": "array", "description": "A row in this table exists for each row in the\n csubAggStatsTable.\n Each row defines the set of thresholds and evaluation attributes\n for an aggregation point.", "items": { "type": "object", "properties": { "csubSessionRisingThresh": { "type": "integer", "description": "This threshold, if non-zero, indicates the rising threshold\n for the value of csubAggStatsUpSessions for the aggregation\n point,\n When the current sample of csubAggStatsUpSessions is greater\n than\n or equal to this threshold, and the value of\n csubAggStatsUpSessions\n for the last sample interval was less than this thershold, the\n csubSessionRisingNotif is triggered.\n \n If the value of this threshold is 0, the threshold is\n not evaluated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubSessionFallingThresh": { "type": "integer", "description": "This threshold, if non-zero, indicates the falling threshold\n for the value of csubAggStatsUpSessions for the aggregation\n point,\n When the current sample of csubAggStatsUpSessions is less than\n or equal to this threshold, and the value of\n csubAggStatsUpSessions\n for the last sample interval was greater than this thershold,\n the\n csubSessionFallingNotif is triggered.\n \n If the value of this threshold is 0, the threshold is\n not evaluated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubSessionDeltaPercentFallingThresh": { "type": "integer", "description": "This threshold, if non-zero, indicates the delta falling\n threshold\n as a percentage of the value of csubAggStatsUpSessions for the\n aggregation point, The delta as a percentage of\n csubAggStatsUpSessions (delta_percent) is calculated as\n follows:\n current value of csubAggStatsUpSessions = value(n)\n previous sampled value of csubAggStatsUpSessions =\n value(n-1)\n \n delta_percent = ((value(n-1) - value(n)) /\n value(n-1)) * 100\n \n If the delta_percent value of the current evaluation\n interval is\n greater than the value of this threshold, a\n csubSessionDeltaPercentLossNotif is triggered.\n \n If the value of this threshold is 0, the threshold is\n not evaluated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubSessionThreshEvalInterval": { "type": "integer", "description": "The value of this object sets the number of seconds between\n samples\n for threshold evaluation. For implementations capable of\n per-session event evaluation of thresholds this object\n represents the maximum number of seconds between samples.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "csubJobTable": { "type": "object", "description": "This table contains the subscriber session jobs submitted by\n the EMS/NMS.", "properties": { "csubJobEntry": { "type": "array", "description": "csubJobEntry", "items": { "type": "object", "properties": { "csubJobId": { "type": "string", "description": "This object indicates an arbitrary, positive integer-value\n uniquely identifying the subscriber session job.", "x-yang-type": "CISCO-SUBSCRIBER-SESSION-MIB:SubscriberJobIdentifier", "readOnly": true }, "csubJobStatus": { "type": "string", "description": "This object specifies the status of the subscriber session\n job. The following columns must be valid before activating a\n subscriber session job:\n \n - csubJobStorage\n - csubJobType\n - csubJobControl\n \n However, these objects specify a default value. Thus, it is\n possible to use create-and-go semantics without setting any\n additional columns.\n \n An implementation must allow the EMS/NMS to modify any column\n when this column is 'active', including columns defined in\n tables that have a one-to-one or sparse dependent relationship\n on this table.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "csubJobStorage": { "type": "string", "description": "This object specifies what happens to the subscriber session\n job upon restart.", "x-yang-type": "snmpv2-tc:StorageType", "readOnly": true }, "csubJobType": { "type": "string", "description": "This object specifies the type of subscriber session job:\n \n 'noop'\n This type of job does nothing and simply serves as a\n convenient default value for newly created jobs, thereby\n allowing create-and-go row creation without having to\n specify the type of job.\n \n 'query'\n This type of job starts a subscriber session query. The\n system searches for any subscriber sessions matching the\n configured criteria and sorts them into a resulting\n report.\n \n Upon activation of a subscriber session with this value,\n the system automatically creates corresponding rows in\n the csubJobMatchParamsTable and csubQueryParamsTable.\n \n 'clear'\n This type of job causes the system to terminated all\n subscriber sessions matching configured criteria.\n \n Upon activation of a subscriber session with this value,\n the system automatically creates a corresponding row in\n the csubJobMatchParamsTable.", "readOnly": true }, "csubJobControl": { "type": "string", "description": "This object specifies an action relating to the subscriber\n session job:\n \n 'noop'\n This action does nothing.\n \n 'start'\n If the corresponding instance of csubJobType is 'noop',\n then this action simply causes the system to set the\n corresponding instances of csubJobState and\n csubJobFinishedReason to 'finished' and 'normal',\n respectively.\n \n If the corresponding instance of csubJobType is not\n 'noop' and the system is not executing a subscriber\n session job, then this action causes the system\n immediately execute the subscriber session job.\n \n If the corresponding instance of csubJobType is not\n 'noop' and the system is already executing a subscriber\n session job, then this action causes the system to put\n the job on the subscriber session job queue.\n \n 'abort'\n If the subscriber session job is in the subscriber\n session job queue, then this action causes the system to\n remove the job from the queue.\n \n If the system is executing the subscriber session job,\n then this action causes the system to stop the job.\n \n 'release'\n This action causes the system to destroy any\n corresponding rows in the csubJobReportTable.\n \n The system only accepts this action for a previously\n executed subscriber session job having a corresponding\n instance of csubJobType set to 'query'. Any attempt to\n issue this action under other circumstances will result\n in a response indicating an error-status of\n 'inconsistentValue'.\n \n When read, this column is always 'noop'.", "readOnly": true }, "csubJobState": { "type": "string", "description": "This object indicates the current state of the subscriber\n session job:\n \n 'idle'\n This state indicates that the system has not executed\n the subscriber session job since it was created.\n \n 'pending'\n This state indicates that the subscriber session job is\n waiting in the subscriber session job queue.\n \n 'inProgress'\n This state indicates that the system is executing the\n subscriber session job. Observe that the system may\n execute more than one subscriber session job at a time.\n \n 'finished'\n This state indicates that the system has executed the\n subscriber session job and it has finished. The\n corresponding instance of csubJobFinishedReason\n indicates further details regarding the reason why the\n job finished.", "readOnly": true }, "csubJobStartedTime": { "type": "string", "description": "This object indicates the value of sysUpTime when the system\n started executing the subscriber session job. This value will\n be '0' when the corresponding instance of csubJobState is 'idle'\n or 'pending'.", "x-yang-type": "yang:timestamp", "readOnly": true }, "csubJobFinishedTime": { "type": "string", "description": "This object indicates the value of sysUpTime when the system\n finished executing the subscriber session job, for whatever\n reason. This value will be '0' when the corresponding instance\n of csubJobState is 'idle', 'pending', or 'inProgress'.", "x-yang-type": "yang:timestamp", "readOnly": true }, "csubJobFinishedReason": { "type": "string", "description": "This object indicates the reason why the system finished\n executing the subscriber session job:\n \n 'invalid'\n Indicates that the corresponding instance of\n csubJobState is either 'idle', 'pending', or\n 'inProgress'.\n \n 'other'\n Indicates that the system finished executing the\n subscriber session job abnormally for a reason not\n recognized by this MIB module.\n \n 'normal'\n Indicates that the system finished executing the\n subscriber session job with no problems.\n \n 'aborted'\n Indicates that the system finished executing the\n subscriber session job as the result of the EMS/NMS\n writing 'abort' to the corresponding instance of\n csubJobControl.\n \n 'insufficientResources'\n Indicates that the system finished executing the\n subscriber session job abnormally due to insufficient\n resources to continue.\n \n 'error'\n Indicates that the system encountered an error that\n prevented it from completing the job.", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "csubJobMatchParamsTable": { "type": "object", "description": "This table contains subscriber session job parameters\n describing match criteria.\n \n This table has a sparse-dependent relationship on the\n csubJobTable, containing a row for each job having a\n csubJobType of 'query' or 'clear'.", "properties": { "csubJobMatchParamsEntry": { "type": "array", "description": "csubJobMatchParamsEntry", "items": { "type": "object", "properties": { "csubJobId": { "type": "string", "description": "csubJobId", "x-yang-type": "leafref", "readOnly": true }, "csubJobMatchIdentities": { "type": "string", "description": "This object specifies the subscriber identities that the\n system uses to determine the subscriber sessions the job\n executes on.\n \n Each bit in this bit string corresponds to one or more columns\n in this table. If the bit is '0', then the value of the\n corresponding columns are invalid. If the bit is '1', then the\n value of corresponding columns are valid.\n \n The following list specifies the mappings between the bits and\n the columns:\n \n 'subscriberLabel' => csubJobMatchSubscriberLabel\n 'macAddress' => csubJobMatchMacAddress\n 'nativeVrf' => csubJobMatchNativeVrf\n 'nativeIpAddress' => csubJobMatchNativeIpAddrType,\n csubJobMatchNativeIpAddr,\n csubJobMatchNativeIpMask,\n 'domainVrf' => csubJobMatchDomainVrf\n 'domainIpAddress' => csubJobMatchDomainIpAddrType,\n csubJobMatchDomainIpAddr,\n csubJobMatchDomainIpMask\n 'pbhk' => csubJobMatchPbhk\n 'remoteId' => csubJobMatchRemoteId\n 'circuitId' => csubJobMatchCircuitId\n 'nasPort' => csubJobMatchNasPort\n 'domain' => csubJobMatchDomain\n 'username' => csubJobMatchUsername\n 'acctSessionId' => csubJobMatchAcctSessionId\n 'dnis' => csubJobMatchDnis\n 'media' => csubJobMatchMedia\n 'mlpNegotiated' => csubJobMatchMlpNegotiated\n 'protocol' => csubJobMatchProtocol\n 'serviceName' => csubJobMatchServiceName\n 'dhcpClass' => csubJobMatchDhcpClass\n 'tunnelName' => csubJobMatchTunnelName\n \n Observe that the bit 'ifIndex' has no meaning, as subscriber\n session jobs do not match against this subscriber session\n identity.", "x-yang-type": "cisco-subscriber-identity:SubSessionIdentities", "readOnly": true }, "csubJobMatchOtherParams": { "type": "string", "description": "This object specifies other parameters relating to subscriber\n sessions a subscriber session job may match against.\n \n Each bit in this bit string corresponds to a column in this\n table. If the bit is '0', then the value of the corresponding\n column is invalid. If the bit is '1', then the value of the\n corresponding column represents the value of the parameter\n identity the system should match against for the corresponding\n subscriber session job.\n \n The following list specifies the mappings between bits and the\n columns:\n \n 'danglingDuration' => csubJobMatchDanglingDuration\n 'state' => csubJobMatchState\n 'authenticated' => csubJobMatchAuthenticated\n 'redundancyMode' => csubJobMatchRedundancyMode", "readOnly": true }, "csubJobMatchSubscriberLabel": { "type": "string", "description": "This object specifies the subscriber label that the system\n matches against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'subscriberLabel' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberLabel", "readOnly": true }, "csubJobMatchMacAddress": { "type": "string", "description": "This object specifies the MAC address that the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'macAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "yang:mac-address", "readOnly": true }, "csubJobMatchNativeVrf": { "type": "string", "description": "This object specifies the native VRF the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'nativeVrf' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberVRF", "readOnly": true }, "csubJobMatchNativeIpAddrType": { "type": "string", "description": "This object specifies the type of Internet address specified\n by csubJobMatchNativeIpAddr and csubJobMatchNativeIpMask.\n \n This value is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "csubJobMatchNativeIpAddr": { "type": "string", "description": "This object specifies the native IP address that the system\n matches against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "csubJobMatchNativeIpMask": { "type": "string", "description": "This object specifies the mask used when matching the native IP\n address against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "csubJobMatchDomainVrf": { "type": "string", "description": "This object specifies the domain VRF the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'domainVrf' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberVRF", "readOnly": true }, "csubJobMatchDomainIpAddrType": { "type": "string", "description": "This object specifies the type of Internet address specified\n by csubJobMatchDomainIpAddr and csubJobMatchDomainIpMask.\n \n This value is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "csubJobMatchDomainIpAddr": { "type": "string", "description": "This object specifies the domain IP address that the system\n matches against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "csubJobMatchDomainIpMask": { "type": "string", "description": "This object specifies the mask used when matching the domain IP\n address against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "csubJobMatchPbhk": { "type": "string", "description": "This object specifies the PBHK that the system matches against\n subscriber sessions in the process of executing a subscriber\n session job.\n \n This value is valid only if the 'pbhk' bit of the corresponding\n instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberPbhk", "readOnly": true }, "csubJobMatchRemoteId": { "type": "string", "description": "This object specifies the Remote-Id the system matches against\n subscriber sessions in the process of executing a subscriber\n session job.\n \n This value is valid only if the 'remoteId' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberRemoteId", "readOnly": true }, "csubJobMatchCircuitId": { "type": "string", "description": "This object specifies the Circuit-Id the system matches against\n subscriber sessions in the process of executing a subscriber\n session job.\n \n This value is valid only if the 'circuitId' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberCircuitId", "readOnly": true }, "csubJobMatchNasPort": { "type": "string", "description": "This object specifies the NAS port-identifier the system\n matches against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'nasPort' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberNasPort", "readOnly": true }, "csubJobMatchDomain": { "type": "string", "description": "This object specifies the domain the system matches against\n subscriber sessions in the process of executing a subscriber\n session job.\n \n This value is valid only if the 'domain' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDomain", "readOnly": true }, "csubJobMatchUsername": { "type": "string", "description": "This object specifies the username the system matches against\n subscriber sessions in the process of executing a subscriber\n session job.\n \n This value is valid only if the 'username' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberUsername", "readOnly": true }, "csubJobMatchAcctSessionId": { "type": "string", "description": "This object specifies the accounting session identifier the\n system matches against subscriber sessions in the process of\n executing a subscriber session job.\n \n This value is valid only if the 'accountingSid' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberAcctSessionId", "readOnly": true }, "csubJobMatchDnis": { "type": "string", "description": "This object specifies the DNIS number the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'dnis' bit of the corresponding\n instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDnis", "readOnly": true }, "csubJobMatchMedia": { "type": "string", "description": "This object specifies the media type the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'media' bit of the corresponding\n instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberMediaType", "readOnly": true }, "csubJobMatchMlpNegotiated": { "type": "boolean", "description": "This object specifies the MLP negotiated flag the system\n matches against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'mlpNegotiated' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "readOnly": true }, "csubJobMatchProtocol": { "type": "string", "description": "This object specifies the protocol type the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'protocol' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberProtocolType", "readOnly": true }, "csubJobMatchServiceName": { "type": "string", "description": "This object specifies the service name the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'serviceName' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-cbp:CbpElementName", "readOnly": true }, "csubJobMatchDhcpClass": { "type": "string", "description": "This object specifies the DHCP class name the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'dhcpClass' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDhcpClass", "readOnly": true }, "csubJobMatchTunnelName": { "type": "string", "description": "This object specifies the tunnel name the system matches\n against subscriber session in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'tunnelName' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberTunnelName", "readOnly": true }, "csubJobMatchDanglingDuration": { "type": "integer", "description": "This object specifies the minimum interval of time a subscriber\n session can remain dangling in order for the system to consider\n it a match in the process of executing a subscriber session job.\n A 'dangling' subscriber session is one in the PENDING state.\n \n The value '0' cannot be written to an instance of this object.\n However, it serves as a convenient value when the column is not\n valid.\n \n This value is valid only if the 'danglingDuration' bit of the\n corresponding instance of csubJobMatchOtherParams is '1'.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubJobMatchState": { "type": "string", "description": "This object specifies the state of a subscriber session in\n order for the system to consider a match in the process of\n executing a subscriber session job.\n \n The value 'other' is not valid and an implementation should\n not allow it to be written to this column.\n \n This value is valid only if the 'state' bit of the\n corresponding instance of csubJobMatchOtherParams is '1'.", "x-yang-type": "cisco-subscriber:SubSessionState", "readOnly": true }, "csubJobMatchAuthenticated": { "type": "boolean", "description": "This object specifies whether a subscriber session should be\n unauthenticated for the system to consider a match in the\n process of executing a subscriber session job.\n \n If this column is 'false', then the subscriber session job\n matches subscriber sessions that are unauthenticated.\n \n If this column is 'true', then the subscriber session job\n matches subscriber session that are authenticated.\n \n This value is valid only if the 'authenticated' bit of the\n corresponding instance of csubJobMatchParams is '1'.", "readOnly": true }, "csubJobMatchRedundancyMode": { "type": "string", "description": "This object specifies the redudancy mode of the subscriber\n session in order for the system to consider a match in the\n process of executing a subscriber session job.\n \n The value 'other' is not valid and an implementation should not\n allow it to be written to this column.\n \n This value is valid only if the 'redundancyMode' bit of the\n corresponding instance of csubJobMatchOtherParams is '1'.", "x-yang-type": "cisco-subscriber:SubSessionRedundancyMode", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "csubJobQueryParamsTable": { "type": "object", "description": "This table contains subscriber session job parameters\n describing query parameters.\n \n This table has a sparse-dependent relationship on the\n csubJobTable, containing a row for each job having a\n csubJobType of 'query'.", "properties": { "csubJobQueryParamsEntry": { "type": "array", "description": "csubJobQueryParamsEntry", "items": { "type": "object", "properties": { "csubJobId": { "type": "string", "description": "csubJobId", "x-yang-type": "leafref", "readOnly": true }, "csubJobQuerySortKey1": { "type": "string", "description": "This object specifies the first subscriber identity that the\n system uses when sorting subscriber sessions into the final\n report corresponding to a subscriber session query.\n \n It is not valid to set this column to 'other' or 'ifIndex'.", "x-yang-type": "cisco-subscriber-identity:SubSessionIdentity", "readOnly": true }, "csubJobQuerySortKey2": { "type": "string", "description": "This object specifies the second subscriber identity that the\n system uses when sorting subscriber sessions into the final\n report corresponding to a subscriber session query.\n \n If it is the desire to have the final report sorted on a single\n subscriber identity, then this column should be 'other'.", "x-yang-type": "cisco-subscriber-identity:SubSessionIdentity", "readOnly": true }, "csubJobQuerySortKey3": { "type": "string", "description": "This object specifies the third subscriber identity that the\n system uses when sorting subscriber sessions into the final\n report corresponding to a subscriber session query.\n \n If it is the desire to have the final report sorted on one or\n two subscriber identities, then this column should be 'other'.", "x-yang-type": "cisco-subscriber-identity:SubSessionIdentity", "readOnly": true }, "csubJobQueryResultingReportSize": { "type": "integer", "description": "This object indicates the number of subscriber sessions that\n matched the corresponding subscriber session query.\n \n The value of this column should be '0' unless the corresponding\n value of csubJobState is 'finished'.\n \n The value of this column should be '0' after the EMS/NMS sets\n the corresponding csubJobControl to 'release'.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "csubJobQueueTable": { "type": "object", "description": "This table lists the subscriber session jobs currently pending\n in the subscriber session job queue.", "properties": { "csubJobQueueEntry": { "type": "array", "description": "csubJobQueueEntry", "items": { "type": "object", "properties": { "csubJobQueueNumber": { "type": "integer", "description": "This object indicates an positive, integer-value that uniquely\n identifies the entry in the table. The value of this object\n starts at '1' and monotonically increases for each subscriber\n session job inserted into the subscriber session job queue. If\n the value of this object is '4294967295', the system will reset\n it to '1' when it inserts the next subscriber session job into\n the subscriber session job queue.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubJobQueueJobId": { "type": "string", "description": "This object indicates the identifier associated with the\n subscriber session job.", "x-yang-type": "CISCO-SUBSCRIBER-SESSION-MIB:SubscriberJobIdentifier", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "csubJobReportTable": { "type": "object", "description": "This table contains the reports corresponding to subscriber\n session jobs that have a csubJobType of 'query' and\n csubJobState of 'finished'.\n \n This table has an expansion dependent relationship on the\n csubJobTable, containing zero or more rows for each job.", "properties": { "csubJobReportEntry": { "type": "array", "description": "csubJobReportEntry", "items": { "type": "object", "properties": { "csubJobId": { "type": "string", "description": "csubJobId", "x-yang-type": "leafref", "readOnly": true }, "csubJobReportId": { "type": "integer", "description": "This object indicates an arbitrary, positive, integer-value\n that uniquely identifies this entry in a report. This auxiliary\n value is necessary, as the corresponding subscriber session job\n can specify up to three subscriber identities on which to sort\n the subscriber sessions that end up in the final report.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubJobReportSession": { "type": "string", "description": "This object indicates the ifIndex-value assigned to the\n subscriber session that satisfied the match criteria specified\n by the corresponding subscriber session job having a csubJobType\n of 'query'.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true } } }, "readOnly": true } }, "readOnly": true } } }, "CISCO-SUBSCRIBER-SESSION-MIB_object-1": { "type": "object", "description": "object-1", "properties": { "csubAggStatsPointType": { "type": "string", "description": "csubAggStatsPointType", "x-yang-type": "leafref", "readOnly": true }, "csubAggStatsPoint": { "type": "string", "description": "csubAggStatsPoint", "x-yang-type": "leafref", "readOnly": true }, "csubAggStatsSessionType": { "type": "string", "description": "csubAggStatsSessionType", "x-yang-type": "leafref", "readOnly": true }, "csubAggStatsUpSessions": { "type": "string", "description": "csubAggStatsUpSessions", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-SUBSCRIBER-SESSION-MIB_object-2": { "type": "object", "description": "object-2", "properties": { "csubSessionRisingThresh": { "type": "string", "description": "csubSessionRisingThresh", "x-yang-type": "leafref", "readOnly": true }, "csubSessionDeltaPercentFallingThresh": { "type": "string", "description": "csubSessionDeltaPercentFallingThresh", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-SUBSCRIBER-SESSION-MIB_object-3": { "type": "object", "description": "object-3", "properties": { "csubJobId": { "type": "string", "description": "csubJobId", "x-yang-type": "leafref", "readOnly": true }, "csubJobFinishedReason": { "type": "string", "description": "csubJobFinishedReason", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-SUBSCRIBER-SESSION-MIB_csubSessionEntry": { "type": "array", "description": "csubSessionEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "csubSessionType": { "type": "string", "description": "This object indicates the type of subscriber session.", "x-yang-type": "cisco-subscriber:SubSessionType", "readOnly": true }, "csubSessionIpAddrAssignment": { "type": "string", "description": "This object indicates how the system assigns IP addresses to\n the subscriber:\n \n 'none'\n The system does not an involvement in (or is it aware\n of) the assignment an subscriber IP addresses. For\n example, a system does not have an involvement in the\n assignment of subscriber IP addresses for IP interface\n subscriber sessions.\n \n 'other'\n The system assigns subscriber IP addresses using a\n method not recognized by this MIB module.\n \n 'static'\n Subscriber IP addresses have been configured correctly\n for the service domain. The system does not have an\n involvement in the assignment of the IP address.\n \n 'localPool'\n The system assigns subscriber IP addresses from a\n locally configured pool of IP addresses.\n \n 'dhcpv4'\n The system assigns subscriber IP addresses are using the\n DHCPv4.\n \n 'dhcpv6'\n The system assigns subscriber IP addresses using the\n DHCPv6.\n \n 'userProfileIpAddr'\n The system assigns subscriber IP addresses from a user\n profile.\n \n 'userProfileIpSubnet'\n The system assigns the subscriber an IP subnet from a\n user profile.\n \n 'userProfileNamedPool'\n The system assigns subscriber IP addresses from a\n locally configured named pool specified by a user\n profile.", "readOnly": true }, "csubSessionState": { "type": "string", "description": "This object indicates the operational state of the subscriber\n session.", "x-yang-type": "cisco-subscriber:SubSessionState", "readOnly": true }, "csubSessionAuthenticated": { "type": "boolean", "description": "This object indicates whether the system has successfully\n authenticated the subscriber session.\n \n 'false'\n The subscriber session is operationally up, but in the\n UNAUTHENTICATED state.\n \n 'true'\n The subscriber session is operationally up, but in the\n AUTHENTICATED state.", "readOnly": true }, "csubSessionRedundancyMode": { "type": "string", "description": "This object indicates the redundancy mode in which the\n subscriber session is operating.", "x-yang-type": "cisco-subscriber:SubSessionRedundancyMode", "readOnly": true }, "csubSessionCreationTime": { "type": "string", "description": "This object indicates when the subscriber session was created\n (i.e., when the subscriber session was initiated).", "x-yang-type": "snmpv2-tc:DateAndTime", "readOnly": true }, "csubSessionDerivedCfg": { "type": "string", "description": "This object indicates the row in the cdtTemplateTable (defined\n by the CISCO-DYNAMIC-TEMPLATE-MIB) describing the derived\n configuration for the subscriber session.\n \n Observe that the value of cdtTemplateType corresponding to the\n referenced row must be 'derived'.", "x-yang-type": "cisco-dynamic:DynamicTemplateName", "readOnly": true }, "csubSessionAvailableIdentities": { "type": "string", "description": "This object indicates the subscriber identities that the system\n has successfully collected for the subscriber session.\n \n Each bit in this bit string corresponds to a column in this\n table. If the bit is '0', then the value of the corresponding\n column is invalid. If the bit is '1', then the value of the\n corresponding column represents the value of the subscriber\n identity collected by the system.\n \n The following list specifies the mappings between the bits and\n the columns:\n \n 'subscriberLabel' => csubSessionSubscriberLabel\n 'macAddress' => csubSessionMacAddress\n 'nativeVrf' => csubSessionNativeVrf\n 'nativeIpAddress' => csubSessionNativeIpAddrType,\n csubSessionNativeIpAddr,\n csubSessionNativeIpMask\n 'nativeIpAddress2'=> csubSessionNativeIpAddrType2,\n csubSessionNativeIpAddr2,\n csubSessionNativeIpMask2 \n 'domainVrf' => csubSessionDomainVrf\n 'domainIpAddress' => csubSessionDomainIpAddrType,\n csubSessionDomainIpAddr,\n csubSessionDomainIpMask\n 'pbhk' => csubSessionPbhk\n 'remoteId' => csubSessionRemoteId\n 'circuitId' => csubSessionCircuitId\n 'nasPort' => csubSessionNasPort\n 'domain' => csubSessionDomain\n 'username' => csubSessionUsername\n 'acctSessionId' => csubSessionAcctSessionId\n 'dnis' => csubSessionDnis\n 'media' => csubSessionMedia\n 'mlpNegotiated' => csubSessionMlpNegotiated\n 'protocol' => csubSessionProtocol\n 'dhcpClass' => csubSessionDhcpClass\n 'tunnelName' => csubSessionTunnelName\n \n Observe that the bit 'ifIndex' should always be '1'. This\n identity maps to the ifIndex assigned to the subscriber\n session.\n \n Observe that the bit 'serviceName' maps to one or more instance\n of ccbptPolicyMap (defined by the CISCO-CBP-TARGET-MIB).", "x-yang-type": "cisco-subscriber-identity:SubSessionIdentities", "readOnly": true }, "csubSessionSubscriberLabel": { "type": "string", "description": "This object indicates a positive integer-value uniquely\n identifying the subscriber session within the scope of\n the system.\n \n This column is valid only if the 'subscriberLabel' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberLabel", "readOnly": true }, "csubSessionMacAddress": { "type": "string", "description": "This object indicates the MAC address of the subscriber.\n \n This column is valid only if the 'macAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "yang:mac-address", "readOnly": true }, "csubSessionNativeVrf": { "type": "string", "description": "This object indicates the VRF originating the subscriber\n session.\n \n This column is valid only if the 'nativeVrf' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberVRF", "readOnly": true }, "csubSessionNativeIpAddrType": { "type": "string", "description": "This object indicates the type of IP address assigned to the\n subscriber on the customer-facing side of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "csubSessionNativeIpAddr": { "type": "string", "description": "This object indicates the IP address assigned to the\n subscriber on the customer-facing side of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "csubSessionNativeIpMask": { "type": "string", "description": "This object indicates the corresponding mask for the IP\n address assigned to the subscriber on the customer-facing side\n of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "csubSessionDomainVrf": { "type": "string", "description": "This object indicates the VRF to which the system transfers\n the subscriber session's traffic.\n \n This column is valid only if the 'domainVrf' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberVRF", "readOnly": true }, "csubSessionDomainIpAddrType": { "type": "string", "description": "This object indicates the type of IP address assigned to the\n subscriber on the service-facing side of the system.\n \n This column is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "csubSessionDomainIpAddr": { "type": "string", "description": "This object indicates the IP address assigned to the\n subscriber on the service-facing side of the system.\n \n This column is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "csubSessionDomainIpMask": { "type": "string", "description": "This object indicates the corresponding mask for the IP\n address assigned to the subscriber on the service-facing side of\n the system.\n \n This column is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "csubSessionPbhk": { "type": "string", "description": "This object indicates the PBHK identifying the subscriber.\n \n This column is valid only if the 'pbhk' bit of the corresponding\n instance of csubSessionAvailableIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberPbhk", "readOnly": true }, "csubSessionRemoteId": { "type": "string", "description": "This object indicates the Remote-Id identifying the 'calling\n station' or AN supporting the circuit that provides access to\n the subscriber.\n \n This column is valid only if the 'remoteId' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberRemoteId", "readOnly": true }, "csubSessionCircuitId": { "type": "string", "description": "This object indicates the Circuit-Id identifying the circuit\n supported by the 'calling station' or AN providing access to\n the subscriber.\n \n This column is valid only if the 'circuitId' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberCircuitId", "readOnly": true }, "csubSessionNasPort": { "type": "string", "description": "This object indicates the NAS port-identifier identifying the\n port on the NAS providing access to the subscriber.\n \n This column is valid only if the 'nasPort' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberNasPort", "readOnly": true }, "csubSessionDomain": { "type": "string", "description": "This object indicates the domain associated with the\n subscriber.\n \n This column is valid only if the 'domain' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDomain", "readOnly": true }, "csubSessionUsername": { "type": "string", "description": "This object indicates the username identifying the subscriber.\n \n This column is valid only if the 'username' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberUsername", "readOnly": true }, "csubSessionAcctSessionId": { "type": "string", "description": "This object indicates the accounting session identifier\n assigned to the subscriber session.\n \n This column is valid only if the 'accountingSid' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberAcctSessionId", "readOnly": true }, "csubSessionDnis": { "type": "string", "description": "This object indicates the DNIS number dialed by the\n subscriber to access the 'calling station' or AN.\n \n This column is valid only if the 'dnis' bit of the corresponding\n instance of csubSessionAvailableIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDnis", "readOnly": true }, "csubSessionMedia": { "type": "string", "description": "This object indicates the type of media providing access to\n the subscriber.\n \n This column is valid only if the 'media' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberMediaType", "readOnly": true }, "csubSessionMlpNegotiated": { "type": "boolean", "description": "This object indicates whether the subscriber session was\n established using multi-link PPP negotiation.\n \n This column is valid only if the 'mlpNegotiated' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "readOnly": true }, "csubSessionProtocol": { "type": "string", "description": "This object indicates the type of protocol providing access to\n the subscriber.\n \n This column is valid only if the 'protocol' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberProtocolType", "readOnly": true }, "csubSessionDhcpClass": { "type": "string", "description": "This object indicates the name of the class matching the DHCP\n DISCOVER message received from the subscriber.\n \n This column is valid only if the 'dhcpClass' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDhcpClass", "readOnly": true }, "csubSessionTunnelName": { "type": "string", "description": "This object indicates the name of the VPDN used to carry the\n subscriber session to the system.\n \n This column is valid only if the 'tunnelName' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberTunnelName", "readOnly": true }, "csubSessionLocationIdentifier": { "type": "string", "description": "This object indicates the location of the\n subscriber", "x-yang-type": "cisco-subscriber-identity:SubscriberLocationName", "readOnly": true }, "csubSessionServiceIdentifier": { "type": "string", "description": "This object indicates the name used to identify the services\n subscribed by a particular session.", "x-yang-type": "cisco-subscriber-identity:SubscriberServiceName", "readOnly": true }, "csubSessionLastChanged": { "type": "string", "description": "This object indicates when the subscriber session is updated\n with new policy information.", "x-yang-type": "snmpv2-tc:DateAndTime", "readOnly": true }, "csubSessionNativeIpAddrType2": { "type": "string", "description": "This object indicates the type of IP address assigned to the\n subscriber on the customer-facing side of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.\n \n In Dual stack scenarios both 'csubSessionNativeIpAddrType' and \n 'csubSessionNativeIpAddrType2' will be valid", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "csubSessionNativeIpAddr2": { "type": "string", "description": "This object indicates the IP address assigned to the\n subscriber on the customer-facing side of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "csubSessionNativeIpMask2": { "type": "string", "description": "This object indicates the corresponding mask for the IP\n address assigned to the subscriber on the customer-facing side\n of the system.\n \n This column is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubSessionAvailableIdentities is\n '1'.", "x-yang-type": "inet-address:InetAddress", "readOnly": true } } } }, "CISCO-SUBSCRIBER-SESSION-MIB_csubSessionByTypeEntry": { "type": "array", "description": "csubSessionByTypeEntry", "items": { "type": "object", "properties": { "csubSessionByType": { "type": "string", "description": "This object indicates the type of the subscriber session.", "x-yang-type": "cisco-subscriber:SubSessionType", "readOnly": true }, "csubSessionIfIndex": { "type": "string", "description": "This object indicates the ifIndex assigned to the subscriber\n session.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true } } } }, "CISCO-SUBSCRIBER-SESSION-MIB_csubAggStatsEntry": { "type": "array", "description": "csubAggStatsEntry", "items": { "type": "object", "properties": { "csubAggStatsPointType": { "type": "string", "description": "This object indicates format of the csubAggStatsPoint\n for this entry. \n \n The format for the csubAggStatsPoint is as follows: \n \n csubAggStatsPointType csubAggStatsPoint \n ---------------------- ------------------ \n 'physical' PhysicalIndex \n 'interface' InterfaceIndex", "readOnly": true }, "csubAggStatsPoint": { "type": "integer", "description": "This object should be read with csubAggStatsPointType always.\n \n This object indicates one of the determining factors affecting \n the 'scope of aggregation' for the set of statistics contained \n by the row. \n \n The value indicated by this object should be interpreted as the \n identifier for the point type specific base table. \n \n For point types of 'physical', the type specific base table is \n the entPhysicalTable and this value is a PhysicalIndex. For \n point types of 'interface', the type specific base table is \n the ifTable and this value is an InterfaceIndex. \n \n If this column indicates a physical entity which has an \n entPhysicalClass of 'chassis', then the 'scope of aggregation' \n may includes those subscriber sessions maintained by all nodes \n contained by the system. \n \n If this column indicates a physical entity which has an \n entPhysicalClass of 'module' (e.g., a line card), then the \n 'scope of aggregation' may include those subscriber sessions \n maintained by the nodes contained by the module. \n \n If this column indicates a physical entity which has an \n entPhysicalClass of 'cpu', then the 'scope of aggregation' may \n include those subscriber sessions maintained by the node \n running on the processor. \n \n Aggregation points with entPhysicalTable / ifTable overlap: \n For interfaces which map directly to physical 'port' class \n entities in the entPhysicalTable, the preferred representation \n as aggregation points is the 'physical' point type and \n PhysicalIndex identifier.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsSessionType": { "type": "string", "description": "This object indicates one of the determining factors affecting\n the 'scope of aggregation' for the statistics contained by the\n row.\n \n If the value of this column is 'all', then the 'scope of\n aggregation' may include all subscriber sessions, regardless of\n type.\n \n If the value of this column is not 'all', then the 'scope of\n aggregation' may include subscriber sessions of the indicated\n subscriber session type.", "x-yang-type": "cisco-subscriber:SubSessionType", "readOnly": true }, "csubAggStatsPendingSessions": { "type": "integer", "description": "This object indicates the current number of subscriber sessions\n within the 'scope of aggregation' that are in the PENDING\n state.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsUpSessions": { "type": "integer", "description": "This object indicates the current number of subscriber sessions\n within the 'scope of aggregation' that are in the UP state.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsAuthSessions": { "type": "integer", "description": "This object indicates the current number of subscriber session\n within the 'scope of aggregation' that have been authenticated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsUnAuthSessions": { "type": "integer", "description": "This object indicates the current number of subscriber session\n within the 'scope of aggregation' that have not been authenticated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsLightWeightSessions": { "type": "integer", "description": "This object indicates the current number of subscriber\n sessions within the 'scope of aggregation' that are less resource intensive.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsRedSessions": { "type": "integer", "description": "This object indicates the current number of subscriber sessions\n within the 'scope of aggregation' that are redundant (i.e., \n sessions with a csubSessionRedundancyMode of 'standby').", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsHighUpSessions": { "type": "integer", "description": "This object indicates the highest number of subscriber sessions\n within the 'scope of aggregation' observed simultaneously in the UP\n state since the last discontinuity time.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsAvgSessionUptime": { "type": "integer", "description": "This object indicates the average time subscriber sessions\n within the 'scope of aggregation' spent in the UP state.\n \n The system calculates this average over all subscriber\n sessions maintained by all nodes contained by the 'scope of\n aggregation' since the last discontinuity time.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsAvgSessionRPM": { "type": "integer", "description": "This object indicates the average rate (per minute) at which\n the nodes contained by the 'scope of aggregation' have\n established new subscriber sessions.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsAvgSessionRPH": { "type": "integer", "description": "This object indicates the average rate (per hour) at which the\n nodes contained by the 'scope of aggregation' have established new\n subscriber sessions.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsThrottleEngagements": { "type": "integer", "description": "This object indicates the number of times that nodes contained\n within the 'scope of aggregation' have engaged the subscriber\n session throttle since the last discontinuity time.\n \n The mechanics of a subscriber session throttle vary with\n subscriber session type and implementation. However, the\n general concept of the throttle prevents a node from having\n to deal with more than a configured number of requests to\n establish subscriber sessions from the same CPE within the a\n configured interval of time. When the number of requests\n exceeds the configured threshold within the configured interval,\n then the node processing the requests engages the throttle.\n Typically, when a node engages a throttle, it drops requests\n from the CPE for some period of time, after which the node\n disengages the throttle.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime.", "minimum": 0, "readOnly": true }, "csubAggStatsTotalCreatedSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' created since the\n discontinuity time.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime.", "minimum": 0, "readOnly": true }, "csubAggStatsTotalFailedSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that were in the PENDING state\n and terminated for reasons other than disconnect since the last\n discontinuity time.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime.", "minimum": 0, "readOnly": true }, "csubAggStatsTotalUpSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned to the UP\n state since the last discontinuity time.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime", "minimum": 0, "readOnly": true }, "csubAggStatsTotalAuthSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned from the\n UNAUTHENTICATED to the AUTHENTICATED state since the last\n discontinuity time.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime", "minimum": 0, "readOnly": true }, "csubAggStatsTotalDiscSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n terminated due to a disconnect event since the last\n discontinuity time.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other times\n as indicated by the value of csubAggStatsDiscontinuityTime", "minimum": 0, "readOnly": true }, "csubAggStatsTotalLightWeightSessions": { "type": "integer", "description": "This object indicates the total number of subscriber sessions\n that are less resource intensive", "minimum": 0, "readOnly": true }, "csubAggStatsTotalFlowsUp": { "type": "integer", "description": "This object indicates the total number of differential traffic classes\n on subscriber sessions. IP ACLs are used to create differential flows(Traffic Classes). \n Each Traffic Class can have a different set of features applied.", "minimum": 0, "readOnly": true }, "csubAggStatsDayCreatedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' created during the last 24\n hours.\n \n The system calculates the value of this column by summing the\n values of all instances of csubAggStatsIntCreatedSessions that\n expand this row and have a corresponding csubAggStatsIntValid of\n 'true'.", "x-yang-type": "perfhist-tc:PerfTotalCount", "readOnly": true }, "csubAggStatsDayFailedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that were in the PENDING state\n and terminated for reasons other than disconnect during the\n last 24 hours.\n \n The system calculates the value of this column by summing the\n values of all instances of csubAggStatsIntFailedSessions that\n expand this row and have a corresponding csubAggStatsIntValid\n of 'true'.", "x-yang-type": "perfhist-tc:PerfTotalCount", "readOnly": true }, "csubAggStatsDayUpSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned to the UP\n state during the last 24 hours.\n \n The system calculates the value of this column by summing the\n values of all instances of csubAggStatsIntUpSessions that\n expand this row and have a corresponding csubAggStatsIntValid\n of 'true'.", "x-yang-type": "perfhist-tc:PerfTotalCount", "readOnly": true }, "csubAggStatsDayAuthSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned from the\n UNAUTHENTICATED to the AUTHENTICATED state during the last 24\n hours.\n \n The system calculates the value of this column by summing the\n values of all instances of csubAggStatsIntAuthSessions that\n expand this row and have a corresponding csubAggStatsIntValid of\n 'true'.", "x-yang-type": "perfhist-tc:PerfTotalCount", "readOnly": true }, "csubAggStatsDayDiscSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n terminated due to a disconnect event during the last 24 hours.\n \n The system calculates the value of this column by summing the\n values of all instances of csubAggStatsIntDiscSessions that\n expand this row and have a corresponding csubAggStatsIntValid of\n 'true'.", "x-yang-type": "perfhist-tc:PerfTotalCount", "readOnly": true }, "csubAggStatsCurrTimeElapsed": { "type": "integer", "description": "This object indicates the time that has elapsed since the\n beginning of the current 15-minute measurement interval. If,\n for some reason, such as an adjustment in the system's\n time-of-day clock, the current interval exceeds the maximum\n value, then the value of this column will be the maximum value.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsCurrValidIntervals": { "type": "integer", "description": "This object indicates the number of intervals for which data\n was collected. The value of this column will be '96' unless the\n measurement was started (or restarted) within 1,440 minutes, in\n which case the value will be the number of complete 15-minute\n intervals for which the system has at least some data.\n \n In certain cases it is possible that some intervals are\n unavailable, in which case the value of this column will\n be maximum interval number for which data is available.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsCurrInvalidIntervals": { "type": "integer", "description": "This object indicates the number of intervals in the range\n from 0 to csubCurrValidIntervals for which no data is\n available. This object will typically be '0' except in certain\n circumstances when some intervals are unavailable.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsCurrFlowsUp": { "type": "integer", "description": "This object indicates the current number of differential traffic classes\n on subscriber sessions currently UP. IP ACLs are used to create differential flows\n (Traffic Classes).Each Traffic Class can have a different set of features applied.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsCurrCreatedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' created during the current\n 15-minute interval.", "x-yang-type": "perfhist-tc:PerfCurrentCount", "readOnly": true }, "csubAggStatsCurrFailedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that were in the PENDING state\n and terminated for reasons other than disconnect during the\n current 15-minute interval.", "x-yang-type": "perfhist-tc:PerfCurrentCount", "readOnly": true }, "csubAggStatsCurrUpSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned to the UP\n state during the current 15-minute interval.", "x-yang-type": "perfhist-tc:PerfCurrentCount", "readOnly": true }, "csubAggStatsCurrAuthSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned from the\n UNAUTHENTICATED to the AUTHENTICATED state during the current\n 15-minute interval.", "x-yang-type": "perfhist-tc:PerfCurrentCount", "readOnly": true }, "csubAggStatsCurrDiscSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n terminated due to a disconnect event during the current\n 15-minute interval.", "x-yang-type": "perfhist-tc:PerfCurrentCount", "readOnly": true }, "csubAggStatsDiscontinuityTime": { "type": "string", "description": "The date and time (as determined by the system's clock) of\n the most recent occurrence of an event affecting the \n continuity of the aggregation statistics for this aggregation \n point.", "x-yang-type": "snmpv2-tc:DateAndTime", "readOnly": true } } } }, "CISCO-SUBSCRIBER-SESSION-MIB_csubAggStatsIntEntry": { "type": "array", "description": "An entry contains the aggregated subscriber session performance\n data collected over a single 15-minute measurement interval\n within a 'scope of aggregation'. For further details regarding\n 'scope of aggregation', see the descriptive text associated with\n the csubAggStatsEntry.", "items": { "type": "object", "properties": { "csubAggStatsPointType": { "type": "string", "description": "csubAggStatsPointType", "x-yang-type": "leafref", "readOnly": true }, "csubAggStatsPoint": { "type": "string", "description": "csubAggStatsPoint", "x-yang-type": "leafref", "readOnly": true }, "csubAggStatsSessionType": { "type": "string", "description": "csubAggStatsSessionType", "x-yang-type": "leafref", "readOnly": true }, "csubAggStatsIntNumber": { "type": "integer", "description": "This object indicates the interval number identifying the\n 15-minute measurement interval for which aggregated subscriber\n session performance data was successfully collected by the\n system.\n \n The interval identified by the value '1' represents the most\n recent 15-minute measurement interval, and the interval\n identified by the value (n) represents the interval immediately\n preceding the interval identified by the value (n-1).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubAggStatsIntValid": { "type": "boolean", "description": "This object indicates whether the data for the 15-minute\n measurement interval is valid.", "readOnly": true }, "csubAggStatsIntCreatedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' created during the 15-minute\n measurement interval.", "x-yang-type": "perfhist-tc:PerfIntervalCount", "readOnly": true }, "csubAggStatsIntFailedSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that were in the PENDING state\n and terminated for reasons other than disconnect during the\n 15-minute measurement interval.", "x-yang-type": "perfhist-tc:PerfIntervalCount", "readOnly": true }, "csubAggStatsIntUpSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned to the UP\n state during the 15-minute measurement interval.", "x-yang-type": "perfhist-tc:PerfIntervalCount", "readOnly": true }, "csubAggStatsIntAuthSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n within the 'scope of aggregation' that transitioned from the\n UNAUTHENTICATED to the AUTHENTICATED state during the\n 15-minute measurement interval.", "x-yang-type": "perfhist-tc:PerfIntervalCount", "readOnly": true }, "csubAggStatsIntDiscSessions": { "type": "string", "description": "This object indicates the total number of subscriber sessions\n terminated due to a disconnect event during the 15-minute\n measurement interval.", "x-yang-type": "perfhist-tc:PerfIntervalCount", "readOnly": true } } } }, "CISCO-SUBSCRIBER-SESSION-MIB_csubAggStatsThreshEntry": { "type": "array", "description": "A row in this table exists for each row in the\n csubAggStatsTable.\n Each row defines the set of thresholds and evaluation attributes\n for an aggregation point.", "items": { "type": "object", "properties": { "csubSessionRisingThresh": { "type": "integer", "description": "This threshold, if non-zero, indicates the rising threshold\n for the value of csubAggStatsUpSessions for the aggregation\n point,\n When the current sample of csubAggStatsUpSessions is greater\n than\n or equal to this threshold, and the value of\n csubAggStatsUpSessions\n for the last sample interval was less than this thershold, the\n csubSessionRisingNotif is triggered.\n \n If the value of this threshold is 0, the threshold is\n not evaluated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubSessionFallingThresh": { "type": "integer", "description": "This threshold, if non-zero, indicates the falling threshold\n for the value of csubAggStatsUpSessions for the aggregation\n point,\n When the current sample of csubAggStatsUpSessions is less than\n or equal to this threshold, and the value of\n csubAggStatsUpSessions\n for the last sample interval was greater than this thershold,\n the\n csubSessionFallingNotif is triggered.\n \n If the value of this threshold is 0, the threshold is\n not evaluated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubSessionDeltaPercentFallingThresh": { "type": "integer", "description": "This threshold, if non-zero, indicates the delta falling\n threshold\n as a percentage of the value of csubAggStatsUpSessions for the\n aggregation point, The delta as a percentage of\n csubAggStatsUpSessions (delta_percent) is calculated as\n follows:\n current value of csubAggStatsUpSessions = value(n)\n previous sampled value of csubAggStatsUpSessions =\n value(n-1)\n \n delta_percent = ((value(n-1) - value(n)) /\n value(n-1)) * 100\n \n If the delta_percent value of the current evaluation\n interval is\n greater than the value of this threshold, a\n csubSessionDeltaPercentLossNotif is triggered.\n \n If the value of this threshold is 0, the threshold is\n not evaluated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubSessionThreshEvalInterval": { "type": "integer", "description": "The value of this object sets the number of seconds between\n samples\n for threshold evaluation. For implementations capable of\n per-session event evaluation of thresholds this object\n represents the maximum number of seconds between samples.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } } }, "CISCO-SUBSCRIBER-SESSION-MIB_csubJobEntry": { "type": "array", "description": "csubJobEntry", "items": { "type": "object", "properties": { "csubJobId": { "type": "string", "description": "This object indicates an arbitrary, positive integer-value\n uniquely identifying the subscriber session job.", "x-yang-type": "CISCO-SUBSCRIBER-SESSION-MIB:SubscriberJobIdentifier", "readOnly": true }, "csubJobStatus": { "type": "string", "description": "This object specifies the status of the subscriber session\n job. The following columns must be valid before activating a\n subscriber session job:\n \n - csubJobStorage\n - csubJobType\n - csubJobControl\n \n However, these objects specify a default value. Thus, it is\n possible to use create-and-go semantics without setting any\n additional columns.\n \n An implementation must allow the EMS/NMS to modify any column\n when this column is 'active', including columns defined in\n tables that have a one-to-one or sparse dependent relationship\n on this table.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "csubJobStorage": { "type": "string", "description": "This object specifies what happens to the subscriber session\n job upon restart.", "x-yang-type": "snmpv2-tc:StorageType", "readOnly": true }, "csubJobType": { "type": "string", "description": "This object specifies the type of subscriber session job:\n \n 'noop'\n This type of job does nothing and simply serves as a\n convenient default value for newly created jobs, thereby\n allowing create-and-go row creation without having to\n specify the type of job.\n \n 'query'\n This type of job starts a subscriber session query. The\n system searches for any subscriber sessions matching the\n configured criteria and sorts them into a resulting\n report.\n \n Upon activation of a subscriber session with this value,\n the system automatically creates corresponding rows in\n the csubJobMatchParamsTable and csubQueryParamsTable.\n \n 'clear'\n This type of job causes the system to terminated all\n subscriber sessions matching configured criteria.\n \n Upon activation of a subscriber session with this value,\n the system automatically creates a corresponding row in\n the csubJobMatchParamsTable.", "readOnly": true }, "csubJobControl": { "type": "string", "description": "This object specifies an action relating to the subscriber\n session job:\n \n 'noop'\n This action does nothing.\n \n 'start'\n If the corresponding instance of csubJobType is 'noop',\n then this action simply causes the system to set the\n corresponding instances of csubJobState and\n csubJobFinishedReason to 'finished' and 'normal',\n respectively.\n \n If the corresponding instance of csubJobType is not\n 'noop' and the system is not executing a subscriber\n session job, then this action causes the system\n immediately execute the subscriber session job.\n \n If the corresponding instance of csubJobType is not\n 'noop' and the system is already executing a subscriber\n session job, then this action causes the system to put\n the job on the subscriber session job queue.\n \n 'abort'\n If the subscriber session job is in the subscriber\n session job queue, then this action causes the system to\n remove the job from the queue.\n \n If the system is executing the subscriber session job,\n then this action causes the system to stop the job.\n \n 'release'\n This action causes the system to destroy any\n corresponding rows in the csubJobReportTable.\n \n The system only accepts this action for a previously\n executed subscriber session job having a corresponding\n instance of csubJobType set to 'query'. Any attempt to\n issue this action under other circumstances will result\n in a response indicating an error-status of\n 'inconsistentValue'.\n \n When read, this column is always 'noop'.", "readOnly": true }, "csubJobState": { "type": "string", "description": "This object indicates the current state of the subscriber\n session job:\n \n 'idle'\n This state indicates that the system has not executed\n the subscriber session job since it was created.\n \n 'pending'\n This state indicates that the subscriber session job is\n waiting in the subscriber session job queue.\n \n 'inProgress'\n This state indicates that the system is executing the\n subscriber session job. Observe that the system may\n execute more than one subscriber session job at a time.\n \n 'finished'\n This state indicates that the system has executed the\n subscriber session job and it has finished. The\n corresponding instance of csubJobFinishedReason\n indicates further details regarding the reason why the\n job finished.", "readOnly": true }, "csubJobStartedTime": { "type": "string", "description": "This object indicates the value of sysUpTime when the system\n started executing the subscriber session job. This value will\n be '0' when the corresponding instance of csubJobState is 'idle'\n or 'pending'.", "x-yang-type": "yang:timestamp", "readOnly": true }, "csubJobFinishedTime": { "type": "string", "description": "This object indicates the value of sysUpTime when the system\n finished executing the subscriber session job, for whatever\n reason. This value will be '0' when the corresponding instance\n of csubJobState is 'idle', 'pending', or 'inProgress'.", "x-yang-type": "yang:timestamp", "readOnly": true }, "csubJobFinishedReason": { "type": "string", "description": "This object indicates the reason why the system finished\n executing the subscriber session job:\n \n 'invalid'\n Indicates that the corresponding instance of\n csubJobState is either 'idle', 'pending', or\n 'inProgress'.\n \n 'other'\n Indicates that the system finished executing the\n subscriber session job abnormally for a reason not\n recognized by this MIB module.\n \n 'normal'\n Indicates that the system finished executing the\n subscriber session job with no problems.\n \n 'aborted'\n Indicates that the system finished executing the\n subscriber session job as the result of the EMS/NMS\n writing 'abort' to the corresponding instance of\n csubJobControl.\n \n 'insufficientResources'\n Indicates that the system finished executing the\n subscriber session job abnormally due to insufficient\n resources to continue.\n \n 'error'\n Indicates that the system encountered an error that\n prevented it from completing the job.", "readOnly": true } } } }, "CISCO-SUBSCRIBER-SESSION-MIB_csubJobMatchParamsEntry": { "type": "array", "description": "csubJobMatchParamsEntry", "items": { "type": "object", "properties": { "csubJobId": { "type": "string", "description": "csubJobId", "x-yang-type": "leafref", "readOnly": true }, "csubJobMatchIdentities": { "type": "string", "description": "This object specifies the subscriber identities that the\n system uses to determine the subscriber sessions the job\n executes on.\n \n Each bit in this bit string corresponds to one or more columns\n in this table. If the bit is '0', then the value of the\n corresponding columns are invalid. If the bit is '1', then the\n value of corresponding columns are valid.\n \n The following list specifies the mappings between the bits and\n the columns:\n \n 'subscriberLabel' => csubJobMatchSubscriberLabel\n 'macAddress' => csubJobMatchMacAddress\n 'nativeVrf' => csubJobMatchNativeVrf\n 'nativeIpAddress' => csubJobMatchNativeIpAddrType,\n csubJobMatchNativeIpAddr,\n csubJobMatchNativeIpMask,\n 'domainVrf' => csubJobMatchDomainVrf\n 'domainIpAddress' => csubJobMatchDomainIpAddrType,\n csubJobMatchDomainIpAddr,\n csubJobMatchDomainIpMask\n 'pbhk' => csubJobMatchPbhk\n 'remoteId' => csubJobMatchRemoteId\n 'circuitId' => csubJobMatchCircuitId\n 'nasPort' => csubJobMatchNasPort\n 'domain' => csubJobMatchDomain\n 'username' => csubJobMatchUsername\n 'acctSessionId' => csubJobMatchAcctSessionId\n 'dnis' => csubJobMatchDnis\n 'media' => csubJobMatchMedia\n 'mlpNegotiated' => csubJobMatchMlpNegotiated\n 'protocol' => csubJobMatchProtocol\n 'serviceName' => csubJobMatchServiceName\n 'dhcpClass' => csubJobMatchDhcpClass\n 'tunnelName' => csubJobMatchTunnelName\n \n Observe that the bit 'ifIndex' has no meaning, as subscriber\n session jobs do not match against this subscriber session\n identity.", "x-yang-type": "cisco-subscriber-identity:SubSessionIdentities", "readOnly": true }, "csubJobMatchOtherParams": { "type": "string", "description": "This object specifies other parameters relating to subscriber\n sessions a subscriber session job may match against.\n \n Each bit in this bit string corresponds to a column in this\n table. If the bit is '0', then the value of the corresponding\n column is invalid. If the bit is '1', then the value of the\n corresponding column represents the value of the parameter\n identity the system should match against for the corresponding\n subscriber session job.\n \n The following list specifies the mappings between bits and the\n columns:\n \n 'danglingDuration' => csubJobMatchDanglingDuration\n 'state' => csubJobMatchState\n 'authenticated' => csubJobMatchAuthenticated\n 'redundancyMode' => csubJobMatchRedundancyMode", "readOnly": true }, "csubJobMatchSubscriberLabel": { "type": "string", "description": "This object specifies the subscriber label that the system\n matches against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'subscriberLabel' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberLabel", "readOnly": true }, "csubJobMatchMacAddress": { "type": "string", "description": "This object specifies the MAC address that the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'macAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "yang:mac-address", "readOnly": true }, "csubJobMatchNativeVrf": { "type": "string", "description": "This object specifies the native VRF the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'nativeVrf' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberVRF", "readOnly": true }, "csubJobMatchNativeIpAddrType": { "type": "string", "description": "This object specifies the type of Internet address specified\n by csubJobMatchNativeIpAddr and csubJobMatchNativeIpMask.\n \n This value is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "csubJobMatchNativeIpAddr": { "type": "string", "description": "This object specifies the native IP address that the system\n matches against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "csubJobMatchNativeIpMask": { "type": "string", "description": "This object specifies the mask used when matching the native IP\n address against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'nativeIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "csubJobMatchDomainVrf": { "type": "string", "description": "This object specifies the domain VRF the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'domainVrf' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberVRF", "readOnly": true }, "csubJobMatchDomainIpAddrType": { "type": "string", "description": "This object specifies the type of Internet address specified\n by csubJobMatchDomainIpAddr and csubJobMatchDomainIpMask.\n \n This value is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "csubJobMatchDomainIpAddr": { "type": "string", "description": "This object specifies the domain IP address that the system\n matches against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "csubJobMatchDomainIpMask": { "type": "string", "description": "This object specifies the mask used when matching the domain IP\n address against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'domainIpAddress' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "csubJobMatchPbhk": { "type": "string", "description": "This object specifies the PBHK that the system matches against\n subscriber sessions in the process of executing a subscriber\n session job.\n \n This value is valid only if the 'pbhk' bit of the corresponding\n instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberPbhk", "readOnly": true }, "csubJobMatchRemoteId": { "type": "string", "description": "This object specifies the Remote-Id the system matches against\n subscriber sessions in the process of executing a subscriber\n session job.\n \n This value is valid only if the 'remoteId' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberRemoteId", "readOnly": true }, "csubJobMatchCircuitId": { "type": "string", "description": "This object specifies the Circuit-Id the system matches against\n subscriber sessions in the process of executing a subscriber\n session job.\n \n This value is valid only if the 'circuitId' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberCircuitId", "readOnly": true }, "csubJobMatchNasPort": { "type": "string", "description": "This object specifies the NAS port-identifier the system\n matches against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'nasPort' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberNasPort", "readOnly": true }, "csubJobMatchDomain": { "type": "string", "description": "This object specifies the domain the system matches against\n subscriber sessions in the process of executing a subscriber\n session job.\n \n This value is valid only if the 'domain' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDomain", "readOnly": true }, "csubJobMatchUsername": { "type": "string", "description": "This object specifies the username the system matches against\n subscriber sessions in the process of executing a subscriber\n session job.\n \n This value is valid only if the 'username' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberUsername", "readOnly": true }, "csubJobMatchAcctSessionId": { "type": "string", "description": "This object specifies the accounting session identifier the\n system matches against subscriber sessions in the process of\n executing a subscriber session job.\n \n This value is valid only if the 'accountingSid' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberAcctSessionId", "readOnly": true }, "csubJobMatchDnis": { "type": "string", "description": "This object specifies the DNIS number the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'dnis' bit of the corresponding\n instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDnis", "readOnly": true }, "csubJobMatchMedia": { "type": "string", "description": "This object specifies the media type the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'media' bit of the corresponding\n instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberMediaType", "readOnly": true }, "csubJobMatchMlpNegotiated": { "type": "boolean", "description": "This object specifies the MLP negotiated flag the system\n matches against subscriber sessions in the process of executing\n a subscriber session job.\n \n This value is valid only if the 'mlpNegotiated' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "readOnly": true }, "csubJobMatchProtocol": { "type": "string", "description": "This object specifies the protocol type the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'protocol' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberProtocolType", "readOnly": true }, "csubJobMatchServiceName": { "type": "string", "description": "This object specifies the service name the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'serviceName' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-cbp:CbpElementName", "readOnly": true }, "csubJobMatchDhcpClass": { "type": "string", "description": "This object specifies the DHCP class name the system matches\n against subscriber sessions in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'dhcpClass' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberDhcpClass", "readOnly": true }, "csubJobMatchTunnelName": { "type": "string", "description": "This object specifies the tunnel name the system matches\n against subscriber session in the process of executing a\n subscriber session job.\n \n This value is valid only if the 'tunnelName' bit of the\n corresponding instance of csubJobMatchIdentities is '1'.", "x-yang-type": "cisco-subscriber-identity:SubscriberTunnelName", "readOnly": true }, "csubJobMatchDanglingDuration": { "type": "integer", "description": "This object specifies the minimum interval of time a subscriber\n session can remain dangling in order for the system to consider\n it a match in the process of executing a subscriber session job.\n A 'dangling' subscriber session is one in the PENDING state.\n \n The value '0' cannot be written to an instance of this object.\n However, it serves as a convenient value when the column is not\n valid.\n \n This value is valid only if the 'danglingDuration' bit of the\n corresponding instance of csubJobMatchOtherParams is '1'.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubJobMatchState": { "type": "string", "description": "This object specifies the state of a subscriber session in\n order for the system to consider a match in the process of\n executing a subscriber session job.\n \n The value 'other' is not valid and an implementation should\n not allow it to be written to this column.\n \n This value is valid only if the 'state' bit of the\n corresponding instance of csubJobMatchOtherParams is '1'.", "x-yang-type": "cisco-subscriber:SubSessionState", "readOnly": true }, "csubJobMatchAuthenticated": { "type": "boolean", "description": "This object specifies whether a subscriber session should be\n unauthenticated for the system to consider a match in the\n process of executing a subscriber session job.\n \n If this column is 'false', then the subscriber session job\n matches subscriber sessions that are unauthenticated.\n \n If this column is 'true', then the subscriber session job\n matches subscriber session that are authenticated.\n \n This value is valid only if the 'authenticated' bit of the\n corresponding instance of csubJobMatchParams is '1'.", "readOnly": true }, "csubJobMatchRedundancyMode": { "type": "string", "description": "This object specifies the redudancy mode of the subscriber\n session in order for the system to consider a match in the\n process of executing a subscriber session job.\n \n The value 'other' is not valid and an implementation should not\n allow it to be written to this column.\n \n This value is valid only if the 'redundancyMode' bit of the\n corresponding instance of csubJobMatchOtherParams is '1'.", "x-yang-type": "cisco-subscriber:SubSessionRedundancyMode", "readOnly": true } } } }, "CISCO-SUBSCRIBER-SESSION-MIB_csubJobQueryParamsEntry": { "type": "array", "description": "csubJobQueryParamsEntry", "items": { "type": "object", "properties": { "csubJobId": { "type": "string", "description": "csubJobId", "x-yang-type": "leafref", "readOnly": true }, "csubJobQuerySortKey1": { "type": "string", "description": "This object specifies the first subscriber identity that the\n system uses when sorting subscriber sessions into the final\n report corresponding to a subscriber session query.\n \n It is not valid to set this column to 'other' or 'ifIndex'.", "x-yang-type": "cisco-subscriber-identity:SubSessionIdentity", "readOnly": true }, "csubJobQuerySortKey2": { "type": "string", "description": "This object specifies the second subscriber identity that the\n system uses when sorting subscriber sessions into the final\n report corresponding to a subscriber session query.\n \n If it is the desire to have the final report sorted on a single\n subscriber identity, then this column should be 'other'.", "x-yang-type": "cisco-subscriber-identity:SubSessionIdentity", "readOnly": true }, "csubJobQuerySortKey3": { "type": "string", "description": "This object specifies the third subscriber identity that the\n system uses when sorting subscriber sessions into the final\n report corresponding to a subscriber session query.\n \n If it is the desire to have the final report sorted on one or\n two subscriber identities, then this column should be 'other'.", "x-yang-type": "cisco-subscriber-identity:SubSessionIdentity", "readOnly": true }, "csubJobQueryResultingReportSize": { "type": "integer", "description": "This object indicates the number of subscriber sessions that\n matched the corresponding subscriber session query.\n \n The value of this column should be '0' unless the corresponding\n value of csubJobState is 'finished'.\n \n The value of this column should be '0' after the EMS/NMS sets\n the corresponding csubJobControl to 'release'.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } } }, "CISCO-SUBSCRIBER-SESSION-MIB_csubJobQueueEntry": { "type": "array", "description": "csubJobQueueEntry", "items": { "type": "object", "properties": { "csubJobQueueNumber": { "type": "integer", "description": "This object indicates an positive, integer-value that uniquely\n identifies the entry in the table. The value of this object\n starts at '1' and monotonically increases for each subscriber\n session job inserted into the subscriber session job queue. If\n the value of this object is '4294967295', the system will reset\n it to '1' when it inserts the next subscriber session job into\n the subscriber session job queue.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubJobQueueJobId": { "type": "string", "description": "This object indicates the identifier associated with the\n subscriber session job.", "x-yang-type": "CISCO-SUBSCRIBER-SESSION-MIB:SubscriberJobIdentifier", "readOnly": true } } } }, "CISCO-SUBSCRIBER-SESSION-MIB_csubJobReportEntry": { "type": "array", "description": "csubJobReportEntry", "items": { "type": "object", "properties": { "csubJobId": { "type": "string", "description": "csubJobId", "x-yang-type": "leafref", "readOnly": true }, "csubJobReportId": { "type": "integer", "description": "This object indicates an arbitrary, positive, integer-value\n that uniquely identifies this entry in a report. This auxiliary\n value is necessary, as the corresponding subscriber session job\n can specify up to three subscriber identities on which to sort\n the subscriber sessions that end up in the final report.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "csubJobReportSession": { "type": "string", "description": "This object indicates the ifIndex-value assigned to the\n subscriber session that satisfied the match criteria specified\n by the corresponding subscriber session job having a csubJobType\n of 'query'.", "x-yang-type": "if-mib:InterfaceIndex", "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-SUBSCRIBER-SESSION-MIB", "description": "MIB operations for CISCO-SUBSCRIBER-SESSION-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }