cisco.catalystcenter.wireless_controllers_intended_flexes_update_create module -- Resource module for Wireless Controllers Intended Flexes Update Create

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

New in cisco.catalystcenter 2.11.0

Synopsis

  • Manage operation create of the resource Wireless Controllers Intended Flexes Update Create. - > This API operation creates/updates/deletes an intended feature 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.

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

flexProfiles

dictionary

Wireless Controllers Intended Flexes Update Create's flexProfiles.

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.update_configurations_for_an_intended_flex_feature_on_a_wireless_controller,

  • Paths used are post /dna/campus/api/v1/wirelessControllers/{networkDeviceId}/intended/flexes/update,

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

Complete reference of the UpdateConfigurationsForAnIntendedFlexFeatureOnAWirelessController API.

Examples

---
- name: Create
  cisco.catalystcenter.wireless_controllers_intended_flexes_update_create:
    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}}"
    flexProfiles:
      acctRadiusServerGrpName: RADIUS-ACCT-GROUP
      arpCaching: true
      configType: FLEX_PROFILE
      ctsInlineTagging: true
      ctsProfileName: CTS-SXP-PROFILE-001
      ctsRolebasedEnforce: true
      deviceVersion: '17.18'
      eapFastProfileName: EAP-FAST-PROFILE-001
      efficientApUpgradeEnabled: true
      fallbackRadioShut: false
      flexOverlapIpEnabled: false
      flexPolicyDescription: Comprehensive flex profile
      flexPolicyDhcpBroadcast: true
      flexPolicyHttpProxyIp: 192.168.1.100
      flexPolicyHttpProxyPort: 8080
      flexPolicyJoinMinLatency: true
      flexPolicyMdnsProfileName: MDNS-PROFILE-001
      flexPolicyName: Enterprise-FlexProfile-001
      flexPolicyNativeVlanId: 100
      flexPolicyPmkDistMethod: PMK_DIST_WLC_TO_AP
      flexPolicyRadiusEnabled: true
      flexPolicyRadiusServerGrpName: RADIUS-AUTH-GROUP
      flexPolicySecurityEapEnabled: true
      flexPolicySecurityLeapEnabled: false
      flexPolicySecurityPeapEnabled: true
      flexPolicySecurityTlsEnabled: true
      flexPolicyVlanEnabled: true
      homeApEnabled: false
      ifNameVlanIdConfigs:
        items:
          - configType: INTERFACE_NAME_VLAN_ID
            deviceVersion: '17.18'
            flexPolicyName: Enterprise-FlexProfile-001
            ifNameVlanId: 200
            ifNameVlanIdInterfaceName: GUEST-VLAN
            op: CREATE
      localAuthUserConfigs:
        items:
          - configType: LOCAL_AUTH_USER
            deviceVersion: '17.18'
            flexPolicyName: Enterprise-FlexProfile-001
            localAuthUserPassword: SecureP@ssw0rd123!
            localAuthUserPasswordType: CLEAR
            localAuthUserUserName: admin_user
            op: CREATE
          - configType: LOCAL_AUTH_USER
            deviceVersion: '17.18'
            flexPolicyName: Enterprise-FlexProfile-001
            localAuthUserPassword: GuestAccess2024!
            localAuthUserPasswordType: CLEAR
            localAuthUserUserName: guest_user
            op: CREATE
          - configType: LOCAL_AUTH_USER
            deviceVersion: '17.18'
            flexPolicyName: Enterprise-FlexProfile-001
            localAuthUserPassword: ServiceAcc0unt#2024
            localAuthUserPasswordType: CLEAR
            localAuthUserUserName: service_account
            op: CREATE
      localRoamingEnabled: true
      op: CREATE
      policyAclConfigs:
        items:
          - configType: POLICY_ACL
            deviceVersion: '17.18'
            flexPolicyName: Enterprise-FlexProfile-001
            op: CREATE
            policyAclCwaEnabled: true
            policyAclName: CORPORATE-WEB-POLICY
            policyAclUrlfilterlistName: CORPORATE-URL-FILTER
          - configType: POLICY_ACL
            deviceVersion: '17.18'
            flexPolicyName: Enterprise-FlexProfile-001
            op: CREATE
            policyAclCwaEnabled: true
            policyAclName: GUEST-WEB-POLICY
            policyAclUrlfilterlistName: GUEST-URL-FILTER
          - configType: POLICY_ACL
            deviceVersion: '17.18'
            flexPolicyName: Enterprise-FlexProfile-001
            op: CREATE
            policyAclCwaEnabled: false
            policyAclName: IOT-RESTRICTED-POLICY
            policyAclUrlfilterlistName: IOT-RESTRICTED-FILTER
      radioBackhaul: false
      resilientMode: true
      slaveMaxRetryCount: 3
      umbrellaProfileConfigs:
        items:
          - configType: UMBRELLA_PROFILE
            deviceVersion: '17.18'
            flexPolicyName: Enterprise-FlexProfile-001
            op: CREATE
            umbrellaProfileName: ENTERPRISE-UMBRELLA-PROFILE
          - configType: UMBRELLA_PROFILE
            deviceVersion: '17.18'
            flexPolicyName: Enterprise-FlexProfile-001
            op: CREATE
            umbrellaProfileName: GUEST-UMBRELLA-PROFILE
    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)