cisco.catalystcenter.wireless_controllers_intended_ssids_policy_profiles module -- Resource module for Wireless Controllers Intended Ssids Policy Profiles

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

New in cisco.catalystcenter 2.11.0

Synopsis

  • 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 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:

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:

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. Instance UUID of the PolicyProfile.

networkDeviceId

string

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.

validate_response_schema

boolean

Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

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

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

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)