Create configurations for an intended layer 2 feature on a wired device - Cisco Catalyst Center API 2.3.7.9

{"type":"api","title":"Create configurations for an intended layer 2 feature on a wired device","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-9/a58b8872fdc3116cb1a0478252ee81e8011d37c2/6a3cd7ca-617e-374c-a10b-740a529a993e","info":{"title":"Intent API","description":"Cisco Catalyst Center Platform v. 2.3.7.9","version":"2.3.7.9"},"tags":[{"name":"Authentication","description":"Access Token Request"},{"name":"Sites","description":"Create sites, assign devices to them and get site health"},{"name":"Topology","description":"Get topology details and overall network health"},{"name":"Devices","description":"Manage network devices"},{"name":"Clients","description":"Get client (by MAC Address) health, status, and information"},{"name":"Users","description":"Obtain information about *Users* and associated connections and devices"},{"name":"Issues","description":"Obtain issue details, impacted hosts, and suggested actions for remediation"},{"name":"Site Design","description":"Design/provision NFV device to site/area/building/floor"},{"name":"Network Settings","description":"Manage Network Settings"},{"name":"Software Image Management (SWIM)","description":"Manage activation and distribution of software images"},{"name":"Device Onboarding (PnP)","description":"Zero-touch deployment of network devices"},{"name":"Configuration Templates","description":"Configure and manage CLI templates"},{"name":"Configuration Archive","description":"Export device configurations to an encrypted zip file"},{"name":"SDA","description":"(BETA) Configure and manage SDA wired fabric border devices"},{"name":"Sensors","description":"Manage sensor test templates"},{"name":"Wireless","description":"Configure and manage SSIDs, Wireless, and RF profiles in non-fabric wireless network"},{"name":"Command Runner","description":"Retrieve real-time device configuration and CLI keywords"},{"name":"Discovery","description":"Discover network devices and manage discovery jobs"},{"name":"Path Trace","description":"Network route and flow analysis"},{"name":"File","description":"Get configuration files by namespace and ID"},{"name":"Task","description":"Get information about asynchronous tasks"},{"name":"Tag","description":"Assign administrator-defined tags to network devices"},{"name":"Application Policy","description":"Create and manage applications, application sets, and application policies"},{"name":"Applications","description":"Intent API to get a list of applications for a specific site, a device, or a client device's MAC address"},{"name":"ITSM","description":"Provide the details of the various third party integrations that are supported"},{"name":"Event Management","description":"Event based notification to external handlers"},{"name":"Security Advisories","description":"Provides the details of advisories on the network and devices"},{"name":"Compliance","description":"Provides compliance status data on the devices"}],"x-parser-conf":{"expand":0,"labelConfig":{"endpoint":"summary"}},"openapi":"3.0.1","servers":[{"url":"/"}]},"spec":{"operationId":"createConfigurationsForAnIntendedLayer2FeatureOnAWiredDevice","tags":["Wired"],"deprecated":false,"summary":"Create configurations for an intended layer 2 feature on a wired device","description":"This API creates configurations for an intended feature on a wired device, if it hasn't been added earlier. nly the feature configurations to be changed need to be added to the intended features. Updates to intended features can be done over several iterations. When the intended features are deployed to a device using the API /dna/intent/api/v1/networkDevices/{id}/configFeatures/intended/deploy, they are applied on top of the existing configurations on the device. Any existing configurations on the device which are not included in the intended features, are retained on the device.","parameters":[{"name":"Content-Type","description":"Request body content type","required":true,"schema":{"type":"string","default":"application/json"},"in":"header"},{"name":"id","description":"Network device ID of the wired device to configure.","required":true,"schema":{"type":"string","default":"application/json"},"in":"path"},{"name":"feature","description":"Name of the feature to configure. The API /dna/intent/api/v1/networkDevices/{id}/configFeatures/supported/layer2 can be used to get the list of features supported on a device.","required":true,"schema":{"type":"string","default":"application/json"},"in":"path"}],"requestBody":{"description":"request","content":{"application/json":{"schema":{"type":"object","properties":{"cdpGlobalConfig":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","enum":["CDP_GLOBAL"],"description":"Type of network functionality configured for CDP. Config type CDP_GLOBAL is for configuring the global settings for CDP."},"timer":{"type":"integer","description":"Sets the transmission frequency of CDP updates in seconds. Corresponding CLI - cdp timer \u003c5-254\u003e."},"isCdpEnabled":{"type":"boolean","description":"Enables or disables CDP on the device. Corresponding CLI - cdp run. default: true"},"isLogDuplexMismatchEnabled":{"type":"boolean","description":"Configures the reporting of duplex mismatches generated by CDP for all Ethernet interfaces on the device. Corresponding CLI - cdp log mismatch. duplex. default: true."},"isAdvertiseV2Enabled":{"type":"boolean","description":"Configures CDP to send Version-2 advertisements. The default state is enabled. Corresponding CLI - cdp advertise-v2."},"holdTime":{"type":"integer","description":"Specifies the amount of time a receiving device should hold the information sent by the device before discarding it. Corresponding CLI - cdp holdtime \u003c10-255\u003e."}}},"description":""}},"description":""},"cdpIntefaceConfig":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","enum":["CDP_INTERFACE"],"description":"Type of network functionality under a feature. Config type CDP_INTERFACE is for configuring CDP on an interface."},"interfaceName":{"type":"string","description":"Interface name. The API /dna/intent/api/v1/interface/network-device/{deviceId} can be used to get the list of interfaces on a device. example: GigabitEthernet1/0/1"},"isCdpEnabled":{"type":"boolean","description":"Enables or disables CDP on the interface. Corresponding CLI - cdp enable. default: true"},"isLogDuplexMismatchEnabled":{"type":"boolean","description":"Configures the reporting of duplex mismatches generated by CDP for all Ethernet interfaces on the device. Corresponding CLI - cdp log mismatch duplex. default: true"}}},"description":""}},"description":""},"dhcpSnoopingIntefaceConfig":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","enum":["DHCP_SNOOPING_INTERFACE"],"description":"Type of network functionality under a feature. Config type DHCP_SNOOPING_INTERFACE is for configuring DHCP snooping on an interface."},"interfaceName":{"type":"string","description":"Interface name. The API /intent/api/v1/interface/network-device/{deviceId} can be used to get the list of interfaces on a device.example: GigabitEthernet1/0/1"},"isTrustedInterface":{"type":"boolean","description":"Enable Trusted Interface. Corresponding CLI - ip dhcp snooping trust."},"messageRateLimit":{"type":"integer","description":"Limit the number of DHCP packets a port can send or receive in a second. This is a protective measure to prevent a single device from overwhelming the DHCP server. Increase the rate limit on trunk ports carrying more than one VLAN. By default, rate limit is disabled. The recommended value is \u003c= 100. Set the rate-limit as 0 to disable it. Corresponding CLI - ip dhcp snooping limit rate \u003c1-2048\u003e."}}},"description":"Configure DHCP Snooping settings of an interface."}},"description":""},"dhcpSnoopingGlobalConfig":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","enum":[""],"description":"Type of network functionality under a feature. Config type DHCP_SNOOPING_GLOBAL is for configuring the global settings for DHCP snooping."},"isDhcpSnoopingEnabled":{"type":"boolean","description":"Enable DHCP snooping globally. Corresponding CLI - ip dhcp snooping.default: false"},"databaseAgent":{"type":"object","properties":{"configType":{"type":"string","enum":["DHCP_SNOOPING_DATABASE_AGENT"],"description":"Type of network functionality under a feature. Config type DHCP_SNOOPING_DATABASE_AGENT is for configuring DHCP snooping database agent settings on a device."},"agentUrl":{"type":"string","description":"example: tftp://192.168.1.100/db_backup Specify the URL for the database agent or the binding file. Corresponding CLI - ip dhcp snooping database ."},"timeout":{"type":"integer","description":"Specify the duration, in seconds, after which a configuration process will be automatically terminated. Corresponding CLI - ip dhcp snooping database timeout \u003c0-86400\u003e."},"writeDelay":{"type":"integer","description":""}},"description":"Configure the settings for managing and maintaining the DHCP server's database remotely."},"isGleaningEnabled":{"type":"boolean","description":"Enable DHCP gleaning which allows components to register and glean only DHCP version 4 packets. Corresponding CLI - ip dhcp snooping glean.default: false"},"proxyBridgeVlans":{"type":"string","description":"Enable bridge mode on VLANs. VLANs can be comma separated and/or a range like '2,4-5,7,10-20'. Corresponding CLI - ip dhcp snooping vlan proxy-bridge."},"dhcpSnoopingVlans":{"type":"string","description":"Enable DHCP snooping on VLANs. VLANs can be comma separated and/or a range like '2,4-5,7,10-20'. Corresponding CLI - ip dhcp snooping vlan ."}}},"description":"Configure global DHCP Snooping parameters on the device."}},"description":""},"dot1xInterfaceConfig":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","enum":["DOT1X_INTERFACE"],"description":"Type of network functionality under a feature. Config type DOT1X_INTERFACE is for configuring 802.1x on an interface."},"interfaceName":{"type":"string","description":"Interface name. The API /intent/api/v1/interface/network-device/{deviceId} can be used to get the list of interfaces on a device.example: GigabitEthernet1/0/1"},"authenticationOrder":{"type":"object","properties":{"configType":{"type":"string","enum":["ORDERED_SET"],"description":""},"items":{"type":"array","items":{"type":"string"},"description":"Array of Enums. [ DOT1X, MAB, WEBAUTH ]"}},"description":"Set the order of authentication methods used on a port. Corresponding CLI - authentication order [dot1x | mab | webauth]."}}},"description":"Configure 802.1x settings of an interface."}},"description":""},"dot1xGlobalConfig":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","enum":["DOT1X_GLOBAL"],"description":"Type of network functionality under a feature. Config type DOT1X_GLOBAL is for global 802.1x settings on a device."},"authenticationConfigMode":{"type":"string","enum":["LEGACY","NEW_STYLE"],"description":"readOnly attribute. Identity-Based Networking Services features are configured in the Cisco common classification policy language (C3PL) display mode. The legacy authentication manager mode is enabled by default. Use this command in EXEC mode to display the current configuration mode. Corresponding CLI - authentication display config-mode. LEGACY - Legacy configuration mode. NEW_STYLE - Identity-Based Networking Services (IBNS) configuration mode."},"isDot1xEnabled":{"type":"boolean","description":"Globally enable 802.1x authentication on Switch. Corresponding CLI - dot1x system-auth-control. default: false"}}},"description":"Configure Dot1x global characteristics on a device."}},"description":"This feature is for configuring 802.1x. IEEE 802.1x is a standard which facilitates access control between a client and a server. Before services can be provided to a client by a Local Access Network (LAN) or switch, the client connected to the switch port has to be authenticated by the authentication server which runs Remote Authentication Dial-In User Service (RADIUS). 802.1x authentication restricts unauthorized clients from connecting to a LAN through publicly-accessible ports."},"lldpGlobalConfig":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","enum":["LLDP_GLOBAL"],"description":"Type of network functionality configured for LLDP. Config type LLDP_GLOBAL is for configuring the global settings for LLDP."},"timer":{"type":"integer","description":"Sets the transmission frequency of LLDP updates in seconds. Corresponding CLI - lldp timer \u003c5-32767\u003e."},"isLldpEnabled":{"type":"boolean","description":"Enables or disables LLDP on the device. Corresponding CLI - lldp run. default: true"},"reinitializationDelay":{"type":"integer","description":"Specifies the delay time in seconds for LLDP to initialize on any interface. Corresponding CLI - lldp reinit \u003c2-5\u003e."},"holdTime":{"type":"integer","description":"Specifies the amount of time a receiving device should hold the information sent by the device before discarding it. Corresponding CLI - lldp holdtime $holdTime \u003c0-32767\u003e."}}},"description":""}},"description":""},"lldpInterfaceConfig":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","enum":["LLDP_INTERFACE"],"description":"Type of network functionality under a feature. Config type LLDP_INTERFACE is for configuring LLDP on an interface."},"interfaceName":{"type":"string","description":"Interface name. The API /intent/api/v1/interface/network-device/{deviceId} can be used to get the list of interfaces on a device. example: GigabitEthernet1/0/1"},"adminStatus":{"type":"string","enum":["TRANSMIT_ONLY","RECEIVE_ONLY","TRANSMIT_AND_RECEIVE","DISABLED"],"description":"Configure the interface to transmit and receive LLDP packets, or disable LLDP on the interface. TRANSMIT_ONLY - Configure the interface to transmit LLDP packets only. Corresponding CLI - lldp transmit. RECEIVE_ONLY - Configure the interface to receive LLDP packets only. Corresponding CLI - lldp receive. TRANSMIT_AND_RECEIVE - Configure the interface to both transmit and receive LLDP packets. Corresponding CLI - lldp receive; lldp transmit. DISABLED - Disable LLDP functionality on the device, preventing both transmission and reception of LLDP packets."}}},"description":""}},"description":""},"mabInterfaceConfig":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","enum":["MAB_INTERFACE"],"description":"Type of network functionality under a feature. Config type MAB_INTERFACE is for configuring MAB on an interface."},"interfaceName":{"type":"string","description":"Interface name. The API /intent/api/v1/interface/network-device/{deviceId} can be used to get the list of interfaces on a device."},"isMabEnabled":{"type":"boolean","description":"Enable MAC-based authentication on a port. Corresponding CLI - mab. default: false"}}},"description":"Configure MAB settings of an interface."}},"description":""},"mldSnoopingConfig":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","enum":["MLD_SNOOPING_GLOBAL"],"description":"Type of network functionality under a feature. Config type MLD_SNOOPING_GLOBAL is for configuring MLD snooping settings on a device."},"isMldSnoopingEnabled":{"type":"boolean","description":"Enable global MLD Snooping. Corresponding CLI - ipv6 mld snooping.default: false"},"isSuppressListenerMessagesEnabled":{"type":"boolean","description":"When Listener Message Suppression is enabled, the switch forwards only a single MLD report per multicast router query. Corresponding CLI - ipv6 mld snooping listener-message-suppression.default: true"},"isQuerierEnabled":{"type":"boolean","description":"Enable MLD Snooping Querier. Corresponding CLI - ipv6 mld snooping querier.default: false"},"querierAddress":{"type":"string","description":"MLD querier source IP address. Corresponding CLI - ipv6 mld snooping querier address \u003csource-ipv6-address\u003e."},"querierQueryInterval":{"type":"integer","description":"Set the MLD querier query interval (in seconds). Corresponding CLI - ipv6 mld snooping querier query-interval \u003c1-18000\u003e."},"querierVersion":{"type":"string","enum":["VERSION_1","VERSION_2"],"description":"Configure the MLD version. Corresponding CLI - ipv6 mld snooping querier version \u003c1-2\u003e VERSION_1 - MLDv1 snooping detects MLDv1 control packets and sets up traffic bridging based on IPv6 destination multicast addresses. MLDv1 supports three types of messages - Listener Queries, Multicast Listener Reports, Multicast Listener Done. VERSION_2 - MLDv2 basic snooping (MBSS) uses MLDv2 control packets to set up traffic forwarding based on IPv6 destination multicast addresses. MLDv2 supports MLDv2 queries and reports, as well as MLDv1 Report and Done messages."},"mldSnoopingVlanSettings":{"type":"object","properties":{"configType":{"type":"string","enum":["SET"],"description":"Type of MLD Snooping VLAN Settings."},"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","enum":["MLD_SNOOPING_VLAN"],"description":"Type of network functionality under a feature. Config type MLD_SNOOPING_VLAN is for configuring MLD snooping per VLAN."},"vlanId":{"type":"integer","description":"VLAN ID."},"isMldSnoopingEnabled":{"type":"boolean","description":"Enable MLD Snooping for a VLAN. Corresponding CLI - ipv6 mld snooping vlan \u003c1-4094\u003e."},"isImmediateLeaveEnabled":{"type":"boolean","description":"Enable immediate leave processing for MLDv1. Corresponding CLI - ipv6 mld snooping vlan \u003cvlan-id\u003e immediate-leave.default: false"},"isQuerierEnabled":{"type":"boolean","description":"Enable MLD querier for this VLAN. Corresponding CLI - ipv6 mld snooping vlan \u003cvlan-id\u003e querier."},"querierAddress":{"type":"string","description":"MLD querier source IP address. Corresponding CLI - ipv6 mld snooping vlan \u003cvlan-id\u003e querier address \u003csource-ipv6-address\u003e."},"querierQueryInterval":{"type":"integer","description":"Set the MLD querier query interval (in seconds). Corresponding CLI - ipv6 mld snooping vlan \u003cvlan-id\u003e querier query-interval \u003c1-18000\u003e."},"querierVersion":{"type":"string","enum":["VERSION_1","VERSION_2"],"description":"Configure MLD version. Corresponding CLI - ipv6 mld snooping vlan \u003cvlan-id\u003e querier version \u003c1-2\u003e VERSION_1 - MLDv1 snooping detects MLDv1 control packets and sets up traffic bridging based on IPv6 destination multicast addresses. MLDv1 supports three types of messages - Listener Queries, Multicast Listener Reports, Multicast Listener Done. VERSION_2 - MLDv2 basic snooping (MBSS) uses MLDv2 control packets to set up traffic forwarding based on IPv6 destination multicast addresses. MLDv2 supports MLDv2 queries and reports, as well as MLDv1 Report and Done messages."},"mldSnoopingVlanMrouters":{"type":"object","properties":{"configType":{"type":"string","enum":["SET"],"description":"Type of MLD Snooping Mrouter Settings."},"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","enum":["MLD_SNOOPING_VLAN_MROUTER"],"description":"Type of network functionality under a feature. Config type MLD_SNOOPING_VLAN_MROUTER is for configuring MLD snooping mrouter per VLAN."},"interfaceName":{"type":"string","description":"Mrouter interface name. The API /dna/intent/api/v1/interface/network-device/{deviceId} can be used to get the list of interfaces on a device.example: GigabitEthernet1/0/2"}}},"description":"MLD Snooping VLAN Mrouter configuration."}},"description":"MLD Snooping VLAN Mrouter configuration."}}},"description":"MLD Snooping per VLAN Configuration."}},"description":"Configure MLD Snooping characteristics for VLANs on a device."}}},"description":"Configure MLD Snooping global characteristics on a device."}},"description":""},"igmpSnoopingConfig":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","enum":["IGMP_SNOOPING_GLOBAL"],"description":"Type of network functionality under a feature. Config type IGMP_SNOOPING_GLOBAL is for configuring global IGMP snooping settings on a device."},"isIgmpSnoopingEnabled":{"type":"boolean","description":"Enable global IGMP Snooping. Corresponding CLI - ip igmp snooping.default: true"},"isQuerierEnabled":{"type":"boolean","description":"Enable IGMP Snooping Querier. Corresponding CLI - ip igmp snooping querier.default: false"},"querierAddress":{"type":"string","description":"Configure IGMP querier source IP address. Corresponding CLI - ip igmp snooping querier address \u003cip-address\u003e."},"querierQueryInterval":{"type":"integer","description":"Set the IGMP querier query interval (in seconds). Corresponding CLI - ip igmp snooping querier query-interval \u003c1-18000\u003e."},"querierVersion":{"type":"string","enum":["VERSION_1","VERSION_2","VERSION_3"],"description":"The switch supports IGMP version 1, IGMP version 2, and IGMP version 3. These versions are interoperable on the switch. For example, if IGMP snooping is enabled and the querier's version is IGMPv2, and the switch receives an IGMPv3 report from a host, then the switch can forward the IGMPv3 report to the multicast router. Corresponding CLI - ip igmp snooping querier version \u003c1-3\u003e. IGMP version 1 provides the basic query-response mechanism that allows the multicast device to determine which multicast groups are active and other processes that enable hosts to join and leave a multicast group. IGMP version 2 extends IGMP functionality by providing such features as the IGMP leave process to reduce leave latency, group-specific queries, and an explicit maximum query response time. IGMPv2 also adds the capability for routers to elect the IGMP querier without depending on the multicast protocol to perform this task. An IGMP version 3 switch supports Basic IGMPv3SnoopingSupport (BISS), which includes support for the snooping features on IGMPv1 and IGMPv2 switches and for IGMPv3 membership report messages. BISS constrains the flooding of multicast traffic when your network includes IGMPv3 hosts. It constrains traffic to approximately the same set of ports as the IGMP snooping feature on IGMPv2 or IGMPv1 hosts. An IGMPv3 switch can receive messages from and forward messages to a device running theSourceSpecific Multicast (SSM) feature."},"igmpSnoopingVlanSettings":{"type":"object","properties":{"configType":{"type":"string","enum":["SET"],"description":""},"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","enum":["IGMP_SNOOPING_VLAN"],"description":"Type of network functionality under a feature. Config type IGMP_SNOOPING_VLAN is for configuring IGMP snooping per VLAN."},"vlanId":{"type":"integer","description":"VLAN ID."},"isIgmpSnoopingEnabled":{"type":"boolean","description":"Enable IGMP Snooping for a VLAN. Corresponding CLI - ip igmp snooping vlan \u003c1-4094\u003e."},"isImmediateLeaveEnabled":{"type":"boolean","description":"Enable immediate leave processing for IGMPv2. Corresponding CLI - ip igmp snooping vlan \u003cvlan-id\u003e immediate-leave.default: false"},"isQuerierEnabled":{"type":"boolean","description":"Enable IGMP querier for this VLAN. Corresponding CLI - ip igmp snooping vlan \u003cvlan-id\u003e querier."},"querierAddress":{"type":"string","description":"IGMP querier source IP address. Corresponding CLI - ip igmp snooping vlan \u003cvlan-id\u003e querier address \u003cip-address\u003e."},"querierQueryInterval":{"type":"integer","description":"Set the IGMP querier query interval (in seconds). Corresponding CLI - ip igmp snooping vlan \u003cvlan-id\u003e querier query-interval \u003c1-18000\u003e."},"querierVersion":{"type":"string","enum":["VERSION_1","VERSION_2","VERSION_3"],"description":"The switch supports IGMP version 1, IGMP version 2, and IGMP version 3. These versions are interoperable on the switch. For example, if IGMP snooping is enabled and the querier's version is IGMPv2, and the switch receives an IGMPv3 report from a host, then the switch can forward the IGMPv3 report to the multicast router. Corresponding CLI - ip igmp snooping querier version \u003c1-3\u003e. IGMP version 1 provides the basic query-response mechanism that allows the multicast device to determine which multicast groups are active and other processes that enable hosts to join and leave a multicast group. IGMP version 2 extends IGMP functionality by providing such features as the IGMP leave process to reduce leave latency, group-specific queries, and an explicit maximum query response time. IGMPv2 also addsthe capability for routers to elect the IGMP querier without depending on the multicast protocol to perform this task. An IGMP version 3 switch supports Basic IGMPv3SnoopingSupport (BISS), which includes support for the snooping features on IGMPv1 and IGMPv2 switches and for IGMPv3 membership report messages. BISS constrains the flooding of multicast traffic when your network includes IGMPv3 hosts. It constrains traffic to approximately the same set of ports as the IGMP snooping feature on IGMPv2 or IGMPv1 hosts. An IGMPv3 switch can receive messages from and forward messages to a device running theSourceSpecific Multicast (SSM) feature."},"igmpSnoopingVlanMrouters":{"type":"object","properties":{"configType":{"type":"string","enum":["SET"],"description":"Type of IGMP Snooping Mrouter Settings."},"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","enum":["IGMP_SNOOPING_VLAN_MROUTER"],"description":"Type of network functionality under a feature. Config type IGMP_SNOOPING_VLAN_MROUTER is for configuring IGMP snooping mrouter per VLAN."},"interfaceName":{"type":"string","description":"Mrouter interface name. The API /dna/intent/api/v1/interface/network-device/{deviceId} can be used to get the list of interfaces on a device.example: GigabitEthernet1/0/2"}}},"description":"IGMP Snooping VLAN Mrouter Configuration."}},"description":"IGMP Snooping VLAN Mrouter Configuration."}}},"description":"IGMP Snooping per VLAN Configuration."}},"description":"Configure IGMP Snooping characteristics for VLANs on a device."}}},"description":"Configure IGMP Snooping global characteristics on a device."}},"description":""},"stpGlobalConfig":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","enum":["STP_GLOBAL"],"description":"Type of network functionality configured for STP. Config type STP_GLOBAL is for configuring the global settings for STP."},"stpMode":{"type":"string","enum":["PVST","RSTP","MST"],"description":"Configure the STP mode. Corresponding CLI - spanning-tree mode [mst | pvst | rapid-pvst]. PVST - Per-VLAN Spanning Tree (PVST) mode is based on the IEEE 802.1D standard and Cisco proprietary extensions. The PVST+ runs on each VLAN on the device up to the maximum supported, ensuring that each has a loop-free path through the network. RSTP - Rapid per-VLAN Spanning Tree Plus (RSTP) mode is the same as PVST+ except that is uses a rapid convergence based on the IEEE 802.1w standard. MST - Multiple Spanning Tree (MST) mode is based on the IEEE 802.1s standard. You can map multiple VLANs to the same spanning-tree instance, which reduces the number of spanning-tree instances that are required to support many VLANs."},"isBackboneFastEnabled":{"type":"boolean","description":"Enable BackboneFast to detect indirect link failures and to start the STP reconfiguration sooner than it would under normal spanning-tree rules. Corresponding CLI - spanning-tree backbonefast.default: false"},"isEtherChannelGuardEnabled":{"type":"boolean","description":"Enable EtherChannel guard to detect an EtherChannel misconfiguration between the switch and a connected device. A misconfiguration can occur if the switch interfaces are configured in an EtherChannel, but the interfaces on the other device are not. A misconfiguration can also occur if the channel parameters are not the same at both ends of the EtherChannel. Corresponding CLI - spanning-tree etherchannel guard misconfig.default: true"},"isExtendedSystemIdEnabled":{"type":"boolean","description":"Enable the extended-system ID updates the bridge IDs of all active Spanning Tree Protocol (STP) instances, which might change the spanning-tree topology. Corresponding CLI - spanning-tree extend system-id.default: true"},"isLoggingEnabled":{"type":"boolean","description":"Enable STP Logging . Corresponding CLI - spanning-tree logging.default: false"},"isLoopGuardEnabled":{"type":"boolean","description":"Configure loop guard to prevent alternate or root ports from becoming designated ports because of a failure that leads to a unidirectional link. Loop guard prevents alternate and root ports from becoming designated ports, and spanning tree does not send BPDUs on root or alternate ports. Corresponding CLI - spanning-tree loopguard default.default: false"},"portFastMode":{"type":"string","enum":["ENABLE","DISABLE","EDGE","NETWORK"],"description":"Configure portfast on ports so they are moved directly to STP forwarding state without waiting for the standard forward-time delay. Corresponding CLI - spanning-tree portfast default."},"isBpduFilterEnabled":{"type":"boolean","description":"Configure BPDU filtering. Enabling BPDU filtering on PortFast edge-enabled interfaces keeps those interfaces that are in a PortFast edge-operational state from sending or receiving BPDUs. Corresponding CLI - spanning-tree portfast bpdufilter default.default: false"},"isBpduGuardEnabled":{"type":"boolean","description":"Configure BPDU guard. Enabling BPDU filtering on PortFast edge-enabled interfaces spanning tree shuts down ports that are in a PortFast edge-operational state if any BPDU is received on them. Corresponding CLI - spanning-tree portfast bpduguard default.default: false"},"isUplinkFastEnabled":{"type":"boolean","description":"Configure UplinkFast which provides fast convergence after a direct link failure and achieves load-balancing between redundant Layer 2 links using uplink groups. Corresponding CLI - spanning-tree uplinkfast.default: false"},"transmitHoldCount":{"type":"integer","description":"Configure the BPDU burst size by changing the transmit hold count value. Corresponding CLI - spanning-tree transmit hold-count \u003c1-20\u003e.default: 6"},"uplinkFastMaxUpdateRate":{"type":"integer","description":"Configure the STP Uplink Fast Max Update Rate to change the rate at which update packets are sent. Corresponding CLI - spanning-tree uplinkfast max-update-rate \u003c0-32000\u003e."},"stpInstances":{"type":"object","properties":{"configType":{"type":"string","enum":["LIST"],"description":"Type of STP VLAN instances."},"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","enum":["STP_VLAN"],"description":"Type of network functionality under a feature. Config type STP_VLAN is for configuring the per VLAN settings for STP."},"vlanId":{"type":"integer","description":"VLAN ID for which STP is configured."},"priority":{"type":"integer","description":"Configure the device priority of a VLAN. Corresponding CLI - spanning-tree vlan \u003cvlan-id\u003e priority \u003c0-61440\u003e. default: 32768 multipleOf: 4096"},"timers":{"type":"object","properties":{"configType":{"type":"string","enum":["STP_TIMERS"],"description":"Type of network functionality under a feature. Config type STP_TIMERS is for configuring the per-VLAN timers for STP."},"forwardDelay":{"type":"integer","description":"Configures the maximum-aging time of a VLAN. The maximum-aging time is the number of seconds a switch waits without receiving spanning-tree configuration messages before attempting a reconfiguration. Corresponding CLI - spanning-tree vlan \u003cvlan-id\u003e max-age \u003c6-40\u003e."},"helloInterval":{"type":"integer","description":"Configure the hello time of a VLAN. The hello time is the time interval between configuration messages that are generated and sent by the root switch. These messages mean that the switch is alive. Corresponding CLI - spanning-tree vlan \u003cvlan-id\u003e hello-time \u003c1-10\u003e."},"maxAge":{"type":"integer","description":"Configure the maximum-aging time of a VLAN. The maximum-aging time is the number of seconds a switch waits without receiving spanning-tree configuration messages before attempting a reconfiguration. Corresponding CLI - spanning-tree vlan \u003cvlan-id\u003e max-age \u003c6-40\u003e.default: 20"},"isStpEnabled":{"type":"boolean","description":"Enable STP on the VLAN. Corresponding CLI - spanning-tree vlan \u003cvlan-id\u003e. default: true"}},"description":"Configure max age, hello interval and forward delay of a VLAN."}}},"description":""}},"description":"Configure STP characteristics of a VLAN."}}},"description":""}},"description":""},"stpInterfaceConfig":{"type":"object","properties":{"items":{"type":"object","properties":{"configType":{"type":"string","enum":["STP_INTERFACE"],"description":"Type of network functionality under a feature. Config type STP_INTERFACE is for configuring STP on an interface."},"interfaceName":{"type":"string","description":"Interface name. The API /intent/api/v1/interface/network-device/{deviceId} can be used to get the list of interfaces on a device.example: GigabitEthernet1/0/1"},"guardMode":{"type":"string","enum":["LOOP","ROOT","NONE"],"description":"Enable loop guard or root guard on the interface. Corresponding CLI - spanning-tree guard [loop | none | root]. LOOP - Enables loop guard on the interface. ROOT - Enables root guard on the interface"},"bpduFilter":{"type":"string","enum":["ENABLE","DISABLE","NONE"],"description":"Configure BPDU filtering on a port. Enabling BPDU filtering on PortFast edge-enabled port keeps the port from sending or receiving BPDUs. Corresponding CLI - spanning-tree bpduguard [enable | disable]."},"bpduGuard":{"type":"string","enum":["ENABLE","DISABLE","NONE"],"description":"Configures BPDU guard. When BPDU filtering is enabled on PortFast edge-enabled port, spanning tree shuts down the port if any BPDU is received on it."},"pathCost":{"type":"integer","description":"Configure the cost for an interface. Corresponding CLI - spanning-tree cost \u003c1-200000000\u003e."},"portFastMode":{"type":"string","enum":["NONE","DISABLE","EDGE","EDGE_TRUNK","NETWORK","TRUNK"],"description":"Configure the portFast mode for an interface. Corresponding CLI - spanning-tree portfast [disable | trunk | network | edge | edge trunk]. DISABLE - Disable portFast for this interface. EDGE - Enable edge behavior on a Layer 2 access port connected to an end workstation or server. EDGE_TRUNK - Enable edge behavior on a trunk port. Use this keyword if the link is a trunk. NETWORK - Configure the port as a network port. Ports that are connected to Layer 2 switches and bridges can be configured as network ports. If Bridge Assurance is enabled globally, it automatically gets enabled on a spanning tree network port. TRUNK - Enable portfast on a trunk port."},"priority":{"type":"integer","description":"Configures port priority for an interface. If a loop occurs, spanning tree uses port priority when selecting an interface to put into the forwarding state. Assign higher priority values (lower numerical values) to interfaces that you want selected first and lower priority values (higher numerical values) that you want selected last. If all interfaces have the same priority value, spanning tree puts the interface with the lowest interface number in the forwarding state and blocks the other interfaces. Corresponding CLI - spanning-tree port-priority \u003c0-240\u003e.multipleOf: 16"},"portVlanCostSettings":{"type":"object","properties":{"configType":{"type":"string","enum":["LIST"],"description":"Type of STP Cost Settings"},"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","enum":["STP_INTERFACE_VLAN_COST"],"description":"Type of network functionality under a feature. Config type STP_INTERFACE_VLAN_COST is for configuring per VLAN cost on an interface."},"cost":{"type":"integer","description":"Configure the cost for the VLANs. Corresponding CLI - spanning-tree vlan cost \u003c1-200000000\u003e."},"vlans":{"type":"string","description":"VLANs can be comma separated and/or a range like '2,4-5,7,10-20'."}}},"description":""}},"description":"Configure the cost for VLANs. If a loop occurs, spanning tree uses the path cost when selecting an interface to place into the forwarding state. A lower path cost represents higher-speed transmission."},"portVlanPrioritySettings":{"type":"object","properties":{"configType":{"type":"string","enum":["LIST"],"description":"Type of STP Priority Settings"},"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","enum":["STP_INTERFACE_VLAN_PRIORITY"],"description":""},"priority":{"type":"integer","description":"Configures the port priority for the VLANs. Corresponding CLI - spanning-tree vlan port-priority \u003c0-240\u003e.multipleOf: 16"},"vlans":{"type":"string","description":"VLANs can be comma separated and/or a range like '2,4-5,7,10-20'."}}},"description":""}},"description":"Configure the priority for VLANs."}},"description":"Configure STP settings of an interface."}},"description":""},"trunkInterfaceConfig":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","enum":["TRUNK_INTERFACE"],"description":"Type of network functionality under a feature. Config type TRUNK_INTERFACE is for configuring trunk settings on an interface."},"interfaceName":{"type":"string","description":"Interface name. The API /intent/api/v1/interface/network-device/{deviceId} can be used to get the list of interfaces on a device."},"isProtected":{"type":"boolean","description":"A protected port does not forward any traffic (unicast, multicast, or broadcast) to any other port that is also a protected port. Data traffic cannot be forwarded between protected ports at Layer 2; all data traffic passing between protected ports must be forwarded through a Layer 3 device. Forwarding behavior between a protected port and a non-protected port proceeds as usual. Corresponding CLI - switchport protected.default: false"},"isDtpNegotiationEnabled":{"type":"boolean","description":"Configure whether or not the interface supports negotiation of the trunk encapsulation. The switchport nonegotiate command is issued to prevent DTP (negotiation) packets from being sent out the interface. Corresponding CLI - switchport nonegotiate. default: true"},"pruneEligibleVlans":{"type":"string","description":"Configure the prune eligibility list. By default, all VLANs are allowed on a trunk and all VLANs (between 2 and 1001, inclusive) are eligible for pruning if pruning is enabled globally with the vtp pruning command. If a prune eligibility list is configured, then only those VLANs on the list are eligible for pruning. Corresponding CLI - switchport trunk pruning vlan [10, 20, 21-24 | none]."}}},"description":"Configure trunk settings of an interface."}},"description":""},"vlanConfig":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","enum":["VLAN"],"description":"Type of network functionality configured for VLAN. Config type VLAN is for configuring VLANs."},"vlanId":{"type":"integer","description":"VLAN ID is the identifier for a VLAN."},"name":{"type":"string","description":"Configure the name of the VLAN. VTP version VTPv1 and VTPv2 supports VLAN name of 32 character length, VTP version VTPv3 supports up to 128 characters. The recommended name length is 20 characters. If no name is entered for the VLAN, the default is to append the VLAN ID with leading zeros to the word VLAN. For example, VLAN0004 is a default VLAN name for VLAN 4. Corresponding CLI - name \u003cvlan-name\u003e. example: iot_vlan"},"isVlanEnabled":{"type":"boolean","description":"Enables or disables the VLAN switching. Corresponding CLI - shutdown. default: true"}}},"description":""}},"description":""},"vtpGlobalConfig":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","enum":["VTP_GLOBAL"],"description":"Type of network functionality configured for VTP. Config type VTP_GLOBAL is for configuring the global settings for VTP."},"mode":{"type":"string","enum":["SERVER","CLIENT","TRANSPARENT","OFF"],"description":"Configures the device for VTP mode. Corresponding CLI - vtp mode . SERVER - Any VLAN configuration changes in this mode are propagated to all devices in the VTP domain. VTP servers advertise their VLAN configurations to other devices in the same VTP domain and synchronize their VLAN configurations with other devices based on advertisements received over trunk links. CLIENT - VLANs cannot be configured in this mode but VTP updates are transmitted as well as received. TRANSPARENT - VLANs can be configured in this mode but the changes are not sent to other devices in the domain, and they affect only the individual device. VTP updates are not generated but the received updates are forwarded. However, in VTP version 2 or version 3, transparent devices do forward VTP advertisements that they receive from other devices. OFF - VLANs can be configured in this mode but VTP updates are neither generated nor forwarded."},"version":{"type":"string","enum":["VERSION_1","VERSION_2","VERSION_3"],"description":"Configures VTP version on the device. Corresponding CLI - vtp version. VERSION_2 supports unrecognized TLV. VERSION_3 supports primary and secondary servers, private VLANs, propagation of extended VLANs (VLAN IDs 1006-4094), propagation of Multiple Spanning Tree (MST) information. VTP domain name needs to be configured for VTP version 3."},"domainName":{"type":"string","description":"Configures the VTP administrative domain name. Global VLAN configuration changes are propagated to the devices that have the same VTP domain name. When the domain name is not specified, VLAN information is not propagated over the network. Once the domain name is configured, it cannot be deleted; it can only be changed. Devices in VTP transparent mode do not exchange VTP messages with other devices, so a VTP domain name does not need to be configured for them. Corresponding CLI - vtp domain \u003cdomain-name\u003e."},"isPruningEnabled":{"type":"boolean","description":"Enables pruning in the VTP administrative domain. VTP pruning blocks unneeded flooded traffic for prune-eligible VLANs on trunk ports. It increases network available bandwidth by restricting flooded traffic to those trunk links that the traffic must use to reach the destination devices. VLAN 1 and VLANs 1002 to 1005 are always pruning-ineligible; traffic from these VLANs cannot be pruned. Extended-range VLANs (VLAN IDs higher than 1005) are also pruning-ineligible. VTP pruning can be configured only on a VTP server. Corresponding CLI - vtp pruning.default: false"},"configurationFileName":{"type":"string","description":"Configures the ASCII filename of the IFS file system file where the VTP configuration is stored. By default, it is stored in the vlan.dat file. Corresponding CLI - vtp filename \u003cfile-name\u003e.example: flash:saved_vtp_config"},"sourceInterface":{"type":"string","description":"Configures an interface as the preferred source for VTP updates from this device. The IP address of the specified interface becomes the VTP IP updater address, and can be used to determine which VTP server last updated the VLAN database in the VTP domain. Corresponding CLI - vtp interface \u003cinterface-name\u003e.example: GigabitEthernet1/0/1"}}},"description":"Configure global VTP characteristics of a device."}},"description":""},"vtpInterfaceConfig":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","enum":["VTP_INTERFACE"],"description":"Type of network functionality under a feature. Config type VTP_INTERFACE is for configuring VTP in an interface."},"interfaceName":{"type":"string","description":"Interface name. The API /intent/api/v1/interface/network-device/{deviceId} can be used to get the list of interfaces on a device.example: GigabitEthernet1/0/1"},"isVtpEnabled":{"type":"boolean","description":"Enables or disables VTP per interface. When VTP is disabled on a trunk interface, it drops incoming VTP packets and prevents VTP advertisements on this particular trunk. Corresponding CLI - vtp. default: true"}}},"description":"Configure VTP settings on a per-port basis to control the VTP traffic on trunk interfaces."}},"description":""},"portChannelConfig":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","enum":["PORTCHANNEL"],"description":"Type of network functionality configured for Portchannel."},"isAutoEnabled":{"type":"boolean","description":"Enables the auto-LAG feature on a switch globally. Corresponding CLI - port-channel auto.default: false"},"loadBalancingMethod":{"type":"string","enum":["SRC_MAC","DST_MAC","SRC_DST_MAC","SRC_IP","DST_IP","SRC_DST_IP","SRC_PORT","DST_PORT","SRC_DST_PORT","SRC_DST_MIXED_IP_PORT","SRC_MIXED_IP_PORT","DST_MIXED_IP_PORT","VLAN_SRC_IP","VLAN_DST_IP","VLAN_SRC_DST_IP","VLAN_SRC_MIXED_IP_PORT","VLAN_DST_MIXED_IP_PORT","VLAN_SRC_DST_MIXED_IP_PORT"],"description":"Configures an EtherChannel load-balancing method. Corresponding CLI - port-channel load-balance ."},"lacpSystemPriority":{"type":"integer","description":"Configures the LACP system priority. Corresponding CLI - lacp system-priority \u003c0-65535\u003e."},"portchannels":{"type":"object","properties":{"configType":{"type":"string","enum":["SET"],"description":"Type of Portchannels."},"items":{"type":"array","items":{"type":"object","properties":{"AnyOf":{"type":"object","properties":{"EtherchannelConfig":{"type":"object","properties":{"configType":{"type":"string","enum":["ETHERCHANNEL_CONFIG"],"description":"Type of a Portchannel."},"name":{"type":"string","description":"Configures the channel group. Corresponding CLI - interface port-channel \u003c1-128\u003e."},"minLinks":{"type":"integer","description":"Specifies the minimum number of member ports that must be in the link-up state and bundled in the EtherChannel for the port channel interface to transition to the link-up state. Corresponding CLI - port-channel min-links \u003c2-8\u003e."},"memberPorts":{"type":"object","properties":{"configType":{"type":"string","enum":["SET"],"description":"Type of member ports"},"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","enum":["ETHERCHANNEL_MEMBER_PORT_CONFIG"],"description":"Type of network functionality configured for Etherchannel member port.default: ETHERCHANNEL_MEMBER_PORT_CONFIG"},"interfaceName":{"type":"string","description":""},"mode":{"type":"string","enum":["ON"],"description":""}}},"description":""}},"description":"Member ports of the Etherchannel. They must have compatible port characteristics, such as speed and duplex. Ports that are not compatible are suspended, even though they are configured in the Etherchannel on mode."}},"description":"Not a payload attribute, defined to represent EtherchannelConfig within anyOf "},"LacpPortchannelConfig":{"type":"object","properties":{"configType":{"type":"string","enum":["LACP_PORTCHANNEL_CONFIG"],"description":"Type of a Portchannel."},"name":{"type":"string","description":"Configures the channel group. Corresponding CLI - interface port-channel \u003c1-128\u003e."},"minLinks":{"type":"integer","description":"Specifies the minimum number of member ports that must be in the link-up state and bundled in the EtherChannel for the port channel interface to transition to the link-up state. Corresponding CLI - port-channel min-links \u003c2-8\u003e."},"memberPorts":{"type":"object","properties":{"configType":{"type":"string","enum":["SET"],"description":"Type of member ports"},"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","enum":["LACP_PORTCHANNEL_MEMBER_PORT_CONFIG"],"description":"Type of network functionality configured for LACP Portchannel member port."},"interfaceName":{"type":"string","description":"Interface name. The API /dna/intent/api/v1/interface/network-device/{deviceId} can be used to get the list of interfaces on a device."},"mode":{"type":"string","enum":["ACTIVE","PASSIVE"],"description":"Specify whether a port can send LACP packets or only receive LACP packets."},"portPriority":{"type":"integer","description":"Configures the LACP port priority. Corresponding CLI - lacp port-priority \u003c0-65535\u003e."},"rate":{"type":"integer","description":"Configures the rate at which LACP control packets are received by an LACP-supported interface. Corresponding CLI - lacp rate [fast| normal]."}}},"description":""}},"description":"Member ports of the LACP Portchannel."}},"description":"Not a payload attribute, defined to represent LacpPortchannelConfig within anyOf. LACP (Link Aggregation Control Protocol) Portchannel is formed using LACP, a IEEE 802.3ad protocol that facilitates dynamically grouping similarly configured ports into a single logical port."},"PagpPortchannelConfig":{"type":"object","properties":{"configType":{"type":"string","enum":["PAGP_PORTCHANNEL_CONFIG"],"description":"Type of a Portchannel."},"name":{"type":"string","description":"Configures the channel group. Corresponding CLI - interface port-channel \u003c1-128\u003e."},"minLinks":{"type":"integer","description":"Specifies the minimum number of member ports that must be in the link-up state and bundled in the EtherChannel for the port channel interface to transition to the link-up state. Corresponding CLI - port-channel min-links \u003c2-8\u003e."},"memberPorts":{"type":"object","properties":{"configType":{"type":"string","enum":["SET"],"description":"Type of member ports"},"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","enum":["PAGP_PORTCHANNEL_MEMBER_PORT_CONFIG"],"description":"Type of network functionality configured for Etherchannel member port."},"interfaceName":{"type":"string","description":"Interface name. The API /dna/intent/api/v1/interface/network-device/{deviceId} can be used to get the list of interfaces on a device."},"mode":{"type":"string","enum":["AUTO","AUTO_NON_SILENT","DESIRABLE","DESIRABLE_NON_SILENT"],"description":""},"portPriority":{"type":"integer","description":"Assigns a priority so that the selected port is chosen for packet transmission. Corresponding CLI - pagp port-priority \u003c0-255\u003e."},"learnMethod":{"type":"string","enum":["AGGREGATION_PORT","PHYSICAL_PORT"],"description":"Selects the PAgP learning method. Corresponding CLI - pagp learn-method [aggregation port | physical port]."}}},"description":"Pagp PortChannel MemberPortConfig"}},"description":"Member ports of the PAgP Portchannel."}},"description":"Not a payload attribute, defined to represent LacpPortchannelConfig within anyOf. PAgP (Port Aggregation Protocol) Portchannel is formed using PAgP, a Cisco-proprietary protocol that facilitates dynamically grouping similarly configured ports into a single logical port."}},"description":"Not a payload attribue, defined to represent anyOf structure"}}},"description":""}},"description":"PortchannelConfig Portchannels"}}},"description":"Configure portchannel on a wired device."}},"description":""},"switchportInterfaceConfig":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"configType":{"type":"string","enum":["SWITCHPORT_INTERFACE"],"description":"Type of network functionality under a feature. Config type SWITCHPORT_INTERFACE is for configuring switchport settings on an interface."},"interfaceName":{"type":"string","description":"Interface name. The API /intent/api/v1/interface/network-device/{deviceId} can be used to get the list of interfaces on a device.example: GigabitEthernet1/0/1"},"description":{"type":"string","description":"Configure the description of the interface. It cannot include non-ASCII characters. Corresponding CLI - description ."},"mode":{"type":"string","enum":["ACCESS","TRUNK","DYNAMIC_AUTO","DYNAMIC_DESIRABLE","DOT1Q_TUNNEL"],"description":"Set the administrative mode for the interface. Corresponding CLI - switchport mode [access | trunk | dynamic auto | dynamic desirable | dot1q-tunnel ]."},"accessVlan":{"type":"integer","description":"Set the VLAN for untagged traffic when the interface is in access mode. Corresponding CLI - switchport access vlan \u003c1-4094\u003e."},"voiceVlan":{"type":"integer","description":"Enable the access port to carry IP voice traffic from an IP phone. All voice traffic is on the specified VLAN. Corresponding CLI - switchport voice vlan \u003c1-4094\u003e."},"adminStatus":{"type":"string","enum":["UP","DOWN"],"description":"Configured the admin state of the interface as either 'UP' or 'DOWN'. Corresponding CLI - [no] shutdown.default: UP"},"trunkAllowedVlans":{"type":"string","description":"Configure the list of VLANs allowed on a trunk interface. Allowed VLANs should be between 1 and 4094. VLANs can be comma separated and/or a range like '2,4-5,7,10-20'. Corresponding CLI - switchport trunk allowed vlan [10, 20, 21-24 | all | none]."},"nativeVlan":{"type":"integer","description":"Set the native VLAN for IEEE 802.1Q trunks. Corresponding CLI - switchport trunk native vlan \u003c1-4094\u003e."}}},"description":"Configure switchport settings of an interface."}},"description":"This feature is for configuring switchport on interfaces."}},"description":"","$$ref":"#/components/schemas/CreateConfigurationsForAnIntendedLayerFeatureOnAWiredDeviceRequest"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"object","properties":{"taskId":{"type":"string","description":""},"url":{"type":"string","description":""}},"description":""},"version":{"type":"string","description":""}},"description":"","$$ref":"#/components/schemas/CreateConfigurationsForAnIntendedLayerFeatureOnAWiredDeviceResponse"}}}},"202":{"description":"Success Response.","content":{}},"400":{"description":"Invalid request error message. Example: {\"response\": { \"errorCode\": \"NCCO00000\", \"message\": \"Bad Request.\", \"detail\": \"Detail message.\" }, \"version\": \"1.0\"}.","content":{}},"404":{"description":"The requested resource not found error message.","content":{}},"500":{"description":"An Internal error message. Example: {\"response\": { \"errorCode\": \"NCCO00000\", \"message\": \"Internal Error Message.\", \"detail\": \"Detail message.\" }, \"version\": \"1.0\"}","content":{}}},"x-rapi-id":"a79a-8a2e-4598-8219","x-rapi-overview":"This API creates configurations for an intended feature on a wired device, if it hasn't been added earlier. nly the feature configurations to be changed need to be added to the intended features. Updates to intended features can be done over several iterations. When the intended features are deployed to a device using the API /dna/intent/api/v1/networkDevices/{id}/configFeatures/intended/deploy, they are applied on top of the existing configurations on the device. Any existing configurations on the device which are not included in the intended features, are retained on the device.","x-rapi-domain":"Connectivity","x-rapi-subdomain":"Wired","x-rapi-version":"1.0.0","x-rapi-internalPath":"/api/provisioning/v3/campus-automation/wired/networkDevices/${id}/configFeatures/intended/layer2/${feature}","x-rapi-publicPath":"/dna/intent/api/v1/wired/networkDevices/${id}/configFeatures/intended/layer2/${feature}","x-rapi-registerInKONG":true,"x-rapi-banner":[],"x-rapi-rateLimiting":"50~MINUTE","__originalOperationId":"createConfigurationsForAnIntendedLayer2FeatureOnAWiredDevice","method":"post","path":"/dna/intent/api/v1/wired/networkDevices/{id}/configFeatures/intended/layer2/{feature}"}}