cisco.catalystcenter.wireless_provision_ssid_create_provision module -- Resource module for Wireless Provision Ssid Create Provision

Note

This module is part of the cisco.catalystcenter collection (version 2.1.4).

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

New in cisco.catalystcenter 3.1.0

Synopsis

  • This module represents an alias of the module wireless_provision_ssid_create_provision_v1

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

  • catalystcentersdk >= 2.3.7.9

  • python >= 3.5

Parameters

Parameter

Comments

_api_port

integer

The Cisco CATALYST Center port.

Default: :ansible-option-default:`443`

_debug

boolean

Flag for Cisco CATALYST Center SDK to enable debugging.

Choices:

_host

string / required

The Cisco CATALYST Center hostname.

_password

string

The Cisco CATALYST Center password to authenticate.

_username

aliases: user

string

The Cisco CATALYST Center username to authenticate.

Default: :ansible-option-default:`"admin"`

_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

_version

string

Informs the SDK which version of Cisco CATALYST Center to use.

Default: :ansible-option-default:`"2.3.7.6"`

enableFabric

boolean

Enable SSID for Fabric.

Choices:

flexConnect

dictionary

Wireless Provision Ssid Create Provision's flexConnect.

enableFlexConnect

boolean

Enable Flex Connect.

Choices:

localToVlan

integer

Local To Vlan (range is 1 to 4094).

headers

dictionary

Additional headers.

managedAPLocations

list / elements=string

Managed AP Locations (Enter entire Site(s) hierarchy).

ssidDetails

dictionary

Wireless Provision Ssid Create Provision's ssidDetails.

authKeyMgmt

list / elements=string

Takes string inputs for the AKMs that should be set true. Possible AKM values dot1x,dot1x_ft, dot1x_sha, psk, psk_ft, psk_sha, owe, sae, sae_ft.

enableBroadcastSSID

boolean

Enable Broadcast SSID.

Choices:

enableFastLane

boolean

Enable Fast Lane.

Choices:

enableMACFiltering

boolean

Enable MAC Filtering.

Choices:

fastTransition

string

Fast Transition.

ghz24Policy

string

2.4 GHz Policy.

ghz6PolicyClientSteering

boolean

6 Ghz Client Steering.

Choices:

name

string

SSID Name.

passphrase

string

Pass Phrase ( Only applicable for SSID with PERSONAL auth type ).

radioPolicy

string

Radio Policy.

rsnCipherSuiteCcmp256

boolean

Rsn Cipher Suite Ccmp256.

Choices:

rsnCipherSuiteGcmp128

boolean

Rsn Cipher Suite Gcmp128.

Choices:

rsnCipherSuiteGcmp256

boolean

Rsn Cipher Suite Gcmp256.

Choices:

securityLevel

string

Security Level(For guest SSID OPEN/WEB_AUTH, For Enterprise SSID ENTERPRISE/PERSONAL/OPEN).

trafficType

string

Traffic Type.

webAuthURL

string

Web Auth URL.

ssidType

string

SSID Type.

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

  • Paths used are post /dna/intent/api/v1/business/ssid,

  • It should be noted that this module is an alias of wireless_provision_ssid_create_provision_v1

  • Does not support check_mode

  • The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco CATALYST SDK

  • The parameters starting with catalystCenter_ are used by the Cisco CATALYST Python SDK to establish the connection

See Also

See also

Cisco DNA Center documentation for Wireless CreateAndProvisionSSIDV1

Complete reference of the CreateAndProvisionSSIDV1 API.

Examples

- name: Create
  cisco.catalystcenter.wireless_provision_ssid_create_provision:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    enableFabric: true
    flexConnect:
      enableFlexConnect: true
      localToVlan: 0
    headers: '{{my_headers | from_json}}'
    managedAPLocations:
      - string
    ssidDetails:
      authKeyMgmt:
        - string
      enableBroadcastSSID: true
      enableFastLane: true
      enableMACFiltering: true
      fastTransition: string
      ghz24Policy: string
      ghz6PolicyClientSteering: true
      name: string
      passphrase: string
      radioPolicy: string
      rsnCipherSuiteCcmp256: true
      rsnCipherSuiteGcmp128: true
      rsnCipherSuiteGcmp256: true
      securityLevel: string
      trafficType: string
      webAuthURL: string
    ssidType: 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 DNAC Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"executionId": "string", "executionStatusUrl": "string", "message": "string"}`

Authors

  • Rafael Campos (@racampos)