{ "openapi": "3.0.0", "info": { "title": "CISCO-VTP-MIB MIB API", "version": "1.0.0", "description": "The MIB module for entities implementing the VTP\n protocol and Vlan management.\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-VTP-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/CISCO-VTP-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "CISCO-VTP-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-VTP-MIB:vtpStatus": { "get": { "summary": "Get vtpStatus data", "description": "Retrieve vtpStatus operational data from MIB", "tags": [ "CISCO-VTP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "vtpStatus", "properties": { "vtpVersion": { "type": "string", "description": "The version of VTP in use on the local system. A device\n will report its version capability and not any particular\n version in use on the device. If the device does not support\n vtp, the version is none(3)." }, "vtpMaxVlanStorage": { "type": "integer", "description": "An estimate of the maximum number of VLANs about which the\n local system can recover complete VTP information after a\n reboot. If the number of defined VLANs is greater than this\n value, then the system can not act as a VTP Server. For a\n device which has no means to calculate the estimated number,\n this value is -1.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpNotificationsEnabled": { "type": "boolean", "description": "An indication of whether the notifications/traps defined by\n the vtpConfigNotificationsGroup, vtpConfigNotificationsGroup2,\n and vtpConfigNotificationsGroup8 are enabled." }, "vtpVlanCreatedNotifEnabled": { "type": "boolean", "description": "An indication of whether the notification should\n be generated when a VLAN is created. \n \n If the value of this object is 'true' then the\n vtpVlanCreated notification will be generated.\n \n If the value of this object is 'false' then the\n vtpVlanCreated notification will not be generated." }, "vtpVlanDeletedNotifEnabled": { "type": "boolean", "description": "An indication of whether the notification should\n be generated when a VLAN is deleted. \n \n If the value of this object is 'true' then the\n vtpVlanDeleted notification will be generated.\n \n If the value of this object is 'false' then the\n vtpVlanDeleted notification will not be generated." } } }, "example": { "CISCO-VTP-MIB:vtpStatus": { "vtpVersion": "example-string", "vtpMaxVlanStorage": -2147483648, "vtpNotificationsEnabled": true, "vtpVlanCreatedNotifEnabled": true, "vtpVlanDeletedNotifEnabled": true } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vtpStatus", "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": "/vtpStatus", "x-restconf-kind": "container" }, "/data/CISCO-VTP-MIB:internalVlanInfo": { "get": { "summary": "Get internalVlanInfo data", "description": "Retrieve internalVlanInfo operational data from MIB", "tags": [ "CISCO-VTP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "internalVlanInfo", "properties": { "vtpInternalVlanAllocPolicy": { "type": "string", "description": "The internal VLAN allocation policy.\n \n 'ascending' - internal VLANs are allocated\n starting from a lowwer VLAN ID and \n upwards.\n 'descending' - internal VLANs are allocated\n starting from a higher VLAN ID and\n downwards." } } }, "example": { "CISCO-VTP-MIB:internalVlanInfo": { "vtpInternalVlanAllocPolicy": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-internalVlanInfo", "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": "/internalVlanInfo", "x-restconf-kind": "container" }, "/data/CISCO-VTP-MIB:vlanTrunkPorts": { "get": { "summary": "Get vlanTrunkPorts data", "description": "Retrieve vlanTrunkPorts operational data from MIB", "tags": [ "CISCO-VTP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "An advisory lock used to allow several cooperating SNMPv2\n managers to coordinate their use of the SNMPv2 set operation\n acting upon any instance of vlanTrunkPortVlansEnabled.", "properties": { "vlanTrunkPortSetSerialNo": { "type": "string", "description": "An advisory lock used to allow several cooperating SNMPv2\n managers to coordinate their use of the SNMPv2 set operation\n acting upon any instance of vlanTrunkPortVlansEnabled.", "x-yang-type": "snmpv2-tc:TestAndIncr" }, "vlanTrunkPortsDot1qTag": { "type": "boolean", "description": "An indication of whether the tagging on all VLANs including\n native VLAN for all 802.1q trunks is enabled.\n \n If this object has a value of true(1) then all VLANs\n including native VLAN are tagged. If the value is false(2)\n then all VLANs excluding native VLAN are tagged.\n \n This object has been deprecated and is replaced by the\n object 'cltcDot1qAllTaggedEnabled' in the\n CISCO-L2-TUNNEL-CONFIG-MIB" } } }, "example": { "CISCO-VTP-MIB:vlanTrunkPorts": { "vlanTrunkPortSetSerialNo": "example-string", "vlanTrunkPortsDot1qTag": true } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vlanTrunkPorts", "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": "/vlanTrunkPorts", "x-restconf-kind": "container" }, "/data/CISCO-VTP-MIB:vlanStatistics": { "get": { "summary": "Get vlanStatistics data", "description": "Retrieve vlanStatistics operational data from MIB", "tags": [ "CISCO-VTP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This object indicates the number of the existing\n manageable VLANs with VLAN indices from 1 to\n 1024 in the system.", "properties": { "vlanStatsVlans": { "type": "integer", "description": "This object indicates the number of the existing\n manageable VLANs with VLAN indices from 1 to\n 1024 in the system.", "minimum": 0, "maximum": 4294967295 }, "vlanStatsExtendedVlans": { "type": "integer", "description": "This object indicates the number of the\n existing manageable VLANs with VLAN indices\n greater than 1024 in the system.", "minimum": 0, "maximum": 4294967295 }, "vlanStatsInternalVlans": { "type": "integer", "description": "This object indicates the number of the\n internal VLANs existing in the system.", "minimum": 0, "maximum": 4294967295 }, "vlanStatsFreeVlans": { "type": "integer", "description": "This object indicates the number of the\n free or unused VLANs in the system.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-VTP-MIB:vlanStatistics": { "vlanStatsVlans": 0, "vlanStatsExtendedVlans": 0, "vlanStatsInternalVlans": 0, "vlanStatsFreeVlans": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vlanStatistics", "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": "/vlanStatistics", "x-restconf-kind": "container" }, "/data/CISCO-VTP-MIB:managementDomainTable": { "get": { "summary": "Get managementDomainTable data", "description": "Retrieve managementDomainTable operational data from MIB", "tags": [ "CISCO-VTP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "managementDomainTable", "properties": { "managementDomainEntry": { "type": "array", "description": "Information about the status of one management domain.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "An arbitrary value to uniquely identify the management\n domain on the local system.", "x-yang-type": "CISCO-VTP-MIB:ManagementDomainIndex" }, "managementDomainName": { "type": "string", "description": "The management name of a domain in which the local system\n is participating. The zero-length name corresponds to the\n 'no management-domain' state which is the initial value at\n installation-time if not configured otherwise. Note that\n the zero-length name does not correspond to an operational\n management domain, and a device does not send VTP\n advertisements while in the 'no management-domain' state. A\n device leaves the 'no management-domain' state when it\n obtains a management-domain name, either through\n configuration or through inheriting the management-domain\n name from a received VTP advertisement.\n \n When the value of an existing instance of this object is\n modified by network management, the local system should re-\n initialize its VLAN information (for the given management\n domain) as if it had just been configured with a management\n domain name at installation time.", "x-yang-type": "snmpv2-tc:DisplayString" }, "managementDomainLocalMode": { "type": "string", "description": "The local VTP mode in this management domain when\n managementDomainVersionInUse is version1(1) or\n version2(2).\n \n If managementDomainVersionInUse is version3(4), this \n object has the same value with vtpDatabaseLocalMode \n of VLAN database type.\n \n - 'client' indicates that the local system is acting\n as a VTP client.\n \n - 'server' indicates that the local system is acting\n as a VTP server.\n \n - 'transparent' indicates that the local system does\n not generate or listen to VTP messages, but forwards\n messages. This mode can also be set by the device\n itself when the amount of VLAN information is too\n large for it to hold in DRAM.\n \n - 'off' indicates that the local system does not\n generate, listen to or forward any VTP messages." }, "managementDomainConfigRevNumber": { "type": "integer", "description": "The current Configuration Revision Number as known by\n the local device for this management domain when \n managementDomainVersionInUse is version1(1) or \n version2(2).\n \n If managementDomainVersionInUse is version3(4), this \n object has the same value with vtpDatabaseRevisionNumber \n of VLAN database type.\n \n This value is updated (if necessary) whenever a VTP\n advertisement is received or generated. When in the\n 'no management-domain' state, this value is 0.", "minimum": 0, "maximum": 4294967295 }, "managementDomainLastUpdater": { "type": "string", "description": "The IP-address (or one of them) of the VTP Server which\n last updated the Configuration Revision Number, as indicated\n in the most recently received VTP advertisement for this\n management domain, when managementDomainVersionInUse is\n version1(1) or version2(2). \n \n If managementDomainVersionInUse is version3(4), this object\n has the value of 0.0.0.0.\n \n Before an advertisement has been received, this value is\n 0.0.0.0.", "format": "inet:ipv4-address" }, "managementDomainLastChange": { "type": "string", "description": "The time at which the Configuration Revision Number was\n (last) increased to its current value, as indicated in the\n most recently received VTP advertisement for this management\n domain when managementDomainVersionInUse is not version3(4)\n or in the most recently received VTP VLAN database \n advertisement for this management domain when \n managementDomainVersionInUse is version3(4).\n \n The value 0x0000010100000000 indicates that the device which\n last increased the Configuration Revision Number had no idea\n of the date/time, or that no advertisement has been\n received.", "x-yang-type": "snmpv2-tc:DateAndTime" }, "managementDomainRowStatus": { "type": "string", "description": "The status of this conceptual row.", "x-yang-type": "snmpv2-tc:RowStatus" }, "managementDomainTftpServer": { "type": "string", "description": "The IP address of a TFTP Server in/from which VTP VLAN\n information for this management domain is to be\n stored/retrieved. If the information is being locally\n stored in NVRAM, this object should take the value 0.0.0.0.", "format": "inet:ipv4-address" }, "managementDomainTftpPathname": { "type": "string", "description": "The complete pathname of the file at the TFTP Server\n identified by the value of managementDomainTftpServer\n in/from which VTP VLAN information for this management\n domain is to be stored/retrieved. If the value of\n corresponding instance of managementDomainTftpServer is\n 0.0.0.0, the value of this object is ignored.", "x-yang-type": "snmpv2-tc:DisplayString" }, "managementDomainPruningState": { "type": "string", "description": "An indication of whether VTP pruning is enabled or disabled\n in this managament domain. \n \n This object can only be modified, either when the \n corresponding instance value of managementDomainVersionInUse \n is 'version1' or 'version2' and the corresponding instance \n value of managementDomainLocalMode is 'server', or when the \n corresponding instance value of managementDomainVersionInUse \n is 'version3' and the corresponding instance value of \n managementDomainLocalMode is 'server' or 'client'." }, "managementDomainVersionInUse": { "type": "string", "description": "The current version of the VTP that is in use by the\n designated management domain. \n \n This object can be set to none(3) only when \n vtpVersion is none(3)." }, "managementDomainPruningStateOper": { "type": "string", "description": "Indicates whether VTP pruning is operationally enabled or\n disabled in this managament domain." }, "managementDomainAdminSrcIf": { "type": "string", "description": "The object specifies the interface to be used as the\n preferred source interface for the VTP IP updater address.\n \n A zero length value indicates that a source interface is not\n specified.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "managementDomainSourceOnlyMode": { "type": "boolean", "description": "The object specifies whether to use only the IP address of\n managementDomainAdminSrcIf as the VTP IP updater address. \n \n 'true' indicates to only use the IP address of \n managementDomainAdminSrcIf as the VTP IP \n updater address. \n \n 'false' indicates to use the IP address of \n managementDomainAdminSrcIf as the VTP IP \n updater address if managementDomainAdminSrcIf \n is configured with an IP address. Otherwise, the \n first available IP address of the system will\n be used." }, "managementDomainOperSrcIf": { "type": "string", "description": "The object indicates the interface used as the\n preferred source interface for the VTP IP updater address.\n \n A zero length string indicates that a source interface is not\n available.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "managementDomainConfigFile": { "type": "string", "description": "The object specifies the file name where VTP configuration\n is stored in the format of or :[].\n \n can be (but not limited to): flash, bootflash,\n slot0, slot1, disk0.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "managementDomainLocalUpdaterType": { "type": "string", "description": "The object indicates the type of the Internet address\n of the preferred source interface for the VTP IP updater.\n \n The value of this object is 'unknown' if\n managementDomainVersionInUse is 'version3' or\n managementDomainLocalMode is not 'server'.", "x-yang-type": "inet-address:InetAddressType" }, "managementDomainLocalUpdater": { "type": "string", "description": "The object indicates the Internet address of the\n preferred source interface for the VTP IP updater.", "x-yang-type": "inet-address:InetAddress" }, "managementDomainDeviceID": { "type": "string", "description": "The object indicates a value that uniquely identifies\n this device within a VTP Domain.\n \n The value of this object is zero length string if\n managementDomainVersionInUse is not 'version3'.", "x-yang-type": "snmp-framework:SnmpAdminString" } } } } } }, "example": { "CISCO-VTP-MIB:managementDomainTable": { "managementDomainEntry": [ { "managementDomainIndex": "1", "managementDomainName": "interface-1", "managementDomainLocalMode": "example-string", "managementDomainConfigRevNumber": 0, "managementDomainLastUpdater": "example-string", "managementDomainLastChange": "example-string", "managementDomainRowStatus": "up(1)", "managementDomainTftpServer": "example-string", "managementDomainTftpPathname": "interface-1", "managementDomainPruningState": "up(1)", "managementDomainVersionInUse": "example-string", "managementDomainPruningStateOper": "up(1)", "managementDomainAdminSrcIf": "example-string", "managementDomainSourceOnlyMode": true, "managementDomainOperSrcIf": "example-string", "managementDomainConfigFile": "example-string", "managementDomainLocalUpdaterType": "ethernetCsmacd(6)", "managementDomainLocalUpdater": "example-string", "managementDomainDeviceID": "example-string" }, { "managementDomainIndex": "2", "managementDomainName": "interface-1", "managementDomainLocalMode": "example-string", "managementDomainConfigRevNumber": 0, "managementDomainLastUpdater": "example-string", "managementDomainLastChange": "example-string", "managementDomainRowStatus": "up(1)", "managementDomainTftpServer": "example-string", "managementDomainTftpPathname": "interface-1", "managementDomainPruningState": "up(1)", "managementDomainVersionInUse": "example-string", "managementDomainPruningStateOper": "up(1)", "managementDomainAdminSrcIf": "example-string", "managementDomainSourceOnlyMode": true, "managementDomainOperSrcIf": "example-string", "managementDomainConfigFile": "example-string", "managementDomainLocalUpdaterType": "ethernetCsmacd(6)", "managementDomainLocalUpdater": "example-string", "managementDomainDeviceID": "example-string" }, { "managementDomainIndex": "3", "managementDomainName": "interface-1", "managementDomainLocalMode": "example-string", "managementDomainConfigRevNumber": 0, "managementDomainLastUpdater": "example-string", "managementDomainLastChange": "example-string", "managementDomainRowStatus": "up(1)", "managementDomainTftpServer": "example-string", "managementDomainTftpPathname": "interface-1", "managementDomainPruningState": "up(1)", "managementDomainVersionInUse": "example-string", "managementDomainPruningStateOper": "up(1)", "managementDomainAdminSrcIf": "example-string", "managementDomainSourceOnlyMode": true, "managementDomainOperSrcIf": "example-string", "managementDomainConfigFile": "example-string", "managementDomainLocalUpdaterType": "ethernetCsmacd(6)", "managementDomainLocalUpdater": "example-string", "managementDomainDeviceID": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-managementDomainTable", "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": "/managementDomainTable", "x-restconf-kind": "container" }, "/data/CISCO-VTP-MIB:managementDomainTable/managementDomainEntry": { "get": { "summary": "Get managementDomainEntry list", "description": "Retrieve list of managementDomainEntry entries from MIB", "tags": [ "CISCO-VTP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Information about the status of one management domain.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "An arbitrary value to uniquely identify the management\n domain on the local system.", "x-yang-type": "CISCO-VTP-MIB:ManagementDomainIndex" }, "managementDomainName": { "type": "string", "description": "The management name of a domain in which the local system\n is participating. The zero-length name corresponds to the\n 'no management-domain' state which is the initial value at\n installation-time if not configured otherwise. Note that\n the zero-length name does not correspond to an operational\n management domain, and a device does not send VTP\n advertisements while in the 'no management-domain' state. A\n device leaves the 'no management-domain' state when it\n obtains a management-domain name, either through\n configuration or through inheriting the management-domain\n name from a received VTP advertisement.\n \n When the value of an existing instance of this object is\n modified by network management, the local system should re-\n initialize its VLAN information (for the given management\n domain) as if it had just been configured with a management\n domain name at installation time.", "x-yang-type": "snmpv2-tc:DisplayString" }, "managementDomainLocalMode": { "type": "string", "description": "The local VTP mode in this management domain when\n managementDomainVersionInUse is version1(1) or\n version2(2).\n \n If managementDomainVersionInUse is version3(4), this \n object has the same value with vtpDatabaseLocalMode \n of VLAN database type.\n \n - 'client' indicates that the local system is acting\n as a VTP client.\n \n - 'server' indicates that the local system is acting\n as a VTP server.\n \n - 'transparent' indicates that the local system does\n not generate or listen to VTP messages, but forwards\n messages. This mode can also be set by the device\n itself when the amount of VLAN information is too\n large for it to hold in DRAM.\n \n - 'off' indicates that the local system does not\n generate, listen to or forward any VTP messages." }, "managementDomainConfigRevNumber": { "type": "integer", "description": "The current Configuration Revision Number as known by\n the local device for this management domain when \n managementDomainVersionInUse is version1(1) or \n version2(2).\n \n If managementDomainVersionInUse is version3(4), this \n object has the same value with vtpDatabaseRevisionNumber \n of VLAN database type.\n \n This value is updated (if necessary) whenever a VTP\n advertisement is received or generated. When in the\n 'no management-domain' state, this value is 0.", "minimum": 0, "maximum": 4294967295 }, "managementDomainLastUpdater": { "type": "string", "description": "The IP-address (or one of them) of the VTP Server which\n last updated the Configuration Revision Number, as indicated\n in the most recently received VTP advertisement for this\n management domain, when managementDomainVersionInUse is\n version1(1) or version2(2). \n \n If managementDomainVersionInUse is version3(4), this object\n has the value of 0.0.0.0.\n \n Before an advertisement has been received, this value is\n 0.0.0.0.", "format": "inet:ipv4-address" }, "managementDomainLastChange": { "type": "string", "description": "The time at which the Configuration Revision Number was\n (last) increased to its current value, as indicated in the\n most recently received VTP advertisement for this management\n domain when managementDomainVersionInUse is not version3(4)\n or in the most recently received VTP VLAN database \n advertisement for this management domain when \n managementDomainVersionInUse is version3(4).\n \n The value 0x0000010100000000 indicates that the device which\n last increased the Configuration Revision Number had no idea\n of the date/time, or that no advertisement has been\n received.", "x-yang-type": "snmpv2-tc:DateAndTime" }, "managementDomainRowStatus": { "type": "string", "description": "The status of this conceptual row.", "x-yang-type": "snmpv2-tc:RowStatus" }, "managementDomainTftpServer": { "type": "string", "description": "The IP address of a TFTP Server in/from which VTP VLAN\n information for this management domain is to be\n stored/retrieved. If the information is being locally\n stored in NVRAM, this object should take the value 0.0.0.0.", "format": "inet:ipv4-address" }, "managementDomainTftpPathname": { "type": "string", "description": "The complete pathname of the file at the TFTP Server\n identified by the value of managementDomainTftpServer\n in/from which VTP VLAN information for this management\n domain is to be stored/retrieved. If the value of\n corresponding instance of managementDomainTftpServer is\n 0.0.0.0, the value of this object is ignored.", "x-yang-type": "snmpv2-tc:DisplayString" }, "managementDomainPruningState": { "type": "string", "description": "An indication of whether VTP pruning is enabled or disabled\n in this managament domain. \n \n This object can only be modified, either when the \n corresponding instance value of managementDomainVersionInUse \n is 'version1' or 'version2' and the corresponding instance \n value of managementDomainLocalMode is 'server', or when the \n corresponding instance value of managementDomainVersionInUse \n is 'version3' and the corresponding instance value of \n managementDomainLocalMode is 'server' or 'client'." }, "managementDomainVersionInUse": { "type": "string", "description": "The current version of the VTP that is in use by the\n designated management domain. \n \n This object can be set to none(3) only when \n vtpVersion is none(3)." }, "managementDomainPruningStateOper": { "type": "string", "description": "Indicates whether VTP pruning is operationally enabled or\n disabled in this managament domain." }, "managementDomainAdminSrcIf": { "type": "string", "description": "The object specifies the interface to be used as the\n preferred source interface for the VTP IP updater address.\n \n A zero length value indicates that a source interface is not\n specified.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "managementDomainSourceOnlyMode": { "type": "boolean", "description": "The object specifies whether to use only the IP address of\n managementDomainAdminSrcIf as the VTP IP updater address. \n \n 'true' indicates to only use the IP address of \n managementDomainAdminSrcIf as the VTP IP \n updater address. \n \n 'false' indicates to use the IP address of \n managementDomainAdminSrcIf as the VTP IP \n updater address if managementDomainAdminSrcIf \n is configured with an IP address. Otherwise, the \n first available IP address of the system will\n be used." }, "managementDomainOperSrcIf": { "type": "string", "description": "The object indicates the interface used as the\n preferred source interface for the VTP IP updater address.\n \n A zero length string indicates that a source interface is not\n available.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "managementDomainConfigFile": { "type": "string", "description": "The object specifies the file name where VTP configuration\n is stored in the format of or :[].\n \n can be (but not limited to): flash, bootflash,\n slot0, slot1, disk0.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "managementDomainLocalUpdaterType": { "type": "string", "description": "The object indicates the type of the Internet address\n of the preferred source interface for the VTP IP updater.\n \n The value of this object is 'unknown' if\n managementDomainVersionInUse is 'version3' or\n managementDomainLocalMode is not 'server'.", "x-yang-type": "inet-address:InetAddressType" }, "managementDomainLocalUpdater": { "type": "string", "description": "The object indicates the Internet address of the\n preferred source interface for the VTP IP updater.", "x-yang-type": "inet-address:InetAddress" }, "managementDomainDeviceID": { "type": "string", "description": "The object indicates a value that uniquely identifies\n this device within a VTP Domain.\n \n The value of this object is zero length string if\n managementDomainVersionInUse is not 'version3'.", "x-yang-type": "snmp-framework:SnmpAdminString" } } } }, "example": { "CISCO-VTP-MIB:managementDomainEntry": [ { "managementDomainIndex": "example-string", "managementDomainName": "interface-1", "managementDomainLocalMode": "example-string", "managementDomainConfigRevNumber": 0, "managementDomainLastUpdater": "example-string", "managementDomainLastChange": "example-string", "managementDomainRowStatus": "up(1)", "managementDomainTftpServer": "example-string", "managementDomainTftpPathname": "interface-1", "managementDomainPruningState": "up(1)", "managementDomainVersionInUse": "example-string", "managementDomainPruningStateOper": "up(1)", "managementDomainAdminSrcIf": "example-string", "managementDomainSourceOnlyMode": true, "managementDomainOperSrcIf": "example-string", "managementDomainConfigFile": "example-string", "managementDomainLocalUpdaterType": "ethernetCsmacd(6)", "managementDomainLocalUpdater": "example-string", "managementDomainDeviceID": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-managementDomainEntry", "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": "/managementDomainTable/managementDomainEntry", "x-restconf-kind": "container" }, "/data/CISCO-VTP-MIB:managementDomainTable/managementDomainEntry={managementDomainIndex}": { "get": { "summary": "Get managementDomainEntry entry", "description": "Retrieve specific managementDomainEntry entry by key from MIB", "tags": [ "CISCO-VTP-MIB" ], "parameters": [ { "name": "managementDomainIndex", "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": { "managementDomainIndex": { "type": "string", "description": "An arbitrary value to uniquely identify the management\n domain on the local system.", "x-yang-type": "CISCO-VTP-MIB:ManagementDomainIndex" }, "managementDomainName": { "type": "string", "description": "The management name of a domain in which the local system\n is participating. The zero-length name corresponds to the\n 'no management-domain' state which is the initial value at\n installation-time if not configured otherwise. Note that\n the zero-length name does not correspond to an operational\n management domain, and a device does not send VTP\n advertisements while in the 'no management-domain' state. A\n device leaves the 'no management-domain' state when it\n obtains a management-domain name, either through\n configuration or through inheriting the management-domain\n name from a received VTP advertisement.\n \n When the value of an existing instance of this object is\n modified by network management, the local system should re-\n initialize its VLAN information (for the given management\n domain) as if it had just been configured with a management\n domain name at installation time.", "x-yang-type": "snmpv2-tc:DisplayString" }, "managementDomainLocalMode": { "type": "string", "description": "The local VTP mode in this management domain when\n managementDomainVersionInUse is version1(1) or\n version2(2).\n \n If managementDomainVersionInUse is version3(4), this \n object has the same value with vtpDatabaseLocalMode \n of VLAN database type.\n \n - 'client' indicates that the local system is acting\n as a VTP client.\n \n - 'server' indicates that the local system is acting\n as a VTP server.\n \n - 'transparent' indicates that the local system does\n not generate or listen to VTP messages, but forwards\n messages. This mode can also be set by the device\n itself when the amount of VLAN information is too\n large for it to hold in DRAM.\n \n - 'off' indicates that the local system does not\n generate, listen to or forward any VTP messages." }, "managementDomainConfigRevNumber": { "type": "integer", "description": "The current Configuration Revision Number as known by\n the local device for this management domain when \n managementDomainVersionInUse is version1(1) or \n version2(2).\n \n If managementDomainVersionInUse is version3(4), this \n object has the same value with vtpDatabaseRevisionNumber \n of VLAN database type.\n \n This value is updated (if necessary) whenever a VTP\n advertisement is received or generated. When in the\n 'no management-domain' state, this value is 0.", "minimum": 0, "maximum": 4294967295 }, "managementDomainLastUpdater": { "type": "string", "description": "The IP-address (or one of them) of the VTP Server which\n last updated the Configuration Revision Number, as indicated\n in the most recently received VTP advertisement for this\n management domain, when managementDomainVersionInUse is\n version1(1) or version2(2). \n \n If managementDomainVersionInUse is version3(4), this object\n has the value of 0.0.0.0.\n \n Before an advertisement has been received, this value is\n 0.0.0.0.", "format": "inet:ipv4-address" }, "managementDomainLastChange": { "type": "string", "description": "The time at which the Configuration Revision Number was\n (last) increased to its current value, as indicated in the\n most recently received VTP advertisement for this management\n domain when managementDomainVersionInUse is not version3(4)\n or in the most recently received VTP VLAN database \n advertisement for this management domain when \n managementDomainVersionInUse is version3(4).\n \n The value 0x0000010100000000 indicates that the device which\n last increased the Configuration Revision Number had no idea\n of the date/time, or that no advertisement has been\n received.", "x-yang-type": "snmpv2-tc:DateAndTime" }, "managementDomainRowStatus": { "type": "string", "description": "The status of this conceptual row.", "x-yang-type": "snmpv2-tc:RowStatus" }, "managementDomainTftpServer": { "type": "string", "description": "The IP address of a TFTP Server in/from which VTP VLAN\n information for this management domain is to be\n stored/retrieved. If the information is being locally\n stored in NVRAM, this object should take the value 0.0.0.0.", "format": "inet:ipv4-address" }, "managementDomainTftpPathname": { "type": "string", "description": "The complete pathname of the file at the TFTP Server\n identified by the value of managementDomainTftpServer\n in/from which VTP VLAN information for this management\n domain is to be stored/retrieved. If the value of\n corresponding instance of managementDomainTftpServer is\n 0.0.0.0, the value of this object is ignored.", "x-yang-type": "snmpv2-tc:DisplayString" }, "managementDomainPruningState": { "type": "string", "description": "An indication of whether VTP pruning is enabled or disabled\n in this managament domain. \n \n This object can only be modified, either when the \n corresponding instance value of managementDomainVersionInUse \n is 'version1' or 'version2' and the corresponding instance \n value of managementDomainLocalMode is 'server', or when the \n corresponding instance value of managementDomainVersionInUse \n is 'version3' and the corresponding instance value of \n managementDomainLocalMode is 'server' or 'client'." }, "managementDomainVersionInUse": { "type": "string", "description": "The current version of the VTP that is in use by the\n designated management domain. \n \n This object can be set to none(3) only when \n vtpVersion is none(3)." }, "managementDomainPruningStateOper": { "type": "string", "description": "Indicates whether VTP pruning is operationally enabled or\n disabled in this managament domain." }, "managementDomainAdminSrcIf": { "type": "string", "description": "The object specifies the interface to be used as the\n preferred source interface for the VTP IP updater address.\n \n A zero length value indicates that a source interface is not\n specified.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "managementDomainSourceOnlyMode": { "type": "boolean", "description": "The object specifies whether to use only the IP address of\n managementDomainAdminSrcIf as the VTP IP updater address. \n \n 'true' indicates to only use the IP address of \n managementDomainAdminSrcIf as the VTP IP \n updater address. \n \n 'false' indicates to use the IP address of \n managementDomainAdminSrcIf as the VTP IP \n updater address if managementDomainAdminSrcIf \n is configured with an IP address. Otherwise, the \n first available IP address of the system will\n be used." }, "managementDomainOperSrcIf": { "type": "string", "description": "The object indicates the interface used as the\n preferred source interface for the VTP IP updater address.\n \n A zero length string indicates that a source interface is not\n available.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "managementDomainConfigFile": { "type": "string", "description": "The object specifies the file name where VTP configuration\n is stored in the format of or :[].\n \n can be (but not limited to): flash, bootflash,\n slot0, slot1, disk0.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "managementDomainLocalUpdaterType": { "type": "string", "description": "The object indicates the type of the Internet address\n of the preferred source interface for the VTP IP updater.\n \n The value of this object is 'unknown' if\n managementDomainVersionInUse is 'version3' or\n managementDomainLocalMode is not 'server'.", "x-yang-type": "inet-address:InetAddressType" }, "managementDomainLocalUpdater": { "type": "string", "description": "The object indicates the Internet address of the\n preferred source interface for the VTP IP updater.", "x-yang-type": "inet-address:InetAddress" }, "managementDomainDeviceID": { "type": "string", "description": "The object indicates a value that uniquely identifies\n this device within a VTP Domain.\n \n The value of this object is zero length string if\n managementDomainVersionInUse is not 'version3'.", "x-yang-type": "snmp-framework:SnmpAdminString" } } }, "example": { "CISCO-VTP-MIB:managementDomainEntry": { "managementDomainIndex": "example-string", "managementDomainName": "interface-1", "managementDomainLocalMode": "example-string", "managementDomainConfigRevNumber": 0, "managementDomainLastUpdater": "example-string", "managementDomainLastChange": "example-string", "managementDomainRowStatus": "up(1)", "managementDomainTftpServer": "example-string", "managementDomainTftpPathname": "interface-1", "managementDomainPruningState": "up(1)", "managementDomainVersionInUse": "example-string", "managementDomainPruningStateOper": "up(1)", "managementDomainAdminSrcIf": "example-string", "managementDomainSourceOnlyMode": true, "managementDomainOperSrcIf": "example-string", "managementDomainConfigFile": "example-string", "managementDomainLocalUpdaterType": "ethernetCsmacd(6)", "managementDomainLocalUpdater": "example-string", "managementDomainDeviceID": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-managementDomainEntry-2" }, "x-yang-path": "/managementDomainTable/managementDomainEntry={managementDomainIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "managementDomainIndex" ] }, "/data/CISCO-VTP-MIB:vtpVlanTable": { "get": { "summary": "Get vtpVlanTable data", "description": "Retrieve vtpVlanTable operational data from MIB", "tags": [ "CISCO-VTP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table contains information on the VLANs which\n currently exist.", "properties": { "vtpVlanEntry": { "type": "array", "description": "Information about one current VLAN. The\n managementDomainIndex value in the INDEX clause indicates\n which management domain the VLAN is in.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref" }, "vtpVlanIndex": { "type": "string", "description": "The VLAN-id of this VLAN on ISL or 802.1q trunks.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex" }, "vtpVlanState": { "type": "string", "description": "The state of this VLAN.\n \n The state 'mtuTooBigForDevice' indicates that this device\n cannot participate in this VLAN because the VLAN's MTU is\n larger than the device can support.\n \n The state 'mtuTooBigForTrunk' indicates that while this\n VLAN's MTU is supported by this device, it is too large for\n one or more of the device's trunk ports." }, "vtpVlanType": { "type": "string", "description": "The type of this VLAN.", "x-yang-type": "CISCO-VTP-MIB:VlanType" }, "vtpVlanName": { "type": "string", "description": "The name of this VLAN. This name is used as the ELAN-name\n for an ATM LAN-Emulation segment of this VLAN.", "x-yang-type": "snmpv2-tc:DisplayString" }, "vtpVlanMtu": { "type": "integer", "description": "The MTU size on this VLAN, defined as the size of largest\n MAC-layer (information field portion of the) data frame\n which can be transmitted on the VLAN.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanDot10Said": { "type": "string", "description": "The value of the 802.10 SAID field for this VLAN.", "format": "binary" }, "vtpVlanRingNumber": { "type": "integer", "description": "The ring number of this VLAN. This object is only\n instantiated when the value of the corresponding instance of\n vtpVlanType has a value of 'fddi' or 'tokenRing' and Source\n Routing is in use on this VLAN.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanBridgeNumber": { "type": "integer", "description": "The bridge number of the VTP-capable switches for this\n VLAN. This object is only instantiated for VLANs that are\n involved with emulating token ring segments.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanStpType": { "type": "string", "description": "The type of the Spanning Tree Protocol (STP) running on\n this VLAN. This object is only instanciated when the\n value of the corresponding instance of vtpVlanType has a\n value of 'fddiNet' or 'trNet'.\n \n The value returned by this object depends upon the value\n of the corresponding instance of vtpVlanEditStpType.\n \n - 'ieee' indicates IEEE STP is running exclusively.\n \n - 'ibm' indicates IBM STP is running exclusively.\n \n - 'hybrid' indicates a STP that allows a combination of\n IEEE and IBM is running.\n \n The 'hybrid' STP type results from tokenRing/fddi VLANs\n that are children of this trNet/fddiNet parent VLAN being\n configured in a combination of SRT and SRB\n vtpVlanBridgeTypes while the instance of\n vtpVlanEditStpType that corresponds to this object is set\n to 'auto'." }, "vtpVlanParentVlan": { "type": "string", "description": "The parent VLAN for this VLAN. This object is only\n instantiated when the value of the corresponding instance of\n vtpVlanType has a value of 'fddi' or 'tokenRing' and Source\n Routing is in use on this VLAN. The parent VLAN must have \n a vtpVlanType value of fddiNet(4) or trNet(5), \n respectively.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex" }, "vtpVlanTranslationalVlan1": { "type": "string", "description": "A VLAN to which this VLAN is being translational-bridged.\n If this value and the corresponding instance of\n vtpVlanTranslationalVlan2 are both zero, then this VLAN is\n not being translational-bridged.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex" }, "vtpVlanTranslationalVlan2": { "type": "string", "description": "Another VLAN, i.e., other than that indicated by\n vtpVlanTranslationalVlan1, to which this VLAN is being\n translational-bridged. If this value and the corresponding\n instance of vtpVlanTranslationalVlan1 are both zero, then\n this VLAN is not being translational-bridged.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex" }, "vtpVlanBridgeType": { "type": "string", "description": "The type of the Source Route bridging mode in use on this\n VLAN. This object is only instantiated when the value of \n the corresponding instance of vtpVlanType has a value of \n fddi(2) or tokenRing(3) and Source Routing is in use on\n this VLAN." }, "vtpVlanAreHopCount": { "type": "integer", "description": "The maximum number of bridge hops allowed in\n All Routes Explorer frames on this VLAN. This\n object is only instantiated when the value of the\n corresponding instance of vtpVlanType has a value of fddi(2)\n or tokenRing(3) and Source Routing is in use on this VLAN.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanSteHopCount": { "type": "integer", "description": "The maximum number of bridge hops allowed in\n Spanning Tree Explorer frames on this VLAN. This\n object is only instantiated when the value of the\n corresponding instance of vtpVlanType has a value of fddi(2)\n or tokenRing(3) and Source Routing is in use on this VLAN.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanIsCRFBackup": { "type": "boolean", "description": "True if this VLAN is of type trCrf and also is acting as\n a backup trCrf for the ISL distributed BRF" }, "vtpVlanTypeExt": { "type": "string", "description": "The additional type information of this VLAN.", "x-yang-type": "CISCO-VTP-MIB:VlanTypeExt" }, "vtpVlanIfIndex": { "type": "string", "description": "The value of the ifIndex corresponding to this VLAN ID.\n If the VLAN ID does not have its corresponding interface, \n this object has the value of zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero" } } } } } }, "example": { "CISCO-VTP-MIB:vtpVlanTable": { "vtpVlanEntry": [ { "managementDomainIndex": "1", "vtpVlanIndex": "1", "vtpVlanState": "up(1)", "vtpVlanType": "ethernetCsmacd(6)", "vtpVlanName": "interface-1", "vtpVlanMtu": 1500, "vtpVlanDot10Said": "example-string", "vtpVlanRingNumber": -2147483648, "vtpVlanBridgeNumber": -2147483648, "vtpVlanStpType": "ethernetCsmacd(6)", "vtpVlanParentVlan": "example-string", "vtpVlanTranslationalVlan1": "example-string", "vtpVlanTranslationalVlan2": "example-string", "vtpVlanBridgeType": "ethernetCsmacd(6)", "vtpVlanAreHopCount": -2147483648, "vtpVlanSteHopCount": -2147483648, "vtpVlanIsCRFBackup": true, "vtpVlanTypeExt": "ethernetCsmacd(6)", "vtpVlanIfIndex": "1" }, { "managementDomainIndex": "2", "vtpVlanIndex": "2", "vtpVlanState": "up(1)", "vtpVlanType": "ethernetCsmacd(6)", "vtpVlanName": "interface-1", "vtpVlanMtu": 1500, "vtpVlanDot10Said": "example-string", "vtpVlanRingNumber": -2147483648, "vtpVlanBridgeNumber": -2147483648, "vtpVlanStpType": "ethernetCsmacd(6)", "vtpVlanParentVlan": "example-string", "vtpVlanTranslationalVlan1": "example-string", "vtpVlanTranslationalVlan2": "example-string", "vtpVlanBridgeType": "ethernetCsmacd(6)", "vtpVlanAreHopCount": -2147483648, "vtpVlanSteHopCount": -2147483648, "vtpVlanIsCRFBackup": true, "vtpVlanTypeExt": "ethernetCsmacd(6)", "vtpVlanIfIndex": "2" }, { "managementDomainIndex": "3", "vtpVlanIndex": "3", "vtpVlanState": "up(1)", "vtpVlanType": "ethernetCsmacd(6)", "vtpVlanName": "interface-1", "vtpVlanMtu": 1500, "vtpVlanDot10Said": "example-string", "vtpVlanRingNumber": -2147483648, "vtpVlanBridgeNumber": -2147483648, "vtpVlanStpType": "ethernetCsmacd(6)", "vtpVlanParentVlan": "example-string", "vtpVlanTranslationalVlan1": "example-string", "vtpVlanTranslationalVlan2": "example-string", "vtpVlanBridgeType": "ethernetCsmacd(6)", "vtpVlanAreHopCount": -2147483648, "vtpVlanSteHopCount": -2147483648, "vtpVlanIsCRFBackup": true, "vtpVlanTypeExt": "ethernetCsmacd(6)", "vtpVlanIfIndex": "3" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vtpVlanTable", "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": "/vtpVlanTable", "x-restconf-kind": "container" }, "/data/CISCO-VTP-MIB:vtpVlanTable/vtpVlanEntry": { "get": { "summary": "Get vtpVlanEntry list", "description": "Retrieve list of vtpVlanEntry entries from MIB", "tags": [ "CISCO-VTP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Information about one current VLAN. The\n managementDomainIndex value in the INDEX clause indicates\n which management domain the VLAN is in.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref" }, "vtpVlanIndex": { "type": "string", "description": "The VLAN-id of this VLAN on ISL or 802.1q trunks.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex" }, "vtpVlanState": { "type": "string", "description": "The state of this VLAN.\n \n The state 'mtuTooBigForDevice' indicates that this device\n cannot participate in this VLAN because the VLAN's MTU is\n larger than the device can support.\n \n The state 'mtuTooBigForTrunk' indicates that while this\n VLAN's MTU is supported by this device, it is too large for\n one or more of the device's trunk ports." }, "vtpVlanType": { "type": "string", "description": "The type of this VLAN.", "x-yang-type": "CISCO-VTP-MIB:VlanType" }, "vtpVlanName": { "type": "string", "description": "The name of this VLAN. This name is used as the ELAN-name\n for an ATM LAN-Emulation segment of this VLAN.", "x-yang-type": "snmpv2-tc:DisplayString" }, "vtpVlanMtu": { "type": "integer", "description": "The MTU size on this VLAN, defined as the size of largest\n MAC-layer (information field portion of the) data frame\n which can be transmitted on the VLAN.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanDot10Said": { "type": "string", "description": "The value of the 802.10 SAID field for this VLAN.", "format": "binary" }, "vtpVlanRingNumber": { "type": "integer", "description": "The ring number of this VLAN. This object is only\n instantiated when the value of the corresponding instance of\n vtpVlanType has a value of 'fddi' or 'tokenRing' and Source\n Routing is in use on this VLAN.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanBridgeNumber": { "type": "integer", "description": "The bridge number of the VTP-capable switches for this\n VLAN. This object is only instantiated for VLANs that are\n involved with emulating token ring segments.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanStpType": { "type": "string", "description": "The type of the Spanning Tree Protocol (STP) running on\n this VLAN. This object is only instanciated when the\n value of the corresponding instance of vtpVlanType has a\n value of 'fddiNet' or 'trNet'.\n \n The value returned by this object depends upon the value\n of the corresponding instance of vtpVlanEditStpType.\n \n - 'ieee' indicates IEEE STP is running exclusively.\n \n - 'ibm' indicates IBM STP is running exclusively.\n \n - 'hybrid' indicates a STP that allows a combination of\n IEEE and IBM is running.\n \n The 'hybrid' STP type results from tokenRing/fddi VLANs\n that are children of this trNet/fddiNet parent VLAN being\n configured in a combination of SRT and SRB\n vtpVlanBridgeTypes while the instance of\n vtpVlanEditStpType that corresponds to this object is set\n to 'auto'." }, "vtpVlanParentVlan": { "type": "string", "description": "The parent VLAN for this VLAN. This object is only\n instantiated when the value of the corresponding instance of\n vtpVlanType has a value of 'fddi' or 'tokenRing' and Source\n Routing is in use on this VLAN. The parent VLAN must have \n a vtpVlanType value of fddiNet(4) or trNet(5), \n respectively.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex" }, "vtpVlanTranslationalVlan1": { "type": "string", "description": "A VLAN to which this VLAN is being translational-bridged.\n If this value and the corresponding instance of\n vtpVlanTranslationalVlan2 are both zero, then this VLAN is\n not being translational-bridged.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex" }, "vtpVlanTranslationalVlan2": { "type": "string", "description": "Another VLAN, i.e., other than that indicated by\n vtpVlanTranslationalVlan1, to which this VLAN is being\n translational-bridged. If this value and the corresponding\n instance of vtpVlanTranslationalVlan1 are both zero, then\n this VLAN is not being translational-bridged.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex" }, "vtpVlanBridgeType": { "type": "string", "description": "The type of the Source Route bridging mode in use on this\n VLAN. This object is only instantiated when the value of \n the corresponding instance of vtpVlanType has a value of \n fddi(2) or tokenRing(3) and Source Routing is in use on\n this VLAN." }, "vtpVlanAreHopCount": { "type": "integer", "description": "The maximum number of bridge hops allowed in\n All Routes Explorer frames on this VLAN. This\n object is only instantiated when the value of the\n corresponding instance of vtpVlanType has a value of fddi(2)\n or tokenRing(3) and Source Routing is in use on this VLAN.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanSteHopCount": { "type": "integer", "description": "The maximum number of bridge hops allowed in\n Spanning Tree Explorer frames on this VLAN. This\n object is only instantiated when the value of the\n corresponding instance of vtpVlanType has a value of fddi(2)\n or tokenRing(3) and Source Routing is in use on this VLAN.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanIsCRFBackup": { "type": "boolean", "description": "True if this VLAN is of type trCrf and also is acting as\n a backup trCrf for the ISL distributed BRF" }, "vtpVlanTypeExt": { "type": "string", "description": "The additional type information of this VLAN.", "x-yang-type": "CISCO-VTP-MIB:VlanTypeExt" }, "vtpVlanIfIndex": { "type": "string", "description": "The value of the ifIndex corresponding to this VLAN ID.\n If the VLAN ID does not have its corresponding interface, \n this object has the value of zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero" } } } }, "example": { "CISCO-VTP-MIB:vtpVlanEntry": [ { "managementDomainIndex": "example-string", "vtpVlanIndex": "example-string", "vtpVlanState": "up(1)", "vtpVlanType": "ethernetCsmacd(6)", "vtpVlanName": "interface-1", "vtpVlanMtu": 1500, "vtpVlanDot10Said": "example-string", "vtpVlanRingNumber": -2147483648, "vtpVlanBridgeNumber": -2147483648, "vtpVlanStpType": "ethernetCsmacd(6)", "vtpVlanParentVlan": "example-string", "vtpVlanTranslationalVlan1": "example-string", "vtpVlanTranslationalVlan2": "example-string", "vtpVlanBridgeType": "ethernetCsmacd(6)", "vtpVlanAreHopCount": -2147483648, "vtpVlanSteHopCount": -2147483648, "vtpVlanIsCRFBackup": true, "vtpVlanTypeExt": "ethernetCsmacd(6)", "vtpVlanIfIndex": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vtpVlanEntry", "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": "/vtpVlanTable/vtpVlanEntry", "x-restconf-kind": "container" }, "/data/CISCO-VTP-MIB:vtpInternalVlanTable": { "get": { "summary": "Get vtpInternalVlanTable data", "description": "Retrieve vtpInternalVlanTable operational data from MIB", "tags": [ "CISCO-VTP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "A vtpInternalVlanTable entry contains\n information on an existing internal\n VLAN. It is internally created by the\n device for a specific application program \n and hence owned by the application. \n It cannot be modified or deleted by (local \n or network) management.", "properties": { "vtpInternalVlanEntry": { "type": "array", "description": "Information about one current internal\n VLAN.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref" }, "vtpVlanIndex": { "type": "string", "description": "vtpVlanIndex", "x-yang-type": "leafref" }, "vtpInternalVlanOwner": { "type": "string", "description": "The program name of the internal VLAN's\n owner application. This internal VLAN\n is allocated by the device specifically\n for this application and no one else\n could create, modify or delete this \n VLAN.", "x-yang-type": "snmp-framework:SnmpAdminString" } } } } } }, "example": { "CISCO-VTP-MIB:vtpInternalVlanTable": { "vtpInternalVlanEntry": [ { "managementDomainIndex": "1", "vtpVlanIndex": "1", "vtpInternalVlanOwner": "example-string" }, { "managementDomainIndex": "2", "vtpVlanIndex": "2", "vtpInternalVlanOwner": "example-string" }, { "managementDomainIndex": "3", "vtpVlanIndex": "3", "vtpInternalVlanOwner": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vtpInternalVlanTable", "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": "/vtpInternalVlanTable", "x-restconf-kind": "container" }, "/data/CISCO-VTP-MIB:vtpInternalVlanTable/vtpInternalVlanEntry": { "get": { "summary": "Get vtpInternalVlanEntry list", "description": "Retrieve list of vtpInternalVlanEntry entries from MIB", "tags": [ "CISCO-VTP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Information about one current internal\n VLAN.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref" }, "vtpVlanIndex": { "type": "string", "description": "vtpVlanIndex", "x-yang-type": "leafref" }, "vtpInternalVlanOwner": { "type": "string", "description": "The program name of the internal VLAN's\n owner application. This internal VLAN\n is allocated by the device specifically\n for this application and no one else\n could create, modify or delete this \n VLAN.", "x-yang-type": "snmp-framework:SnmpAdminString" } } } }, "example": { "CISCO-VTP-MIB:vtpInternalVlanEntry": [ { "managementDomainIndex": "example-string", "vtpVlanIndex": "example-string", "vtpInternalVlanOwner": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vtpInternalVlanEntry", "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": "/vtpInternalVlanTable/vtpInternalVlanEntry", "x-restconf-kind": "container" }, "/data/CISCO-VTP-MIB:vtpVlanEditTable": { "get": { "summary": "Get vtpVlanEditTable data", "description": "Retrieve vtpVlanEditTable operational data from MIB", "tags": [ "CISCO-VTP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "vtpVlanEditTable", "properties": { "vtpVlanEditEntry": { "type": "array", "description": "Information about one VLAN in the Edit Buffer for a\n particular management domain.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref" }, "vtpVlanEditIndex": { "type": "string", "description": "The VLAN-id which this VLAN would have on ISL or\n 802.1q trunks.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex" }, "vtpVlanEditState": { "type": "string", "description": "The state which this VLAN would have." }, "vtpVlanEditType": { "type": "string", "description": "The type which this VLAN would have.\n An implementation may restrict access to this object.", "x-yang-type": "CISCO-VTP-MIB:VlanType" }, "vtpVlanEditName": { "type": "string", "description": "The name which this VLAN would have. This name would be\n used as the ELAN-name for an ATM LAN-Emulation segment of\n this VLAN.\n \n An implementation may restrict access to this object.", "x-yang-type": "snmpv2-tc:DisplayString" }, "vtpVlanEditMtu": { "type": "integer", "description": "The MTU size which this VLAN would have, defined as the\n size of largest MAC-layer (information field portion of the)\n data frame which can be transmitted on the VLAN.\n \n An implementation may restrict access to this object.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanEditDot10Said": { "type": "string", "description": "The value of the 802.10 SAID field which would be used for\n this VLAN.\n \n An implementation may restrict access to this object.", "format": "binary" }, "vtpVlanEditRingNumber": { "type": "integer", "description": "The ring number which would be used for this VLAN. This\n object is only instantiated when the value of the\n corresponding instance of vtpVlanEditType has a value of\n 'fddi' or 'tokenRing' and Source Routing is in use on \n this VLAN.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanEditBridgeNumber": { "type": "integer", "description": "The bridge number of the VTP-capable switches which would\n be used for this VLAN. This object is only instantiated\n when the value of the corresponding instance of\n vtpVlanEditType has a value of fddiNet(4) or trNet(5).", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanEditStpType": { "type": "string", "description": "The type of the Spanning Tree Protocol which would be\n running on this VLAN. This object is only instantiated\n when the value of the corresponding instance of\n vtpVlanEditType has a value of fddiNet(4) or trNet(5).\n \n If 'ieee' is selected, the STP that runs will be IEEE.\n \n If 'ibm' is selected, the STP that runs will be IBM.\n \n If 'auto' is selected, the STP that runs will be\n dependant on the values of vtpVlanEditBridgeType for all\n children tokenRing/fddi type VLANs. This will result in\n a 'hybrid' STP (see vtpVlanStpType)." }, "vtpVlanEditParentVlan": { "type": "string", "description": "The VLAN index of the VLAN which would be the parent for\n this VLAN. This object is only instantiated when the value\n of the corresponding instance of vtpVlanEditType has a value\n of 'fddi' or 'tokenRing' and Source Routing is in use on\n this VLAN. The parent VLAN must have a vtpVlanEditType \n value of fddiNet(4) or trNet(5), respectively.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex" }, "vtpVlanEditRowStatus": { "type": "string", "description": "The status of this row. Any and all columnar objects in an\n existing row can be modified irrespective of the status of\n the row.\n \n A row is not qualified for activation until instances of at\n least its vtpVlanEditType, vtpVlanEditName and\n vtpVlanEditDot10Said columns have appropriate values.\n \n The management station should endeavor to make all rows\n consistent in the table before 'apply'ing the buffer. An\n inconsistent entry in the table will cause the entire\n buffer to be rejected with the vtpVlanApplyStatus object\n set to the appropriate error value.", "x-yang-type": "snmpv2-tc:RowStatus" }, "vtpVlanEditTranslationalVlan1": { "type": "string", "description": "A VLAN to which this VLAN would be translational-bridged.\n If this value and the corresponding instance of\n vtpVlanTranslationalVlan2 are both zero, then this VLAN\n would not be translational-bridged.\n \n An implementation may restrict access to this object.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex" }, "vtpVlanEditTranslationalVlan2": { "type": "string", "description": "Another VLAN, i.e., other than that indicated by\n vtpVlanEditTranslationalVlan1, to which this VLAN would be\n translational-bridged. If this value and the corresponding\n instance of vtpVlanTranslationalVlan1 are both zero, then\n this VLAN would not be translational-bridged.\n \n An implementation may restrict access to this object.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex" }, "vtpVlanEditBridgeType": { "type": "string", "description": "The type of Source Route bridging mode which would be in\n use on this VLAN. This object is only instantiated when \n the value of the corresponding instance of vtpVlanEditType\n has a value of fddi(2) or tokenRing(3) and Source Routing \n is in use on this VLAN." }, "vtpVlanEditAreHopCount": { "type": "integer", "description": "The maximum number of bridge hops allowed in\n All Routes Explorer frames on this VLAN. This\n object is only instantiated when the value of the\n corresponding instance of vtpVlanType has a value of fddi(2)\n or tokenRing(3) and Source Routing is in use on this VLAN.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanEditSteHopCount": { "type": "integer", "description": "The maximum number of bridge hops allowed in\n Spanning Tree Explorer frames on this VLAN. This\n object is only instantiated when the value of the\n corresponding instance of vtpVlanType has a value of fddi(2)\n or tokenRing(3) and Source Routing is in use on this VLAN.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanEditIsCRFBackup": { "type": "boolean", "description": "True if this VLAN is of type trCrf and also is acting as\n a backup trCrf for the ISL distributed BRF. This object is\n only instantiated when the value of the corresponding\n instance of vtpVlanEditType has a value of tokenRing(3)." }, "vtpVlanEditTypeExt": { "type": "string", "description": "The additional type information of this VLAN.\n vtpVlanEditTypeExt object is superseded by vtpVlanEditTypeExt2.", "x-yang-type": "CISCO-VTP-MIB:VlanTypeExt" }, "vtpVlanEditTypeExt2": { "type": "string", "description": "The additional type information of this VLAN.\n The VlanTypeExt TC specifies which bits may\n be written by a management application.\n The agent should provide a default value.", "x-yang-type": "CISCO-VTP-MIB:VlanTypeExt" } } } } } }, "example": { "CISCO-VTP-MIB:vtpVlanEditTable": { "vtpVlanEditEntry": [ { "managementDomainIndex": "1", "vtpVlanEditIndex": "1", "vtpVlanEditState": "up(1)", "vtpVlanEditType": "ethernetCsmacd(6)", "vtpVlanEditName": "interface-1", "vtpVlanEditMtu": 1500, "vtpVlanEditDot10Said": "example-string", "vtpVlanEditRingNumber": -2147483648, "vtpVlanEditBridgeNumber": -2147483648, "vtpVlanEditStpType": "ethernetCsmacd(6)", "vtpVlanEditParentVlan": "example-string", "vtpVlanEditRowStatus": "up(1)", "vtpVlanEditTranslationalVlan1": "example-string", "vtpVlanEditTranslationalVlan2": "example-string", "vtpVlanEditBridgeType": "ethernetCsmacd(6)", "vtpVlanEditAreHopCount": -2147483648, "vtpVlanEditSteHopCount": -2147483648, "vtpVlanEditIsCRFBackup": true, "vtpVlanEditTypeExt": "ethernetCsmacd(6)", "vtpVlanEditTypeExt2": "ethernetCsmacd(6)" }, { "managementDomainIndex": "2", "vtpVlanEditIndex": "2", "vtpVlanEditState": "up(1)", "vtpVlanEditType": "ethernetCsmacd(6)", "vtpVlanEditName": "interface-1", "vtpVlanEditMtu": 1500, "vtpVlanEditDot10Said": "example-string", "vtpVlanEditRingNumber": -2147483648, "vtpVlanEditBridgeNumber": -2147483648, "vtpVlanEditStpType": "ethernetCsmacd(6)", "vtpVlanEditParentVlan": "example-string", "vtpVlanEditRowStatus": "up(1)", "vtpVlanEditTranslationalVlan1": "example-string", "vtpVlanEditTranslationalVlan2": "example-string", "vtpVlanEditBridgeType": "ethernetCsmacd(6)", "vtpVlanEditAreHopCount": -2147483648, "vtpVlanEditSteHopCount": -2147483648, "vtpVlanEditIsCRFBackup": true, "vtpVlanEditTypeExt": "ethernetCsmacd(6)", "vtpVlanEditTypeExt2": "ethernetCsmacd(6)" }, { "managementDomainIndex": "3", "vtpVlanEditIndex": "3", "vtpVlanEditState": "up(1)", "vtpVlanEditType": "ethernetCsmacd(6)", "vtpVlanEditName": "interface-1", "vtpVlanEditMtu": 1500, "vtpVlanEditDot10Said": "example-string", "vtpVlanEditRingNumber": -2147483648, "vtpVlanEditBridgeNumber": -2147483648, "vtpVlanEditStpType": "ethernetCsmacd(6)", "vtpVlanEditParentVlan": "example-string", "vtpVlanEditRowStatus": "up(1)", "vtpVlanEditTranslationalVlan1": "example-string", "vtpVlanEditTranslationalVlan2": "example-string", "vtpVlanEditBridgeType": "ethernetCsmacd(6)", "vtpVlanEditAreHopCount": -2147483648, "vtpVlanEditSteHopCount": -2147483648, "vtpVlanEditIsCRFBackup": true, "vtpVlanEditTypeExt": "ethernetCsmacd(6)", "vtpVlanEditTypeExt2": "ethernetCsmacd(6)" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vtpVlanEditTable", "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": "/vtpVlanEditTable", "x-restconf-kind": "container" }, "/data/CISCO-VTP-MIB:vtpVlanEditTable/vtpVlanEditEntry": { "get": { "summary": "Get vtpVlanEditEntry list", "description": "Retrieve list of vtpVlanEditEntry entries from MIB", "tags": [ "CISCO-VTP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Information about one VLAN in the Edit Buffer for a\n particular management domain.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref" }, "vtpVlanEditIndex": { "type": "string", "description": "The VLAN-id which this VLAN would have on ISL or\n 802.1q trunks.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex" }, "vtpVlanEditState": { "type": "string", "description": "The state which this VLAN would have." }, "vtpVlanEditType": { "type": "string", "description": "The type which this VLAN would have.\n An implementation may restrict access to this object.", "x-yang-type": "CISCO-VTP-MIB:VlanType" }, "vtpVlanEditName": { "type": "string", "description": "The name which this VLAN would have. This name would be\n used as the ELAN-name for an ATM LAN-Emulation segment of\n this VLAN.\n \n An implementation may restrict access to this object.", "x-yang-type": "snmpv2-tc:DisplayString" }, "vtpVlanEditMtu": { "type": "integer", "description": "The MTU size which this VLAN would have, defined as the\n size of largest MAC-layer (information field portion of the)\n data frame which can be transmitted on the VLAN.\n \n An implementation may restrict access to this object.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanEditDot10Said": { "type": "string", "description": "The value of the 802.10 SAID field which would be used for\n this VLAN.\n \n An implementation may restrict access to this object.", "format": "binary" }, "vtpVlanEditRingNumber": { "type": "integer", "description": "The ring number which would be used for this VLAN. This\n object is only instantiated when the value of the\n corresponding instance of vtpVlanEditType has a value of\n 'fddi' or 'tokenRing' and Source Routing is in use on \n this VLAN.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanEditBridgeNumber": { "type": "integer", "description": "The bridge number of the VTP-capable switches which would\n be used for this VLAN. This object is only instantiated\n when the value of the corresponding instance of\n vtpVlanEditType has a value of fddiNet(4) or trNet(5).", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanEditStpType": { "type": "string", "description": "The type of the Spanning Tree Protocol which would be\n running on this VLAN. This object is only instantiated\n when the value of the corresponding instance of\n vtpVlanEditType has a value of fddiNet(4) or trNet(5).\n \n If 'ieee' is selected, the STP that runs will be IEEE.\n \n If 'ibm' is selected, the STP that runs will be IBM.\n \n If 'auto' is selected, the STP that runs will be\n dependant on the values of vtpVlanEditBridgeType for all\n children tokenRing/fddi type VLANs. This will result in\n a 'hybrid' STP (see vtpVlanStpType)." }, "vtpVlanEditParentVlan": { "type": "string", "description": "The VLAN index of the VLAN which would be the parent for\n this VLAN. This object is only instantiated when the value\n of the corresponding instance of vtpVlanEditType has a value\n of 'fddi' or 'tokenRing' and Source Routing is in use on\n this VLAN. The parent VLAN must have a vtpVlanEditType \n value of fddiNet(4) or trNet(5), respectively.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex" }, "vtpVlanEditRowStatus": { "type": "string", "description": "The status of this row. Any and all columnar objects in an\n existing row can be modified irrespective of the status of\n the row.\n \n A row is not qualified for activation until instances of at\n least its vtpVlanEditType, vtpVlanEditName and\n vtpVlanEditDot10Said columns have appropriate values.\n \n The management station should endeavor to make all rows\n consistent in the table before 'apply'ing the buffer. An\n inconsistent entry in the table will cause the entire\n buffer to be rejected with the vtpVlanApplyStatus object\n set to the appropriate error value.", "x-yang-type": "snmpv2-tc:RowStatus" }, "vtpVlanEditTranslationalVlan1": { "type": "string", "description": "A VLAN to which this VLAN would be translational-bridged.\n If this value and the corresponding instance of\n vtpVlanTranslationalVlan2 are both zero, then this VLAN\n would not be translational-bridged.\n \n An implementation may restrict access to this object.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex" }, "vtpVlanEditTranslationalVlan2": { "type": "string", "description": "Another VLAN, i.e., other than that indicated by\n vtpVlanEditTranslationalVlan1, to which this VLAN would be\n translational-bridged. If this value and the corresponding\n instance of vtpVlanTranslationalVlan1 are both zero, then\n this VLAN would not be translational-bridged.\n \n An implementation may restrict access to this object.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex" }, "vtpVlanEditBridgeType": { "type": "string", "description": "The type of Source Route bridging mode which would be in\n use on this VLAN. This object is only instantiated when \n the value of the corresponding instance of vtpVlanEditType\n has a value of fddi(2) or tokenRing(3) and Source Routing \n is in use on this VLAN." }, "vtpVlanEditAreHopCount": { "type": "integer", "description": "The maximum number of bridge hops allowed in\n All Routes Explorer frames on this VLAN. This\n object is only instantiated when the value of the\n corresponding instance of vtpVlanType has a value of fddi(2)\n or tokenRing(3) and Source Routing is in use on this VLAN.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanEditSteHopCount": { "type": "integer", "description": "The maximum number of bridge hops allowed in\n Spanning Tree Explorer frames on this VLAN. This\n object is only instantiated when the value of the\n corresponding instance of vtpVlanType has a value of fddi(2)\n or tokenRing(3) and Source Routing is in use on this VLAN.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanEditIsCRFBackup": { "type": "boolean", "description": "True if this VLAN is of type trCrf and also is acting as\n a backup trCrf for the ISL distributed BRF. This object is\n only instantiated when the value of the corresponding\n instance of vtpVlanEditType has a value of tokenRing(3)." }, "vtpVlanEditTypeExt": { "type": "string", "description": "The additional type information of this VLAN.\n vtpVlanEditTypeExt object is superseded by vtpVlanEditTypeExt2.", "x-yang-type": "CISCO-VTP-MIB:VlanTypeExt" }, "vtpVlanEditTypeExt2": { "type": "string", "description": "The additional type information of this VLAN.\n The VlanTypeExt TC specifies which bits may\n be written by a management application.\n The agent should provide a default value.", "x-yang-type": "CISCO-VTP-MIB:VlanTypeExt" } } } }, "example": { "CISCO-VTP-MIB:vtpVlanEditEntry": [ { "managementDomainIndex": "example-string", "vtpVlanEditIndex": "example-string", "vtpVlanEditState": "up(1)", "vtpVlanEditType": "ethernetCsmacd(6)", "vtpVlanEditName": "interface-1", "vtpVlanEditMtu": 1500, "vtpVlanEditDot10Said": "example-string", "vtpVlanEditRingNumber": -2147483648, "vtpVlanEditBridgeNumber": -2147483648, "vtpVlanEditStpType": "ethernetCsmacd(6)", "vtpVlanEditParentVlan": "example-string", "vtpVlanEditRowStatus": "up(1)", "vtpVlanEditTranslationalVlan1": "example-string", "vtpVlanEditTranslationalVlan2": "example-string", "vtpVlanEditBridgeType": "ethernetCsmacd(6)", "vtpVlanEditAreHopCount": -2147483648, "vtpVlanEditSteHopCount": -2147483648, "vtpVlanEditIsCRFBackup": true, "vtpVlanEditTypeExt": "ethernetCsmacd(6)", "vtpVlanEditTypeExt2": "ethernetCsmacd(6)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vtpVlanEditEntry", "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": "/vtpVlanEditTable/vtpVlanEditEntry", "x-restconf-kind": "container" }, "/data/CISCO-VTP-MIB:vtpVlanLocalShutdownTable": { "get": { "summary": "Get vtpVlanLocalShutdownTable data", "description": "Retrieve vtpVlanLocalShutdownTable operational data from MIB", "tags": [ "CISCO-VTP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "Ths table contains the VLAN local shutdown\n information within management domain.", "properties": { "vtpVlanLocalShutdownEntry": { "type": "array", "description": "An entry containing VLAN local shutdown information for a\n particular VLAN in the management domain.\n \n An entry is created if a VLAN which supports local shutdown\n has been created.\n \n An entry is deleted if a VLAN which supports local shutdown\n has been removed.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref" }, "vtpVlanIndex": { "type": "string", "description": "vtpVlanIndex", "x-yang-type": "leafref" }, "vtpVlanLocalShutdown": { "type": "string", "description": "The object specifies the VLAN local shutdown state." } } } } } }, "example": { "CISCO-VTP-MIB:vtpVlanLocalShutdownTable": { "vtpVlanLocalShutdownEntry": [ { "managementDomainIndex": "1", "vtpVlanIndex": "1", "vtpVlanLocalShutdown": "example-string" }, { "managementDomainIndex": "2", "vtpVlanIndex": "2", "vtpVlanLocalShutdown": "example-string" }, { "managementDomainIndex": "3", "vtpVlanIndex": "3", "vtpVlanLocalShutdown": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vtpVlanLocalShutdownTable", "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": "/vtpVlanLocalShutdownTable", "x-restconf-kind": "container" }, "/data/CISCO-VTP-MIB:vtpVlanLocalShutdownTable/vtpVlanLocalShutdownEntry": { "get": { "summary": "Get vtpVlanLocalShutdownEntry list", "description": "Retrieve list of vtpVlanLocalShutdownEntry entries from MIB", "tags": [ "CISCO-VTP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry containing VLAN local shutdown information for a\n particular VLAN in the management domain.\n \n An entry is created if a VLAN which supports local shutdown\n has been created.\n \n An entry is deleted if a VLAN which supports local shutdown\n has been removed.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref" }, "vtpVlanIndex": { "type": "string", "description": "vtpVlanIndex", "x-yang-type": "leafref" }, "vtpVlanLocalShutdown": { "type": "string", "description": "The object specifies the VLAN local shutdown state." } } } }, "example": { "CISCO-VTP-MIB:vtpVlanLocalShutdownEntry": [ { "managementDomainIndex": "example-string", "vtpVlanIndex": "example-string", "vtpVlanLocalShutdown": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vtpVlanLocalShutdownEntry", "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": "/vtpVlanLocalShutdownTable/vtpVlanLocalShutdownEntry", "x-restconf-kind": "container" }, "/data/CISCO-VTP-MIB:vlanTrunkPortTable": { "get": { "summary": "Get vlanTrunkPortTable data", "description": "Retrieve vlanTrunkPortTable operational data from MIB", "tags": [ "CISCO-VTP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The table containing information on the local system's VLAN\n trunk ports.", "properties": { "vlanTrunkPortEntry": { "type": "array", "description": "Information about one trunk port.", "items": { "type": "object", "properties": { "vlanTrunkPortIfIndex": { "type": "string", "description": "The value of ifIndex for the interface corresponding to\n this trunk port.", "x-yang-type": "if-mib:InterfaceIndex" }, "vlanTrunkPortManagementDomain": { "type": "string", "description": "The value of managementDomainIndex for the management\n domain on this trunk port. Devices which support only one\n management domain will support this object read-only.", "x-yang-type": "CISCO-VTP-MIB:ManagementDomainIndex" }, "vlanTrunkPortEncapsulationType": { "type": "string", "description": "The type of VLAN encapsulation desired to be used on this\n trunk port. It is either a particular type, or 'negotiate'\n meaning whatever type results from the negotiation.\n negotiate(5) is not allowed if the port does not support\n negotiation or if its vlanTrunkPortDynamicState is set to\n on(1) or onNoNegotiate(5). Whether writing to this object\n in order to modify the encapsulation is supported is both\n device and interface specific." }, "vlanTrunkPortVlansEnabled": { "type": "string", "description": "A string of octets containing one bit per VLAN in the\n management domain on this trunk port. The first octet\n corresponds to VLANs with VlanIndex values of 0 through 7;\n the second octet to VLANs 8 through 15; etc. The most\n significant bit of each octet corresponds to the lowest\n value VlanIndex in that octet. If the bit corresponding to\n a VLAN is set to '1', then the local system is enabled for\n sending and receiving frames on that VLAN; if the bit is set\n to '0', then the system is disabled from sending and\n receiving frames on that VLAN.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary" }, "vlanTrunkPortNativeVlan": { "type": "string", "description": "The VlanIndex of the VLAN which is represented by native\n frames on this trunk port. For trunk ports not supporting\n the sending and receiving of native frames, this value\n should be set to zero.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex" }, "vlanTrunkPortRowStatus": { "type": "string", "description": "The status of this row. In some circumstances, the\n creation of a row in this table is needed to enable the\n appropriate trunking/tagging protocol on the port, to enable\n the use of VTP on the port, and to assign the port to the\n appropriate management domain. In other circumstances, rows\n in this table will be created as a by-product of other\n operations.", "x-yang-type": "snmpv2-tc:RowStatus" }, "vlanTrunkPortInJoins": { "type": "integer", "description": "The number of VTP Join messages received on this trunk\n port.", "minimum": 0, "maximum": 4294967295 }, "vlanTrunkPortOutJoins": { "type": "integer", "description": "The number of VTP Join messages sent on this trunk port.", "minimum": 0, "maximum": 4294967295 }, "vlanTrunkPortOldAdverts": { "type": "integer", "description": "The number of VTP Advertisement messages which indicated\n the sender does not support VLAN-pruning received on this\n trunk port.", "minimum": 0, "maximum": 4294967295 }, "vlanTrunkPortVlansPruningEligible": { "type": "string", "description": "A string of octets containing one bit per VLAN in the\n management domain on this trunk port. The first octet\n corresponds to VLANs with VlanIndex values of 0 through 7;\n the second octet to VLANs 8 through 15; etc. The most\n significant bit of each octet corresponds to the lowest\n value VlanIndex in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local system is permitted to prune that VLAN on this trunk\n port; if the bit is set to '0', then the system must not\n prune that VLAN on this trunk port.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary" }, "vlanTrunkPortVlansXmitJoined": { "type": "string", "description": "A string of octets containing one bit per VLAN in the\n management domain on this trunk port. The first octet\n corresponds to VLANs with VlanIndex values of 0 through 7;\n the second octet to VLANs 8 through 15; etc. The most\n significant bit of each octet corresponds to the lowest\n value VlanIndex in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then this\n VLAN is presently being forwarded on this trunk port, i.e.,\n it is not pruned; if the bit is set to '0', then this VLAN\n is presently not being forwarded on this trunk port, either\n because it is pruned or for some other reason.", "format": "binary" }, "vlanTrunkPortVlansRcvJoined": { "type": "string", "description": "A string of octets containing one bit per VLAN in the\n management domain on this trunk port. The first octet\n corresponds to VLANs with VlanIndex values of 0 through 7;\n the second octet to VLANs 8 through 15; etc. The most\n significant bit of each octet corresponds to the lowest\n value VlanIndex in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local switch is currently sending joins for this VLAN on\n this trunk port, i.e., it is asking to receive frames for\n this VLAN; if the bit is set to '0', then the local switch\n is not currently sending joins for this VLAN on this trunk\n port.", "format": "binary" }, "vlanTrunkPortDynamicState": { "type": "string", "description": "For devices that allows dynamic determination of whether\n a link between two switches should be a trunk or not, this\n object allows the operator to mandate the behavior of that\n dynamic mechanism.\n \n on(1) dictates that the interface will always be a\n trunk. This is the value for static entries (those that\n show no dynamic behavior). If the negotiation is supported\n on this port, negotiation will take place with the far end\n to attempt to bring the far end into trunking state.\n \n off(2) allows an operator to specify that the specified\n interface is never to be trunk, regardless of any dynamic\n mechanisms to the contrary. This value is useful for\n overriding the default behavior of some switches. If the\n negotiation is supported on this port, negotiation will take\n place with the far end to attempt on the link to bring the\n far end into non-trunking state.\n \n desirable(3) is used to indicate that it is desirable for\n the interface to become a trunk. The device will initiate\n any negotiation necessary to become a trunk but will not\n become a trunk unless it receives confirmation from the far\n end on the link.\n \n auto(4) is used to indicate that the interface is capable\n and willing to become a trunk but will not initiate\n trunking negotiations. The far end on the link are\n required to either start negotiations or start sending\n encapsulated packets, on which event the specified\n interface will become a trunk.\n \n onNoNegotiate(5) is used to indicate that the interface is\n permanently set to be a trunk, and no negotiation takes\n place with the far end on the link to ensure consistent\n operation. This is similar to on(1) except no negotiation\n takes place with the far end.\n \n If the port does not support negotiation or its\n vlanTrunkPortEncapsulationType is set to negotiate(5),\n onNoNegotiate(5) is not allowed.\n \n Devices that do no support dynamic determination (for just\n a particular interface, encapsulation or for the whole\n device) need only support the 'on', and 'off' values." }, "vlanTrunkPortDynamicStatus": { "type": "string", "description": "Indicates whether the specified interface is either\n acting as a trunk or not. This is a result of the\n vlanTrunkPortDynamicState and the ifOperStatus of the\n trunk port itself." }, "vlanTrunkPortVtpEnabled": { "type": "boolean", "description": "Some trunk interface modules allow VTP to be\n enabled/disabled seperately from that of the central\n device. In such a case this object provides management a\n way to remotely enable VTP on that module. If a module\n does not support a seperate VTP enabled state then this\n object shall always return 'true' and will accept no other\n value during a SET operation." }, "vlanTrunkPortEncapsulationOperType": { "type": "string", "description": "The type of VLAN encapsulation in use on this trunk port.\n For intefaces with vlanTrunkPortDynamicStatus of\n notTrunking(2) the vlanTrunkPortEncapsulationOperType shall\n be notApplicable(6)." }, "vlanTrunkPortVlansEnabled2k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 1024 through 2047 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 1024 through 1031; the second\n octet to VLANs 1032 through 1039; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet. If the bit corresponding to a VLAN is set to\n '1', then the local system is enabled for sending and\n receiving frames on that VLAN; if the bit is set to '0',\n then the system is disabled from sending and receiving\n frames on that VLAN. The default value is zero length\n string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary" }, "vlanTrunkPortVlansEnabled3k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 2048 through 3071 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 2048 through 2055; the second\n octet to VLANs 2056 through 2063; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet. If the bit corresponding to a VLAN is set to\n '1', then the local system is enabled for sending and\n receiving frames on that VLAN; if the bit is set to '0',\n then the system is disabled from sending and receiving\n frames on that VLAN. The default value is zero length\n string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary" }, "vlanTrunkPortVlansEnabled4k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 3072 through 4095 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 3072 through 3079; the second\n octet to VLANs 3080 through 3087; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet. If the bit corresponding to a VLAN is set to\n '1', then the local system is enabled for sending and\n receiving frames on that VLAN; if the bit is set to '0',\n then the system is disabled from sending and receiving\n frames on that VLAN. The default value is zero length\n string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary" }, "vtpVlansPruningEligible2k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 1024 through 2047 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 1024 through 1031; the second\n octet to VLANs 1032 through 1039; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local system is permitted to prune that VLAN on this trunk\n port; if the bit is set to '0', then the system must not\n prune that VLAN on this trunk port.\n The default value is zero length string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary" }, "vtpVlansPruningEligible3k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 2048 through 3071 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 2048 through 2055; the second\n octet to VLANs 2056 through 2063; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local system is permitted to prune that VLAN on this trunk\n port; if the bit is set to '0', then the system must not\n prune that VLAN on this trunk port.\n The default value is zero length string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary" }, "vtpVlansPruningEligible4k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 3072 through 4095 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 3072 through 3079; the second\n octet to VLANs 3080 through 3087; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local system is permitted to prune that VLAN on this trunk\n port; if the bit is set to '0', then the system must not\n prune that VLAN on this trunk port.\n The default value is zero length string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary" }, "vlanTrunkPortVlansXmitJoined2k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 1024 through 2047 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 1024 through 1031; the second\n octet to VLANs 1032 through 1039; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then this\n VLAN is presently being forwarded on this trunk port, i.e.,\n it is not pruned; if the bit is set to '0', then this VLAN\n is presently not being forwarded on this trunk port, either\n because it is pruned or for some other reason.", "format": "binary" }, "vlanTrunkPortVlansXmitJoined3k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 2048 through 3071 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 2048 through 2055; the second\n octet to VLANs 2056 through 2063; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then this\n VLAN is presently being forwarded on this trunk port, i.e.,\n it is not pruned; if the bit is set to '0', then this VLAN\n is presently not being forwarded on this trunk port, either\n because it is pruned or for some other reason.", "format": "binary" }, "vlanTrunkPortVlansXmitJoined4k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 3072 through 4095 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 3072 through 3079; the second\n octet to VLANs 3080 through 3087; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then this\n VLAN is presently being forwarded on this trunk port, i.e.,\n it is not pruned; if the bit is set to '0', then this VLAN\n is presently not being forwarded on this trunk port, either\n because it is pruned or for some other reason.", "format": "binary" }, "vlanTrunkPortVlansRcvJoined2k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 1024 through 2047 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 1024 through 1031; the second\n octet to VLANs 1032 through 1039; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local switch is currently sending joins for this VLAN on\n this trunk port, i.e., it is asking to receive frames for\n this VLAN; if the bit is set to '0', then the local switch\n is not currently sending joins for this VLAN on this trunk\n port.", "format": "binary" }, "vlanTrunkPortVlansRcvJoined3k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 2048 through 3071 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 2048 through 2055; the second\n octet to VLANs 2056 through 2063; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local switch is currently sending joins for this VLAN on\n this trunk port, i.e., it is asking to receive frames for\n this VLAN; if the bit is set to '0', then the local switch\n is not currently sending joins for this VLAN on this trunk\n port.", "format": "binary" }, "vlanTrunkPortVlansRcvJoined4k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 3072 through 4095 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 3072 through 3079; the second\n octet to VLANs 3080 through 3087; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local switch is currently sending joins for this VLAN on\n this trunk port, i.e., it is asking to receive frames for\n this VLAN; if the bit is set to '0', then the local switch\n is not currently sending joins for this VLAN on this trunk\n port.", "format": "binary" }, "vlanTrunkPortDot1qTunnel": { "type": "string", "description": "Indicates dot1qtunnel mode of the port.\n \n If the portDot1qTunnel is set to 'trunk' mode, the port's\n vlanTrunkPortDynamicState will be changed to 'onNoNegotiate'\n and the vlanTrunkPortEncapsulationType will be set to\n 'dot1Q'. These values cannot be changed unless dot1q tunnel\n is disabled on this port.\n \n If the portDot1qTunnel mode is set to 'access' mode, the\n port's vlanTrunkPortDynamicState will be set to 'off'.And\n the value of vlanTrunkPortDynamicState cannot be changed\n unless dot1q tunnel is disabled on this port. 1Q packets\n received on this access port will remain.\n \n Setting the port to dot1q tunnel 'disabled' mode causes the\n dot1q tunnel feature to be disabled on this port. This\n object can't be set to 'trunk' or 'access' mode, when\n vlanTrunkPortsDot1qTag object is set to 'false'.\n \n This object has been deprecated and is replaced by the\n object 'cltcDot1qTunnelMode' in the\n CISCO-L2-TUNNEL-CONFIG-MIB" }, "vlanTrunkPortVlansActiveFirst2k": { "type": "string", "description": "A string of octets containing one bit per VLAN\n with VlanIndex values of 0 through 2047.\n \n If the bit corresponding to a VLAN is set to 1,\n it indicates that vlan is allowed and active in\n management domain.\n \n If the bit corresponding to a VLAN is set to 0,\n it indicates that vlan is not allowed or not active\n in management domain.", "x-yang-type": "cisco-tc:Cisco2KVlanList" }, "vlanTrunkPortVlansActiveSecond2k": { "type": "string", "description": "A string of octets containing one bit per VLAN\n with VlanIndex values of 2048 through 4095.\n \n If the bit corresponding to a VLAN is set to 1,\n it indicates that vlan is allowed and active in\n management domain.\n \n If the bit corresponding to a VLAN is set to 0,\n it indicates that vlan is not allowed or not active\n in management domain.", "x-yang-type": "cisco-tc:Cisco2KVlanList" } } } } } }, "example": { "CISCO-VTP-MIB:vlanTrunkPortTable": { "vlanTrunkPortEntry": [ { "vlanTrunkPortIfIndex": "1", "vlanTrunkPortManagementDomain": "example-string", "vlanTrunkPortEncapsulationType": "ethernetCsmacd(6)", "vlanTrunkPortVlansEnabled": "example-string", "vlanTrunkPortNativeVlan": "example-string", "vlanTrunkPortRowStatus": "up(1)", "vlanTrunkPortInJoins": 0, "vlanTrunkPortOutJoins": 0, "vlanTrunkPortOldAdverts": 0, "vlanTrunkPortVlansPruningEligible": "example-string", "vlanTrunkPortVlansXmitJoined": "example-string", "vlanTrunkPortVlansRcvJoined": "example-string", "vlanTrunkPortDynamicState": "up(1)", "vlanTrunkPortDynamicStatus": "up(1)", "vlanTrunkPortVtpEnabled": true, "vlanTrunkPortEncapsulationOperType": "ethernetCsmacd(6)", "vlanTrunkPortVlansEnabled2k": "example-string", "vlanTrunkPortVlansEnabled3k": "example-string", "vlanTrunkPortVlansEnabled4k": "example-string", "vtpVlansPruningEligible2k": "example-string", "vtpVlansPruningEligible3k": "example-string", "vtpVlansPruningEligible4k": "example-string", "vlanTrunkPortVlansXmitJoined2k": "example-string", "vlanTrunkPortVlansXmitJoined3k": "example-string", "vlanTrunkPortVlansXmitJoined4k": "example-string", "vlanTrunkPortVlansRcvJoined2k": "example-string", "vlanTrunkPortVlansRcvJoined3k": "example-string", "vlanTrunkPortVlansRcvJoined4k": "example-string", "vlanTrunkPortDot1qTunnel": "example-string", "vlanTrunkPortVlansActiveFirst2k": "example-string", "vlanTrunkPortVlansActiveSecond2k": "example-string" }, { "vlanTrunkPortIfIndex": "2", "vlanTrunkPortManagementDomain": "example-string", "vlanTrunkPortEncapsulationType": "ethernetCsmacd(6)", "vlanTrunkPortVlansEnabled": "example-string", "vlanTrunkPortNativeVlan": "example-string", "vlanTrunkPortRowStatus": "up(1)", "vlanTrunkPortInJoins": 0, "vlanTrunkPortOutJoins": 0, "vlanTrunkPortOldAdverts": 0, "vlanTrunkPortVlansPruningEligible": "example-string", "vlanTrunkPortVlansXmitJoined": "example-string", "vlanTrunkPortVlansRcvJoined": "example-string", "vlanTrunkPortDynamicState": "up(1)", "vlanTrunkPortDynamicStatus": "up(1)", "vlanTrunkPortVtpEnabled": true, "vlanTrunkPortEncapsulationOperType": "ethernetCsmacd(6)", "vlanTrunkPortVlansEnabled2k": "example-string", "vlanTrunkPortVlansEnabled3k": "example-string", "vlanTrunkPortVlansEnabled4k": "example-string", "vtpVlansPruningEligible2k": "example-string", "vtpVlansPruningEligible3k": "example-string", "vtpVlansPruningEligible4k": "example-string", "vlanTrunkPortVlansXmitJoined2k": "example-string", "vlanTrunkPortVlansXmitJoined3k": "example-string", "vlanTrunkPortVlansXmitJoined4k": "example-string", "vlanTrunkPortVlansRcvJoined2k": "example-string", "vlanTrunkPortVlansRcvJoined3k": "example-string", "vlanTrunkPortVlansRcvJoined4k": "example-string", "vlanTrunkPortDot1qTunnel": "example-string", "vlanTrunkPortVlansActiveFirst2k": "example-string", "vlanTrunkPortVlansActiveSecond2k": "example-string" }, { "vlanTrunkPortIfIndex": "3", "vlanTrunkPortManagementDomain": "example-string", "vlanTrunkPortEncapsulationType": "ethernetCsmacd(6)", "vlanTrunkPortVlansEnabled": "example-string", "vlanTrunkPortNativeVlan": "example-string", "vlanTrunkPortRowStatus": "up(1)", "vlanTrunkPortInJoins": 0, "vlanTrunkPortOutJoins": 0, "vlanTrunkPortOldAdverts": 0, "vlanTrunkPortVlansPruningEligible": "example-string", "vlanTrunkPortVlansXmitJoined": "example-string", "vlanTrunkPortVlansRcvJoined": "example-string", "vlanTrunkPortDynamicState": "up(1)", "vlanTrunkPortDynamicStatus": "up(1)", "vlanTrunkPortVtpEnabled": true, "vlanTrunkPortEncapsulationOperType": "ethernetCsmacd(6)", "vlanTrunkPortVlansEnabled2k": "example-string", "vlanTrunkPortVlansEnabled3k": "example-string", "vlanTrunkPortVlansEnabled4k": "example-string", "vtpVlansPruningEligible2k": "example-string", "vtpVlansPruningEligible3k": "example-string", "vtpVlansPruningEligible4k": "example-string", "vlanTrunkPortVlansXmitJoined2k": "example-string", "vlanTrunkPortVlansXmitJoined3k": "example-string", "vlanTrunkPortVlansXmitJoined4k": "example-string", "vlanTrunkPortVlansRcvJoined2k": "example-string", "vlanTrunkPortVlansRcvJoined3k": "example-string", "vlanTrunkPortVlansRcvJoined4k": "example-string", "vlanTrunkPortDot1qTunnel": "example-string", "vlanTrunkPortVlansActiveFirst2k": "example-string", "vlanTrunkPortVlansActiveSecond2k": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vlanTrunkPortTable", "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": "/vlanTrunkPortTable", "x-restconf-kind": "container" }, "/data/CISCO-VTP-MIB:vlanTrunkPortTable/vlanTrunkPortEntry": { "get": { "summary": "Get vlanTrunkPortEntry list", "description": "Retrieve list of vlanTrunkPortEntry entries from MIB", "tags": [ "CISCO-VTP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Information about one trunk port.", "items": { "type": "object", "properties": { "vlanTrunkPortIfIndex": { "type": "string", "description": "The value of ifIndex for the interface corresponding to\n this trunk port.", "x-yang-type": "if-mib:InterfaceIndex" }, "vlanTrunkPortManagementDomain": { "type": "string", "description": "The value of managementDomainIndex for the management\n domain on this trunk port. Devices which support only one\n management domain will support this object read-only.", "x-yang-type": "CISCO-VTP-MIB:ManagementDomainIndex" }, "vlanTrunkPortEncapsulationType": { "type": "string", "description": "The type of VLAN encapsulation desired to be used on this\n trunk port. It is either a particular type, or 'negotiate'\n meaning whatever type results from the negotiation.\n negotiate(5) is not allowed if the port does not support\n negotiation or if its vlanTrunkPortDynamicState is set to\n on(1) or onNoNegotiate(5). Whether writing to this object\n in order to modify the encapsulation is supported is both\n device and interface specific." }, "vlanTrunkPortVlansEnabled": { "type": "string", "description": "A string of octets containing one bit per VLAN in the\n management domain on this trunk port. The first octet\n corresponds to VLANs with VlanIndex values of 0 through 7;\n the second octet to VLANs 8 through 15; etc. The most\n significant bit of each octet corresponds to the lowest\n value VlanIndex in that octet. If the bit corresponding to\n a VLAN is set to '1', then the local system is enabled for\n sending and receiving frames on that VLAN; if the bit is set\n to '0', then the system is disabled from sending and\n receiving frames on that VLAN.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary" }, "vlanTrunkPortNativeVlan": { "type": "string", "description": "The VlanIndex of the VLAN which is represented by native\n frames on this trunk port. For trunk ports not supporting\n the sending and receiving of native frames, this value\n should be set to zero.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex" }, "vlanTrunkPortRowStatus": { "type": "string", "description": "The status of this row. In some circumstances, the\n creation of a row in this table is needed to enable the\n appropriate trunking/tagging protocol on the port, to enable\n the use of VTP on the port, and to assign the port to the\n appropriate management domain. In other circumstances, rows\n in this table will be created as a by-product of other\n operations.", "x-yang-type": "snmpv2-tc:RowStatus" }, "vlanTrunkPortInJoins": { "type": "integer", "description": "The number of VTP Join messages received on this trunk\n port.", "minimum": 0, "maximum": 4294967295 }, "vlanTrunkPortOutJoins": { "type": "integer", "description": "The number of VTP Join messages sent on this trunk port.", "minimum": 0, "maximum": 4294967295 }, "vlanTrunkPortOldAdverts": { "type": "integer", "description": "The number of VTP Advertisement messages which indicated\n the sender does not support VLAN-pruning received on this\n trunk port.", "minimum": 0, "maximum": 4294967295 }, "vlanTrunkPortVlansPruningEligible": { "type": "string", "description": "A string of octets containing one bit per VLAN in the\n management domain on this trunk port. The first octet\n corresponds to VLANs with VlanIndex values of 0 through 7;\n the second octet to VLANs 8 through 15; etc. The most\n significant bit of each octet corresponds to the lowest\n value VlanIndex in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local system is permitted to prune that VLAN on this trunk\n port; if the bit is set to '0', then the system must not\n prune that VLAN on this trunk port.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary" }, "vlanTrunkPortVlansXmitJoined": { "type": "string", "description": "A string of octets containing one bit per VLAN in the\n management domain on this trunk port. The first octet\n corresponds to VLANs with VlanIndex values of 0 through 7;\n the second octet to VLANs 8 through 15; etc. The most\n significant bit of each octet corresponds to the lowest\n value VlanIndex in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then this\n VLAN is presently being forwarded on this trunk port, i.e.,\n it is not pruned; if the bit is set to '0', then this VLAN\n is presently not being forwarded on this trunk port, either\n because it is pruned or for some other reason.", "format": "binary" }, "vlanTrunkPortVlansRcvJoined": { "type": "string", "description": "A string of octets containing one bit per VLAN in the\n management domain on this trunk port. The first octet\n corresponds to VLANs with VlanIndex values of 0 through 7;\n the second octet to VLANs 8 through 15; etc. The most\n significant bit of each octet corresponds to the lowest\n value VlanIndex in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local switch is currently sending joins for this VLAN on\n this trunk port, i.e., it is asking to receive frames for\n this VLAN; if the bit is set to '0', then the local switch\n is not currently sending joins for this VLAN on this trunk\n port.", "format": "binary" }, "vlanTrunkPortDynamicState": { "type": "string", "description": "For devices that allows dynamic determination of whether\n a link between two switches should be a trunk or not, this\n object allows the operator to mandate the behavior of that\n dynamic mechanism.\n \n on(1) dictates that the interface will always be a\n trunk. This is the value for static entries (those that\n show no dynamic behavior). If the negotiation is supported\n on this port, negotiation will take place with the far end\n to attempt to bring the far end into trunking state.\n \n off(2) allows an operator to specify that the specified\n interface is never to be trunk, regardless of any dynamic\n mechanisms to the contrary. This value is useful for\n overriding the default behavior of some switches. If the\n negotiation is supported on this port, negotiation will take\n place with the far end to attempt on the link to bring the\n far end into non-trunking state.\n \n desirable(3) is used to indicate that it is desirable for\n the interface to become a trunk. The device will initiate\n any negotiation necessary to become a trunk but will not\n become a trunk unless it receives confirmation from the far\n end on the link.\n \n auto(4) is used to indicate that the interface is capable\n and willing to become a trunk but will not initiate\n trunking negotiations. The far end on the link are\n required to either start negotiations or start sending\n encapsulated packets, on which event the specified\n interface will become a trunk.\n \n onNoNegotiate(5) is used to indicate that the interface is\n permanently set to be a trunk, and no negotiation takes\n place with the far end on the link to ensure consistent\n operation. This is similar to on(1) except no negotiation\n takes place with the far end.\n \n If the port does not support negotiation or its\n vlanTrunkPortEncapsulationType is set to negotiate(5),\n onNoNegotiate(5) is not allowed.\n \n Devices that do no support dynamic determination (for just\n a particular interface, encapsulation or for the whole\n device) need only support the 'on', and 'off' values." }, "vlanTrunkPortDynamicStatus": { "type": "string", "description": "Indicates whether the specified interface is either\n acting as a trunk or not. This is a result of the\n vlanTrunkPortDynamicState and the ifOperStatus of the\n trunk port itself." }, "vlanTrunkPortVtpEnabled": { "type": "boolean", "description": "Some trunk interface modules allow VTP to be\n enabled/disabled seperately from that of the central\n device. In such a case this object provides management a\n way to remotely enable VTP on that module. If a module\n does not support a seperate VTP enabled state then this\n object shall always return 'true' and will accept no other\n value during a SET operation." }, "vlanTrunkPortEncapsulationOperType": { "type": "string", "description": "The type of VLAN encapsulation in use on this trunk port.\n For intefaces with vlanTrunkPortDynamicStatus of\n notTrunking(2) the vlanTrunkPortEncapsulationOperType shall\n be notApplicable(6)." }, "vlanTrunkPortVlansEnabled2k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 1024 through 2047 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 1024 through 1031; the second\n octet to VLANs 1032 through 1039; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet. If the bit corresponding to a VLAN is set to\n '1', then the local system is enabled for sending and\n receiving frames on that VLAN; if the bit is set to '0',\n then the system is disabled from sending and receiving\n frames on that VLAN. The default value is zero length\n string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary" }, "vlanTrunkPortVlansEnabled3k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 2048 through 3071 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 2048 through 2055; the second\n octet to VLANs 2056 through 2063; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet. If the bit corresponding to a VLAN is set to\n '1', then the local system is enabled for sending and\n receiving frames on that VLAN; if the bit is set to '0',\n then the system is disabled from sending and receiving\n frames on that VLAN. The default value is zero length\n string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary" }, "vlanTrunkPortVlansEnabled4k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 3072 through 4095 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 3072 through 3079; the second\n octet to VLANs 3080 through 3087; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet. If the bit corresponding to a VLAN is set to\n '1', then the local system is enabled for sending and\n receiving frames on that VLAN; if the bit is set to '0',\n then the system is disabled from sending and receiving\n frames on that VLAN. The default value is zero length\n string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary" }, "vtpVlansPruningEligible2k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 1024 through 2047 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 1024 through 1031; the second\n octet to VLANs 1032 through 1039; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local system is permitted to prune that VLAN on this trunk\n port; if the bit is set to '0', then the system must not\n prune that VLAN on this trunk port.\n The default value is zero length string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary" }, "vtpVlansPruningEligible3k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 2048 through 3071 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 2048 through 2055; the second\n octet to VLANs 2056 through 2063; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local system is permitted to prune that VLAN on this trunk\n port; if the bit is set to '0', then the system must not\n prune that VLAN on this trunk port.\n The default value is zero length string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary" }, "vtpVlansPruningEligible4k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 3072 through 4095 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 3072 through 3079; the second\n octet to VLANs 3080 through 3087; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local system is permitted to prune that VLAN on this trunk\n port; if the bit is set to '0', then the system must not\n prune that VLAN on this trunk port.\n The default value is zero length string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary" }, "vlanTrunkPortVlansXmitJoined2k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 1024 through 2047 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 1024 through 1031; the second\n octet to VLANs 1032 through 1039; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then this\n VLAN is presently being forwarded on this trunk port, i.e.,\n it is not pruned; if the bit is set to '0', then this VLAN\n is presently not being forwarded on this trunk port, either\n because it is pruned or for some other reason.", "format": "binary" }, "vlanTrunkPortVlansXmitJoined3k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 2048 through 3071 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 2048 through 2055; the second\n octet to VLANs 2056 through 2063; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then this\n VLAN is presently being forwarded on this trunk port, i.e.,\n it is not pruned; if the bit is set to '0', then this VLAN\n is presently not being forwarded on this trunk port, either\n because it is pruned or for some other reason.", "format": "binary" }, "vlanTrunkPortVlansXmitJoined4k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 3072 through 4095 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 3072 through 3079; the second\n octet to VLANs 3080 through 3087; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then this\n VLAN is presently being forwarded on this trunk port, i.e.,\n it is not pruned; if the bit is set to '0', then this VLAN\n is presently not being forwarded on this trunk port, either\n because it is pruned or for some other reason.", "format": "binary" }, "vlanTrunkPortVlansRcvJoined2k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 1024 through 2047 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 1024 through 1031; the second\n octet to VLANs 1032 through 1039; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local switch is currently sending joins for this VLAN on\n this trunk port, i.e., it is asking to receive frames for\n this VLAN; if the bit is set to '0', then the local switch\n is not currently sending joins for this VLAN on this trunk\n port.", "format": "binary" }, "vlanTrunkPortVlansRcvJoined3k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 2048 through 3071 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 2048 through 2055; the second\n octet to VLANs 2056 through 2063; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local switch is currently sending joins for this VLAN on\n this trunk port, i.e., it is asking to receive frames for\n this VLAN; if the bit is set to '0', then the local switch\n is not currently sending joins for this VLAN on this trunk\n port.", "format": "binary" }, "vlanTrunkPortVlansRcvJoined4k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 3072 through 4095 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 3072 through 3079; the second\n octet to VLANs 3080 through 3087; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local switch is currently sending joins for this VLAN on\n this trunk port, i.e., it is asking to receive frames for\n this VLAN; if the bit is set to '0', then the local switch\n is not currently sending joins for this VLAN on this trunk\n port.", "format": "binary" }, "vlanTrunkPortDot1qTunnel": { "type": "string", "description": "Indicates dot1qtunnel mode of the port.\n \n If the portDot1qTunnel is set to 'trunk' mode, the port's\n vlanTrunkPortDynamicState will be changed to 'onNoNegotiate'\n and the vlanTrunkPortEncapsulationType will be set to\n 'dot1Q'. These values cannot be changed unless dot1q tunnel\n is disabled on this port.\n \n If the portDot1qTunnel mode is set to 'access' mode, the\n port's vlanTrunkPortDynamicState will be set to 'off'.And\n the value of vlanTrunkPortDynamicState cannot be changed\n unless dot1q tunnel is disabled on this port. 1Q packets\n received on this access port will remain.\n \n Setting the port to dot1q tunnel 'disabled' mode causes the\n dot1q tunnel feature to be disabled on this port. This\n object can't be set to 'trunk' or 'access' mode, when\n vlanTrunkPortsDot1qTag object is set to 'false'.\n \n This object has been deprecated and is replaced by the\n object 'cltcDot1qTunnelMode' in the\n CISCO-L2-TUNNEL-CONFIG-MIB" }, "vlanTrunkPortVlansActiveFirst2k": { "type": "string", "description": "A string of octets containing one bit per VLAN\n with VlanIndex values of 0 through 2047.\n \n If the bit corresponding to a VLAN is set to 1,\n it indicates that vlan is allowed and active in\n management domain.\n \n If the bit corresponding to a VLAN is set to 0,\n it indicates that vlan is not allowed or not active\n in management domain.", "x-yang-type": "cisco-tc:Cisco2KVlanList" }, "vlanTrunkPortVlansActiveSecond2k": { "type": "string", "description": "A string of octets containing one bit per VLAN\n with VlanIndex values of 2048 through 4095.\n \n If the bit corresponding to a VLAN is set to 1,\n it indicates that vlan is allowed and active in\n management domain.\n \n If the bit corresponding to a VLAN is set to 0,\n it indicates that vlan is not allowed or not active\n in management domain.", "x-yang-type": "cisco-tc:Cisco2KVlanList" } } } }, "example": { "CISCO-VTP-MIB:vlanTrunkPortEntry": [ { "vlanTrunkPortIfIndex": "example-string", "vlanTrunkPortManagementDomain": "example-string", "vlanTrunkPortEncapsulationType": "ethernetCsmacd(6)", "vlanTrunkPortVlansEnabled": "example-string", "vlanTrunkPortNativeVlan": "example-string", "vlanTrunkPortRowStatus": "up(1)", "vlanTrunkPortInJoins": 0, "vlanTrunkPortOutJoins": 0, "vlanTrunkPortOldAdverts": 0, "vlanTrunkPortVlansPruningEligible": "example-string", "vlanTrunkPortVlansXmitJoined": "example-string", "vlanTrunkPortVlansRcvJoined": "example-string", "vlanTrunkPortDynamicState": "up(1)", "vlanTrunkPortDynamicStatus": "up(1)", "vlanTrunkPortVtpEnabled": true, "vlanTrunkPortEncapsulationOperType": "ethernetCsmacd(6)", "vlanTrunkPortVlansEnabled2k": "example-string", "vlanTrunkPortVlansEnabled3k": "example-string", "vlanTrunkPortVlansEnabled4k": "example-string", "vtpVlansPruningEligible2k": "example-string", "vtpVlansPruningEligible3k": "example-string", "vtpVlansPruningEligible4k": "example-string", "vlanTrunkPortVlansXmitJoined2k": "example-string", "vlanTrunkPortVlansXmitJoined3k": "example-string", "vlanTrunkPortVlansXmitJoined4k": "example-string", "vlanTrunkPortVlansRcvJoined2k": "example-string", "vlanTrunkPortVlansRcvJoined3k": "example-string", "vlanTrunkPortVlansRcvJoined4k": "example-string", "vlanTrunkPortDot1qTunnel": "example-string", "vlanTrunkPortVlansActiveFirst2k": "example-string", "vlanTrunkPortVlansActiveSecond2k": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vlanTrunkPortEntry", "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": "/vlanTrunkPortTable/vlanTrunkPortEntry", "x-restconf-kind": "container" }, "/data/CISCO-VTP-MIB:vlanTrunkPortTable/vlanTrunkPortEntry={vlanTrunkPortIfIndex}": { "get": { "summary": "Get vlanTrunkPortEntry entry", "description": "Retrieve specific vlanTrunkPortEntry entry by key from MIB", "tags": [ "CISCO-VTP-MIB" ], "parameters": [ { "name": "vlanTrunkPortIfIndex", "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": { "vlanTrunkPortIfIndex": { "type": "string", "description": "The value of ifIndex for the interface corresponding to\n this trunk port.", "x-yang-type": "if-mib:InterfaceIndex" }, "vlanTrunkPortManagementDomain": { "type": "string", "description": "The value of managementDomainIndex for the management\n domain on this trunk port. Devices which support only one\n management domain will support this object read-only.", "x-yang-type": "CISCO-VTP-MIB:ManagementDomainIndex" }, "vlanTrunkPortEncapsulationType": { "type": "string", "description": "The type of VLAN encapsulation desired to be used on this\n trunk port. It is either a particular type, or 'negotiate'\n meaning whatever type results from the negotiation.\n negotiate(5) is not allowed if the port does not support\n negotiation or if its vlanTrunkPortDynamicState is set to\n on(1) or onNoNegotiate(5). Whether writing to this object\n in order to modify the encapsulation is supported is both\n device and interface specific." }, "vlanTrunkPortVlansEnabled": { "type": "string", "description": "A string of octets containing one bit per VLAN in the\n management domain on this trunk port. The first octet\n corresponds to VLANs with VlanIndex values of 0 through 7;\n the second octet to VLANs 8 through 15; etc. The most\n significant bit of each octet corresponds to the lowest\n value VlanIndex in that octet. If the bit corresponding to\n a VLAN is set to '1', then the local system is enabled for\n sending and receiving frames on that VLAN; if the bit is set\n to '0', then the system is disabled from sending and\n receiving frames on that VLAN.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary" }, "vlanTrunkPortNativeVlan": { "type": "string", "description": "The VlanIndex of the VLAN which is represented by native\n frames on this trunk port. For trunk ports not supporting\n the sending and receiving of native frames, this value\n should be set to zero.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex" }, "vlanTrunkPortRowStatus": { "type": "string", "description": "The status of this row. In some circumstances, the\n creation of a row in this table is needed to enable the\n appropriate trunking/tagging protocol on the port, to enable\n the use of VTP on the port, and to assign the port to the\n appropriate management domain. In other circumstances, rows\n in this table will be created as a by-product of other\n operations.", "x-yang-type": "snmpv2-tc:RowStatus" }, "vlanTrunkPortInJoins": { "type": "integer", "description": "The number of VTP Join messages received on this trunk\n port.", "minimum": 0, "maximum": 4294967295 }, "vlanTrunkPortOutJoins": { "type": "integer", "description": "The number of VTP Join messages sent on this trunk port.", "minimum": 0, "maximum": 4294967295 }, "vlanTrunkPortOldAdverts": { "type": "integer", "description": "The number of VTP Advertisement messages which indicated\n the sender does not support VLAN-pruning received on this\n trunk port.", "minimum": 0, "maximum": 4294967295 }, "vlanTrunkPortVlansPruningEligible": { "type": "string", "description": "A string of octets containing one bit per VLAN in the\n management domain on this trunk port. The first octet\n corresponds to VLANs with VlanIndex values of 0 through 7;\n the second octet to VLANs 8 through 15; etc. The most\n significant bit of each octet corresponds to the lowest\n value VlanIndex in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local system is permitted to prune that VLAN on this trunk\n port; if the bit is set to '0', then the system must not\n prune that VLAN on this trunk port.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary" }, "vlanTrunkPortVlansXmitJoined": { "type": "string", "description": "A string of octets containing one bit per VLAN in the\n management domain on this trunk port. The first octet\n corresponds to VLANs with VlanIndex values of 0 through 7;\n the second octet to VLANs 8 through 15; etc. The most\n significant bit of each octet corresponds to the lowest\n value VlanIndex in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then this\n VLAN is presently being forwarded on this trunk port, i.e.,\n it is not pruned; if the bit is set to '0', then this VLAN\n is presently not being forwarded on this trunk port, either\n because it is pruned or for some other reason.", "format": "binary" }, "vlanTrunkPortVlansRcvJoined": { "type": "string", "description": "A string of octets containing one bit per VLAN in the\n management domain on this trunk port. The first octet\n corresponds to VLANs with VlanIndex values of 0 through 7;\n the second octet to VLANs 8 through 15; etc. The most\n significant bit of each octet corresponds to the lowest\n value VlanIndex in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local switch is currently sending joins for this VLAN on\n this trunk port, i.e., it is asking to receive frames for\n this VLAN; if the bit is set to '0', then the local switch\n is not currently sending joins for this VLAN on this trunk\n port.", "format": "binary" }, "vlanTrunkPortDynamicState": { "type": "string", "description": "For devices that allows dynamic determination of whether\n a link between two switches should be a trunk or not, this\n object allows the operator to mandate the behavior of that\n dynamic mechanism.\n \n on(1) dictates that the interface will always be a\n trunk. This is the value for static entries (those that\n show no dynamic behavior). If the negotiation is supported\n on this port, negotiation will take place with the far end\n to attempt to bring the far end into trunking state.\n \n off(2) allows an operator to specify that the specified\n interface is never to be trunk, regardless of any dynamic\n mechanisms to the contrary. This value is useful for\n overriding the default behavior of some switches. If the\n negotiation is supported on this port, negotiation will take\n place with the far end to attempt on the link to bring the\n far end into non-trunking state.\n \n desirable(3) is used to indicate that it is desirable for\n the interface to become a trunk. The device will initiate\n any negotiation necessary to become a trunk but will not\n become a trunk unless it receives confirmation from the far\n end on the link.\n \n auto(4) is used to indicate that the interface is capable\n and willing to become a trunk but will not initiate\n trunking negotiations. The far end on the link are\n required to either start negotiations or start sending\n encapsulated packets, on which event the specified\n interface will become a trunk.\n \n onNoNegotiate(5) is used to indicate that the interface is\n permanently set to be a trunk, and no negotiation takes\n place with the far end on the link to ensure consistent\n operation. This is similar to on(1) except no negotiation\n takes place with the far end.\n \n If the port does not support negotiation or its\n vlanTrunkPortEncapsulationType is set to negotiate(5),\n onNoNegotiate(5) is not allowed.\n \n Devices that do no support dynamic determination (for just\n a particular interface, encapsulation or for the whole\n device) need only support the 'on', and 'off' values." }, "vlanTrunkPortDynamicStatus": { "type": "string", "description": "Indicates whether the specified interface is either\n acting as a trunk or not. This is a result of the\n vlanTrunkPortDynamicState and the ifOperStatus of the\n trunk port itself." }, "vlanTrunkPortVtpEnabled": { "type": "boolean", "description": "Some trunk interface modules allow VTP to be\n enabled/disabled seperately from that of the central\n device. In such a case this object provides management a\n way to remotely enable VTP on that module. If a module\n does not support a seperate VTP enabled state then this\n object shall always return 'true' and will accept no other\n value during a SET operation." }, "vlanTrunkPortEncapsulationOperType": { "type": "string", "description": "The type of VLAN encapsulation in use on this trunk port.\n For intefaces with vlanTrunkPortDynamicStatus of\n notTrunking(2) the vlanTrunkPortEncapsulationOperType shall\n be notApplicable(6)." }, "vlanTrunkPortVlansEnabled2k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 1024 through 2047 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 1024 through 1031; the second\n octet to VLANs 1032 through 1039; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet. If the bit corresponding to a VLAN is set to\n '1', then the local system is enabled for sending and\n receiving frames on that VLAN; if the bit is set to '0',\n then the system is disabled from sending and receiving\n frames on that VLAN. The default value is zero length\n string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary" }, "vlanTrunkPortVlansEnabled3k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 2048 through 3071 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 2048 through 2055; the second\n octet to VLANs 2056 through 2063; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet. If the bit corresponding to a VLAN is set to\n '1', then the local system is enabled for sending and\n receiving frames on that VLAN; if the bit is set to '0',\n then the system is disabled from sending and receiving\n frames on that VLAN. The default value is zero length\n string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary" }, "vlanTrunkPortVlansEnabled4k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 3072 through 4095 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 3072 through 3079; the second\n octet to VLANs 3080 through 3087; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet. If the bit corresponding to a VLAN is set to\n '1', then the local system is enabled for sending and\n receiving frames on that VLAN; if the bit is set to '0',\n then the system is disabled from sending and receiving\n frames on that VLAN. The default value is zero length\n string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary" }, "vtpVlansPruningEligible2k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 1024 through 2047 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 1024 through 1031; the second\n octet to VLANs 1032 through 1039; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local system is permitted to prune that VLAN on this trunk\n port; if the bit is set to '0', then the system must not\n prune that VLAN on this trunk port.\n The default value is zero length string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary" }, "vtpVlansPruningEligible3k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 2048 through 3071 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 2048 through 2055; the second\n octet to VLANs 2056 through 2063; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local system is permitted to prune that VLAN on this trunk\n port; if the bit is set to '0', then the system must not\n prune that VLAN on this trunk port.\n The default value is zero length string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary" }, "vtpVlansPruningEligible4k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 3072 through 4095 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 3072 through 3079; the second\n octet to VLANs 3080 through 3087; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local system is permitted to prune that VLAN on this trunk\n port; if the bit is set to '0', then the system must not\n prune that VLAN on this trunk port.\n The default value is zero length string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary" }, "vlanTrunkPortVlansXmitJoined2k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 1024 through 2047 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 1024 through 1031; the second\n octet to VLANs 1032 through 1039; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then this\n VLAN is presently being forwarded on this trunk port, i.e.,\n it is not pruned; if the bit is set to '0', then this VLAN\n is presently not being forwarded on this trunk port, either\n because it is pruned or for some other reason.", "format": "binary" }, "vlanTrunkPortVlansXmitJoined3k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 2048 through 3071 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 2048 through 2055; the second\n octet to VLANs 2056 through 2063; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then this\n VLAN is presently being forwarded on this trunk port, i.e.,\n it is not pruned; if the bit is set to '0', then this VLAN\n is presently not being forwarded on this trunk port, either\n because it is pruned or for some other reason.", "format": "binary" }, "vlanTrunkPortVlansXmitJoined4k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 3072 through 4095 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 3072 through 3079; the second\n octet to VLANs 3080 through 3087; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then this\n VLAN is presently being forwarded on this trunk port, i.e.,\n it is not pruned; if the bit is set to '0', then this VLAN\n is presently not being forwarded on this trunk port, either\n because it is pruned or for some other reason.", "format": "binary" }, "vlanTrunkPortVlansRcvJoined2k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 1024 through 2047 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 1024 through 1031; the second\n octet to VLANs 1032 through 1039; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local switch is currently sending joins for this VLAN on\n this trunk port, i.e., it is asking to receive frames for\n this VLAN; if the bit is set to '0', then the local switch\n is not currently sending joins for this VLAN on this trunk\n port.", "format": "binary" }, "vlanTrunkPortVlansRcvJoined3k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 2048 through 3071 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 2048 through 2055; the second\n octet to VLANs 2056 through 2063; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local switch is currently sending joins for this VLAN on\n this trunk port, i.e., it is asking to receive frames for\n this VLAN; if the bit is set to '0', then the local switch\n is not currently sending joins for this VLAN on this trunk\n port.", "format": "binary" }, "vlanTrunkPortVlansRcvJoined4k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 3072 through 4095 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 3072 through 3079; the second\n octet to VLANs 3080 through 3087; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local switch is currently sending joins for this VLAN on\n this trunk port, i.e., it is asking to receive frames for\n this VLAN; if the bit is set to '0', then the local switch\n is not currently sending joins for this VLAN on this trunk\n port.", "format": "binary" }, "vlanTrunkPortDot1qTunnel": { "type": "string", "description": "Indicates dot1qtunnel mode of the port.\n \n If the portDot1qTunnel is set to 'trunk' mode, the port's\n vlanTrunkPortDynamicState will be changed to 'onNoNegotiate'\n and the vlanTrunkPortEncapsulationType will be set to\n 'dot1Q'. These values cannot be changed unless dot1q tunnel\n is disabled on this port.\n \n If the portDot1qTunnel mode is set to 'access' mode, the\n port's vlanTrunkPortDynamicState will be set to 'off'.And\n the value of vlanTrunkPortDynamicState cannot be changed\n unless dot1q tunnel is disabled on this port. 1Q packets\n received on this access port will remain.\n \n Setting the port to dot1q tunnel 'disabled' mode causes the\n dot1q tunnel feature to be disabled on this port. This\n object can't be set to 'trunk' or 'access' mode, when\n vlanTrunkPortsDot1qTag object is set to 'false'.\n \n This object has been deprecated and is replaced by the\n object 'cltcDot1qTunnelMode' in the\n CISCO-L2-TUNNEL-CONFIG-MIB" }, "vlanTrunkPortVlansActiveFirst2k": { "type": "string", "description": "A string of octets containing one bit per VLAN\n with VlanIndex values of 0 through 2047.\n \n If the bit corresponding to a VLAN is set to 1,\n it indicates that vlan is allowed and active in\n management domain.\n \n If the bit corresponding to a VLAN is set to 0,\n it indicates that vlan is not allowed or not active\n in management domain.", "x-yang-type": "cisco-tc:Cisco2KVlanList" }, "vlanTrunkPortVlansActiveSecond2k": { "type": "string", "description": "A string of octets containing one bit per VLAN\n with VlanIndex values of 2048 through 4095.\n \n If the bit corresponding to a VLAN is set to 1,\n it indicates that vlan is allowed and active in\n management domain.\n \n If the bit corresponding to a VLAN is set to 0,\n it indicates that vlan is not allowed or not active\n in management domain.", "x-yang-type": "cisco-tc:Cisco2KVlanList" } } }, "example": { "CISCO-VTP-MIB:vlanTrunkPortEntry": { "vlanTrunkPortIfIndex": "example-string", "vlanTrunkPortManagementDomain": "example-string", "vlanTrunkPortEncapsulationType": "ethernetCsmacd(6)", "vlanTrunkPortVlansEnabled": "example-string", "vlanTrunkPortNativeVlan": "example-string", "vlanTrunkPortRowStatus": "up(1)", "vlanTrunkPortInJoins": 0, "vlanTrunkPortOutJoins": 0, "vlanTrunkPortOldAdverts": 0, "vlanTrunkPortVlansPruningEligible": "example-string", "vlanTrunkPortVlansXmitJoined": "example-string", "vlanTrunkPortVlansRcvJoined": "example-string", "vlanTrunkPortDynamicState": "up(1)", "vlanTrunkPortDynamicStatus": "up(1)", "vlanTrunkPortVtpEnabled": true, "vlanTrunkPortEncapsulationOperType": "ethernetCsmacd(6)", "vlanTrunkPortVlansEnabled2k": "example-string", "vlanTrunkPortVlansEnabled3k": "example-string", "vlanTrunkPortVlansEnabled4k": "example-string", "vtpVlansPruningEligible2k": "example-string", "vtpVlansPruningEligible3k": "example-string", "vtpVlansPruningEligible4k": "example-string", "vlanTrunkPortVlansXmitJoined2k": "example-string", "vlanTrunkPortVlansXmitJoined3k": "example-string", "vlanTrunkPortVlansXmitJoined4k": "example-string", "vlanTrunkPortVlansRcvJoined2k": "example-string", "vlanTrunkPortVlansRcvJoined3k": "example-string", "vlanTrunkPortVlansRcvJoined4k": "example-string", "vlanTrunkPortDot1qTunnel": "example-string", "vlanTrunkPortVlansActiveFirst2k": "example-string", "vlanTrunkPortVlansActiveSecond2k": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vlanTrunkPortEntry-2" }, "x-yang-path": "/vlanTrunkPortTable/vlanTrunkPortEntry={vlanTrunkPortIfIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "vlanTrunkPortIfIndex" ] }, "/data/CISCO-VTP-MIB:vtpDiscoverTable": { "get": { "summary": "Get vtpDiscoverTable data", "description": "Retrieve vtpDiscoverTable operational data from MIB", "tags": [ "CISCO-VTP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table contains information related to the discovery\n of the VTP members in the designated management\n domain. This table is not instantiated when \n managementDomainVersionInUse is version1(1), version2(3)\n or none(3).", "properties": { "vtpDiscoverEntry": { "type": "array", "description": "Information related to the discovery of the\n VTP members in one management domain.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref" }, "vtpDiscoverAction": { "type": "string", "description": "When this object is set to discover(1), all the\n entries in vtpDiscoverResultTable for the\n corresponding management domain will be removed \n and the local device will begin to discover all\n VTP members in the management domain. Upon the\n successful completion of discovery, the discovered\n result will be stored in the vtpDiscoverResultTable.\n \n If vtpDiscoverStatus is inProgress(1), setting \n vtpDiscoverAction to discover(1) will fail. \n \n When this object is set to purgeResult(3), \n all the entries of vtpDiscoverResultTable for \n the corresponding management domain will be\n removed from vtpDiscoverResultTable.\n \n When this object is set to noOperation(2), no\n action will be taken. When read, this object\n always returns noOperation(2)." }, "vtpDiscoverStatus": { "type": "string", "description": "The current status of VTP discovery.\n \n inProgress - a discovery is in progress;\n \n succeeded - the discovery was completed successfully\n (this value is also used when \n no discover has been invoked since the\n last time the local system restarted);\n \n resourceUnavailable - the discovery failed because\n the required allocation of a resource is\n presently unavailable.\n \n someOtherError - 'the discovery failed due to a\n reason no listed." }, "vtpLastDiscoverTime": { "type": "string", "description": "The value of sysUpTime at which the last discovery\n was completed.\n \n A value of zero indicates that no discovery has been\n invoked since last time the local system restarted.", "x-yang-type": "yang:timestamp" } } } } } }, "example": { "CISCO-VTP-MIB:vtpDiscoverTable": { "vtpDiscoverEntry": [ { "managementDomainIndex": "1", "vtpDiscoverAction": "example-string", "vtpDiscoverStatus": "up(1)", "vtpLastDiscoverTime": "example-string" }, { "managementDomainIndex": "2", "vtpDiscoverAction": "example-string", "vtpDiscoverStatus": "up(1)", "vtpLastDiscoverTime": "example-string" }, { "managementDomainIndex": "3", "vtpDiscoverAction": "example-string", "vtpDiscoverStatus": "up(1)", "vtpLastDiscoverTime": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vtpDiscoverTable", "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": "/vtpDiscoverTable", "x-restconf-kind": "container" }, "/data/CISCO-VTP-MIB:vtpDiscoverTable/vtpDiscoverEntry": { "get": { "summary": "Get vtpDiscoverEntry list", "description": "Retrieve list of vtpDiscoverEntry entries from MIB", "tags": [ "CISCO-VTP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Information related to the discovery of the\n VTP members in one management domain.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref" }, "vtpDiscoverAction": { "type": "string", "description": "When this object is set to discover(1), all the\n entries in vtpDiscoverResultTable for the\n corresponding management domain will be removed \n and the local device will begin to discover all\n VTP members in the management domain. Upon the\n successful completion of discovery, the discovered\n result will be stored in the vtpDiscoverResultTable.\n \n If vtpDiscoverStatus is inProgress(1), setting \n vtpDiscoverAction to discover(1) will fail. \n \n When this object is set to purgeResult(3), \n all the entries of vtpDiscoverResultTable for \n the corresponding management domain will be\n removed from vtpDiscoverResultTable.\n \n When this object is set to noOperation(2), no\n action will be taken. When read, this object\n always returns noOperation(2)." }, "vtpDiscoverStatus": { "type": "string", "description": "The current status of VTP discovery.\n \n inProgress - a discovery is in progress;\n \n succeeded - the discovery was completed successfully\n (this value is also used when \n no discover has been invoked since the\n last time the local system restarted);\n \n resourceUnavailable - the discovery failed because\n the required allocation of a resource is\n presently unavailable.\n \n someOtherError - 'the discovery failed due to a\n reason no listed." }, "vtpLastDiscoverTime": { "type": "string", "description": "The value of sysUpTime at which the last discovery\n was completed.\n \n A value of zero indicates that no discovery has been\n invoked since last time the local system restarted.", "x-yang-type": "yang:timestamp" } } } }, "example": { "CISCO-VTP-MIB:vtpDiscoverEntry": [ { "managementDomainIndex": "example-string", "vtpDiscoverAction": "example-string", "vtpDiscoverStatus": "up(1)", "vtpLastDiscoverTime": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vtpDiscoverEntry", "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": "/vtpDiscoverTable/vtpDiscoverEntry", "x-restconf-kind": "container" }, "/data/CISCO-VTP-MIB:vtpDiscoverTable/vtpDiscoverEntry={managementDomainIndex}": { "get": { "summary": "Get vtpDiscoverEntry entry", "description": "Retrieve specific vtpDiscoverEntry entry by key from MIB", "tags": [ "CISCO-VTP-MIB" ], "parameters": [ { "name": "managementDomainIndex", "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": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref" }, "vtpDiscoverAction": { "type": "string", "description": "When this object is set to discover(1), all the\n entries in vtpDiscoverResultTable for the\n corresponding management domain will be removed \n and the local device will begin to discover all\n VTP members in the management domain. Upon the\n successful completion of discovery, the discovered\n result will be stored in the vtpDiscoverResultTable.\n \n If vtpDiscoverStatus is inProgress(1), setting \n vtpDiscoverAction to discover(1) will fail. \n \n When this object is set to purgeResult(3), \n all the entries of vtpDiscoverResultTable for \n the corresponding management domain will be\n removed from vtpDiscoverResultTable.\n \n When this object is set to noOperation(2), no\n action will be taken. When read, this object\n always returns noOperation(2)." }, "vtpDiscoverStatus": { "type": "string", "description": "The current status of VTP discovery.\n \n inProgress - a discovery is in progress;\n \n succeeded - the discovery was completed successfully\n (this value is also used when \n no discover has been invoked since the\n last time the local system restarted);\n \n resourceUnavailable - the discovery failed because\n the required allocation of a resource is\n presently unavailable.\n \n someOtherError - 'the discovery failed due to a\n reason no listed." }, "vtpLastDiscoverTime": { "type": "string", "description": "The value of sysUpTime at which the last discovery\n was completed.\n \n A value of zero indicates that no discovery has been\n invoked since last time the local system restarted.", "x-yang-type": "yang:timestamp" } } }, "example": { "CISCO-VTP-MIB:vtpDiscoverEntry": { "managementDomainIndex": "example-string", "vtpDiscoverAction": "example-string", "vtpDiscoverStatus": "up(1)", "vtpLastDiscoverTime": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vtpDiscoverEntry-2" }, "x-yang-path": "/vtpDiscoverTable/vtpDiscoverEntry={managementDomainIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "managementDomainIndex" ] }, "/data/CISCO-VTP-MIB:vtpDiscoverResultTable": { "get": { "summary": "Get vtpDiscoverResultTable data", "description": "Retrieve vtpDiscoverResultTable operational data from MIB", "tags": [ "CISCO-VTP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The table containing information of discovered VTP members\n in the management domain in which the local system is\n participating. This table is not instantiated when \n managementDomainVersionInUse is version1(1), version2(2) or\n none(3).", "properties": { "vtpDiscoverResultEntry": { "type": "array", "description": "A conceptual row is created for each VTP member which\n is found through successful discovery.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref" }, "vtpDiscoverResultIndex": { "type": "integer", "description": "A value assigned by the system which identifies\n a VTP member and the associated database in the \n management domain.", "minimum": 0, "maximum": 4294967295 }, "vtpDiscoverResultDatabaseName": { "type": "string", "description": "The database name associated with the\n discovered VTP member.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "vtpDiscoverResultConflicting": { "type": "boolean", "description": "Indicates whether this VTP member contains\n conflicting information.\n \n true(1) indicates that this member has conflicting \n information of the database type in the management domain.\n \n false(2) indicates that there is no conflicting information\n of the database type in the management domain." }, "vtpDiscoverResultDeviceId": { "type": "string", "description": "The unique identifier of the device for this VTP member.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "vtpDiscoverResultPrimaryServer": { "type": "string", "description": "The unique identifier of the primary server for this VTP\n member and the associated database type.\n \n There are two different VTP servers, the primary server\n and the secondary server. When a local device is\n configured as a server for a certain database type,\n it becomes secondary server by default. \n Primary server is an operational role under which a\n server can initiate or change the VTP configuration of the\n database type.\n \n If this VTP member itself is the primary server, the \n value of this object is the same as the value of \n vtpDiscoverResultDeviceId of the instance.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "vtpDiscoverResultRevNumber": { "type": "integer", "description": "The current configuration revision number as known by the\n VTP member. When the database type is unknown for\n the VTP member, this value is 0.", "minimum": 0, "maximum": 4294967295 }, "vtpDiscoverResultSystemName": { "type": "string", "description": "sysName of the VTP member.", "x-yang-type": "snmp-framework:SnmpAdminString" } } } } } }, "example": { "CISCO-VTP-MIB:vtpDiscoverResultTable": { "vtpDiscoverResultEntry": [ { "managementDomainIndex": "1", "vtpDiscoverResultIndex": 1, "vtpDiscoverResultDatabaseName": "interface-1", "vtpDiscoverResultConflicting": true, "vtpDiscoverResultDeviceId": "example-string", "vtpDiscoverResultPrimaryServer": "example-string", "vtpDiscoverResultRevNumber": 0, "vtpDiscoverResultSystemName": "interface-1" }, { "managementDomainIndex": "2", "vtpDiscoverResultIndex": 2, "vtpDiscoverResultDatabaseName": "interface-1", "vtpDiscoverResultConflicting": true, "vtpDiscoverResultDeviceId": "example-string", "vtpDiscoverResultPrimaryServer": "example-string", "vtpDiscoverResultRevNumber": 0, "vtpDiscoverResultSystemName": "interface-1" }, { "managementDomainIndex": "3", "vtpDiscoverResultIndex": 3, "vtpDiscoverResultDatabaseName": "interface-1", "vtpDiscoverResultConflicting": true, "vtpDiscoverResultDeviceId": "example-string", "vtpDiscoverResultPrimaryServer": "example-string", "vtpDiscoverResultRevNumber": 0, "vtpDiscoverResultSystemName": "interface-1" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vtpDiscoverResultTable", "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": "/vtpDiscoverResultTable", "x-restconf-kind": "container" }, "/data/CISCO-VTP-MIB:vtpDiscoverResultTable/vtpDiscoverResultEntry": { "get": { "summary": "Get vtpDiscoverResultEntry list", "description": "Retrieve list of vtpDiscoverResultEntry entries from MIB", "tags": [ "CISCO-VTP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A conceptual row is created for each VTP member which\n is found through successful discovery.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref" }, "vtpDiscoverResultIndex": { "type": "integer", "description": "A value assigned by the system which identifies\n a VTP member and the associated database in the \n management domain.", "minimum": 0, "maximum": 4294967295 }, "vtpDiscoverResultDatabaseName": { "type": "string", "description": "The database name associated with the\n discovered VTP member.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "vtpDiscoverResultConflicting": { "type": "boolean", "description": "Indicates whether this VTP member contains\n conflicting information.\n \n true(1) indicates that this member has conflicting \n information of the database type in the management domain.\n \n false(2) indicates that there is no conflicting information\n of the database type in the management domain." }, "vtpDiscoverResultDeviceId": { "type": "string", "description": "The unique identifier of the device for this VTP member.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "vtpDiscoverResultPrimaryServer": { "type": "string", "description": "The unique identifier of the primary server for this VTP\n member and the associated database type.\n \n There are two different VTP servers, the primary server\n and the secondary server. When a local device is\n configured as a server for a certain database type,\n it becomes secondary server by default. \n Primary server is an operational role under which a\n server can initiate or change the VTP configuration of the\n database type.\n \n If this VTP member itself is the primary server, the \n value of this object is the same as the value of \n vtpDiscoverResultDeviceId of the instance.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "vtpDiscoverResultRevNumber": { "type": "integer", "description": "The current configuration revision number as known by the\n VTP member. When the database type is unknown for\n the VTP member, this value is 0.", "minimum": 0, "maximum": 4294967295 }, "vtpDiscoverResultSystemName": { "type": "string", "description": "sysName of the VTP member.", "x-yang-type": "snmp-framework:SnmpAdminString" } } } }, "example": { "CISCO-VTP-MIB:vtpDiscoverResultEntry": [ { "managementDomainIndex": "example-string", "vtpDiscoverResultIndex": 1, "vtpDiscoverResultDatabaseName": "interface-1", "vtpDiscoverResultConflicting": true, "vtpDiscoverResultDeviceId": "example-string", "vtpDiscoverResultPrimaryServer": "example-string", "vtpDiscoverResultRevNumber": 0, "vtpDiscoverResultSystemName": "interface-1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vtpDiscoverResultEntry", "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": "/vtpDiscoverResultTable/vtpDiscoverResultEntry", "x-restconf-kind": "container" }, "/data/CISCO-VTP-MIB:vtpDatabaseTable": { "get": { "summary": "Get vtpDatabaseTable data", "description": "Retrieve vtpDatabaseTable operational data from MIB", "tags": [ "CISCO-VTP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table contains information of the VTP\n databases. It is not instantiated when\n managementDomainVersionInUse is version1(1), \n version2(3) or none(3).", "properties": { "vtpDatabaseEntry": { "type": "array", "description": "Information about the status of the VTP database\n in the domain. Each VTP database type known to the\n local device type has an entry in this table.\n An entry is also created for unknown database which is\n notified through VTP advertisements from other VTP\n servers.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref" }, "vtpDatabaseIndex": { "type": "integer", "description": "A value assigned by the system which uniquely identifies\n a VTP database in the local system.", "minimum": 0, "maximum": 4294967295 }, "vtpDatabaseName": { "type": "string", "description": "The name of the database.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "vtpDatabaseLocalMode": { "type": "string", "description": "The local VTP mode for a particular database type\n in this administrative domain.\n \n - 'client' indicates that the local system is acting\n as a VTP client of the database type.\n \n - 'server' indicates that the local system is acting\n as a VTP server of the database type.\n \n - 'transparent' indicates that the local system does\n not generate or listen to VTP messages of this \n database type, but forwards\n messages. This mode can also be set by the device\n itself when the size of database is too large for it\n to hold in DRAM.\n \n - 'off' indicates that the local system does not\n generate, listen to or forward any VTP messages\n of this database type.\n \n The default mode is 'client' for the database type \n known to the local device and 'transparent' for the\n unknown database type." }, "vtpDatabaseRevNumber": { "type": "integer", "description": "The current configuration revision number as known by the\n local device for this VTP 3 database type in the management\n domain. This value is updated (if necessary) whenever a \n VTP advertisement for the database type is received \n or generated. When the database type is unknown to the \n local device or no VTP advertisement for the database\n type is received or generated, its value is 0.", "minimum": 0, "maximum": 4294967295 }, "vtpDatabasePrimaryServer": { "type": "boolean", "description": "There are two kinds of VTP version 3 servers for a certain\n database type - the primary server and the secondary server.\n When a local device is configured as a server for a certain\n database type, it becomes secondary server by default.\n Primary server is an operational role under which a\n server can initiate or change the VTP configuration of the\n database type.\n \n A true(1) value indicates that the local device is the \n primary server of the database type in the management\n domain. A false(2) value indicates that the local device\n is not the primary server, or the database type is unknown\n to the local device." }, "vtpDatabasePrimaryServerId": { "type": "string", "description": "The unique identifier of the primary server in the\n management domain for the database type. \n \n If no primary server is discovered for the database\n type, the object has a value of zero length string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "vtpDatabaseTakeOverPrimary": { "type": "boolean", "description": "There are two kinds of VTP version 3 servers for a certain\n database type - the primary server and the secondary server.\n When a local device is configured as a server for a certain\n database type, it becomes secondary server by default.\n Primary server is an operational role under which a\n server can initiate or change the VTP configuration of the\n database type.\n \n Setting this object to a true(1) value will advertise the\n configuration of this database type to the whole domain.\n \n In order to successfully setting this object to true(1),\n the value of vtpDatabaseLocalMode must be server(2). Besides\n that, when the VTP password is hidden from the configuration\n file, the password (vtpDatabaseTakeOverPassword) which \n matches the secret key (vtpAuthSecretKey) must be provided\n in the same data packet. \n \n When read, the object always returns false(2)." }, "vtpDatabaseTakeOverPassword": { "type": "string", "description": "When read, this object always returns the value of a\n zero-length octet string.\n \n In the case that the VTP password is hidden from the \n configuration and the local device intends\n to take over the whole domain, this object must be \n set to the matching password with the secret key \n (vtpAuthSecretKey) in the same data packet as which \n the vtpDatabaseTakeOverPrimary is in. In all the \n other situations, setting a valid value to this object \n has no impact on the system.", "x-yang-type": "snmp-framework:SnmpAdminString" } } } } } }, "example": { "CISCO-VTP-MIB:vtpDatabaseTable": { "vtpDatabaseEntry": [ { "managementDomainIndex": "1", "vtpDatabaseIndex": 1, "vtpDatabaseName": "interface-1", "vtpDatabaseLocalMode": "example-string", "vtpDatabaseRevNumber": 0, "vtpDatabasePrimaryServer": true, "vtpDatabasePrimaryServerId": "example-string", "vtpDatabaseTakeOverPrimary": true, "vtpDatabaseTakeOverPassword": "example-string" }, { "managementDomainIndex": "2", "vtpDatabaseIndex": 2, "vtpDatabaseName": "interface-1", "vtpDatabaseLocalMode": "example-string", "vtpDatabaseRevNumber": 0, "vtpDatabasePrimaryServer": true, "vtpDatabasePrimaryServerId": "example-string", "vtpDatabaseTakeOverPrimary": true, "vtpDatabaseTakeOverPassword": "example-string" }, { "managementDomainIndex": "3", "vtpDatabaseIndex": 3, "vtpDatabaseName": "interface-1", "vtpDatabaseLocalMode": "example-string", "vtpDatabaseRevNumber": 0, "vtpDatabasePrimaryServer": true, "vtpDatabasePrimaryServerId": "example-string", "vtpDatabaseTakeOverPrimary": true, "vtpDatabaseTakeOverPassword": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vtpDatabaseTable", "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": "/vtpDatabaseTable", "x-restconf-kind": "container" }, "/data/CISCO-VTP-MIB:vtpDatabaseTable/vtpDatabaseEntry": { "get": { "summary": "Get vtpDatabaseEntry list", "description": "Retrieve list of vtpDatabaseEntry entries from MIB", "tags": [ "CISCO-VTP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Information about the status of the VTP database\n in the domain. Each VTP database type known to the\n local device type has an entry in this table.\n An entry is also created for unknown database which is\n notified through VTP advertisements from other VTP\n servers.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref" }, "vtpDatabaseIndex": { "type": "integer", "description": "A value assigned by the system which uniquely identifies\n a VTP database in the local system.", "minimum": 0, "maximum": 4294967295 }, "vtpDatabaseName": { "type": "string", "description": "The name of the database.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "vtpDatabaseLocalMode": { "type": "string", "description": "The local VTP mode for a particular database type\n in this administrative domain.\n \n - 'client' indicates that the local system is acting\n as a VTP client of the database type.\n \n - 'server' indicates that the local system is acting\n as a VTP server of the database type.\n \n - 'transparent' indicates that the local system does\n not generate or listen to VTP messages of this \n database type, but forwards\n messages. This mode can also be set by the device\n itself when the size of database is too large for it\n to hold in DRAM.\n \n - 'off' indicates that the local system does not\n generate, listen to or forward any VTP messages\n of this database type.\n \n The default mode is 'client' for the database type \n known to the local device and 'transparent' for the\n unknown database type." }, "vtpDatabaseRevNumber": { "type": "integer", "description": "The current configuration revision number as known by the\n local device for this VTP 3 database type in the management\n domain. This value is updated (if necessary) whenever a \n VTP advertisement for the database type is received \n or generated. When the database type is unknown to the \n local device or no VTP advertisement for the database\n type is received or generated, its value is 0.", "minimum": 0, "maximum": 4294967295 }, "vtpDatabasePrimaryServer": { "type": "boolean", "description": "There are two kinds of VTP version 3 servers for a certain\n database type - the primary server and the secondary server.\n When a local device is configured as a server for a certain\n database type, it becomes secondary server by default.\n Primary server is an operational role under which a\n server can initiate or change the VTP configuration of the\n database type.\n \n A true(1) value indicates that the local device is the \n primary server of the database type in the management\n domain. A false(2) value indicates that the local device\n is not the primary server, or the database type is unknown\n to the local device." }, "vtpDatabasePrimaryServerId": { "type": "string", "description": "The unique identifier of the primary server in the\n management domain for the database type. \n \n If no primary server is discovered for the database\n type, the object has a value of zero length string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "vtpDatabaseTakeOverPrimary": { "type": "boolean", "description": "There are two kinds of VTP version 3 servers for a certain\n database type - the primary server and the secondary server.\n When a local device is configured as a server for a certain\n database type, it becomes secondary server by default.\n Primary server is an operational role under which a\n server can initiate or change the VTP configuration of the\n database type.\n \n Setting this object to a true(1) value will advertise the\n configuration of this database type to the whole domain.\n \n In order to successfully setting this object to true(1),\n the value of vtpDatabaseLocalMode must be server(2). Besides\n that, when the VTP password is hidden from the configuration\n file, the password (vtpDatabaseTakeOverPassword) which \n matches the secret key (vtpAuthSecretKey) must be provided\n in the same data packet. \n \n When read, the object always returns false(2)." }, "vtpDatabaseTakeOverPassword": { "type": "string", "description": "When read, this object always returns the value of a\n zero-length octet string.\n \n In the case that the VTP password is hidden from the \n configuration and the local device intends\n to take over the whole domain, this object must be \n set to the matching password with the secret key \n (vtpAuthSecretKey) in the same data packet as which \n the vtpDatabaseTakeOverPrimary is in. In all the \n other situations, setting a valid value to this object \n has no impact on the system.", "x-yang-type": "snmp-framework:SnmpAdminString" } } } }, "example": { "CISCO-VTP-MIB:vtpDatabaseEntry": [ { "managementDomainIndex": "example-string", "vtpDatabaseIndex": 1, "vtpDatabaseName": "interface-1", "vtpDatabaseLocalMode": "example-string", "vtpDatabaseRevNumber": 0, "vtpDatabasePrimaryServer": true, "vtpDatabasePrimaryServerId": "example-string", "vtpDatabaseTakeOverPrimary": true, "vtpDatabaseTakeOverPassword": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vtpDatabaseEntry", "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": "/vtpDatabaseTable/vtpDatabaseEntry", "x-restconf-kind": "container" }, "/data/CISCO-VTP-MIB:vtpAuthenticationTable": { "get": { "summary": "Get vtpAuthenticationTable data", "description": "Retrieve vtpAuthenticationTable operational data from MIB", "tags": [ "CISCO-VTP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "vtpAuthenticationTable", "properties": { "vtpAuthEntry": { "type": "array", "description": "Information about the status of the VTP\n authentication information in one domain.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref" }, "vtpAuthPassword": { "type": "string", "description": "By default, this object has a value of a zero-length\n character string and is considered to be not\n configured.\n \n The device uses the password to generate the \n secret key. It can be stored in the configuration in \n plain text or hidden from the configuration. If a VTP \n server intends to modify the database's configuration\n in the domain but the password was hidden from the\n configuration, the same password\n (vtpDatabaseTakeOverPassword) as the hidden one\n has to be provided.\n \n When this object is set alone, vtpAuthPasswordType is\n set to plaintext(1) automatically by the system.\n Setting this object to a zero length character string\n resets the password to its default value and the\n password is considered as not configured.\n \n This object is not allowed to be set at the same time\n when vtpAuthSecretKey is set.\n \n When the vtpAuthPasswordType is hidden(2), this object \n will return a zero-length character string when read.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "vtpAuthPasswordType": { "type": "string", "description": "By default this object has the value as plaintext(1)\n and the VTP password is stored in the configuration\n file in plain text.\n \n Setting this object to hidden(2) will hide the\n password from the configuration.\n \n Once this object is set to hidden(2), it cannot\n be set to plaintext(1) alone. However, it may\n be set to plaintext(1) at the same time the\n password is set." }, "vtpAuthSecretKey": { "type": "string", "description": "The device creating or modifying the VTP configuration\n signs it using the MD5 digest generated from the secret\n key before advertising it. Other devices in the domain\n receiving this configuration use the same secret key\n to accept it if it was correctly signed or drop it \n otherwise.\n \n By default, the object has the value as a zero-length\n string and this value is read only. It is set \n to this value automatically when the password \n (vtpAuthPassword) is set to a zero-length octet string.\n \n The secret key can be either generated using\n the password or configured by the user. Once\n the secret key is configured by the user, it is\n stored as a hexadecimal string in the device's\n configuration and the password is considered to be\n the secret key's matching password and hidden\n from the configuration automatically.\n \n This object is not allowed to be set at the same\n time when vtpAuthPassword is set.\n \n The secret key is overwritten by a newly generated\n secret key when the password is re-configured.", "format": "binary" } } } } } }, "example": { "CISCO-VTP-MIB:vtpAuthenticationTable": { "vtpAuthEntry": [ { "managementDomainIndex": "1", "vtpAuthPassword": "example-string", "vtpAuthPasswordType": "ethernetCsmacd(6)", "vtpAuthSecretKey": "example-string" }, { "managementDomainIndex": "2", "vtpAuthPassword": "example-string", "vtpAuthPasswordType": "ethernetCsmacd(6)", "vtpAuthSecretKey": "example-string" }, { "managementDomainIndex": "3", "vtpAuthPassword": "example-string", "vtpAuthPasswordType": "ethernetCsmacd(6)", "vtpAuthSecretKey": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vtpAuthenticationTable", "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": "/vtpAuthenticationTable", "x-restconf-kind": "container" }, "/data/CISCO-VTP-MIB:vtpAuthenticationTable/vtpAuthEntry": { "get": { "summary": "Get vtpAuthEntry list", "description": "Retrieve list of vtpAuthEntry entries from MIB", "tags": [ "CISCO-VTP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Information about the status of the VTP\n authentication information in one domain.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref" }, "vtpAuthPassword": { "type": "string", "description": "By default, this object has a value of a zero-length\n character string and is considered to be not\n configured.\n \n The device uses the password to generate the \n secret key. It can be stored in the configuration in \n plain text or hidden from the configuration. If a VTP \n server intends to modify the database's configuration\n in the domain but the password was hidden from the\n configuration, the same password\n (vtpDatabaseTakeOverPassword) as the hidden one\n has to be provided.\n \n When this object is set alone, vtpAuthPasswordType is\n set to plaintext(1) automatically by the system.\n Setting this object to a zero length character string\n resets the password to its default value and the\n password is considered as not configured.\n \n This object is not allowed to be set at the same time\n when vtpAuthSecretKey is set.\n \n When the vtpAuthPasswordType is hidden(2), this object \n will return a zero-length character string when read.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "vtpAuthPasswordType": { "type": "string", "description": "By default this object has the value as plaintext(1)\n and the VTP password is stored in the configuration\n file in plain text.\n \n Setting this object to hidden(2) will hide the\n password from the configuration.\n \n Once this object is set to hidden(2), it cannot\n be set to plaintext(1) alone. However, it may\n be set to plaintext(1) at the same time the\n password is set." }, "vtpAuthSecretKey": { "type": "string", "description": "The device creating or modifying the VTP configuration\n signs it using the MD5 digest generated from the secret\n key before advertising it. Other devices in the domain\n receiving this configuration use the same secret key\n to accept it if it was correctly signed or drop it \n otherwise.\n \n By default, the object has the value as a zero-length\n string and this value is read only. It is set \n to this value automatically when the password \n (vtpAuthPassword) is set to a zero-length octet string.\n \n The secret key can be either generated using\n the password or configured by the user. Once\n the secret key is configured by the user, it is\n stored as a hexadecimal string in the device's\n configuration and the password is considered to be\n the secret key's matching password and hidden\n from the configuration automatically.\n \n This object is not allowed to be set at the same\n time when vtpAuthPassword is set.\n \n The secret key is overwritten by a newly generated\n secret key when the password is re-configured.", "format": "binary" } } } }, "example": { "CISCO-VTP-MIB:vtpAuthEntry": [ { "managementDomainIndex": "example-string", "vtpAuthPassword": "example-string", "vtpAuthPasswordType": "ethernetCsmacd(6)", "vtpAuthSecretKey": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vtpAuthEntry", "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": "/vtpAuthenticationTable/vtpAuthEntry", "x-restconf-kind": "container" }, "/data/CISCO-VTP-MIB:vtpAuthenticationTable/vtpAuthEntry={managementDomainIndex}": { "get": { "summary": "Get vtpAuthEntry entry", "description": "Retrieve specific vtpAuthEntry entry by key from MIB", "tags": [ "CISCO-VTP-MIB" ], "parameters": [ { "name": "managementDomainIndex", "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": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref" }, "vtpAuthPassword": { "type": "string", "description": "By default, this object has a value of a zero-length\n character string and is considered to be not\n configured.\n \n The device uses the password to generate the \n secret key. It can be stored in the configuration in \n plain text or hidden from the configuration. If a VTP \n server intends to modify the database's configuration\n in the domain but the password was hidden from the\n configuration, the same password\n (vtpDatabaseTakeOverPassword) as the hidden one\n has to be provided.\n \n When this object is set alone, vtpAuthPasswordType is\n set to plaintext(1) automatically by the system.\n Setting this object to a zero length character string\n resets the password to its default value and the\n password is considered as not configured.\n \n This object is not allowed to be set at the same time\n when vtpAuthSecretKey is set.\n \n When the vtpAuthPasswordType is hidden(2), this object \n will return a zero-length character string when read.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "vtpAuthPasswordType": { "type": "string", "description": "By default this object has the value as plaintext(1)\n and the VTP password is stored in the configuration\n file in plain text.\n \n Setting this object to hidden(2) will hide the\n password from the configuration.\n \n Once this object is set to hidden(2), it cannot\n be set to plaintext(1) alone. However, it may\n be set to plaintext(1) at the same time the\n password is set." }, "vtpAuthSecretKey": { "type": "string", "description": "The device creating or modifying the VTP configuration\n signs it using the MD5 digest generated from the secret\n key before advertising it. Other devices in the domain\n receiving this configuration use the same secret key\n to accept it if it was correctly signed or drop it \n otherwise.\n \n By default, the object has the value as a zero-length\n string and this value is read only. It is set \n to this value automatically when the password \n (vtpAuthPassword) is set to a zero-length octet string.\n \n The secret key can be either generated using\n the password or configured by the user. Once\n the secret key is configured by the user, it is\n stored as a hexadecimal string in the device's\n configuration and the password is considered to be\n the secret key's matching password and hidden\n from the configuration automatically.\n \n This object is not allowed to be set at the same\n time when vtpAuthPassword is set.\n \n The secret key is overwritten by a newly generated\n secret key when the password is re-configured.", "format": "binary" } } }, "example": { "CISCO-VTP-MIB:vtpAuthEntry": { "managementDomainIndex": "example-string", "vtpAuthPassword": "example-string", "vtpAuthPasswordType": "ethernetCsmacd(6)", "vtpAuthSecretKey": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vtpAuthEntry-2" }, "x-yang-path": "/vtpAuthenticationTable/vtpAuthEntry={managementDomainIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "managementDomainIndex" ] }, "/data/CISCO-VTP-MIB:managementDomainEntry": { "get": { "summary": "Get managementDomainEntry list", "description": "Retrieve list of managementDomainEntry entries from MIB", "tags": [ "CISCO-VTP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Information about the status of one management domain.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "An arbitrary value to uniquely identify the management\n domain on the local system.", "x-yang-type": "CISCO-VTP-MIB:ManagementDomainIndex" }, "managementDomainName": { "type": "string", "description": "The management name of a domain in which the local system\n is participating. The zero-length name corresponds to the\n 'no management-domain' state which is the initial value at\n installation-time if not configured otherwise. Note that\n the zero-length name does not correspond to an operational\n management domain, and a device does not send VTP\n advertisements while in the 'no management-domain' state. A\n device leaves the 'no management-domain' state when it\n obtains a management-domain name, either through\n configuration or through inheriting the management-domain\n name from a received VTP advertisement.\n \n When the value of an existing instance of this object is\n modified by network management, the local system should re-\n initialize its VLAN information (for the given management\n domain) as if it had just been configured with a management\n domain name at installation time.", "x-yang-type": "snmpv2-tc:DisplayString" }, "managementDomainLocalMode": { "type": "string", "description": "The local VTP mode in this management domain when\n managementDomainVersionInUse is version1(1) or\n version2(2).\n \n If managementDomainVersionInUse is version3(4), this \n object has the same value with vtpDatabaseLocalMode \n of VLAN database type.\n \n - 'client' indicates that the local system is acting\n as a VTP client.\n \n - 'server' indicates that the local system is acting\n as a VTP server.\n \n - 'transparent' indicates that the local system does\n not generate or listen to VTP messages, but forwards\n messages. This mode can also be set by the device\n itself when the amount of VLAN information is too\n large for it to hold in DRAM.\n \n - 'off' indicates that the local system does not\n generate, listen to or forward any VTP messages." }, "managementDomainConfigRevNumber": { "type": "integer", "description": "The current Configuration Revision Number as known by\n the local device for this management domain when \n managementDomainVersionInUse is version1(1) or \n version2(2).\n \n If managementDomainVersionInUse is version3(4), this \n object has the same value with vtpDatabaseRevisionNumber \n of VLAN database type.\n \n This value is updated (if necessary) whenever a VTP\n advertisement is received or generated. When in the\n 'no management-domain' state, this value is 0.", "minimum": 0, "maximum": 4294967295 }, "managementDomainLastUpdater": { "type": "string", "description": "The IP-address (or one of them) of the VTP Server which\n last updated the Configuration Revision Number, as indicated\n in the most recently received VTP advertisement for this\n management domain, when managementDomainVersionInUse is\n version1(1) or version2(2). \n \n If managementDomainVersionInUse is version3(4), this object\n has the value of 0.0.0.0.\n \n Before an advertisement has been received, this value is\n 0.0.0.0.", "format": "inet:ipv4-address" }, "managementDomainLastChange": { "type": "string", "description": "The time at which the Configuration Revision Number was\n (last) increased to its current value, as indicated in the\n most recently received VTP advertisement for this management\n domain when managementDomainVersionInUse is not version3(4)\n or in the most recently received VTP VLAN database \n advertisement for this management domain when \n managementDomainVersionInUse is version3(4).\n \n The value 0x0000010100000000 indicates that the device which\n last increased the Configuration Revision Number had no idea\n of the date/time, or that no advertisement has been\n received.", "x-yang-type": "snmpv2-tc:DateAndTime" }, "managementDomainRowStatus": { "type": "string", "description": "The status of this conceptual row.", "x-yang-type": "snmpv2-tc:RowStatus" }, "managementDomainTftpServer": { "type": "string", "description": "The IP address of a TFTP Server in/from which VTP VLAN\n information for this management domain is to be\n stored/retrieved. If the information is being locally\n stored in NVRAM, this object should take the value 0.0.0.0.", "format": "inet:ipv4-address" }, "managementDomainTftpPathname": { "type": "string", "description": "The complete pathname of the file at the TFTP Server\n identified by the value of managementDomainTftpServer\n in/from which VTP VLAN information for this management\n domain is to be stored/retrieved. If the value of\n corresponding instance of managementDomainTftpServer is\n 0.0.0.0, the value of this object is ignored.", "x-yang-type": "snmpv2-tc:DisplayString" }, "managementDomainPruningState": { "type": "string", "description": "An indication of whether VTP pruning is enabled or disabled\n in this managament domain. \n \n This object can only be modified, either when the \n corresponding instance value of managementDomainVersionInUse \n is 'version1' or 'version2' and the corresponding instance \n value of managementDomainLocalMode is 'server', or when the \n corresponding instance value of managementDomainVersionInUse \n is 'version3' and the corresponding instance value of \n managementDomainLocalMode is 'server' or 'client'." }, "managementDomainVersionInUse": { "type": "string", "description": "The current version of the VTP that is in use by the\n designated management domain. \n \n This object can be set to none(3) only when \n vtpVersion is none(3)." }, "managementDomainPruningStateOper": { "type": "string", "description": "Indicates whether VTP pruning is operationally enabled or\n disabled in this managament domain." }, "managementDomainAdminSrcIf": { "type": "string", "description": "The object specifies the interface to be used as the\n preferred source interface for the VTP IP updater address.\n \n A zero length value indicates that a source interface is not\n specified.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "managementDomainSourceOnlyMode": { "type": "boolean", "description": "The object specifies whether to use only the IP address of\n managementDomainAdminSrcIf as the VTP IP updater address. \n \n 'true' indicates to only use the IP address of \n managementDomainAdminSrcIf as the VTP IP \n updater address. \n \n 'false' indicates to use the IP address of \n managementDomainAdminSrcIf as the VTP IP \n updater address if managementDomainAdminSrcIf \n is configured with an IP address. Otherwise, the \n first available IP address of the system will\n be used." }, "managementDomainOperSrcIf": { "type": "string", "description": "The object indicates the interface used as the\n preferred source interface for the VTP IP updater address.\n \n A zero length string indicates that a source interface is not\n available.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "managementDomainConfigFile": { "type": "string", "description": "The object specifies the file name where VTP configuration\n is stored in the format of or :[].\n \n can be (but not limited to): flash, bootflash,\n slot0, slot1, disk0.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "managementDomainLocalUpdaterType": { "type": "string", "description": "The object indicates the type of the Internet address\n of the preferred source interface for the VTP IP updater.\n \n The value of this object is 'unknown' if\n managementDomainVersionInUse is 'version3' or\n managementDomainLocalMode is not 'server'.", "x-yang-type": "inet-address:InetAddressType" }, "managementDomainLocalUpdater": { "type": "string", "description": "The object indicates the Internet address of the\n preferred source interface for the VTP IP updater.", "x-yang-type": "inet-address:InetAddress" }, "managementDomainDeviceID": { "type": "string", "description": "The object indicates a value that uniquely identifies\n this device within a VTP Domain.\n \n The value of this object is zero length string if\n managementDomainVersionInUse is not 'version3'.", "x-yang-type": "snmp-framework:SnmpAdminString" } } } }, "example": { "CISCO-VTP-MIB:managementDomainEntry": [ { "managementDomainIndex": "example-string", "managementDomainName": "interface-1", "managementDomainLocalMode": "example-string", "managementDomainConfigRevNumber": 0, "managementDomainLastUpdater": "example-string", "managementDomainLastChange": "example-string", "managementDomainRowStatus": "up(1)", "managementDomainTftpServer": "example-string", "managementDomainTftpPathname": "interface-1", "managementDomainPruningState": "up(1)", "managementDomainVersionInUse": "example-string", "managementDomainPruningStateOper": "up(1)", "managementDomainAdminSrcIf": "example-string", "managementDomainSourceOnlyMode": true, "managementDomainOperSrcIf": "example-string", "managementDomainConfigFile": "example-string", "managementDomainLocalUpdaterType": "ethernetCsmacd(6)", "managementDomainLocalUpdater": "example-string", "managementDomainDeviceID": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-managementDomainEntry-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": "/managementDomainEntry", "x-restconf-kind": "container" }, "/data/CISCO-VTP-MIB:managementDomainEntry={managementDomainIndex}": { "get": { "summary": "Get managementDomainEntry entry", "description": "Retrieve specific managementDomainEntry entry by key from MIB", "tags": [ "CISCO-VTP-MIB" ], "parameters": [ { "name": "managementDomainIndex", "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": { "managementDomainIndex": { "type": "string", "description": "An arbitrary value to uniquely identify the management\n domain on the local system.", "x-yang-type": "CISCO-VTP-MIB:ManagementDomainIndex" }, "managementDomainName": { "type": "string", "description": "The management name of a domain in which the local system\n is participating. The zero-length name corresponds to the\n 'no management-domain' state which is the initial value at\n installation-time if not configured otherwise. Note that\n the zero-length name does not correspond to an operational\n management domain, and a device does not send VTP\n advertisements while in the 'no management-domain' state. A\n device leaves the 'no management-domain' state when it\n obtains a management-domain name, either through\n configuration or through inheriting the management-domain\n name from a received VTP advertisement.\n \n When the value of an existing instance of this object is\n modified by network management, the local system should re-\n initialize its VLAN information (for the given management\n domain) as if it had just been configured with a management\n domain name at installation time.", "x-yang-type": "snmpv2-tc:DisplayString" }, "managementDomainLocalMode": { "type": "string", "description": "The local VTP mode in this management domain when\n managementDomainVersionInUse is version1(1) or\n version2(2).\n \n If managementDomainVersionInUse is version3(4), this \n object has the same value with vtpDatabaseLocalMode \n of VLAN database type.\n \n - 'client' indicates that the local system is acting\n as a VTP client.\n \n - 'server' indicates that the local system is acting\n as a VTP server.\n \n - 'transparent' indicates that the local system does\n not generate or listen to VTP messages, but forwards\n messages. This mode can also be set by the device\n itself when the amount of VLAN information is too\n large for it to hold in DRAM.\n \n - 'off' indicates that the local system does not\n generate, listen to or forward any VTP messages." }, "managementDomainConfigRevNumber": { "type": "integer", "description": "The current Configuration Revision Number as known by\n the local device for this management domain when \n managementDomainVersionInUse is version1(1) or \n version2(2).\n \n If managementDomainVersionInUse is version3(4), this \n object has the same value with vtpDatabaseRevisionNumber \n of VLAN database type.\n \n This value is updated (if necessary) whenever a VTP\n advertisement is received or generated. When in the\n 'no management-domain' state, this value is 0.", "minimum": 0, "maximum": 4294967295 }, "managementDomainLastUpdater": { "type": "string", "description": "The IP-address (or one of them) of the VTP Server which\n last updated the Configuration Revision Number, as indicated\n in the most recently received VTP advertisement for this\n management domain, when managementDomainVersionInUse is\n version1(1) or version2(2). \n \n If managementDomainVersionInUse is version3(4), this object\n has the value of 0.0.0.0.\n \n Before an advertisement has been received, this value is\n 0.0.0.0.", "format": "inet:ipv4-address" }, "managementDomainLastChange": { "type": "string", "description": "The time at which the Configuration Revision Number was\n (last) increased to its current value, as indicated in the\n most recently received VTP advertisement for this management\n domain when managementDomainVersionInUse is not version3(4)\n or in the most recently received VTP VLAN database \n advertisement for this management domain when \n managementDomainVersionInUse is version3(4).\n \n The value 0x0000010100000000 indicates that the device which\n last increased the Configuration Revision Number had no idea\n of the date/time, or that no advertisement has been\n received.", "x-yang-type": "snmpv2-tc:DateAndTime" }, "managementDomainRowStatus": { "type": "string", "description": "The status of this conceptual row.", "x-yang-type": "snmpv2-tc:RowStatus" }, "managementDomainTftpServer": { "type": "string", "description": "The IP address of a TFTP Server in/from which VTP VLAN\n information for this management domain is to be\n stored/retrieved. If the information is being locally\n stored in NVRAM, this object should take the value 0.0.0.0.", "format": "inet:ipv4-address" }, "managementDomainTftpPathname": { "type": "string", "description": "The complete pathname of the file at the TFTP Server\n identified by the value of managementDomainTftpServer\n in/from which VTP VLAN information for this management\n domain is to be stored/retrieved. If the value of\n corresponding instance of managementDomainTftpServer is\n 0.0.0.0, the value of this object is ignored.", "x-yang-type": "snmpv2-tc:DisplayString" }, "managementDomainPruningState": { "type": "string", "description": "An indication of whether VTP pruning is enabled or disabled\n in this managament domain. \n \n This object can only be modified, either when the \n corresponding instance value of managementDomainVersionInUse \n is 'version1' or 'version2' and the corresponding instance \n value of managementDomainLocalMode is 'server', or when the \n corresponding instance value of managementDomainVersionInUse \n is 'version3' and the corresponding instance value of \n managementDomainLocalMode is 'server' or 'client'." }, "managementDomainVersionInUse": { "type": "string", "description": "The current version of the VTP that is in use by the\n designated management domain. \n \n This object can be set to none(3) only when \n vtpVersion is none(3)." }, "managementDomainPruningStateOper": { "type": "string", "description": "Indicates whether VTP pruning is operationally enabled or\n disabled in this managament domain." }, "managementDomainAdminSrcIf": { "type": "string", "description": "The object specifies the interface to be used as the\n preferred source interface for the VTP IP updater address.\n \n A zero length value indicates that a source interface is not\n specified.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "managementDomainSourceOnlyMode": { "type": "boolean", "description": "The object specifies whether to use only the IP address of\n managementDomainAdminSrcIf as the VTP IP updater address. \n \n 'true' indicates to only use the IP address of \n managementDomainAdminSrcIf as the VTP IP \n updater address. \n \n 'false' indicates to use the IP address of \n managementDomainAdminSrcIf as the VTP IP \n updater address if managementDomainAdminSrcIf \n is configured with an IP address. Otherwise, the \n first available IP address of the system will\n be used." }, "managementDomainOperSrcIf": { "type": "string", "description": "The object indicates the interface used as the\n preferred source interface for the VTP IP updater address.\n \n A zero length string indicates that a source interface is not\n available.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "managementDomainConfigFile": { "type": "string", "description": "The object specifies the file name where VTP configuration\n is stored in the format of or :[].\n \n can be (but not limited to): flash, bootflash,\n slot0, slot1, disk0.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "managementDomainLocalUpdaterType": { "type": "string", "description": "The object indicates the type of the Internet address\n of the preferred source interface for the VTP IP updater.\n \n The value of this object is 'unknown' if\n managementDomainVersionInUse is 'version3' or\n managementDomainLocalMode is not 'server'.", "x-yang-type": "inet-address:InetAddressType" }, "managementDomainLocalUpdater": { "type": "string", "description": "The object indicates the Internet address of the\n preferred source interface for the VTP IP updater.", "x-yang-type": "inet-address:InetAddress" }, "managementDomainDeviceID": { "type": "string", "description": "The object indicates a value that uniquely identifies\n this device within a VTP Domain.\n \n The value of this object is zero length string if\n managementDomainVersionInUse is not 'version3'.", "x-yang-type": "snmp-framework:SnmpAdminString" } } }, "example": { "CISCO-VTP-MIB:managementDomainEntry": { "managementDomainIndex": "example-string", "managementDomainName": "interface-1", "managementDomainLocalMode": "example-string", "managementDomainConfigRevNumber": 0, "managementDomainLastUpdater": "example-string", "managementDomainLastChange": "example-string", "managementDomainRowStatus": "up(1)", "managementDomainTftpServer": "example-string", "managementDomainTftpPathname": "interface-1", "managementDomainPruningState": "up(1)", "managementDomainVersionInUse": "example-string", "managementDomainPruningStateOper": "up(1)", "managementDomainAdminSrcIf": "example-string", "managementDomainSourceOnlyMode": true, "managementDomainOperSrcIf": "example-string", "managementDomainConfigFile": "example-string", "managementDomainLocalUpdaterType": "ethernetCsmacd(6)", "managementDomainLocalUpdater": "example-string", "managementDomainDeviceID": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-managementDomainEntry-4" }, "x-yang-path": "/managementDomainEntry={managementDomainIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "managementDomainIndex" ] }, "/data/CISCO-VTP-MIB:vtpVlanEntry": { "get": { "summary": "Get vtpVlanEntry list", "description": "Retrieve list of vtpVlanEntry entries from MIB", "tags": [ "CISCO-VTP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Information about one current VLAN. The\n managementDomainIndex value in the INDEX clause indicates\n which management domain the VLAN is in.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref" }, "vtpVlanIndex": { "type": "string", "description": "The VLAN-id of this VLAN on ISL or 802.1q trunks.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex" }, "vtpVlanState": { "type": "string", "description": "The state of this VLAN.\n \n The state 'mtuTooBigForDevice' indicates that this device\n cannot participate in this VLAN because the VLAN's MTU is\n larger than the device can support.\n \n The state 'mtuTooBigForTrunk' indicates that while this\n VLAN's MTU is supported by this device, it is too large for\n one or more of the device's trunk ports." }, "vtpVlanType": { "type": "string", "description": "The type of this VLAN.", "x-yang-type": "CISCO-VTP-MIB:VlanType" }, "vtpVlanName": { "type": "string", "description": "The name of this VLAN. This name is used as the ELAN-name\n for an ATM LAN-Emulation segment of this VLAN.", "x-yang-type": "snmpv2-tc:DisplayString" }, "vtpVlanMtu": { "type": "integer", "description": "The MTU size on this VLAN, defined as the size of largest\n MAC-layer (information field portion of the) data frame\n which can be transmitted on the VLAN.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanDot10Said": { "type": "string", "description": "The value of the 802.10 SAID field for this VLAN.", "format": "binary" }, "vtpVlanRingNumber": { "type": "integer", "description": "The ring number of this VLAN. This object is only\n instantiated when the value of the corresponding instance of\n vtpVlanType has a value of 'fddi' or 'tokenRing' and Source\n Routing is in use on this VLAN.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanBridgeNumber": { "type": "integer", "description": "The bridge number of the VTP-capable switches for this\n VLAN. This object is only instantiated for VLANs that are\n involved with emulating token ring segments.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanStpType": { "type": "string", "description": "The type of the Spanning Tree Protocol (STP) running on\n this VLAN. This object is only instanciated when the\n value of the corresponding instance of vtpVlanType has a\n value of 'fddiNet' or 'trNet'.\n \n The value returned by this object depends upon the value\n of the corresponding instance of vtpVlanEditStpType.\n \n - 'ieee' indicates IEEE STP is running exclusively.\n \n - 'ibm' indicates IBM STP is running exclusively.\n \n - 'hybrid' indicates a STP that allows a combination of\n IEEE and IBM is running.\n \n The 'hybrid' STP type results from tokenRing/fddi VLANs\n that are children of this trNet/fddiNet parent VLAN being\n configured in a combination of SRT and SRB\n vtpVlanBridgeTypes while the instance of\n vtpVlanEditStpType that corresponds to this object is set\n to 'auto'." }, "vtpVlanParentVlan": { "type": "string", "description": "The parent VLAN for this VLAN. This object is only\n instantiated when the value of the corresponding instance of\n vtpVlanType has a value of 'fddi' or 'tokenRing' and Source\n Routing is in use on this VLAN. The parent VLAN must have \n a vtpVlanType value of fddiNet(4) or trNet(5), \n respectively.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex" }, "vtpVlanTranslationalVlan1": { "type": "string", "description": "A VLAN to which this VLAN is being translational-bridged.\n If this value and the corresponding instance of\n vtpVlanTranslationalVlan2 are both zero, then this VLAN is\n not being translational-bridged.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex" }, "vtpVlanTranslationalVlan2": { "type": "string", "description": "Another VLAN, i.e., other than that indicated by\n vtpVlanTranslationalVlan1, to which this VLAN is being\n translational-bridged. If this value and the corresponding\n instance of vtpVlanTranslationalVlan1 are both zero, then\n this VLAN is not being translational-bridged.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex" }, "vtpVlanBridgeType": { "type": "string", "description": "The type of the Source Route bridging mode in use on this\n VLAN. This object is only instantiated when the value of \n the corresponding instance of vtpVlanType has a value of \n fddi(2) or tokenRing(3) and Source Routing is in use on\n this VLAN." }, "vtpVlanAreHopCount": { "type": "integer", "description": "The maximum number of bridge hops allowed in\n All Routes Explorer frames on this VLAN. This\n object is only instantiated when the value of the\n corresponding instance of vtpVlanType has a value of fddi(2)\n or tokenRing(3) and Source Routing is in use on this VLAN.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanSteHopCount": { "type": "integer", "description": "The maximum number of bridge hops allowed in\n Spanning Tree Explorer frames on this VLAN. This\n object is only instantiated when the value of the\n corresponding instance of vtpVlanType has a value of fddi(2)\n or tokenRing(3) and Source Routing is in use on this VLAN.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanIsCRFBackup": { "type": "boolean", "description": "True if this VLAN is of type trCrf and also is acting as\n a backup trCrf for the ISL distributed BRF" }, "vtpVlanTypeExt": { "type": "string", "description": "The additional type information of this VLAN.", "x-yang-type": "CISCO-VTP-MIB:VlanTypeExt" }, "vtpVlanIfIndex": { "type": "string", "description": "The value of the ifIndex corresponding to this VLAN ID.\n If the VLAN ID does not have its corresponding interface, \n this object has the value of zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero" } } } }, "example": { "CISCO-VTP-MIB:vtpVlanEntry": [ { "managementDomainIndex": "example-string", "vtpVlanIndex": "example-string", "vtpVlanState": "up(1)", "vtpVlanType": "ethernetCsmacd(6)", "vtpVlanName": "interface-1", "vtpVlanMtu": 1500, "vtpVlanDot10Said": "example-string", "vtpVlanRingNumber": -2147483648, "vtpVlanBridgeNumber": -2147483648, "vtpVlanStpType": "ethernetCsmacd(6)", "vtpVlanParentVlan": "example-string", "vtpVlanTranslationalVlan1": "example-string", "vtpVlanTranslationalVlan2": "example-string", "vtpVlanBridgeType": "ethernetCsmacd(6)", "vtpVlanAreHopCount": -2147483648, "vtpVlanSteHopCount": -2147483648, "vtpVlanIsCRFBackup": true, "vtpVlanTypeExt": "ethernetCsmacd(6)", "vtpVlanIfIndex": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vtpVlanEntry-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": "/vtpVlanEntry", "x-restconf-kind": "container" }, "/data/CISCO-VTP-MIB:vtpInternalVlanEntry": { "get": { "summary": "Get vtpInternalVlanEntry list", "description": "Retrieve list of vtpInternalVlanEntry entries from MIB", "tags": [ "CISCO-VTP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Information about one current internal\n VLAN.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref" }, "vtpVlanIndex": { "type": "string", "description": "vtpVlanIndex", "x-yang-type": "leafref" }, "vtpInternalVlanOwner": { "type": "string", "description": "The program name of the internal VLAN's\n owner application. This internal VLAN\n is allocated by the device specifically\n for this application and no one else\n could create, modify or delete this \n VLAN.", "x-yang-type": "snmp-framework:SnmpAdminString" } } } }, "example": { "CISCO-VTP-MIB:vtpInternalVlanEntry": [ { "managementDomainIndex": "example-string", "vtpVlanIndex": "example-string", "vtpInternalVlanOwner": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vtpInternalVlanEntry-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": "/vtpInternalVlanEntry", "x-restconf-kind": "container" }, "/data/CISCO-VTP-MIB:vtpVlanEditEntry": { "get": { "summary": "Get vtpVlanEditEntry list", "description": "Retrieve list of vtpVlanEditEntry entries from MIB", "tags": [ "CISCO-VTP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Information about one VLAN in the Edit Buffer for a\n particular management domain.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref" }, "vtpVlanEditIndex": { "type": "string", "description": "The VLAN-id which this VLAN would have on ISL or\n 802.1q trunks.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex" }, "vtpVlanEditState": { "type": "string", "description": "The state which this VLAN would have." }, "vtpVlanEditType": { "type": "string", "description": "The type which this VLAN would have.\n An implementation may restrict access to this object.", "x-yang-type": "CISCO-VTP-MIB:VlanType" }, "vtpVlanEditName": { "type": "string", "description": "The name which this VLAN would have. This name would be\n used as the ELAN-name for an ATM LAN-Emulation segment of\n this VLAN.\n \n An implementation may restrict access to this object.", "x-yang-type": "snmpv2-tc:DisplayString" }, "vtpVlanEditMtu": { "type": "integer", "description": "The MTU size which this VLAN would have, defined as the\n size of largest MAC-layer (information field portion of the)\n data frame which can be transmitted on the VLAN.\n \n An implementation may restrict access to this object.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanEditDot10Said": { "type": "string", "description": "The value of the 802.10 SAID field which would be used for\n this VLAN.\n \n An implementation may restrict access to this object.", "format": "binary" }, "vtpVlanEditRingNumber": { "type": "integer", "description": "The ring number which would be used for this VLAN. This\n object is only instantiated when the value of the\n corresponding instance of vtpVlanEditType has a value of\n 'fddi' or 'tokenRing' and Source Routing is in use on \n this VLAN.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanEditBridgeNumber": { "type": "integer", "description": "The bridge number of the VTP-capable switches which would\n be used for this VLAN. This object is only instantiated\n when the value of the corresponding instance of\n vtpVlanEditType has a value of fddiNet(4) or trNet(5).", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanEditStpType": { "type": "string", "description": "The type of the Spanning Tree Protocol which would be\n running on this VLAN. This object is only instantiated\n when the value of the corresponding instance of\n vtpVlanEditType has a value of fddiNet(4) or trNet(5).\n \n If 'ieee' is selected, the STP that runs will be IEEE.\n \n If 'ibm' is selected, the STP that runs will be IBM.\n \n If 'auto' is selected, the STP that runs will be\n dependant on the values of vtpVlanEditBridgeType for all\n children tokenRing/fddi type VLANs. This will result in\n a 'hybrid' STP (see vtpVlanStpType)." }, "vtpVlanEditParentVlan": { "type": "string", "description": "The VLAN index of the VLAN which would be the parent for\n this VLAN. This object is only instantiated when the value\n of the corresponding instance of vtpVlanEditType has a value\n of 'fddi' or 'tokenRing' and Source Routing is in use on\n this VLAN. The parent VLAN must have a vtpVlanEditType \n value of fddiNet(4) or trNet(5), respectively.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex" }, "vtpVlanEditRowStatus": { "type": "string", "description": "The status of this row. Any and all columnar objects in an\n existing row can be modified irrespective of the status of\n the row.\n \n A row is not qualified for activation until instances of at\n least its vtpVlanEditType, vtpVlanEditName and\n vtpVlanEditDot10Said columns have appropriate values.\n \n The management station should endeavor to make all rows\n consistent in the table before 'apply'ing the buffer. An\n inconsistent entry in the table will cause the entire\n buffer to be rejected with the vtpVlanApplyStatus object\n set to the appropriate error value.", "x-yang-type": "snmpv2-tc:RowStatus" }, "vtpVlanEditTranslationalVlan1": { "type": "string", "description": "A VLAN to which this VLAN would be translational-bridged.\n If this value and the corresponding instance of\n vtpVlanTranslationalVlan2 are both zero, then this VLAN\n would not be translational-bridged.\n \n An implementation may restrict access to this object.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex" }, "vtpVlanEditTranslationalVlan2": { "type": "string", "description": "Another VLAN, i.e., other than that indicated by\n vtpVlanEditTranslationalVlan1, to which this VLAN would be\n translational-bridged. If this value and the corresponding\n instance of vtpVlanTranslationalVlan1 are both zero, then\n this VLAN would not be translational-bridged.\n \n An implementation may restrict access to this object.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex" }, "vtpVlanEditBridgeType": { "type": "string", "description": "The type of Source Route bridging mode which would be in\n use on this VLAN. This object is only instantiated when \n the value of the corresponding instance of vtpVlanEditType\n has a value of fddi(2) or tokenRing(3) and Source Routing \n is in use on this VLAN." }, "vtpVlanEditAreHopCount": { "type": "integer", "description": "The maximum number of bridge hops allowed in\n All Routes Explorer frames on this VLAN. This\n object is only instantiated when the value of the\n corresponding instance of vtpVlanType has a value of fddi(2)\n or tokenRing(3) and Source Routing is in use on this VLAN.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanEditSteHopCount": { "type": "integer", "description": "The maximum number of bridge hops allowed in\n Spanning Tree Explorer frames on this VLAN. This\n object is only instantiated when the value of the\n corresponding instance of vtpVlanType has a value of fddi(2)\n or tokenRing(3) and Source Routing is in use on this VLAN.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanEditIsCRFBackup": { "type": "boolean", "description": "True if this VLAN is of type trCrf and also is acting as\n a backup trCrf for the ISL distributed BRF. This object is\n only instantiated when the value of the corresponding\n instance of vtpVlanEditType has a value of tokenRing(3)." }, "vtpVlanEditTypeExt": { "type": "string", "description": "The additional type information of this VLAN.\n vtpVlanEditTypeExt object is superseded by vtpVlanEditTypeExt2.", "x-yang-type": "CISCO-VTP-MIB:VlanTypeExt" }, "vtpVlanEditTypeExt2": { "type": "string", "description": "The additional type information of this VLAN.\n The VlanTypeExt TC specifies which bits may\n be written by a management application.\n The agent should provide a default value.", "x-yang-type": "CISCO-VTP-MIB:VlanTypeExt" } } } }, "example": { "CISCO-VTP-MIB:vtpVlanEditEntry": [ { "managementDomainIndex": "example-string", "vtpVlanEditIndex": "example-string", "vtpVlanEditState": "up(1)", "vtpVlanEditType": "ethernetCsmacd(6)", "vtpVlanEditName": "interface-1", "vtpVlanEditMtu": 1500, "vtpVlanEditDot10Said": "example-string", "vtpVlanEditRingNumber": -2147483648, "vtpVlanEditBridgeNumber": -2147483648, "vtpVlanEditStpType": "ethernetCsmacd(6)", "vtpVlanEditParentVlan": "example-string", "vtpVlanEditRowStatus": "up(1)", "vtpVlanEditTranslationalVlan1": "example-string", "vtpVlanEditTranslationalVlan2": "example-string", "vtpVlanEditBridgeType": "ethernetCsmacd(6)", "vtpVlanEditAreHopCount": -2147483648, "vtpVlanEditSteHopCount": -2147483648, "vtpVlanEditIsCRFBackup": true, "vtpVlanEditTypeExt": "ethernetCsmacd(6)", "vtpVlanEditTypeExt2": "ethernetCsmacd(6)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vtpVlanEditEntry-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": "/vtpVlanEditEntry", "x-restconf-kind": "container" }, "/data/CISCO-VTP-MIB:vtpVlanLocalShutdownEntry": { "get": { "summary": "Get vtpVlanLocalShutdownEntry list", "description": "Retrieve list of vtpVlanLocalShutdownEntry entries from MIB", "tags": [ "CISCO-VTP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry containing VLAN local shutdown information for a\n particular VLAN in the management domain.\n \n An entry is created if a VLAN which supports local shutdown\n has been created.\n \n An entry is deleted if a VLAN which supports local shutdown\n has been removed.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref" }, "vtpVlanIndex": { "type": "string", "description": "vtpVlanIndex", "x-yang-type": "leafref" }, "vtpVlanLocalShutdown": { "type": "string", "description": "The object specifies the VLAN local shutdown state." } } } }, "example": { "CISCO-VTP-MIB:vtpVlanLocalShutdownEntry": [ { "managementDomainIndex": "example-string", "vtpVlanIndex": "example-string", "vtpVlanLocalShutdown": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vtpVlanLocalShutdownEntry-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": "/vtpVlanLocalShutdownEntry", "x-restconf-kind": "container" }, "/data/CISCO-VTP-MIB:vlanTrunkPortEntry": { "get": { "summary": "Get vlanTrunkPortEntry list", "description": "Retrieve list of vlanTrunkPortEntry entries from MIB", "tags": [ "CISCO-VTP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Information about one trunk port.", "items": { "type": "object", "properties": { "vlanTrunkPortIfIndex": { "type": "string", "description": "The value of ifIndex for the interface corresponding to\n this trunk port.", "x-yang-type": "if-mib:InterfaceIndex" }, "vlanTrunkPortManagementDomain": { "type": "string", "description": "The value of managementDomainIndex for the management\n domain on this trunk port. Devices which support only one\n management domain will support this object read-only.", "x-yang-type": "CISCO-VTP-MIB:ManagementDomainIndex" }, "vlanTrunkPortEncapsulationType": { "type": "string", "description": "The type of VLAN encapsulation desired to be used on this\n trunk port. It is either a particular type, or 'negotiate'\n meaning whatever type results from the negotiation.\n negotiate(5) is not allowed if the port does not support\n negotiation or if its vlanTrunkPortDynamicState is set to\n on(1) or onNoNegotiate(5). Whether writing to this object\n in order to modify the encapsulation is supported is both\n device and interface specific." }, "vlanTrunkPortVlansEnabled": { "type": "string", "description": "A string of octets containing one bit per VLAN in the\n management domain on this trunk port. The first octet\n corresponds to VLANs with VlanIndex values of 0 through 7;\n the second octet to VLANs 8 through 15; etc. The most\n significant bit of each octet corresponds to the lowest\n value VlanIndex in that octet. If the bit corresponding to\n a VLAN is set to '1', then the local system is enabled for\n sending and receiving frames on that VLAN; if the bit is set\n to '0', then the system is disabled from sending and\n receiving frames on that VLAN.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary" }, "vlanTrunkPortNativeVlan": { "type": "string", "description": "The VlanIndex of the VLAN which is represented by native\n frames on this trunk port. For trunk ports not supporting\n the sending and receiving of native frames, this value\n should be set to zero.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex" }, "vlanTrunkPortRowStatus": { "type": "string", "description": "The status of this row. In some circumstances, the\n creation of a row in this table is needed to enable the\n appropriate trunking/tagging protocol on the port, to enable\n the use of VTP on the port, and to assign the port to the\n appropriate management domain. In other circumstances, rows\n in this table will be created as a by-product of other\n operations.", "x-yang-type": "snmpv2-tc:RowStatus" }, "vlanTrunkPortInJoins": { "type": "integer", "description": "The number of VTP Join messages received on this trunk\n port.", "minimum": 0, "maximum": 4294967295 }, "vlanTrunkPortOutJoins": { "type": "integer", "description": "The number of VTP Join messages sent on this trunk port.", "minimum": 0, "maximum": 4294967295 }, "vlanTrunkPortOldAdverts": { "type": "integer", "description": "The number of VTP Advertisement messages which indicated\n the sender does not support VLAN-pruning received on this\n trunk port.", "minimum": 0, "maximum": 4294967295 }, "vlanTrunkPortVlansPruningEligible": { "type": "string", "description": "A string of octets containing one bit per VLAN in the\n management domain on this trunk port. The first octet\n corresponds to VLANs with VlanIndex values of 0 through 7;\n the second octet to VLANs 8 through 15; etc. The most\n significant bit of each octet corresponds to the lowest\n value VlanIndex in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local system is permitted to prune that VLAN on this trunk\n port; if the bit is set to '0', then the system must not\n prune that VLAN on this trunk port.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary" }, "vlanTrunkPortVlansXmitJoined": { "type": "string", "description": "A string of octets containing one bit per VLAN in the\n management domain on this trunk port. The first octet\n corresponds to VLANs with VlanIndex values of 0 through 7;\n the second octet to VLANs 8 through 15; etc. The most\n significant bit of each octet corresponds to the lowest\n value VlanIndex in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then this\n VLAN is presently being forwarded on this trunk port, i.e.,\n it is not pruned; if the bit is set to '0', then this VLAN\n is presently not being forwarded on this trunk port, either\n because it is pruned or for some other reason.", "format": "binary" }, "vlanTrunkPortVlansRcvJoined": { "type": "string", "description": "A string of octets containing one bit per VLAN in the\n management domain on this trunk port. The first octet\n corresponds to VLANs with VlanIndex values of 0 through 7;\n the second octet to VLANs 8 through 15; etc. The most\n significant bit of each octet corresponds to the lowest\n value VlanIndex in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local switch is currently sending joins for this VLAN on\n this trunk port, i.e., it is asking to receive frames for\n this VLAN; if the bit is set to '0', then the local switch\n is not currently sending joins for this VLAN on this trunk\n port.", "format": "binary" }, "vlanTrunkPortDynamicState": { "type": "string", "description": "For devices that allows dynamic determination of whether\n a link between two switches should be a trunk or not, this\n object allows the operator to mandate the behavior of that\n dynamic mechanism.\n \n on(1) dictates that the interface will always be a\n trunk. This is the value for static entries (those that\n show no dynamic behavior). If the negotiation is supported\n on this port, negotiation will take place with the far end\n to attempt to bring the far end into trunking state.\n \n off(2) allows an operator to specify that the specified\n interface is never to be trunk, regardless of any dynamic\n mechanisms to the contrary. This value is useful for\n overriding the default behavior of some switches. If the\n negotiation is supported on this port, negotiation will take\n place with the far end to attempt on the link to bring the\n far end into non-trunking state.\n \n desirable(3) is used to indicate that it is desirable for\n the interface to become a trunk. The device will initiate\n any negotiation necessary to become a trunk but will not\n become a trunk unless it receives confirmation from the far\n end on the link.\n \n auto(4) is used to indicate that the interface is capable\n and willing to become a trunk but will not initiate\n trunking negotiations. The far end on the link are\n required to either start negotiations or start sending\n encapsulated packets, on which event the specified\n interface will become a trunk.\n \n onNoNegotiate(5) is used to indicate that the interface is\n permanently set to be a trunk, and no negotiation takes\n place with the far end on the link to ensure consistent\n operation. This is similar to on(1) except no negotiation\n takes place with the far end.\n \n If the port does not support negotiation or its\n vlanTrunkPortEncapsulationType is set to negotiate(5),\n onNoNegotiate(5) is not allowed.\n \n Devices that do no support dynamic determination (for just\n a particular interface, encapsulation or for the whole\n device) need only support the 'on', and 'off' values." }, "vlanTrunkPortDynamicStatus": { "type": "string", "description": "Indicates whether the specified interface is either\n acting as a trunk or not. This is a result of the\n vlanTrunkPortDynamicState and the ifOperStatus of the\n trunk port itself." }, "vlanTrunkPortVtpEnabled": { "type": "boolean", "description": "Some trunk interface modules allow VTP to be\n enabled/disabled seperately from that of the central\n device. In such a case this object provides management a\n way to remotely enable VTP on that module. If a module\n does not support a seperate VTP enabled state then this\n object shall always return 'true' and will accept no other\n value during a SET operation." }, "vlanTrunkPortEncapsulationOperType": { "type": "string", "description": "The type of VLAN encapsulation in use on this trunk port.\n For intefaces with vlanTrunkPortDynamicStatus of\n notTrunking(2) the vlanTrunkPortEncapsulationOperType shall\n be notApplicable(6)." }, "vlanTrunkPortVlansEnabled2k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 1024 through 2047 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 1024 through 1031; the second\n octet to VLANs 1032 through 1039; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet. If the bit corresponding to a VLAN is set to\n '1', then the local system is enabled for sending and\n receiving frames on that VLAN; if the bit is set to '0',\n then the system is disabled from sending and receiving\n frames on that VLAN. The default value is zero length\n string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary" }, "vlanTrunkPortVlansEnabled3k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 2048 through 3071 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 2048 through 2055; the second\n octet to VLANs 2056 through 2063; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet. If the bit corresponding to a VLAN is set to\n '1', then the local system is enabled for sending and\n receiving frames on that VLAN; if the bit is set to '0',\n then the system is disabled from sending and receiving\n frames on that VLAN. The default value is zero length\n string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary" }, "vlanTrunkPortVlansEnabled4k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 3072 through 4095 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 3072 through 3079; the second\n octet to VLANs 3080 through 3087; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet. If the bit corresponding to a VLAN is set to\n '1', then the local system is enabled for sending and\n receiving frames on that VLAN; if the bit is set to '0',\n then the system is disabled from sending and receiving\n frames on that VLAN. The default value is zero length\n string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary" }, "vtpVlansPruningEligible2k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 1024 through 2047 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 1024 through 1031; the second\n octet to VLANs 1032 through 1039; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local system is permitted to prune that VLAN on this trunk\n port; if the bit is set to '0', then the system must not\n prune that VLAN on this trunk port.\n The default value is zero length string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary" }, "vtpVlansPruningEligible3k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 2048 through 3071 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 2048 through 2055; the second\n octet to VLANs 2056 through 2063; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local system is permitted to prune that VLAN on this trunk\n port; if the bit is set to '0', then the system must not\n prune that VLAN on this trunk port.\n The default value is zero length string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary" }, "vtpVlansPruningEligible4k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 3072 through 4095 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 3072 through 3079; the second\n octet to VLANs 3080 through 3087; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local system is permitted to prune that VLAN on this trunk\n port; if the bit is set to '0', then the system must not\n prune that VLAN on this trunk port.\n The default value is zero length string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary" }, "vlanTrunkPortVlansXmitJoined2k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 1024 through 2047 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 1024 through 1031; the second\n octet to VLANs 1032 through 1039; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then this\n VLAN is presently being forwarded on this trunk port, i.e.,\n it is not pruned; if the bit is set to '0', then this VLAN\n is presently not being forwarded on this trunk port, either\n because it is pruned or for some other reason.", "format": "binary" }, "vlanTrunkPortVlansXmitJoined3k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 2048 through 3071 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 2048 through 2055; the second\n octet to VLANs 2056 through 2063; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then this\n VLAN is presently being forwarded on this trunk port, i.e.,\n it is not pruned; if the bit is set to '0', then this VLAN\n is presently not being forwarded on this trunk port, either\n because it is pruned or for some other reason.", "format": "binary" }, "vlanTrunkPortVlansXmitJoined4k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 3072 through 4095 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 3072 through 3079; the second\n octet to VLANs 3080 through 3087; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then this\n VLAN is presently being forwarded on this trunk port, i.e.,\n it is not pruned; if the bit is set to '0', then this VLAN\n is presently not being forwarded on this trunk port, either\n because it is pruned or for some other reason.", "format": "binary" }, "vlanTrunkPortVlansRcvJoined2k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 1024 through 2047 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 1024 through 1031; the second\n octet to VLANs 1032 through 1039; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local switch is currently sending joins for this VLAN on\n this trunk port, i.e., it is asking to receive frames for\n this VLAN; if the bit is set to '0', then the local switch\n is not currently sending joins for this VLAN on this trunk\n port.", "format": "binary" }, "vlanTrunkPortVlansRcvJoined3k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 2048 through 3071 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 2048 through 2055; the second\n octet to VLANs 2056 through 2063; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local switch is currently sending joins for this VLAN on\n this trunk port, i.e., it is asking to receive frames for\n this VLAN; if the bit is set to '0', then the local switch\n is not currently sending joins for this VLAN on this trunk\n port.", "format": "binary" }, "vlanTrunkPortVlansRcvJoined4k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 3072 through 4095 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 3072 through 3079; the second\n octet to VLANs 3080 through 3087; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local switch is currently sending joins for this VLAN on\n this trunk port, i.e., it is asking to receive frames for\n this VLAN; if the bit is set to '0', then the local switch\n is not currently sending joins for this VLAN on this trunk\n port.", "format": "binary" }, "vlanTrunkPortDot1qTunnel": { "type": "string", "description": "Indicates dot1qtunnel mode of the port.\n \n If the portDot1qTunnel is set to 'trunk' mode, the port's\n vlanTrunkPortDynamicState will be changed to 'onNoNegotiate'\n and the vlanTrunkPortEncapsulationType will be set to\n 'dot1Q'. These values cannot be changed unless dot1q tunnel\n is disabled on this port.\n \n If the portDot1qTunnel mode is set to 'access' mode, the\n port's vlanTrunkPortDynamicState will be set to 'off'.And\n the value of vlanTrunkPortDynamicState cannot be changed\n unless dot1q tunnel is disabled on this port. 1Q packets\n received on this access port will remain.\n \n Setting the port to dot1q tunnel 'disabled' mode causes the\n dot1q tunnel feature to be disabled on this port. This\n object can't be set to 'trunk' or 'access' mode, when\n vlanTrunkPortsDot1qTag object is set to 'false'.\n \n This object has been deprecated and is replaced by the\n object 'cltcDot1qTunnelMode' in the\n CISCO-L2-TUNNEL-CONFIG-MIB" }, "vlanTrunkPortVlansActiveFirst2k": { "type": "string", "description": "A string of octets containing one bit per VLAN\n with VlanIndex values of 0 through 2047.\n \n If the bit corresponding to a VLAN is set to 1,\n it indicates that vlan is allowed and active in\n management domain.\n \n If the bit corresponding to a VLAN is set to 0,\n it indicates that vlan is not allowed or not active\n in management domain.", "x-yang-type": "cisco-tc:Cisco2KVlanList" }, "vlanTrunkPortVlansActiveSecond2k": { "type": "string", "description": "A string of octets containing one bit per VLAN\n with VlanIndex values of 2048 through 4095.\n \n If the bit corresponding to a VLAN is set to 1,\n it indicates that vlan is allowed and active in\n management domain.\n \n If the bit corresponding to a VLAN is set to 0,\n it indicates that vlan is not allowed or not active\n in management domain.", "x-yang-type": "cisco-tc:Cisco2KVlanList" } } } }, "example": { "CISCO-VTP-MIB:vlanTrunkPortEntry": [ { "vlanTrunkPortIfIndex": "example-string", "vlanTrunkPortManagementDomain": "example-string", "vlanTrunkPortEncapsulationType": "ethernetCsmacd(6)", "vlanTrunkPortVlansEnabled": "example-string", "vlanTrunkPortNativeVlan": "example-string", "vlanTrunkPortRowStatus": "up(1)", "vlanTrunkPortInJoins": 0, "vlanTrunkPortOutJoins": 0, "vlanTrunkPortOldAdverts": 0, "vlanTrunkPortVlansPruningEligible": "example-string", "vlanTrunkPortVlansXmitJoined": "example-string", "vlanTrunkPortVlansRcvJoined": "example-string", "vlanTrunkPortDynamicState": "up(1)", "vlanTrunkPortDynamicStatus": "up(1)", "vlanTrunkPortVtpEnabled": true, "vlanTrunkPortEncapsulationOperType": "ethernetCsmacd(6)", "vlanTrunkPortVlansEnabled2k": "example-string", "vlanTrunkPortVlansEnabled3k": "example-string", "vlanTrunkPortVlansEnabled4k": "example-string", "vtpVlansPruningEligible2k": "example-string", "vtpVlansPruningEligible3k": "example-string", "vtpVlansPruningEligible4k": "example-string", "vlanTrunkPortVlansXmitJoined2k": "example-string", "vlanTrunkPortVlansXmitJoined3k": "example-string", "vlanTrunkPortVlansXmitJoined4k": "example-string", "vlanTrunkPortVlansRcvJoined2k": "example-string", "vlanTrunkPortVlansRcvJoined3k": "example-string", "vlanTrunkPortVlansRcvJoined4k": "example-string", "vlanTrunkPortDot1qTunnel": "example-string", "vlanTrunkPortVlansActiveFirst2k": "example-string", "vlanTrunkPortVlansActiveSecond2k": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vlanTrunkPortEntry-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": "/vlanTrunkPortEntry", "x-restconf-kind": "container" }, "/data/CISCO-VTP-MIB:vlanTrunkPortEntry={vlanTrunkPortIfIndex}": { "get": { "summary": "Get vlanTrunkPortEntry entry", "description": "Retrieve specific vlanTrunkPortEntry entry by key from MIB", "tags": [ "CISCO-VTP-MIB" ], "parameters": [ { "name": "vlanTrunkPortIfIndex", "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": { "vlanTrunkPortIfIndex": { "type": "string", "description": "The value of ifIndex for the interface corresponding to\n this trunk port.", "x-yang-type": "if-mib:InterfaceIndex" }, "vlanTrunkPortManagementDomain": { "type": "string", "description": "The value of managementDomainIndex for the management\n domain on this trunk port. Devices which support only one\n management domain will support this object read-only.", "x-yang-type": "CISCO-VTP-MIB:ManagementDomainIndex" }, "vlanTrunkPortEncapsulationType": { "type": "string", "description": "The type of VLAN encapsulation desired to be used on this\n trunk port. It is either a particular type, or 'negotiate'\n meaning whatever type results from the negotiation.\n negotiate(5) is not allowed if the port does not support\n negotiation or if its vlanTrunkPortDynamicState is set to\n on(1) or onNoNegotiate(5). Whether writing to this object\n in order to modify the encapsulation is supported is both\n device and interface specific." }, "vlanTrunkPortVlansEnabled": { "type": "string", "description": "A string of octets containing one bit per VLAN in the\n management domain on this trunk port. The first octet\n corresponds to VLANs with VlanIndex values of 0 through 7;\n the second octet to VLANs 8 through 15; etc. The most\n significant bit of each octet corresponds to the lowest\n value VlanIndex in that octet. If the bit corresponding to\n a VLAN is set to '1', then the local system is enabled for\n sending and receiving frames on that VLAN; if the bit is set\n to '0', then the system is disabled from sending and\n receiving frames on that VLAN.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary" }, "vlanTrunkPortNativeVlan": { "type": "string", "description": "The VlanIndex of the VLAN which is represented by native\n frames on this trunk port. For trunk ports not supporting\n the sending and receiving of native frames, this value\n should be set to zero.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex" }, "vlanTrunkPortRowStatus": { "type": "string", "description": "The status of this row. In some circumstances, the\n creation of a row in this table is needed to enable the\n appropriate trunking/tagging protocol on the port, to enable\n the use of VTP on the port, and to assign the port to the\n appropriate management domain. In other circumstances, rows\n in this table will be created as a by-product of other\n operations.", "x-yang-type": "snmpv2-tc:RowStatus" }, "vlanTrunkPortInJoins": { "type": "integer", "description": "The number of VTP Join messages received on this trunk\n port.", "minimum": 0, "maximum": 4294967295 }, "vlanTrunkPortOutJoins": { "type": "integer", "description": "The number of VTP Join messages sent on this trunk port.", "minimum": 0, "maximum": 4294967295 }, "vlanTrunkPortOldAdverts": { "type": "integer", "description": "The number of VTP Advertisement messages which indicated\n the sender does not support VLAN-pruning received on this\n trunk port.", "minimum": 0, "maximum": 4294967295 }, "vlanTrunkPortVlansPruningEligible": { "type": "string", "description": "A string of octets containing one bit per VLAN in the\n management domain on this trunk port. The first octet\n corresponds to VLANs with VlanIndex values of 0 through 7;\n the second octet to VLANs 8 through 15; etc. The most\n significant bit of each octet corresponds to the lowest\n value VlanIndex in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local system is permitted to prune that VLAN on this trunk\n port; if the bit is set to '0', then the system must not\n prune that VLAN on this trunk port.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary" }, "vlanTrunkPortVlansXmitJoined": { "type": "string", "description": "A string of octets containing one bit per VLAN in the\n management domain on this trunk port. The first octet\n corresponds to VLANs with VlanIndex values of 0 through 7;\n the second octet to VLANs 8 through 15; etc. The most\n significant bit of each octet corresponds to the lowest\n value VlanIndex in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then this\n VLAN is presently being forwarded on this trunk port, i.e.,\n it is not pruned; if the bit is set to '0', then this VLAN\n is presently not being forwarded on this trunk port, either\n because it is pruned or for some other reason.", "format": "binary" }, "vlanTrunkPortVlansRcvJoined": { "type": "string", "description": "A string of octets containing one bit per VLAN in the\n management domain on this trunk port. The first octet\n corresponds to VLANs with VlanIndex values of 0 through 7;\n the second octet to VLANs 8 through 15; etc. The most\n significant bit of each octet corresponds to the lowest\n value VlanIndex in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local switch is currently sending joins for this VLAN on\n this trunk port, i.e., it is asking to receive frames for\n this VLAN; if the bit is set to '0', then the local switch\n is not currently sending joins for this VLAN on this trunk\n port.", "format": "binary" }, "vlanTrunkPortDynamicState": { "type": "string", "description": "For devices that allows dynamic determination of whether\n a link between two switches should be a trunk or not, this\n object allows the operator to mandate the behavior of that\n dynamic mechanism.\n \n on(1) dictates that the interface will always be a\n trunk. This is the value for static entries (those that\n show no dynamic behavior). If the negotiation is supported\n on this port, negotiation will take place with the far end\n to attempt to bring the far end into trunking state.\n \n off(2) allows an operator to specify that the specified\n interface is never to be trunk, regardless of any dynamic\n mechanisms to the contrary. This value is useful for\n overriding the default behavior of some switches. If the\n negotiation is supported on this port, negotiation will take\n place with the far end to attempt on the link to bring the\n far end into non-trunking state.\n \n desirable(3) is used to indicate that it is desirable for\n the interface to become a trunk. The device will initiate\n any negotiation necessary to become a trunk but will not\n become a trunk unless it receives confirmation from the far\n end on the link.\n \n auto(4) is used to indicate that the interface is capable\n and willing to become a trunk but will not initiate\n trunking negotiations. The far end on the link are\n required to either start negotiations or start sending\n encapsulated packets, on which event the specified\n interface will become a trunk.\n \n onNoNegotiate(5) is used to indicate that the interface is\n permanently set to be a trunk, and no negotiation takes\n place with the far end on the link to ensure consistent\n operation. This is similar to on(1) except no negotiation\n takes place with the far end.\n \n If the port does not support negotiation or its\n vlanTrunkPortEncapsulationType is set to negotiate(5),\n onNoNegotiate(5) is not allowed.\n \n Devices that do no support dynamic determination (for just\n a particular interface, encapsulation or for the whole\n device) need only support the 'on', and 'off' values." }, "vlanTrunkPortDynamicStatus": { "type": "string", "description": "Indicates whether the specified interface is either\n acting as a trunk or not. This is a result of the\n vlanTrunkPortDynamicState and the ifOperStatus of the\n trunk port itself." }, "vlanTrunkPortVtpEnabled": { "type": "boolean", "description": "Some trunk interface modules allow VTP to be\n enabled/disabled seperately from that of the central\n device. In such a case this object provides management a\n way to remotely enable VTP on that module. If a module\n does not support a seperate VTP enabled state then this\n object shall always return 'true' and will accept no other\n value during a SET operation." }, "vlanTrunkPortEncapsulationOperType": { "type": "string", "description": "The type of VLAN encapsulation in use on this trunk port.\n For intefaces with vlanTrunkPortDynamicStatus of\n notTrunking(2) the vlanTrunkPortEncapsulationOperType shall\n be notApplicable(6)." }, "vlanTrunkPortVlansEnabled2k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 1024 through 2047 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 1024 through 1031; the second\n octet to VLANs 1032 through 1039; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet. If the bit corresponding to a VLAN is set to\n '1', then the local system is enabled for sending and\n receiving frames on that VLAN; if the bit is set to '0',\n then the system is disabled from sending and receiving\n frames on that VLAN. The default value is zero length\n string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary" }, "vlanTrunkPortVlansEnabled3k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 2048 through 3071 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 2048 through 2055; the second\n octet to VLANs 2056 through 2063; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet. If the bit corresponding to a VLAN is set to\n '1', then the local system is enabled for sending and\n receiving frames on that VLAN; if the bit is set to '0',\n then the system is disabled from sending and receiving\n frames on that VLAN. The default value is zero length\n string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary" }, "vlanTrunkPortVlansEnabled4k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 3072 through 4095 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 3072 through 3079; the second\n octet to VLANs 3080 through 3087; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet. If the bit corresponding to a VLAN is set to\n '1', then the local system is enabled for sending and\n receiving frames on that VLAN; if the bit is set to '0',\n then the system is disabled from sending and receiving\n frames on that VLAN. The default value is zero length\n string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary" }, "vtpVlansPruningEligible2k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 1024 through 2047 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 1024 through 1031; the second\n octet to VLANs 1032 through 1039; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local system is permitted to prune that VLAN on this trunk\n port; if the bit is set to '0', then the system must not\n prune that VLAN on this trunk port.\n The default value is zero length string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary" }, "vtpVlansPruningEligible3k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 2048 through 3071 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 2048 through 2055; the second\n octet to VLANs 2056 through 2063; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local system is permitted to prune that VLAN on this trunk\n port; if the bit is set to '0', then the system must not\n prune that VLAN on this trunk port.\n The default value is zero length string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary" }, "vtpVlansPruningEligible4k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 3072 through 4095 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 3072 through 3079; the second\n octet to VLANs 3080 through 3087; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local system is permitted to prune that VLAN on this trunk\n port; if the bit is set to '0', then the system must not\n prune that VLAN on this trunk port.\n The default value is zero length string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary" }, "vlanTrunkPortVlansXmitJoined2k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 1024 through 2047 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 1024 through 1031; the second\n octet to VLANs 1032 through 1039; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then this\n VLAN is presently being forwarded on this trunk port, i.e.,\n it is not pruned; if the bit is set to '0', then this VLAN\n is presently not being forwarded on this trunk port, either\n because it is pruned or for some other reason.", "format": "binary" }, "vlanTrunkPortVlansXmitJoined3k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 2048 through 3071 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 2048 through 2055; the second\n octet to VLANs 2056 through 2063; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then this\n VLAN is presently being forwarded on this trunk port, i.e.,\n it is not pruned; if the bit is set to '0', then this VLAN\n is presently not being forwarded on this trunk port, either\n because it is pruned or for some other reason.", "format": "binary" }, "vlanTrunkPortVlansXmitJoined4k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 3072 through 4095 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 3072 through 3079; the second\n octet to VLANs 3080 through 3087; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then this\n VLAN is presently being forwarded on this trunk port, i.e.,\n it is not pruned; if the bit is set to '0', then this VLAN\n is presently not being forwarded on this trunk port, either\n because it is pruned or for some other reason.", "format": "binary" }, "vlanTrunkPortVlansRcvJoined2k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 1024 through 2047 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 1024 through 1031; the second\n octet to VLANs 1032 through 1039; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local switch is currently sending joins for this VLAN on\n this trunk port, i.e., it is asking to receive frames for\n this VLAN; if the bit is set to '0', then the local switch\n is not currently sending joins for this VLAN on this trunk\n port.", "format": "binary" }, "vlanTrunkPortVlansRcvJoined3k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 2048 through 3071 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 2048 through 2055; the second\n octet to VLANs 2056 through 2063; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local switch is currently sending joins for this VLAN on\n this trunk port, i.e., it is asking to receive frames for\n this VLAN; if the bit is set to '0', then the local switch\n is not currently sending joins for this VLAN on this trunk\n port.", "format": "binary" }, "vlanTrunkPortVlansRcvJoined4k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 3072 through 4095 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 3072 through 3079; the second\n octet to VLANs 3080 through 3087; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local switch is currently sending joins for this VLAN on\n this trunk port, i.e., it is asking to receive frames for\n this VLAN; if the bit is set to '0', then the local switch\n is not currently sending joins for this VLAN on this trunk\n port.", "format": "binary" }, "vlanTrunkPortDot1qTunnel": { "type": "string", "description": "Indicates dot1qtunnel mode of the port.\n \n If the portDot1qTunnel is set to 'trunk' mode, the port's\n vlanTrunkPortDynamicState will be changed to 'onNoNegotiate'\n and the vlanTrunkPortEncapsulationType will be set to\n 'dot1Q'. These values cannot be changed unless dot1q tunnel\n is disabled on this port.\n \n If the portDot1qTunnel mode is set to 'access' mode, the\n port's vlanTrunkPortDynamicState will be set to 'off'.And\n the value of vlanTrunkPortDynamicState cannot be changed\n unless dot1q tunnel is disabled on this port. 1Q packets\n received on this access port will remain.\n \n Setting the port to dot1q tunnel 'disabled' mode causes the\n dot1q tunnel feature to be disabled on this port. This\n object can't be set to 'trunk' or 'access' mode, when\n vlanTrunkPortsDot1qTag object is set to 'false'.\n \n This object has been deprecated and is replaced by the\n object 'cltcDot1qTunnelMode' in the\n CISCO-L2-TUNNEL-CONFIG-MIB" }, "vlanTrunkPortVlansActiveFirst2k": { "type": "string", "description": "A string of octets containing one bit per VLAN\n with VlanIndex values of 0 through 2047.\n \n If the bit corresponding to a VLAN is set to 1,\n it indicates that vlan is allowed and active in\n management domain.\n \n If the bit corresponding to a VLAN is set to 0,\n it indicates that vlan is not allowed or not active\n in management domain.", "x-yang-type": "cisco-tc:Cisco2KVlanList" }, "vlanTrunkPortVlansActiveSecond2k": { "type": "string", "description": "A string of octets containing one bit per VLAN\n with VlanIndex values of 2048 through 4095.\n \n If the bit corresponding to a VLAN is set to 1,\n it indicates that vlan is allowed and active in\n management domain.\n \n If the bit corresponding to a VLAN is set to 0,\n it indicates that vlan is not allowed or not active\n in management domain.", "x-yang-type": "cisco-tc:Cisco2KVlanList" } } }, "example": { "CISCO-VTP-MIB:vlanTrunkPortEntry": { "vlanTrunkPortIfIndex": "example-string", "vlanTrunkPortManagementDomain": "example-string", "vlanTrunkPortEncapsulationType": "ethernetCsmacd(6)", "vlanTrunkPortVlansEnabled": "example-string", "vlanTrunkPortNativeVlan": "example-string", "vlanTrunkPortRowStatus": "up(1)", "vlanTrunkPortInJoins": 0, "vlanTrunkPortOutJoins": 0, "vlanTrunkPortOldAdverts": 0, "vlanTrunkPortVlansPruningEligible": "example-string", "vlanTrunkPortVlansXmitJoined": "example-string", "vlanTrunkPortVlansRcvJoined": "example-string", "vlanTrunkPortDynamicState": "up(1)", "vlanTrunkPortDynamicStatus": "up(1)", "vlanTrunkPortVtpEnabled": true, "vlanTrunkPortEncapsulationOperType": "ethernetCsmacd(6)", "vlanTrunkPortVlansEnabled2k": "example-string", "vlanTrunkPortVlansEnabled3k": "example-string", "vlanTrunkPortVlansEnabled4k": "example-string", "vtpVlansPruningEligible2k": "example-string", "vtpVlansPruningEligible3k": "example-string", "vtpVlansPruningEligible4k": "example-string", "vlanTrunkPortVlansXmitJoined2k": "example-string", "vlanTrunkPortVlansXmitJoined3k": "example-string", "vlanTrunkPortVlansXmitJoined4k": "example-string", "vlanTrunkPortVlansRcvJoined2k": "example-string", "vlanTrunkPortVlansRcvJoined3k": "example-string", "vlanTrunkPortVlansRcvJoined4k": "example-string", "vlanTrunkPortDot1qTunnel": "example-string", "vlanTrunkPortVlansActiveFirst2k": "example-string", "vlanTrunkPortVlansActiveSecond2k": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vlanTrunkPortEntry-4" }, "x-yang-path": "/vlanTrunkPortEntry={vlanTrunkPortIfIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "vlanTrunkPortIfIndex" ] }, "/data/CISCO-VTP-MIB:vtpDiscoverEntry": { "get": { "summary": "Get vtpDiscoverEntry list", "description": "Retrieve list of vtpDiscoverEntry entries from MIB", "tags": [ "CISCO-VTP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Information related to the discovery of the\n VTP members in one management domain.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref" }, "vtpDiscoverAction": { "type": "string", "description": "When this object is set to discover(1), all the\n entries in vtpDiscoverResultTable for the\n corresponding management domain will be removed \n and the local device will begin to discover all\n VTP members in the management domain. Upon the\n successful completion of discovery, the discovered\n result will be stored in the vtpDiscoverResultTable.\n \n If vtpDiscoverStatus is inProgress(1), setting \n vtpDiscoverAction to discover(1) will fail. \n \n When this object is set to purgeResult(3), \n all the entries of vtpDiscoverResultTable for \n the corresponding management domain will be\n removed from vtpDiscoverResultTable.\n \n When this object is set to noOperation(2), no\n action will be taken. When read, this object\n always returns noOperation(2)." }, "vtpDiscoverStatus": { "type": "string", "description": "The current status of VTP discovery.\n \n inProgress - a discovery is in progress;\n \n succeeded - the discovery was completed successfully\n (this value is also used when \n no discover has been invoked since the\n last time the local system restarted);\n \n resourceUnavailable - the discovery failed because\n the required allocation of a resource is\n presently unavailable.\n \n someOtherError - 'the discovery failed due to a\n reason no listed." }, "vtpLastDiscoverTime": { "type": "string", "description": "The value of sysUpTime at which the last discovery\n was completed.\n \n A value of zero indicates that no discovery has been\n invoked since last time the local system restarted.", "x-yang-type": "yang:timestamp" } } } }, "example": { "CISCO-VTP-MIB:vtpDiscoverEntry": [ { "managementDomainIndex": "example-string", "vtpDiscoverAction": "example-string", "vtpDiscoverStatus": "up(1)", "vtpLastDiscoverTime": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vtpDiscoverEntry-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": "/vtpDiscoverEntry", "x-restconf-kind": "container" }, "/data/CISCO-VTP-MIB:vtpDiscoverEntry={managementDomainIndex}": { "get": { "summary": "Get vtpDiscoverEntry entry", "description": "Retrieve specific vtpDiscoverEntry entry by key from MIB", "tags": [ "CISCO-VTP-MIB" ], "parameters": [ { "name": "managementDomainIndex", "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": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref" }, "vtpDiscoverAction": { "type": "string", "description": "When this object is set to discover(1), all the\n entries in vtpDiscoverResultTable for the\n corresponding management domain will be removed \n and the local device will begin to discover all\n VTP members in the management domain. Upon the\n successful completion of discovery, the discovered\n result will be stored in the vtpDiscoverResultTable.\n \n If vtpDiscoverStatus is inProgress(1), setting \n vtpDiscoverAction to discover(1) will fail. \n \n When this object is set to purgeResult(3), \n all the entries of vtpDiscoverResultTable for \n the corresponding management domain will be\n removed from vtpDiscoverResultTable.\n \n When this object is set to noOperation(2), no\n action will be taken. When read, this object\n always returns noOperation(2)." }, "vtpDiscoverStatus": { "type": "string", "description": "The current status of VTP discovery.\n \n inProgress - a discovery is in progress;\n \n succeeded - the discovery was completed successfully\n (this value is also used when \n no discover has been invoked since the\n last time the local system restarted);\n \n resourceUnavailable - the discovery failed because\n the required allocation of a resource is\n presently unavailable.\n \n someOtherError - 'the discovery failed due to a\n reason no listed." }, "vtpLastDiscoverTime": { "type": "string", "description": "The value of sysUpTime at which the last discovery\n was completed.\n \n A value of zero indicates that no discovery has been\n invoked since last time the local system restarted.", "x-yang-type": "yang:timestamp" } } }, "example": { "CISCO-VTP-MIB:vtpDiscoverEntry": { "managementDomainIndex": "example-string", "vtpDiscoverAction": "example-string", "vtpDiscoverStatus": "up(1)", "vtpLastDiscoverTime": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vtpDiscoverEntry-4" }, "x-yang-path": "/vtpDiscoverEntry={managementDomainIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "managementDomainIndex" ] }, "/data/CISCO-VTP-MIB:vtpDiscoverResultEntry": { "get": { "summary": "Get vtpDiscoverResultEntry list", "description": "Retrieve list of vtpDiscoverResultEntry entries from MIB", "tags": [ "CISCO-VTP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A conceptual row is created for each VTP member which\n is found through successful discovery.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref" }, "vtpDiscoverResultIndex": { "type": "integer", "description": "A value assigned by the system which identifies\n a VTP member and the associated database in the \n management domain.", "minimum": 0, "maximum": 4294967295 }, "vtpDiscoverResultDatabaseName": { "type": "string", "description": "The database name associated with the\n discovered VTP member.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "vtpDiscoverResultConflicting": { "type": "boolean", "description": "Indicates whether this VTP member contains\n conflicting information.\n \n true(1) indicates that this member has conflicting \n information of the database type in the management domain.\n \n false(2) indicates that there is no conflicting information\n of the database type in the management domain." }, "vtpDiscoverResultDeviceId": { "type": "string", "description": "The unique identifier of the device for this VTP member.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "vtpDiscoverResultPrimaryServer": { "type": "string", "description": "The unique identifier of the primary server for this VTP\n member and the associated database type.\n \n There are two different VTP servers, the primary server\n and the secondary server. When a local device is\n configured as a server for a certain database type,\n it becomes secondary server by default. \n Primary server is an operational role under which a\n server can initiate or change the VTP configuration of the\n database type.\n \n If this VTP member itself is the primary server, the \n value of this object is the same as the value of \n vtpDiscoverResultDeviceId of the instance.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "vtpDiscoverResultRevNumber": { "type": "integer", "description": "The current configuration revision number as known by the\n VTP member. When the database type is unknown for\n the VTP member, this value is 0.", "minimum": 0, "maximum": 4294967295 }, "vtpDiscoverResultSystemName": { "type": "string", "description": "sysName of the VTP member.", "x-yang-type": "snmp-framework:SnmpAdminString" } } } }, "example": { "CISCO-VTP-MIB:vtpDiscoverResultEntry": [ { "managementDomainIndex": "example-string", "vtpDiscoverResultIndex": 1, "vtpDiscoverResultDatabaseName": "interface-1", "vtpDiscoverResultConflicting": true, "vtpDiscoverResultDeviceId": "example-string", "vtpDiscoverResultPrimaryServer": "example-string", "vtpDiscoverResultRevNumber": 0, "vtpDiscoverResultSystemName": "interface-1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vtpDiscoverResultEntry-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": "/vtpDiscoverResultEntry", "x-restconf-kind": "container" }, "/data/CISCO-VTP-MIB:vtpDatabaseEntry": { "get": { "summary": "Get vtpDatabaseEntry list", "description": "Retrieve list of vtpDatabaseEntry entries from MIB", "tags": [ "CISCO-VTP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Information about the status of the VTP database\n in the domain. Each VTP database type known to the\n local device type has an entry in this table.\n An entry is also created for unknown database which is\n notified through VTP advertisements from other VTP\n servers.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref" }, "vtpDatabaseIndex": { "type": "integer", "description": "A value assigned by the system which uniquely identifies\n a VTP database in the local system.", "minimum": 0, "maximum": 4294967295 }, "vtpDatabaseName": { "type": "string", "description": "The name of the database.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "vtpDatabaseLocalMode": { "type": "string", "description": "The local VTP mode for a particular database type\n in this administrative domain.\n \n - 'client' indicates that the local system is acting\n as a VTP client of the database type.\n \n - 'server' indicates that the local system is acting\n as a VTP server of the database type.\n \n - 'transparent' indicates that the local system does\n not generate or listen to VTP messages of this \n database type, but forwards\n messages. This mode can also be set by the device\n itself when the size of database is too large for it\n to hold in DRAM.\n \n - 'off' indicates that the local system does not\n generate, listen to or forward any VTP messages\n of this database type.\n \n The default mode is 'client' for the database type \n known to the local device and 'transparent' for the\n unknown database type." }, "vtpDatabaseRevNumber": { "type": "integer", "description": "The current configuration revision number as known by the\n local device for this VTP 3 database type in the management\n domain. This value is updated (if necessary) whenever a \n VTP advertisement for the database type is received \n or generated. When the database type is unknown to the \n local device or no VTP advertisement for the database\n type is received or generated, its value is 0.", "minimum": 0, "maximum": 4294967295 }, "vtpDatabasePrimaryServer": { "type": "boolean", "description": "There are two kinds of VTP version 3 servers for a certain\n database type - the primary server and the secondary server.\n When a local device is configured as a server for a certain\n database type, it becomes secondary server by default.\n Primary server is an operational role under which a\n server can initiate or change the VTP configuration of the\n database type.\n \n A true(1) value indicates that the local device is the \n primary server of the database type in the management\n domain. A false(2) value indicates that the local device\n is not the primary server, or the database type is unknown\n to the local device." }, "vtpDatabasePrimaryServerId": { "type": "string", "description": "The unique identifier of the primary server in the\n management domain for the database type. \n \n If no primary server is discovered for the database\n type, the object has a value of zero length string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "vtpDatabaseTakeOverPrimary": { "type": "boolean", "description": "There are two kinds of VTP version 3 servers for a certain\n database type - the primary server and the secondary server.\n When a local device is configured as a server for a certain\n database type, it becomes secondary server by default.\n Primary server is an operational role under which a\n server can initiate or change the VTP configuration of the\n database type.\n \n Setting this object to a true(1) value will advertise the\n configuration of this database type to the whole domain.\n \n In order to successfully setting this object to true(1),\n the value of vtpDatabaseLocalMode must be server(2). Besides\n that, when the VTP password is hidden from the configuration\n file, the password (vtpDatabaseTakeOverPassword) which \n matches the secret key (vtpAuthSecretKey) must be provided\n in the same data packet. \n \n When read, the object always returns false(2)." }, "vtpDatabaseTakeOverPassword": { "type": "string", "description": "When read, this object always returns the value of a\n zero-length octet string.\n \n In the case that the VTP password is hidden from the \n configuration and the local device intends\n to take over the whole domain, this object must be \n set to the matching password with the secret key \n (vtpAuthSecretKey) in the same data packet as which \n the vtpDatabaseTakeOverPrimary is in. In all the \n other situations, setting a valid value to this object \n has no impact on the system.", "x-yang-type": "snmp-framework:SnmpAdminString" } } } }, "example": { "CISCO-VTP-MIB:vtpDatabaseEntry": [ { "managementDomainIndex": "example-string", "vtpDatabaseIndex": 1, "vtpDatabaseName": "interface-1", "vtpDatabaseLocalMode": "example-string", "vtpDatabaseRevNumber": 0, "vtpDatabasePrimaryServer": true, "vtpDatabasePrimaryServerId": "example-string", "vtpDatabaseTakeOverPrimary": true, "vtpDatabaseTakeOverPassword": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vtpDatabaseEntry-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": "/vtpDatabaseEntry", "x-restconf-kind": "container" }, "/data/CISCO-VTP-MIB:vtpAuthEntry": { "get": { "summary": "Get vtpAuthEntry list", "description": "Retrieve list of vtpAuthEntry entries from MIB", "tags": [ "CISCO-VTP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Information about the status of the VTP\n authentication information in one domain.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref" }, "vtpAuthPassword": { "type": "string", "description": "By default, this object has a value of a zero-length\n character string and is considered to be not\n configured.\n \n The device uses the password to generate the \n secret key. It can be stored in the configuration in \n plain text or hidden from the configuration. If a VTP \n server intends to modify the database's configuration\n in the domain but the password was hidden from the\n configuration, the same password\n (vtpDatabaseTakeOverPassword) as the hidden one\n has to be provided.\n \n When this object is set alone, vtpAuthPasswordType is\n set to plaintext(1) automatically by the system.\n Setting this object to a zero length character string\n resets the password to its default value and the\n password is considered as not configured.\n \n This object is not allowed to be set at the same time\n when vtpAuthSecretKey is set.\n \n When the vtpAuthPasswordType is hidden(2), this object \n will return a zero-length character string when read.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "vtpAuthPasswordType": { "type": "string", "description": "By default this object has the value as plaintext(1)\n and the VTP password is stored in the configuration\n file in plain text.\n \n Setting this object to hidden(2) will hide the\n password from the configuration.\n \n Once this object is set to hidden(2), it cannot\n be set to plaintext(1) alone. However, it may\n be set to plaintext(1) at the same time the\n password is set." }, "vtpAuthSecretKey": { "type": "string", "description": "The device creating or modifying the VTP configuration\n signs it using the MD5 digest generated from the secret\n key before advertising it. Other devices in the domain\n receiving this configuration use the same secret key\n to accept it if it was correctly signed or drop it \n otherwise.\n \n By default, the object has the value as a zero-length\n string and this value is read only. It is set \n to this value automatically when the password \n (vtpAuthPassword) is set to a zero-length octet string.\n \n The secret key can be either generated using\n the password or configured by the user. Once\n the secret key is configured by the user, it is\n stored as a hexadecimal string in the device's\n configuration and the password is considered to be\n the secret key's matching password and hidden\n from the configuration automatically.\n \n This object is not allowed to be set at the same\n time when vtpAuthPassword is set.\n \n The secret key is overwritten by a newly generated\n secret key when the password is re-configured.", "format": "binary" } } } }, "example": { "CISCO-VTP-MIB:vtpAuthEntry": [ { "managementDomainIndex": "example-string", "vtpAuthPassword": "example-string", "vtpAuthPasswordType": "ethernetCsmacd(6)", "vtpAuthSecretKey": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vtpAuthEntry-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": "/vtpAuthEntry", "x-restconf-kind": "container" }, "/data/CISCO-VTP-MIB:vtpAuthEntry={managementDomainIndex}": { "get": { "summary": "Get vtpAuthEntry entry", "description": "Retrieve specific vtpAuthEntry entry by key from MIB", "tags": [ "CISCO-VTP-MIB" ], "parameters": [ { "name": "managementDomainIndex", "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": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref" }, "vtpAuthPassword": { "type": "string", "description": "By default, this object has a value of a zero-length\n character string and is considered to be not\n configured.\n \n The device uses the password to generate the \n secret key. It can be stored in the configuration in \n plain text or hidden from the configuration. If a VTP \n server intends to modify the database's configuration\n in the domain but the password was hidden from the\n configuration, the same password\n (vtpDatabaseTakeOverPassword) as the hidden one\n has to be provided.\n \n When this object is set alone, vtpAuthPasswordType is\n set to plaintext(1) automatically by the system.\n Setting this object to a zero length character string\n resets the password to its default value and the\n password is considered as not configured.\n \n This object is not allowed to be set at the same time\n when vtpAuthSecretKey is set.\n \n When the vtpAuthPasswordType is hidden(2), this object \n will return a zero-length character string when read.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "vtpAuthPasswordType": { "type": "string", "description": "By default this object has the value as plaintext(1)\n and the VTP password is stored in the configuration\n file in plain text.\n \n Setting this object to hidden(2) will hide the\n password from the configuration.\n \n Once this object is set to hidden(2), it cannot\n be set to plaintext(1) alone. However, it may\n be set to plaintext(1) at the same time the\n password is set." }, "vtpAuthSecretKey": { "type": "string", "description": "The device creating or modifying the VTP configuration\n signs it using the MD5 digest generated from the secret\n key before advertising it. Other devices in the domain\n receiving this configuration use the same secret key\n to accept it if it was correctly signed or drop it \n otherwise.\n \n By default, the object has the value as a zero-length\n string and this value is read only. It is set \n to this value automatically when the password \n (vtpAuthPassword) is set to a zero-length octet string.\n \n The secret key can be either generated using\n the password or configured by the user. Once\n the secret key is configured by the user, it is\n stored as a hexadecimal string in the device's\n configuration and the password is considered to be\n the secret key's matching password and hidden\n from the configuration automatically.\n \n This object is not allowed to be set at the same\n time when vtpAuthPassword is set.\n \n The secret key is overwritten by a newly generated\n secret key when the password is re-configured.", "format": "binary" } } }, "example": { "CISCO-VTP-MIB:vtpAuthEntry": { "managementDomainIndex": "example-string", "vtpAuthPassword": "example-string", "vtpAuthPasswordType": "ethernetCsmacd(6)", "vtpAuthSecretKey": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vtpAuthEntry-4" }, "x-yang-path": "/vtpAuthEntry={managementDomainIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "managementDomainIndex" ] }, "/data/CISCO-VTP-MIB:vtpVlanTable/vtpVlanEntry={managementDomainIndex},{vtpVlanIndex}": { "get": { "summary": "Get vtpVlanEntry entry", "description": "Retrieve specific vtpVlanEntry entry by key from MIB", "tags": [ "CISCO-VTP-MIB" ], "parameters": [ { "name": "managementDomainIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "vtpVlanIndex", "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": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref" }, "vtpVlanIndex": { "type": "string", "description": "The VLAN-id of this VLAN on ISL or 802.1q trunks.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex" }, "vtpVlanState": { "type": "string", "description": "The state of this VLAN.\n \n The state 'mtuTooBigForDevice' indicates that this device\n cannot participate in this VLAN because the VLAN's MTU is\n larger than the device can support.\n \n The state 'mtuTooBigForTrunk' indicates that while this\n VLAN's MTU is supported by this device, it is too large for\n one or more of the device's trunk ports." }, "vtpVlanType": { "type": "string", "description": "The type of this VLAN.", "x-yang-type": "CISCO-VTP-MIB:VlanType" }, "vtpVlanName": { "type": "string", "description": "The name of this VLAN. This name is used as the ELAN-name\n for an ATM LAN-Emulation segment of this VLAN.", "x-yang-type": "snmpv2-tc:DisplayString" }, "vtpVlanMtu": { "type": "integer", "description": "The MTU size on this VLAN, defined as the size of largest\n MAC-layer (information field portion of the) data frame\n which can be transmitted on the VLAN.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanDot10Said": { "type": "string", "description": "The value of the 802.10 SAID field for this VLAN.", "format": "binary" }, "vtpVlanRingNumber": { "type": "integer", "description": "The ring number of this VLAN. This object is only\n instantiated when the value of the corresponding instance of\n vtpVlanType has a value of 'fddi' or 'tokenRing' and Source\n Routing is in use on this VLAN.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanBridgeNumber": { "type": "integer", "description": "The bridge number of the VTP-capable switches for this\n VLAN. This object is only instantiated for VLANs that are\n involved with emulating token ring segments.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanStpType": { "type": "string", "description": "The type of the Spanning Tree Protocol (STP) running on\n this VLAN. This object is only instanciated when the\n value of the corresponding instance of vtpVlanType has a\n value of 'fddiNet' or 'trNet'.\n \n The value returned by this object depends upon the value\n of the corresponding instance of vtpVlanEditStpType.\n \n - 'ieee' indicates IEEE STP is running exclusively.\n \n - 'ibm' indicates IBM STP is running exclusively.\n \n - 'hybrid' indicates a STP that allows a combination of\n IEEE and IBM is running.\n \n The 'hybrid' STP type results from tokenRing/fddi VLANs\n that are children of this trNet/fddiNet parent VLAN being\n configured in a combination of SRT and SRB\n vtpVlanBridgeTypes while the instance of\n vtpVlanEditStpType that corresponds to this object is set\n to 'auto'." }, "vtpVlanParentVlan": { "type": "string", "description": "The parent VLAN for this VLAN. This object is only\n instantiated when the value of the corresponding instance of\n vtpVlanType has a value of 'fddi' or 'tokenRing' and Source\n Routing is in use on this VLAN. The parent VLAN must have \n a vtpVlanType value of fddiNet(4) or trNet(5), \n respectively.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex" }, "vtpVlanTranslationalVlan1": { "type": "string", "description": "A VLAN to which this VLAN is being translational-bridged.\n If this value and the corresponding instance of\n vtpVlanTranslationalVlan2 are both zero, then this VLAN is\n not being translational-bridged.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex" }, "vtpVlanTranslationalVlan2": { "type": "string", "description": "Another VLAN, i.e., other than that indicated by\n vtpVlanTranslationalVlan1, to which this VLAN is being\n translational-bridged. If this value and the corresponding\n instance of vtpVlanTranslationalVlan1 are both zero, then\n this VLAN is not being translational-bridged.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex" }, "vtpVlanBridgeType": { "type": "string", "description": "The type of the Source Route bridging mode in use on this\n VLAN. This object is only instantiated when the value of \n the corresponding instance of vtpVlanType has a value of \n fddi(2) or tokenRing(3) and Source Routing is in use on\n this VLAN." }, "vtpVlanAreHopCount": { "type": "integer", "description": "The maximum number of bridge hops allowed in\n All Routes Explorer frames on this VLAN. This\n object is only instantiated when the value of the\n corresponding instance of vtpVlanType has a value of fddi(2)\n or tokenRing(3) and Source Routing is in use on this VLAN.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanSteHopCount": { "type": "integer", "description": "The maximum number of bridge hops allowed in\n Spanning Tree Explorer frames on this VLAN. This\n object is only instantiated when the value of the\n corresponding instance of vtpVlanType has a value of fddi(2)\n or tokenRing(3) and Source Routing is in use on this VLAN.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanIsCRFBackup": { "type": "boolean", "description": "True if this VLAN is of type trCrf and also is acting as\n a backup trCrf for the ISL distributed BRF" }, "vtpVlanTypeExt": { "type": "string", "description": "The additional type information of this VLAN.", "x-yang-type": "CISCO-VTP-MIB:VlanTypeExt" }, "vtpVlanIfIndex": { "type": "string", "description": "The value of the ifIndex corresponding to this VLAN ID.\n If the VLAN ID does not have its corresponding interface, \n this object has the value of zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero" } } }, "example": { "CISCO-VTP-MIB:vtpVlanEntry": { "managementDomainIndex": "example-string", "vtpVlanIndex": "example-string", "vtpVlanState": "up(1)", "vtpVlanType": "ethernetCsmacd(6)", "vtpVlanName": "interface-1", "vtpVlanMtu": 1500, "vtpVlanDot10Said": "example-string", "vtpVlanRingNumber": -2147483648, "vtpVlanBridgeNumber": -2147483648, "vtpVlanStpType": "ethernetCsmacd(6)", "vtpVlanParentVlan": "example-string", "vtpVlanTranslationalVlan1": "example-string", "vtpVlanTranslationalVlan2": "example-string", "vtpVlanBridgeType": "ethernetCsmacd(6)", "vtpVlanAreHopCount": -2147483648, "vtpVlanSteHopCount": -2147483648, "vtpVlanIsCRFBackup": true, "vtpVlanTypeExt": "ethernetCsmacd(6)", "vtpVlanIfIndex": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vtpVlanEntry-2" }, "x-yang-path": "/vtpVlanTable/vtpVlanEntry={managementDomainIndex vtpVlanIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "managementDomainIndex vtpVlanIndex" ] }, "/data/CISCO-VTP-MIB:vtpInternalVlanTable/vtpInternalVlanEntry={managementDomainIndex},{vtpVlanIndex}": { "get": { "summary": "Get vtpInternalVlanEntry entry", "description": "Retrieve specific vtpInternalVlanEntry entry by key from MIB", "tags": [ "CISCO-VTP-MIB" ], "parameters": [ { "name": "managementDomainIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "vtpVlanIndex", "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": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref" }, "vtpVlanIndex": { "type": "string", "description": "vtpVlanIndex", "x-yang-type": "leafref" }, "vtpInternalVlanOwner": { "type": "string", "description": "The program name of the internal VLAN's\n owner application. This internal VLAN\n is allocated by the device specifically\n for this application and no one else\n could create, modify or delete this \n VLAN.", "x-yang-type": "snmp-framework:SnmpAdminString" } } }, "example": { "CISCO-VTP-MIB:vtpInternalVlanEntry": { "managementDomainIndex": "example-string", "vtpVlanIndex": "example-string", "vtpInternalVlanOwner": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vtpInternalVlanEntry-2" }, "x-yang-path": "/vtpInternalVlanTable/vtpInternalVlanEntry={managementDomainIndex vtpVlanIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "managementDomainIndex vtpVlanIndex" ] }, "/data/CISCO-VTP-MIB:vtpVlanEditTable/vtpVlanEditEntry={managementDomainIndex},{vtpVlanEditIndex}": { "get": { "summary": "Get vtpVlanEditEntry entry", "description": "Retrieve specific vtpVlanEditEntry entry by key from MIB", "tags": [ "CISCO-VTP-MIB" ], "parameters": [ { "name": "managementDomainIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "vtpVlanEditIndex", "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": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref" }, "vtpVlanEditIndex": { "type": "string", "description": "The VLAN-id which this VLAN would have on ISL or\n 802.1q trunks.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex" }, "vtpVlanEditState": { "type": "string", "description": "The state which this VLAN would have." }, "vtpVlanEditType": { "type": "string", "description": "The type which this VLAN would have.\n An implementation may restrict access to this object.", "x-yang-type": "CISCO-VTP-MIB:VlanType" }, "vtpVlanEditName": { "type": "string", "description": "The name which this VLAN would have. This name would be\n used as the ELAN-name for an ATM LAN-Emulation segment of\n this VLAN.\n \n An implementation may restrict access to this object.", "x-yang-type": "snmpv2-tc:DisplayString" }, "vtpVlanEditMtu": { "type": "integer", "description": "The MTU size which this VLAN would have, defined as the\n size of largest MAC-layer (information field portion of the)\n data frame which can be transmitted on the VLAN.\n \n An implementation may restrict access to this object.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanEditDot10Said": { "type": "string", "description": "The value of the 802.10 SAID field which would be used for\n this VLAN.\n \n An implementation may restrict access to this object.", "format": "binary" }, "vtpVlanEditRingNumber": { "type": "integer", "description": "The ring number which would be used for this VLAN. This\n object is only instantiated when the value of the\n corresponding instance of vtpVlanEditType has a value of\n 'fddi' or 'tokenRing' and Source Routing is in use on \n this VLAN.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanEditBridgeNumber": { "type": "integer", "description": "The bridge number of the VTP-capable switches which would\n be used for this VLAN. This object is only instantiated\n when the value of the corresponding instance of\n vtpVlanEditType has a value of fddiNet(4) or trNet(5).", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanEditStpType": { "type": "string", "description": "The type of the Spanning Tree Protocol which would be\n running on this VLAN. This object is only instantiated\n when the value of the corresponding instance of\n vtpVlanEditType has a value of fddiNet(4) or trNet(5).\n \n If 'ieee' is selected, the STP that runs will be IEEE.\n \n If 'ibm' is selected, the STP that runs will be IBM.\n \n If 'auto' is selected, the STP that runs will be\n dependant on the values of vtpVlanEditBridgeType for all\n children tokenRing/fddi type VLANs. This will result in\n a 'hybrid' STP (see vtpVlanStpType)." }, "vtpVlanEditParentVlan": { "type": "string", "description": "The VLAN index of the VLAN which would be the parent for\n this VLAN. This object is only instantiated when the value\n of the corresponding instance of vtpVlanEditType has a value\n of 'fddi' or 'tokenRing' and Source Routing is in use on\n this VLAN. The parent VLAN must have a vtpVlanEditType \n value of fddiNet(4) or trNet(5), respectively.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex" }, "vtpVlanEditRowStatus": { "type": "string", "description": "The status of this row. Any and all columnar objects in an\n existing row can be modified irrespective of the status of\n the row.\n \n A row is not qualified for activation until instances of at\n least its vtpVlanEditType, vtpVlanEditName and\n vtpVlanEditDot10Said columns have appropriate values.\n \n The management station should endeavor to make all rows\n consistent in the table before 'apply'ing the buffer. An\n inconsistent entry in the table will cause the entire\n buffer to be rejected with the vtpVlanApplyStatus object\n set to the appropriate error value.", "x-yang-type": "snmpv2-tc:RowStatus" }, "vtpVlanEditTranslationalVlan1": { "type": "string", "description": "A VLAN to which this VLAN would be translational-bridged.\n If this value and the corresponding instance of\n vtpVlanTranslationalVlan2 are both zero, then this VLAN\n would not be translational-bridged.\n \n An implementation may restrict access to this object.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex" }, "vtpVlanEditTranslationalVlan2": { "type": "string", "description": "Another VLAN, i.e., other than that indicated by\n vtpVlanEditTranslationalVlan1, to which this VLAN would be\n translational-bridged. If this value and the corresponding\n instance of vtpVlanTranslationalVlan1 are both zero, then\n this VLAN would not be translational-bridged.\n \n An implementation may restrict access to this object.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex" }, "vtpVlanEditBridgeType": { "type": "string", "description": "The type of Source Route bridging mode which would be in\n use on this VLAN. This object is only instantiated when \n the value of the corresponding instance of vtpVlanEditType\n has a value of fddi(2) or tokenRing(3) and Source Routing \n is in use on this VLAN." }, "vtpVlanEditAreHopCount": { "type": "integer", "description": "The maximum number of bridge hops allowed in\n All Routes Explorer frames on this VLAN. This\n object is only instantiated when the value of the\n corresponding instance of vtpVlanType has a value of fddi(2)\n or tokenRing(3) and Source Routing is in use on this VLAN.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanEditSteHopCount": { "type": "integer", "description": "The maximum number of bridge hops allowed in\n Spanning Tree Explorer frames on this VLAN. This\n object is only instantiated when the value of the\n corresponding instance of vtpVlanType has a value of fddi(2)\n or tokenRing(3) and Source Routing is in use on this VLAN.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanEditIsCRFBackup": { "type": "boolean", "description": "True if this VLAN is of type trCrf and also is acting as\n a backup trCrf for the ISL distributed BRF. This object is\n only instantiated when the value of the corresponding\n instance of vtpVlanEditType has a value of tokenRing(3)." }, "vtpVlanEditTypeExt": { "type": "string", "description": "The additional type information of this VLAN.\n vtpVlanEditTypeExt object is superseded by vtpVlanEditTypeExt2.", "x-yang-type": "CISCO-VTP-MIB:VlanTypeExt" }, "vtpVlanEditTypeExt2": { "type": "string", "description": "The additional type information of this VLAN.\n The VlanTypeExt TC specifies which bits may\n be written by a management application.\n The agent should provide a default value.", "x-yang-type": "CISCO-VTP-MIB:VlanTypeExt" } } }, "example": { "CISCO-VTP-MIB:vtpVlanEditEntry": { "managementDomainIndex": "example-string", "vtpVlanEditIndex": "example-string", "vtpVlanEditState": "up(1)", "vtpVlanEditType": "ethernetCsmacd(6)", "vtpVlanEditName": "interface-1", "vtpVlanEditMtu": 1500, "vtpVlanEditDot10Said": "example-string", "vtpVlanEditRingNumber": -2147483648, "vtpVlanEditBridgeNumber": -2147483648, "vtpVlanEditStpType": "ethernetCsmacd(6)", "vtpVlanEditParentVlan": "example-string", "vtpVlanEditRowStatus": "up(1)", "vtpVlanEditTranslationalVlan1": "example-string", "vtpVlanEditTranslationalVlan2": "example-string", "vtpVlanEditBridgeType": "ethernetCsmacd(6)", "vtpVlanEditAreHopCount": -2147483648, "vtpVlanEditSteHopCount": -2147483648, "vtpVlanEditIsCRFBackup": true, "vtpVlanEditTypeExt": "ethernetCsmacd(6)", "vtpVlanEditTypeExt2": "ethernetCsmacd(6)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vtpVlanEditEntry-2" }, "x-yang-path": "/vtpVlanEditTable/vtpVlanEditEntry={managementDomainIndex vtpVlanEditIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "managementDomainIndex vtpVlanEditIndex" ] }, "/data/CISCO-VTP-MIB:vtpVlanLocalShutdownTable/vtpVlanLocalShutdownEntry={managementDomainIndex},{vtpVlanIndex}": { "get": { "summary": "Get vtpVlanLocalShutdownEntry entry", "description": "Retrieve specific vtpVlanLocalShutdownEntry entry by key from MIB", "tags": [ "CISCO-VTP-MIB" ], "parameters": [ { "name": "managementDomainIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "vtpVlanIndex", "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": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref" }, "vtpVlanIndex": { "type": "string", "description": "vtpVlanIndex", "x-yang-type": "leafref" }, "vtpVlanLocalShutdown": { "type": "string", "description": "The object specifies the VLAN local shutdown state." } } }, "example": { "CISCO-VTP-MIB:vtpVlanLocalShutdownEntry": { "managementDomainIndex": "example-string", "vtpVlanIndex": "example-string", "vtpVlanLocalShutdown": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vtpVlanLocalShutdownEntry-2" }, "x-yang-path": "/vtpVlanLocalShutdownTable/vtpVlanLocalShutdownEntry={managementDomainIndex vtpVlanIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "managementDomainIndex vtpVlanIndex" ] }, "/data/CISCO-VTP-MIB:vtpDiscoverResultTable/vtpDiscoverResultEntry={managementDomainIndex},{vtpDiscoverResultIndex}": { "get": { "summary": "Get vtpDiscoverResultEntry entry", "description": "Retrieve specific vtpDiscoverResultEntry entry by key from MIB", "tags": [ "CISCO-VTP-MIB" ], "parameters": [ { "name": "managementDomainIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "vtpDiscoverResultIndex", "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": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref" }, "vtpDiscoverResultIndex": { "type": "integer", "description": "A value assigned by the system which identifies\n a VTP member and the associated database in the \n management domain.", "minimum": 0, "maximum": 4294967295 }, "vtpDiscoverResultDatabaseName": { "type": "string", "description": "The database name associated with the\n discovered VTP member.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "vtpDiscoverResultConflicting": { "type": "boolean", "description": "Indicates whether this VTP member contains\n conflicting information.\n \n true(1) indicates that this member has conflicting \n information of the database type in the management domain.\n \n false(2) indicates that there is no conflicting information\n of the database type in the management domain." }, "vtpDiscoverResultDeviceId": { "type": "string", "description": "The unique identifier of the device for this VTP member.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "vtpDiscoverResultPrimaryServer": { "type": "string", "description": "The unique identifier of the primary server for this VTP\n member and the associated database type.\n \n There are two different VTP servers, the primary server\n and the secondary server. When a local device is\n configured as a server for a certain database type,\n it becomes secondary server by default. \n Primary server is an operational role under which a\n server can initiate or change the VTP configuration of the\n database type.\n \n If this VTP member itself is the primary server, the \n value of this object is the same as the value of \n vtpDiscoverResultDeviceId of the instance.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "vtpDiscoverResultRevNumber": { "type": "integer", "description": "The current configuration revision number as known by the\n VTP member. When the database type is unknown for\n the VTP member, this value is 0.", "minimum": 0, "maximum": 4294967295 }, "vtpDiscoverResultSystemName": { "type": "string", "description": "sysName of the VTP member.", "x-yang-type": "snmp-framework:SnmpAdminString" } } }, "example": { "CISCO-VTP-MIB:vtpDiscoverResultEntry": { "managementDomainIndex": "example-string", "vtpDiscoverResultIndex": 1, "vtpDiscoverResultDatabaseName": "interface-1", "vtpDiscoverResultConflicting": true, "vtpDiscoverResultDeviceId": "example-string", "vtpDiscoverResultPrimaryServer": "example-string", "vtpDiscoverResultRevNumber": 0, "vtpDiscoverResultSystemName": "interface-1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vtpDiscoverResultEntry-2" }, "x-yang-path": "/vtpDiscoverResultTable/vtpDiscoverResultEntry={managementDomainIndex vtpDiscoverResultIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "managementDomainIndex vtpDiscoverResultIndex" ] }, "/data/CISCO-VTP-MIB:vtpDatabaseTable/vtpDatabaseEntry={managementDomainIndex},{vtpDatabaseIndex}": { "get": { "summary": "Get vtpDatabaseEntry entry", "description": "Retrieve specific vtpDatabaseEntry entry by key from MIB", "tags": [ "CISCO-VTP-MIB" ], "parameters": [ { "name": "managementDomainIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "vtpDatabaseIndex", "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": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref" }, "vtpDatabaseIndex": { "type": "integer", "description": "A value assigned by the system which uniquely identifies\n a VTP database in the local system.", "minimum": 0, "maximum": 4294967295 }, "vtpDatabaseName": { "type": "string", "description": "The name of the database.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "vtpDatabaseLocalMode": { "type": "string", "description": "The local VTP mode for a particular database type\n in this administrative domain.\n \n - 'client' indicates that the local system is acting\n as a VTP client of the database type.\n \n - 'server' indicates that the local system is acting\n as a VTP server of the database type.\n \n - 'transparent' indicates that the local system does\n not generate or listen to VTP messages of this \n database type, but forwards\n messages. This mode can also be set by the device\n itself when the size of database is too large for it\n to hold in DRAM.\n \n - 'off' indicates that the local system does not\n generate, listen to or forward any VTP messages\n of this database type.\n \n The default mode is 'client' for the database type \n known to the local device and 'transparent' for the\n unknown database type." }, "vtpDatabaseRevNumber": { "type": "integer", "description": "The current configuration revision number as known by the\n local device for this VTP 3 database type in the management\n domain. This value is updated (if necessary) whenever a \n VTP advertisement for the database type is received \n or generated. When the database type is unknown to the \n local device or no VTP advertisement for the database\n type is received or generated, its value is 0.", "minimum": 0, "maximum": 4294967295 }, "vtpDatabasePrimaryServer": { "type": "boolean", "description": "There are two kinds of VTP version 3 servers for a certain\n database type - the primary server and the secondary server.\n When a local device is configured as a server for a certain\n database type, it becomes secondary server by default.\n Primary server is an operational role under which a\n server can initiate or change the VTP configuration of the\n database type.\n \n A true(1) value indicates that the local device is the \n primary server of the database type in the management\n domain. A false(2) value indicates that the local device\n is not the primary server, or the database type is unknown\n to the local device." }, "vtpDatabasePrimaryServerId": { "type": "string", "description": "The unique identifier of the primary server in the\n management domain for the database type. \n \n If no primary server is discovered for the database\n type, the object has a value of zero length string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "vtpDatabaseTakeOverPrimary": { "type": "boolean", "description": "There are two kinds of VTP version 3 servers for a certain\n database type - the primary server and the secondary server.\n When a local device is configured as a server for a certain\n database type, it becomes secondary server by default.\n Primary server is an operational role under which a\n server can initiate or change the VTP configuration of the\n database type.\n \n Setting this object to a true(1) value will advertise the\n configuration of this database type to the whole domain.\n \n In order to successfully setting this object to true(1),\n the value of vtpDatabaseLocalMode must be server(2). Besides\n that, when the VTP password is hidden from the configuration\n file, the password (vtpDatabaseTakeOverPassword) which \n matches the secret key (vtpAuthSecretKey) must be provided\n in the same data packet. \n \n When read, the object always returns false(2)." }, "vtpDatabaseTakeOverPassword": { "type": "string", "description": "When read, this object always returns the value of a\n zero-length octet string.\n \n In the case that the VTP password is hidden from the \n configuration and the local device intends\n to take over the whole domain, this object must be \n set to the matching password with the secret key \n (vtpAuthSecretKey) in the same data packet as which \n the vtpDatabaseTakeOverPrimary is in. In all the \n other situations, setting a valid value to this object \n has no impact on the system.", "x-yang-type": "snmp-framework:SnmpAdminString" } } }, "example": { "CISCO-VTP-MIB:vtpDatabaseEntry": { "managementDomainIndex": "example-string", "vtpDatabaseIndex": 1, "vtpDatabaseName": "interface-1", "vtpDatabaseLocalMode": "example-string", "vtpDatabaseRevNumber": 0, "vtpDatabasePrimaryServer": true, "vtpDatabasePrimaryServerId": "example-string", "vtpDatabaseTakeOverPrimary": true, "vtpDatabaseTakeOverPassword": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vtpDatabaseEntry-2" }, "x-yang-path": "/vtpDatabaseTable/vtpDatabaseEntry={managementDomainIndex vtpDatabaseIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "managementDomainIndex vtpDatabaseIndex" ] }, "/data/CISCO-VTP-MIB:vtpVlanEntry={managementDomainIndex},{vtpVlanIndex}": { "get": { "summary": "Get vtpVlanEntry entry", "description": "Retrieve specific vtpVlanEntry entry by key from MIB", "tags": [ "CISCO-VTP-MIB" ], "parameters": [ { "name": "managementDomainIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "vtpVlanIndex", "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": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref" }, "vtpVlanIndex": { "type": "string", "description": "The VLAN-id of this VLAN on ISL or 802.1q trunks.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex" }, "vtpVlanState": { "type": "string", "description": "The state of this VLAN.\n \n The state 'mtuTooBigForDevice' indicates that this device\n cannot participate in this VLAN because the VLAN's MTU is\n larger than the device can support.\n \n The state 'mtuTooBigForTrunk' indicates that while this\n VLAN's MTU is supported by this device, it is too large for\n one or more of the device's trunk ports." }, "vtpVlanType": { "type": "string", "description": "The type of this VLAN.", "x-yang-type": "CISCO-VTP-MIB:VlanType" }, "vtpVlanName": { "type": "string", "description": "The name of this VLAN. This name is used as the ELAN-name\n for an ATM LAN-Emulation segment of this VLAN.", "x-yang-type": "snmpv2-tc:DisplayString" }, "vtpVlanMtu": { "type": "integer", "description": "The MTU size on this VLAN, defined as the size of largest\n MAC-layer (information field portion of the) data frame\n which can be transmitted on the VLAN.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanDot10Said": { "type": "string", "description": "The value of the 802.10 SAID field for this VLAN.", "format": "binary" }, "vtpVlanRingNumber": { "type": "integer", "description": "The ring number of this VLAN. This object is only\n instantiated when the value of the corresponding instance of\n vtpVlanType has a value of 'fddi' or 'tokenRing' and Source\n Routing is in use on this VLAN.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanBridgeNumber": { "type": "integer", "description": "The bridge number of the VTP-capable switches for this\n VLAN. This object is only instantiated for VLANs that are\n involved with emulating token ring segments.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanStpType": { "type": "string", "description": "The type of the Spanning Tree Protocol (STP) running on\n this VLAN. This object is only instanciated when the\n value of the corresponding instance of vtpVlanType has a\n value of 'fddiNet' or 'trNet'.\n \n The value returned by this object depends upon the value\n of the corresponding instance of vtpVlanEditStpType.\n \n - 'ieee' indicates IEEE STP is running exclusively.\n \n - 'ibm' indicates IBM STP is running exclusively.\n \n - 'hybrid' indicates a STP that allows a combination of\n IEEE and IBM is running.\n \n The 'hybrid' STP type results from tokenRing/fddi VLANs\n that are children of this trNet/fddiNet parent VLAN being\n configured in a combination of SRT and SRB\n vtpVlanBridgeTypes while the instance of\n vtpVlanEditStpType that corresponds to this object is set\n to 'auto'." }, "vtpVlanParentVlan": { "type": "string", "description": "The parent VLAN for this VLAN. This object is only\n instantiated when the value of the corresponding instance of\n vtpVlanType has a value of 'fddi' or 'tokenRing' and Source\n Routing is in use on this VLAN. The parent VLAN must have \n a vtpVlanType value of fddiNet(4) or trNet(5), \n respectively.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex" }, "vtpVlanTranslationalVlan1": { "type": "string", "description": "A VLAN to which this VLAN is being translational-bridged.\n If this value and the corresponding instance of\n vtpVlanTranslationalVlan2 are both zero, then this VLAN is\n not being translational-bridged.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex" }, "vtpVlanTranslationalVlan2": { "type": "string", "description": "Another VLAN, i.e., other than that indicated by\n vtpVlanTranslationalVlan1, to which this VLAN is being\n translational-bridged. If this value and the corresponding\n instance of vtpVlanTranslationalVlan1 are both zero, then\n this VLAN is not being translational-bridged.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex" }, "vtpVlanBridgeType": { "type": "string", "description": "The type of the Source Route bridging mode in use on this\n VLAN. This object is only instantiated when the value of \n the corresponding instance of vtpVlanType has a value of \n fddi(2) or tokenRing(3) and Source Routing is in use on\n this VLAN." }, "vtpVlanAreHopCount": { "type": "integer", "description": "The maximum number of bridge hops allowed in\n All Routes Explorer frames on this VLAN. This\n object is only instantiated when the value of the\n corresponding instance of vtpVlanType has a value of fddi(2)\n or tokenRing(3) and Source Routing is in use on this VLAN.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanSteHopCount": { "type": "integer", "description": "The maximum number of bridge hops allowed in\n Spanning Tree Explorer frames on this VLAN. This\n object is only instantiated when the value of the\n corresponding instance of vtpVlanType has a value of fddi(2)\n or tokenRing(3) and Source Routing is in use on this VLAN.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanIsCRFBackup": { "type": "boolean", "description": "True if this VLAN is of type trCrf and also is acting as\n a backup trCrf for the ISL distributed BRF" }, "vtpVlanTypeExt": { "type": "string", "description": "The additional type information of this VLAN.", "x-yang-type": "CISCO-VTP-MIB:VlanTypeExt" }, "vtpVlanIfIndex": { "type": "string", "description": "The value of the ifIndex corresponding to this VLAN ID.\n If the VLAN ID does not have its corresponding interface, \n this object has the value of zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero" } } }, "example": { "CISCO-VTP-MIB:vtpVlanEntry": { "managementDomainIndex": "example-string", "vtpVlanIndex": "example-string", "vtpVlanState": "up(1)", "vtpVlanType": "ethernetCsmacd(6)", "vtpVlanName": "interface-1", "vtpVlanMtu": 1500, "vtpVlanDot10Said": "example-string", "vtpVlanRingNumber": -2147483648, "vtpVlanBridgeNumber": -2147483648, "vtpVlanStpType": "ethernetCsmacd(6)", "vtpVlanParentVlan": "example-string", "vtpVlanTranslationalVlan1": "example-string", "vtpVlanTranslationalVlan2": "example-string", "vtpVlanBridgeType": "ethernetCsmacd(6)", "vtpVlanAreHopCount": -2147483648, "vtpVlanSteHopCount": -2147483648, "vtpVlanIsCRFBackup": true, "vtpVlanTypeExt": "ethernetCsmacd(6)", "vtpVlanIfIndex": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vtpVlanEntry-4" }, "x-yang-path": "/vtpVlanEntry={managementDomainIndex vtpVlanIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "managementDomainIndex vtpVlanIndex" ] }, "/data/CISCO-VTP-MIB:vtpInternalVlanEntry={managementDomainIndex},{vtpVlanIndex}": { "get": { "summary": "Get vtpInternalVlanEntry entry", "description": "Retrieve specific vtpInternalVlanEntry entry by key from MIB", "tags": [ "CISCO-VTP-MIB" ], "parameters": [ { "name": "managementDomainIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "vtpVlanIndex", "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": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref" }, "vtpVlanIndex": { "type": "string", "description": "vtpVlanIndex", "x-yang-type": "leafref" }, "vtpInternalVlanOwner": { "type": "string", "description": "The program name of the internal VLAN's\n owner application. This internal VLAN\n is allocated by the device specifically\n for this application and no one else\n could create, modify or delete this \n VLAN.", "x-yang-type": "snmp-framework:SnmpAdminString" } } }, "example": { "CISCO-VTP-MIB:vtpInternalVlanEntry": { "managementDomainIndex": "example-string", "vtpVlanIndex": "example-string", "vtpInternalVlanOwner": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vtpInternalVlanEntry-4" }, "x-yang-path": "/vtpInternalVlanEntry={managementDomainIndex vtpVlanIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "managementDomainIndex vtpVlanIndex" ] }, "/data/CISCO-VTP-MIB:vtpVlanEditEntry={managementDomainIndex},{vtpVlanEditIndex}": { "get": { "summary": "Get vtpVlanEditEntry entry", "description": "Retrieve specific vtpVlanEditEntry entry by key from MIB", "tags": [ "CISCO-VTP-MIB" ], "parameters": [ { "name": "managementDomainIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "vtpVlanEditIndex", "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": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref" }, "vtpVlanEditIndex": { "type": "string", "description": "The VLAN-id which this VLAN would have on ISL or\n 802.1q trunks.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex" }, "vtpVlanEditState": { "type": "string", "description": "The state which this VLAN would have." }, "vtpVlanEditType": { "type": "string", "description": "The type which this VLAN would have.\n An implementation may restrict access to this object.", "x-yang-type": "CISCO-VTP-MIB:VlanType" }, "vtpVlanEditName": { "type": "string", "description": "The name which this VLAN would have. This name would be\n used as the ELAN-name for an ATM LAN-Emulation segment of\n this VLAN.\n \n An implementation may restrict access to this object.", "x-yang-type": "snmpv2-tc:DisplayString" }, "vtpVlanEditMtu": { "type": "integer", "description": "The MTU size which this VLAN would have, defined as the\n size of largest MAC-layer (information field portion of the)\n data frame which can be transmitted on the VLAN.\n \n An implementation may restrict access to this object.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanEditDot10Said": { "type": "string", "description": "The value of the 802.10 SAID field which would be used for\n this VLAN.\n \n An implementation may restrict access to this object.", "format": "binary" }, "vtpVlanEditRingNumber": { "type": "integer", "description": "The ring number which would be used for this VLAN. This\n object is only instantiated when the value of the\n corresponding instance of vtpVlanEditType has a value of\n 'fddi' or 'tokenRing' and Source Routing is in use on \n this VLAN.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanEditBridgeNumber": { "type": "integer", "description": "The bridge number of the VTP-capable switches which would\n be used for this VLAN. This object is only instantiated\n when the value of the corresponding instance of\n vtpVlanEditType has a value of fddiNet(4) or trNet(5).", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanEditStpType": { "type": "string", "description": "The type of the Spanning Tree Protocol which would be\n running on this VLAN. This object is only instantiated\n when the value of the corresponding instance of\n vtpVlanEditType has a value of fddiNet(4) or trNet(5).\n \n If 'ieee' is selected, the STP that runs will be IEEE.\n \n If 'ibm' is selected, the STP that runs will be IBM.\n \n If 'auto' is selected, the STP that runs will be\n dependant on the values of vtpVlanEditBridgeType for all\n children tokenRing/fddi type VLANs. This will result in\n a 'hybrid' STP (see vtpVlanStpType)." }, "vtpVlanEditParentVlan": { "type": "string", "description": "The VLAN index of the VLAN which would be the parent for\n this VLAN. This object is only instantiated when the value\n of the corresponding instance of vtpVlanEditType has a value\n of 'fddi' or 'tokenRing' and Source Routing is in use on\n this VLAN. The parent VLAN must have a vtpVlanEditType \n value of fddiNet(4) or trNet(5), respectively.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex" }, "vtpVlanEditRowStatus": { "type": "string", "description": "The status of this row. Any and all columnar objects in an\n existing row can be modified irrespective of the status of\n the row.\n \n A row is not qualified for activation until instances of at\n least its vtpVlanEditType, vtpVlanEditName and\n vtpVlanEditDot10Said columns have appropriate values.\n \n The management station should endeavor to make all rows\n consistent in the table before 'apply'ing the buffer. An\n inconsistent entry in the table will cause the entire\n buffer to be rejected with the vtpVlanApplyStatus object\n set to the appropriate error value.", "x-yang-type": "snmpv2-tc:RowStatus" }, "vtpVlanEditTranslationalVlan1": { "type": "string", "description": "A VLAN to which this VLAN would be translational-bridged.\n If this value and the corresponding instance of\n vtpVlanTranslationalVlan2 are both zero, then this VLAN\n would not be translational-bridged.\n \n An implementation may restrict access to this object.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex" }, "vtpVlanEditTranslationalVlan2": { "type": "string", "description": "Another VLAN, i.e., other than that indicated by\n vtpVlanEditTranslationalVlan1, to which this VLAN would be\n translational-bridged. If this value and the corresponding\n instance of vtpVlanTranslationalVlan1 are both zero, then\n this VLAN would not be translational-bridged.\n \n An implementation may restrict access to this object.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex" }, "vtpVlanEditBridgeType": { "type": "string", "description": "The type of Source Route bridging mode which would be in\n use on this VLAN. This object is only instantiated when \n the value of the corresponding instance of vtpVlanEditType\n has a value of fddi(2) or tokenRing(3) and Source Routing \n is in use on this VLAN." }, "vtpVlanEditAreHopCount": { "type": "integer", "description": "The maximum number of bridge hops allowed in\n All Routes Explorer frames on this VLAN. This\n object is only instantiated when the value of the\n corresponding instance of vtpVlanType has a value of fddi(2)\n or tokenRing(3) and Source Routing is in use on this VLAN.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanEditSteHopCount": { "type": "integer", "description": "The maximum number of bridge hops allowed in\n Spanning Tree Explorer frames on this VLAN. This\n object is only instantiated when the value of the\n corresponding instance of vtpVlanType has a value of fddi(2)\n or tokenRing(3) and Source Routing is in use on this VLAN.", "minimum": -2147483648, "maximum": 2147483647 }, "vtpVlanEditIsCRFBackup": { "type": "boolean", "description": "True if this VLAN is of type trCrf and also is acting as\n a backup trCrf for the ISL distributed BRF. This object is\n only instantiated when the value of the corresponding\n instance of vtpVlanEditType has a value of tokenRing(3)." }, "vtpVlanEditTypeExt": { "type": "string", "description": "The additional type information of this VLAN.\n vtpVlanEditTypeExt object is superseded by vtpVlanEditTypeExt2.", "x-yang-type": "CISCO-VTP-MIB:VlanTypeExt" }, "vtpVlanEditTypeExt2": { "type": "string", "description": "The additional type information of this VLAN.\n The VlanTypeExt TC specifies which bits may\n be written by a management application.\n The agent should provide a default value.", "x-yang-type": "CISCO-VTP-MIB:VlanTypeExt" } } }, "example": { "CISCO-VTP-MIB:vtpVlanEditEntry": { "managementDomainIndex": "example-string", "vtpVlanEditIndex": "example-string", "vtpVlanEditState": "up(1)", "vtpVlanEditType": "ethernetCsmacd(6)", "vtpVlanEditName": "interface-1", "vtpVlanEditMtu": 1500, "vtpVlanEditDot10Said": "example-string", "vtpVlanEditRingNumber": -2147483648, "vtpVlanEditBridgeNumber": -2147483648, "vtpVlanEditStpType": "ethernetCsmacd(6)", "vtpVlanEditParentVlan": "example-string", "vtpVlanEditRowStatus": "up(1)", "vtpVlanEditTranslationalVlan1": "example-string", "vtpVlanEditTranslationalVlan2": "example-string", "vtpVlanEditBridgeType": "ethernetCsmacd(6)", "vtpVlanEditAreHopCount": -2147483648, "vtpVlanEditSteHopCount": -2147483648, "vtpVlanEditIsCRFBackup": true, "vtpVlanEditTypeExt": "ethernetCsmacd(6)", "vtpVlanEditTypeExt2": "ethernetCsmacd(6)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vtpVlanEditEntry-4" }, "x-yang-path": "/vtpVlanEditEntry={managementDomainIndex vtpVlanEditIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "managementDomainIndex vtpVlanEditIndex" ] }, "/data/CISCO-VTP-MIB:vtpVlanLocalShutdownEntry={managementDomainIndex},{vtpVlanIndex}": { "get": { "summary": "Get vtpVlanLocalShutdownEntry entry", "description": "Retrieve specific vtpVlanLocalShutdownEntry entry by key from MIB", "tags": [ "CISCO-VTP-MIB" ], "parameters": [ { "name": "managementDomainIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "vtpVlanIndex", "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": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref" }, "vtpVlanIndex": { "type": "string", "description": "vtpVlanIndex", "x-yang-type": "leafref" }, "vtpVlanLocalShutdown": { "type": "string", "description": "The object specifies the VLAN local shutdown state." } } }, "example": { "CISCO-VTP-MIB:vtpVlanLocalShutdownEntry": { "managementDomainIndex": "example-string", "vtpVlanIndex": "example-string", "vtpVlanLocalShutdown": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vtpVlanLocalShutdownEntry-4" }, "x-yang-path": "/vtpVlanLocalShutdownEntry={managementDomainIndex vtpVlanIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "managementDomainIndex vtpVlanIndex" ] }, "/data/CISCO-VTP-MIB:vtpDiscoverResultEntry={managementDomainIndex},{vtpDiscoverResultIndex}": { "get": { "summary": "Get vtpDiscoverResultEntry entry", "description": "Retrieve specific vtpDiscoverResultEntry entry by key from MIB", "tags": [ "CISCO-VTP-MIB" ], "parameters": [ { "name": "managementDomainIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "vtpDiscoverResultIndex", "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": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref" }, "vtpDiscoverResultIndex": { "type": "integer", "description": "A value assigned by the system which identifies\n a VTP member and the associated database in the \n management domain.", "minimum": 0, "maximum": 4294967295 }, "vtpDiscoverResultDatabaseName": { "type": "string", "description": "The database name associated with the\n discovered VTP member.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "vtpDiscoverResultConflicting": { "type": "boolean", "description": "Indicates whether this VTP member contains\n conflicting information.\n \n true(1) indicates that this member has conflicting \n information of the database type in the management domain.\n \n false(2) indicates that there is no conflicting information\n of the database type in the management domain." }, "vtpDiscoverResultDeviceId": { "type": "string", "description": "The unique identifier of the device for this VTP member.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "vtpDiscoverResultPrimaryServer": { "type": "string", "description": "The unique identifier of the primary server for this VTP\n member and the associated database type.\n \n There are two different VTP servers, the primary server\n and the secondary server. When a local device is\n configured as a server for a certain database type,\n it becomes secondary server by default. \n Primary server is an operational role under which a\n server can initiate or change the VTP configuration of the\n database type.\n \n If this VTP member itself is the primary server, the \n value of this object is the same as the value of \n vtpDiscoverResultDeviceId of the instance.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "vtpDiscoverResultRevNumber": { "type": "integer", "description": "The current configuration revision number as known by the\n VTP member. When the database type is unknown for\n the VTP member, this value is 0.", "minimum": 0, "maximum": 4294967295 }, "vtpDiscoverResultSystemName": { "type": "string", "description": "sysName of the VTP member.", "x-yang-type": "snmp-framework:SnmpAdminString" } } }, "example": { "CISCO-VTP-MIB:vtpDiscoverResultEntry": { "managementDomainIndex": "example-string", "vtpDiscoverResultIndex": 1, "vtpDiscoverResultDatabaseName": "interface-1", "vtpDiscoverResultConflicting": true, "vtpDiscoverResultDeviceId": "example-string", "vtpDiscoverResultPrimaryServer": "example-string", "vtpDiscoverResultRevNumber": 0, "vtpDiscoverResultSystemName": "interface-1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vtpDiscoverResultEntry-4" }, "x-yang-path": "/vtpDiscoverResultEntry={managementDomainIndex vtpDiscoverResultIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "managementDomainIndex vtpDiscoverResultIndex" ] }, "/data/CISCO-VTP-MIB:vtpDatabaseEntry={managementDomainIndex},{vtpDatabaseIndex}": { "get": { "summary": "Get vtpDatabaseEntry entry", "description": "Retrieve specific vtpDatabaseEntry entry by key from MIB", "tags": [ "CISCO-VTP-MIB" ], "parameters": [ { "name": "managementDomainIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "vtpDatabaseIndex", "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": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref" }, "vtpDatabaseIndex": { "type": "integer", "description": "A value assigned by the system which uniquely identifies\n a VTP database in the local system.", "minimum": 0, "maximum": 4294967295 }, "vtpDatabaseName": { "type": "string", "description": "The name of the database.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "vtpDatabaseLocalMode": { "type": "string", "description": "The local VTP mode for a particular database type\n in this administrative domain.\n \n - 'client' indicates that the local system is acting\n as a VTP client of the database type.\n \n - 'server' indicates that the local system is acting\n as a VTP server of the database type.\n \n - 'transparent' indicates that the local system does\n not generate or listen to VTP messages of this \n database type, but forwards\n messages. This mode can also be set by the device\n itself when the size of database is too large for it\n to hold in DRAM.\n \n - 'off' indicates that the local system does not\n generate, listen to or forward any VTP messages\n of this database type.\n \n The default mode is 'client' for the database type \n known to the local device and 'transparent' for the\n unknown database type." }, "vtpDatabaseRevNumber": { "type": "integer", "description": "The current configuration revision number as known by the\n local device for this VTP 3 database type in the management\n domain. This value is updated (if necessary) whenever a \n VTP advertisement for the database type is received \n or generated. When the database type is unknown to the \n local device or no VTP advertisement for the database\n type is received or generated, its value is 0.", "minimum": 0, "maximum": 4294967295 }, "vtpDatabasePrimaryServer": { "type": "boolean", "description": "There are two kinds of VTP version 3 servers for a certain\n database type - the primary server and the secondary server.\n When a local device is configured as a server for a certain\n database type, it becomes secondary server by default.\n Primary server is an operational role under which a\n server can initiate or change the VTP configuration of the\n database type.\n \n A true(1) value indicates that the local device is the \n primary server of the database type in the management\n domain. A false(2) value indicates that the local device\n is not the primary server, or the database type is unknown\n to the local device." }, "vtpDatabasePrimaryServerId": { "type": "string", "description": "The unique identifier of the primary server in the\n management domain for the database type. \n \n If no primary server is discovered for the database\n type, the object has a value of zero length string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "vtpDatabaseTakeOverPrimary": { "type": "boolean", "description": "There are two kinds of VTP version 3 servers for a certain\n database type - the primary server and the secondary server.\n When a local device is configured as a server for a certain\n database type, it becomes secondary server by default.\n Primary server is an operational role under which a\n server can initiate or change the VTP configuration of the\n database type.\n \n Setting this object to a true(1) value will advertise the\n configuration of this database type to the whole domain.\n \n In order to successfully setting this object to true(1),\n the value of vtpDatabaseLocalMode must be server(2). Besides\n that, when the VTP password is hidden from the configuration\n file, the password (vtpDatabaseTakeOverPassword) which \n matches the secret key (vtpAuthSecretKey) must be provided\n in the same data packet. \n \n When read, the object always returns false(2)." }, "vtpDatabaseTakeOverPassword": { "type": "string", "description": "When read, this object always returns the value of a\n zero-length octet string.\n \n In the case that the VTP password is hidden from the \n configuration and the local device intends\n to take over the whole domain, this object must be \n set to the matching password with the secret key \n (vtpAuthSecretKey) in the same data packet as which \n the vtpDatabaseTakeOverPrimary is in. In all the \n other situations, setting a valid value to this object \n has no impact on the system.", "x-yang-type": "snmp-framework:SnmpAdminString" } } }, "example": { "CISCO-VTP-MIB:vtpDatabaseEntry": { "managementDomainIndex": "example-string", "vtpDatabaseIndex": 1, "vtpDatabaseName": "interface-1", "vtpDatabaseLocalMode": "example-string", "vtpDatabaseRevNumber": 0, "vtpDatabasePrimaryServer": true, "vtpDatabasePrimaryServerId": "example-string", "vtpDatabaseTakeOverPrimary": true, "vtpDatabaseTakeOverPassword": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-vtpDatabaseEntry-4" }, "x-yang-path": "/vtpDatabaseEntry={managementDomainIndex vtpDatabaseIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "managementDomainIndex vtpDatabaseIndex" ] } }, "components": { "schemas": { "CISCO-VTP-MIB_CISCO-VTP-MIB": { "type": "object", "description": "CISCO-VTP-MIB", "properties": { "managementDomainEntry": { "type": "array", "description": "Information about the status of one management domain.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "An arbitrary value to uniquely identify the management\n domain on the local system.", "x-yang-type": "CISCO-VTP-MIB:ManagementDomainIndex", "readOnly": true }, "managementDomainName": { "type": "string", "description": "The management name of a domain in which the local system\n is participating. The zero-length name corresponds to the\n 'no management-domain' state which is the initial value at\n installation-time if not configured otherwise. Note that\n the zero-length name does not correspond to an operational\n management domain, and a device does not send VTP\n advertisements while in the 'no management-domain' state. A\n device leaves the 'no management-domain' state when it\n obtains a management-domain name, either through\n configuration or through inheriting the management-domain\n name from a received VTP advertisement.\n \n When the value of an existing instance of this object is\n modified by network management, the local system should re-\n initialize its VLAN information (for the given management\n domain) as if it had just been configured with a management\n domain name at installation time.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "managementDomainLocalMode": { "type": "string", "description": "The local VTP mode in this management domain when\n managementDomainVersionInUse is version1(1) or\n version2(2).\n \n If managementDomainVersionInUse is version3(4), this \n object has the same value with vtpDatabaseLocalMode \n of VLAN database type.\n \n - 'client' indicates that the local system is acting\n as a VTP client.\n \n - 'server' indicates that the local system is acting\n as a VTP server.\n \n - 'transparent' indicates that the local system does\n not generate or listen to VTP messages, but forwards\n messages. This mode can also be set by the device\n itself when the amount of VLAN information is too\n large for it to hold in DRAM.\n \n - 'off' indicates that the local system does not\n generate, listen to or forward any VTP messages.", "readOnly": true }, "managementDomainConfigRevNumber": { "type": "integer", "description": "The current Configuration Revision Number as known by\n the local device for this management domain when \n managementDomainVersionInUse is version1(1) or \n version2(2).\n \n If managementDomainVersionInUse is version3(4), this \n object has the same value with vtpDatabaseRevisionNumber \n of VLAN database type.\n \n This value is updated (if necessary) whenever a VTP\n advertisement is received or generated. When in the\n 'no management-domain' state, this value is 0.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "managementDomainLastUpdater": { "type": "string", "description": "The IP-address (or one of them) of the VTP Server which\n last updated the Configuration Revision Number, as indicated\n in the most recently received VTP advertisement for this\n management domain, when managementDomainVersionInUse is\n version1(1) or version2(2). \n \n If managementDomainVersionInUse is version3(4), this object\n has the value of 0.0.0.0.\n \n Before an advertisement has been received, this value is\n 0.0.0.0.", "format": "inet:ipv4-address", "readOnly": true }, "managementDomainLastChange": { "type": "string", "description": "The time at which the Configuration Revision Number was\n (last) increased to its current value, as indicated in the\n most recently received VTP advertisement for this management\n domain when managementDomainVersionInUse is not version3(4)\n or in the most recently received VTP VLAN database \n advertisement for this management domain when \n managementDomainVersionInUse is version3(4).\n \n The value 0x0000010100000000 indicates that the device which\n last increased the Configuration Revision Number had no idea\n of the date/time, or that no advertisement has been\n received.", "x-yang-type": "snmpv2-tc:DateAndTime", "readOnly": true }, "managementDomainRowStatus": { "type": "string", "description": "The status of this conceptual row.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "managementDomainTftpServer": { "type": "string", "description": "The IP address of a TFTP Server in/from which VTP VLAN\n information for this management domain is to be\n stored/retrieved. If the information is being locally\n stored in NVRAM, this object should take the value 0.0.0.0.", "format": "inet:ipv4-address", "readOnly": true }, "managementDomainTftpPathname": { "type": "string", "description": "The complete pathname of the file at the TFTP Server\n identified by the value of managementDomainTftpServer\n in/from which VTP VLAN information for this management\n domain is to be stored/retrieved. If the value of\n corresponding instance of managementDomainTftpServer is\n 0.0.0.0, the value of this object is ignored.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "managementDomainPruningState": { "type": "string", "description": "An indication of whether VTP pruning is enabled or disabled\n in this managament domain. \n \n This object can only be modified, either when the \n corresponding instance value of managementDomainVersionInUse \n is 'version1' or 'version2' and the corresponding instance \n value of managementDomainLocalMode is 'server', or when the \n corresponding instance value of managementDomainVersionInUse \n is 'version3' and the corresponding instance value of \n managementDomainLocalMode is 'server' or 'client'.", "readOnly": true }, "managementDomainVersionInUse": { "type": "string", "description": "The current version of the VTP that is in use by the\n designated management domain. \n \n This object can be set to none(3) only when \n vtpVersion is none(3).", "readOnly": true }, "managementDomainPruningStateOper": { "type": "string", "description": "Indicates whether VTP pruning is operationally enabled or\n disabled in this managament domain.", "readOnly": true }, "managementDomainAdminSrcIf": { "type": "string", "description": "The object specifies the interface to be used as the\n preferred source interface for the VTP IP updater address.\n \n A zero length value indicates that a source interface is not\n specified.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "managementDomainSourceOnlyMode": { "type": "boolean", "description": "The object specifies whether to use only the IP address of\n managementDomainAdminSrcIf as the VTP IP updater address. \n \n 'true' indicates to only use the IP address of \n managementDomainAdminSrcIf as the VTP IP \n updater address. \n \n 'false' indicates to use the IP address of \n managementDomainAdminSrcIf as the VTP IP \n updater address if managementDomainAdminSrcIf \n is configured with an IP address. Otherwise, the \n first available IP address of the system will\n be used.", "readOnly": true }, "managementDomainOperSrcIf": { "type": "string", "description": "The object indicates the interface used as the\n preferred source interface for the VTP IP updater address.\n \n A zero length string indicates that a source interface is not\n available.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "managementDomainConfigFile": { "type": "string", "description": "The object specifies the file name where VTP configuration\n is stored in the format of or :[].\n \n can be (but not limited to): flash, bootflash,\n slot0, slot1, disk0.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "managementDomainLocalUpdaterType": { "type": "string", "description": "The object indicates the type of the Internet address\n of the preferred source interface for the VTP IP updater.\n \n The value of this object is 'unknown' if\n managementDomainVersionInUse is 'version3' or\n managementDomainLocalMode is not 'server'.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "managementDomainLocalUpdater": { "type": "string", "description": "The object indicates the Internet address of the\n preferred source interface for the VTP IP updater.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "managementDomainDeviceID": { "type": "string", "description": "The object indicates a value that uniquely identifies\n this device within a VTP Domain.\n \n The value of this object is zero length string if\n managementDomainVersionInUse is not 'version3'.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true } } }, "readOnly": true }, "vtpVlanEntry": { "type": "array", "description": "Information about one current VLAN. The\n managementDomainIndex value in the INDEX clause indicates\n which management domain the VLAN is in.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref", "readOnly": true }, "vtpVlanIndex": { "type": "string", "description": "The VLAN-id of this VLAN on ISL or 802.1q trunks.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex", "readOnly": true }, "vtpVlanState": { "type": "string", "description": "The state of this VLAN.\n \n The state 'mtuTooBigForDevice' indicates that this device\n cannot participate in this VLAN because the VLAN's MTU is\n larger than the device can support.\n \n The state 'mtuTooBigForTrunk' indicates that while this\n VLAN's MTU is supported by this device, it is too large for\n one or more of the device's trunk ports.", "readOnly": true }, "vtpVlanType": { "type": "string", "description": "The type of this VLAN.", "x-yang-type": "CISCO-VTP-MIB:VlanType", "readOnly": true }, "vtpVlanName": { "type": "string", "description": "The name of this VLAN. This name is used as the ELAN-name\n for an ATM LAN-Emulation segment of this VLAN.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "vtpVlanMtu": { "type": "integer", "description": "The MTU size on this VLAN, defined as the size of largest\n MAC-layer (information field portion of the) data frame\n which can be transmitted on the VLAN.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "vtpVlanDot10Said": { "type": "string", "description": "The value of the 802.10 SAID field for this VLAN.", "format": "binary", "readOnly": true }, "vtpVlanRingNumber": { "type": "integer", "description": "The ring number of this VLAN. This object is only\n instantiated when the value of the corresponding instance of\n vtpVlanType has a value of 'fddi' or 'tokenRing' and Source\n Routing is in use on this VLAN.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "vtpVlanBridgeNumber": { "type": "integer", "description": "The bridge number of the VTP-capable switches for this\n VLAN. This object is only instantiated for VLANs that are\n involved with emulating token ring segments.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "vtpVlanStpType": { "type": "string", "description": "The type of the Spanning Tree Protocol (STP) running on\n this VLAN. This object is only instanciated when the\n value of the corresponding instance of vtpVlanType has a\n value of 'fddiNet' or 'trNet'.\n \n The value returned by this object depends upon the value\n of the corresponding instance of vtpVlanEditStpType.\n \n - 'ieee' indicates IEEE STP is running exclusively.\n \n - 'ibm' indicates IBM STP is running exclusively.\n \n - 'hybrid' indicates a STP that allows a combination of\n IEEE and IBM is running.\n \n The 'hybrid' STP type results from tokenRing/fddi VLANs\n that are children of this trNet/fddiNet parent VLAN being\n configured in a combination of SRT and SRB\n vtpVlanBridgeTypes while the instance of\n vtpVlanEditStpType that corresponds to this object is set\n to 'auto'.", "readOnly": true }, "vtpVlanParentVlan": { "type": "string", "description": "The parent VLAN for this VLAN. This object is only\n instantiated when the value of the corresponding instance of\n vtpVlanType has a value of 'fddi' or 'tokenRing' and Source\n Routing is in use on this VLAN. The parent VLAN must have \n a vtpVlanType value of fddiNet(4) or trNet(5), \n respectively.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex", "readOnly": true }, "vtpVlanTranslationalVlan1": { "type": "string", "description": "A VLAN to which this VLAN is being translational-bridged.\n If this value and the corresponding instance of\n vtpVlanTranslationalVlan2 are both zero, then this VLAN is\n not being translational-bridged.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex", "readOnly": true }, "vtpVlanTranslationalVlan2": { "type": "string", "description": "Another VLAN, i.e., other than that indicated by\n vtpVlanTranslationalVlan1, to which this VLAN is being\n translational-bridged. If this value and the corresponding\n instance of vtpVlanTranslationalVlan1 are both zero, then\n this VLAN is not being translational-bridged.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex", "readOnly": true }, "vtpVlanBridgeType": { "type": "string", "description": "The type of the Source Route bridging mode in use on this\n VLAN. This object is only instantiated when the value of \n the corresponding instance of vtpVlanType has a value of \n fddi(2) or tokenRing(3) and Source Routing is in use on\n this VLAN.", "readOnly": true }, "vtpVlanAreHopCount": { "type": "integer", "description": "The maximum number of bridge hops allowed in\n All Routes Explorer frames on this VLAN. This\n object is only instantiated when the value of the\n corresponding instance of vtpVlanType has a value of fddi(2)\n or tokenRing(3) and Source Routing is in use on this VLAN.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "vtpVlanSteHopCount": { "type": "integer", "description": "The maximum number of bridge hops allowed in\n Spanning Tree Explorer frames on this VLAN. This\n object is only instantiated when the value of the\n corresponding instance of vtpVlanType has a value of fddi(2)\n or tokenRing(3) and Source Routing is in use on this VLAN.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "vtpVlanIsCRFBackup": { "type": "boolean", "description": "True if this VLAN is of type trCrf and also is acting as\n a backup trCrf for the ISL distributed BRF", "readOnly": true }, "vtpVlanTypeExt": { "type": "string", "description": "The additional type information of this VLAN.", "x-yang-type": "CISCO-VTP-MIB:VlanTypeExt", "readOnly": true }, "vtpVlanIfIndex": { "type": "string", "description": "The value of the ifIndex corresponding to this VLAN ID.\n If the VLAN ID does not have its corresponding interface, \n this object has the value of zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true } } }, "readOnly": true }, "vtpInternalVlanEntry": { "type": "array", "description": "Information about one current internal\n VLAN.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref", "readOnly": true }, "vtpVlanIndex": { "type": "string", "description": "vtpVlanIndex", "x-yang-type": "leafref", "readOnly": true }, "vtpInternalVlanOwner": { "type": "string", "description": "The program name of the internal VLAN's\n owner application. This internal VLAN\n is allocated by the device specifically\n for this application and no one else\n could create, modify or delete this \n VLAN.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true } } }, "readOnly": true }, "vtpVlanEditEntry": { "type": "array", "description": "Information about one VLAN in the Edit Buffer for a\n particular management domain.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref", "readOnly": true }, "vtpVlanEditIndex": { "type": "string", "description": "The VLAN-id which this VLAN would have on ISL or\n 802.1q trunks.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex", "readOnly": true }, "vtpVlanEditState": { "type": "string", "description": "The state which this VLAN would have.", "readOnly": true }, "vtpVlanEditType": { "type": "string", "description": "The type which this VLAN would have.\n An implementation may restrict access to this object.", "x-yang-type": "CISCO-VTP-MIB:VlanType", "readOnly": true }, "vtpVlanEditName": { "type": "string", "description": "The name which this VLAN would have. This name would be\n used as the ELAN-name for an ATM LAN-Emulation segment of\n this VLAN.\n \n An implementation may restrict access to this object.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "vtpVlanEditMtu": { "type": "integer", "description": "The MTU size which this VLAN would have, defined as the\n size of largest MAC-layer (information field portion of the)\n data frame which can be transmitted on the VLAN.\n \n An implementation may restrict access to this object.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "vtpVlanEditDot10Said": { "type": "string", "description": "The value of the 802.10 SAID field which would be used for\n this VLAN.\n \n An implementation may restrict access to this object.", "format": "binary", "readOnly": true }, "vtpVlanEditRingNumber": { "type": "integer", "description": "The ring number which would be used for this VLAN. This\n object is only instantiated when the value of the\n corresponding instance of vtpVlanEditType has a value of\n 'fddi' or 'tokenRing' and Source Routing is in use on \n this VLAN.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "vtpVlanEditBridgeNumber": { "type": "integer", "description": "The bridge number of the VTP-capable switches which would\n be used for this VLAN. This object is only instantiated\n when the value of the corresponding instance of\n vtpVlanEditType has a value of fddiNet(4) or trNet(5).", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "vtpVlanEditStpType": { "type": "string", "description": "The type of the Spanning Tree Protocol which would be\n running on this VLAN. This object is only instantiated\n when the value of the corresponding instance of\n vtpVlanEditType has a value of fddiNet(4) or trNet(5).\n \n If 'ieee' is selected, the STP that runs will be IEEE.\n \n If 'ibm' is selected, the STP that runs will be IBM.\n \n If 'auto' is selected, the STP that runs will be\n dependant on the values of vtpVlanEditBridgeType for all\n children tokenRing/fddi type VLANs. This will result in\n a 'hybrid' STP (see vtpVlanStpType).", "readOnly": true }, "vtpVlanEditParentVlan": { "type": "string", "description": "The VLAN index of the VLAN which would be the parent for\n this VLAN. This object is only instantiated when the value\n of the corresponding instance of vtpVlanEditType has a value\n of 'fddi' or 'tokenRing' and Source Routing is in use on\n this VLAN. The parent VLAN must have a vtpVlanEditType \n value of fddiNet(4) or trNet(5), respectively.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex", "readOnly": true }, "vtpVlanEditRowStatus": { "type": "string", "description": "The status of this row. Any and all columnar objects in an\n existing row can be modified irrespective of the status of\n the row.\n \n A row is not qualified for activation until instances of at\n least its vtpVlanEditType, vtpVlanEditName and\n vtpVlanEditDot10Said columns have appropriate values.\n \n The management station should endeavor to make all rows\n consistent in the table before 'apply'ing the buffer. An\n inconsistent entry in the table will cause the entire\n buffer to be rejected with the vtpVlanApplyStatus object\n set to the appropriate error value.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "vtpVlanEditTranslationalVlan1": { "type": "string", "description": "A VLAN to which this VLAN would be translational-bridged.\n If this value and the corresponding instance of\n vtpVlanTranslationalVlan2 are both zero, then this VLAN\n would not be translational-bridged.\n \n An implementation may restrict access to this object.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex", "readOnly": true }, "vtpVlanEditTranslationalVlan2": { "type": "string", "description": "Another VLAN, i.e., other than that indicated by\n vtpVlanEditTranslationalVlan1, to which this VLAN would be\n translational-bridged. If this value and the corresponding\n instance of vtpVlanTranslationalVlan1 are both zero, then\n this VLAN would not be translational-bridged.\n \n An implementation may restrict access to this object.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex", "readOnly": true }, "vtpVlanEditBridgeType": { "type": "string", "description": "The type of Source Route bridging mode which would be in\n use on this VLAN. This object is only instantiated when \n the value of the corresponding instance of vtpVlanEditType\n has a value of fddi(2) or tokenRing(3) and Source Routing \n is in use on this VLAN.", "readOnly": true }, "vtpVlanEditAreHopCount": { "type": "integer", "description": "The maximum number of bridge hops allowed in\n All Routes Explorer frames on this VLAN. This\n object is only instantiated when the value of the\n corresponding instance of vtpVlanType has a value of fddi(2)\n or tokenRing(3) and Source Routing is in use on this VLAN.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "vtpVlanEditSteHopCount": { "type": "integer", "description": "The maximum number of bridge hops allowed in\n Spanning Tree Explorer frames on this VLAN. This\n object is only instantiated when the value of the\n corresponding instance of vtpVlanType has a value of fddi(2)\n or tokenRing(3) and Source Routing is in use on this VLAN.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "vtpVlanEditIsCRFBackup": { "type": "boolean", "description": "True if this VLAN is of type trCrf and also is acting as\n a backup trCrf for the ISL distributed BRF. This object is\n only instantiated when the value of the corresponding\n instance of vtpVlanEditType has a value of tokenRing(3).", "readOnly": true }, "vtpVlanEditTypeExt": { "type": "string", "description": "The additional type information of this VLAN.\n vtpVlanEditTypeExt object is superseded by vtpVlanEditTypeExt2.", "x-yang-type": "CISCO-VTP-MIB:VlanTypeExt", "readOnly": true }, "vtpVlanEditTypeExt2": { "type": "string", "description": "The additional type information of this VLAN.\n The VlanTypeExt TC specifies which bits may\n be written by a management application.\n The agent should provide a default value.", "x-yang-type": "CISCO-VTP-MIB:VlanTypeExt", "readOnly": true } } }, "readOnly": true }, "vtpVlanLocalShutdownEntry": { "type": "array", "description": "An entry containing VLAN local shutdown information for a\n particular VLAN in the management domain.\n \n An entry is created if a VLAN which supports local shutdown\n has been created.\n \n An entry is deleted if a VLAN which supports local shutdown\n has been removed.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref", "readOnly": true }, "vtpVlanIndex": { "type": "string", "description": "vtpVlanIndex", "x-yang-type": "leafref", "readOnly": true }, "vtpVlanLocalShutdown": { "type": "string", "description": "The object specifies the VLAN local shutdown state.", "readOnly": true } } }, "readOnly": true }, "vlanTrunkPortEntry": { "type": "array", "description": "Information about one trunk port.", "items": { "type": "object", "properties": { "vlanTrunkPortIfIndex": { "type": "string", "description": "The value of ifIndex for the interface corresponding to\n this trunk port.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true }, "vlanTrunkPortManagementDomain": { "type": "string", "description": "The value of managementDomainIndex for the management\n domain on this trunk port. Devices which support only one\n management domain will support this object read-only.", "x-yang-type": "CISCO-VTP-MIB:ManagementDomainIndex", "readOnly": true }, "vlanTrunkPortEncapsulationType": { "type": "string", "description": "The type of VLAN encapsulation desired to be used on this\n trunk port. It is either a particular type, or 'negotiate'\n meaning whatever type results from the negotiation.\n negotiate(5) is not allowed if the port does not support\n negotiation or if its vlanTrunkPortDynamicState is set to\n on(1) or onNoNegotiate(5). Whether writing to this object\n in order to modify the encapsulation is supported is both\n device and interface specific.", "readOnly": true }, "vlanTrunkPortVlansEnabled": { "type": "string", "description": "A string of octets containing one bit per VLAN in the\n management domain on this trunk port. The first octet\n corresponds to VLANs with VlanIndex values of 0 through 7;\n the second octet to VLANs 8 through 15; etc. The most\n significant bit of each octet corresponds to the lowest\n value VlanIndex in that octet. If the bit corresponding to\n a VLAN is set to '1', then the local system is enabled for\n sending and receiving frames on that VLAN; if the bit is set\n to '0', then the system is disabled from sending and\n receiving frames on that VLAN.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary", "readOnly": true }, "vlanTrunkPortNativeVlan": { "type": "string", "description": "The VlanIndex of the VLAN which is represented by native\n frames on this trunk port. For trunk ports not supporting\n the sending and receiving of native frames, this value\n should be set to zero.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex", "readOnly": true }, "vlanTrunkPortRowStatus": { "type": "string", "description": "The status of this row. In some circumstances, the\n creation of a row in this table is needed to enable the\n appropriate trunking/tagging protocol on the port, to enable\n the use of VTP on the port, and to assign the port to the\n appropriate management domain. In other circumstances, rows\n in this table will be created as a by-product of other\n operations.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "vlanTrunkPortInJoins": { "type": "integer", "description": "The number of VTP Join messages received on this trunk\n port.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "vlanTrunkPortOutJoins": { "type": "integer", "description": "The number of VTP Join messages sent on this trunk port.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "vlanTrunkPortOldAdverts": { "type": "integer", "description": "The number of VTP Advertisement messages which indicated\n the sender does not support VLAN-pruning received on this\n trunk port.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "vlanTrunkPortVlansPruningEligible": { "type": "string", "description": "A string of octets containing one bit per VLAN in the\n management domain on this trunk port. The first octet\n corresponds to VLANs with VlanIndex values of 0 through 7;\n the second octet to VLANs 8 through 15; etc. The most\n significant bit of each octet corresponds to the lowest\n value VlanIndex in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local system is permitted to prune that VLAN on this trunk\n port; if the bit is set to '0', then the system must not\n prune that VLAN on this trunk port.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary", "readOnly": true }, "vlanTrunkPortVlansXmitJoined": { "type": "string", "description": "A string of octets containing one bit per VLAN in the\n management domain on this trunk port. The first octet\n corresponds to VLANs with VlanIndex values of 0 through 7;\n the second octet to VLANs 8 through 15; etc. The most\n significant bit of each octet corresponds to the lowest\n value VlanIndex in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then this\n VLAN is presently being forwarded on this trunk port, i.e.,\n it is not pruned; if the bit is set to '0', then this VLAN\n is presently not being forwarded on this trunk port, either\n because it is pruned or for some other reason.", "format": "binary", "readOnly": true }, "vlanTrunkPortVlansRcvJoined": { "type": "string", "description": "A string of octets containing one bit per VLAN in the\n management domain on this trunk port. The first octet\n corresponds to VLANs with VlanIndex values of 0 through 7;\n the second octet to VLANs 8 through 15; etc. The most\n significant bit of each octet corresponds to the lowest\n value VlanIndex in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local switch is currently sending joins for this VLAN on\n this trunk port, i.e., it is asking to receive frames for\n this VLAN; if the bit is set to '0', then the local switch\n is not currently sending joins for this VLAN on this trunk\n port.", "format": "binary", "readOnly": true }, "vlanTrunkPortDynamicState": { "type": "string", "description": "For devices that allows dynamic determination of whether\n a link between two switches should be a trunk or not, this\n object allows the operator to mandate the behavior of that\n dynamic mechanism.\n \n on(1) dictates that the interface will always be a\n trunk. This is the value for static entries (those that\n show no dynamic behavior). If the negotiation is supported\n on this port, negotiation will take place with the far end\n to attempt to bring the far end into trunking state.\n \n off(2) allows an operator to specify that the specified\n interface is never to be trunk, regardless of any dynamic\n mechanisms to the contrary. This value is useful for\n overriding the default behavior of some switches. If the\n negotiation is supported on this port, negotiation will take\n place with the far end to attempt on the link to bring the\n far end into non-trunking state.\n \n desirable(3) is used to indicate that it is desirable for\n the interface to become a trunk. The device will initiate\n any negotiation necessary to become a trunk but will not\n become a trunk unless it receives confirmation from the far\n end on the link.\n \n auto(4) is used to indicate that the interface is capable\n and willing to become a trunk but will not initiate\n trunking negotiations. The far end on the link are\n required to either start negotiations or start sending\n encapsulated packets, on which event the specified\n interface will become a trunk.\n \n onNoNegotiate(5) is used to indicate that the interface is\n permanently set to be a trunk, and no negotiation takes\n place with the far end on the link to ensure consistent\n operation. This is similar to on(1) except no negotiation\n takes place with the far end.\n \n If the port does not support negotiation or its\n vlanTrunkPortEncapsulationType is set to negotiate(5),\n onNoNegotiate(5) is not allowed.\n \n Devices that do no support dynamic determination (for just\n a particular interface, encapsulation or for the whole\n device) need only support the 'on', and 'off' values.", "readOnly": true }, "vlanTrunkPortDynamicStatus": { "type": "string", "description": "Indicates whether the specified interface is either\n acting as a trunk or not. This is a result of the\n vlanTrunkPortDynamicState and the ifOperStatus of the\n trunk port itself.", "readOnly": true }, "vlanTrunkPortVtpEnabled": { "type": "boolean", "description": "Some trunk interface modules allow VTP to be\n enabled/disabled seperately from that of the central\n device. In such a case this object provides management a\n way to remotely enable VTP on that module. If a module\n does not support a seperate VTP enabled state then this\n object shall always return 'true' and will accept no other\n value during a SET operation.", "readOnly": true }, "vlanTrunkPortEncapsulationOperType": { "type": "string", "description": "The type of VLAN encapsulation in use on this trunk port.\n For intefaces with vlanTrunkPortDynamicStatus of\n notTrunking(2) the vlanTrunkPortEncapsulationOperType shall\n be notApplicable(6).", "readOnly": true }, "vlanTrunkPortVlansEnabled2k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 1024 through 2047 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 1024 through 1031; the second\n octet to VLANs 1032 through 1039; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet. If the bit corresponding to a VLAN is set to\n '1', then the local system is enabled for sending and\n receiving frames on that VLAN; if the bit is set to '0',\n then the system is disabled from sending and receiving\n frames on that VLAN. The default value is zero length\n string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary", "readOnly": true }, "vlanTrunkPortVlansEnabled3k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 2048 through 3071 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 2048 through 2055; the second\n octet to VLANs 2056 through 2063; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet. If the bit corresponding to a VLAN is set to\n '1', then the local system is enabled for sending and\n receiving frames on that VLAN; if the bit is set to '0',\n then the system is disabled from sending and receiving\n frames on that VLAN. The default value is zero length\n string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary", "readOnly": true }, "vlanTrunkPortVlansEnabled4k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 3072 through 4095 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 3072 through 3079; the second\n octet to VLANs 3080 through 3087; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet. If the bit corresponding to a VLAN is set to\n '1', then the local system is enabled for sending and\n receiving frames on that VLAN; if the bit is set to '0',\n then the system is disabled from sending and receiving\n frames on that VLAN. The default value is zero length\n string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary", "readOnly": true }, "vtpVlansPruningEligible2k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 1024 through 2047 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 1024 through 1031; the second\n octet to VLANs 1032 through 1039; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local system is permitted to prune that VLAN on this trunk\n port; if the bit is set to '0', then the system must not\n prune that VLAN on this trunk port.\n The default value is zero length string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary", "readOnly": true }, "vtpVlansPruningEligible3k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 2048 through 3071 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 2048 through 2055; the second\n octet to VLANs 2056 through 2063; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local system is permitted to prune that VLAN on this trunk\n port; if the bit is set to '0', then the system must not\n prune that VLAN on this trunk port.\n The default value is zero length string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary", "readOnly": true }, "vtpVlansPruningEligible4k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 3072 through 4095 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 3072 through 3079; the second\n octet to VLANs 3080 through 3087; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local system is permitted to prune that VLAN on this trunk\n port; if the bit is set to '0', then the system must not\n prune that VLAN on this trunk port.\n The default value is zero length string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary", "readOnly": true }, "vlanTrunkPortVlansXmitJoined2k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 1024 through 2047 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 1024 through 1031; the second\n octet to VLANs 1032 through 1039; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then this\n VLAN is presently being forwarded on this trunk port, i.e.,\n it is not pruned; if the bit is set to '0', then this VLAN\n is presently not being forwarded on this trunk port, either\n because it is pruned or for some other reason.", "format": "binary", "readOnly": true }, "vlanTrunkPortVlansXmitJoined3k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 2048 through 3071 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 2048 through 2055; the second\n octet to VLANs 2056 through 2063; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then this\n VLAN is presently being forwarded on this trunk port, i.e.,\n it is not pruned; if the bit is set to '0', then this VLAN\n is presently not being forwarded on this trunk port, either\n because it is pruned or for some other reason.", "format": "binary", "readOnly": true }, "vlanTrunkPortVlansXmitJoined4k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 3072 through 4095 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 3072 through 3079; the second\n octet to VLANs 3080 through 3087; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then this\n VLAN is presently being forwarded on this trunk port, i.e.,\n it is not pruned; if the bit is set to '0', then this VLAN\n is presently not being forwarded on this trunk port, either\n because it is pruned or for some other reason.", "format": "binary", "readOnly": true }, "vlanTrunkPortVlansRcvJoined2k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 1024 through 2047 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 1024 through 1031; the second\n octet to VLANs 1032 through 1039; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local switch is currently sending joins for this VLAN on\n this trunk port, i.e., it is asking to receive frames for\n this VLAN; if the bit is set to '0', then the local switch\n is not currently sending joins for this VLAN on this trunk\n port.", "format": "binary", "readOnly": true }, "vlanTrunkPortVlansRcvJoined3k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 2048 through 3071 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 2048 through 2055; the second\n octet to VLANs 2056 through 2063; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local switch is currently sending joins for this VLAN on\n this trunk port, i.e., it is asking to receive frames for\n this VLAN; if the bit is set to '0', then the local switch\n is not currently sending joins for this VLAN on this trunk\n port.", "format": "binary", "readOnly": true }, "vlanTrunkPortVlansRcvJoined4k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 3072 through 4095 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 3072 through 3079; the second\n octet to VLANs 3080 through 3087; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local switch is currently sending joins for this VLAN on\n this trunk port, i.e., it is asking to receive frames for\n this VLAN; if the bit is set to '0', then the local switch\n is not currently sending joins for this VLAN on this trunk\n port.", "format": "binary", "readOnly": true }, "vlanTrunkPortDot1qTunnel": { "type": "string", "description": "Indicates dot1qtunnel mode of the port.\n \n If the portDot1qTunnel is set to 'trunk' mode, the port's\n vlanTrunkPortDynamicState will be changed to 'onNoNegotiate'\n and the vlanTrunkPortEncapsulationType will be set to\n 'dot1Q'. These values cannot be changed unless dot1q tunnel\n is disabled on this port.\n \n If the portDot1qTunnel mode is set to 'access' mode, the\n port's vlanTrunkPortDynamicState will be set to 'off'.And\n the value of vlanTrunkPortDynamicState cannot be changed\n unless dot1q tunnel is disabled on this port. 1Q packets\n received on this access port will remain.\n \n Setting the port to dot1q tunnel 'disabled' mode causes the\n dot1q tunnel feature to be disabled on this port. This\n object can't be set to 'trunk' or 'access' mode, when\n vlanTrunkPortsDot1qTag object is set to 'false'.\n \n This object has been deprecated and is replaced by the\n object 'cltcDot1qTunnelMode' in the\n CISCO-L2-TUNNEL-CONFIG-MIB", "readOnly": true }, "vlanTrunkPortVlansActiveFirst2k": { "type": "string", "description": "A string of octets containing one bit per VLAN\n with VlanIndex values of 0 through 2047.\n \n If the bit corresponding to a VLAN is set to 1,\n it indicates that vlan is allowed and active in\n management domain.\n \n If the bit corresponding to a VLAN is set to 0,\n it indicates that vlan is not allowed or not active\n in management domain.", "x-yang-type": "cisco-tc:Cisco2KVlanList", "readOnly": true }, "vlanTrunkPortVlansActiveSecond2k": { "type": "string", "description": "A string of octets containing one bit per VLAN\n with VlanIndex values of 2048 through 4095.\n \n If the bit corresponding to a VLAN is set to 1,\n it indicates that vlan is allowed and active in\n management domain.\n \n If the bit corresponding to a VLAN is set to 0,\n it indicates that vlan is not allowed or not active\n in management domain.", "x-yang-type": "cisco-tc:Cisco2KVlanList", "readOnly": true } } }, "readOnly": true }, "vtpDiscoverEntry": { "type": "array", "description": "Information related to the discovery of the\n VTP members in one management domain.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref", "readOnly": true }, "vtpDiscoverAction": { "type": "string", "description": "When this object is set to discover(1), all the\n entries in vtpDiscoverResultTable for the\n corresponding management domain will be removed \n and the local device will begin to discover all\n VTP members in the management domain. Upon the\n successful completion of discovery, the discovered\n result will be stored in the vtpDiscoverResultTable.\n \n If vtpDiscoverStatus is inProgress(1), setting \n vtpDiscoverAction to discover(1) will fail. \n \n When this object is set to purgeResult(3), \n all the entries of vtpDiscoverResultTable for \n the corresponding management domain will be\n removed from vtpDiscoverResultTable.\n \n When this object is set to noOperation(2), no\n action will be taken. When read, this object\n always returns noOperation(2).", "readOnly": true }, "vtpDiscoverStatus": { "type": "string", "description": "The current status of VTP discovery.\n \n inProgress - a discovery is in progress;\n \n succeeded - the discovery was completed successfully\n (this value is also used when \n no discover has been invoked since the\n last time the local system restarted);\n \n resourceUnavailable - the discovery failed because\n the required allocation of a resource is\n presently unavailable.\n \n someOtherError - 'the discovery failed due to a\n reason no listed.", "readOnly": true }, "vtpLastDiscoverTime": { "type": "string", "description": "The value of sysUpTime at which the last discovery\n was completed.\n \n A value of zero indicates that no discovery has been\n invoked since last time the local system restarted.", "x-yang-type": "yang:timestamp", "readOnly": true } } }, "readOnly": true }, "vtpDiscoverResultEntry": { "type": "array", "description": "A conceptual row is created for each VTP member which\n is found through successful discovery.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref", "readOnly": true }, "vtpDiscoverResultIndex": { "type": "integer", "description": "A value assigned by the system which identifies\n a VTP member and the associated database in the \n management domain.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "vtpDiscoverResultDatabaseName": { "type": "string", "description": "The database name associated with the\n discovered VTP member.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "vtpDiscoverResultConflicting": { "type": "boolean", "description": "Indicates whether this VTP member contains\n conflicting information.\n \n true(1) indicates that this member has conflicting \n information of the database type in the management domain.\n \n false(2) indicates that there is no conflicting information\n of the database type in the management domain.", "readOnly": true }, "vtpDiscoverResultDeviceId": { "type": "string", "description": "The unique identifier of the device for this VTP member.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "vtpDiscoverResultPrimaryServer": { "type": "string", "description": "The unique identifier of the primary server for this VTP\n member and the associated database type.\n \n There are two different VTP servers, the primary server\n and the secondary server. When a local device is\n configured as a server for a certain database type,\n it becomes secondary server by default. \n Primary server is an operational role under which a\n server can initiate or change the VTP configuration of the\n database type.\n \n If this VTP member itself is the primary server, the \n value of this object is the same as the value of \n vtpDiscoverResultDeviceId of the instance.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "vtpDiscoverResultRevNumber": { "type": "integer", "description": "The current configuration revision number as known by the\n VTP member. When the database type is unknown for\n the VTP member, this value is 0.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "vtpDiscoverResultSystemName": { "type": "string", "description": "sysName of the VTP member.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true } } }, "readOnly": true }, "vtpDatabaseEntry": { "type": "array", "description": "Information about the status of the VTP database\n in the domain. Each VTP database type known to the\n local device type has an entry in this table.\n An entry is also created for unknown database which is\n notified through VTP advertisements from other VTP\n servers.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref", "readOnly": true }, "vtpDatabaseIndex": { "type": "integer", "description": "A value assigned by the system which uniquely identifies\n a VTP database in the local system.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "vtpDatabaseName": { "type": "string", "description": "The name of the database.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "vtpDatabaseLocalMode": { "type": "string", "description": "The local VTP mode for a particular database type\n in this administrative domain.\n \n - 'client' indicates that the local system is acting\n as a VTP client of the database type.\n \n - 'server' indicates that the local system is acting\n as a VTP server of the database type.\n \n - 'transparent' indicates that the local system does\n not generate or listen to VTP messages of this \n database type, but forwards\n messages. This mode can also be set by the device\n itself when the size of database is too large for it\n to hold in DRAM.\n \n - 'off' indicates that the local system does not\n generate, listen to or forward any VTP messages\n of this database type.\n \n The default mode is 'client' for the database type \n known to the local device and 'transparent' for the\n unknown database type.", "readOnly": true }, "vtpDatabaseRevNumber": { "type": "integer", "description": "The current configuration revision number as known by the\n local device for this VTP 3 database type in the management\n domain. This value is updated (if necessary) whenever a \n VTP advertisement for the database type is received \n or generated. When the database type is unknown to the \n local device or no VTP advertisement for the database\n type is received or generated, its value is 0.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "vtpDatabasePrimaryServer": { "type": "boolean", "description": "There are two kinds of VTP version 3 servers for a certain\n database type - the primary server and the secondary server.\n When a local device is configured as a server for a certain\n database type, it becomes secondary server by default.\n Primary server is an operational role under which a\n server can initiate or change the VTP configuration of the\n database type.\n \n A true(1) value indicates that the local device is the \n primary server of the database type in the management\n domain. A false(2) value indicates that the local device\n is not the primary server, or the database type is unknown\n to the local device.", "readOnly": true }, "vtpDatabasePrimaryServerId": { "type": "string", "description": "The unique identifier of the primary server in the\n management domain for the database type. \n \n If no primary server is discovered for the database\n type, the object has a value of zero length string.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "vtpDatabaseTakeOverPrimary": { "type": "boolean", "description": "There are two kinds of VTP version 3 servers for a certain\n database type - the primary server and the secondary server.\n When a local device is configured as a server for a certain\n database type, it becomes secondary server by default.\n Primary server is an operational role under which a\n server can initiate or change the VTP configuration of the\n database type.\n \n Setting this object to a true(1) value will advertise the\n configuration of this database type to the whole domain.\n \n In order to successfully setting this object to true(1),\n the value of vtpDatabaseLocalMode must be server(2). Besides\n that, when the VTP password is hidden from the configuration\n file, the password (vtpDatabaseTakeOverPassword) which \n matches the secret key (vtpAuthSecretKey) must be provided\n in the same data packet. \n \n When read, the object always returns false(2).", "readOnly": true }, "vtpDatabaseTakeOverPassword": { "type": "string", "description": "When read, this object always returns the value of a\n zero-length octet string.\n \n In the case that the VTP password is hidden from the \n configuration and the local device intends\n to take over the whole domain, this object must be \n set to the matching password with the secret key \n (vtpAuthSecretKey) in the same data packet as which \n the vtpDatabaseTakeOverPrimary is in. In all the \n other situations, setting a valid value to this object \n has no impact on the system.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true } } }, "readOnly": true }, "vtpAuthEntry": { "type": "array", "description": "Information about the status of the VTP\n authentication information in one domain.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref", "readOnly": true }, "vtpAuthPassword": { "type": "string", "description": "By default, this object has a value of a zero-length\n character string and is considered to be not\n configured.\n \n The device uses the password to generate the \n secret key. It can be stored in the configuration in \n plain text or hidden from the configuration. If a VTP \n server intends to modify the database's configuration\n in the domain but the password was hidden from the\n configuration, the same password\n (vtpDatabaseTakeOverPassword) as the hidden one\n has to be provided.\n \n When this object is set alone, vtpAuthPasswordType is\n set to plaintext(1) automatically by the system.\n Setting this object to a zero length character string\n resets the password to its default value and the\n password is considered as not configured.\n \n This object is not allowed to be set at the same time\n when vtpAuthSecretKey is set.\n \n When the vtpAuthPasswordType is hidden(2), this object \n will return a zero-length character string when read.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "vtpAuthPasswordType": { "type": "string", "description": "By default this object has the value as plaintext(1)\n and the VTP password is stored in the configuration\n file in plain text.\n \n Setting this object to hidden(2) will hide the\n password from the configuration.\n \n Once this object is set to hidden(2), it cannot\n be set to plaintext(1) alone. However, it may\n be set to plaintext(1) at the same time the\n password is set.", "readOnly": true }, "vtpAuthSecretKey": { "type": "string", "description": "The device creating or modifying the VTP configuration\n signs it using the MD5 digest generated from the secret\n key before advertising it. Other devices in the domain\n receiving this configuration use the same secret key\n to accept it if it was correctly signed or drop it \n otherwise.\n \n By default, the object has the value as a zero-length\n string and this value is read only. It is set \n to this value automatically when the password \n (vtpAuthPassword) is set to a zero-length octet string.\n \n The secret key can be either generated using\n the password or configured by the user. Once\n the secret key is configured by the user, it is\n stored as a hexadecimal string in the device's\n configuration and the password is considered to be\n the secret key's matching password and hidden\n from the configuration automatically.\n \n This object is not allowed to be set at the same\n time when vtpAuthPassword is set.\n \n The secret key is overwritten by a newly generated\n secret key when the password is re-configured.", "format": "binary", "readOnly": true } } }, "readOnly": true }, "vtpStatus": { "type": "object", "description": "vtpStatus", "properties": { "vtpVersion": { "type": "string", "description": "The version of VTP in use on the local system. A device\n will report its version capability and not any particular\n version in use on the device. If the device does not support\n vtp, the version is none(3).", "readOnly": true }, "vtpMaxVlanStorage": { "type": "integer", "description": "An estimate of the maximum number of VLANs about which the\n local system can recover complete VTP information after a\n reboot. If the number of defined VLANs is greater than this\n value, then the system can not act as a VTP Server. For a\n device which has no means to calculate the estimated number,\n this value is -1.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "vtpNotificationsEnabled": { "type": "boolean", "description": "An indication of whether the notifications/traps defined by\n the vtpConfigNotificationsGroup, vtpConfigNotificationsGroup2,\n and vtpConfigNotificationsGroup8 are enabled.", "readOnly": true }, "vtpVlanCreatedNotifEnabled": { "type": "boolean", "description": "An indication of whether the notification should\n be generated when a VLAN is created. \n \n If the value of this object is 'true' then the\n vtpVlanCreated notification will be generated.\n \n If the value of this object is 'false' then the\n vtpVlanCreated notification will not be generated.", "readOnly": true }, "vtpVlanDeletedNotifEnabled": { "type": "boolean", "description": "An indication of whether the notification should\n be generated when a VLAN is deleted. \n \n If the value of this object is 'true' then the\n vtpVlanDeleted notification will be generated.\n \n If the value of this object is 'false' then the\n vtpVlanDeleted notification will not be generated.", "readOnly": true } }, "readOnly": true }, "internalVlanInfo": { "type": "object", "description": "internalVlanInfo", "properties": { "vtpInternalVlanAllocPolicy": { "type": "string", "description": "The internal VLAN allocation policy.\n \n 'ascending' - internal VLANs are allocated\n starting from a lowwer VLAN ID and \n upwards.\n 'descending' - internal VLANs are allocated\n starting from a higher VLAN ID and\n downwards.", "readOnly": true } }, "readOnly": true }, "vlanTrunkPorts": { "type": "object", "description": "An advisory lock used to allow several cooperating SNMPv2\n managers to coordinate their use of the SNMPv2 set operation\n acting upon any instance of vlanTrunkPortVlansEnabled.", "properties": { "vlanTrunkPortSetSerialNo": { "type": "string", "description": "An advisory lock used to allow several cooperating SNMPv2\n managers to coordinate their use of the SNMPv2 set operation\n acting upon any instance of vlanTrunkPortVlansEnabled.", "x-yang-type": "snmpv2-tc:TestAndIncr", "readOnly": true }, "vlanTrunkPortsDot1qTag": { "type": "boolean", "description": "An indication of whether the tagging on all VLANs including\n native VLAN for all 802.1q trunks is enabled.\n \n If this object has a value of true(1) then all VLANs\n including native VLAN are tagged. If the value is false(2)\n then all VLANs excluding native VLAN are tagged.\n \n This object has been deprecated and is replaced by the\n object 'cltcDot1qAllTaggedEnabled' in the\n CISCO-L2-TUNNEL-CONFIG-MIB", "readOnly": true } }, "readOnly": true }, "vlanStatistics": { "type": "object", "description": "This object indicates the number of the existing\n manageable VLANs with VLAN indices from 1 to\n 1024 in the system.", "properties": { "vlanStatsVlans": { "type": "integer", "description": "This object indicates the number of the existing\n manageable VLANs with VLAN indices from 1 to\n 1024 in the system.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "vlanStatsExtendedVlans": { "type": "integer", "description": "This object indicates the number of the\n existing manageable VLANs with VLAN indices\n greater than 1024 in the system.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "vlanStatsInternalVlans": { "type": "integer", "description": "This object indicates the number of the\n internal VLANs existing in the system.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "vlanStatsFreeVlans": { "type": "integer", "description": "This object indicates the number of the\n free or unused VLANs in the system.", "minimum": 0, "maximum": 4294967295, "readOnly": true } }, "readOnly": true }, "managementDomainTable": { "type": "object", "description": "managementDomainTable", "properties": { "managementDomainEntry": { "type": "array", "description": "Information about the status of one management domain.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "An arbitrary value to uniquely identify the management\n domain on the local system.", "x-yang-type": "CISCO-VTP-MIB:ManagementDomainIndex", "readOnly": true }, "managementDomainName": { "type": "string", "description": "The management name of a domain in which the local system\n is participating. The zero-length name corresponds to the\n 'no management-domain' state which is the initial value at\n installation-time if not configured otherwise. Note that\n the zero-length name does not correspond to an operational\n management domain, and a device does not send VTP\n advertisements while in the 'no management-domain' state. A\n device leaves the 'no management-domain' state when it\n obtains a management-domain name, either through\n configuration or through inheriting the management-domain\n name from a received VTP advertisement.\n \n When the value of an existing instance of this object is\n modified by network management, the local system should re-\n initialize its VLAN information (for the given management\n domain) as if it had just been configured with a management\n domain name at installation time.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "managementDomainLocalMode": { "type": "string", "description": "The local VTP mode in this management domain when\n managementDomainVersionInUse is version1(1) or\n version2(2).\n \n If managementDomainVersionInUse is version3(4), this \n object has the same value with vtpDatabaseLocalMode \n of VLAN database type.\n \n - 'client' indicates that the local system is acting\n as a VTP client.\n \n - 'server' indicates that the local system is acting\n as a VTP server.\n \n - 'transparent' indicates that the local system does\n not generate or listen to VTP messages, but forwards\n messages. This mode can also be set by the device\n itself when the amount of VLAN information is too\n large for it to hold in DRAM.\n \n - 'off' indicates that the local system does not\n generate, listen to or forward any VTP messages.", "readOnly": true }, "managementDomainConfigRevNumber": { "type": "integer", "description": "The current Configuration Revision Number as known by\n the local device for this management domain when \n managementDomainVersionInUse is version1(1) or \n version2(2).\n \n If managementDomainVersionInUse is version3(4), this \n object has the same value with vtpDatabaseRevisionNumber \n of VLAN database type.\n \n This value is updated (if necessary) whenever a VTP\n advertisement is received or generated. When in the\n 'no management-domain' state, this value is 0.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "managementDomainLastUpdater": { "type": "string", "description": "The IP-address (or one of them) of the VTP Server which\n last updated the Configuration Revision Number, as indicated\n in the most recently received VTP advertisement for this\n management domain, when managementDomainVersionInUse is\n version1(1) or version2(2). \n \n If managementDomainVersionInUse is version3(4), this object\n has the value of 0.0.0.0.\n \n Before an advertisement has been received, this value is\n 0.0.0.0.", "format": "inet:ipv4-address", "readOnly": true }, "managementDomainLastChange": { "type": "string", "description": "The time at which the Configuration Revision Number was\n (last) increased to its current value, as indicated in the\n most recently received VTP advertisement for this management\n domain when managementDomainVersionInUse is not version3(4)\n or in the most recently received VTP VLAN database \n advertisement for this management domain when \n managementDomainVersionInUse is version3(4).\n \n The value 0x0000010100000000 indicates that the device which\n last increased the Configuration Revision Number had no idea\n of the date/time, or that no advertisement has been\n received.", "x-yang-type": "snmpv2-tc:DateAndTime", "readOnly": true }, "managementDomainRowStatus": { "type": "string", "description": "The status of this conceptual row.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "managementDomainTftpServer": { "type": "string", "description": "The IP address of a TFTP Server in/from which VTP VLAN\n information for this management domain is to be\n stored/retrieved. If the information is being locally\n stored in NVRAM, this object should take the value 0.0.0.0.", "format": "inet:ipv4-address", "readOnly": true }, "managementDomainTftpPathname": { "type": "string", "description": "The complete pathname of the file at the TFTP Server\n identified by the value of managementDomainTftpServer\n in/from which VTP VLAN information for this management\n domain is to be stored/retrieved. If the value of\n corresponding instance of managementDomainTftpServer is\n 0.0.0.0, the value of this object is ignored.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "managementDomainPruningState": { "type": "string", "description": "An indication of whether VTP pruning is enabled or disabled\n in this managament domain. \n \n This object can only be modified, either when the \n corresponding instance value of managementDomainVersionInUse \n is 'version1' or 'version2' and the corresponding instance \n value of managementDomainLocalMode is 'server', or when the \n corresponding instance value of managementDomainVersionInUse \n is 'version3' and the corresponding instance value of \n managementDomainLocalMode is 'server' or 'client'.", "readOnly": true }, "managementDomainVersionInUse": { "type": "string", "description": "The current version of the VTP that is in use by the\n designated management domain. \n \n This object can be set to none(3) only when \n vtpVersion is none(3).", "readOnly": true }, "managementDomainPruningStateOper": { "type": "string", "description": "Indicates whether VTP pruning is operationally enabled or\n disabled in this managament domain.", "readOnly": true }, "managementDomainAdminSrcIf": { "type": "string", "description": "The object specifies the interface to be used as the\n preferred source interface for the VTP IP updater address.\n \n A zero length value indicates that a source interface is not\n specified.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "managementDomainSourceOnlyMode": { "type": "boolean", "description": "The object specifies whether to use only the IP address of\n managementDomainAdminSrcIf as the VTP IP updater address. \n \n 'true' indicates to only use the IP address of \n managementDomainAdminSrcIf as the VTP IP \n updater address. \n \n 'false' indicates to use the IP address of \n managementDomainAdminSrcIf as the VTP IP \n updater address if managementDomainAdminSrcIf \n is configured with an IP address. Otherwise, the \n first available IP address of the system will\n be used.", "readOnly": true }, "managementDomainOperSrcIf": { "type": "string", "description": "The object indicates the interface used as the\n preferred source interface for the VTP IP updater address.\n \n A zero length string indicates that a source interface is not\n available.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "managementDomainConfigFile": { "type": "string", "description": "The object specifies the file name where VTP configuration\n is stored in the format of or :[].\n \n can be (but not limited to): flash, bootflash,\n slot0, slot1, disk0.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "managementDomainLocalUpdaterType": { "type": "string", "description": "The object indicates the type of the Internet address\n of the preferred source interface for the VTP IP updater.\n \n The value of this object is 'unknown' if\n managementDomainVersionInUse is 'version3' or\n managementDomainLocalMode is not 'server'.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "managementDomainLocalUpdater": { "type": "string", "description": "The object indicates the Internet address of the\n preferred source interface for the VTP IP updater.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "managementDomainDeviceID": { "type": "string", "description": "The object indicates a value that uniquely identifies\n this device within a VTP Domain.\n \n The value of this object is zero length string if\n managementDomainVersionInUse is not 'version3'.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "vtpVlanTable": { "type": "object", "description": "This table contains information on the VLANs which\n currently exist.", "properties": { "vtpVlanEntry": { "type": "array", "description": "Information about one current VLAN. The\n managementDomainIndex value in the INDEX clause indicates\n which management domain the VLAN is in.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref", "readOnly": true }, "vtpVlanIndex": { "type": "string", "description": "The VLAN-id of this VLAN on ISL or 802.1q trunks.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex", "readOnly": true }, "vtpVlanState": { "type": "string", "description": "The state of this VLAN.\n \n The state 'mtuTooBigForDevice' indicates that this device\n cannot participate in this VLAN because the VLAN's MTU is\n larger than the device can support.\n \n The state 'mtuTooBigForTrunk' indicates that while this\n VLAN's MTU is supported by this device, it is too large for\n one or more of the device's trunk ports.", "readOnly": true }, "vtpVlanType": { "type": "string", "description": "The type of this VLAN.", "x-yang-type": "CISCO-VTP-MIB:VlanType", "readOnly": true }, "vtpVlanName": { "type": "string", "description": "The name of this VLAN. This name is used as the ELAN-name\n for an ATM LAN-Emulation segment of this VLAN.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "vtpVlanMtu": { "type": "integer", "description": "The MTU size on this VLAN, defined as the size of largest\n MAC-layer (information field portion of the) data frame\n which can be transmitted on the VLAN.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "vtpVlanDot10Said": { "type": "string", "description": "The value of the 802.10 SAID field for this VLAN.", "format": "binary", "readOnly": true }, "vtpVlanRingNumber": { "type": "integer", "description": "The ring number of this VLAN. This object is only\n instantiated when the value of the corresponding instance of\n vtpVlanType has a value of 'fddi' or 'tokenRing' and Source\n Routing is in use on this VLAN.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "vtpVlanBridgeNumber": { "type": "integer", "description": "The bridge number of the VTP-capable switches for this\n VLAN. This object is only instantiated for VLANs that are\n involved with emulating token ring segments.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "vtpVlanStpType": { "type": "string", "description": "The type of the Spanning Tree Protocol (STP) running on\n this VLAN. This object is only instanciated when the\n value of the corresponding instance of vtpVlanType has a\n value of 'fddiNet' or 'trNet'.\n \n The value returned by this object depends upon the value\n of the corresponding instance of vtpVlanEditStpType.\n \n - 'ieee' indicates IEEE STP is running exclusively.\n \n - 'ibm' indicates IBM STP is running exclusively.\n \n - 'hybrid' indicates a STP that allows a combination of\n IEEE and IBM is running.\n \n The 'hybrid' STP type results from tokenRing/fddi VLANs\n that are children of this trNet/fddiNet parent VLAN being\n configured in a combination of SRT and SRB\n vtpVlanBridgeTypes while the instance of\n vtpVlanEditStpType that corresponds to this object is set\n to 'auto'.", "readOnly": true }, "vtpVlanParentVlan": { "type": "string", "description": "The parent VLAN for this VLAN. This object is only\n instantiated when the value of the corresponding instance of\n vtpVlanType has a value of 'fddi' or 'tokenRing' and Source\n Routing is in use on this VLAN. The parent VLAN must have \n a vtpVlanType value of fddiNet(4) or trNet(5), \n respectively.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex", "readOnly": true }, "vtpVlanTranslationalVlan1": { "type": "string", "description": "A VLAN to which this VLAN is being translational-bridged.\n If this value and the corresponding instance of\n vtpVlanTranslationalVlan2 are both zero, then this VLAN is\n not being translational-bridged.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex", "readOnly": true }, "vtpVlanTranslationalVlan2": { "type": "string", "description": "Another VLAN, i.e., other than that indicated by\n vtpVlanTranslationalVlan1, to which this VLAN is being\n translational-bridged. If this value and the corresponding\n instance of vtpVlanTranslationalVlan1 are both zero, then\n this VLAN is not being translational-bridged.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex", "readOnly": true }, "vtpVlanBridgeType": { "type": "string", "description": "The type of the Source Route bridging mode in use on this\n VLAN. This object is only instantiated when the value of \n the corresponding instance of vtpVlanType has a value of \n fddi(2) or tokenRing(3) and Source Routing is in use on\n this VLAN.", "readOnly": true }, "vtpVlanAreHopCount": { "type": "integer", "description": "The maximum number of bridge hops allowed in\n All Routes Explorer frames on this VLAN. This\n object is only instantiated when the value of the\n corresponding instance of vtpVlanType has a value of fddi(2)\n or tokenRing(3) and Source Routing is in use on this VLAN.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "vtpVlanSteHopCount": { "type": "integer", "description": "The maximum number of bridge hops allowed in\n Spanning Tree Explorer frames on this VLAN. This\n object is only instantiated when the value of the\n corresponding instance of vtpVlanType has a value of fddi(2)\n or tokenRing(3) and Source Routing is in use on this VLAN.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "vtpVlanIsCRFBackup": { "type": "boolean", "description": "True if this VLAN is of type trCrf and also is acting as\n a backup trCrf for the ISL distributed BRF", "readOnly": true }, "vtpVlanTypeExt": { "type": "string", "description": "The additional type information of this VLAN.", "x-yang-type": "CISCO-VTP-MIB:VlanTypeExt", "readOnly": true }, "vtpVlanIfIndex": { "type": "string", "description": "The value of the ifIndex corresponding to this VLAN ID.\n If the VLAN ID does not have its corresponding interface, \n this object has the value of zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "vtpInternalVlanTable": { "type": "object", "description": "A vtpInternalVlanTable entry contains\n information on an existing internal\n VLAN. It is internally created by the\n device for a specific application program \n and hence owned by the application. \n It cannot be modified or deleted by (local \n or network) management.", "properties": { "vtpInternalVlanEntry": { "type": "array", "description": "Information about one current internal\n VLAN.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref", "readOnly": true }, "vtpVlanIndex": { "type": "string", "description": "vtpVlanIndex", "x-yang-type": "leafref", "readOnly": true }, "vtpInternalVlanOwner": { "type": "string", "description": "The program name of the internal VLAN's\n owner application. This internal VLAN\n is allocated by the device specifically\n for this application and no one else\n could create, modify or delete this \n VLAN.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "vtpVlanEditTable": { "type": "object", "description": "vtpVlanEditTable", "properties": { "vtpVlanEditEntry": { "type": "array", "description": "Information about one VLAN in the Edit Buffer for a\n particular management domain.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref", "readOnly": true }, "vtpVlanEditIndex": { "type": "string", "description": "The VLAN-id which this VLAN would have on ISL or\n 802.1q trunks.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex", "readOnly": true }, "vtpVlanEditState": { "type": "string", "description": "The state which this VLAN would have.", "readOnly": true }, "vtpVlanEditType": { "type": "string", "description": "The type which this VLAN would have.\n An implementation may restrict access to this object.", "x-yang-type": "CISCO-VTP-MIB:VlanType", "readOnly": true }, "vtpVlanEditName": { "type": "string", "description": "The name which this VLAN would have. This name would be\n used as the ELAN-name for an ATM LAN-Emulation segment of\n this VLAN.\n \n An implementation may restrict access to this object.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "vtpVlanEditMtu": { "type": "integer", "description": "The MTU size which this VLAN would have, defined as the\n size of largest MAC-layer (information field portion of the)\n data frame which can be transmitted on the VLAN.\n \n An implementation may restrict access to this object.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "vtpVlanEditDot10Said": { "type": "string", "description": "The value of the 802.10 SAID field which would be used for\n this VLAN.\n \n An implementation may restrict access to this object.", "format": "binary", "readOnly": true }, "vtpVlanEditRingNumber": { "type": "integer", "description": "The ring number which would be used for this VLAN. This\n object is only instantiated when the value of the\n corresponding instance of vtpVlanEditType has a value of\n 'fddi' or 'tokenRing' and Source Routing is in use on \n this VLAN.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "vtpVlanEditBridgeNumber": { "type": "integer", "description": "The bridge number of the VTP-capable switches which would\n be used for this VLAN. This object is only instantiated\n when the value of the corresponding instance of\n vtpVlanEditType has a value of fddiNet(4) or trNet(5).", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "vtpVlanEditStpType": { "type": "string", "description": "The type of the Spanning Tree Protocol which would be\n running on this VLAN. This object is only instantiated\n when the value of the corresponding instance of\n vtpVlanEditType has a value of fddiNet(4) or trNet(5).\n \n If 'ieee' is selected, the STP that runs will be IEEE.\n \n If 'ibm' is selected, the STP that runs will be IBM.\n \n If 'auto' is selected, the STP that runs will be\n dependant on the values of vtpVlanEditBridgeType for all\n children tokenRing/fddi type VLANs. This will result in\n a 'hybrid' STP (see vtpVlanStpType).", "readOnly": true }, "vtpVlanEditParentVlan": { "type": "string", "description": "The VLAN index of the VLAN which would be the parent for\n this VLAN. This object is only instantiated when the value\n of the corresponding instance of vtpVlanEditType has a value\n of 'fddi' or 'tokenRing' and Source Routing is in use on\n this VLAN. The parent VLAN must have a vtpVlanEditType \n value of fddiNet(4) or trNet(5), respectively.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex", "readOnly": true }, "vtpVlanEditRowStatus": { "type": "string", "description": "The status of this row. Any and all columnar objects in an\n existing row can be modified irrespective of the status of\n the row.\n \n A row is not qualified for activation until instances of at\n least its vtpVlanEditType, vtpVlanEditName and\n vtpVlanEditDot10Said columns have appropriate values.\n \n The management station should endeavor to make all rows\n consistent in the table before 'apply'ing the buffer. An\n inconsistent entry in the table will cause the entire\n buffer to be rejected with the vtpVlanApplyStatus object\n set to the appropriate error value.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "vtpVlanEditTranslationalVlan1": { "type": "string", "description": "A VLAN to which this VLAN would be translational-bridged.\n If this value and the corresponding instance of\n vtpVlanTranslationalVlan2 are both zero, then this VLAN\n would not be translational-bridged.\n \n An implementation may restrict access to this object.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex", "readOnly": true }, "vtpVlanEditTranslationalVlan2": { "type": "string", "description": "Another VLAN, i.e., other than that indicated by\n vtpVlanEditTranslationalVlan1, to which this VLAN would be\n translational-bridged. If this value and the corresponding\n instance of vtpVlanTranslationalVlan1 are both zero, then\n this VLAN would not be translational-bridged.\n \n An implementation may restrict access to this object.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex", "readOnly": true }, "vtpVlanEditBridgeType": { "type": "string", "description": "The type of Source Route bridging mode which would be in\n use on this VLAN. This object is only instantiated when \n the value of the corresponding instance of vtpVlanEditType\n has a value of fddi(2) or tokenRing(3) and Source Routing \n is in use on this VLAN.", "readOnly": true }, "vtpVlanEditAreHopCount": { "type": "integer", "description": "The maximum number of bridge hops allowed in\n All Routes Explorer frames on this VLAN. This\n object is only instantiated when the value of the\n corresponding instance of vtpVlanType has a value of fddi(2)\n or tokenRing(3) and Source Routing is in use on this VLAN.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "vtpVlanEditSteHopCount": { "type": "integer", "description": "The maximum number of bridge hops allowed in\n Spanning Tree Explorer frames on this VLAN. This\n object is only instantiated when the value of the\n corresponding instance of vtpVlanType has a value of fddi(2)\n or tokenRing(3) and Source Routing is in use on this VLAN.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "vtpVlanEditIsCRFBackup": { "type": "boolean", "description": "True if this VLAN is of type trCrf and also is acting as\n a backup trCrf for the ISL distributed BRF. This object is\n only instantiated when the value of the corresponding\n instance of vtpVlanEditType has a value of tokenRing(3).", "readOnly": true }, "vtpVlanEditTypeExt": { "type": "string", "description": "The additional type information of this VLAN.\n vtpVlanEditTypeExt object is superseded by vtpVlanEditTypeExt2.", "x-yang-type": "CISCO-VTP-MIB:VlanTypeExt", "readOnly": true }, "vtpVlanEditTypeExt2": { "type": "string", "description": "The additional type information of this VLAN.\n The VlanTypeExt TC specifies which bits may\n be written by a management application.\n The agent should provide a default value.", "x-yang-type": "CISCO-VTP-MIB:VlanTypeExt", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "vtpVlanLocalShutdownTable": { "type": "object", "description": "Ths table contains the VLAN local shutdown\n information within management domain.", "properties": { "vtpVlanLocalShutdownEntry": { "type": "array", "description": "An entry containing VLAN local shutdown information for a\n particular VLAN in the management domain.\n \n An entry is created if a VLAN which supports local shutdown\n has been created.\n \n An entry is deleted if a VLAN which supports local shutdown\n has been removed.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref", "readOnly": true }, "vtpVlanIndex": { "type": "string", "description": "vtpVlanIndex", "x-yang-type": "leafref", "readOnly": true }, "vtpVlanLocalShutdown": { "type": "string", "description": "The object specifies the VLAN local shutdown state.", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "vlanTrunkPortTable": { "type": "object", "description": "The table containing information on the local system's VLAN\n trunk ports.", "properties": { "vlanTrunkPortEntry": { "type": "array", "description": "Information about one trunk port.", "items": { "type": "object", "properties": { "vlanTrunkPortIfIndex": { "type": "string", "description": "The value of ifIndex for the interface corresponding to\n this trunk port.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true }, "vlanTrunkPortManagementDomain": { "type": "string", "description": "The value of managementDomainIndex for the management\n domain on this trunk port. Devices which support only one\n management domain will support this object read-only.", "x-yang-type": "CISCO-VTP-MIB:ManagementDomainIndex", "readOnly": true }, "vlanTrunkPortEncapsulationType": { "type": "string", "description": "The type of VLAN encapsulation desired to be used on this\n trunk port. It is either a particular type, or 'negotiate'\n meaning whatever type results from the negotiation.\n negotiate(5) is not allowed if the port does not support\n negotiation or if its vlanTrunkPortDynamicState is set to\n on(1) or onNoNegotiate(5). Whether writing to this object\n in order to modify the encapsulation is supported is both\n device and interface specific.", "readOnly": true }, "vlanTrunkPortVlansEnabled": { "type": "string", "description": "A string of octets containing one bit per VLAN in the\n management domain on this trunk port. The first octet\n corresponds to VLANs with VlanIndex values of 0 through 7;\n the second octet to VLANs 8 through 15; etc. The most\n significant bit of each octet corresponds to the lowest\n value VlanIndex in that octet. If the bit corresponding to\n a VLAN is set to '1', then the local system is enabled for\n sending and receiving frames on that VLAN; if the bit is set\n to '0', then the system is disabled from sending and\n receiving frames on that VLAN.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary", "readOnly": true }, "vlanTrunkPortNativeVlan": { "type": "string", "description": "The VlanIndex of the VLAN which is represented by native\n frames on this trunk port. For trunk ports not supporting\n the sending and receiving of native frames, this value\n should be set to zero.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex", "readOnly": true }, "vlanTrunkPortRowStatus": { "type": "string", "description": "The status of this row. In some circumstances, the\n creation of a row in this table is needed to enable the\n appropriate trunking/tagging protocol on the port, to enable\n the use of VTP on the port, and to assign the port to the\n appropriate management domain. In other circumstances, rows\n in this table will be created as a by-product of other\n operations.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "vlanTrunkPortInJoins": { "type": "integer", "description": "The number of VTP Join messages received on this trunk\n port.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "vlanTrunkPortOutJoins": { "type": "integer", "description": "The number of VTP Join messages sent on this trunk port.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "vlanTrunkPortOldAdverts": { "type": "integer", "description": "The number of VTP Advertisement messages which indicated\n the sender does not support VLAN-pruning received on this\n trunk port.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "vlanTrunkPortVlansPruningEligible": { "type": "string", "description": "A string of octets containing one bit per VLAN in the\n management domain on this trunk port. The first octet\n corresponds to VLANs with VlanIndex values of 0 through 7;\n the second octet to VLANs 8 through 15; etc. The most\n significant bit of each octet corresponds to the lowest\n value VlanIndex in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local system is permitted to prune that VLAN on this trunk\n port; if the bit is set to '0', then the system must not\n prune that VLAN on this trunk port.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary", "readOnly": true }, "vlanTrunkPortVlansXmitJoined": { "type": "string", "description": "A string of octets containing one bit per VLAN in the\n management domain on this trunk port. The first octet\n corresponds to VLANs with VlanIndex values of 0 through 7;\n the second octet to VLANs 8 through 15; etc. The most\n significant bit of each octet corresponds to the lowest\n value VlanIndex in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then this\n VLAN is presently being forwarded on this trunk port, i.e.,\n it is not pruned; if the bit is set to '0', then this VLAN\n is presently not being forwarded on this trunk port, either\n because it is pruned or for some other reason.", "format": "binary", "readOnly": true }, "vlanTrunkPortVlansRcvJoined": { "type": "string", "description": "A string of octets containing one bit per VLAN in the\n management domain on this trunk port. The first octet\n corresponds to VLANs with VlanIndex values of 0 through 7;\n the second octet to VLANs 8 through 15; etc. The most\n significant bit of each octet corresponds to the lowest\n value VlanIndex in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local switch is currently sending joins for this VLAN on\n this trunk port, i.e., it is asking to receive frames for\n this VLAN; if the bit is set to '0', then the local switch\n is not currently sending joins for this VLAN on this trunk\n port.", "format": "binary", "readOnly": true }, "vlanTrunkPortDynamicState": { "type": "string", "description": "For devices that allows dynamic determination of whether\n a link between two switches should be a trunk or not, this\n object allows the operator to mandate the behavior of that\n dynamic mechanism.\n \n on(1) dictates that the interface will always be a\n trunk. This is the value for static entries (those that\n show no dynamic behavior). If the negotiation is supported\n on this port, negotiation will take place with the far end\n to attempt to bring the far end into trunking state.\n \n off(2) allows an operator to specify that the specified\n interface is never to be trunk, regardless of any dynamic\n mechanisms to the contrary. This value is useful for\n overriding the default behavior of some switches. If the\n negotiation is supported on this port, negotiation will take\n place with the far end to attempt on the link to bring the\n far end into non-trunking state.\n \n desirable(3) is used to indicate that it is desirable for\n the interface to become a trunk. The device will initiate\n any negotiation necessary to become a trunk but will not\n become a trunk unless it receives confirmation from the far\n end on the link.\n \n auto(4) is used to indicate that the interface is capable\n and willing to become a trunk but will not initiate\n trunking negotiations. The far end on the link are\n required to either start negotiations or start sending\n encapsulated packets, on which event the specified\n interface will become a trunk.\n \n onNoNegotiate(5) is used to indicate that the interface is\n permanently set to be a trunk, and no negotiation takes\n place with the far end on the link to ensure consistent\n operation. This is similar to on(1) except no negotiation\n takes place with the far end.\n \n If the port does not support negotiation or its\n vlanTrunkPortEncapsulationType is set to negotiate(5),\n onNoNegotiate(5) is not allowed.\n \n Devices that do no support dynamic determination (for just\n a particular interface, encapsulation or for the whole\n device) need only support the 'on', and 'off' values.", "readOnly": true }, "vlanTrunkPortDynamicStatus": { "type": "string", "description": "Indicates whether the specified interface is either\n acting as a trunk or not. This is a result of the\n vlanTrunkPortDynamicState and the ifOperStatus of the\n trunk port itself.", "readOnly": true }, "vlanTrunkPortVtpEnabled": { "type": "boolean", "description": "Some trunk interface modules allow VTP to be\n enabled/disabled seperately from that of the central\n device. In such a case this object provides management a\n way to remotely enable VTP on that module. If a module\n does not support a seperate VTP enabled state then this\n object shall always return 'true' and will accept no other\n value during a SET operation.", "readOnly": true }, "vlanTrunkPortEncapsulationOperType": { "type": "string", "description": "The type of VLAN encapsulation in use on this trunk port.\n For intefaces with vlanTrunkPortDynamicStatus of\n notTrunking(2) the vlanTrunkPortEncapsulationOperType shall\n be notApplicable(6).", "readOnly": true }, "vlanTrunkPortVlansEnabled2k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 1024 through 2047 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 1024 through 1031; the second\n octet to VLANs 1032 through 1039; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet. If the bit corresponding to a VLAN is set to\n '1', then the local system is enabled for sending and\n receiving frames on that VLAN; if the bit is set to '0',\n then the system is disabled from sending and receiving\n frames on that VLAN. The default value is zero length\n string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary", "readOnly": true }, "vlanTrunkPortVlansEnabled3k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 2048 through 3071 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 2048 through 2055; the second\n octet to VLANs 2056 through 2063; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet. If the bit corresponding to a VLAN is set to\n '1', then the local system is enabled for sending and\n receiving frames on that VLAN; if the bit is set to '0',\n then the system is disabled from sending and receiving\n frames on that VLAN. The default value is zero length\n string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary", "readOnly": true }, "vlanTrunkPortVlansEnabled4k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 3072 through 4095 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 3072 through 3079; the second\n octet to VLANs 3080 through 3087; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet. If the bit corresponding to a VLAN is set to\n '1', then the local system is enabled for sending and\n receiving frames on that VLAN; if the bit is set to '0',\n then the system is disabled from sending and receiving\n frames on that VLAN. The default value is zero length\n string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary", "readOnly": true }, "vtpVlansPruningEligible2k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 1024 through 2047 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 1024 through 1031; the second\n octet to VLANs 1032 through 1039; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local system is permitted to prune that VLAN on this trunk\n port; if the bit is set to '0', then the system must not\n prune that VLAN on this trunk port.\n The default value is zero length string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary", "readOnly": true }, "vtpVlansPruningEligible3k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 2048 through 3071 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 2048 through 2055; the second\n octet to VLANs 2056 through 2063; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local system is permitted to prune that VLAN on this trunk\n port; if the bit is set to '0', then the system must not\n prune that VLAN on this trunk port.\n The default value is zero length string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary", "readOnly": true }, "vtpVlansPruningEligible4k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 3072 through 4095 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 3072 through 3079; the second\n octet to VLANs 3080 through 3087; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local system is permitted to prune that VLAN on this trunk\n port; if the bit is set to '0', then the system must not\n prune that VLAN on this trunk port.\n The default value is zero length string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary", "readOnly": true }, "vlanTrunkPortVlansXmitJoined2k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 1024 through 2047 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 1024 through 1031; the second\n octet to VLANs 1032 through 1039; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then this\n VLAN is presently being forwarded on this trunk port, i.e.,\n it is not pruned; if the bit is set to '0', then this VLAN\n is presently not being forwarded on this trunk port, either\n because it is pruned or for some other reason.", "format": "binary", "readOnly": true }, "vlanTrunkPortVlansXmitJoined3k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 2048 through 3071 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 2048 through 2055; the second\n octet to VLANs 2056 through 2063; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then this\n VLAN is presently being forwarded on this trunk port, i.e.,\n it is not pruned; if the bit is set to '0', then this VLAN\n is presently not being forwarded on this trunk port, either\n because it is pruned or for some other reason.", "format": "binary", "readOnly": true }, "vlanTrunkPortVlansXmitJoined4k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 3072 through 4095 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 3072 through 3079; the second\n octet to VLANs 3080 through 3087; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then this\n VLAN is presently being forwarded on this trunk port, i.e.,\n it is not pruned; if the bit is set to '0', then this VLAN\n is presently not being forwarded on this trunk port, either\n because it is pruned or for some other reason.", "format": "binary", "readOnly": true }, "vlanTrunkPortVlansRcvJoined2k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 1024 through 2047 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 1024 through 1031; the second\n octet to VLANs 1032 through 1039; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local switch is currently sending joins for this VLAN on\n this trunk port, i.e., it is asking to receive frames for\n this VLAN; if the bit is set to '0', then the local switch\n is not currently sending joins for this VLAN on this trunk\n port.", "format": "binary", "readOnly": true }, "vlanTrunkPortVlansRcvJoined3k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 2048 through 3071 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 2048 through 2055; the second\n octet to VLANs 2056 through 2063; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local switch is currently sending joins for this VLAN on\n this trunk port, i.e., it is asking to receive frames for\n this VLAN; if the bit is set to '0', then the local switch\n is not currently sending joins for this VLAN on this trunk\n port.", "format": "binary", "readOnly": true }, "vlanTrunkPortVlansRcvJoined4k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 3072 through 4095 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 3072 through 3079; the second\n octet to VLANs 3080 through 3087; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local switch is currently sending joins for this VLAN on\n this trunk port, i.e., it is asking to receive frames for\n this VLAN; if the bit is set to '0', then the local switch\n is not currently sending joins for this VLAN on this trunk\n port.", "format": "binary", "readOnly": true }, "vlanTrunkPortDot1qTunnel": { "type": "string", "description": "Indicates dot1qtunnel mode of the port.\n \n If the portDot1qTunnel is set to 'trunk' mode, the port's\n vlanTrunkPortDynamicState will be changed to 'onNoNegotiate'\n and the vlanTrunkPortEncapsulationType will be set to\n 'dot1Q'. These values cannot be changed unless dot1q tunnel\n is disabled on this port.\n \n If the portDot1qTunnel mode is set to 'access' mode, the\n port's vlanTrunkPortDynamicState will be set to 'off'.And\n the value of vlanTrunkPortDynamicState cannot be changed\n unless dot1q tunnel is disabled on this port. 1Q packets\n received on this access port will remain.\n \n Setting the port to dot1q tunnel 'disabled' mode causes the\n dot1q tunnel feature to be disabled on this port. This\n object can't be set to 'trunk' or 'access' mode, when\n vlanTrunkPortsDot1qTag object is set to 'false'.\n \n This object has been deprecated and is replaced by the\n object 'cltcDot1qTunnelMode' in the\n CISCO-L2-TUNNEL-CONFIG-MIB", "readOnly": true }, "vlanTrunkPortVlansActiveFirst2k": { "type": "string", "description": "A string of octets containing one bit per VLAN\n with VlanIndex values of 0 through 2047.\n \n If the bit corresponding to a VLAN is set to 1,\n it indicates that vlan is allowed and active in\n management domain.\n \n If the bit corresponding to a VLAN is set to 0,\n it indicates that vlan is not allowed or not active\n in management domain.", "x-yang-type": "cisco-tc:Cisco2KVlanList", "readOnly": true }, "vlanTrunkPortVlansActiveSecond2k": { "type": "string", "description": "A string of octets containing one bit per VLAN\n with VlanIndex values of 2048 through 4095.\n \n If the bit corresponding to a VLAN is set to 1,\n it indicates that vlan is allowed and active in\n management domain.\n \n If the bit corresponding to a VLAN is set to 0,\n it indicates that vlan is not allowed or not active\n in management domain.", "x-yang-type": "cisco-tc:Cisco2KVlanList", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "vtpDiscoverTable": { "type": "object", "description": "This table contains information related to the discovery\n of the VTP members in the designated management\n domain. This table is not instantiated when \n managementDomainVersionInUse is version1(1), version2(3)\n or none(3).", "properties": { "vtpDiscoverEntry": { "type": "array", "description": "Information related to the discovery of the\n VTP members in one management domain.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref", "readOnly": true }, "vtpDiscoverAction": { "type": "string", "description": "When this object is set to discover(1), all the\n entries in vtpDiscoverResultTable for the\n corresponding management domain will be removed \n and the local device will begin to discover all\n VTP members in the management domain. Upon the\n successful completion of discovery, the discovered\n result will be stored in the vtpDiscoverResultTable.\n \n If vtpDiscoverStatus is inProgress(1), setting \n vtpDiscoverAction to discover(1) will fail. \n \n When this object is set to purgeResult(3), \n all the entries of vtpDiscoverResultTable for \n the corresponding management domain will be\n removed from vtpDiscoverResultTable.\n \n When this object is set to noOperation(2), no\n action will be taken. When read, this object\n always returns noOperation(2).", "readOnly": true }, "vtpDiscoverStatus": { "type": "string", "description": "The current status of VTP discovery.\n \n inProgress - a discovery is in progress;\n \n succeeded - the discovery was completed successfully\n (this value is also used when \n no discover has been invoked since the\n last time the local system restarted);\n \n resourceUnavailable - the discovery failed because\n the required allocation of a resource is\n presently unavailable.\n \n someOtherError - 'the discovery failed due to a\n reason no listed.", "readOnly": true }, "vtpLastDiscoverTime": { "type": "string", "description": "The value of sysUpTime at which the last discovery\n was completed.\n \n A value of zero indicates that no discovery has been\n invoked since last time the local system restarted.", "x-yang-type": "yang:timestamp", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "vtpDiscoverResultTable": { "type": "object", "description": "The table containing information of discovered VTP members\n in the management domain in which the local system is\n participating. This table is not instantiated when \n managementDomainVersionInUse is version1(1), version2(2) or\n none(3).", "properties": { "vtpDiscoverResultEntry": { "type": "array", "description": "A conceptual row is created for each VTP member which\n is found through successful discovery.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref", "readOnly": true }, "vtpDiscoverResultIndex": { "type": "integer", "description": "A value assigned by the system which identifies\n a VTP member and the associated database in the \n management domain.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "vtpDiscoverResultDatabaseName": { "type": "string", "description": "The database name associated with the\n discovered VTP member.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "vtpDiscoverResultConflicting": { "type": "boolean", "description": "Indicates whether this VTP member contains\n conflicting information.\n \n true(1) indicates that this member has conflicting \n information of the database type in the management domain.\n \n false(2) indicates that there is no conflicting information\n of the database type in the management domain.", "readOnly": true }, "vtpDiscoverResultDeviceId": { "type": "string", "description": "The unique identifier of the device for this VTP member.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "vtpDiscoverResultPrimaryServer": { "type": "string", "description": "The unique identifier of the primary server for this VTP\n member and the associated database type.\n \n There are two different VTP servers, the primary server\n and the secondary server. When a local device is\n configured as a server for a certain database type,\n it becomes secondary server by default. \n Primary server is an operational role under which a\n server can initiate or change the VTP configuration of the\n database type.\n \n If this VTP member itself is the primary server, the \n value of this object is the same as the value of \n vtpDiscoverResultDeviceId of the instance.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "vtpDiscoverResultRevNumber": { "type": "integer", "description": "The current configuration revision number as known by the\n VTP member. When the database type is unknown for\n the VTP member, this value is 0.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "vtpDiscoverResultSystemName": { "type": "string", "description": "sysName of the VTP member.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "vtpDatabaseTable": { "type": "object", "description": "This table contains information of the VTP\n databases. It is not instantiated when\n managementDomainVersionInUse is version1(1), \n version2(3) or none(3).", "properties": { "vtpDatabaseEntry": { "type": "array", "description": "Information about the status of the VTP database\n in the domain. Each VTP database type known to the\n local device type has an entry in this table.\n An entry is also created for unknown database which is\n notified through VTP advertisements from other VTP\n servers.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref", "readOnly": true }, "vtpDatabaseIndex": { "type": "integer", "description": "A value assigned by the system which uniquely identifies\n a VTP database in the local system.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "vtpDatabaseName": { "type": "string", "description": "The name of the database.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "vtpDatabaseLocalMode": { "type": "string", "description": "The local VTP mode for a particular database type\n in this administrative domain.\n \n - 'client' indicates that the local system is acting\n as a VTP client of the database type.\n \n - 'server' indicates that the local system is acting\n as a VTP server of the database type.\n \n - 'transparent' indicates that the local system does\n not generate or listen to VTP messages of this \n database type, but forwards\n messages. This mode can also be set by the device\n itself when the size of database is too large for it\n to hold in DRAM.\n \n - 'off' indicates that the local system does not\n generate, listen to or forward any VTP messages\n of this database type.\n \n The default mode is 'client' for the database type \n known to the local device and 'transparent' for the\n unknown database type.", "readOnly": true }, "vtpDatabaseRevNumber": { "type": "integer", "description": "The current configuration revision number as known by the\n local device for this VTP 3 database type in the management\n domain. This value is updated (if necessary) whenever a \n VTP advertisement for the database type is received \n or generated. When the database type is unknown to the \n local device or no VTP advertisement for the database\n type is received or generated, its value is 0.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "vtpDatabasePrimaryServer": { "type": "boolean", "description": "There are two kinds of VTP version 3 servers for a certain\n database type - the primary server and the secondary server.\n When a local device is configured as a server for a certain\n database type, it becomes secondary server by default.\n Primary server is an operational role under which a\n server can initiate or change the VTP configuration of the\n database type.\n \n A true(1) value indicates that the local device is the \n primary server of the database type in the management\n domain. A false(2) value indicates that the local device\n is not the primary server, or the database type is unknown\n to the local device.", "readOnly": true }, "vtpDatabasePrimaryServerId": { "type": "string", "description": "The unique identifier of the primary server in the\n management domain for the database type. \n \n If no primary server is discovered for the database\n type, the object has a value of zero length string.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "vtpDatabaseTakeOverPrimary": { "type": "boolean", "description": "There are two kinds of VTP version 3 servers for a certain\n database type - the primary server and the secondary server.\n When a local device is configured as a server for a certain\n database type, it becomes secondary server by default.\n Primary server is an operational role under which a\n server can initiate or change the VTP configuration of the\n database type.\n \n Setting this object to a true(1) value will advertise the\n configuration of this database type to the whole domain.\n \n In order to successfully setting this object to true(1),\n the value of vtpDatabaseLocalMode must be server(2). Besides\n that, when the VTP password is hidden from the configuration\n file, the password (vtpDatabaseTakeOverPassword) which \n matches the secret key (vtpAuthSecretKey) must be provided\n in the same data packet. \n \n When read, the object always returns false(2).", "readOnly": true }, "vtpDatabaseTakeOverPassword": { "type": "string", "description": "When read, this object always returns the value of a\n zero-length octet string.\n \n In the case that the VTP password is hidden from the \n configuration and the local device intends\n to take over the whole domain, this object must be \n set to the matching password with the secret key \n (vtpAuthSecretKey) in the same data packet as which \n the vtpDatabaseTakeOverPrimary is in. In all the \n other situations, setting a valid value to this object \n has no impact on the system.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "vtpAuthenticationTable": { "type": "object", "description": "vtpAuthenticationTable", "properties": { "vtpAuthEntry": { "type": "array", "description": "Information about the status of the VTP\n authentication information in one domain.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref", "readOnly": true }, "vtpAuthPassword": { "type": "string", "description": "By default, this object has a value of a zero-length\n character string and is considered to be not\n configured.\n \n The device uses the password to generate the \n secret key. It can be stored in the configuration in \n plain text or hidden from the configuration. If a VTP \n server intends to modify the database's configuration\n in the domain but the password was hidden from the\n configuration, the same password\n (vtpDatabaseTakeOverPassword) as the hidden one\n has to be provided.\n \n When this object is set alone, vtpAuthPasswordType is\n set to plaintext(1) automatically by the system.\n Setting this object to a zero length character string\n resets the password to its default value and the\n password is considered as not configured.\n \n This object is not allowed to be set at the same time\n when vtpAuthSecretKey is set.\n \n When the vtpAuthPasswordType is hidden(2), this object \n will return a zero-length character string when read.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "vtpAuthPasswordType": { "type": "string", "description": "By default this object has the value as plaintext(1)\n and the VTP password is stored in the configuration\n file in plain text.\n \n Setting this object to hidden(2) will hide the\n password from the configuration.\n \n Once this object is set to hidden(2), it cannot\n be set to plaintext(1) alone. However, it may\n be set to plaintext(1) at the same time the\n password is set.", "readOnly": true }, "vtpAuthSecretKey": { "type": "string", "description": "The device creating or modifying the VTP configuration\n signs it using the MD5 digest generated from the secret\n key before advertising it. Other devices in the domain\n receiving this configuration use the same secret key\n to accept it if it was correctly signed or drop it \n otherwise.\n \n By default, the object has the value as a zero-length\n string and this value is read only. It is set \n to this value automatically when the password \n (vtpAuthPassword) is set to a zero-length octet string.\n \n The secret key can be either generated using\n the password or configured by the user. Once\n the secret key is configured by the user, it is\n stored as a hexadecimal string in the device's\n configuration and the password is considered to be\n the secret key's matching password and hidden\n from the configuration automatically.\n \n This object is not allowed to be set at the same\n time when vtpAuthPassword is set.\n \n The secret key is overwritten by a newly generated\n secret key when the password is re-configured.", "format": "binary", "readOnly": true } } }, "readOnly": true } }, "readOnly": true } } }, "CISCO-VTP-MIB_object-1": { "type": "object", "description": "object-1", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref", "readOnly": true }, "managementDomainPruningStateOper": { "type": "string", "description": "managementDomainPruningStateOper", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-VTP-MIB_object-2": { "type": "object", "description": "object-2", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-VTP-MIB_object-3": { "type": "object", "description": "object-3", "properties": { "vtpVlanPortLocalSegment": { "type": "integer", "description": "The ring (segment) number in use on a 802.5 ring. For\n bridges supporting RFC 1525, this value is the same as given\n by dot1dSrPortLocalSegment for the bridge port attached to\n that ring. When tokenRing VLANs are in use, each 'trNet'\n VLAN can/does have a different instance of\n dot1dSrPortLocalSegment for each physical port. Note that\n access to the particuler instance of dot1dSrPortLocalSegment\n requires knowledge of how the agent supports the multiple\n 'contexts' required to implement RFC 1525 for multiple\n VLANs; also note that the assignment of ifIndex values may\n be different in different 'contexts'.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true } } }, "CISCO-VTP-MIB_managementDomainEntry": { "type": "array", "description": "Information about the status of one management domain.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "An arbitrary value to uniquely identify the management\n domain on the local system.", "x-yang-type": "CISCO-VTP-MIB:ManagementDomainIndex", "readOnly": true }, "managementDomainName": { "type": "string", "description": "The management name of a domain in which the local system\n is participating. The zero-length name corresponds to the\n 'no management-domain' state which is the initial value at\n installation-time if not configured otherwise. Note that\n the zero-length name does not correspond to an operational\n management domain, and a device does not send VTP\n advertisements while in the 'no management-domain' state. A\n device leaves the 'no management-domain' state when it\n obtains a management-domain name, either through\n configuration or through inheriting the management-domain\n name from a received VTP advertisement.\n \n When the value of an existing instance of this object is\n modified by network management, the local system should re-\n initialize its VLAN information (for the given management\n domain) as if it had just been configured with a management\n domain name at installation time.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "managementDomainLocalMode": { "type": "string", "description": "The local VTP mode in this management domain when\n managementDomainVersionInUse is version1(1) or\n version2(2).\n \n If managementDomainVersionInUse is version3(4), this \n object has the same value with vtpDatabaseLocalMode \n of VLAN database type.\n \n - 'client' indicates that the local system is acting\n as a VTP client.\n \n - 'server' indicates that the local system is acting\n as a VTP server.\n \n - 'transparent' indicates that the local system does\n not generate or listen to VTP messages, but forwards\n messages. This mode can also be set by the device\n itself when the amount of VLAN information is too\n large for it to hold in DRAM.\n \n - 'off' indicates that the local system does not\n generate, listen to or forward any VTP messages.", "readOnly": true }, "managementDomainConfigRevNumber": { "type": "integer", "description": "The current Configuration Revision Number as known by\n the local device for this management domain when \n managementDomainVersionInUse is version1(1) or \n version2(2).\n \n If managementDomainVersionInUse is version3(4), this \n object has the same value with vtpDatabaseRevisionNumber \n of VLAN database type.\n \n This value is updated (if necessary) whenever a VTP\n advertisement is received or generated. When in the\n 'no management-domain' state, this value is 0.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "managementDomainLastUpdater": { "type": "string", "description": "The IP-address (or one of them) of the VTP Server which\n last updated the Configuration Revision Number, as indicated\n in the most recently received VTP advertisement for this\n management domain, when managementDomainVersionInUse is\n version1(1) or version2(2). \n \n If managementDomainVersionInUse is version3(4), this object\n has the value of 0.0.0.0.\n \n Before an advertisement has been received, this value is\n 0.0.0.0.", "format": "inet:ipv4-address", "readOnly": true }, "managementDomainLastChange": { "type": "string", "description": "The time at which the Configuration Revision Number was\n (last) increased to its current value, as indicated in the\n most recently received VTP advertisement for this management\n domain when managementDomainVersionInUse is not version3(4)\n or in the most recently received VTP VLAN database \n advertisement for this management domain when \n managementDomainVersionInUse is version3(4).\n \n The value 0x0000010100000000 indicates that the device which\n last increased the Configuration Revision Number had no idea\n of the date/time, or that no advertisement has been\n received.", "x-yang-type": "snmpv2-tc:DateAndTime", "readOnly": true }, "managementDomainRowStatus": { "type": "string", "description": "The status of this conceptual row.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "managementDomainTftpServer": { "type": "string", "description": "The IP address of a TFTP Server in/from which VTP VLAN\n information for this management domain is to be\n stored/retrieved. If the information is being locally\n stored in NVRAM, this object should take the value 0.0.0.0.", "format": "inet:ipv4-address", "readOnly": true }, "managementDomainTftpPathname": { "type": "string", "description": "The complete pathname of the file at the TFTP Server\n identified by the value of managementDomainTftpServer\n in/from which VTP VLAN information for this management\n domain is to be stored/retrieved. If the value of\n corresponding instance of managementDomainTftpServer is\n 0.0.0.0, the value of this object is ignored.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "managementDomainPruningState": { "type": "string", "description": "An indication of whether VTP pruning is enabled or disabled\n in this managament domain. \n \n This object can only be modified, either when the \n corresponding instance value of managementDomainVersionInUse \n is 'version1' or 'version2' and the corresponding instance \n value of managementDomainLocalMode is 'server', or when the \n corresponding instance value of managementDomainVersionInUse \n is 'version3' and the corresponding instance value of \n managementDomainLocalMode is 'server' or 'client'.", "readOnly": true }, "managementDomainVersionInUse": { "type": "string", "description": "The current version of the VTP that is in use by the\n designated management domain. \n \n This object can be set to none(3) only when \n vtpVersion is none(3).", "readOnly": true }, "managementDomainPruningStateOper": { "type": "string", "description": "Indicates whether VTP pruning is operationally enabled or\n disabled in this managament domain.", "readOnly": true }, "managementDomainAdminSrcIf": { "type": "string", "description": "The object specifies the interface to be used as the\n preferred source interface for the VTP IP updater address.\n \n A zero length value indicates that a source interface is not\n specified.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "managementDomainSourceOnlyMode": { "type": "boolean", "description": "The object specifies whether to use only the IP address of\n managementDomainAdminSrcIf as the VTP IP updater address. \n \n 'true' indicates to only use the IP address of \n managementDomainAdminSrcIf as the VTP IP \n updater address. \n \n 'false' indicates to use the IP address of \n managementDomainAdminSrcIf as the VTP IP \n updater address if managementDomainAdminSrcIf \n is configured with an IP address. Otherwise, the \n first available IP address of the system will\n be used.", "readOnly": true }, "managementDomainOperSrcIf": { "type": "string", "description": "The object indicates the interface used as the\n preferred source interface for the VTP IP updater address.\n \n A zero length string indicates that a source interface is not\n available.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "managementDomainConfigFile": { "type": "string", "description": "The object specifies the file name where VTP configuration\n is stored in the format of or :[].\n \n can be (but not limited to): flash, bootflash,\n slot0, slot1, disk0.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "managementDomainLocalUpdaterType": { "type": "string", "description": "The object indicates the type of the Internet address\n of the preferred source interface for the VTP IP updater.\n \n The value of this object is 'unknown' if\n managementDomainVersionInUse is 'version3' or\n managementDomainLocalMode is not 'server'.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "managementDomainLocalUpdater": { "type": "string", "description": "The object indicates the Internet address of the\n preferred source interface for the VTP IP updater.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "managementDomainDeviceID": { "type": "string", "description": "The object indicates a value that uniquely identifies\n this device within a VTP Domain.\n \n The value of this object is zero length string if\n managementDomainVersionInUse is not 'version3'.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true } } } }, "CISCO-VTP-MIB_vtpVlanEntry": { "type": "array", "description": "Information about one current VLAN. The\n managementDomainIndex value in the INDEX clause indicates\n which management domain the VLAN is in.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref", "readOnly": true }, "vtpVlanIndex": { "type": "string", "description": "The VLAN-id of this VLAN on ISL or 802.1q trunks.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex", "readOnly": true }, "vtpVlanState": { "type": "string", "description": "The state of this VLAN.\n \n The state 'mtuTooBigForDevice' indicates that this device\n cannot participate in this VLAN because the VLAN's MTU is\n larger than the device can support.\n \n The state 'mtuTooBigForTrunk' indicates that while this\n VLAN's MTU is supported by this device, it is too large for\n one or more of the device's trunk ports.", "readOnly": true }, "vtpVlanType": { "type": "string", "description": "The type of this VLAN.", "x-yang-type": "CISCO-VTP-MIB:VlanType", "readOnly": true }, "vtpVlanName": { "type": "string", "description": "The name of this VLAN. This name is used as the ELAN-name\n for an ATM LAN-Emulation segment of this VLAN.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "vtpVlanMtu": { "type": "integer", "description": "The MTU size on this VLAN, defined as the size of largest\n MAC-layer (information field portion of the) data frame\n which can be transmitted on the VLAN.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "vtpVlanDot10Said": { "type": "string", "description": "The value of the 802.10 SAID field for this VLAN.", "format": "binary", "readOnly": true }, "vtpVlanRingNumber": { "type": "integer", "description": "The ring number of this VLAN. This object is only\n instantiated when the value of the corresponding instance of\n vtpVlanType has a value of 'fddi' or 'tokenRing' and Source\n Routing is in use on this VLAN.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "vtpVlanBridgeNumber": { "type": "integer", "description": "The bridge number of the VTP-capable switches for this\n VLAN. This object is only instantiated for VLANs that are\n involved with emulating token ring segments.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "vtpVlanStpType": { "type": "string", "description": "The type of the Spanning Tree Protocol (STP) running on\n this VLAN. This object is only instanciated when the\n value of the corresponding instance of vtpVlanType has a\n value of 'fddiNet' or 'trNet'.\n \n The value returned by this object depends upon the value\n of the corresponding instance of vtpVlanEditStpType.\n \n - 'ieee' indicates IEEE STP is running exclusively.\n \n - 'ibm' indicates IBM STP is running exclusively.\n \n - 'hybrid' indicates a STP that allows a combination of\n IEEE and IBM is running.\n \n The 'hybrid' STP type results from tokenRing/fddi VLANs\n that are children of this trNet/fddiNet parent VLAN being\n configured in a combination of SRT and SRB\n vtpVlanBridgeTypes while the instance of\n vtpVlanEditStpType that corresponds to this object is set\n to 'auto'.", "readOnly": true }, "vtpVlanParentVlan": { "type": "string", "description": "The parent VLAN for this VLAN. This object is only\n instantiated when the value of the corresponding instance of\n vtpVlanType has a value of 'fddi' or 'tokenRing' and Source\n Routing is in use on this VLAN. The parent VLAN must have \n a vtpVlanType value of fddiNet(4) or trNet(5), \n respectively.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex", "readOnly": true }, "vtpVlanTranslationalVlan1": { "type": "string", "description": "A VLAN to which this VLAN is being translational-bridged.\n If this value and the corresponding instance of\n vtpVlanTranslationalVlan2 are both zero, then this VLAN is\n not being translational-bridged.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex", "readOnly": true }, "vtpVlanTranslationalVlan2": { "type": "string", "description": "Another VLAN, i.e., other than that indicated by\n vtpVlanTranslationalVlan1, to which this VLAN is being\n translational-bridged. If this value and the corresponding\n instance of vtpVlanTranslationalVlan1 are both zero, then\n this VLAN is not being translational-bridged.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex", "readOnly": true }, "vtpVlanBridgeType": { "type": "string", "description": "The type of the Source Route bridging mode in use on this\n VLAN. This object is only instantiated when the value of \n the corresponding instance of vtpVlanType has a value of \n fddi(2) or tokenRing(3) and Source Routing is in use on\n this VLAN.", "readOnly": true }, "vtpVlanAreHopCount": { "type": "integer", "description": "The maximum number of bridge hops allowed in\n All Routes Explorer frames on this VLAN. This\n object is only instantiated when the value of the\n corresponding instance of vtpVlanType has a value of fddi(2)\n or tokenRing(3) and Source Routing is in use on this VLAN.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "vtpVlanSteHopCount": { "type": "integer", "description": "The maximum number of bridge hops allowed in\n Spanning Tree Explorer frames on this VLAN. This\n object is only instantiated when the value of the\n corresponding instance of vtpVlanType has a value of fddi(2)\n or tokenRing(3) and Source Routing is in use on this VLAN.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "vtpVlanIsCRFBackup": { "type": "boolean", "description": "True if this VLAN is of type trCrf and also is acting as\n a backup trCrf for the ISL distributed BRF", "readOnly": true }, "vtpVlanTypeExt": { "type": "string", "description": "The additional type information of this VLAN.", "x-yang-type": "CISCO-VTP-MIB:VlanTypeExt", "readOnly": true }, "vtpVlanIfIndex": { "type": "string", "description": "The value of the ifIndex corresponding to this VLAN ID.\n If the VLAN ID does not have its corresponding interface, \n this object has the value of zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true } } } }, "CISCO-VTP-MIB_vtpInternalVlanEntry": { "type": "array", "description": "Information about one current internal\n VLAN.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref", "readOnly": true }, "vtpVlanIndex": { "type": "string", "description": "vtpVlanIndex", "x-yang-type": "leafref", "readOnly": true }, "vtpInternalVlanOwner": { "type": "string", "description": "The program name of the internal VLAN's\n owner application. This internal VLAN\n is allocated by the device specifically\n for this application and no one else\n could create, modify or delete this \n VLAN.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true } } } }, "CISCO-VTP-MIB_vtpVlanEditEntry": { "type": "array", "description": "Information about one VLAN in the Edit Buffer for a\n particular management domain.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref", "readOnly": true }, "vtpVlanEditIndex": { "type": "string", "description": "The VLAN-id which this VLAN would have on ISL or\n 802.1q trunks.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex", "readOnly": true }, "vtpVlanEditState": { "type": "string", "description": "The state which this VLAN would have.", "readOnly": true }, "vtpVlanEditType": { "type": "string", "description": "The type which this VLAN would have.\n An implementation may restrict access to this object.", "x-yang-type": "CISCO-VTP-MIB:VlanType", "readOnly": true }, "vtpVlanEditName": { "type": "string", "description": "The name which this VLAN would have. This name would be\n used as the ELAN-name for an ATM LAN-Emulation segment of\n this VLAN.\n \n An implementation may restrict access to this object.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "vtpVlanEditMtu": { "type": "integer", "description": "The MTU size which this VLAN would have, defined as the\n size of largest MAC-layer (information field portion of the)\n data frame which can be transmitted on the VLAN.\n \n An implementation may restrict access to this object.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "vtpVlanEditDot10Said": { "type": "string", "description": "The value of the 802.10 SAID field which would be used for\n this VLAN.\n \n An implementation may restrict access to this object.", "format": "binary", "readOnly": true }, "vtpVlanEditRingNumber": { "type": "integer", "description": "The ring number which would be used for this VLAN. This\n object is only instantiated when the value of the\n corresponding instance of vtpVlanEditType has a value of\n 'fddi' or 'tokenRing' and Source Routing is in use on \n this VLAN.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "vtpVlanEditBridgeNumber": { "type": "integer", "description": "The bridge number of the VTP-capable switches which would\n be used for this VLAN. This object is only instantiated\n when the value of the corresponding instance of\n vtpVlanEditType has a value of fddiNet(4) or trNet(5).", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "vtpVlanEditStpType": { "type": "string", "description": "The type of the Spanning Tree Protocol which would be\n running on this VLAN. This object is only instantiated\n when the value of the corresponding instance of\n vtpVlanEditType has a value of fddiNet(4) or trNet(5).\n \n If 'ieee' is selected, the STP that runs will be IEEE.\n \n If 'ibm' is selected, the STP that runs will be IBM.\n \n If 'auto' is selected, the STP that runs will be\n dependant on the values of vtpVlanEditBridgeType for all\n children tokenRing/fddi type VLANs. This will result in\n a 'hybrid' STP (see vtpVlanStpType).", "readOnly": true }, "vtpVlanEditParentVlan": { "type": "string", "description": "The VLAN index of the VLAN which would be the parent for\n this VLAN. This object is only instantiated when the value\n of the corresponding instance of vtpVlanEditType has a value\n of 'fddi' or 'tokenRing' and Source Routing is in use on\n this VLAN. The parent VLAN must have a vtpVlanEditType \n value of fddiNet(4) or trNet(5), respectively.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex", "readOnly": true }, "vtpVlanEditRowStatus": { "type": "string", "description": "The status of this row. Any and all columnar objects in an\n existing row can be modified irrespective of the status of\n the row.\n \n A row is not qualified for activation until instances of at\n least its vtpVlanEditType, vtpVlanEditName and\n vtpVlanEditDot10Said columns have appropriate values.\n \n The management station should endeavor to make all rows\n consistent in the table before 'apply'ing the buffer. An\n inconsistent entry in the table will cause the entire\n buffer to be rejected with the vtpVlanApplyStatus object\n set to the appropriate error value.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "vtpVlanEditTranslationalVlan1": { "type": "string", "description": "A VLAN to which this VLAN would be translational-bridged.\n If this value and the corresponding instance of\n vtpVlanTranslationalVlan2 are both zero, then this VLAN\n would not be translational-bridged.\n \n An implementation may restrict access to this object.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex", "readOnly": true }, "vtpVlanEditTranslationalVlan2": { "type": "string", "description": "Another VLAN, i.e., other than that indicated by\n vtpVlanEditTranslationalVlan1, to which this VLAN would be\n translational-bridged. If this value and the corresponding\n instance of vtpVlanTranslationalVlan1 are both zero, then\n this VLAN would not be translational-bridged.\n \n An implementation may restrict access to this object.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex", "readOnly": true }, "vtpVlanEditBridgeType": { "type": "string", "description": "The type of Source Route bridging mode which would be in\n use on this VLAN. This object is only instantiated when \n the value of the corresponding instance of vtpVlanEditType\n has a value of fddi(2) or tokenRing(3) and Source Routing \n is in use on this VLAN.", "readOnly": true }, "vtpVlanEditAreHopCount": { "type": "integer", "description": "The maximum number of bridge hops allowed in\n All Routes Explorer frames on this VLAN. This\n object is only instantiated when the value of the\n corresponding instance of vtpVlanType has a value of fddi(2)\n or tokenRing(3) and Source Routing is in use on this VLAN.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "vtpVlanEditSteHopCount": { "type": "integer", "description": "The maximum number of bridge hops allowed in\n Spanning Tree Explorer frames on this VLAN. This\n object is only instantiated when the value of the\n corresponding instance of vtpVlanType has a value of fddi(2)\n or tokenRing(3) and Source Routing is in use on this VLAN.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "vtpVlanEditIsCRFBackup": { "type": "boolean", "description": "True if this VLAN is of type trCrf and also is acting as\n a backup trCrf for the ISL distributed BRF. This object is\n only instantiated when the value of the corresponding\n instance of vtpVlanEditType has a value of tokenRing(3).", "readOnly": true }, "vtpVlanEditTypeExt": { "type": "string", "description": "The additional type information of this VLAN.\n vtpVlanEditTypeExt object is superseded by vtpVlanEditTypeExt2.", "x-yang-type": "CISCO-VTP-MIB:VlanTypeExt", "readOnly": true }, "vtpVlanEditTypeExt2": { "type": "string", "description": "The additional type information of this VLAN.\n The VlanTypeExt TC specifies which bits may\n be written by a management application.\n The agent should provide a default value.", "x-yang-type": "CISCO-VTP-MIB:VlanTypeExt", "readOnly": true } } } }, "CISCO-VTP-MIB_vtpVlanLocalShutdownEntry": { "type": "array", "description": "An entry containing VLAN local shutdown information for a\n particular VLAN in the management domain.\n \n An entry is created if a VLAN which supports local shutdown\n has been created.\n \n An entry is deleted if a VLAN which supports local shutdown\n has been removed.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref", "readOnly": true }, "vtpVlanIndex": { "type": "string", "description": "vtpVlanIndex", "x-yang-type": "leafref", "readOnly": true }, "vtpVlanLocalShutdown": { "type": "string", "description": "The object specifies the VLAN local shutdown state.", "readOnly": true } } } }, "CISCO-VTP-MIB_vlanTrunkPortEntry": { "type": "array", "description": "Information about one trunk port.", "items": { "type": "object", "properties": { "vlanTrunkPortIfIndex": { "type": "string", "description": "The value of ifIndex for the interface corresponding to\n this trunk port.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true }, "vlanTrunkPortManagementDomain": { "type": "string", "description": "The value of managementDomainIndex for the management\n domain on this trunk port. Devices which support only one\n management domain will support this object read-only.", "x-yang-type": "CISCO-VTP-MIB:ManagementDomainIndex", "readOnly": true }, "vlanTrunkPortEncapsulationType": { "type": "string", "description": "The type of VLAN encapsulation desired to be used on this\n trunk port. It is either a particular type, or 'negotiate'\n meaning whatever type results from the negotiation.\n negotiate(5) is not allowed if the port does not support\n negotiation or if its vlanTrunkPortDynamicState is set to\n on(1) or onNoNegotiate(5). Whether writing to this object\n in order to modify the encapsulation is supported is both\n device and interface specific.", "readOnly": true }, "vlanTrunkPortVlansEnabled": { "type": "string", "description": "A string of octets containing one bit per VLAN in the\n management domain on this trunk port. The first octet\n corresponds to VLANs with VlanIndex values of 0 through 7;\n the second octet to VLANs 8 through 15; etc. The most\n significant bit of each octet corresponds to the lowest\n value VlanIndex in that octet. If the bit corresponding to\n a VLAN is set to '1', then the local system is enabled for\n sending and receiving frames on that VLAN; if the bit is set\n to '0', then the system is disabled from sending and\n receiving frames on that VLAN.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary", "readOnly": true }, "vlanTrunkPortNativeVlan": { "type": "string", "description": "The VlanIndex of the VLAN which is represented by native\n frames on this trunk port. For trunk ports not supporting\n the sending and receiving of native frames, this value\n should be set to zero.", "x-yang-type": "CISCO-VTP-MIB:VlanIndex", "readOnly": true }, "vlanTrunkPortRowStatus": { "type": "string", "description": "The status of this row. In some circumstances, the\n creation of a row in this table is needed to enable the\n appropriate trunking/tagging protocol on the port, to enable\n the use of VTP on the port, and to assign the port to the\n appropriate management domain. In other circumstances, rows\n in this table will be created as a by-product of other\n operations.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "vlanTrunkPortInJoins": { "type": "integer", "description": "The number of VTP Join messages received on this trunk\n port.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "vlanTrunkPortOutJoins": { "type": "integer", "description": "The number of VTP Join messages sent on this trunk port.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "vlanTrunkPortOldAdverts": { "type": "integer", "description": "The number of VTP Advertisement messages which indicated\n the sender does not support VLAN-pruning received on this\n trunk port.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "vlanTrunkPortVlansPruningEligible": { "type": "string", "description": "A string of octets containing one bit per VLAN in the\n management domain on this trunk port. The first octet\n corresponds to VLANs with VlanIndex values of 0 through 7;\n the second octet to VLANs 8 through 15; etc. The most\n significant bit of each octet corresponds to the lowest\n value VlanIndex in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local system is permitted to prune that VLAN on this trunk\n port; if the bit is set to '0', then the system must not\n prune that VLAN on this trunk port.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary", "readOnly": true }, "vlanTrunkPortVlansXmitJoined": { "type": "string", "description": "A string of octets containing one bit per VLAN in the\n management domain on this trunk port. The first octet\n corresponds to VLANs with VlanIndex values of 0 through 7;\n the second octet to VLANs 8 through 15; etc. The most\n significant bit of each octet corresponds to the lowest\n value VlanIndex in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then this\n VLAN is presently being forwarded on this trunk port, i.e.,\n it is not pruned; if the bit is set to '0', then this VLAN\n is presently not being forwarded on this trunk port, either\n because it is pruned or for some other reason.", "format": "binary", "readOnly": true }, "vlanTrunkPortVlansRcvJoined": { "type": "string", "description": "A string of octets containing one bit per VLAN in the\n management domain on this trunk port. The first octet\n corresponds to VLANs with VlanIndex values of 0 through 7;\n the second octet to VLANs 8 through 15; etc. The most\n significant bit of each octet corresponds to the lowest\n value VlanIndex in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local switch is currently sending joins for this VLAN on\n this trunk port, i.e., it is asking to receive frames for\n this VLAN; if the bit is set to '0', then the local switch\n is not currently sending joins for this VLAN on this trunk\n port.", "format": "binary", "readOnly": true }, "vlanTrunkPortDynamicState": { "type": "string", "description": "For devices that allows dynamic determination of whether\n a link between two switches should be a trunk or not, this\n object allows the operator to mandate the behavior of that\n dynamic mechanism.\n \n on(1) dictates that the interface will always be a\n trunk. This is the value for static entries (those that\n show no dynamic behavior). If the negotiation is supported\n on this port, negotiation will take place with the far end\n to attempt to bring the far end into trunking state.\n \n off(2) allows an operator to specify that the specified\n interface is never to be trunk, regardless of any dynamic\n mechanisms to the contrary. This value is useful for\n overriding the default behavior of some switches. If the\n negotiation is supported on this port, negotiation will take\n place with the far end to attempt on the link to bring the\n far end into non-trunking state.\n \n desirable(3) is used to indicate that it is desirable for\n the interface to become a trunk. The device will initiate\n any negotiation necessary to become a trunk but will not\n become a trunk unless it receives confirmation from the far\n end on the link.\n \n auto(4) is used to indicate that the interface is capable\n and willing to become a trunk but will not initiate\n trunking negotiations. The far end on the link are\n required to either start negotiations or start sending\n encapsulated packets, on which event the specified\n interface will become a trunk.\n \n onNoNegotiate(5) is used to indicate that the interface is\n permanently set to be a trunk, and no negotiation takes\n place with the far end on the link to ensure consistent\n operation. This is similar to on(1) except no negotiation\n takes place with the far end.\n \n If the port does not support negotiation or its\n vlanTrunkPortEncapsulationType is set to negotiate(5),\n onNoNegotiate(5) is not allowed.\n \n Devices that do no support dynamic determination (for just\n a particular interface, encapsulation or for the whole\n device) need only support the 'on', and 'off' values.", "readOnly": true }, "vlanTrunkPortDynamicStatus": { "type": "string", "description": "Indicates whether the specified interface is either\n acting as a trunk or not. This is a result of the\n vlanTrunkPortDynamicState and the ifOperStatus of the\n trunk port itself.", "readOnly": true }, "vlanTrunkPortVtpEnabled": { "type": "boolean", "description": "Some trunk interface modules allow VTP to be\n enabled/disabled seperately from that of the central\n device. In such a case this object provides management a\n way to remotely enable VTP on that module. If a module\n does not support a seperate VTP enabled state then this\n object shall always return 'true' and will accept no other\n value during a SET operation.", "readOnly": true }, "vlanTrunkPortEncapsulationOperType": { "type": "string", "description": "The type of VLAN encapsulation in use on this trunk port.\n For intefaces with vlanTrunkPortDynamicStatus of\n notTrunking(2) the vlanTrunkPortEncapsulationOperType shall\n be notApplicable(6).", "readOnly": true }, "vlanTrunkPortVlansEnabled2k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 1024 through 2047 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 1024 through 1031; the second\n octet to VLANs 1032 through 1039; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet. If the bit corresponding to a VLAN is set to\n '1', then the local system is enabled for sending and\n receiving frames on that VLAN; if the bit is set to '0',\n then the system is disabled from sending and receiving\n frames on that VLAN. The default value is zero length\n string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary", "readOnly": true }, "vlanTrunkPortVlansEnabled3k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 2048 through 3071 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 2048 through 2055; the second\n octet to VLANs 2056 through 2063; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet. If the bit corresponding to a VLAN is set to\n '1', then the local system is enabled for sending and\n receiving frames on that VLAN; if the bit is set to '0',\n then the system is disabled from sending and receiving\n frames on that VLAN. The default value is zero length\n string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary", "readOnly": true }, "vlanTrunkPortVlansEnabled4k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 3072 through 4095 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 3072 through 3079; the second\n octet to VLANs 3080 through 3087; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet. If the bit corresponding to a VLAN is set to\n '1', then the local system is enabled for sending and\n receiving frames on that VLAN; if the bit is set to '0',\n then the system is disabled from sending and receiving\n frames on that VLAN. The default value is zero length\n string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary", "readOnly": true }, "vtpVlansPruningEligible2k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 1024 through 2047 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 1024 through 1031; the second\n octet to VLANs 1032 through 1039; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local system is permitted to prune that VLAN on this trunk\n port; if the bit is set to '0', then the system must not\n prune that VLAN on this trunk port.\n The default value is zero length string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary", "readOnly": true }, "vtpVlansPruningEligible3k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 2048 through 3071 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 2048 through 2055; the second\n octet to VLANs 2056 through 2063; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local system is permitted to prune that VLAN on this trunk\n port; if the bit is set to '0', then the system must not\n prune that VLAN on this trunk port.\n The default value is zero length string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary", "readOnly": true }, "vtpVlansPruningEligible4k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 3072 through 4095 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 3072 through 3079; the second\n octet to VLANs 3080 through 3087; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local system is permitted to prune that VLAN on this trunk\n port; if the bit is set to '0', then the system must not\n prune that VLAN on this trunk port.\n The default value is zero length string.\n \n To avoid conflicts between overlapping partial updates by\n multiple managers, i.e., updates which modify only a portion\n of an instance of this object (e.g., enable/disable a single\n VLAN on the trunk port), any SNMP Set operation accessing an\n instance of this object should also write the value of\n vlanTrunkPortSetSerialNo.", "format": "binary", "readOnly": true }, "vlanTrunkPortVlansXmitJoined2k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 1024 through 2047 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 1024 through 1031; the second\n octet to VLANs 1032 through 1039; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then this\n VLAN is presently being forwarded on this trunk port, i.e.,\n it is not pruned; if the bit is set to '0', then this VLAN\n is presently not being forwarded on this trunk port, either\n because it is pruned or for some other reason.", "format": "binary", "readOnly": true }, "vlanTrunkPortVlansXmitJoined3k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 2048 through 3071 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 2048 through 2055; the second\n octet to VLANs 2056 through 2063; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then this\n VLAN is presently being forwarded on this trunk port, i.e.,\n it is not pruned; if the bit is set to '0', then this VLAN\n is presently not being forwarded on this trunk port, either\n because it is pruned or for some other reason.", "format": "binary", "readOnly": true }, "vlanTrunkPortVlansXmitJoined4k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 3072 through 4095 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 3072 through 3079; the second\n octet to VLANs 3080 through 3087; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then this\n VLAN is presently being forwarded on this trunk port, i.e.,\n it is not pruned; if the bit is set to '0', then this VLAN\n is presently not being forwarded on this trunk port, either\n because it is pruned or for some other reason.", "format": "binary", "readOnly": true }, "vlanTrunkPortVlansRcvJoined2k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 1024 through 2047 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 1024 through 1031; the second\n octet to VLANs 1032 through 1039; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local switch is currently sending joins for this VLAN on\n this trunk port, i.e., it is asking to receive frames for\n this VLAN; if the bit is set to '0', then the local switch\n is not currently sending joins for this VLAN on this trunk\n port.", "format": "binary", "readOnly": true }, "vlanTrunkPortVlansRcvJoined3k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 2048 through 3071 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 2048 through 2055; the second\n octet to VLANs 2056 through 2063; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local switch is currently sending joins for this VLAN on\n this trunk port, i.e., it is asking to receive frames for\n this VLAN; if the bit is set to '0', then the local switch\n is not currently sending joins for this VLAN on this trunk\n port.", "format": "binary", "readOnly": true }, "vlanTrunkPortVlansRcvJoined4k": { "type": "string", "description": "A string of octets containing one bit per VLAN for VLANS\n with VlanIndex values of 3072 through 4095 in the management\n domain on this trunk port. The first octet corresponds to\n VLANs with VlanIndex values of 3072 through 3079; the second\n octet to VLANs 3080 through 3087; etc. The most significant\n bit of each octet corresponds to the lowest value VlanIndex\n in that octet.\n \n If the bit corresponding to a VLAN is set to '1', then the\n local switch is currently sending joins for this VLAN on\n this trunk port, i.e., it is asking to receive frames for\n this VLAN; if the bit is set to '0', then the local switch\n is not currently sending joins for this VLAN on this trunk\n port.", "format": "binary", "readOnly": true }, "vlanTrunkPortDot1qTunnel": { "type": "string", "description": "Indicates dot1qtunnel mode of the port.\n \n If the portDot1qTunnel is set to 'trunk' mode, the port's\n vlanTrunkPortDynamicState will be changed to 'onNoNegotiate'\n and the vlanTrunkPortEncapsulationType will be set to\n 'dot1Q'. These values cannot be changed unless dot1q tunnel\n is disabled on this port.\n \n If the portDot1qTunnel mode is set to 'access' mode, the\n port's vlanTrunkPortDynamicState will be set to 'off'.And\n the value of vlanTrunkPortDynamicState cannot be changed\n unless dot1q tunnel is disabled on this port. 1Q packets\n received on this access port will remain.\n \n Setting the port to dot1q tunnel 'disabled' mode causes the\n dot1q tunnel feature to be disabled on this port. This\n object can't be set to 'trunk' or 'access' mode, when\n vlanTrunkPortsDot1qTag object is set to 'false'.\n \n This object has been deprecated and is replaced by the\n object 'cltcDot1qTunnelMode' in the\n CISCO-L2-TUNNEL-CONFIG-MIB", "readOnly": true }, "vlanTrunkPortVlansActiveFirst2k": { "type": "string", "description": "A string of octets containing one bit per VLAN\n with VlanIndex values of 0 through 2047.\n \n If the bit corresponding to a VLAN is set to 1,\n it indicates that vlan is allowed and active in\n management domain.\n \n If the bit corresponding to a VLAN is set to 0,\n it indicates that vlan is not allowed or not active\n in management domain.", "x-yang-type": "cisco-tc:Cisco2KVlanList", "readOnly": true }, "vlanTrunkPortVlansActiveSecond2k": { "type": "string", "description": "A string of octets containing one bit per VLAN\n with VlanIndex values of 2048 through 4095.\n \n If the bit corresponding to a VLAN is set to 1,\n it indicates that vlan is allowed and active in\n management domain.\n \n If the bit corresponding to a VLAN is set to 0,\n it indicates that vlan is not allowed or not active\n in management domain.", "x-yang-type": "cisco-tc:Cisco2KVlanList", "readOnly": true } } } }, "CISCO-VTP-MIB_vtpDiscoverEntry": { "type": "array", "description": "Information related to the discovery of the\n VTP members in one management domain.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref", "readOnly": true }, "vtpDiscoverAction": { "type": "string", "description": "When this object is set to discover(1), all the\n entries in vtpDiscoverResultTable for the\n corresponding management domain will be removed \n and the local device will begin to discover all\n VTP members in the management domain. Upon the\n successful completion of discovery, the discovered\n result will be stored in the vtpDiscoverResultTable.\n \n If vtpDiscoverStatus is inProgress(1), setting \n vtpDiscoverAction to discover(1) will fail. \n \n When this object is set to purgeResult(3), \n all the entries of vtpDiscoverResultTable for \n the corresponding management domain will be\n removed from vtpDiscoverResultTable.\n \n When this object is set to noOperation(2), no\n action will be taken. When read, this object\n always returns noOperation(2).", "readOnly": true }, "vtpDiscoverStatus": { "type": "string", "description": "The current status of VTP discovery.\n \n inProgress - a discovery is in progress;\n \n succeeded - the discovery was completed successfully\n (this value is also used when \n no discover has been invoked since the\n last time the local system restarted);\n \n resourceUnavailable - the discovery failed because\n the required allocation of a resource is\n presently unavailable.\n \n someOtherError - 'the discovery failed due to a\n reason no listed.", "readOnly": true }, "vtpLastDiscoverTime": { "type": "string", "description": "The value of sysUpTime at which the last discovery\n was completed.\n \n A value of zero indicates that no discovery has been\n invoked since last time the local system restarted.", "x-yang-type": "yang:timestamp", "readOnly": true } } } }, "CISCO-VTP-MIB_vtpDiscoverResultEntry": { "type": "array", "description": "A conceptual row is created for each VTP member which\n is found through successful discovery.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref", "readOnly": true }, "vtpDiscoverResultIndex": { "type": "integer", "description": "A value assigned by the system which identifies\n a VTP member and the associated database in the \n management domain.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "vtpDiscoverResultDatabaseName": { "type": "string", "description": "The database name associated with the\n discovered VTP member.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "vtpDiscoverResultConflicting": { "type": "boolean", "description": "Indicates whether this VTP member contains\n conflicting information.\n \n true(1) indicates that this member has conflicting \n information of the database type in the management domain.\n \n false(2) indicates that there is no conflicting information\n of the database type in the management domain.", "readOnly": true }, "vtpDiscoverResultDeviceId": { "type": "string", "description": "The unique identifier of the device for this VTP member.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "vtpDiscoverResultPrimaryServer": { "type": "string", "description": "The unique identifier of the primary server for this VTP\n member and the associated database type.\n \n There are two different VTP servers, the primary server\n and the secondary server. When a local device is\n configured as a server for a certain database type,\n it becomes secondary server by default. \n Primary server is an operational role under which a\n server can initiate or change the VTP configuration of the\n database type.\n \n If this VTP member itself is the primary server, the \n value of this object is the same as the value of \n vtpDiscoverResultDeviceId of the instance.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "vtpDiscoverResultRevNumber": { "type": "integer", "description": "The current configuration revision number as known by the\n VTP member. When the database type is unknown for\n the VTP member, this value is 0.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "vtpDiscoverResultSystemName": { "type": "string", "description": "sysName of the VTP member.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true } } } }, "CISCO-VTP-MIB_vtpDatabaseEntry": { "type": "array", "description": "Information about the status of the VTP database\n in the domain. Each VTP database type known to the\n local device type has an entry in this table.\n An entry is also created for unknown database which is\n notified through VTP advertisements from other VTP\n servers.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref", "readOnly": true }, "vtpDatabaseIndex": { "type": "integer", "description": "A value assigned by the system which uniquely identifies\n a VTP database in the local system.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "vtpDatabaseName": { "type": "string", "description": "The name of the database.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "vtpDatabaseLocalMode": { "type": "string", "description": "The local VTP mode for a particular database type\n in this administrative domain.\n \n - 'client' indicates that the local system is acting\n as a VTP client of the database type.\n \n - 'server' indicates that the local system is acting\n as a VTP server of the database type.\n \n - 'transparent' indicates that the local system does\n not generate or listen to VTP messages of this \n database type, but forwards\n messages. This mode can also be set by the device\n itself when the size of database is too large for it\n to hold in DRAM.\n \n - 'off' indicates that the local system does not\n generate, listen to or forward any VTP messages\n of this database type.\n \n The default mode is 'client' for the database type \n known to the local device and 'transparent' for the\n unknown database type.", "readOnly": true }, "vtpDatabaseRevNumber": { "type": "integer", "description": "The current configuration revision number as known by the\n local device for this VTP 3 database type in the management\n domain. This value is updated (if necessary) whenever a \n VTP advertisement for the database type is received \n or generated. When the database type is unknown to the \n local device or no VTP advertisement for the database\n type is received or generated, its value is 0.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "vtpDatabasePrimaryServer": { "type": "boolean", "description": "There are two kinds of VTP version 3 servers for a certain\n database type - the primary server and the secondary server.\n When a local device is configured as a server for a certain\n database type, it becomes secondary server by default.\n Primary server is an operational role under which a\n server can initiate or change the VTP configuration of the\n database type.\n \n A true(1) value indicates that the local device is the \n primary server of the database type in the management\n domain. A false(2) value indicates that the local device\n is not the primary server, or the database type is unknown\n to the local device.", "readOnly": true }, "vtpDatabasePrimaryServerId": { "type": "string", "description": "The unique identifier of the primary server in the\n management domain for the database type. \n \n If no primary server is discovered for the database\n type, the object has a value of zero length string.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "vtpDatabaseTakeOverPrimary": { "type": "boolean", "description": "There are two kinds of VTP version 3 servers for a certain\n database type - the primary server and the secondary server.\n When a local device is configured as a server for a certain\n database type, it becomes secondary server by default.\n Primary server is an operational role under which a\n server can initiate or change the VTP configuration of the\n database type.\n \n Setting this object to a true(1) value will advertise the\n configuration of this database type to the whole domain.\n \n In order to successfully setting this object to true(1),\n the value of vtpDatabaseLocalMode must be server(2). Besides\n that, when the VTP password is hidden from the configuration\n file, the password (vtpDatabaseTakeOverPassword) which \n matches the secret key (vtpAuthSecretKey) must be provided\n in the same data packet. \n \n When read, the object always returns false(2).", "readOnly": true }, "vtpDatabaseTakeOverPassword": { "type": "string", "description": "When read, this object always returns the value of a\n zero-length octet string.\n \n In the case that the VTP password is hidden from the \n configuration and the local device intends\n to take over the whole domain, this object must be \n set to the matching password with the secret key \n (vtpAuthSecretKey) in the same data packet as which \n the vtpDatabaseTakeOverPrimary is in. In all the \n other situations, setting a valid value to this object \n has no impact on the system.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true } } } }, "CISCO-VTP-MIB_vtpAuthEntry": { "type": "array", "description": "Information about the status of the VTP\n authentication information in one domain.", "items": { "type": "object", "properties": { "managementDomainIndex": { "type": "string", "description": "managementDomainIndex", "x-yang-type": "leafref", "readOnly": true }, "vtpAuthPassword": { "type": "string", "description": "By default, this object has a value of a zero-length\n character string and is considered to be not\n configured.\n \n The device uses the password to generate the \n secret key. It can be stored in the configuration in \n plain text or hidden from the configuration. If a VTP \n server intends to modify the database's configuration\n in the domain but the password was hidden from the\n configuration, the same password\n (vtpDatabaseTakeOverPassword) as the hidden one\n has to be provided.\n \n When this object is set alone, vtpAuthPasswordType is\n set to plaintext(1) automatically by the system.\n Setting this object to a zero length character string\n resets the password to its default value and the\n password is considered as not configured.\n \n This object is not allowed to be set at the same time\n when vtpAuthSecretKey is set.\n \n When the vtpAuthPasswordType is hidden(2), this object \n will return a zero-length character string when read.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "vtpAuthPasswordType": { "type": "string", "description": "By default this object has the value as plaintext(1)\n and the VTP password is stored in the configuration\n file in plain text.\n \n Setting this object to hidden(2) will hide the\n password from the configuration.\n \n Once this object is set to hidden(2), it cannot\n be set to plaintext(1) alone. However, it may\n be set to plaintext(1) at the same time the\n password is set.", "readOnly": true }, "vtpAuthSecretKey": { "type": "string", "description": "The device creating or modifying the VTP configuration\n signs it using the MD5 digest generated from the secret\n key before advertising it. Other devices in the domain\n receiving this configuration use the same secret key\n to accept it if it was correctly signed or drop it \n otherwise.\n \n By default, the object has the value as a zero-length\n string and this value is read only. It is set \n to this value automatically when the password \n (vtpAuthPassword) is set to a zero-length octet string.\n \n The secret key can be either generated using\n the password or configured by the user. Once\n the secret key is configured by the user, it is\n stored as a hexadecimal string in the device's\n configuration and the password is considered to be\n the secret key's matching password and hidden\n from the configuration automatically.\n \n This object is not allowed to be set at the same\n time when vtpAuthPassword is set.\n \n The secret key is overwritten by a newly generated\n secret key when the password is re-configured.", "format": "binary", "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-VTP-MIB", "description": "MIB operations for CISCO-VTP-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }