cisco.catalystcenter.wireless_settings_pre_auth_acls module -- Resource module for Wireless Settings Pre Auth Acls

Note

This module is part of the cisco.catalystcenter collection (version 2.12.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.wireless_settings_pre_auth_acls.

New in cisco.catalystcenter 2.11.0

Synopsis

• Manage operations create, update and delete of the resource Wireless Settings Pre Auth Acls. - > This API allows users to create a Pre-Auth ACL design. To configure the created Pre-Auth ACL settings to an IOS-XE wireless supported device,. - > This API allows users to delete a Pre-Auth ACL by ID. This API will not remove the Pre-Auth ACL configured on a controller. To remove the provisioned Pre-Auth ACL settings from an IOS-XE wireless supported device,. - > This API allows users to update the details of an existing Pre-Auth ACL by ID. To configure the modified Pre- Auth ACL settings to an IOS-XE wireless supported 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
aclListName string	Pre-Auth ACL List Name.
aclName string	Pre-Auth ACL Name.
catalystcenter_debug aliases: dnac_debug boolean	Flag for Cisco Catalyst Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
catalystcenter_host aliases: dnac_host string / required	The Cisco Catalyst Center hostname.
catalystcenter_password aliases: dnac_password string	The Cisco Catalyst Center password to authenticate.
catalystcenter_port aliases: dnac_port, catalystcenter_api_port integer	The Cisco Catalyst Center port. Default: :ansible-option-default:`443`
catalystcenter_username aliases: dnac_username, user string	The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"`
catalystcenter_verify aliases: dnac_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
catalystcenter_version aliases: dnac_version string	Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"3.1.6.0"`
id string	Id path parameter. Pre-Auth ACL ID.
includeAutoGeneratedRules boolean	If set to true, Predefined rules will be pushed, which include allowing DHCP, DNS, AAA, and other applicable ports and IPs that are created as part of the default pre-auth rule/ACE for the applicable SSID. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
ipAclRules list / elements=dictionary	List of IPv4 or IPv6 ACL rules.
destinationAddress dictionary	An IPv4 or IPv6 address.
destinationPorts string	Destination port. Required when protocol is TCP or UDP. Accepts a single number (e.g., 100) or a range with a hyphen and no whitespaces (e.g., 100-200). Valid values are between 0 and 65535.
destinationSubnetMaskOrPrefix integer	Destination subnet (IPv4) / Destination prefix (IPv6). Value should be in CIDR notation.
protocol dictionary	An IPv4 or IPv6 protocol.
sourceAddress dictionary	An IPv4 or IPv6 address.
sourcePorts string	Source port. Required when protocol is TCP or UDP. Accepts a single number (e.g., 100) or a range with a hyphen and no whitespaces (e.g., 100-200). Valid values are between 0 and 65535.
sourceSubnetMaskOrPrefix integer	Source subnet (IPv4) / Source prefix (IPv6). Value should be in CIDR notation.
ipv6AclEnabled boolean	When set to true, only IPv6 ACL rules can be configured. When set to false, only IPv4 ACL rules can be configured. Default value of the attribute is false. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
validate_response_schema boolean	Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
walledGardenUrls list / elements=string	Walled Garden URLs. List of URLs that are allowed for access before a client device is fully authenticated to the network. Allowed special characters are hyphen(-), underscore(_), dot(.) and asterisk(*).

Notes

Note

• SDK Method used are wireless.Wireless.create_pre_auth_acl, wireless.Wireless.delete_pre_auth_acl, wireless.Wireless.update_pre_auth_acl,

• Paths used are post /dna/intent/api/v1/wirelessSettings/preAuthAcls, delete /dna/intent/api/v1/wirelessSettings/preAuthAcls/{id}, put /dna/intent/api/v1/wirelessSettings/preAuthAcls/{id},

• Does not support check_mode

• The 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 Wireless CreatePreAuthACL

Complete reference of the CreatePreAuthACL API.

Cisco Catalyst Center documentation for Wireless DeletePreAuthACL

Complete reference of the DeletePreAuthACL API.

Cisco Catalyst Center documentation for Wireless UpdatePreAuthACL

Complete reference of the UpdatePreAuthACL API.

Examples

---
- name: Delete by id
  cisco.catalystcenter.wireless_settings_pre_auth_acls:
    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
    id: string
- name: Update by id
  cisco.catalystcenter.wireless_settings_pre_auth_acls:
    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
    aclListName: string
    aclName: string
    id: string
    includeAutoGeneratedRules: true
    ipAclRules:
      - destinationAddress: {}
        destinationPorts: string
        destinationSubnetMaskOrPrefix: 0
        protocol: {}
        sourceAddress: {}
        sourcePorts: string
        sourceSubnetMaskOrPrefix: 0
    ipv6AclEnabled: true
    walledGardenUrls:
      - string
- name: Create
  cisco.catalystcenter.wireless_settings_pre_auth_acls:
    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
    aclListName: string
    aclName: string
    includeAutoGeneratedRules: true
    ipAclRules:
      - destinationAddress: {}
        destinationPorts: string
        destinationSubnetMaskOrPrefix: 0
        protocol: {}
        sourceAddress: {}
        sourcePorts: string
        sourceSubnetMaskOrPrefix: 0
    ipv6AclEnabled: true
    walledGardenUrls:
      - string

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
catalystcenter_response dictionary	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"}`

Authors

• Bryan Vargas (@bvargasre)

Collection links

Issue Tracker Repository (Sources)