/ home / cisco / cisco.dnac / 6.13.3 / module / wireless_enterprise_ssid_info

cisco.dnac.wireless_enterprise_ssid_info (6.13.3) — module

Information module for Wireless Enterprise Ssid

| "added in version" 3.1.0 of cisco.dnac"

Authors: Rafael Campos (@racampos)

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install cisco.dnac:==6.13.3

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 6.13.3

Description

Get all Wireless Enterprise Ssid.

Gets either one or all the enterprise SSID.

Requirements

dnacentersdk >= 2.6.0
python >= 3.9

Usage examples

Scanned by Steampunk Spotter

- name: Get all Wireless Enterprise Ssid
  cisco.dnac.wireless_enterprise_ssid_info:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    headers: "{{my_headers | from_json}}"
    ssidName: string
  register: result

Inputs

    
headers:
    description: Additional headers.
    type: dict

ssidName:
    description:
    - 'SsidName query parameter. Enter the enterprise SSID name that needs to be retrieved.
      If not entered, all the enterprise SSIDs will be retrieved.

      '
    type: str

dnac_host:
    description:
    - The Cisco DNA Center hostname.
    required: true
    type: str

dnac_port:
    default: 443
    description:
    - The Cisco DNA Center port.
    type: int

dnac_debug:
    default: false
    description:
    - Flag for Cisco DNA Center SDK to enable debugging.
    type: bool

dnac_verify:
    default: true
    description:
    - Flag to enable or disable SSL certificate verification.
    type: bool

dnac_version:
    default: 2.3.5.3
    description:
    - Informs the SDK which version of Cisco DNA Center to use.
    type: str

dnac_password:
    description:
    - The Cisco DNA Center password to authenticate.
    type: str

dnac_username:
    aliases:
    - user
    default: admin
    description:
    - The Cisco DNA Center username to authenticate.
    type: str

validate_response_schema:
    default: true
    description:
    - Flag for Cisco DNA Center SDK to enable the validation of request bodies against
      a JSON schema.
    type: bool

Outputs

dnac_response:
  description: A dictionary or list with the response returned by the Cisco DNAC Python
    SDK
  elements: dict
  returned: always
  sample: "[\n  {\n    \"instanceUuid\": \"string\",\n    \"version\": 0,\n    \"\
    ssidDetails\": [\n      {\n        \"name\": \"string\",\n        \"wlanType\"\
    : \"string\",\n        \"enableFastLane\": true,\n        \"securityLevel\": \"\
    string\",\n        \"authServer\": \"string\",\n        \"passphrase\": \"string\"\
    ,\n        \"trafficType\": \"string\",\n        \"enableMACFiltering\": true,\n\
    \        \"isEnabled\": true,\n        \"isFabric\": true,\n        \"fastTransition\"\
    : \"string\",\n        \"radioPolicy\": \"string\",\n        \"enableBroadcastSSID\"\
    : true,\n        \"nasOptions\": [\n          \"string\"\n        ],\n       \
    \ \"aaaOverride\": true,\n        \"coverageHoleDetectionEnable\": true,\n   \
    \     \"protectedManagementFrame\": \"string\",\n        \"multiPSKSettings\"\
    : [\n          {\n            \"priority\": 0,\n            \"passphraseType\"\
    : \"string\",\n            \"passphrase\": \"string\"\n          }\n        ],\n\
    \        \"clientRateLimit\": 0\n      }\n    ],\n    \"groupUuid\": \"string\"\
    ,\n    \"inheritedGroupUuid\": \"string\",\n    \"inheritedGroupName\": \"string\"\
    \n  }\n]\n"
  type: list