cisco.dnac.sda_auth_profile – Manage SdaAuthProfile objects of Sda¶

Note

This plugin is part of the cisco.dnac collection (version 2.0.7).

To install it use: ansible-galaxy collection install cisco.dnac.

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

New in version 1.0.0: of cisco.dnac

Synopsis
Requirements
Parameters
See Also
Examples
Return Values

Synopsis ¶

Add default authentication profile in SDA Fabric.
Get default authentication profile from SDA Fabric.
Add 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.

dnacentersdk

Parameters ¶

Parameter		Comments
payload list / elements=dictionary / required		An object to send in the Request body.
	authenticateTemplateName string	It is the sda auth profile's authenticateTemplateName.
	siteNameHierarchy string	It is the sda auth profile's siteNameHierarchy.
site_name_hierarchy string / required		SiteNameHierarchy query parameter.

Examples ¶

- name: delete_default_authentication_profile
  cisco.dnac.sda_auth_profile:
    state: delete  # required
    site_name_hierarchy: SomeValue  # string, required

- name: get_default_authentication_profile
  cisco.dnac.sda_auth_profile:
    state: query  # required
    site_name_hierarchy: SomeValue  # string, required
  register: nm_get_default_authentication_profile

- name: add_default_authentication_profile
  cisco.dnac.sda_auth_profile:
    state: create  # required
    payload:  # required
    - siteNameHierarchy: SomeValue  # string
      authenticateTemplateName: SomeValue  # string

- name: update_default_authentication_profile
  cisco.dnac.sda_auth_profile:
    state: update  # required
    payload:  # required
    - siteNameHierarchy: SomeValue  # string
      authenticateTemplateName: SomeValue  # string

Return Values ¶

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

Key	Returned	Description
dnac_response dictionary	always	A dictionary with the response returned by the DNA Center Python SDK Sample: {'response': 29, 'version': '1.0'}
missing_params list / elements=string	when the function request schema is not satisfied	Provided arguments do not comply with the schema of the DNA Center Python SDK function
sdk_function string	always	The DNA Center SDK function used to execute the task Sample: sda.add_default_authentication_profile

Authors¶

Rafael Campos (@racampos)

cisco.dnac.sda_auth_profile – Manage SdaAuthProfile objects of Sda¶

Synopsis¶

Requirements¶

Parameters¶

See Also¶

Examples¶

Return Values¶