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

Note

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

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

New in cisco.catalystcenter 6.14.0

Synopsis

  • Manage operation update of the resource Sda Authentication Profiles.

  • Updates an authentication profile based on user input.

Note

This module has a corresponding action plugin.

Requirements

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

  • catalystcentersdk >= 3.1.3.0.0

  • python >= 3.5

Parameters

Parameter

Comments

catalystcenter_api_port

integer

The Cisco Catalyst Center port.

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

catalystcenter_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catalystcenter_host

string / required

The Cisco Catalyst Center hostname.

catalystcenter_password

string

The Cisco Catalyst Center password to authenticate.

catalystcenter_username

string

The Cisco Catalyst Center username to authenticate.

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

catalystcenter_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catalystcenter_version

string

Informs the SDK which version of Cisco Catalyst 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:

isVoiceVlanEnabled

boolean

Enable/disable Voice Vlan.

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

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

  • 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

See Also

See also

Cisco DNA Center documentation for SDA UpdateAuthenticationProfile

Complete reference of the UpdateAuthenticationProfile API.

Examples

---
- name: Update all
  cisco.catalystcenter.sda_authentication_profiles:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_api_port: "{{catalystcenter_api_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    state: present
    payload:
      - authenticationOrder: string
        authenticationProfileName: string
        dot1xToMabFallbackTimeout: 0
        fabricId: string
        id: string
        isBpduGuardEnabled: true
        isVoiceVlanEnabled: 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 CATALYST Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

  • Rafael Campos (@racampos)