cisco.catalystcenter.switches_configs_intended_port_create module -- Resource module for Switches Configs Intended Port Create
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.switches_configs_intended_port_create.
New in cisco.catalystcenter 2.11.0
Synopsis
Manage operation create of the resource Switches Configs Intended Port Create. - > This API creates configurations for an intended feature on a switch. Once all the updates to intended features are complete, they can be deployed to a device using the API /api/v1/switches/{id}/configs/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. The device config learning must have enabled for the switch using the API /dna/campus/api/v1/switches/configs/deployed/enable and Error code NCCO15475 can be observed if not enabled.
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 ethernet interface config on device. |
|
Switches Configs Intended Port Create's items. |
|
Name of the IPv6 access list for traffic filtering, used to control IPv6 packet flow. Derived From - The available IPv6 access list names include IPv6 Named ACL configurations from the current profile and the device. Unconfigure Value - use "" to unconfigure. |
|
Specifies the direction (in, out, both) for applying access session controls on the interface. This determines which traffic flows are subject to session policies. Unconfigure Value - use BOTH (default value) to revert to default settings. |
|
Defines the host mode for access sessions, such as single-host, multi-host, multi-auth, or multi-domain. This controls how many endpoints can authenticate on the interface. Unconfigure Value - use MULTI_AUTH (default value) to revert to default settings. |
|
Access-session host-mode values. |
|
Sets the port control mode for access sessions (auto, force-authorized, force-unauthorized). Determines how the port responds to authentication status. Unconfigure Value - use FORCE_AUTHORIZED (default value) to revert to default settings. |
|
VLAN ID for switchport access mode. Assigns the interface to a specific VLAN for untagged traffic. Derived From - The available VLAN IDs include VLAN configurations from the current profile and the device, always including VLAN 1. Unconfigure Value - use 1 to revert to default settings. Restrictions â Access VLAN must refer to a VLAN. The VLAN must exist in the Layer 2 profile or on the device. |
|
Specifies the direction (in, out) for 802.1X authentication control. This determines which traffic direction is subject to authentication policies. Unconfigure Value - use BOTH to revert to default settings. |
|
Defines the host mode for 802.1X authentication, such as single-host, multi-host, multi-auth, or multi-domain. Controls how many devices can authenticate on the port. Unconfigure Value - use SINGLE_HOST to revert to default settings. |
|
Specifies the inactivity timeout value in seconds for 802.1X authentication. Devices inactive for this period will be deauthenticated. Unconfigure Value - use 0 to revert to default settings. |
|
Sets the port control mode for 802.1X authentication (auto, force-authorized, force-unauthorized). Determines port behavior based on authentication status. Unconfigure Value - use FORCE_AUTHORIZED to revert to default settings. |
|
Number of missed BFD packets before declaring a failure. Higher values increase tolerance to missed packets. Unconfigure Value - use 3 to revert to default settings. |
|
Minimum interval in milliseconds between received BFD packets. Controls how quickly the interface detects failures. |
|
Interval in milliseconds for sending BFD packets. Adjusts the frequency of BFD monitoring on the interface. Unconfigure Value - use 0 to unconfigure. |
|
Name of the BFD template applied to the interface, allowing standardized BFD configuration across multiple interfaces. Derived From - The available BFD template names include BFD Template Single Hop configurations from the current profile and the device. Unconfigure Value - use "" to unconfigure. |
|
Sets the mode for channel group configuration (active, passive, on). Determines how the interface participates in EtherChannel formation. Unconfigure Value - use NONE to unconfigure. |
|
Specifies the channel group number for EtherChannel configuration, grouping multiple interfaces for increased bandwidth and redundancy. Unconfigure Value - use 0 to unconfigure. Derived From - The available port channel numbers include PortChannel configurations from the current profile and the device. |
|
Defines the protocol used for channel group formation (lacp, pagp, none). Controls how interfaces negotiate EtherChannel membership. Unconfigure Value - use NONE to unconfigure. |
|
Prefix name, truncated to 200 characters. Unconfigure Value - use "" to unconfigure. |
|
Type of network functionality under a feature. Config type ETHERNET_INTERFACE_CONFIG is for configuring high-speed data transmission over Ethernet using full duplex and extensive flow control capabilities. |
|
Text description for the interface, used for documentation and identification in network management. |
|
Device tracking policy configuration for the interface. |
|
Switches Configs Intended Port Create's configType. |
|
Switches Configs Intended Port Create's items. |
|
Type of network functionality under a feature. Config type ETHERNET_INTERFACE_DEVICE_TRACKING_POLICY_CONFIG is for configuring policies and parameters that manage and ensure the tracking and monitoring of devices connected through Gigabit Ethernet to enhance network security and efficiency. |
|
Specifies the name of the device tracking policy attached to the interface, controlling how device tracking is enforced. Restrictions â Create policy first, then attach policy to the port. |
|
Specifies the maximum number of DHCP packets per second allowed on the interface, protecting against DHCP floods. Unconfigure Value - use 0 to unconfigure. |
|
Direction for access list application. |
|
Helper Address. |
|
Switches Configs Intended Port Create's configType. |
|
Switches Configs Intended Port Create's items. |
|
Type of network functionality under a feature. Config type ETHERNET_INTERFACE_HELPER_ADDRESS is for configuring the IP addresses that the device uses as the next hop to forward DHCP requests to a designated DHCP server. |
|
IPv4 address of the DHCP relay (helper) server, used to forward DHCP requests to remote servers. |
|
Specifies the name or identifier for the interface, used for configuration and management. |
|
Specify value for hostname option. Unconfigure Value - use "" to unconfigure. |
|
Name of the ACL applied inbound on the interface, used to filter incoming traffic based on access control rules. Derived From - The available ACL names include standard and extended access list configurations from the current profile and the device. Unconfigure Value - use "" to unconfigure. |
|
Name of the ACL applied outbound on the interface, used to filter outgoing traffic based on access control rules. Derived From - The available ACL names include standard and extended access list configurations from the current profile and the device. Unconfigure Value - use "" to unconfigure. |
|
Specifies the VRF name for interface IP forwarding, enabling logical network segmentation. Derived From - The available VRF names include IPv4 VRF configurations from the current profile and the device. Unconfigure Value - use "" to unconfigure. |
|
DHCP Relay Destination Address. Restrictions â IPv6 must be enabled within IPv4/IPv6 vrfs to configure IPv6 DHCP Relay Destination Addresses. |
|
Switches Configs Intended Port Create's configType. |
|
Switches Configs Intended Port Create's items. |
|
Type of network functionality under a feature. Config type ETHERNET_INTERFACE_IPV6_DHCP_RELAY_DEST_ADDRESS is for configuring the destination IPv6 address to which DHCP relay messages are forwarded in a Gigabit Ethernet network. |
|
IPv6 address of the DHCP relay destination, used to forward DHCPv6 requests. |
|
IPv6 DHCP relay global destination address configuration for the interface. |
|
Switches Configs Intended Port Create's configType. |
|
Switches Configs Intended Port Create's items. |
|
Type of network functionality under a feature. Config type ETHERNET_INTERFACE_IPV6_DHCP_RELAY_DEST_GLOBAL is for configuring the destination IPv6 address to which DHCP relay messages are forwarded in a Gigabit Ethernet network. |
|
Global IPv6 address for DHCP relay destination, used for forwarding DHCPv6 messages. |
|
IPv6 link-local address assigned to the interface, used for local network communication. Supported IOS-XE versions - This property is viewable only (read-only) on Cisco switches running IOS version earlier than 17.18.1. Since IOS version 17.18.1 or later, configuration for this property is supported. Unconfigure Value - use "" to unconfigure. Restrictions â IPv6 must be enabled within IPv4/IPv6 VRFs to configure IPv6 Link Local Addresses or IPv6 Link Local Addresses should be removed. |
|
IPv6 Prefix Addresses. Restrictions â IPv6 must be enabled within IPv4/IPv6 VRFs to configure IPv6 Prefix Addresses or IPv6 Prefix Addresses should be removed. |
|
Switches Configs Intended Port Create's configType. |
|
Switches Configs Intended Port Create's items. |
|
Type of network functionality under a feature. Config type ETHERNET_INTERFACE_IPV6_PREFIX_LIST is for configuring IPv6 prefix lists on Ethernet interfaces. |
|
IPv6 Prefix. |
|
IPv6 traffic filter configuration for the interface. |
|
Switches Configs Intended Port Create's configType. |
|
Switches Configs Intended Port Create's items. |
|
Name of the IPv6 access list for traffic filtering, used to control IPv6 packet flow. Derived From - The available IPv6 access list names include IPv6 Named ACL configurations from the current profile and the device. Unconfigure Value - use "" to unconfigure. |
|
Type of network functionality under a feature. Config type ETHERNET_INTERFACE_IPV6_TRAFFIC_FILTER is for configuring IPv6 traffic filtering on Ethernet interfaces. |
|
Specifies the direction (in, out) for IPv6 traffic filtering on the interface. |
|
Enables closed mode for access sessions on the interface. In closed mode, the interface restricts access until authentication is successful. Access). Choices: |
|
Marks the interface as trusted for ARP inspection, exempting it from ARP security checks. Unconfigure Value - use false to unconfigure. Choices: |
|
Enables dynamic inactivity timer for 802.1X authentication, allowing the server to adjust inactivity timeouts based on network conditions. Unconfigure Value - use false to revert to default settings. Choices: |
|
Enables open mode for 802.1X authentication, allowing unauthenticated access to the network while still monitoring authentication attempts. Unconfigure Value - use false to unconfigure. Choices: |
|
Enables Bidirectional Forwarding Detection (BFD) on the interface for rapid detection of link failures and improved network resiliency. Choices: |
|
Enable or disable BFD interval configuration. Unconfigure Value - use false to unconfigure. |
|
Enables Cisco Discovery Protocol (CDP) on the interface, allowing the device to advertise and discover neighboring Cisco devices. Unconfigure Value - use true to revert to default settings. Restrictions â CDP can be enabled at port level only when global CDP is enabled. Choices: |
|
Specifies the application name for the default WRP TLV in CDP advertisements, used for device identification and management. Unconfigure Value - use true to revert to default settings. Choices: |
|
Enables or disables device tracking on the interface, allowing the system to monitor and manage connected devices. Unconfigure Value - use false to revert to default settings. Choices: |
|
Enables DHCP for automatic IP address assignment on the interface, allowing dynamic address configuration. Unconfigure Value - use false to revert to default settings. Restrictions â IPv4 must be enabled within IPv4/IPv6 VRFs to configure IPv4 Address via DHCP or IPv4 Address via DHCP must be disabled. Choices: |
|
Marks the interface as trusted for DHCP snooping, allowing DHCP messages to pass without restriction. Unconfigure Value - use false to revert to default settings. Choices: |
|
Enables MAC Authentication Bypass (MAB) in the authentication order, allowing devices without 802.1X support to authenticate using their MAC address. Unconfigure Value - use false to unconfigure. Choices: |
|
Sets the priority for MAC Authentication Bypass (MAB) in the authentication process, determining if MAB is preferred over other methods. Unconfigure Value - use false to unconfigure. Choices: |
|
Enables IPv6 address autoconfiguration on the interface, allowing automatic assignment of IPv6 addresses. Unconfigure Value - use false to unconfigure. Restrictions â IPv6 must be enabled within IPv4/IPv6 VRF Name to configure IPv6 Address Autoconfig or IPv6 Address Autoconfig must be disabled. Choices: |
|
Enables DHCPv6 for automatic IPv6 address assignment on the interface. Unconfigure Value - use false to revert to default settings. Choices: |
|
Enables IPv6 processing on the interface, allowing IPv6 traffic and configuration. Unconfigure Value - use false (default value) to revert to default settings. Restrictions â IPv6 must be enabled within IPv4/IPv6 VRF Name to configure Port IPv6 or Port IPv6 must be disabled. Choices: |
|
Enables EAP authentication for MAB, providing additional authentication options for MAC-based access. Choices: |
|
Enables MAC Authentication Bypass (MAB) on the interface, allowing devices to authenticate using their MAC address. Unconfigure Value - use false to unconfigure. Choices: |
|
Authentication method webauth allowed. Unconfigure Value - use false to unconfigure. Choices: |
|
Enables periodic reauthentication for 802.1X, requiring devices to re-authenticate at regular intervals to maintain network access. Unconfigure Value - use false to revert to default settings. Choices: |
|
Enables port security on the interface. Port security restricts access based on MAC addresses to enhance network security. Unconfigure Value - use false to revert to default settings. Choices: |
|
Enables server-based reauthentication timer for 802.1X, allowing the authentication server to control reauthentication intervals. Unconfigure Value - use false to unconfigure. Choices: |
|
Disables the interface (administratively down), preventing traffic flow. Unconfigure Value - use false (default value) to revert to default settings. Choices: |
|
Marks the interface as trusted for manual CTS static policy, exempting it from certain security checks. Unconfigure Value - use false to revert to default settings. Choices: |
|
Enables shutdown action for storm control violations. If a traffic storm is detected, the interface will be shut down to protect the network. Unconfigure Value - use false to revert to default settings. Choices: |
|
Enables SNMP trap notification for storm control violations. This allows network monitoring systems to be alerted when a storm control event occurs. Unconfigure Value - use false to revert to default settings. Choices: |
|
Enables switchport mode on the interface. This configures the interface to operate as a Layer 2 port, participating in VLAN switching. Choices: |
|
Disables DTP negotiation on the interface. Prevents the port from automatically negotiating trunking with other devices. Choices: |
|
Sets the port priority value for LACP, influencing which port is selected for aggregation. Unconfigure Value - use -1 to unconfigure. |
|
Specifies the LACP packet transmission rate (fast or normal), controlling how quickly LACP packets are sent. Unconfigure Value - use NORMAL to revert to default settings. |
|
Configure the interface to transmit and receive LLDP packets, or disable LLDP on the interface. Unconfigure Value - use TRANSMIT_AND_RECEIVE to revert to default settings. |
|
Set the administrative mode for the interface. Corresponding CLI - switchport mode access | trunk | dynamic auto | dynamic desirable | dot1q-tunnel. Unconfigure Value - use DYNAMIC_AUTO to revert to default settings. |
|
VLAN ID for native VLAN on the trunk. The native VLAN is used for untagged traffic on the trunk link. Derived From - The available VLAN IDs include VLAN configurations from the current profile and the device, always including VLAN 1. Unconfigure Value - use 1 to revert to default settings. Restrictions â Native VLAN must refer to a VLAN. The VLAN must exist in the Layer 2 profile or on the device. |
|
Time in minutes before a secure MAC address ages out. This controls how long learned MAC addresses remain valid. Unconfigure Value - use 0 to unconfigure. |
|
Type of aging for secure MAC addresses (absolute, inactivity). Absolute ages out after a set time; inactivity ages out after no activity. Unconfigure Value - use ABSOLUTE to revert to default settings. |
|
Security violation mode. Unconfigure Value - use SHUTDOWN_VLAN to revert to default settings. |
|
Primary IPv4 address assigned to the interface, used for network communication. Unconfigure Value - use "" to unconfigure. Restrictions â IPv4 must be enabled within IPv4/IPv6 VRF Name to configure IPv4 Address or IPv4 Address should be removed. |
|
Subnet mask for the primary IPv4 address, defining the network portion of the address. Unconfigure Value - use "" to unconfigure. |
|
Sets the reauthentication interval in seconds for 802.1X authentication. Devices must re-authenticate after this period. Unconfigure Value - use 3600 to revert to default settings. |
|
Secondary Address. Restrictions â IPv4 must be enabled within IPv4/IPv6 VRFs to configure Secondary IPv4 Addresses or Secondary IPv4 Addresses should be removed. |
|
Switches Configs Intended Port Create's configType. |
|
Switches Configs Intended Port Create's items. |
|
Type of network functionality under a feature. Config type ETHERNET_INTERFACE_SECONDARY_ADDRESS is for configuring secondary IP addresses on a Gigabit Ethernet interface to support multiple IP addresses within the same subnet. |
|
Secondary IPv4 address assigned to the interface, providing additional address for communication. |
|
Subnet mask for the secondary IPv4 address, defining the network portion of the secondary address. |
|
Security Group Tag (SGT) value for manual CTS static policy. Used to assign a fixed security group to the interface for TrustSec enforcement. Unconfigure Value - use 0 to unconfigure. |
|
Enables BPDU filtering on the interface, blocking spanning tree BPDUs to prevent topology changes. Unconfigure Value - use NONE to unconfigure. |
|
Enable/Disable STP BPDU Guard on interface. Unconfigure Value - use NONE to unconfigure. |
|
Specifies the spanning tree path cost for the interface, influencing the selection of the forwarding path. Unconfigure Value - use 0 to unconfigure. |
|
Configures the type of spanning tree guard (root, loop, none) to protect against topology changes. Unconfigure Value - use NONE to revert to default settings. |
|
Configure the portFast mode for an interface. Corresponding CLI - spanning-tree portfast disable | trunk | network | edge | edge trunk. Supported IOS-XE versions - On Cisco switches running IOS versions earlier than 17.15.1, this property is read-only and only the EDGE, TRUNK, DISABLE, ENABLE, NONE modes are supported. Since IOS version 17.15.1 and later, this property is configurable and supports all available modes. Unconfigure Value - use NONE to revert to default settings. |
|
Sets the port priority value for spanning tree, affecting which port is selected as the root port. Unconfigure Value - use 128 (default value) to revert to default settings. |
|
List of VLANs allowed on the trunk. Specify which VLANs are permitted to pass through the trunk interface. Unconfigure Value - use "" to revert to default settings. |
|
Mode for allowed VLANs on trunk. Unconfigure Value - use ALL to revert to default settings. |
|
Configure the VLANs allowed on the trunk. Unconfigure Value - use "" to unconfigure. |
|
Timeout for supplicant retries. Unconfigure Value - use 30 to revert to default settings. |
|
Enables UDLD at the port level. UDLD (Unidirectional Link Detection) helps detect and disable unidirectional links to prevent network issues. Supported IOS-XE versions - On Cisco switches running IOS versions earlier than 17.15.1, this property is read-only and only the AGGRESSIVE, ALERT, and DISABLE modes are supported. Since IOS version 17.15.1 or later, this property can be configured, and all modes are supported, including AGGRESS_ALERT, AGGRESSIVE, ALERT, DISABLE, and ENABLE. |
|
VLAN ID for voice traffic on the port-channel interface. Derived From - The available VLAN IDs include VLAN configurations from the current profile and the device, always including VLAN 1. Unconfigure Value - use 0 to unconfigure. Restrictions â Voice VLAN must refer to a VLAN. The VLAN must exist in the Layer 2 profile or on the device. |
|
VRF name for interface IP forwarding. This enables logical network segmentation by assigning the interface to a specific VRF. Derived From - The available VRF names include VRF Definition configurations from the current profile and the device, excluding Mgmt-vrf. Unconfigure Value - use "" to unconfigure. |
|
Feature path parameter. Name of the feature to configure. The API /api/v1/switches/{id}/configs/su... can be used to get the list of features supported on a device. |
|
Id path parameter. Network device id of the switch to configure. The Network device id is identified from the GET network device API /dna/intent/api/v1/network-device response. |
|
This feature is for configuring port-channels on a switch. 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. |
|
Switches Configs Intended Port Create's items. |
|
VLAN ID for switchport access mode on the port-channel interface. Derived From - The available VLAN IDs include VLAN configurations from the current profile and the device, always including VLAN 1. Unconfigure Value - use 1 to revert to default settings. Restrictions â Access VLAN must refer to a VLAN. The VLAN must exist in the Layer 2 profile or on the device. |
|
Number of missed BFD packets before declaring a failure on the port-channel interface. Unconfigure Value - use 3 to revert to default settings. |
|
Minimum interval in milliseconds between received BFD packets on the port-channel interface. |
|
Interval in milliseconds for sending BFD packets on the port-channel interface. Unconfigure Value - use 0 to unconfigure. |
|
Name of the BFD template applied to the port-channel interface, allowing standardized BFD configuration. Derived From - The available BFD template names include BFD Template Single Hop configurations from the current profile and the device. Unconfigure Value - use "" to unconfigure. |
|
Type of network functionality under a feature. Config type PORT_CHANNEL_INTERFACE_CONFIG is for configuring a logical aggregation of multiple physical Ethernet links to increase bandwidth and provide redundancy through link aggregation protocols. |
|
Text description for the port-channel interface, used for documentation and identification. Unconfigure Value - use "" to unconfigure. |
|
IPv4 Helper Address. |
|
Switches Configs Intended Port Create's configType. |
|
Switches Configs Intended Port Create's items. |
|
Configuring IP address settings for network interfaces, enabling communication and routing on Cisco devices. |
|
IPv4 address of the DHCP relay (helper) server for the port-channel interface. |
|
Name of the ACL applied inbound on the port-channel interface for traffic filtering. Derived From - The available ACL names include standard and extended access list configurations from the current profile and the device. Unconfigure Value - use "" to unconfigure. |
|
Subnet mask for the primary IPv4 address on the port-channel interface. Unconfigure Value - use "" to unconfigure. |
|
IPv4 Outbound ACL Name for filtering outgoing traffic on the port channel. Derived From - The available ACL names include standard and extended access list configurations from the current profile and the device. Unconfigure Value - use "" to unconfigure. |
|
VRF name for port-channel interface IP forwarding, enabling logical network segmentation. Derived From - The available VRF names include IPv4 VRF configurations from the current profile and the device. Unconfigure Value - use "" to unconfigure. Restrictions â IPv4 VRF Name must refer to an existing VRF. The VRF must exist in the Layer 3 profile or on the device. |
|
IPv6 DHCP Relay Destination Address. |
|
Switches Configs Intended Port Create's configType. |
|
Switches Configs Intended Port Create's items. |
|
Type of network functionality under a feature. Config type PORT_CHANNEL_V6_DHCP_RELAY_DEST_CONFIG is for configuring IPv6 DHCP relay destinations on a port channel interface. |
|
IPv6 address of the DHCP relay destination for the port-channel interface. |
|
IPv6 DHCP Relay Global Destination Address. |
|
Switches Configs Intended Port Create's configType. |
|
Switches Configs Intended Port Create's items. |
|
Type of network functionality under a feature. Config type PORT_CHANNEL_IPV6_DHCP_RELAY_DST_CONFIG is for configuring the destination IP address for relaying DHCPv6 messages within a Port-Channel feature utilizing IPv6. |
|
Global IPv6 address for DHCP relay destination on the port-channel interface. |
|
IPv6 link-local address assigned to the port-channel interface for local network communication. Supported IOS-XE versions - This property is viewable only (read-only) on Cisco switches running IOS version earlier than 17.18.1. Since IOS version 17.18.1 or later, configuration for this property is supported. Unconfigure Value - use "" to unconfigure. Restrictions â IPv6 must be enabled within IPv4/IPv6 VRFs to configure IPv6 Link Local Address or IPv6 Link Local Address should be removed. |
|
Prefix List IPv6 Address. Restrictions â IPv6 must be enabled within IPv4/IPv6 VRFs to configure IPv6 Prefix Addresses or IPv6 Prefix Addresses should be removed. |
|
Switches Configs Intended Port Create's configType. |
|
Switches Configs Intended Port Create's items. |
|
Type of network functionality under a feature. Config type PORT_CHANNEL_V6_ADDR_PREFIX_LIST_CONFIG is for configuring IPv6 address prefixes for a PortChannel interface, allowing grouped links to be managed under a single network entity in adding address prefix lists. |
|
IPv6 prefix for the port-channel interface, used for routing and address assignment. |
|
IPv6 Traffic Filter. |
|
Switches Configs Intended Port Create's configType. |
|
Switches Configs Intended Port Create's items. |
|
Name of the IPv6 access list for traffic filtering on the port-channel interface. Derived From - The available IPv6 access list names include IPv6 Named ACL configurations from the current profile and the device. Unconfigure Value - use "" to unconfigure. |
|
Type of network functionality under a feature. Config type PORT_CHANNEL_IPV6_TRAFFIC_FILTER_CONFIG is for configuring IPv6 traffic filters on port channels to manage and control IPv6 data packet flow. |
|
Direction for IPv6 traffic filtering on the port-channel interface (in, out). |
|
Enables Bidirectional Forwarding Detection (BFD) on the port-channel interface for rapid detection of link failures. Unconfigure Value - use true to revert to default settings. Choices: |
|
Enable or disable BFD interval configuration. Unconfigure Value - use false to unconfigure. Choices: |
|
Enables DHCP for automatic IP address assignment on the port-channel interface, allowing dynamic address configuration. Unconfigure Value - use false to unconfigure. Restrictions â IPv4 must be enabled within IPv4/IPv6 VRFs to configure IPv4 Address via DHCP or IPv4 Address via DHCP must be disabled. Choices: |
|
Enables IP redirects on the port-channel interface, allowing the interface to send ICMP redirect messages. Unconfigure Value - use true to revert to default settings. Choices: |
|
Enable sending ICMP Unreachable messages. Unconfigure Value - use true to revert to default settings. Choices: |
|
Enables IPv6 address autoconfiguration on the port-channel interface, allowing automatic assignment of IPv6 addresses. Unconfigure Value - use false to unconfigure. Restrictions â IPv6 must be enabled within IPv4/IPv6 VRFs to configure IPv6 Address Autoconfig or IPv6 Address Autoconfig must be disabled. Choices: |
|
Enables DHCPv6 for automatic IPv6 address assignment on the port-channel interface. Unconfigure Value - use false to unconfigure. Choices: |
|
Enables IPv6 processing on the port-channel interface, allowing IPv6 traffic and configuration. Unconfigure Value - use false to unconfigure. Choices: |
|
Enables IPv6 redirects on the port-channel interface, allowing the interface to send ICMPv6 redirect messages. Unconfigure Value - use true to revert to default settings. Choices: |
|
Enables fast switchover for LACP on the port-channel interface, improving failover times. Unconfigure Value - use false to unconfigure. Choices: |
|
Enables proxy ARP on the port-channel interface, allowing the interface to respond to ARP requests on behalf of other devices. Unconfigure Value - use true to revert to default settings. Choices: |
|
Enables rapid commit option for DHCPv6 on the port-channel interface, allowing faster address assignment. Unconfigure Value - use false to unconfigure. Choices: |
|
Disables the port-channel interface (administratively down), preventing traffic flow. Unconfigure Value - use false to revert to default settings. Choices: |
|
Enables switchport mode on the port-channel interface, allowing it to participate in VLAN switching. Unconfigure Value - use true to revert to default settings. Choices: |
|
Disables DTP negotiation on the port-channel interface, preventing automatic trunk negotiation. Unconfigure Value - use false to unconfigure. Choices: |
|
Maximum number of LACP bundled links allowed for the port-channel interface. Unconfigure Value - use 0 to unconfigure. |
|
MAC address assigned to the port-channel interface for identification and communication. Unconfigure Value - use "" to unconfigure. |
|
Minimum number of links required for the port-channel to be up and operational. Unconfigure Value - use 0 to unconfigure. |
|
Set the administrative mode for the interface. Corresponding CLI - switchport mode access | trunk | dynamic auto | dynamic desirable | dot1q-tunnel. Unconfigure Value - use DYNAMIC_AUTO to revert to default settings. |
|
VLAN ID for native VLAN on the trunk for the port-channel interface. Derived From - The available VLAN IDs include VLAN configurations from the current profile and the device, always including VLAN 1. Unconfigure Value - use 1 to revert to default settings. Restrictions â Native VLAN must refer to a VLAN. The VLAN must exist in the Layer 2 profile or on the device. |
|
Portchannel Number or identifier for the port-channel interface, used for configuration and management. |
|
Primary IPv4 address assigned to the port-channel interface for network communication. Unconfigure Value - use "" to unconfigure. Restrictions â IPv4 must be enabled within IPv4/IPv6 VRFs to configure IPv4 Address or IPv4 Address should be removed. |
|
IPv4 Secondary Address. Restrictions â IPv4 must be enabled within IPv4/IPv6 VRFs to configure Secondary IPv4 Addresses or Secondary IPv4 Addresses should be removed. |
|
Switches Configs Intended Port Create's configType. |
|
Switches Configs Intended Port Create's items. |
|
Type of network functionality under a feature. Config type INTERFACE_PORT_CHANNEL_IP_ADDR_SEC_CONFIG is for configuring IP address security settings on a port channel interface to ensure secure network communication. |
|
Secondary IPv4 address assigned to the port-channel interface, providing additional address for communication. |
|
Subnet mask for the secondary IPv4 address on the port-channel interface. |
|
Enables BPDU filtering on the port-channel interface, blocking spanning tree BPDUs to prevent topology changes. Unconfigure Value - use NONE to unconfigure. |
|
Enable/Disable STP BPDU Guard on interface. Unconfigure Value - use NONE to unconfigure. |
|
Specifies the spanning tree path cost for the port-channel interface, influencing the selection of the forwarding path in the spanning tree topology. Unconfigure Value - use 0 to unconfigure. |
|
Configures the type of spanning tree guard (root, loop, none) to protect against topology changes and maintain network stability. Unconfigure Value - use NONE to revert to default settings. |
|
Configure the portFast mode for an interface. Supported IOS-XE versions - On Cisco switches running IOS versions earlier than 17.15.1, this property is read-only and only the EDGE, TRUNK, DISABLE, ENABLE, NONE modes are supported. Since IOS version 17.15.1 and later, this property is configurable and supports all available modes. Unconfigure Value - use NONE to revert to default settings. |
|
Sets the port priority value for spanning tree on the port-channel interface, affecting which port is selected as the root port. Unconfigure Value - use -1 to unconfigure. |
|
List of VLANs allowed on the trunk for the port-channel interface. Unconfigure Value - use "" to revert to default settings. |
|
Mode for allowed VLANs on trunk. Unconfigure Value - use ALL to revert to default settings. |
|
VLAN ID for voice traffic on the port-channel interface. Derived From - The available VLAN IDs include VLAN configurations from the current profile and the device, always including VLAN 1. Unconfigure Value - use 0 to unconfigure. Restrictions â Voice VLAN must refer to a VLAN. The VLAN must exist in the Layer 2 profile or on the device. |
|
VRF name for port-channel interface IP forwarding, enabling logical network segmentation. Derived From - The available VRF names include VRF Definition configurations from the current profile and the device, excluding Mgmt-vrf. Unconfigure Value - use "" to unconfigure. Restrictions â IPv4/IPv6 VRF Name must refer to an existing VRF. The VRF must exist in the Layer 3 profile or on the device. |
|
Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: |
Notes
Note
SDK Method used are wired.Wired.add_intended_port_configurations,
Paths used are post /dna/campus/api/v1/switches/{id}/configs/intended/port/{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 AddIntendedPortConfigurations
Complete reference of the AddIntendedPortConfigurations API.
Examples
---
- name: Create
cisco.catalystcenter.switches_configs_intended_port_create:
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}}"
ethernetInterfaceConfig:
items:
- accessList: string
accessSessionControlDirection: string
accessSessionHostModeCfg: string
accessSessionHostModeEnum: string
accessSessionPortControl: string
accessVlanId: 0
authControlDirection: string
authHostMode: string
authInactivityTimer: 0
authPortControl: string
bfdIntervalMultiplier: 0
bfdMinRxInterval: 0
bfdMinTxInterval: 0
bfdTemplate: string
channelGroupMode: string
channelGroupNumber: 0
channelProtocol: string
clientPdPreName: string
configType: string
description: string
deviceTrackingPolicy:
configType: string
items:
- configType: string
deviceTrackingPolicy: string
dhcpSnoopingLimitRate: 0
direction: string
helperAddresses:
configType: string
items:
- configType: string
ipAddress: string
interfaceName: string
ipDhcpHostname: string
ipV4InboundAclName: string
ipV4OutboundAclName: string
ipV4VrfName: string
ipV6DhcpRelayDestination:
configType: string
items:
- configType: string
ipV6Address: string
ipV6DhcpRelayDestinationGlobal:
configType: string
items:
- configType: string
ipV6Address: string
ipV6LinkLocalAddress: string
ipV6PrefixList:
configType: string
items:
- configType: string
ipV6Address: string
ipV6TrafficFilter:
configType: string
items:
- accessList: string
configType: string
direction: string
isAccessSessionClosed: true
isArpInspectionTrustEnabled: true
isAuthInactivityTimerFromServerEnabled: true
isAuthOpenEnabled: true
isBfdEnabled: true
isBfdIntervalEnabled: {}
isCdpEnabled: true
isCdpTlvAppEnabled: true
isDeviceTrackingEnabled: true
isDhcpEnabled: true
isDhcpSnoopingTrustEnabled: true
isDot1xMabOrderEnabled: true
isDot1xMabPriorityEnabled: true
isIpV6AutoconfigEnabled: true
isIpV6DhcpEnabled: true
isIpV6Enabled: true
isMabEapEnabled: true
isMabEnabled: true
isMabWebauthPriority: true
isPeriodicAuthEnabled: true
isPortSecurityEnabled: true
isReauthTimerFromServerEnabled: true
isShutdown: true
isStaticTrustedEnabled: true
isStormControlShutdownEnabled: true
isStormControlTrapEnabled: true
isSwitchportEnabled: true
isSwitchportNonegotiate: true
lacpPortPriority: 0
lacpRate: string
lldpAdminStatus: string
mode: string
nativeVlanId: 0
portSecurityAgingTime: 0
portSecurityAgingType: string
portSecurityViolation: string
primaryIpAddress: string
primaryIpMask: string
reauthTimer: 0
secondaryAddress:
configType: string
items:
- configType: string
ipAddress: string
mask: string
staticSgt: 0
stpBpduGuard: string
stpBpdufilterStatus: string
stpCost: 0
stpGuardMode: string
stpPortPriority: 0
stpPortfastMode: string
trunkAllowedVlanIds: string
trunkAllowedVlansMode: string
trunkVlans: string
txPeriod: 0
udldMode: string
voiceVlanId: 0
vrfName: string
feature: string
id: string
portChannelInterfaceConfig:
items:
- accessVlanId: 0
bfdIntervalMultiplier: 0
bfdMinRxInterval: 0
bfdMinTxInterval: 0
bfdTemplate: string
configType: string
description: string
helperAddress:
configType: string
items:
- configType: string
ipAddress: string
ipV4InboundAclName: string
ipV4Mask: string
ipV4OutboundAclName: string
ipV4VrfName: string
ipV6DhcpRelayDestination:
configType: string
items:
- configType: string
ipV6Address: string
ipV6DhcpRelayDestinationGlobal:
configType: string
items:
- configType: string
ipV6Address: string
ipV6LinkLocalAddress: string
ipV6PrefixList:
configType: string
items:
- configType: string
ipV6Prefix: string
ipV6TrafficFilter:
configType: string
items:
- actionList: string
configType: string
direction: string
isBfdEnabled: true
isBfdIntervalEnabled: true
isIpV4DhcpEnabled: true
isIpV4RedirectsEnabled: true
isIpV4UnreachablesEnabled: true
isIpV6AutoconfigEnabled: true
isIpV6DhcpEnabled: true
isIpV6Enabled: true
isIpV6RedirectsEnabled: true
isLacpFastSwitchoverEnabled: true
isProxyArpEnabled: true
isRapidCommitEnabled: true
isShutdown: true
isSwitchportEnabled: true
isSwitchportNonegotiate: true
lacpMaxBundle: 0
macAddress: string
minLinks: 0
mode: string
nativeVlanId: 0
portchannelNumber: 0
primaryAddress: string
secondaryAddress:
configType: string
items:
- configType: string
ipAddress: string
mask: string
stpBpduGuard: string
stpBpdufilterStatus: string
stpCost: 0
stpGuardMode: string
stpPortPriority: 0
stpPortfastMode: string
trunkAllowedVlanIds: string
trunkAllowedVlansMode: string
voiceVlanId: 0
vrfName: string
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"}` |