cisco.dnac.sda_authentication_profiles module -- Resource module for Sda Authentication Profiles

Note

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

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

New in cisco.dnac 6.14.0

Synopsis

  • This module represents an alias of the module sda_authentication_profiles_v1

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

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

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: :ansible-option-default:`443`

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

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

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

dnac_version

string

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

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

payload

list / elements=dictionary

Sda Authentication Profiles's payload.

authenticationOrder

string

First authentication method.

authenticationProfileName

string

The default host authentication template (updating this field is not allowed).

dot1xToMabFallbackTimeout

integer

802.1x Timeout.

fabricId

string

ID of the fabric this authentication profile is assigned to (updating this field is not allowed). To update a global authentication profile, either remove this property or set its value to null.

id

string

ID of the authentication profile (updating this field is not allowed).

isBpduGuardEnabled

boolean

Enable/disable BPDU Guard. Only applicable when authenticationProfileName is set to "Closed Authentication" (defaults to true).

Choices:

numberOfHosts

string

Number of Hosts.

preAuthAcl

dictionary

Sda Authentication Profiles's preAuthAcl.

accessContracts

list / elements=dictionary

Sda Authentication Profiles's accessContracts.

action

string

Contract behaviour.

port

string

Port for the access contract. The port can only be used once in the Access Contract list.

protocol

string

Protocol for the access contract. "TCP" and "TCP_UDP" are only allowed when the contract port is "domain".

description

string

Description of this Pre-Authentication ACL.

enabled

boolean

Enable/disable Pre-Authentication ACL.

Choices:

implicitAction

string

Implicit behaviour unless overridden (defaults to "DENY").

wakeOnLan

boolean

Wake on LAN.

Choices:

validate_response_schema

boolean

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

Choices:

Notes

Note

  • SDK Method used are sda.Sda.update_authentication_profile_v1,

  • Paths used are put /dna/intent/api/v1/sda/authenticationProfiles,

  • It should be noted that this module is an alias of sda_authentication_profiles_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 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 SDA UpdateAuthenticationProfileV1

Complete reference of the UpdateAuthenticationProfileV1 API.

Examples

- name: Update all
  cisco.dnac.sda_authentication_profiles:
    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
    payload:
    - authenticationOrder: string
      authenticationProfileName: string
      dot1xToMabFallbackTimeout: 0
      fabricId: string
      id: string
      isBpduGuardEnabled: true
      numberOfHosts: string
      preAuthAcl:
        accessContracts:
        - action: string
          port: string
          protocol: string
        description: string
        enabled: true
        implicitAction: string
      wakeOnLan: true

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: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

  • Rafael Campos (@racampos)