{ "openapi": "3.0.0", "info": { "title": "CISCO-VLAN-IFTABLE-RELATIONSHIP-MIB MIB API", "version": "1.0.0", "description": "Cisco VLAN ifTable Relationship MIB lists VLAN-id and ifIndex\n information for routed VLAN interfaces. \n \n A routed VLAN interface is the router interface or sub-interface \n to which the router's IP address on the VLAN is attached. \n For example, an ISL, SDE, or 802.1Q encapsulated\n subinterface, or Switched Virtual Interface (SVI).\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-VLAN-IFTABLE-RELATIONSHIP-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/CISCO-VLAN-IFTABLE-RELATIONSHIP-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "CISCO-VLAN-IFTABLE-RELATIONSHIP-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-VLAN-IFTABLE-RELATIONSHIP-MIB:cviVlanInterfaceIndexTable": { "get": { "summary": "Get cviVlanInterfaceIndexTable data", "description": "Retrieve cviVlanInterfaceIndexTable operational data from MIB", "tags": [ "CISCO-VLAN-IFTABLE-RELATIONSHIP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "cviVlanInterfaceIndexTable", "properties": { "cviVlanInterfaceIndexEntry": { "type": "array", "description": "cviVlanInterfaceIndexEntry", "items": { "type": "object", "properties": { "cviVlanId": { "type": "string", "description": "The VLAN-id number of the routed VLAN interface.", "x-yang-type": "cisco-vtp:VlanIndex" }, "cviPhysicalIfIndex": { "type": "string", "description": "For subinterfaces, this object is the ifIndex of the\n physical interface for the subinterface.\n \n For Switch Virtual Interfaces (SVIs), this object is zero.", "x-yang-type": "cisco-tc:InterfaceIndexOrZero" }, "cviRoutedVlanIfIndex": { "type": "string", "description": "The index for the ifTable entry associated with\n this routed VLAN interface.", "x-yang-type": "if-mib:InterfaceIndex" } } } } } }, "example": { "CISCO-VLAN-IFTABLE-RELATIONSHIP-MIB:cviVlanInterfaceIndexTable": { "cviVlanInterfaceIndexEntry": [ { "cviVlanId": "example-string", "cviPhysicalIfIndex": "1", "cviRoutedVlanIfIndex": "1" }, { "cviVlanId": "example-string", "cviPhysicalIfIndex": "2", "cviRoutedVlanIfIndex": "2" }, { "cviVlanId": "example-string", "cviPhysicalIfIndex": "3", "cviRoutedVlanIfIndex": "3" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cviVlanInterfaceIndexTable", "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": "/cviVlanInterfaceIndexTable", "x-restconf-kind": "container" }, "/data/CISCO-VLAN-IFTABLE-RELATIONSHIP-MIB:cviVlanInterfaceIndexTable/cviVlanInterfaceIndexEntry": { "get": { "summary": "Get cviVlanInterfaceIndexEntry list", "description": "Retrieve list of cviVlanInterfaceIndexEntry entries from MIB", "tags": [ "CISCO-VLAN-IFTABLE-RELATIONSHIP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "cviVlanInterfaceIndexEntry", "items": { "type": "object", "properties": { "cviVlanId": { "type": "string", "description": "The VLAN-id number of the routed VLAN interface.", "x-yang-type": "cisco-vtp:VlanIndex" }, "cviPhysicalIfIndex": { "type": "string", "description": "For subinterfaces, this object is the ifIndex of the\n physical interface for the subinterface.\n \n For Switch Virtual Interfaces (SVIs), this object is zero.", "x-yang-type": "cisco-tc:InterfaceIndexOrZero" }, "cviRoutedVlanIfIndex": { "type": "string", "description": "The index for the ifTable entry associated with\n this routed VLAN interface.", "x-yang-type": "if-mib:InterfaceIndex" } } } }, "example": { "CISCO-VLAN-IFTABLE-RELATIONSHIP-MIB:cviVlanInterfaceIndexEntry": [ { "cviVlanId": "example-string", "cviPhysicalIfIndex": "192.168.1.1", "cviRoutedVlanIfIndex": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cviVlanInterfaceIndexEntry", "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": "/cviVlanInterfaceIndexTable/cviVlanInterfaceIndexEntry", "x-restconf-kind": "container" }, "/data/CISCO-VLAN-IFTABLE-RELATIONSHIP-MIB:cviVlanInterfaceIndexEntry": { "get": { "summary": "Get cviVlanInterfaceIndexEntry list", "description": "Retrieve list of cviVlanInterfaceIndexEntry entries from MIB", "tags": [ "CISCO-VLAN-IFTABLE-RELATIONSHIP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "cviVlanInterfaceIndexEntry", "items": { "type": "object", "properties": { "cviVlanId": { "type": "string", "description": "The VLAN-id number of the routed VLAN interface.", "x-yang-type": "cisco-vtp:VlanIndex" }, "cviPhysicalIfIndex": { "type": "string", "description": "For subinterfaces, this object is the ifIndex of the\n physical interface for the subinterface.\n \n For Switch Virtual Interfaces (SVIs), this object is zero.", "x-yang-type": "cisco-tc:InterfaceIndexOrZero" }, "cviRoutedVlanIfIndex": { "type": "string", "description": "The index for the ifTable entry associated with\n this routed VLAN interface.", "x-yang-type": "if-mib:InterfaceIndex" } } } }, "example": { "CISCO-VLAN-IFTABLE-RELATIONSHIP-MIB:cviVlanInterfaceIndexEntry": [ { "cviVlanId": "example-string", "cviPhysicalIfIndex": "192.168.1.1", "cviRoutedVlanIfIndex": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cviVlanInterfaceIndexEntry-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": "/cviVlanInterfaceIndexEntry", "x-restconf-kind": "container" }, "/data/CISCO-VLAN-IFTABLE-RELATIONSHIP-MIB:cviVlanInterfaceIndexTable/cviVlanInterfaceIndexEntry={cviVlanId},{cviPhysicalIfIndex}": { "get": { "summary": "Get cviVlanInterfaceIndexEntry entry", "description": "Retrieve specific cviVlanInterfaceIndexEntry entry by key from MIB", "tags": [ "CISCO-VLAN-IFTABLE-RELATIONSHIP-MIB" ], "parameters": [ { "name": "cviVlanId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cviPhysicalIfIndex", "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": { "cviVlanId": { "type": "string", "description": "The VLAN-id number of the routed VLAN interface.", "x-yang-type": "cisco-vtp:VlanIndex" }, "cviPhysicalIfIndex": { "type": "string", "description": "For subinterfaces, this object is the ifIndex of the\n physical interface for the subinterface.\n \n For Switch Virtual Interfaces (SVIs), this object is zero.", "x-yang-type": "cisco-tc:InterfaceIndexOrZero" }, "cviRoutedVlanIfIndex": { "type": "string", "description": "The index for the ifTable entry associated with\n this routed VLAN interface.", "x-yang-type": "if-mib:InterfaceIndex" } } }, "example": { "CISCO-VLAN-IFTABLE-RELATIONSHIP-MIB:cviVlanInterfaceIndexEntry": { "cviVlanId": "example-string", "cviPhysicalIfIndex": "192.168.1.1", "cviRoutedVlanIfIndex": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cviVlanInterfaceIndexEntry-2" }, "x-yang-path": "/cviVlanInterfaceIndexTable/cviVlanInterfaceIndexEntry={cviVlanId cviPhysicalIfIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cviVlanId cviPhysicalIfIndex" ] }, "/data/CISCO-VLAN-IFTABLE-RELATIONSHIP-MIB:cviVlanInterfaceIndexEntry={cviVlanId},{cviPhysicalIfIndex}": { "get": { "summary": "Get cviVlanInterfaceIndexEntry entry", "description": "Retrieve specific cviVlanInterfaceIndexEntry entry by key from MIB", "tags": [ "CISCO-VLAN-IFTABLE-RELATIONSHIP-MIB" ], "parameters": [ { "name": "cviVlanId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cviPhysicalIfIndex", "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": { "cviVlanId": { "type": "string", "description": "The VLAN-id number of the routed VLAN interface.", "x-yang-type": "cisco-vtp:VlanIndex" }, "cviPhysicalIfIndex": { "type": "string", "description": "For subinterfaces, this object is the ifIndex of the\n physical interface for the subinterface.\n \n For Switch Virtual Interfaces (SVIs), this object is zero.", "x-yang-type": "cisco-tc:InterfaceIndexOrZero" }, "cviRoutedVlanIfIndex": { "type": "string", "description": "The index for the ifTable entry associated with\n this routed VLAN interface.", "x-yang-type": "if-mib:InterfaceIndex" } } }, "example": { "CISCO-VLAN-IFTABLE-RELATIONSHIP-MIB:cviVlanInterfaceIndexEntry": { "cviVlanId": "example-string", "cviPhysicalIfIndex": "192.168.1.1", "cviRoutedVlanIfIndex": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cviVlanInterfaceIndexEntry-4" }, "x-yang-path": "/cviVlanInterfaceIndexEntry={cviVlanId cviPhysicalIfIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cviVlanId cviPhysicalIfIndex" ] } }, "components": { "schemas": { "CISCO-VLAN-IFTABLE-RELATIONSHIP-MIB_CISCO-VLAN-IFTABLE-RELATIONSHIP-MIB": { "type": "object", "description": "CISCO-VLAN-IFTABLE-RELATIONSHIP-MIB", "properties": { "cviVlanInterfaceIndexEntry": { "type": "array", "description": "cviVlanInterfaceIndexEntry", "items": { "type": "object", "properties": { "cviVlanId": { "type": "string", "description": "The VLAN-id number of the routed VLAN interface.", "x-yang-type": "cisco-vtp:VlanIndex", "readOnly": true }, "cviPhysicalIfIndex": { "type": "string", "description": "For subinterfaces, this object is the ifIndex of the\n physical interface for the subinterface.\n \n For Switch Virtual Interfaces (SVIs), this object is zero.", "x-yang-type": "cisco-tc:InterfaceIndexOrZero", "readOnly": true }, "cviRoutedVlanIfIndex": { "type": "string", "description": "The index for the ifTable entry associated with\n this routed VLAN interface.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true } } }, "readOnly": true }, "cviVlanInterfaceIndexTable": { "type": "object", "description": "cviVlanInterfaceIndexTable", "properties": { "cviVlanInterfaceIndexEntry": { "type": "array", "description": "cviVlanInterfaceIndexEntry", "items": { "type": "object", "properties": { "cviVlanId": { "type": "string", "description": "The VLAN-id number of the routed VLAN interface.", "x-yang-type": "cisco-vtp:VlanIndex", "readOnly": true }, "cviPhysicalIfIndex": { "type": "string", "description": "For subinterfaces, this object is the ifIndex of the\n physical interface for the subinterface.\n \n For Switch Virtual Interfaces (SVIs), this object is zero.", "x-yang-type": "cisco-tc:InterfaceIndexOrZero", "readOnly": true }, "cviRoutedVlanIfIndex": { "type": "string", "description": "The index for the ifTable entry associated with\n this routed VLAN interface.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true } } }, "readOnly": true } }, "readOnly": true } } }, "CISCO-VLAN-IFTABLE-RELATIONSHIP-MIB_cviVlanInterfaceIndexEntry": { "type": "array", "description": "cviVlanInterfaceIndexEntry", "items": { "type": "object", "properties": { "cviVlanId": { "type": "string", "description": "The VLAN-id number of the routed VLAN interface.", "x-yang-type": "cisco-vtp:VlanIndex", "readOnly": true }, "cviPhysicalIfIndex": { "type": "string", "description": "For subinterfaces, this object is the ifIndex of the\n physical interface for the subinterface.\n \n For Switch Virtual Interfaces (SVIs), this object is zero.", "x-yang-type": "cisco-tc:InterfaceIndexOrZero", "readOnly": true }, "cviRoutedVlanIfIndex": { "type": "string", "description": "The index for the ifTable entry associated with\n this routed VLAN interface.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true } } } }, "restconf-error": { "type": "object", "description": "Standard RESTCONF error response (RFC 8040 Section 7.1)", "properties": { "ietf-restconf:errors": { "type": "object", "properties": { "error": { "type": "array", "items": { "type": "object", "properties": { "error-type": { "type": "string", "enum": [ "transport", "rpc", "protocol", "application" ], "description": "Layer where the error occurred" }, "error-tag": { "type": "string", "description": "Enumerated error tag (e.g. invalid-value, data-missing, access-denied)" }, "error-severity": { "type": "string", "enum": [ "error", "warning" ], "description": "Error severity" }, "error-app-tag": { "type": "string", "description": "Application-specific error tag" }, "error-path": { "type": "string", "description": "YANG instance-identifier of the error node" }, "error-message": { "type": "string", "description": "Human-readable error description" } }, "required": [ "error-type", "error-tag" ] } } } } }, "example": { "ietf-restconf:errors": { "error": [ { "error-type": "protocol", "error-tag": "invalid-value", "error-severity": "error", "error-message": "Invalid input parameter" } ] } } } }, "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic" } } }, "security": [ { "basicAuth": [] } ], "tags": [ { "name": "CISCO-VLAN-IFTABLE-RELATIONSHIP-MIB", "description": "MIB operations for CISCO-VLAN-IFTABLE-RELATIONSHIP-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }