racampos.dnac.sda_auth_profile (0.0.1) — module

Manage SdaAuthProfile objects of Sda

| "added in version" 1.0 of racampos.dnac"

Authors: first last (@GitHubID)

preview | supported by community

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install racampos.dnac:==0.0.1


Add to requirements.yml

  collections:
    - name: racampos.dnac
      version: 0.0.1

Description

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.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: delete_default_authentication_profile
  cisco.dnac.sda_auth_profile:
    state: delete  # required
    site_name_hierarchy: SomeValue  # string, required
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- name: get_default_authentication_profile
  cisco.dnac.sda_auth_profile:
    state: query  # required
    site_name_hierarchy: SomeValue  # string, required
  register: query_result
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- name: add_default_authentication_profile
  cisco.dnac.sda_auth_profile:
    state: create  # required
    payload:  # required
    - siteNameHierarchy: SomeValue  # string
      authenticateTemplateName: SomeValue  # string
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- name: update_default_authentication_profile
  cisco.dnac.sda_auth_profile:
    state: update  # required
    payload:  # required
    - siteNameHierarchy: SomeValue  # string
      authenticateTemplateName: SomeValue  # string

Inputs

    
payload:
    description:
    - An object to send in the Request body.
    elements: dict
    required: true
    suboptions:
      authenticateTemplateName:
        description:
        - It is the sda auth profile's authenticateTemplateName.
        type: str
      siteNameHierarchy:
        description:
        - It is the sda auth profile's siteNameHierarchy.
        type: str
    type: list

site_name_hierarchy:
    description:
    - SiteNameHierarchy query parameter.
    required: true
    type: str

Outputs

add_default_authentication_profile:
  contains: null
  description:
    description: Description, property of the response body.
    returned: success
    sample: <description>
    type: str
  executionStatusUrl:
    description: Execution Status Url, property of the response body.
    returned: success
    sample: <executionstatusurl>
    type: str
  returned: success
  status:
    description: Status, property of the response body.
    returned: success
    sample: <status>
    type: str
  type: dict
delete_default_authentication_profile:
  contains: null
  description:
    description: Description, property of the response body.
    returned: success
    sample: <description>
    type: str
  executionStatusUrl:
    description: Execution Status Url, property of the response body.
    returned: success
    sample: <executionstatusurl>
    type: str
  returned: success
  status:
    description: Status, property of the response body.
    returned: success
    sample: <status>
    type: str
  type: dict
get_default_authentication_profile:
  authenticateTemplateId:
    description: Authenticate Template Id, property of the response body.
    returned: always
    sample: <authenticatetemplateid>
    type: str
  authenticateTemplateName:
    description: Authenticate Template Name, property of the response body.
    returned: always
    sample: <authenticatetemplatename>
    type: str
  contains: null
  description: Get default authentication profile from SDA Fabric.
  returned: always
  siteNameHierarchy:
    description: Site Name Hierarchy, property of the response body.
    returned: always
    sample: <sitenamehierarchy>
    type: str
  type: dict
update_default_authentication_profile:
  contains: null
  description:
    description: Description, property of the response body.
    returned: changed
    sample: <description>
    type: str
  executionStatusUrl:
    description: Execution Status Url, property of the response body.
    returned: changed
    sample: <executionstatusurl>
    type: str
  returned: changed
  status:
    description: Status, property of the response body.
    returned: changed
    sample: <status>
    type: str
  type: dict

See also