cisco.catalystcenter.wired_network_devices_id_config_features_intended_layer2_feature module -- Resource module for Wired Network Devices Id Config Features Intended Layer2 Feature
Note
This module is part of the cisco.catalystcenter collection (version 2.11.0).
To install it, use: ansible-galaxy collection install cisco.catalystcenter.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.catalystcenter.wired_network_devices_id_config_features_intended_layer2_feature.
New in cisco.catalystcenter 2.2.0
Synopsis
Manage operations create, update and delete of the resource Wired Network Devices Id Config Features Intended Layer2 Feature. - > This API creates configurations for an intended feature on a wired device. Once all the updates to intended features are complete, they can be deployed to a device using the API /dna/intent/api/v1/networkDevices/{id}/configFeatures/intended/deploy. When the intended features are deployed, 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. - > This API deletes the configurations for an intended feature on a wired device. Once all the updates to intended features are complete, they can be deployed to a device using the API /dna/intent/api/v1/networkDevices/{id}/configFeatures/intended/deploy. When the intended features are deployed, 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. - > This API updates the configurations for an intended feature on a wired device. Updates to other intended features can be done over several iterations. Once all the updates to intended features are complete, they can be deployed to a device using the API /dna/intent/api/v1/networkDevices/{id}/configFeatures/intended/deploy. When the intended features are deployed, 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.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
catalystcentersdk >= 3.2.3.0.0
python >= 3.12
Parameters
Parameter |
Comments |
|---|---|
Flag for Cisco Catalyst Center SDK to enable debugging. Choices: |
|
The Cisco Catalyst Center hostname. |
|
The Cisco Catalyst Center password to authenticate. |
|
The Cisco Catalyst Center port. Default: :ansible-option-default:`443` |
|
The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"` |
|
Flag to enable or disable SSL certificate verification. Choices: |
|
Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"3.1.6.0"` |
|
This feature is for configuring CDP. Cisco Discovery Protocol (CDP) is a device discovery protocol that runs over Layer 2 on all Cisco devices and allows network management applications to discover Cisco devices that are neighbors of already known devices. A CDP-enabled device sends periodic messages to a multicast address, advertising at least one address at which it can receive SNMP messages. The advertisements also contain time-to-live, or holdtime information, which is the length of time a receiving device holds CDP information before discarding it. Each device also listens to the messages sent by other devices to learn about neighboring devices. |
|
Wired Network Devices Id Config Features Intended Layer2 Feature's items. |
|
Type of network functionality configured for CDP. Config type CDP_GLOBAL is for configuring the global settings for CDP. |
|
Specifies the amount of time a receiving device should hold the information sent by the device before discarding it. Corresponding CLI - cdp holdtime <10-255>. |
|
Configures CDP to send Version-2 advertisements. The default state is enabled. Corresponding CLI - cdp advertise-v2. Choices: |
|
Enables or disables CDP on the device. Corresponding CLI - cdp run. Default true. Choices: |
|
Configures the reporting of duplex mismatches generated by CDP for all Ethernet interfaces on the device. Corresponding CLI - cdp log mismatch. Duplex. Default true. Choices: |
|
Sets the transmission frequency of CDP updates in seconds. Corresponding CLI - cdp timer <5-254>. |
|
Configure CDP settings of an interface. |
|
Wired Network Devices Id Config Features Intended Layer2 Feature's items. |
|
Type of network functionality under a feature. Config type CDP_INTERFACE is for configuring CDP on an interface. |
|
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. |
|
Enables or disables CDP on the interface. Corresponding CLI - cdp enable. Default true. Choices: |
|
Configures the reporting of duplex mismatches generated by CDP for all Ethernet interfaces on the device. Corresponding CLI - cdp log mismatch duplex. Default true. Choices: |
|
This feature is for configuring DHCP Snooping, which secures networks by monitoring DHCP traffic, blocking unauthorized servers, and enhancing overall security. |
|
Wired Network Devices Id Config Features Intended Layer2 Feature's items. |
|
Type of network functionality under a feature. Config type DHCP_SNOOPING_GLOBAL is for configuring the global settings for DHCP snooping. |
|
Configure the settings for managing and maintaining the DHCP server's database remotely. |
|
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 . |
|
Type of network functionality under a feature. Config type DHCP_SNOOPING_DATABASE_AGENT is for configuring DHCP snooping database agent settings on a device. |
|
Specify the duration, in seconds, after which a configuration process will be automatically terminated. Corresponding CLI - ip dhcp snooping database timeout <0-86400>. |
|
Wired Network Devices Id Config Features Intended Layer2 Feature's writeDelay. |
|
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 . |
|
Enable DHCP snooping globally. Corresponding CLI - ip dhcp snooping.default false. Choices: |
|
Enable DHCP gleaning which allows components to register and glean only DHCP version 4 packets. Corresponding CLI - ip dhcp snooping glean.default false. Choices: |
|
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. |
|
This feature is for configuring DHCP Snooping on interfaces, ensuring secure and reliable IP address assignment by controlling packet filtering, rate limiting, logging, and violation actions. |
|
Wired Network Devices Id Config Features Intended Layer2 Feature's items. |
|
Type of network functionality under a feature. Config type DHCP_SNOOPING_INTERFACE is for configuring DHCP snooping on an interface. |
|
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. |
|
Enable Trusted Interface. Corresponding CLI - ip dhcp snooping trust. Choices: |
|
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 <= 100. Set the rate-limit as 0 to disable it. Corresponding CLI - ip dhcp snooping limit rate <1-2048>. |
|
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. |
|
Wired Network Devices Id Config Features Intended Layer2 Feature's items. |
|
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. |
|
Type of network functionality under a feature. Config type DOT1X_GLOBAL is for global 802.1x settings on a device. |
|
Globally enable 802.1x authentication on Switch. Corresponding CLI - dot1x system-auth-control. Default false. Choices: |
|
This feature is for configuring 802.1x on interfaces. |
|
Wired Network Devices Id Config Features Intended Layer2 Feature's items. |
|
Set the order of authentication methods used on a port. Corresponding CLI - authentication order dot1x | mab | webauth. |
|
Wired Network Devices Id Config Features Intended Layer2 Feature's configType. |
|
Array of Enums. DOT1X, MAB, WEBAUTH. |
|
Type of network functionality under a feature. Config type DOT1X_INTERFACE is for configuring 802.1x on an interface. |
|
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. |
|
Feature path parameter. Name of the feature to delete. |
|
Id path parameter. Network device ID of the wired device to configure. |
|
This feature is for configuring IGMP Snooping, which tracks which ports are attached to multicast-capable routers to help the routers forward IGMP membership reports. By default, IGMP snooping is enabled on the device. |
|
Wired Network Devices Id Config Features Intended Layer2 Feature's items. |
|
Type of network functionality under a feature. Config type IGMP_SNOOPING_GLOBAL is for configuring global IGMP snooping settings on a device. |
|
Configure IGMP Snooping characteristics for VLANs on a device. |
|
Wired Network Devices Id Config Features Intended Layer2 Feature's configType. |
|
IGMP Snooping per VLAN Configuration. |
|
Type of network functionality under a feature. Config type IGMP_SNOOPING_VLAN is for configuring IGMP snooping per VLAN. |
|
IGMP Snooping VLAN Mrouter Configuration. |
|
Type of IGMP Snooping Mrouter Settings. |
|
IGMP Snooping VLAN Mrouter Configuration. |
|
Type of network functionality under a feature. Config type IGMP_SNOOPING_VLAN_MROUTER is for configuring IGMP snooping mrouter per VLAN. |
|
Mrouter interface name. The API /dna/intent/api/v1/interface/network-devic... can be used to get the list of interfaces on a device.example GigabitEthernet1/0/2. |
|
Enable IGMP Snooping for a VLAN. Corresponding CLI - ip igmp snooping vlan <1-4094>. Choices: |
|
Enable immediate leave processing for IGMPv2. Corresponding CLI - ip igmp snooping vlan <vlan-id> immediate-leave.default false. Choices: |
|
Enable IGMP querier for this VLAN. Corresponding CLI - ip igmp snooping vlan <vlan-id> querier. Choices: |
|
IGMP querier source IP address. Corresponding CLI - ip igmp snooping vlan <vlan-id> querier address <ip-address>. |
|
Set the IGMP querier query interval (in seconds). Corresponding CLI - ip igmp snooping vlan <vlan-id> querier query-interval <1-18000>. |
|
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 <1-3>. 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. |
|
VLAN ID. |
|
Enable global IGMP Snooping. Corresponding CLI - ip igmp snooping.default true. Choices: |
|
Enable IGMP Snooping Querier. Corresponding CLI - ip igmp snooping querier.default false. Choices: |
|
Configure IGMP querier source IP address. Corresponding CLI - ip igmp snooping querier address <ip-address>. |
|
Set the IGMP querier query interval (in seconds). Corresponding CLI - ip igmp snooping querier query-interval <1-18000>. |
|
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 <1-3>. 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. |
|
This feature is for configuring LLDP. Link Layer Discovery Protocol (LLDP) is a protocol used to advertise and discover information about neighboring network devices on a local area network (LAN). LLDP allows devices to exchange information such as device capabilities, system information, and network connectivity details. |
|
Wired Network Devices Id Config Features Intended Layer2 Feature's items. |
|
Type of network functionality configured for LLDP. Config type LLDP_GLOBAL is for configuring the global settings for LLDP. |
|
Specifies the amount of time a receiving device should hold the information sent by the device before discarding it. Corresponding CLI - lldp holdtime $holdTime <0-32767>. |
|
Enables or disables LLDP on the device. Corresponding CLI - lldp run. Default true. Choices: |
|
Specifies the delay time in seconds for LLDP to initialize on any interface. Corresponding CLI - lldp reinit <2-5>. |
|
Sets the transmission frequency of LLDP updates in seconds. Corresponding CLI - lldp timer <5-32767>. |
|
This feature is for configuring LLDP on an interface. |
|
Wired Network Devices Id Config Features Intended Layer2 Feature's items. |
|
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. |
|
Type of network functionality under a feature. Config type LLDP_INTERFACE is for configuring LLDP on an interface. |
|
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. |
|
This feature is for configuring MAC Authentication Bypass (MAB), an alternative for devices that don't support 802.1X. The switch checks the MAC address of an endpoint with RADIUS server. |
|
Wired Network Devices Id Config Features Intended Layer2 Feature's items. |
|
Type of network functionality under a feature. Config type MAB_INTERFACE is for configuring MAB on an interface. |
|
Interface name. The API /intent/api/v1/interface/network-device/{deviceId} can be used to get the list of interfaces on a device. |
|
Enable MAC-based authentication on a port. Corresponding CLI - mab. Default false. Choices: |
|
This feature is for configuring MLD Snooping. Multicast Listener Discovery(MLD) is a protocol used by IPv6 multicast routersto discover the presence of multicast listeners (nodes wishing to receive IPv6 multicast packets) on the links that are directly attached to the routers and to discover which multicast packets are of interest to neighboring nodes. MLD snooping allows the switch to examine MLD packets and make forwarding decisions based on their content. |
|
Configure MLD Snooping global characteristics on a device. |
|
Type of network functionality under a feature. Config type MLD_SNOOPING_GLOBAL is for configuring MLD snooping settings on a device. |
|
Enable global MLD Snooping. Corresponding CLI - ipv6 mld snooping.default false. Choices: |
|
Enable MLD Snooping Querier. Corresponding CLI - ipv6 mld snooping querier.default false. Choices: |
|
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. Choices: |
|
Configure MLD Snooping characteristics for VLANs on a device. |
|
Type of MLD Snooping VLAN Settings. |
|
MLD Snooping per VLAN Configuration. |
|
Type of network functionality under a feature. Config type MLD_SNOOPING_VLAN is for configuring MLD snooping per VLAN. |
|
Enable immediate leave processing for MLDv1. Corresponding CLI - ipv6 mld snooping vlan <vlan-id> immediate-leave.default false. Choices: |
|
Enable MLD Snooping for a VLAN. Corresponding CLI - ipv6 mld snooping vlan <1-4094>. Choices: |
|
Enable MLD querier for this VLAN. Corresponding CLI - ipv6 mld snooping vlan <vlan-id> querier. Choices: |
|
MLD Snooping VLAN Mrouter configuration. |
|
Type of MLD Snooping Mrouter Settings. |
|
MLD Snooping VLAN Mrouter configuration. |
|
Type of network functionality under a feature. Config type MLD_SNOOPING_VLAN_MROUTER is for configuring MLD snooping mrouter per VLAN. |
|
Mrouter interface name. The API /dna/intent/api/v1/interface/network-devic... can be used to get the list of interfaces on a device.example GigabitEthernet1/0/2. |
|
MLD querier source IP address. Corresponding CLI - ipv6 mld snooping vlan <vlan-id> querier address <source-ipv6-address>. |
|
Set the MLD querier query interval (in seconds). Corresponding CLI - ipv6 mld snooping vlan <vlan-id> querier query-interval <1-18000>. |
|
Configure MLD version. Corresponding CLI - ipv6 mld snooping vlan <vlan-id> querier version <1-2> 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. |
|
VLAN ID. |
|
MLD querier source IP address. Corresponding CLI - ipv6 mld snooping querier address <source-ipv6-address>. |
|
Set the MLD querier query interval (in seconds). Corresponding CLI - ipv6 mld snooping querier query-interval <1-18000>. |
|
Configure the MLD version. Corresponding CLI - ipv6 mld snooping querier version <1-2> 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. |
|
This feature is for configuring port-channels on a wired device. Portchannel allows grouping of several physical Ethernet interfaces to create one logical Ethernet interface for the purpose of providing fault-tolerance and high-speed links between switches, routers, and servers. |
|
Wired Network Devices Id Config Features Intended Layer2 Feature's items. |
|
Type of network functionality configured for Portchannel. |
|
Enables the auto-LAG feature on a switch globally. Corresponding CLI - port-channel auto.default false. Choices: |
|
Configures the LACP system priority. Corresponding CLI - lacp system-priority <0-65535>. |
|
Configures an EtherChannel load-balancing method. Corresponding CLI - port-channel load-balance . |
|
PortchannelConfig Portchannels. |
|
Type of Portchannels. |
|
Wired Network Devices Id Config Features Intended Layer2 Feature's items. |
|
Not a payload attribue, defined to represent anyOf structure. |
|
Not a payload attribute, defined to represent EtherchannelConfig within anyOf. |
|
Type of a Portchannel. |
|
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. |
|
Type of member ports. |
|
Wired Network Devices Id Config Features Intended Layer2 Feature's items. |
|
Type of network functionality configured for Etherchannel member port.default ETHERCHANNEL_MEMBER_PORT_CONFIG. |
|
Wired Network Devices Id Config Features Intended Layer2 Feature's interfaceName. |
|
Wired Network Devices Id Config Features Intended Layer2 Feature's mode. |
|
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 <2-8>. |
|
Configures the channel group. Corresponding CLI - interface port-channel <1-128>. |
|
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. |
|
Type of a Portchannel. |
|
Member ports of the LACP Portchannel. |
|
Type of member ports. |
|
Wired Network Devices Id Config Features Intended Layer2 Feature's items. |
|
Type of network functionality configured for LACP Portchannel member port. |
|
Interface name. The API /dna/intent/api/v1/interface/network-devic... can be used to get the list of interfaces on a device. |
|
Specify whether a port can send LACP packets or only receive LACP packets. |
|
Configures the LACP port priority. Corresponding CLI - lacp port-priority <0-65535>. |
|
Configures the rate at which LACP control packets are received by an LACP-supported interface. Corresponding CLI - lacp rate fast| normal. |
|
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 <2-8>. |
|
Configures the channel group. Corresponding CLI - interface port-channel <1-128>. |
|
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. |
|
Type of a Portchannel. |
|
Member ports of the PAgP Portchannel. |
|
Type of member ports. |
|
Pagp PortChannel MemberPortConfig. |
|
Type of network functionality configured for Etherchannel member port. |
|
Interface name. The API /dna/intent/api/v1/interface/network-devic... can be used to get the list of interfaces on a device. |
|
Selects the PAgP learning method. Corresponding CLI - pagp learn-method aggregation port | physical port. |
|
Wired Network Devices Id Config Features Intended Layer2 Feature's mode. |
|
Assigns a priority so that the selected port is chosen for packet transmission. Corresponding CLI - pagp port-priority <0-255>. |
|
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 <2-8>. |
|
Configures the channel group. Corresponding CLI - interface port-channel <1-128>. |
|
This feature is for configuring Spanning Tree Protocol (STP), which provides path redundancy while preventing loops in the network. |
|
Wired Network Devices Id Config Features Intended Layer2 Feature's items. |
|
Type of network functionality configured for STP. Config type STP_GLOBAL is for configuring the global settings for STP. |
|
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. Choices: |
|
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. Choices: |
|
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. Choices: |
|
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. Choices: |
|
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. Choices: |
|
Enable STP Logging. Corresponding CLI - spanning-tree logging.default false. Choices: |
|
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. Choices: |
|
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. Choices: |
|
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. |
|
Configure STP characteristics of a VLAN. |
|
Type of STP VLAN instances. |
|
Wired Network Devices Id Config Features Intended Layer2 Feature's items. |
|
Type of network functionality under a feature. Config type STP_VLAN is for configuring the per VLAN settings for STP. |
|
Configure the device priority of a VLAN. Corresponding CLI - spanning-tree vlan <vlan-id> priority <0-61440>. Default 32768 multipleOf 4096. |
|
Configure max age, hello interval and forward delay of a VLAN. |
|
Type of network functionality under a feature. Config type STP_TIMERS is for configuring the per-VLAN timers for STP. |
|
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 <vlan-id> max-age <6-40>. |
|
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 <vlan-id> hello-time <1-10>. |
|
Enable STP on the VLAN. Corresponding CLI - spanning-tree vlan <vlan-id>. Default true. Choices: |
|
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 <vlan-id> max-age <6-40>.default 20. |
|
VLAN ID for which STP is configured. |
|
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. |
|
Configure the BPDU burst size by changing the transmit hold count value. Corresponding CLI - spanning-tree transmit hold-count <1-20>.default 6. |
|
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 <0-32000>. |
|
This feature is for configuring STP on interfaces. |
|
Wired Network Devices Id Config Features Intended Layer2 Feature's items. |
|
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. |
|
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. |
|
Type of network functionality under a feature. Config type STP_INTERFACE is for configuring STP on an interface. |
|
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. |
|
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. |
|
Configure the cost for an interface. Corresponding CLI - spanning-tree cost <1-200000000>. |
|
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. |
|
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. |
|
Type of STP Cost Settings. |
|
Wired Network Devices Id Config Features Intended Layer2 Feature's items. |
|
Type of network functionality under a feature. Config type STP_INTERFACE_VLAN_COST is for configuring per VLAN cost on an interface. |
|
Configure the cost for the VLANs. Corresponding CLI - spanning-tree vlan cost <1-200000000>. |
|
VLANs can be comma separated and/or a range like '2,4-5,7,10-20'. |
|
Configure the priority for VLANs. |
|
Type of STP Priority Settings. |
|
Wired Network Devices Id Config Features Intended Layer2 Feature's items. |
|
Wired Network Devices Id Config Features Intended Layer2 Feature's configType. |
|
Configures the port priority for the VLANs. Corresponding CLI - spanning-tree vlan port-priority <0-240>.multipleOf 16. |
|
VLANs can be comma separated and/or a range like '2,4-5,7,10-20'. |
|
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 <0-240>.multipleOf 16. |
|
This feature is for configuring switchport on interfaces. |
|
Wired Network Devices Id Config Features Intended Layer2 Feature's items. |
|
Set the VLAN for untagged traffic when the interface is in access mode. Corresponding CLI - switchport access vlan <1-4094>. |
|
Configured the admin state of the interface as either 'UP' or 'DOWN'. Corresponding CLI - no shutdown.default UP. |
|
Type of network functionality under a feature. Config type SWITCHPORT_INTERFACE is for configuring switchport settings on an interface. |
|
Configure the description of the interface. It cannot include non-ASCII characters. Corresponding CLI - 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. |
|
Set the administrative mode for the interface. Corresponding CLI - switchport mode access | trunk | dynamic auto | dynamic desirable | dot1q-tunnel . |
|
Set the native VLAN for IEEE 802.1Q trunks. Corresponding CLI - switchport trunk native vlan <1-4094>. |
|
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. |
|
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 <1-4094>. |
|
This feature is for trunk interface configurations on interfaces. |
|
Wired Network Devices Id Config Features Intended Layer2 Feature's items. |
|
Type of network functionality under a feature. Config type TRUNK_INTERFACE is for configuring trunk settings on an interface. |
|
Interface name. The API /intent/api/v1/interface/network-device/{deviceId} can be used to get the list of interfaces on a device. |
|
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. Choices: |
|
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. Choices: |
|
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. |
|
Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: |
|
This feature is for configuring VLANs. VLANs are switched networks that are logically segmented by function or application. |
|
Wired Network Devices Id Config Features Intended Layer2 Feature's items. |
|
Type of network functionality configured for VLAN. Config type VLAN is for configuring VLANs. |
|
Enables or disables the VLAN switching. Corresponding CLI - shutdown. Default true. Choices: |
|
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 <vlan-name>. Example iot_vlan. |
|
VLAN ID is the identifier for a VLAN. |
|
This feature is for configuring VTP. VLAN Trunking Protocol (VTP) is a Layer 2 messaging protocol that maintains VLAN configuration consistency by managing the addition, deletion, and renaming of VLANs on a network-wide basis. It can be used to make vlan configuration changes centrally on one or more devices and have those changes automatically communicated to all the other devices in the network. VTP does not work well in a situation where multiple updates to the VLANs occur simultaneously on devices in the same domain, which would result in an inconsistency in the VLAN database. With VTP, trunk ports must be configured on the device so that the device can send and receive VTP advertisements to and from other devices in the domain. |
|
Wired Network Devices Id Config Features Intended Layer2 Feature's items. |
|
Type of network functionality configured for VTP. Config type VTP_GLOBAL is for configuring the global settings for VTP. |
|
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 <file-name>.example flash saved_vtp_config. |
|
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 <domain-name>. |
|
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. Choices: |
|
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. |
|
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 <interface-name>.example GigabitEthernet1/0/1. |
|
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. |
|
Configure VTP settings on a per-port basis to control the VTP traffic on trunk interfaces. |
|
Configure VTP settings on a per-port basis to control the VTP traffic on trunk interfaces. |
|
Type of network functionality under a feature. Config type VTP_INTERFACE is for configuring VTP in an interface. |
|
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. |
|
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. Choices: |
Notes
Note
SDK Method used are wired.Wired.create_configurations_for_an_intended_layer2_feature_on_a_wired_device, wired.Wired.delete_configurations_for_an_intended_layer2_feature_on_a_wired_device, wired.Wired.update_configurations_for_an_intended_layer2_feature_on_a_wired_device,
Paths used are post /dna/intent/api/v1/wired/networkDevices/{id}/configFeatures/intended/layer2/{feature}, delete /dna/intent/api/v1/wired/networkDevices/{id}/configFeatures/intended/layer2/{feature}, put /dna/intent/api/v1/wired/networkDevices/{id}/configFeatures/intended/layer2/{feature},
Does not support
check_modeThe plugin runs on the control node and does not use any ansible connection plugins,
but instead uses the embedded connection manager from Cisco CATALYST SDK
Requires Python >= 3.10, matching the controller Python versions supported by the collection's minimum ansible-core version (see the collection README for the current ansible-core / Python compatibility range)
See Also
See also
- Cisco Catalyst Center documentation for Wired CreateConfigurationsForAnIntendedLayer2FeatureOnAWiredDevice
Complete reference of the CreateConfigurationsForAnIntendedLayer2FeatureOnAWiredDevice API.
- Cisco Catalyst Center documentation for Wired DeleteConfigurationsForAnIntendedLayer2FeatureOnAWiredDevice
Complete reference of the DeleteConfigurationsForAnIntendedLayer2FeatureOnAWiredDevice API.
- Cisco Catalyst Center documentation for Wired UpdateConfigurationsForAnIntendedLayer2FeatureOnAWiredDevice
Complete reference of the UpdateConfigurationsForAnIntendedLayer2FeatureOnAWiredDevice API.
Examples
---
- name: Delete by id
cisco.catalystcenter.wired_network_devices_id_config_features_intended_layer2_feature:
catalystcenter_host: "{{catalystcenter_host}}"
catalystcenter_username: "{{catalystcenter_username}}"
catalystcenter_password: "{{catalystcenter_password}}"
catalystcenter_verify: "{{catalystcenter_verify}}"
catalystcenter_port: "{{catalystcenter_port}}"
catalystcenter_version: "{{catalystcenter_version}}"
catalystcenter_debug: "{{catalystcenter_debug}}"
state: absent
feature: string
id: string
- name: Update by id
cisco.catalystcenter.wired_network_devices_id_config_features_intended_layer2_feature:
catalystcenter_host: "{{catalystcenter_host}}"
catalystcenter_username: "{{catalystcenter_username}}"
catalystcenter_password: "{{catalystcenter_password}}"
catalystcenter_verify: "{{catalystcenter_verify}}"
catalystcenter_port: "{{catalystcenter_port}}"
catalystcenter_version: "{{catalystcenter_version}}"
catalystcenter_debug: "{{catalystcenter_debug}}"
state: present
cdpGlobalConfig:
items:
- configType: string
holdTime: 0
isAdvertiseV2Enabled: true
isCdpEnabled: true
isLogDuplexMismatchEnabled: true
timer: 0
cdpInterfaceConfig:
items:
- configType: string
interfaceName: string
isCdpEnabled: true
isLogDuplexMismatchEnabled: true
dhcpSnoopingGlobalConfig:
items:
- configType: string
databaseAgent:
agentUrl: string
configType: string
timeout: 0
writeDelay: 0
dhcpSnoopingVlans: string
isDhcpSnoopingEnabled: true
isGleaningEnabled: true
proxyBridgeVlans: string
dhcpSnoopingInterfaceConfig:
items:
- configType: string
interfaceName: string
isTrustedInterface: true
messageRateLimit: 0
dot1xGlobalConfig:
items:
- authenticationConfigMode: string
configType: string
isDot1xEnabled: true
dot1xInterfaceConfig:
items:
- authenticationOrder:
configType: string
items:
- string
configType: string
interfaceName: string
feature: string
id: string
igmpSnoopingGlobalConfig:
items:
- configType: string
igmpSnoopingVlanSettings:
configType: string
items:
- configType: string
igmpSnoopingVlanMrouters:
configType: string
items:
- configType: string
interfaceName: string
isIgmpSnoopingEnabled: true
isImmediateLeaveEnabled: true
isQuerierEnabled: true
querierAddress: string
querierQueryInterval: 0
querierVersion: string
vlanId: 0
isIgmpSnoopingEnabled: true
isQuerierEnabled: true
querierAddress: string
querierQueryInterval: 0
querierVersion: string
lldpGlobalConfig:
items:
- configType: string
holdTime: 0
isLldpEnabled: true
reinitializationDelay: 0
timer: 0
lldpInterfaceConfig:
items:
- adminStatus: string
configType: string
interfaceName: string
mabInterfaceConfig:
items:
- configType: string
interfaceName: string
isMabEnabled: true
mldSnoopingGlobalConfig:
items:
- configType: string
isMldSnoopingEnabled: true
isQuerierEnabled: true
isSuppressListenerMessagesEnabled: true
mldSnoopingVlanSettings:
configType: string
items:
- configType: string
isImmediateLeaveEnabled: true
isMldSnoopingEnabled: true
isQuerierEnabled: true
mldSnoopingVlanMrouters:
configType: string
items:
- configType: string
interfaceName: string
querierAddress: string
querierQueryInterval: 0
querierVersion: string
vlanId: 0
querierAddress: string
querierQueryInterval: 0
querierVersion: string
portChannelConfig:
items:
- configType: string
isAutoEnabled: true
lacpSystemPriority: 0
loadBalancingMethod: string
portchannels:
configType: string
items:
- AnyOf:
EtherchannelConfig:
configType: string
memberPorts:
configType: string
items:
- configType: string
interfaceName: string
mode: string
minLinks: 0
name: string
LacpPortchannelConfig:
configType: string
memberPorts:
configType: string
items:
- configType: string
interfaceName: string
mode: string
portPriority: 0
rate: 0
minLinks: 0
name: string
PagpPortchannelConfig:
configType: string
memberPorts:
configType: string
items:
- configType: string
interfaceName: string
learnMethod: string
mode: string
portPriority: 0
minLinks: 0
name: string
stpGlobalConfig:
items:
- configType: string
isBackboneFastEnabled: true
isBpduFilterEnabled: true
isBpduGuardEnabled: true
isEtherChannelGuardEnabled: true
isExtendedSystemIdEnabled: true
isLoggingEnabled: true
isLoopGuardEnabled: true
isUplinkFastEnabled: true
portFastMode: string
stpInstances:
configType: string
items:
- configType: string
priority: 0
timers:
configType: string
forwardDelay: 0
helloInterval: 0
isStpEnabled: true
maxAge: 0
vlanId: 0
stpMode: string
transmitHoldCount: 0
uplinkFastMaxUpdateRate: 0
stpInterfaceConfig:
items:
bpduFilter: string
bpduGuard: string
configType: string
guardMode: string
interfaceName: string
pathCost: 0
portFastMode: string
portVlanCostSettings:
configType: string
items:
- configType: string
cost: 0
vlans: string
portVlanPrioritySettings:
configType: string
items:
- configType: string
priority: 0
vlans: string
priority: 0
switchportInterfaceConfig:
items:
- accessVlan: 0
adminStatus: string
configType: string
description: string
interfaceName: string
mode: string
nativeVlan: 0
trunkAllowedVlans: string
voiceVlan: 0
trunkInterfaceConfig:
items:
- configType: string
interfaceName: string
isDtpNegotiationEnabled: true
isProtected: true
pruneEligibleVlans: string
vlanConfig:
items:
- configType: string
isVlanEnabled: true
name: string
vlanId: 0
vtpGlobalConfig:
items:
- configType: string
configurationFileName: string
domainName: string
isPruningEnabled: true
mode: string
sourceInterface: string
version: string
vtpInterfaceConfig:
items:
- configType: string
interfaceName: string
isVtpEnabled: true
- name: Create
cisco.catalystcenter.wired_network_devices_id_config_features_intended_layer2_feature:
catalystcenter_host: "{{catalystcenter_host}}"
catalystcenter_username: "{{catalystcenter_username}}"
catalystcenter_password: "{{catalystcenter_password}}"
catalystcenter_verify: "{{catalystcenter_verify}}"
catalystcenter_port: "{{catalystcenter_port}}"
catalystcenter_version: "{{catalystcenter_version}}"
catalystcenter_debug: "{{catalystcenter_debug}}"
state: present
cdpGlobalConfig:
items:
- configType: string
holdTime: 0
isAdvertiseV2Enabled: true
isCdpEnabled: true
isLogDuplexMismatchEnabled: true
timer: 0
cdpInterfaceConfig:
items:
- configType: string
interfaceName: string
isCdpEnabled: true
isLogDuplexMismatchEnabled: true
dhcpSnoopingGlobalConfig:
items:
- configType: string
databaseAgent:
agentUrl: string
configType: string
timeout: 0
writeDelay: 0
dhcpSnoopingVlans: string
isDhcpSnoopingEnabled: true
isGleaningEnabled: true
proxyBridgeVlans: string
dhcpSnoopingInterfaceConfig:
items:
- configType: string
interfaceName: string
isTrustedInterface: true
messageRateLimit: 0
dot1xGlobalConfig:
items:
- authenticationConfigMode: string
configType: string
isDot1xEnabled: true
dot1xInterfaceConfig:
items:
- authenticationOrder:
configType: string
items:
- string
configType: string
interfaceName: string
feature: string
id: string
igmpSnoopingGlobalConfig:
items:
- configType: string
igmpSnoopingVlanSettings:
configType: string
items:
- configType: string
igmpSnoopingVlanMrouters:
configType: string
items:
- configType: string
interfaceName: string
isIgmpSnoopingEnabled: true
isImmediateLeaveEnabled: true
isQuerierEnabled: true
querierAddress: string
querierQueryInterval: 0
querierVersion: string
vlanId: 0
isIgmpSnoopingEnabled: true
isQuerierEnabled: true
querierAddress: string
querierQueryInterval: 0
querierVersion: string
lldpGlobalConfig:
items:
- configType: string
holdTime: 0
isLldpEnabled: true
reinitializationDelay: 0
timer: 0
lldpInterfaceConfig:
items:
- adminStatus: string
configType: string
interfaceName: string
mabInterfaceConfig:
items:
- configType: string
interfaceName: string
isMabEnabled: true
mldSnoopingGlobalConfig:
items:
- configType: string
isMldSnoopingEnabled: true
isQuerierEnabled: true
isSuppressListenerMessagesEnabled: true
mldSnoopingVlanSettings:
configType: string
items:
- configType: string
isImmediateLeaveEnabled: true
isMldSnoopingEnabled: true
isQuerierEnabled: true
mldSnoopingVlanMrouters:
configType: string
items:
- configType: string
interfaceName: string
querierAddress: string
querierQueryInterval: 0
querierVersion: string
vlanId: 0
querierAddress: string
querierQueryInterval: 0
querierVersion: string
portChannelConfig:
items:
- configType: string
isAutoEnabled: true
lacpSystemPriority: 0
loadBalancingMethod: string
portchannels:
configType: string
items:
- AnyOf:
EtherchannelConfig:
configType: string
memberPorts:
configType: string
items:
- configType: string
interfaceName: string
mode: string
minLinks: 0
name: string
LacpPortchannelConfig:
configType: string
memberPorts:
configType: string
items:
- configType: string
interfaceName: string
mode: string
portPriority: 0
rate: 0
minLinks: 0
name: string
PagpPortchannelConfig:
configType: string
memberPorts:
configType: string
items:
- configType: string
interfaceName: string
learnMethod: string
mode: string
portPriority: 0
minLinks: 0
name: string
stpGlobalConfig:
items:
- configType: string
isBackboneFastEnabled: true
isBpduFilterEnabled: true
isBpduGuardEnabled: true
isEtherChannelGuardEnabled: true
isExtendedSystemIdEnabled: true
isLoggingEnabled: true
isLoopGuardEnabled: true
isUplinkFastEnabled: true
portFastMode: string
stpInstances:
configType: string
items:
- configType: string
priority: 0
timers:
configType: string
forwardDelay: 0
helloInterval: 0
isStpEnabled: true
maxAge: 0
vlanId: 0
stpMode: string
transmitHoldCount: 0
uplinkFastMaxUpdateRate: 0
stpInterfaceConfig:
items:
bpduFilter: string
bpduGuard: string
configType: string
guardMode: string
interfaceName: string
pathCost: 0
portFastMode: string
portVlanCostSettings:
configType: string
items:
- configType: string
cost: 0
vlans: string
portVlanPrioritySettings:
configType: string
items:
- configType: string
priority: 0
vlans: string
priority: 0
switchportInterfaceConfig:
items:
- accessVlan: 0
adminStatus: string
configType: string
description: string
interfaceName: string
mode: string
nativeVlan: 0
trunkAllowedVlans: string
voiceVlan: 0
trunkInterfaceConfig:
items:
- configType: string
interfaceName: string
isDtpNegotiationEnabled: true
isProtected: true
pruneEligibleVlans: string
vlanConfig:
items:
- configType: string
isVlanEnabled: true
name: string
vlanId: 0
vtpGlobalConfig:
items:
- configType: string
configurationFileName: string
domainName: string
isPruningEnabled: true
mode: string
sourceInterface: string
version: string
vtpInterfaceConfig:
items:
- configType: string
interfaceName: string
isVtpEnabled: true
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A dictionary or list with the response returned by the Cisco Catalyst Center Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}` |