.. 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_controllers_intended_ssids_policy_profiles_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.catalystcenter.wireless_controllers_intended_ssids_policy_profiles module -- Resource module for Wireless Controllers Intended Ssids Policy Profiles ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.catalystcenter collection `_ (version 2.12.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_controllers_intended_ssids_policy_profiles`. .. 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 Controllers Intended Ssids Policy Profiles. - \> This API operation creates an intended PolicyProfile resource, and the subsequent "deploy" API call will configure the changes on the underlying wireless controller, and this API is applicable for per-device based configuration. - \> This API operation deletes an intended PolicyProfile resource, and the subsequent "deploy" API call will configure the changes on the underlying wireless controller, and this API is applicable for per-device based configuration. Delete operations are not supported for default-policy-profile in any version. - \> This API operation updates an intended PolicyProfile resource, and the subsequent "deploy" API call will configure the changes on the underlying wireless controller, and this API is applicable for per-device based configuration. 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 :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.catalystcenter.wireless_controllers_intended_ssids_policy_profiles_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_controllers_intended_ssids_policy_profiles_module__parameter-catalystcenter_debug: .. _ansible_collections.cisco.catalystcenter.wireless_controllers_intended_ssids_policy_profiles_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_controllers_intended_ssids_policy_profiles_module__parameter-catalystcenter_host: .. _ansible_collections.cisco.catalystcenter.wireless_controllers_intended_ssids_policy_profiles_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_controllers_intended_ssids_policy_profiles_module__parameter-catalystcenter_password: .. _ansible_collections.cisco.catalystcenter.wireless_controllers_intended_ssids_policy_profiles_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_controllers_intended_ssids_policy_profiles_module__parameter-catalystcenter_api_port: .. _ansible_collections.cisco.catalystcenter.wireless_controllers_intended_ssids_policy_profiles_module__parameter-catalystcenter_port: .. _ansible_collections.cisco.catalystcenter.wireless_controllers_intended_ssids_policy_profiles_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_controllers_intended_ssids_policy_profiles_module__parameter-catalystcenter_username: .. _ansible_collections.cisco.catalystcenter.wireless_controllers_intended_ssids_policy_profiles_module__parameter-dnac_username: .. _ansible_collections.cisco.catalystcenter.wireless_controllers_intended_ssids_policy_profiles_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_controllers_intended_ssids_policy_profiles_module__parameter-catalystcenter_verify: .. _ansible_collections.cisco.catalystcenter.wireless_controllers_intended_ssids_policy_profiles_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_controllers_intended_ssids_policy_profiles_module__parameter-catalystcenter_version: .. _ansible_collections.cisco.catalystcenter.wireless_controllers_intended_ssids_policy_profiles_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_controllers_intended_ssids_policy_profiles_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. Instance UUID of the PolicyProfile. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_intended_ssids_policy_profiles_module__parameter-networkdeviceid: .. rst-class:: ansible-option-title **networkDeviceId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
NetworkDeviceId path parameter. Network device ID of the wireless controller to provision. The API /dna/intent/api/v1/network-device can be used to get the network device ID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_intended_ssids_policy_profiles_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
.. Attributes .. Notes Notes ----- .. note:: - SDK Method used are wireless.Wireless.create\_a\_new\_configuration\_for\_an\_intended\_policy\_profile\_feature\_on\_a\_wireless\_controller, wireless.Wireless.delete\_configurations\_for\_a\_specific\_instance\_of\_an\_intended\_policy\_profile\_feature\_on\_a\_wireless\_controller, wireless.Wireless.update\_configurations\_for\_a\_specific\_instance\_of\_an\_intended\_policy\_profile\_feature\_on\_a\_wireless\_controller, - Paths used are post /dna/campus/api/v1/wirelessControllers/{networkDeviceId}/intended/ssids/policyProfiles, delete /dna/campus/api/v1/wirelessControllers/{networkDeviceId}/intended/ssids/policyProfiles/{id}, put /dna/campus/api/v1/wirelessControllers/{networkDeviceId}/intended/ssids/policyProfiles/{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 CreateANewConfigurationForAnIntendedPolicyProfileFeatureOnAWirelessController `_ Complete reference of the CreateANewConfigurationForAnIntendedPolicyProfileFeatureOnAWirelessController API. `Cisco Catalyst Center documentation for Wireless DeleteConfigurationsForASpecificInstanceOfAnIntendedPolicyProfileFeatureOnAWirelessController `_ Complete reference of the DeleteConfigurationsForASpecificInstanceOfAnIntendedPolicyProfileFeatureOnAWirelessController API. `Cisco Catalyst Center documentation for Wireless UpdateConfigurationsForASpecificInstanceOfAnIntendedPolicyProfileFeatureOnAWirelessController `_ Complete reference of the UpdateConfigurationsForASpecificInstanceOfAnIntendedPolicyProfileFeatureOnAWirelessController API. .. Examples Examples -------- .. code-block:: yaml+jinja --- - name: Create cisco.catalystcenter.wireless_controllers_intended_ssids_policy_profiles: 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 aaaOverrideEnabled: false aaaPolicyNacEnabled: false aaaPolicyName: default-aaa-policy aaaPolicyVlanFallbackEnabled: false apEthmacEnabled: false arpProxyStatusEnabled: false arpRateNoneEnabled: false autoqosProfileMode: AUTOQOS_DISABLED blocklistEnabled: true blocklistTimeout: 60 callSnoopEnabled: false centralAuthEnabled: true centralDhcpEnabled: false centralSwitchingEnabled: false configType: POLICY_PROFILE ctsPolicySgaclEnforceEnabled: false deviceClassified: false deviceVersion: '17.16' dhcpDnsOptionEnabled: true dhcpEnabled: false dhcpOpt82AsciiEnabled: false dhcpOpt82Enabled: false dhcpOpt82RidEnabled: false dhcpOpt82VrfEnabled: false dhcpOptionNoneEnabled: false dhcpParamsApLocation: false dhcpParamsApNameEnabled: false dhcpParamsPolicyTagEnabled: false dhcpServerIpv4Addr: 0.0.0.0 dhcpTlvCachingEnabled: false dot11TlvAcctEnabled: false etAnalyticsTviEnabled: false guestLanSessionTimeoutEnabled: false httpTlvCachingEnabled: false interfaceName: data ipMacBinding: true isWlanPolicyDhcpApmacEnabled: false l3AccessEnabled: false linkLocalBridgingEnabled: false mdnsServicePolicyName: default-mdns-service-policy mobilityAnchorEnabled: false multicastFiltered: false nbarProtocolDiscoveryEnabled: false ndpRateNoneEnabled: false ndpRateParamsBurstInterval: 5 ndpRatePps: 100 networkDeviceId: dd584a8a-a7ae-4323-97f4-ab950cab52a6 overrideNatPatEnabled: false passiveClientEnabled: false perSsidQosEgressServiceName: platinum perSsidQosIngressServiceName: platinum-up policyProfileName: Corp_Dot1x_Profile radiusProfilingEnabled: false sessionTimeOut: 28800 sipCacSend486BusyEnabled: false sipCacSendDisAssoc: false statusEnabled: true umbrellaFlexModeForced: false upnRestrictEnabled: false upnUnicastDisabled: false vlanCentralSwitching: false wgbPolicyBroadcastTagging: false wgbPolicyMulticastFw: false wgbPolicyVlanEnabled: false wlanAcctInterimEnabled: true wlanArpBurstInterval: 5 wlanArpRatePps: 100 wlanIdleThreshold: 0 wlanIdleTimeoutValue: 300 wlanInlineTaggingEnabled: false wlanIpv6ProxyEnabled: NO_PROXY wlanPolicyDescription: Copr dot1x profile wlanPolicyDhcpSsidEnabled: false wlanPolicyQbssLoad: true wlanPolicyVlanId: false wlanStaticIpMobility: false - name: Update by id cisco.catalystcenter.wireless_controllers_intended_ssids_policy_profiles: 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 aaaOverrideEnabled: false aaaPolicyNacEnabled: false aaaPolicyName: default-aaa-policy aaaPolicyVlanFallbackEnabled: false apEthmacEnabled: false arpProxyStatusEnabled: false arpRateNoneEnabled: false autoqosProfileMode: AUTOQOS_DISABLED blocklistEnabled: true blocklistTimeout: 60 callSnoopEnabled: false centralAuthEnabled: true centralDhcpEnabled: false centralSwitchingEnabled: false configType: POLICY_PROFILE ctsPolicySgaclEnforceEnabled: false deviceClassified: false deviceVersion: '17.16' dhcpDnsOptionEnabled: true dhcpEnabled: false dhcpOpt82AsciiEnabled: false dhcpOpt82Enabled: false dhcpOpt82RidEnabled: false dhcpOpt82VrfEnabled: false dhcpOptionNoneEnabled: false dhcpParamsApLocation: false dhcpParamsApNameEnabled: false dhcpParamsPolicyTagEnabled: false dhcpServerIpv4Addr: 0.0.0.0 dhcpTlvCachingEnabled: false dot11TlvAcctEnabled: false etAnalyticsTviEnabled: false guestLanSessionTimeoutEnabled: false httpTlvCachingEnabled: false id: string interfaceName: data ipMacBinding: true isWlanPolicyDhcpApmacEnabled: false l3AccessEnabled: false linkLocalBridgingEnabled: false mdnsServicePolicyName: default-mdns-service-policy mobilityAnchorEnabled: false multicastFiltered: false nbarProtocolDiscoveryEnabled: false ndpRateNoneEnabled: false ndpRateParamsBurstInterval: 5 ndpRatePps: 100 networkDeviceId: dd584a8a-a7ae-4323-97f4-ab950cab52a6 overrideNatPatEnabled: false passiveClientEnabled: false perSsidQosEgressServiceName: platinum perSsidQosIngressServiceName: platinum-up policyProfileName: Corp_Dot1x_Profile radiusProfilingEnabled: false sessionTimeOut: 28800 sipCacSend486BusyEnabled: false sipCacSendDisAssoc: false statusEnabled: true umbrellaFlexModeForced: false upnRestrictEnabled: false upnUnicastDisabled: false vlanCentralSwitching: false wgbPolicyBroadcastTagging: false wgbPolicyMulticastFw: false wgbPolicyVlanEnabled: false wlanAcctInterimEnabled: true wlanArpBurstInterval: 5 wlanArpRatePps: 100 wlanIdleThreshold: 0 wlanIdleTimeoutValue: 300 wlanInlineTaggingEnabled: false wlanIpv6ProxyEnabled: NO_PROXY wlanPolicyDescription: Copr dot1x profile wlanPolicyDhcpSsidEnabled: false wlanPolicyQbssLoad: true wlanPolicyVlanId: false wlanStaticIpMobility: false - name: Delete by id cisco.catalystcenter.wireless_controllers_intended_ssids_policy_profiles: 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 networkDeviceId: dd584a8a-a7ae-4323-97f4-ab950cab52a6 .. 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_controllers_intended_ssids_policy_profiles_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