{ "openapi": "3.0.0", "info": { "title": "CISCO-IGMP-FILTER-MIB MIB API", "version": "1.0.0", "description": "IGMP Filter configuration MIB. This MIB provides a\n mechanism for users to configure the system to intercept \n IGMP joins for IP Multicast groups identified in this \n MIB and only allow certain ports to join certain \n multicast groups.\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-IGMP-FILTER-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/CISCO-IGMP-FILTER-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "CISCO-IGMP-FILTER-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-IGMP-FILTER-MIB:cIgmpFilterGeneral": { "get": { "summary": "Get cIgmpFilterGeneral data", "description": "Retrieve cIgmpFilterGeneral operational data from MIB", "tags": [ "CISCO-IGMP-FILTER-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This object controls whether the IGMP filtering\n is enabled on the device. A false(2) value will \n prevent the IGMP filtering action on the device.", "properties": { "cIgmpFilterEnable": { "type": "boolean", "description": "This object controls whether the IGMP filtering\n is enabled on the device. A false(2) value will \n prevent the IGMP filtering action on the device." }, "cIgmpFilterMaxProfiles": { "type": "integer", "description": "Indicates the maximum number of profiles supported by\n this device. A value of zero indicates no limitation on\n the number of profiles.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-IGMP-FILTER-MIB:cIgmpFilterGeneral": { "cIgmpFilterEnable": true, "cIgmpFilterMaxProfiles": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cIgmpFilterGeneral", "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": "/cIgmpFilterGeneral", "x-restconf-kind": "container" }, "/data/CISCO-IGMP-FILTER-MIB:cIgmpFilterEditor": { "get": { "summary": "Get cIgmpFilterEditor data", "description": "Retrieve cIgmpFilterEditor operational data from MIB", "tags": [ "CISCO-IGMP-FILTER-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "cIgmpFilterEditor", "properties": { "cIgmpFilterEditSpinLock": { "type": "string", "description": "This object is used to facilitate modification of\n IGMP Filter Editor Group in the CISCO-IGMP-FILTER-MIB \n module by multiple managers. In particular, it is \n useful when modifying the value of the cIgmpFilterEditor \n object. \n \n The procedure for modifying the cIgmpFilterEditor \n object is as follows: \n \n 1. Retrieve the value of cIgmpFilterEditSpinLock and \n of object within cIgmpFilterEditor group. \n \n 2. Generate new values for 'writeable' objects\n in the cIgmpFilterEditor group except for \n cIgmpFilterEditSpinLock object.\n \n 3. Set the value of cIgmpFilterEditSpinLock to the \n retrieved value, and the value of objects in \n cIgmpFilterEditor to the new value. If the set\n fails for the cIgmpFilterEditSpinLock object,\n go back to step 1. \n \n The cIgmpFilterApplyStatus and cIgmpFilterEditSpinLock \n should be read together by NMS to make sure that the \n result is associated with its configuration request.\n \n To add/delete or modify a profile ( through cIgmpFilterEditor\n objects ) following procedure may be followed as an example.:\n \n 1. GET(cIgmpFilterEditSpinLock.0) and save in sValue.\n 2. SET(cIgmpFilterEditSpinLock.0 = sValue,\n cIgmpFilterEditProfileIndex.0 = validProfileNumber,\n cIgmpFilterEditStartAddress.0 = validStartAddress,\n cIgmpFilterEditEndAddress.0 = validEndAddress,\n cIgmpFilterEditOperation.0 = validOperation)\n 3. If the SET in step 2 is not successful go back\n to step 1.\n 4. If the SET in step 2 is successful, user should \n GET(cIgmpFilterEditSpinLock.0) and \n GET(cIgmpFilterApplyStatus.0) simultaneously.\n \n 5. The cIgmpFilterApplyStatus.0 reflects the outcome of\n step 2 only if\n cIgmpFilterEditSpinLock.0 = sValue + 1 or\n cIgmpFilterEditSpinLock.0 = 0 if sValue reaches\n value at which cIgmpFilterEditSpinLock wraps \n around.", "x-yang-type": "snmpv2-tc:TestAndIncr" }, "cIgmpFilterEditProfileIndex": { "type": "integer", "description": "Buffer object to edit corresponding object\n cIgmpFilterProfileIndex in cIgmpFilterTable.\n \n Maximum value this object can be set to is \n determined by cIgmpFilterMaxProfiles object.", "minimum": 0, "maximum": 4294967295 }, "cIgmpFilterEditStartAddressType": { "type": "string", "description": "Buffer object to edit corresponding object\n cIgmpFilterStartAddressType in cIgmpFilterTable.\n \n This object describes the type of Internet \n address used to determine the start address \n of IP multicast group for a profile.", "x-yang-type": "inet-address:InetAddressType" }, "cIgmpFilterEditStartAddress": { "type": "string", "description": "Buffer object to edit corresponding object\n cIgmpFilterStartAddress in cIgmpFilterTable\n to establish start address of filtering\n range for a profile.", "x-yang-type": "inet-address:InetAddress" }, "cIgmpFilterEditEndAddressType": { "type": "string", "description": "Buffer object to edit corresponding object\n cIgmpFilterEndAddressType in cIgmpFilterTable.\n \n This object describes the type of Internet \n address used to determine the start address \n of IP multicast group for a profile.", "x-yang-type": "inet-address:InetAddressType" }, "cIgmpFilterEditEndAddress": { "type": "string", "description": "Buffer object to edit corresponding object\n cIgmpFilterEndAddress in cIgmpFilterTable \n to establish end address of filtering \n range for a profile.", "x-yang-type": "inet-address:InetAddress" }, "cIgmpFilterEditProfileAction": { "type": "string", "description": "Buffer object to edit corresponding object in\n cIgmpFilterTable to determine filtering action\n of each profile." }, "cIgmpFilterEditOperation": { "type": "string", "description": "The function of this object is to allow user to\n apply the changes in cIgmpFilterEditor objects to \n cIgmpFilterTable. \n \n This object always has the value 'none' when read.\n When written each value causes the appropriate action:\n \n 'add' - tries to insert the information contained \n in cIgmpFilterEditor objects into cIgmpFilterTable.\n If the entry already exists in the table the 'add' \n fails. \n \n 'delete' - tries to delete corresponding entry from\n cIgmpFilterTable. If a user completely deletes a profile\n that has corresponding entries in the\n cIgmpFilterInterfaceTable, then all the interfaces mapped\n to corresponding profile will be cleared and set to zero.\n \n 'modify' - Mode of operation used to edit an entry in\n cIgmpFilterTable. If the corresponding entry does not \n exist, modify operation fails. This mode allows user to\n extend/truncate a contiguous filtered range, type of\n Internet addressing and filtering action for a profile. \n \n 'none' - no operation is performed." }, "cIgmpFilterApplyStatus": { "type": "string", "description": "The current status of an 'add', 'delete' or 'modify'\n operation. If no apply is currently active, the status \n represented is that of the most recently completed 'add', \n 'delete' or 'modify' operation.\n \n The value of this objects indicates succeeded(2) state \n initially when no 'add', 'delete', 'modify' operation\n has been carried out.\n \n The possible values are:\n someOtherError - the 'add', 'delete' or 'modify' failed \n due to undefined error(s) in apply operation.\n (e.g., insufficient memory). \n \n succeeded - the 'add', 'delete' or 'modify' operation\n was successful. (This value is also used when no\n apply has been invoked since the last time the local \n system restarted.)\n \n inconsistentEdit - the 'add', 'delete' or 'modify' failed\n due to inconsistency of the data.\n \n entryPresentError - the 'add' operation failed as the \n corresponding entry already exists in cIgmpFilterTable.\n \n entryNotPresentError - the 'modify' operation failed \n as no corresponding entry exists in cIgmpFilterTable." } } }, "example": { "CISCO-IGMP-FILTER-MIB:cIgmpFilterEditor": { "cIgmpFilterEditSpinLock": "example-string", "cIgmpFilterEditProfileIndex": 1, "cIgmpFilterEditStartAddressType": "192.168.1.1", "cIgmpFilterEditStartAddress": "192.168.1.1", "cIgmpFilterEditEndAddressType": "192.168.1.1", "cIgmpFilterEditEndAddress": "192.168.1.1", "cIgmpFilterEditProfileAction": "example-string", "cIgmpFilterEditOperation": "example-string", "cIgmpFilterApplyStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cIgmpFilterEditor", "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": "/cIgmpFilterEditor", "x-restconf-kind": "container" }, "/data/CISCO-IGMP-FILTER-MIB:cIgmpFilterTable": { "get": { "summary": "Get cIgmpFilterTable data", "description": "Retrieve cIgmpFilterTable operational data from MIB", "tags": [ "CISCO-IGMP-FILTER-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "cIgmpFilterTable", "properties": { "cIgmpFilterEntry": { "type": "array", "description": "An entry (conceptual row) in the cIgmpFilterTable.\n \n The creation, deletion or modification of an entry\n is controlled through the MIB objects defined under\n cIgmpFilterEditor group.", "items": { "type": "object", "properties": { "cIgmpFilterProfileIndex": { "type": "integer", "description": "Index identifying this entry.", "minimum": 0, "maximum": 4294967295 }, "cIgmpFilterStartAddressType": { "type": "string", "description": "This object describes the type of Internet\n address used to determine the start address \n of IP multicast group for a profile.", "x-yang-type": "inet-address:InetAddressType" }, "cIgmpFilterStartAddress": { "type": "string", "description": "This object describes the start of the IP multicast\n group address of a contiguous range which will be\n subjected to filtering operation.", "x-yang-type": "inet-address:InetAddress" }, "cIgmpFilterEndAddressType": { "type": "string", "description": "This object indicates the type of Internet\n address used to determine the end address \n of IP multicast group for a profile.", "x-yang-type": "inet-address:InetAddressType" }, "cIgmpFilterEndAddress": { "type": "string", "description": "This object indicates the end of the IP multicast\n group address of a contiguous range which will be \n subjected to filtering operation.", "x-yang-type": "inet-address:InetAddress" }, "cIgmpFilterProfileAction": { "type": "string", "description": "This object defines the action for\n filtering IGMP reports for this profile.\n \n If the object is set to deny(2):\n then all IGMP reports associated to IP multicast\n groups included in the profile identified by\n cIgmpFilterInterfaceProfileIndex will be dropped.\n \n If the object is set to permit(1):\n then all IGMP reports associated to IP multicast\n groups not included in the profile identified by\n cIgmpFilterInterfaceProfileIndex will be dropped." } } } } } }, "example": { "CISCO-IGMP-FILTER-MIB:cIgmpFilterTable": { "cIgmpFilterEntry": [ { "cIgmpFilterProfileIndex": 1, "cIgmpFilterStartAddressType": "192.168.1.1", "cIgmpFilterStartAddress": "192.168.1.1", "cIgmpFilterEndAddressType": "192.168.1.1", "cIgmpFilterEndAddress": "192.168.1.1", "cIgmpFilterProfileAction": "example-string" }, { "cIgmpFilterProfileIndex": 2, "cIgmpFilterStartAddressType": "192.168.1.1", "cIgmpFilterStartAddress": "192.168.1.1", "cIgmpFilterEndAddressType": "192.168.1.1", "cIgmpFilterEndAddress": "192.168.1.1", "cIgmpFilterProfileAction": "example-string" }, { "cIgmpFilterProfileIndex": 3, "cIgmpFilterStartAddressType": "192.168.1.1", "cIgmpFilterStartAddress": "192.168.1.1", "cIgmpFilterEndAddressType": "192.168.1.1", "cIgmpFilterEndAddress": "192.168.1.1", "cIgmpFilterProfileAction": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cIgmpFilterTable", "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": "/cIgmpFilterTable", "x-restconf-kind": "container" }, "/data/CISCO-IGMP-FILTER-MIB:cIgmpFilterTable/cIgmpFilterEntry": { "get": { "summary": "Get cIgmpFilterEntry list", "description": "Retrieve list of cIgmpFilterEntry entries from MIB", "tags": [ "CISCO-IGMP-FILTER-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry (conceptual row) in the cIgmpFilterTable.\n \n The creation, deletion or modification of an entry\n is controlled through the MIB objects defined under\n cIgmpFilterEditor group.", "items": { "type": "object", "properties": { "cIgmpFilterProfileIndex": { "type": "integer", "description": "Index identifying this entry.", "minimum": 0, "maximum": 4294967295 }, "cIgmpFilterStartAddressType": { "type": "string", "description": "This object describes the type of Internet\n address used to determine the start address \n of IP multicast group for a profile.", "x-yang-type": "inet-address:InetAddressType" }, "cIgmpFilterStartAddress": { "type": "string", "description": "This object describes the start of the IP multicast\n group address of a contiguous range which will be\n subjected to filtering operation.", "x-yang-type": "inet-address:InetAddress" }, "cIgmpFilterEndAddressType": { "type": "string", "description": "This object indicates the type of Internet\n address used to determine the end address \n of IP multicast group for a profile.", "x-yang-type": "inet-address:InetAddressType" }, "cIgmpFilterEndAddress": { "type": "string", "description": "This object indicates the end of the IP multicast\n group address of a contiguous range which will be \n subjected to filtering operation.", "x-yang-type": "inet-address:InetAddress" }, "cIgmpFilterProfileAction": { "type": "string", "description": "This object defines the action for\n filtering IGMP reports for this profile.\n \n If the object is set to deny(2):\n then all IGMP reports associated to IP multicast\n groups included in the profile identified by\n cIgmpFilterInterfaceProfileIndex will be dropped.\n \n If the object is set to permit(1):\n then all IGMP reports associated to IP multicast\n groups not included in the profile identified by\n cIgmpFilterInterfaceProfileIndex will be dropped." } } } }, "example": { "CISCO-IGMP-FILTER-MIB:cIgmpFilterEntry": [ { "cIgmpFilterProfileIndex": 1, "cIgmpFilterStartAddressType": "192.168.1.1", "cIgmpFilterStartAddress": "192.168.1.1", "cIgmpFilterEndAddressType": "192.168.1.1", "cIgmpFilterEndAddress": "192.168.1.1", "cIgmpFilterProfileAction": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cIgmpFilterEntry", "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": "/cIgmpFilterTable/cIgmpFilterEntry", "x-restconf-kind": "container" }, "/data/CISCO-IGMP-FILTER-MIB:cIgmpFilterInterfaceTable": { "get": { "summary": "Get cIgmpFilterInterfaceTable data", "description": "Retrieve cIgmpFilterInterfaceTable operational data from MIB", "tags": [ "CISCO-IGMP-FILTER-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table contains the list of interfaces that can\n support IGMP filter feature.", "properties": { "cIgmpFilterInterfaceEntry": { "type": "array", "description": "Each entry contains the configuration for associating\n the IGMP filter profile index with the interface.\n \n An entry is created for each of the IGMP filter capable \n interface on the system.\n \n The entry is removed on removal of corresponding \n interface from system.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cIgmpFilterInterfaceProfileIndex": { "type": "integer", "description": "Specifies which IGMP filter profile applies to this\n interface. If the value of this MIB object matches the \n value of cIgmpFilterProfileIndex in cIgmpFilterTable, \n the corresponding profile configuration will apply to\n this interface. \n \n Agent returns inconsistentValue if this profile \n does not exist in cIgmpFilterTable. \n A value of zero indicates no profile is associated\n with corresponding interface.\n \n The filtering action on each interface is also\n defined by the associated profile.", "minimum": 0, "maximum": 4294967295 } } } } } }, "example": { "CISCO-IGMP-FILTER-MIB:cIgmpFilterInterfaceTable": { "cIgmpFilterInterfaceEntry": [ { "ifIndex": "1", "cIgmpFilterInterfaceProfileIndex": 1 }, { "ifIndex": "2", "cIgmpFilterInterfaceProfileIndex": 2 }, { "ifIndex": "3", "cIgmpFilterInterfaceProfileIndex": 3 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cIgmpFilterInterfaceTable", "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": "/cIgmpFilterInterfaceTable", "x-restconf-kind": "container" }, "/data/CISCO-IGMP-FILTER-MIB:cIgmpFilterInterfaceTable/cIgmpFilterInterfaceEntry": { "get": { "summary": "Get cIgmpFilterInterfaceEntry list", "description": "Retrieve list of cIgmpFilterInterfaceEntry entries from MIB", "tags": [ "CISCO-IGMP-FILTER-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Each entry contains the configuration for associating\n the IGMP filter profile index with the interface.\n \n An entry is created for each of the IGMP filter capable \n interface on the system.\n \n The entry is removed on removal of corresponding \n interface from system.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cIgmpFilterInterfaceProfileIndex": { "type": "integer", "description": "Specifies which IGMP filter profile applies to this\n interface. If the value of this MIB object matches the \n value of cIgmpFilterProfileIndex in cIgmpFilterTable, \n the corresponding profile configuration will apply to\n this interface. \n \n Agent returns inconsistentValue if this profile \n does not exist in cIgmpFilterTable. \n A value of zero indicates no profile is associated\n with corresponding interface.\n \n The filtering action on each interface is also\n defined by the associated profile.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-IGMP-FILTER-MIB:cIgmpFilterInterfaceEntry": [ { "ifIndex": "example-string", "cIgmpFilterInterfaceProfileIndex": 1 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cIgmpFilterInterfaceEntry", "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": "/cIgmpFilterInterfaceTable/cIgmpFilterInterfaceEntry", "x-restconf-kind": "container" }, "/data/CISCO-IGMP-FILTER-MIB:cIgmpFilterInterfaceTable/cIgmpFilterInterfaceEntry={ifIndex}": { "get": { "summary": "Get cIgmpFilterInterfaceEntry entry", "description": "Retrieve specific cIgmpFilterInterfaceEntry entry by key from MIB", "tags": [ "CISCO-IGMP-FILTER-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" }, "cIgmpFilterInterfaceProfileIndex": { "type": "integer", "description": "Specifies which IGMP filter profile applies to this\n interface. If the value of this MIB object matches the \n value of cIgmpFilterProfileIndex in cIgmpFilterTable, \n the corresponding profile configuration will apply to\n this interface. \n \n Agent returns inconsistentValue if this profile \n does not exist in cIgmpFilterTable. \n A value of zero indicates no profile is associated\n with corresponding interface.\n \n The filtering action on each interface is also\n defined by the associated profile.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-IGMP-FILTER-MIB:cIgmpFilterInterfaceEntry": { "ifIndex": "example-string", "cIgmpFilterInterfaceProfileIndex": 1 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cIgmpFilterInterfaceEntry-2" }, "x-yang-path": "/cIgmpFilterInterfaceTable/cIgmpFilterInterfaceEntry={ifIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ifIndex" ] }, "/data/CISCO-IGMP-FILTER-MIB:cIgmpFilterEntry": { "get": { "summary": "Get cIgmpFilterEntry list", "description": "Retrieve list of cIgmpFilterEntry entries from MIB", "tags": [ "CISCO-IGMP-FILTER-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry (conceptual row) in the cIgmpFilterTable.\n \n The creation, deletion or modification of an entry\n is controlled through the MIB objects defined under\n cIgmpFilterEditor group.", "items": { "type": "object", "properties": { "cIgmpFilterProfileIndex": { "type": "integer", "description": "Index identifying this entry.", "minimum": 0, "maximum": 4294967295 }, "cIgmpFilterStartAddressType": { "type": "string", "description": "This object describes the type of Internet\n address used to determine the start address \n of IP multicast group for a profile.", "x-yang-type": "inet-address:InetAddressType" }, "cIgmpFilterStartAddress": { "type": "string", "description": "This object describes the start of the IP multicast\n group address of a contiguous range which will be\n subjected to filtering operation.", "x-yang-type": "inet-address:InetAddress" }, "cIgmpFilterEndAddressType": { "type": "string", "description": "This object indicates the type of Internet\n address used to determine the end address \n of IP multicast group for a profile.", "x-yang-type": "inet-address:InetAddressType" }, "cIgmpFilterEndAddress": { "type": "string", "description": "This object indicates the end of the IP multicast\n group address of a contiguous range which will be \n subjected to filtering operation.", "x-yang-type": "inet-address:InetAddress" }, "cIgmpFilterProfileAction": { "type": "string", "description": "This object defines the action for\n filtering IGMP reports for this profile.\n \n If the object is set to deny(2):\n then all IGMP reports associated to IP multicast\n groups included in the profile identified by\n cIgmpFilterInterfaceProfileIndex will be dropped.\n \n If the object is set to permit(1):\n then all IGMP reports associated to IP multicast\n groups not included in the profile identified by\n cIgmpFilterInterfaceProfileIndex will be dropped." } } } }, "example": { "CISCO-IGMP-FILTER-MIB:cIgmpFilterEntry": [ { "cIgmpFilterProfileIndex": 1, "cIgmpFilterStartAddressType": "192.168.1.1", "cIgmpFilterStartAddress": "192.168.1.1", "cIgmpFilterEndAddressType": "192.168.1.1", "cIgmpFilterEndAddress": "192.168.1.1", "cIgmpFilterProfileAction": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cIgmpFilterEntry-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": "/cIgmpFilterEntry", "x-restconf-kind": "container" }, "/data/CISCO-IGMP-FILTER-MIB:cIgmpFilterInterfaceEntry": { "get": { "summary": "Get cIgmpFilterInterfaceEntry list", "description": "Retrieve list of cIgmpFilterInterfaceEntry entries from MIB", "tags": [ "CISCO-IGMP-FILTER-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Each entry contains the configuration for associating\n the IGMP filter profile index with the interface.\n \n An entry is created for each of the IGMP filter capable \n interface on the system.\n \n The entry is removed on removal of corresponding \n interface from system.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cIgmpFilterInterfaceProfileIndex": { "type": "integer", "description": "Specifies which IGMP filter profile applies to this\n interface. If the value of this MIB object matches the \n value of cIgmpFilterProfileIndex in cIgmpFilterTable, \n the corresponding profile configuration will apply to\n this interface. \n \n Agent returns inconsistentValue if this profile \n does not exist in cIgmpFilterTable. \n A value of zero indicates no profile is associated\n with corresponding interface.\n \n The filtering action on each interface is also\n defined by the associated profile.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-IGMP-FILTER-MIB:cIgmpFilterInterfaceEntry": [ { "ifIndex": "example-string", "cIgmpFilterInterfaceProfileIndex": 1 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cIgmpFilterInterfaceEntry-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": "/cIgmpFilterInterfaceEntry", "x-restconf-kind": "container" }, "/data/CISCO-IGMP-FILTER-MIB:cIgmpFilterInterfaceEntry={ifIndex}": { "get": { "summary": "Get cIgmpFilterInterfaceEntry entry", "description": "Retrieve specific cIgmpFilterInterfaceEntry entry by key from MIB", "tags": [ "CISCO-IGMP-FILTER-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" }, "cIgmpFilterInterfaceProfileIndex": { "type": "integer", "description": "Specifies which IGMP filter profile applies to this\n interface. If the value of this MIB object matches the \n value of cIgmpFilterProfileIndex in cIgmpFilterTable, \n the corresponding profile configuration will apply to\n this interface. \n \n Agent returns inconsistentValue if this profile \n does not exist in cIgmpFilterTable. \n A value of zero indicates no profile is associated\n with corresponding interface.\n \n The filtering action on each interface is also\n defined by the associated profile.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-IGMP-FILTER-MIB:cIgmpFilterInterfaceEntry": { "ifIndex": "example-string", "cIgmpFilterInterfaceProfileIndex": 1 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cIgmpFilterInterfaceEntry-4" }, "x-yang-path": "/cIgmpFilterInterfaceEntry={ifIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ifIndex" ] }, "/data/CISCO-IGMP-FILTER-MIB:cIgmpFilterTable/cIgmpFilterEntry={cIgmpFilterProfileIndex},{cIgmpFilterStartAddressType},{cIgmpFilterStartAddress}": { "get": { "summary": "Get cIgmpFilterEntry entry", "description": "Retrieve specific cIgmpFilterEntry entry by key from MIB", "tags": [ "CISCO-IGMP-FILTER-MIB" ], "parameters": [ { "name": "cIgmpFilterProfileIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cIgmpFilterStartAddressType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cIgmpFilterStartAddress", "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": { "cIgmpFilterProfileIndex": { "type": "integer", "description": "Index identifying this entry.", "minimum": 0, "maximum": 4294967295 }, "cIgmpFilterStartAddressType": { "type": "string", "description": "This object describes the type of Internet\n address used to determine the start address \n of IP multicast group for a profile.", "x-yang-type": "inet-address:InetAddressType" }, "cIgmpFilterStartAddress": { "type": "string", "description": "This object describes the start of the IP multicast\n group address of a contiguous range which will be\n subjected to filtering operation.", "x-yang-type": "inet-address:InetAddress" }, "cIgmpFilterEndAddressType": { "type": "string", "description": "This object indicates the type of Internet\n address used to determine the end address \n of IP multicast group for a profile.", "x-yang-type": "inet-address:InetAddressType" }, "cIgmpFilterEndAddress": { "type": "string", "description": "This object indicates the end of the IP multicast\n group address of a contiguous range which will be \n subjected to filtering operation.", "x-yang-type": "inet-address:InetAddress" }, "cIgmpFilterProfileAction": { "type": "string", "description": "This object defines the action for\n filtering IGMP reports for this profile.\n \n If the object is set to deny(2):\n then all IGMP reports associated to IP multicast\n groups included in the profile identified by\n cIgmpFilterInterfaceProfileIndex will be dropped.\n \n If the object is set to permit(1):\n then all IGMP reports associated to IP multicast\n groups not included in the profile identified by\n cIgmpFilterInterfaceProfileIndex will be dropped." } } }, "example": { "CISCO-IGMP-FILTER-MIB:cIgmpFilterEntry": { "cIgmpFilterProfileIndex": 1, "cIgmpFilterStartAddressType": "192.168.1.1", "cIgmpFilterStartAddress": "192.168.1.1", "cIgmpFilterEndAddressType": "192.168.1.1", "cIgmpFilterEndAddress": "192.168.1.1", "cIgmpFilterProfileAction": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cIgmpFilterEntry-2" }, "x-yang-path": "/cIgmpFilterTable/cIgmpFilterEntry={cIgmpFilterProfileIndex cIgmpFilterStartAddressType cIgmpFilterStartAddress}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cIgmpFilterProfileIndex cIgmpFilterStartAddressType cIgmpFilterStartAddress" ] }, "/data/CISCO-IGMP-FILTER-MIB:cIgmpFilterEntry={cIgmpFilterProfileIndex},{cIgmpFilterStartAddressType},{cIgmpFilterStartAddress}": { "get": { "summary": "Get cIgmpFilterEntry entry", "description": "Retrieve specific cIgmpFilterEntry entry by key from MIB", "tags": [ "CISCO-IGMP-FILTER-MIB" ], "parameters": [ { "name": "cIgmpFilterProfileIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cIgmpFilterStartAddressType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cIgmpFilterStartAddress", "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": { "cIgmpFilterProfileIndex": { "type": "integer", "description": "Index identifying this entry.", "minimum": 0, "maximum": 4294967295 }, "cIgmpFilterStartAddressType": { "type": "string", "description": "This object describes the type of Internet\n address used to determine the start address \n of IP multicast group for a profile.", "x-yang-type": "inet-address:InetAddressType" }, "cIgmpFilterStartAddress": { "type": "string", "description": "This object describes the start of the IP multicast\n group address of a contiguous range which will be\n subjected to filtering operation.", "x-yang-type": "inet-address:InetAddress" }, "cIgmpFilterEndAddressType": { "type": "string", "description": "This object indicates the type of Internet\n address used to determine the end address \n of IP multicast group for a profile.", "x-yang-type": "inet-address:InetAddressType" }, "cIgmpFilterEndAddress": { "type": "string", "description": "This object indicates the end of the IP multicast\n group address of a contiguous range which will be \n subjected to filtering operation.", "x-yang-type": "inet-address:InetAddress" }, "cIgmpFilterProfileAction": { "type": "string", "description": "This object defines the action for\n filtering IGMP reports for this profile.\n \n If the object is set to deny(2):\n then all IGMP reports associated to IP multicast\n groups included in the profile identified by\n cIgmpFilterInterfaceProfileIndex will be dropped.\n \n If the object is set to permit(1):\n then all IGMP reports associated to IP multicast\n groups not included in the profile identified by\n cIgmpFilterInterfaceProfileIndex will be dropped." } } }, "example": { "CISCO-IGMP-FILTER-MIB:cIgmpFilterEntry": { "cIgmpFilterProfileIndex": 1, "cIgmpFilterStartAddressType": "192.168.1.1", "cIgmpFilterStartAddress": "192.168.1.1", "cIgmpFilterEndAddressType": "192.168.1.1", "cIgmpFilterEndAddress": "192.168.1.1", "cIgmpFilterProfileAction": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cIgmpFilterEntry-4" }, "x-yang-path": "/cIgmpFilterEntry={cIgmpFilterProfileIndex cIgmpFilterStartAddressType cIgmpFilterStartAddress}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cIgmpFilterProfileIndex cIgmpFilterStartAddressType cIgmpFilterStartAddress" ] } }, "components": { "schemas": { "CISCO-IGMP-FILTER-MIB_CISCO-IGMP-FILTER-MIB": { "type": "object", "description": "This object controls whether the IGMP filtering\n is enabled on the device. A false(2) value will \n prevent the IGMP filtering action on the device.", "properties": { "cIgmpFilterEntry": { "type": "array", "description": "An entry (conceptual row) in the cIgmpFilterTable.\n \n The creation, deletion or modification of an entry\n is controlled through the MIB objects defined under\n cIgmpFilterEditor group.", "items": { "type": "object", "properties": { "cIgmpFilterProfileIndex": { "type": "integer", "description": "Index identifying this entry.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cIgmpFilterStartAddressType": { "type": "string", "description": "This object describes the type of Internet\n address used to determine the start address \n of IP multicast group for a profile.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cIgmpFilterStartAddress": { "type": "string", "description": "This object describes the start of the IP multicast\n group address of a contiguous range which will be\n subjected to filtering operation.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cIgmpFilterEndAddressType": { "type": "string", "description": "This object indicates the type of Internet\n address used to determine the end address \n of IP multicast group for a profile.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cIgmpFilterEndAddress": { "type": "string", "description": "This object indicates the end of the IP multicast\n group address of a contiguous range which will be \n subjected to filtering operation.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cIgmpFilterProfileAction": { "type": "string", "description": "This object defines the action for\n filtering IGMP reports for this profile.\n \n If the object is set to deny(2):\n then all IGMP reports associated to IP multicast\n groups included in the profile identified by\n cIgmpFilterInterfaceProfileIndex will be dropped.\n \n If the object is set to permit(1):\n then all IGMP reports associated to IP multicast\n groups not included in the profile identified by\n cIgmpFilterInterfaceProfileIndex will be dropped.", "readOnly": true } } }, "readOnly": true }, "cIgmpFilterInterfaceEntry": { "type": "array", "description": "Each entry contains the configuration for associating\n the IGMP filter profile index with the interface.\n \n An entry is created for each of the IGMP filter capable \n interface on the system.\n \n The entry is removed on removal of corresponding \n interface from system.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cIgmpFilterInterfaceProfileIndex": { "type": "integer", "description": "Specifies which IGMP filter profile applies to this\n interface. If the value of this MIB object matches the \n value of cIgmpFilterProfileIndex in cIgmpFilterTable, \n the corresponding profile configuration will apply to\n this interface. \n \n Agent returns inconsistentValue if this profile \n does not exist in cIgmpFilterTable. \n A value of zero indicates no profile is associated\n with corresponding interface.\n \n The filtering action on each interface is also\n defined by the associated profile.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true }, "cIgmpFilterGeneral": { "type": "object", "description": "This object controls whether the IGMP filtering\n is enabled on the device. A false(2) value will \n prevent the IGMP filtering action on the device.", "properties": { "cIgmpFilterEnable": { "type": "boolean", "description": "This object controls whether the IGMP filtering\n is enabled on the device. A false(2) value will \n prevent the IGMP filtering action on the device.", "readOnly": true }, "cIgmpFilterMaxProfiles": { "type": "integer", "description": "Indicates the maximum number of profiles supported by\n this device. A value of zero indicates no limitation on\n the number of profiles.", "minimum": 0, "maximum": 4294967295, "readOnly": true } }, "readOnly": true }, "cIgmpFilterEditor": { "type": "object", "description": "cIgmpFilterEditor", "properties": { "cIgmpFilterEditSpinLock": { "type": "string", "description": "This object is used to facilitate modification of\n IGMP Filter Editor Group in the CISCO-IGMP-FILTER-MIB \n module by multiple managers. In particular, it is \n useful when modifying the value of the cIgmpFilterEditor \n object. \n \n The procedure for modifying the cIgmpFilterEditor \n object is as follows: \n \n 1. Retrieve the value of cIgmpFilterEditSpinLock and \n of object within cIgmpFilterEditor group. \n \n 2. Generate new values for 'writeable' objects\n in the cIgmpFilterEditor group except for \n cIgmpFilterEditSpinLock object.\n \n 3. Set the value of cIgmpFilterEditSpinLock to the \n retrieved value, and the value of objects in \n cIgmpFilterEditor to the new value. If the set\n fails for the cIgmpFilterEditSpinLock object,\n go back to step 1. \n \n The cIgmpFilterApplyStatus and cIgmpFilterEditSpinLock \n should be read together by NMS to make sure that the \n result is associated with its configuration request.\n \n To add/delete or modify a profile ( through cIgmpFilterEditor\n objects ) following procedure may be followed as an example.:\n \n 1. GET(cIgmpFilterEditSpinLock.0) and save in sValue.\n 2. SET(cIgmpFilterEditSpinLock.0 = sValue,\n cIgmpFilterEditProfileIndex.0 = validProfileNumber,\n cIgmpFilterEditStartAddress.0 = validStartAddress,\n cIgmpFilterEditEndAddress.0 = validEndAddress,\n cIgmpFilterEditOperation.0 = validOperation)\n 3. If the SET in step 2 is not successful go back\n to step 1.\n 4. If the SET in step 2 is successful, user should \n GET(cIgmpFilterEditSpinLock.0) and \n GET(cIgmpFilterApplyStatus.0) simultaneously.\n \n 5. The cIgmpFilterApplyStatus.0 reflects the outcome of\n step 2 only if\n cIgmpFilterEditSpinLock.0 = sValue + 1 or\n cIgmpFilterEditSpinLock.0 = 0 if sValue reaches\n value at which cIgmpFilterEditSpinLock wraps \n around.", "x-yang-type": "snmpv2-tc:TestAndIncr", "readOnly": true }, "cIgmpFilterEditProfileIndex": { "type": "integer", "description": "Buffer object to edit corresponding object\n cIgmpFilterProfileIndex in cIgmpFilterTable.\n \n Maximum value this object can be set to is \n determined by cIgmpFilterMaxProfiles object.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cIgmpFilterEditStartAddressType": { "type": "string", "description": "Buffer object to edit corresponding object\n cIgmpFilterStartAddressType in cIgmpFilterTable.\n \n This object describes the type of Internet \n address used to determine the start address \n of IP multicast group for a profile.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cIgmpFilterEditStartAddress": { "type": "string", "description": "Buffer object to edit corresponding object\n cIgmpFilterStartAddress in cIgmpFilterTable\n to establish start address of filtering\n range for a profile.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cIgmpFilterEditEndAddressType": { "type": "string", "description": "Buffer object to edit corresponding object\n cIgmpFilterEndAddressType in cIgmpFilterTable.\n \n This object describes the type of Internet \n address used to determine the start address \n of IP multicast group for a profile.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cIgmpFilterEditEndAddress": { "type": "string", "description": "Buffer object to edit corresponding object\n cIgmpFilterEndAddress in cIgmpFilterTable \n to establish end address of filtering \n range for a profile.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cIgmpFilterEditProfileAction": { "type": "string", "description": "Buffer object to edit corresponding object in\n cIgmpFilterTable to determine filtering action\n of each profile.", "readOnly": true }, "cIgmpFilterEditOperation": { "type": "string", "description": "The function of this object is to allow user to\n apply the changes in cIgmpFilterEditor objects to \n cIgmpFilterTable. \n \n This object always has the value 'none' when read.\n When written each value causes the appropriate action:\n \n 'add' - tries to insert the information contained \n in cIgmpFilterEditor objects into cIgmpFilterTable.\n If the entry already exists in the table the 'add' \n fails. \n \n 'delete' - tries to delete corresponding entry from\n cIgmpFilterTable. If a user completely deletes a profile\n that has corresponding entries in the\n cIgmpFilterInterfaceTable, then all the interfaces mapped\n to corresponding profile will be cleared and set to zero.\n \n 'modify' - Mode of operation used to edit an entry in\n cIgmpFilterTable. If the corresponding entry does not \n exist, modify operation fails. This mode allows user to\n extend/truncate a contiguous filtered range, type of\n Internet addressing and filtering action for a profile. \n \n 'none' - no operation is performed.", "readOnly": true }, "cIgmpFilterApplyStatus": { "type": "string", "description": "The current status of an 'add', 'delete' or 'modify'\n operation. If no apply is currently active, the status \n represented is that of the most recently completed 'add', \n 'delete' or 'modify' operation.\n \n The value of this objects indicates succeeded(2) state \n initially when no 'add', 'delete', 'modify' operation\n has been carried out.\n \n The possible values are:\n someOtherError - the 'add', 'delete' or 'modify' failed \n due to undefined error(s) in apply operation.\n (e.g., insufficient memory). \n \n succeeded - the 'add', 'delete' or 'modify' operation\n was successful. (This value is also used when no\n apply has been invoked since the last time the local \n system restarted.)\n \n inconsistentEdit - the 'add', 'delete' or 'modify' failed\n due to inconsistency of the data.\n \n entryPresentError - the 'add' operation failed as the \n corresponding entry already exists in cIgmpFilterTable.\n \n entryNotPresentError - the 'modify' operation failed \n as no corresponding entry exists in cIgmpFilterTable.", "readOnly": true } }, "readOnly": true }, "cIgmpFilterTable": { "type": "object", "description": "cIgmpFilterTable", "properties": { "cIgmpFilterEntry": { "type": "array", "description": "An entry (conceptual row) in the cIgmpFilterTable.\n \n The creation, deletion or modification of an entry\n is controlled through the MIB objects defined under\n cIgmpFilterEditor group.", "items": { "type": "object", "properties": { "cIgmpFilterProfileIndex": { "type": "integer", "description": "Index identifying this entry.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cIgmpFilterStartAddressType": { "type": "string", "description": "This object describes the type of Internet\n address used to determine the start address \n of IP multicast group for a profile.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cIgmpFilterStartAddress": { "type": "string", "description": "This object describes the start of the IP multicast\n group address of a contiguous range which will be\n subjected to filtering operation.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cIgmpFilterEndAddressType": { "type": "string", "description": "This object indicates the type of Internet\n address used to determine the end address \n of IP multicast group for a profile.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cIgmpFilterEndAddress": { "type": "string", "description": "This object indicates the end of the IP multicast\n group address of a contiguous range which will be \n subjected to filtering operation.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cIgmpFilterProfileAction": { "type": "string", "description": "This object defines the action for\n filtering IGMP reports for this profile.\n \n If the object is set to deny(2):\n then all IGMP reports associated to IP multicast\n groups included in the profile identified by\n cIgmpFilterInterfaceProfileIndex will be dropped.\n \n If the object is set to permit(1):\n then all IGMP reports associated to IP multicast\n groups not included in the profile identified by\n cIgmpFilterInterfaceProfileIndex will be dropped.", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cIgmpFilterInterfaceTable": { "type": "object", "description": "This table contains the list of interfaces that can\n support IGMP filter feature.", "properties": { "cIgmpFilterInterfaceEntry": { "type": "array", "description": "Each entry contains the configuration for associating\n the IGMP filter profile index with the interface.\n \n An entry is created for each of the IGMP filter capable \n interface on the system.\n \n The entry is removed on removal of corresponding \n interface from system.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cIgmpFilterInterfaceProfileIndex": { "type": "integer", "description": "Specifies which IGMP filter profile applies to this\n interface. If the value of this MIB object matches the \n value of cIgmpFilterProfileIndex in cIgmpFilterTable, \n the corresponding profile configuration will apply to\n this interface. \n \n Agent returns inconsistentValue if this profile \n does not exist in cIgmpFilterTable. \n A value of zero indicates no profile is associated\n with corresponding interface.\n \n The filtering action on each interface is also\n defined by the associated profile.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true } }, "readOnly": true } } }, "CISCO-IGMP-FILTER-MIB_cIgmpFilterEntry": { "type": "array", "description": "An entry (conceptual row) in the cIgmpFilterTable.\n \n The creation, deletion or modification of an entry\n is controlled through the MIB objects defined under\n cIgmpFilterEditor group.", "items": { "type": "object", "properties": { "cIgmpFilterProfileIndex": { "type": "integer", "description": "Index identifying this entry.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cIgmpFilterStartAddressType": { "type": "string", "description": "This object describes the type of Internet\n address used to determine the start address \n of IP multicast group for a profile.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cIgmpFilterStartAddress": { "type": "string", "description": "This object describes the start of the IP multicast\n group address of a contiguous range which will be\n subjected to filtering operation.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cIgmpFilterEndAddressType": { "type": "string", "description": "This object indicates the type of Internet\n address used to determine the end address \n of IP multicast group for a profile.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cIgmpFilterEndAddress": { "type": "string", "description": "This object indicates the end of the IP multicast\n group address of a contiguous range which will be \n subjected to filtering operation.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cIgmpFilterProfileAction": { "type": "string", "description": "This object defines the action for\n filtering IGMP reports for this profile.\n \n If the object is set to deny(2):\n then all IGMP reports associated to IP multicast\n groups included in the profile identified by\n cIgmpFilterInterfaceProfileIndex will be dropped.\n \n If the object is set to permit(1):\n then all IGMP reports associated to IP multicast\n groups not included in the profile identified by\n cIgmpFilterInterfaceProfileIndex will be dropped.", "readOnly": true } } } }, "CISCO-IGMP-FILTER-MIB_cIgmpFilterInterfaceEntry": { "type": "array", "description": "Each entry contains the configuration for associating\n the IGMP filter profile index with the interface.\n \n An entry is created for each of the IGMP filter capable \n interface on the system.\n \n The entry is removed on removal of corresponding \n interface from system.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cIgmpFilterInterfaceProfileIndex": { "type": "integer", "description": "Specifies which IGMP filter profile applies to this\n interface. If the value of this MIB object matches the \n value of cIgmpFilterProfileIndex in cIgmpFilterTable, \n the corresponding profile configuration will apply to\n this interface. \n \n Agent returns inconsistentValue if this profile \n does not exist in cIgmpFilterTable. \n A value of zero indicates no profile is associated\n with corresponding interface.\n \n The filtering action on each interface is also\n defined by the associated profile.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } } }, "restconf-error": { "type": "object", "description": "Standard RESTCONF error response (RFC 8040 Section 7.1)", "properties": { "ietf-restconf:errors": { "type": "object", "properties": { "error": { "type": "array", "items": { "type": "object", "properties": { "error-type": { "type": "string", "enum": [ "transport", "rpc", "protocol", "application" ], "description": "Layer where the error occurred" }, "error-tag": { "type": "string", "description": "Enumerated error tag (e.g. invalid-value, data-missing, access-denied)" }, "error-severity": { "type": "string", "enum": [ "error", "warning" ], "description": "Error severity" }, "error-app-tag": { "type": "string", "description": "Application-specific error tag" }, "error-path": { "type": "string", "description": "YANG instance-identifier of the error node" }, "error-message": { "type": "string", "description": "Human-readable error description" } }, "required": [ "error-type", "error-tag" ] } } } } }, "example": { "ietf-restconf:errors": { "error": [ { "error-type": "protocol", "error-tag": "invalid-value", "error-severity": "error", "error-message": "Invalid input parameter" } ] } } } }, "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic" } } }, "security": [ { "basicAuth": [] } ], "tags": [ { "name": "CISCO-IGMP-FILTER-MIB", "description": "MIB operations for CISCO-IGMP-FILTER-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }