W3cubDocs

/Ansible

cisco.dnac.sites_aaa_settings_v1 module – Resource module for Sites Aaa Settings V1

Note

This module is part of the cisco.dnac collection (version 6.31.3).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cisco.dnac. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.dnac.sites_aaa_settings_v1.

New in cisco.dnac 6.15.0

Synopsis

  • Manage operation update of the resource Sites Aaa Settings V1.
  • Set AAA settings for a site; `null` values indicate that the settings will be inherited from the parent site; empty objects `{}` indicate that the settings is unset.

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk >= 2.4.9
  • python >= 3.5

Parameters

Parameter

Comments

aaaClient

dictionary

Sites Aaa Settings’s aaaClient.

pan

string

Administration Node. Required for ISE.

primaryServerIp

string

The server to use as a primary.

protocol

string

Protocol.

secondaryServerIp

string

The server to use as a secondary.

serverType

string

Server Type.

sharedSecret

string

Shared Secret.

aaaNetwork

dictionary

Sites Aaa Settings’s aaaNetwork.

pan

string

Administration Node. Required for ISE.

primaryServerIp

string

The server to use as a primary.

protocol

string

Protocol.

secondaryServerIp

string

The server to use as a secondary.

serverType

string

Server Type.

sharedSecret

string

Shared Secret.

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

  • false ← (default)
  • true

dnac_host

string / required

The Cisco DNA Center hostname.

dnac_password

string

The Cisco DNA Center password to authenticate.

dnac_port

integer

The Cisco DNA Center port.

Default: 443

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: "admin"

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

  • false
  • true ← (default)

dnac_version

string

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

Default: "2.3.7.6"

id

string

Id path parameter. Site Id.

validate_response_schema

boolean

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

Choices:

  • false
  • true ← (default)

Notes

Note

  • SDK Method used are network_settings.NetworkSettings.set_aaa_settings_for_a_site_v1,
  • Paths used are put /dna/intent/api/v1/sites/{id}/aaaSettings,
  • 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 DNAC SDK
  • The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection

See Also

See also

Cisco DNA Center documentation for Network Settings SetAAASettingsForASiteV1

Complete reference of the SetAAASettingsForASiteV1 API.

Examples

- name: Update all
  cisco.dnac.sites_aaa_settings_v1:
    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}}"
    state: present
    aaaClient:
      pan: string
      primaryServerIp: string
      protocol: string
      secondaryServerIp: string
      serverType: string
      sharedSecret: string
    aaaNetwork:
      pan: string
      primaryServerIp: string
      protocol: string
      secondaryServerIp: string
      serverType: string
      sharedSecret: string
    id: string

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

dnac_response

dictionary

A dictionary or list with the response returned by the Cisco DNAC Python SDK

Returned: always

Sample: {"response": {"taskId": "string", "url": "string"}, "version": "string"}

Authors

  • Rafael Campos (@racampos)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/dnac/sites_aaa_settings_v1_module.html