cisco.catalystcenter.wireless_policies_ip_access_control_lists_contract module -- Resource module for Wireless Policies Ip Access Control Lists Contract

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.wireless_policies_ip_access_control_lists_contract.

New in cisco.catalystcenter 2.11.0

Synopsis

• Manage operations create, update and delete of the resource Wireless Policies Ip Access Control Lists Contract.

• This API allows users to create contracts. This API allows users to create.

• This API allows users to delete contract by contract ID. This API allows users to delete contract by contract ID.

• This API allows users to update contract with protocols by contract ID. This.

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
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"`
description string	Description.
id string	Id path parameter. Contract ID.
implicitAction string	Type of Action.
name string	Contract Name.
protocolIds list / elements=string	A List of protocol IDs associated with the contract. IPv4 and IPv6 protocol IDs cannot be provided together.
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)

Notes

Note

• SDK Method used are wireless.Wireless.create_access_contract, wireless.Wireless.delete_access_contract, wireless.Wireless.update_access_contract,

• Paths used are post /dna/intent/api/v1/wirelessPolicies/ipAccessControlLists/contract, delete /dna/intent/api/v1/wirelessPolicies/ipAccessControlLists/contract/{id}, put /dna/intent/api/v1/wirelessPolicies/ipAccessControlLists/contract/{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 CreateAccessContract

Complete reference of the CreateAccessContract API.

Cisco Catalyst Center documentation for Wireless DeleteAccessContract

Complete reference of the DeleteAccessContract API.

Cisco Catalyst Center documentation for Wireless UpdateAccessContract

Complete reference of the UpdateAccessContract API.

Examples

---
- name: Create
  cisco.catalystcenter.wireless_policies_ip_access_control_lists_contract:
    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
    description: string
    implicitAction: string
    name: string
    protocolIds:
      - string
- name: Update by id
  cisco.catalystcenter.wireless_policies_ip_access_control_lists_contract:
    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
    description: string
    id: string
    implicitAction: string
    protocolIds:
      - string
- name: Delete by id
  cisco.catalystcenter.wireless_policies_ip_access_control_lists_contract:
    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

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)