cisco.catalystcenter.sda_fabric_authentication_profile_v1 module -- Resource module for Sda Fabric Authentication Profile V1

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

New in cisco.catalystcenter 3.1.0

Synopsis

• Manage operations create, update and delete of the resource Sda Fabric Authentication Profile V1.

• Add default authentication template in SDA Fabric.

• Delete default authentication profile in SDA Fabric.

• Update default authentication profile in SDA Fabric.

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: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
_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: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
_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 Fabric Authentication Profile's payload.
authenticateTemplateName string added in cisco.catalystcenter 4.0.0	Authenticate Template Name.
siteNameHierarchy string	Path of sda Fabric Site.
siteNameHierarchy string	SiteNameHierarchy query parameter.
validate_response_schema boolean	Flag for Cisco CATALYST Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)

Notes

Note

• SDK Method used are sda.Sda.add_default_authentication_profile, sda.Sda.delete_default_authentication_profile, sda.Sda.update_default_authentication_profile,

• Paths used are post /dna/intent/api/v1/business/sda/authentication-profile, delete /dna/intent/api/v1/business/sda/authentication-profile, put /dna/intent/api/v1/business/sda/authentication-profile,

• 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 SDA AddDefaultAuthenticationTemplateInSDAFabricV1

Complete reference of the AddDefaultAuthenticationTemplateInSDAFabricV1 API.

Cisco DNA Center documentation for SDA DeleteDefaultAuthenticationProfileFromSDAFabricV1

Complete reference of the DeleteDefaultAuthenticationProfileFromSDAFabricV1 API.

Cisco DNA Center documentation for SDA UpdateDefaultAuthenticationProfileInSDAFabricV1

Complete reference of the UpdateDefaultAuthenticationProfileInSDAFabricV1 API.

Examples

- name: Create
  cisco.catalystcenter.sda_fabric_authentication_profile_v1:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    state: present
    payload:
      - authenticateTemplateName: string
        siteNameHierarchy: string
- name: Update all
  cisco.catalystcenter.sda_fabric_authentication_profile_v1:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    state: present
    payload:
      - authenticateTemplateName: string
        authenticationOrder: string
        dot1xToMabFallbackTimeout: string
        numberOfHosts: string
        siteNameHierarchy: string
        wakeOnLan: true
- name: Delete all
  cisco.catalystcenter.sda_fabric_authentication_profile_v1:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    state: absent
    siteNameHierarchy: 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:`{"description": "string", "executionId": "string", "executionStatusUrl": "string", "status": "string", "taskId": "string", "taskStatusUrl": "string"}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)