{ "openapi": "3.0.0", "info": { "title": "CISCO-CBP-TARGET-MIB MIB API", "version": "1.0.0", "description": "This MIB module defines the managed objects for\n representing targets which have class-based policy \n mappings. A target can be any logical interface \n to which a class-based policy is able to be associated.\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-CBP-TARGET-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/CISCO-CBP-TARGET-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "CISCO-CBP-TARGET-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-CBP-TARGET-MIB:ccbptTargetAttachCfg": { "get": { "summary": "Get ccbptTargetAttachCfg data", "description": "Retrieve ccbptTargetAttachCfg operational data from MIB", "tags": [ "CISCO-CBP-TARGET-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This object indicates the next available value of \n ccbptPolicyId that can be used to create a new conceptual\n row in the ccbptTargetTable. If no available identifier\n exists, then this object will have the value '0'.", "properties": { "ccbptPolicyIdNext": { "type": "string", "description": "This object indicates the next available value of \n ccbptPolicyId that can be used to create a new conceptual\n row in the ccbptTargetTable. If no available identifier\n exists, then this object will have the value '0'.", "x-yang-type": "cisco-cbp:CcbptPolicyIdentifierOrZero" }, "ccbptTargetTableLastChange": { "type": "string", "description": "The value of sysUpTime at the time of the last\n change to an entry in the ccbptTargetTable.", "x-yang-type": "yang:timestamp" } } }, "example": { "CISCO-CBP-TARGET-MIB:ccbptTargetAttachCfg": { "ccbptPolicyIdNext": "example-string", "ccbptTargetTableLastChange": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ccbptTargetAttachCfg", "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": "/ccbptTargetAttachCfg", "x-restconf-kind": "container" }, "/data/CISCO-CBP-TARGET-MIB:ccbptTargetTable": { "get": { "summary": "Get ccbptTargetTable data", "description": "Retrieve ccbptTargetTable operational data from MIB", "tags": [ "CISCO-CBP-TARGET-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table describes the class-based policy attachments to\n to specific targets.", "properties": { "ccbptTargetEntry": { "type": "array", "description": "ccbptTargetEntry", "items": { "type": "object", "properties": { "ccbptTargetType": { "type": "string", "description": "The type of target for this class-based policy attachment.\n This object identifies the format of the ccbptTargetId for\n this entry.", "x-yang-type": "cisco-cbp:CcbptTargetType" }, "ccbptTargetId": { "type": "string", "description": "The target identifier for this class-based policy attachment.\n For decoding the ccbptTargetId refer to the ccbptTargetType\n object and the CcbptTargetType description.", "x-yang-type": "cisco-cbp:CcbptTargetId" }, "ccbptTargetDir": { "type": "string", "description": "The direction relative to the ccbptTargetId for this class\n based policy attachment.", "x-yang-type": "cisco-cbp:CcbptTargetDirection" }, "ccbptPolicySourceType": { "type": "string", "description": "The source-type of the class-based policy for this target.\n The source-type refers to the source of the class-based\n policy definition. The intent of this object is to allow\n implementations to distinguish between different MIBs\n defining policy-maps.", "x-yang-type": "cisco-cbp:CcbptPolicySourceType" }, "ccbptPolicyId": { "type": "string", "description": "Unique identifier of this class-based policy instance.", "x-yang-type": "cisco-cbp:CcbptPolicyIdentifier" }, "ccbptTargetStatus": { "type": "string", "description": "The status of the policy attachment to this target. The\n value for the corresponding instance of each of the \n following objects must be valid before the attachment \n can be activated:\n -ccbptTargetStorageType\n -ccbptPolicyMap\n \n Observe that no corresponding instance of any object in \n this table can be modified when the value of this object is\n 'active'.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ccbptTargetStorageType": { "type": "string", "description": "This object indicates how the device stores the data \n contained by the conceptual row.\n \n If an instance of this object has the value 'permanent',\n then this MIB definition does not require the SNMP entity\n to allow the instance of any object in the corresponding\n conceptual row to be writable through the SNMP.", "x-yang-type": "snmpv2-tc:StorageType" }, "ccbptPolicyMap": { "type": "string", "description": "Refers to the first accessible object in the policy-map\n definition table used to manage policy-map information\n for policy-maps for the corresponding ccbptPolicySourceType.\n \n Specific MIB tables are not mentioned here as the intent of\n this mapping is to allow for different implementations to \n refer to their supported class-based policy definition table\n without requiring support of a specific MIB module.", "x-yang-type": "snmpv2-tc:RowPointer" }, "ccbptPolicyInstance": { "type": "string", "description": "Refers to the first accessible object in the policy \n instance table used to manage policy instance information \n for policy-maps of this ccbptPolicySourceType.\n \n Specific MIB tables are not mentioned here as the intent of\n this mapping is to allow for different implementations to \n refer to their supported class-based policy definition table\n without requiring support of a specific MIB module.", "x-yang-type": "snmpv2-tc:RowPointer" }, "ccbptPolicyAttachTime": { "type": "string", "description": "The value of sysUpTime for the last time that the corresponding\n ccbptTargetStatus instance transitioned to the 'active' state.", "x-yang-type": "yang:timestamp" } } } } } }, "example": { "CISCO-CBP-TARGET-MIB:ccbptTargetTable": { "ccbptTargetEntry": [ { "ccbptTargetType": "ethernetCsmacd(6)", "ccbptTargetId": "example-string", "ccbptTargetDir": "example-string", "ccbptPolicySourceType": "ethernetCsmacd(6)", "ccbptPolicyId": "example-string", "ccbptTargetStatus": "up(1)", "ccbptTargetStorageType": "ethernetCsmacd(6)", "ccbptPolicyMap": "example-string", "ccbptPolicyInstance": "example-string", "ccbptPolicyAttachTime": "example-string" }, { "ccbptTargetType": "ethernetCsmacd(6)", "ccbptTargetId": "example-string", "ccbptTargetDir": "example-string", "ccbptPolicySourceType": "ethernetCsmacd(6)", "ccbptPolicyId": "example-string", "ccbptTargetStatus": "up(1)", "ccbptTargetStorageType": "ethernetCsmacd(6)", "ccbptPolicyMap": "example-string", "ccbptPolicyInstance": "example-string", "ccbptPolicyAttachTime": "example-string" }, { "ccbptTargetType": "ethernetCsmacd(6)", "ccbptTargetId": "example-string", "ccbptTargetDir": "example-string", "ccbptPolicySourceType": "ethernetCsmacd(6)", "ccbptPolicyId": "example-string", "ccbptTargetStatus": "up(1)", "ccbptTargetStorageType": "ethernetCsmacd(6)", "ccbptPolicyMap": "example-string", "ccbptPolicyInstance": "example-string", "ccbptPolicyAttachTime": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ccbptTargetTable", "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": "/ccbptTargetTable", "x-restconf-kind": "container" }, "/data/CISCO-CBP-TARGET-MIB:ccbptTargetTable/ccbptTargetEntry": { "get": { "summary": "Get ccbptTargetEntry list", "description": "Retrieve list of ccbptTargetEntry entries from MIB", "tags": [ "CISCO-CBP-TARGET-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "ccbptTargetEntry", "items": { "type": "object", "properties": { "ccbptTargetType": { "type": "string", "description": "The type of target for this class-based policy attachment.\n This object identifies the format of the ccbptTargetId for\n this entry.", "x-yang-type": "cisco-cbp:CcbptTargetType" }, "ccbptTargetId": { "type": "string", "description": "The target identifier for this class-based policy attachment.\n For decoding the ccbptTargetId refer to the ccbptTargetType\n object and the CcbptTargetType description.", "x-yang-type": "cisco-cbp:CcbptTargetId" }, "ccbptTargetDir": { "type": "string", "description": "The direction relative to the ccbptTargetId for this class\n based policy attachment.", "x-yang-type": "cisco-cbp:CcbptTargetDirection" }, "ccbptPolicySourceType": { "type": "string", "description": "The source-type of the class-based policy for this target.\n The source-type refers to the source of the class-based\n policy definition. The intent of this object is to allow\n implementations to distinguish between different MIBs\n defining policy-maps.", "x-yang-type": "cisco-cbp:CcbptPolicySourceType" }, "ccbptPolicyId": { "type": "string", "description": "Unique identifier of this class-based policy instance.", "x-yang-type": "cisco-cbp:CcbptPolicyIdentifier" }, "ccbptTargetStatus": { "type": "string", "description": "The status of the policy attachment to this target. The\n value for the corresponding instance of each of the \n following objects must be valid before the attachment \n can be activated:\n -ccbptTargetStorageType\n -ccbptPolicyMap\n \n Observe that no corresponding instance of any object in \n this table can be modified when the value of this object is\n 'active'.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ccbptTargetStorageType": { "type": "string", "description": "This object indicates how the device stores the data \n contained by the conceptual row.\n \n If an instance of this object has the value 'permanent',\n then this MIB definition does not require the SNMP entity\n to allow the instance of any object in the corresponding\n conceptual row to be writable through the SNMP.", "x-yang-type": "snmpv2-tc:StorageType" }, "ccbptPolicyMap": { "type": "string", "description": "Refers to the first accessible object in the policy-map\n definition table used to manage policy-map information\n for policy-maps for the corresponding ccbptPolicySourceType.\n \n Specific MIB tables are not mentioned here as the intent of\n this mapping is to allow for different implementations to \n refer to their supported class-based policy definition table\n without requiring support of a specific MIB module.", "x-yang-type": "snmpv2-tc:RowPointer" }, "ccbptPolicyInstance": { "type": "string", "description": "Refers to the first accessible object in the policy \n instance table used to manage policy instance information \n for policy-maps of this ccbptPolicySourceType.\n \n Specific MIB tables are not mentioned here as the intent of\n this mapping is to allow for different implementations to \n refer to their supported class-based policy definition table\n without requiring support of a specific MIB module.", "x-yang-type": "snmpv2-tc:RowPointer" }, "ccbptPolicyAttachTime": { "type": "string", "description": "The value of sysUpTime for the last time that the corresponding\n ccbptTargetStatus instance transitioned to the 'active' state.", "x-yang-type": "yang:timestamp" } } } }, "example": { "CISCO-CBP-TARGET-MIB:ccbptTargetEntry": [ { "ccbptTargetType": "ethernetCsmacd(6)", "ccbptTargetId": "example-string", "ccbptTargetDir": "example-string", "ccbptPolicySourceType": "ethernetCsmacd(6)", "ccbptPolicyId": "example-string", "ccbptTargetStatus": "up(1)", "ccbptTargetStorageType": "ethernetCsmacd(6)", "ccbptPolicyMap": "example-string", "ccbptPolicyInstance": "example-string", "ccbptPolicyAttachTime": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ccbptTargetEntry", "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": "/ccbptTargetTable/ccbptTargetEntry", "x-restconf-kind": "container" }, "/data/CISCO-CBP-TARGET-MIB:ccbptTargetEntry": { "get": { "summary": "Get ccbptTargetEntry list", "description": "Retrieve list of ccbptTargetEntry entries from MIB", "tags": [ "CISCO-CBP-TARGET-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "ccbptTargetEntry", "items": { "type": "object", "properties": { "ccbptTargetType": { "type": "string", "description": "The type of target for this class-based policy attachment.\n This object identifies the format of the ccbptTargetId for\n this entry.", "x-yang-type": "cisco-cbp:CcbptTargetType" }, "ccbptTargetId": { "type": "string", "description": "The target identifier for this class-based policy attachment.\n For decoding the ccbptTargetId refer to the ccbptTargetType\n object and the CcbptTargetType description.", "x-yang-type": "cisco-cbp:CcbptTargetId" }, "ccbptTargetDir": { "type": "string", "description": "The direction relative to the ccbptTargetId for this class\n based policy attachment.", "x-yang-type": "cisco-cbp:CcbptTargetDirection" }, "ccbptPolicySourceType": { "type": "string", "description": "The source-type of the class-based policy for this target.\n The source-type refers to the source of the class-based\n policy definition. The intent of this object is to allow\n implementations to distinguish between different MIBs\n defining policy-maps.", "x-yang-type": "cisco-cbp:CcbptPolicySourceType" }, "ccbptPolicyId": { "type": "string", "description": "Unique identifier of this class-based policy instance.", "x-yang-type": "cisco-cbp:CcbptPolicyIdentifier" }, "ccbptTargetStatus": { "type": "string", "description": "The status of the policy attachment to this target. The\n value for the corresponding instance of each of the \n following objects must be valid before the attachment \n can be activated:\n -ccbptTargetStorageType\n -ccbptPolicyMap\n \n Observe that no corresponding instance of any object in \n this table can be modified when the value of this object is\n 'active'.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ccbptTargetStorageType": { "type": "string", "description": "This object indicates how the device stores the data \n contained by the conceptual row.\n \n If an instance of this object has the value 'permanent',\n then this MIB definition does not require the SNMP entity\n to allow the instance of any object in the corresponding\n conceptual row to be writable through the SNMP.", "x-yang-type": "snmpv2-tc:StorageType" }, "ccbptPolicyMap": { "type": "string", "description": "Refers to the first accessible object in the policy-map\n definition table used to manage policy-map information\n for policy-maps for the corresponding ccbptPolicySourceType.\n \n Specific MIB tables are not mentioned here as the intent of\n this mapping is to allow for different implementations to \n refer to their supported class-based policy definition table\n without requiring support of a specific MIB module.", "x-yang-type": "snmpv2-tc:RowPointer" }, "ccbptPolicyInstance": { "type": "string", "description": "Refers to the first accessible object in the policy \n instance table used to manage policy instance information \n for policy-maps of this ccbptPolicySourceType.\n \n Specific MIB tables are not mentioned here as the intent of\n this mapping is to allow for different implementations to \n refer to their supported class-based policy definition table\n without requiring support of a specific MIB module.", "x-yang-type": "snmpv2-tc:RowPointer" }, "ccbptPolicyAttachTime": { "type": "string", "description": "The value of sysUpTime for the last time that the corresponding\n ccbptTargetStatus instance transitioned to the 'active' state.", "x-yang-type": "yang:timestamp" } } } }, "example": { "CISCO-CBP-TARGET-MIB:ccbptTargetEntry": [ { "ccbptTargetType": "ethernetCsmacd(6)", "ccbptTargetId": "example-string", "ccbptTargetDir": "example-string", "ccbptPolicySourceType": "ethernetCsmacd(6)", "ccbptPolicyId": "example-string", "ccbptTargetStatus": "up(1)", "ccbptTargetStorageType": "ethernetCsmacd(6)", "ccbptPolicyMap": "example-string", "ccbptPolicyInstance": "example-string", "ccbptPolicyAttachTime": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ccbptTargetEntry-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": "/ccbptTargetEntry", "x-restconf-kind": "container" }, "/data/CISCO-CBP-TARGET-MIB:ccbptTargetTable/ccbptTargetEntry={ccbptTargetType},{ccbptTargetId},{ccbptTargetDir},{ccbptPolicySourceType},{ccbptPolicyId}": { "get": { "summary": "Get ccbptTargetEntry entry", "description": "Retrieve specific ccbptTargetEntry entry by key from MIB", "tags": [ "CISCO-CBP-TARGET-MIB" ], "parameters": [ { "name": "ccbptTargetType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ccbptTargetId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ccbptTargetDir", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ccbptPolicySourceType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ccbptPolicyId", "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": { "ccbptTargetType": { "type": "string", "description": "The type of target for this class-based policy attachment.\n This object identifies the format of the ccbptTargetId for\n this entry.", "x-yang-type": "cisco-cbp:CcbptTargetType" }, "ccbptTargetId": { "type": "string", "description": "The target identifier for this class-based policy attachment.\n For decoding the ccbptTargetId refer to the ccbptTargetType\n object and the CcbptTargetType description.", "x-yang-type": "cisco-cbp:CcbptTargetId" }, "ccbptTargetDir": { "type": "string", "description": "The direction relative to the ccbptTargetId for this class\n based policy attachment.", "x-yang-type": "cisco-cbp:CcbptTargetDirection" }, "ccbptPolicySourceType": { "type": "string", "description": "The source-type of the class-based policy for this target.\n The source-type refers to the source of the class-based\n policy definition. The intent of this object is to allow\n implementations to distinguish between different MIBs\n defining policy-maps.", "x-yang-type": "cisco-cbp:CcbptPolicySourceType" }, "ccbptPolicyId": { "type": "string", "description": "Unique identifier of this class-based policy instance.", "x-yang-type": "cisco-cbp:CcbptPolicyIdentifier" }, "ccbptTargetStatus": { "type": "string", "description": "The status of the policy attachment to this target. The\n value for the corresponding instance of each of the \n following objects must be valid before the attachment \n can be activated:\n -ccbptTargetStorageType\n -ccbptPolicyMap\n \n Observe that no corresponding instance of any object in \n this table can be modified when the value of this object is\n 'active'.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ccbptTargetStorageType": { "type": "string", "description": "This object indicates how the device stores the data \n contained by the conceptual row.\n \n If an instance of this object has the value 'permanent',\n then this MIB definition does not require the SNMP entity\n to allow the instance of any object in the corresponding\n conceptual row to be writable through the SNMP.", "x-yang-type": "snmpv2-tc:StorageType" }, "ccbptPolicyMap": { "type": "string", "description": "Refers to the first accessible object in the policy-map\n definition table used to manage policy-map information\n for policy-maps for the corresponding ccbptPolicySourceType.\n \n Specific MIB tables are not mentioned here as the intent of\n this mapping is to allow for different implementations to \n refer to their supported class-based policy definition table\n without requiring support of a specific MIB module.", "x-yang-type": "snmpv2-tc:RowPointer" }, "ccbptPolicyInstance": { "type": "string", "description": "Refers to the first accessible object in the policy \n instance table used to manage policy instance information \n for policy-maps of this ccbptPolicySourceType.\n \n Specific MIB tables are not mentioned here as the intent of\n this mapping is to allow for different implementations to \n refer to their supported class-based policy definition table\n without requiring support of a specific MIB module.", "x-yang-type": "snmpv2-tc:RowPointer" }, "ccbptPolicyAttachTime": { "type": "string", "description": "The value of sysUpTime for the last time that the corresponding\n ccbptTargetStatus instance transitioned to the 'active' state.", "x-yang-type": "yang:timestamp" } } }, "example": { "CISCO-CBP-TARGET-MIB:ccbptTargetEntry": { "ccbptTargetType": "ethernetCsmacd(6)", "ccbptTargetId": "example-string", "ccbptTargetDir": "example-string", "ccbptPolicySourceType": "ethernetCsmacd(6)", "ccbptPolicyId": "example-string", "ccbptTargetStatus": "up(1)", "ccbptTargetStorageType": "ethernetCsmacd(6)", "ccbptPolicyMap": "example-string", "ccbptPolicyInstance": "example-string", "ccbptPolicyAttachTime": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ccbptTargetEntry-2" }, "x-yang-path": "/ccbptTargetTable/ccbptTargetEntry={ccbptTargetType ccbptTargetId ccbptTargetDir ccbptPolicySourceType ccbptPolicyId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ccbptTargetType ccbptTargetId ccbptTargetDir ccbptPolicySourceType ccbptPolicyId" ] }, "/data/CISCO-CBP-TARGET-MIB:ccbptTargetEntry={ccbptTargetType},{ccbptTargetId},{ccbptTargetDir},{ccbptPolicySourceType},{ccbptPolicyId}": { "get": { "summary": "Get ccbptTargetEntry entry", "description": "Retrieve specific ccbptTargetEntry entry by key from MIB", "tags": [ "CISCO-CBP-TARGET-MIB" ], "parameters": [ { "name": "ccbptTargetType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ccbptTargetId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ccbptTargetDir", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ccbptPolicySourceType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ccbptPolicyId", "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": { "ccbptTargetType": { "type": "string", "description": "The type of target for this class-based policy attachment.\n This object identifies the format of the ccbptTargetId for\n this entry.", "x-yang-type": "cisco-cbp:CcbptTargetType" }, "ccbptTargetId": { "type": "string", "description": "The target identifier for this class-based policy attachment.\n For decoding the ccbptTargetId refer to the ccbptTargetType\n object and the CcbptTargetType description.", "x-yang-type": "cisco-cbp:CcbptTargetId" }, "ccbptTargetDir": { "type": "string", "description": "The direction relative to the ccbptTargetId for this class\n based policy attachment.", "x-yang-type": "cisco-cbp:CcbptTargetDirection" }, "ccbptPolicySourceType": { "type": "string", "description": "The source-type of the class-based policy for this target.\n The source-type refers to the source of the class-based\n policy definition. The intent of this object is to allow\n implementations to distinguish between different MIBs\n defining policy-maps.", "x-yang-type": "cisco-cbp:CcbptPolicySourceType" }, "ccbptPolicyId": { "type": "string", "description": "Unique identifier of this class-based policy instance.", "x-yang-type": "cisco-cbp:CcbptPolicyIdentifier" }, "ccbptTargetStatus": { "type": "string", "description": "The status of the policy attachment to this target. The\n value for the corresponding instance of each of the \n following objects must be valid before the attachment \n can be activated:\n -ccbptTargetStorageType\n -ccbptPolicyMap\n \n Observe that no corresponding instance of any object in \n this table can be modified when the value of this object is\n 'active'.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ccbptTargetStorageType": { "type": "string", "description": "This object indicates how the device stores the data \n contained by the conceptual row.\n \n If an instance of this object has the value 'permanent',\n then this MIB definition does not require the SNMP entity\n to allow the instance of any object in the corresponding\n conceptual row to be writable through the SNMP.", "x-yang-type": "snmpv2-tc:StorageType" }, "ccbptPolicyMap": { "type": "string", "description": "Refers to the first accessible object in the policy-map\n definition table used to manage policy-map information\n for policy-maps for the corresponding ccbptPolicySourceType.\n \n Specific MIB tables are not mentioned here as the intent of\n this mapping is to allow for different implementations to \n refer to their supported class-based policy definition table\n without requiring support of a specific MIB module.", "x-yang-type": "snmpv2-tc:RowPointer" }, "ccbptPolicyInstance": { "type": "string", "description": "Refers to the first accessible object in the policy \n instance table used to manage policy instance information \n for policy-maps of this ccbptPolicySourceType.\n \n Specific MIB tables are not mentioned here as the intent of\n this mapping is to allow for different implementations to \n refer to their supported class-based policy definition table\n without requiring support of a specific MIB module.", "x-yang-type": "snmpv2-tc:RowPointer" }, "ccbptPolicyAttachTime": { "type": "string", "description": "The value of sysUpTime for the last time that the corresponding\n ccbptTargetStatus instance transitioned to the 'active' state.", "x-yang-type": "yang:timestamp" } } }, "example": { "CISCO-CBP-TARGET-MIB:ccbptTargetEntry": { "ccbptTargetType": "ethernetCsmacd(6)", "ccbptTargetId": "example-string", "ccbptTargetDir": "example-string", "ccbptPolicySourceType": "ethernetCsmacd(6)", "ccbptPolicyId": "example-string", "ccbptTargetStatus": "up(1)", "ccbptTargetStorageType": "ethernetCsmacd(6)", "ccbptPolicyMap": "example-string", "ccbptPolicyInstance": "example-string", "ccbptPolicyAttachTime": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ccbptTargetEntry-4" }, "x-yang-path": "/ccbptTargetEntry={ccbptTargetType ccbptTargetId ccbptTargetDir ccbptPolicySourceType ccbptPolicyId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ccbptTargetType ccbptTargetId ccbptTargetDir ccbptPolicySourceType ccbptPolicyId" ] } }, "components": { "schemas": { "CISCO-CBP-TARGET-MIB_CISCO-CBP-TARGET-MIB": { "type": "object", "description": "This object indicates the next available value of \n ccbptPolicyId that can be used to create a new conceptual\n row in the ccbptTargetTable. If no available identifier\n exists, then this object will have the value '0'.", "properties": { "ccbptTargetEntry": { "type": "array", "description": "ccbptTargetEntry", "items": { "type": "object", "properties": { "ccbptTargetType": { "type": "string", "description": "The type of target for this class-based policy attachment.\n This object identifies the format of the ccbptTargetId for\n this entry.", "x-yang-type": "cisco-cbp:CcbptTargetType", "readOnly": true }, "ccbptTargetId": { "type": "string", "description": "The target identifier for this class-based policy attachment.\n For decoding the ccbptTargetId refer to the ccbptTargetType\n object and the CcbptTargetType description.", "x-yang-type": "cisco-cbp:CcbptTargetId", "readOnly": true }, "ccbptTargetDir": { "type": "string", "description": "The direction relative to the ccbptTargetId for this class\n based policy attachment.", "x-yang-type": "cisco-cbp:CcbptTargetDirection", "readOnly": true }, "ccbptPolicySourceType": { "type": "string", "description": "The source-type of the class-based policy for this target.\n The source-type refers to the source of the class-based\n policy definition. The intent of this object is to allow\n implementations to distinguish between different MIBs\n defining policy-maps.", "x-yang-type": "cisco-cbp:CcbptPolicySourceType", "readOnly": true }, "ccbptPolicyId": { "type": "string", "description": "Unique identifier of this class-based policy instance.", "x-yang-type": "cisco-cbp:CcbptPolicyIdentifier", "readOnly": true }, "ccbptTargetStatus": { "type": "string", "description": "The status of the policy attachment to this target. The\n value for the corresponding instance of each of the \n following objects must be valid before the attachment \n can be activated:\n -ccbptTargetStorageType\n -ccbptPolicyMap\n \n Observe that no corresponding instance of any object in \n this table can be modified when the value of this object is\n 'active'.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "ccbptTargetStorageType": { "type": "string", "description": "This object indicates how the device stores the data \n contained by the conceptual row.\n \n If an instance of this object has the value 'permanent',\n then this MIB definition does not require the SNMP entity\n to allow the instance of any object in the corresponding\n conceptual row to be writable through the SNMP.", "x-yang-type": "snmpv2-tc:StorageType", "readOnly": true }, "ccbptPolicyMap": { "type": "string", "description": "Refers to the first accessible object in the policy-map\n definition table used to manage policy-map information\n for policy-maps for the corresponding ccbptPolicySourceType.\n \n Specific MIB tables are not mentioned here as the intent of\n this mapping is to allow for different implementations to \n refer to their supported class-based policy definition table\n without requiring support of a specific MIB module.", "x-yang-type": "snmpv2-tc:RowPointer", "readOnly": true }, "ccbptPolicyInstance": { "type": "string", "description": "Refers to the first accessible object in the policy \n instance table used to manage policy instance information \n for policy-maps of this ccbptPolicySourceType.\n \n Specific MIB tables are not mentioned here as the intent of\n this mapping is to allow for different implementations to \n refer to their supported class-based policy definition table\n without requiring support of a specific MIB module.", "x-yang-type": "snmpv2-tc:RowPointer", "readOnly": true }, "ccbptPolicyAttachTime": { "type": "string", "description": "The value of sysUpTime for the last time that the corresponding\n ccbptTargetStatus instance transitioned to the 'active' state.", "x-yang-type": "yang:timestamp", "readOnly": true } } }, "readOnly": true }, "ccbptTargetAttachCfg": { "type": "object", "description": "This object indicates the next available value of \n ccbptPolicyId that can be used to create a new conceptual\n row in the ccbptTargetTable. If no available identifier\n exists, then this object will have the value '0'.", "properties": { "ccbptPolicyIdNext": { "type": "string", "description": "This object indicates the next available value of \n ccbptPolicyId that can be used to create a new conceptual\n row in the ccbptTargetTable. If no available identifier\n exists, then this object will have the value '0'.", "x-yang-type": "cisco-cbp:CcbptPolicyIdentifierOrZero", "readOnly": true }, "ccbptTargetTableLastChange": { "type": "string", "description": "The value of sysUpTime at the time of the last\n change to an entry in the ccbptTargetTable.", "x-yang-type": "yang:timestamp", "readOnly": true } }, "readOnly": true }, "ccbptTargetTable": { "type": "object", "description": "This table describes the class-based policy attachments to\n to specific targets.", "properties": { "ccbptTargetEntry": { "type": "array", "description": "ccbptTargetEntry", "items": { "type": "object", "properties": { "ccbptTargetType": { "type": "string", "description": "The type of target for this class-based policy attachment.\n This object identifies the format of the ccbptTargetId for\n this entry.", "x-yang-type": "cisco-cbp:CcbptTargetType", "readOnly": true }, "ccbptTargetId": { "type": "string", "description": "The target identifier for this class-based policy attachment.\n For decoding the ccbptTargetId refer to the ccbptTargetType\n object and the CcbptTargetType description.", "x-yang-type": "cisco-cbp:CcbptTargetId", "readOnly": true }, "ccbptTargetDir": { "type": "string", "description": "The direction relative to the ccbptTargetId for this class\n based policy attachment.", "x-yang-type": "cisco-cbp:CcbptTargetDirection", "readOnly": true }, "ccbptPolicySourceType": { "type": "string", "description": "The source-type of the class-based policy for this target.\n The source-type refers to the source of the class-based\n policy definition. The intent of this object is to allow\n implementations to distinguish between different MIBs\n defining policy-maps.", "x-yang-type": "cisco-cbp:CcbptPolicySourceType", "readOnly": true }, "ccbptPolicyId": { "type": "string", "description": "Unique identifier of this class-based policy instance.", "x-yang-type": "cisco-cbp:CcbptPolicyIdentifier", "readOnly": true }, "ccbptTargetStatus": { "type": "string", "description": "The status of the policy attachment to this target. The\n value for the corresponding instance of each of the \n following objects must be valid before the attachment \n can be activated:\n -ccbptTargetStorageType\n -ccbptPolicyMap\n \n Observe that no corresponding instance of any object in \n this table can be modified when the value of this object is\n 'active'.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "ccbptTargetStorageType": { "type": "string", "description": "This object indicates how the device stores the data \n contained by the conceptual row.\n \n If an instance of this object has the value 'permanent',\n then this MIB definition does not require the SNMP entity\n to allow the instance of any object in the corresponding\n conceptual row to be writable through the SNMP.", "x-yang-type": "snmpv2-tc:StorageType", "readOnly": true }, "ccbptPolicyMap": { "type": "string", "description": "Refers to the first accessible object in the policy-map\n definition table used to manage policy-map information\n for policy-maps for the corresponding ccbptPolicySourceType.\n \n Specific MIB tables are not mentioned here as the intent of\n this mapping is to allow for different implementations to \n refer to their supported class-based policy definition table\n without requiring support of a specific MIB module.", "x-yang-type": "snmpv2-tc:RowPointer", "readOnly": true }, "ccbptPolicyInstance": { "type": "string", "description": "Refers to the first accessible object in the policy \n instance table used to manage policy instance information \n for policy-maps of this ccbptPolicySourceType.\n \n Specific MIB tables are not mentioned here as the intent of\n this mapping is to allow for different implementations to \n refer to their supported class-based policy definition table\n without requiring support of a specific MIB module.", "x-yang-type": "snmpv2-tc:RowPointer", "readOnly": true }, "ccbptPolicyAttachTime": { "type": "string", "description": "The value of sysUpTime for the last time that the corresponding\n ccbptTargetStatus instance transitioned to the 'active' state.", "x-yang-type": "yang:timestamp", "readOnly": true } } }, "readOnly": true } }, "readOnly": true } } }, "CISCO-CBP-TARGET-MIB_ccbptTargetEntry": { "type": "array", "description": "ccbptTargetEntry", "items": { "type": "object", "properties": { "ccbptTargetType": { "type": "string", "description": "The type of target for this class-based policy attachment.\n This object identifies the format of the ccbptTargetId for\n this entry.", "x-yang-type": "cisco-cbp:CcbptTargetType", "readOnly": true }, "ccbptTargetId": { "type": "string", "description": "The target identifier for this class-based policy attachment.\n For decoding the ccbptTargetId refer to the ccbptTargetType\n object and the CcbptTargetType description.", "x-yang-type": "cisco-cbp:CcbptTargetId", "readOnly": true }, "ccbptTargetDir": { "type": "string", "description": "The direction relative to the ccbptTargetId for this class\n based policy attachment.", "x-yang-type": "cisco-cbp:CcbptTargetDirection", "readOnly": true }, "ccbptPolicySourceType": { "type": "string", "description": "The source-type of the class-based policy for this target.\n The source-type refers to the source of the class-based\n policy definition. The intent of this object is to allow\n implementations to distinguish between different MIBs\n defining policy-maps.", "x-yang-type": "cisco-cbp:CcbptPolicySourceType", "readOnly": true }, "ccbptPolicyId": { "type": "string", "description": "Unique identifier of this class-based policy instance.", "x-yang-type": "cisco-cbp:CcbptPolicyIdentifier", "readOnly": true }, "ccbptTargetStatus": { "type": "string", "description": "The status of the policy attachment to this target. The\n value for the corresponding instance of each of the \n following objects must be valid before the attachment \n can be activated:\n -ccbptTargetStorageType\n -ccbptPolicyMap\n \n Observe that no corresponding instance of any object in \n this table can be modified when the value of this object is\n 'active'.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "ccbptTargetStorageType": { "type": "string", "description": "This object indicates how the device stores the data \n contained by the conceptual row.\n \n If an instance of this object has the value 'permanent',\n then this MIB definition does not require the SNMP entity\n to allow the instance of any object in the corresponding\n conceptual row to be writable through the SNMP.", "x-yang-type": "snmpv2-tc:StorageType", "readOnly": true }, "ccbptPolicyMap": { "type": "string", "description": "Refers to the first accessible object in the policy-map\n definition table used to manage policy-map information\n for policy-maps for the corresponding ccbptPolicySourceType.\n \n Specific MIB tables are not mentioned here as the intent of\n this mapping is to allow for different implementations to \n refer to their supported class-based policy definition table\n without requiring support of a specific MIB module.", "x-yang-type": "snmpv2-tc:RowPointer", "readOnly": true }, "ccbptPolicyInstance": { "type": "string", "description": "Refers to the first accessible object in the policy \n instance table used to manage policy instance information \n for policy-maps of this ccbptPolicySourceType.\n \n Specific MIB tables are not mentioned here as the intent of\n this mapping is to allow for different implementations to \n refer to their supported class-based policy definition table\n without requiring support of a specific MIB module.", "x-yang-type": "snmpv2-tc:RowPointer", "readOnly": true }, "ccbptPolicyAttachTime": { "type": "string", "description": "The value of sysUpTime for the last time that the corresponding\n ccbptTargetStatus instance transitioned to the 'active' state.", "x-yang-type": "yang:timestamp", "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-CBP-TARGET-MIB", "description": "MIB operations for CISCO-CBP-TARGET-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }