.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.catalystcenter.wireless_settings_pre_auth_acls_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.catalystcenter.wireless_settings_pre_auth_acls module -- Resource module for Wireless Settings Pre Auth Acls ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.catalystcenter collection `_ (version 2.11.0). To install it, use: :code:`ansible-galaxy collection install cisco.catalystcenter`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`cisco.catalystcenter.wireless_settings_pre_auth_acls`. .. version_added .. rst-class:: ansible-version-added New in cisco.catalystcenter 2.11.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - 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 :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.catalystcenter.wireless_settings_pre_auth_acls_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - catalystcentersdk \>= 3.2.3.0.0 - python \>= 3.12 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_pre_auth_acls_module__parameter-acllistname: .. rst-class:: ansible-option-title **aclListName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Pre-Auth ACL List Name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_pre_auth_acls_module__parameter-aclname: .. rst-class:: ansible-option-title **aclName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Pre-Auth ACL Name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_pre_auth_acls_module__parameter-catalystcenter_debug: .. _ansible_collections.cisco.catalystcenter.wireless_settings_pre_auth_acls_module__parameter-dnac_debug: .. rst-class:: ansible-option-title **catalystcenter_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_debug` .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco Catalyst Center SDK to enable debugging. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_pre_auth_acls_module__parameter-catalystcenter_host: .. _ansible_collections.cisco.catalystcenter.wireless_settings_pre_auth_acls_module__parameter-dnac_host: .. rst-class:: ansible-option-title **catalystcenter_host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_host` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center hostname. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_pre_auth_acls_module__parameter-catalystcenter_password: .. _ansible_collections.cisco.catalystcenter.wireless_settings_pre_auth_acls_module__parameter-dnac_password: .. rst-class:: ansible-option-title **catalystcenter_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_password` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center password to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_pre_auth_acls_module__parameter-catalystcenter_api_port: .. _ansible_collections.cisco.catalystcenter.wireless_settings_pre_auth_acls_module__parameter-catalystcenter_port: .. _ansible_collections.cisco.catalystcenter.wireless_settings_pre_auth_acls_module__parameter-dnac_port: .. rst-class:: ansible-option-title **catalystcenter_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_port, catalystcenter_api_port` .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center port. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`443` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_pre_auth_acls_module__parameter-catalystcenter_username: .. _ansible_collections.cisco.catalystcenter.wireless_settings_pre_auth_acls_module__parameter-dnac_username: .. _ansible_collections.cisco.catalystcenter.wireless_settings_pre_auth_acls_module__parameter-user: .. rst-class:: ansible-option-title **catalystcenter_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_username, user` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center username to authenticate. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_pre_auth_acls_module__parameter-catalystcenter_verify: .. _ansible_collections.cisco.catalystcenter.wireless_settings_pre_auth_acls_module__parameter-dnac_verify: .. rst-class:: ansible-option-title **catalystcenter_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_verify` .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag to enable or disable SSL certificate verification. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_pre_auth_acls_module__parameter-catalystcenter_version: .. _ansible_collections.cisco.catalystcenter.wireless_settings_pre_auth_acls_module__parameter-dnac_version: .. rst-class:: ansible-option-title **catalystcenter_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_version` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Informs the SDK which version of Cisco Catalyst Center to use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"3.1.6.0"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_pre_auth_acls_module__parameter-id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Id path parameter. Pre-Auth ACL ID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_pre_auth_acls_module__parameter-includeautogeneratedrules: .. rst-class:: ansible-option-title **includeAutoGeneratedRules** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
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. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_pre_auth_acls_module__parameter-ipaclrules: .. rst-class:: ansible-option-title **ipAclRules** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
List of IPv4 or IPv6 ACL rules. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_pre_auth_acls_module__parameter-ipaclrules/destinationaddress: .. rst-class:: ansible-option-title **destinationAddress** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
An IPv4 or IPv6 address. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_pre_auth_acls_module__parameter-ipaclrules/destinationports: .. rst-class:: ansible-option-title **destinationPorts** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_pre_auth_acls_module__parameter-ipaclrules/destinationsubnetmaskorprefix: .. rst-class:: ansible-option-title **destinationSubnetMaskOrPrefix** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Destination subnet (IPv4) / Destination prefix (IPv6). Value should be in CIDR notation. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_pre_auth_acls_module__parameter-ipaclrules/protocol: .. rst-class:: ansible-option-title **protocol** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
An IPv4 or IPv6 protocol. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_pre_auth_acls_module__parameter-ipaclrules/sourceaddress: .. rst-class:: ansible-option-title **sourceAddress** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
An IPv4 or IPv6 address. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_pre_auth_acls_module__parameter-ipaclrules/sourceports: .. rst-class:: ansible-option-title **sourcePorts** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_pre_auth_acls_module__parameter-ipaclrules/sourcesubnetmaskorprefix: .. rst-class:: ansible-option-title **sourceSubnetMaskOrPrefix** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Source subnet (IPv4) / Source prefix (IPv6). Value should be in CIDR notation. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_pre_auth_acls_module__parameter-ipv6aclenabled: .. rst-class:: ansible-option-title **ipv6AclEnabled** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
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. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_pre_auth_acls_module__parameter-validate_response_schema: .. rst-class:: ansible-option-title **validate_response_schema** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_pre_auth_acls_module__parameter-walledgardenurls: .. rst-class:: ansible-option-title **walledGardenUrls** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
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(\*). .. raw:: html
.. Attributes .. Notes 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 \ :literal:`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) .. Seealso See Also -------- .. seealso:: `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 Examples -------- .. code-block:: yaml+jinja --- - 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 .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_pre_auth_acls_module__return-catalystcenter_response: .. rst-class:: ansible-option-title **catalystcenter_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco Catalyst Center Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Bryan Vargas (@bvargasre) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors