cisco.dnac.device_credential_info (6.13.3) — module

Information module for Device Credential

| "added in version" 3.1.0 of cisco.dnac"

Authors: Rafael Campos (@racampos)

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install cisco.dnac:==6.13.3


Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 6.13.3

Description

Get all Device Credential.

API to get device credential details.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get all Device Credential
  cisco.dnac.device_credential_info:
    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}}"
    headers: "{{my_headers | from_json}}"
    siteId: string
  register: result

Inputs

    
siteId:
    description:
    - SiteId query parameter. Site id to retrieve the credential details associated with
      the site.
    type: str

headers:
    description: Additional headers.
    type: dict

dnac_host:
    description:
    - The Cisco DNA Center hostname.
    required: true
    type: str

dnac_port:
    default: 443
    description:
    - The Cisco DNA Center port.
    type: int

dnac_debug:
    default: false
    description:
    - Flag for Cisco DNA Center SDK to enable debugging.
    type: bool

dnac_verify:
    default: true
    description:
    - Flag to enable or disable SSL certificate verification.
    type: bool

dnac_version:
    default: 2.3.5.3
    description:
    - Informs the SDK which version of Cisco DNA Center to use.
    type: str

dnac_password:
    description:
    - The Cisco DNA Center password to authenticate.
    type: str

dnac_username:
    aliases:
    - user
    default: admin
    description:
    - The Cisco DNA Center username to authenticate.
    type: str

validate_response_schema:
    default: true
    description:
    - Flag for Cisco DNA Center SDK to enable the validation of request bodies against
      a JSON schema.
    type: bool

Outputs

dnac_response:
  description: A dictionary or list with the response returned by the Cisco DNAC Python
    SDK
  returned: always
  sample: "{\n  \"snmp_v3\": [\n    {\n      \"username\": \"string\",\n      \"authPassword\"\
    : \"string\",\n      \"authType\": \"string\",\n      \"privacyPassword\": \"\
    string\",\n      \"privacyType\": \"string\",\n      \"snmpMode\": \"string\"\
    ,\n      \"comments\": \"string\",\n      \"description\": \"string\",\n     \
    \ \"credentialType\": \"string\",\n      \"instanceUuid\": \"string\",\n     \
    \ \"instanceTenantId\": \"string\",\n      \"id\": \"string\"\n    }\n  ],\n \
    \ \"http_read\": [\n    {\n      \"secure\": \"string\",\n      \"username\":\
    \ \"string\",\n      \"password\": \"string\",\n      \"port\": \"string\",\n\
    \      \"comments\": \"string\",\n      \"description\": \"string\",\n      \"\
    credentialType\": \"string\",\n      \"instanceUuid\": \"string\",\n      \"instanceTenantId\"\
    : \"string\",\n      \"id\": \"string\"\n    }\n  ],\n  \"http_write\": [\n  \
    \  {\n      \"secure\": \"string\",\n      \"username\": \"string\",\n      \"\
    password\": \"string\",\n      \"port\": \"string\",\n      \"comments\": \"string\"\
    ,\n      \"description\": \"string\",\n      \"credentialType\": \"string\",\n\
    \      \"instanceUuid\": \"string\",\n      \"instanceTenantId\": \"string\",\n\
    \      \"id\": \"string\"\n    }\n  ],\n  \"snmp_v2_write\": [\n    {\n      \"\
    writeCommunity\": \"string\",\n      \"comments\": \"string\",\n      \"description\"\
    : \"string\",\n      \"credentialType\": \"string\",\n      \"instanceUuid\":\
    \ \"string\",\n      \"instanceTenantId\": \"string\",\n      \"id\": \"string\"\
    \n    }\n  ],\n  \"snmp_v2_read\": [\n    {\n      \"readCommunity\": \"string\"\
    ,\n      \"comments\": \"string\",\n      \"description\": \"string\",\n     \
    \ \"credentialType\": \"string\",\n      \"instanceUuid\": \"string\",\n     \
    \ \"instanceTenantId\": \"string\",\n      \"id\": \"string\"\n    }\n  ],\n \
    \ \"cli\": [\n    {\n      \"username\": \"string\",\n      \"enablePassword\"\
    : \"string\",\n      \"password\": \"string\",\n      \"comments\": \"string\"\
    ,\n      \"description\": \"string\",\n      \"credentialType\": \"string\",\n\
    \      \"instanceUuid\": \"string\",\n      \"instanceTenantId\": \"string\",\n\
    \      \"id\": \"string\"\n    }\n  ]\n}\n"
  type: dict

See also