cisco.dnac.device_credential module -- Resource module for Device Credential

Note

This module is part of the cisco.dnac collection (version 6.46.0).

To install it, use: ansible-galaxy collection install cisco.dnac. You need further requirements to be able to use this module, see Requirements for details.

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

New in cisco.dnac 3.1.0

Synopsis

  • Manage operations create, update and delete of the resource Device Credential.

  • API to create device credentials.

  • Delete device credential.

  • API to update device credentials.

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk >= 2.11.0

  • python >= 3.12

Parameters

Parameter

Comments

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

dnac_host

string / required

The Cisco DNA Center hostname.

dnac_password

string

The Cisco DNA Center password to authenticate.

dnac_port

integer

The Cisco DNA Center port.

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

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

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

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

dnac_version

string

Informs the SDK which version of Cisco DNA Center to use.

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

id

string

Id path parameter. Global credential id.

settings

dictionary

Device Credential's settings.

clientAndEndpoint_aaa

dictionary

Device Credential's clientAndEndpoint_aaa.

ipAddress

string

IP address for ISE serve (eg 1.1.1.4).

network

string

IP address for AAA or ISE server (eg 2.2.2.1).

protocol

string

Protocol for AAA or ISE serve (eg RADIUS).

servers

string

Server type AAA or ISE server (eg AAA).

sharedSecret

string

Shared secret for ISE server.

dhcpServer

list / elements=string

DHCP Server IP (eg 1.1.1.1).

dnsServer

dictionary

Device Credential's dnsServer.

domainName

string

Domain Name of DHCP (eg; cisco).

primaryIpAddress

string

Primary IP Address for DHCP (eg 2.2.2.2).

secondaryIpAddress

string

Secondary IP Address for DHCP (eg 3.3.3.3).

messageOfTheday

dictionary

Device Credential's messageOfTheday.

bannerMessage

string

Massage for Banner message (eg; Good day).

retainExistingBanner

string

Retain existing Banner Message (eg "true" or "false").

netflowcollector

dictionary

Device Credential's netflowcollector.

ipAddress

string

IP Address for NetFlow collector (eg 3.3.3.1).

port

float

Port for NetFlow Collector (eg; 443).

network_aaa

dictionary

Device Credential's network_aaa.

ipAddress

string

IP address for AAA and ISE server (eg 1.1.1.1).

network

string

IP Address for AAA or ISE server (eg 2.2.2.2).

protocol

string

Protocol for AAA or ISE serve (eg RADIUS).

servers

string

Server type for AAA Network (eg AAA).

sharedSecret

string

Shared secret for ISE Server.

ntpServer

list / elements=string

IP address for NTP server (eg 1.1.1.2).

snmpServer

dictionary

Device Credential's snmpServer.

configureDnacIP

boolean

Configuration DNAC IP for SNMP Server (eg true).

Choices:

ipAddresses

list / elements=string

IP Address for SNMP Server (eg 4.4.4.1).

syslogServer

dictionary

Device Credential's syslogServer.

configureDnacIP

boolean

Configuration DNAC IP for syslog server (eg true).

Choices:

ipAddresses

list / elements=string

IP Address for syslog server (eg 4.4.4.4).

timezone

string

Input for time zone (eg Africa/Abidjan).

validate_response_schema

boolean

Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

Notes

Note

  • SDK Method used are network_settings.NetworkSettings.create_device_credentials, network_settings.NetworkSettings.delete_device_credential, network_settings.NetworkSettings.update_device_credentials,

  • Paths used are post /dna/intent/api/v1/device-credential, delete /dna/intent/api/v1/device-credential/{id}, put /dna/intent/api/v1/device-credential,

  • 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 DNAC SDK

  • The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection

See Also

See also

Cisco DNA Center documentation for Network Settings CreateDeviceCredentials

Complete reference of the CreateDeviceCredentials API.

Cisco DNA Center documentation for Network Settings DeleteDeviceCredential

Complete reference of the DeleteDeviceCredential API.

Cisco DNA Center documentation for Network Settings UpdateDeviceCredentials

Complete reference of the UpdateDeviceCredentials API.

Examples

---
- name: Create
  cisco.dnac.device_credential:
    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}}"
    state: present
    settings:
      clientAndEndpoint_aaa:
        ipAddress: string
        network: string
        protocol: string
        servers: string
        sharedSecret: string
      dhcpServer:
        - string
      dnsServer:
        domainName: string
        primaryIpAddress: string
        secondaryIpAddress: string
      messageOfTheday:
        bannerMessage: string
        retainExistingBanner: string
      netflowcollector:
        ipAddress: string
        port: 0
      network_aaa:
        ipAddress: string
        network: string
        protocol: string
        servers: string
        sharedSecret: string
      ntpServer:
        - string
      snmpServer:
        configureDnacIP: true
        ipAddresses:
          - string
      syslogServer:
        configureDnacIP: true
        ipAddresses:
          - string
      timezone: string
- name: Update all
  cisco.dnac.device_credential:
    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}}"
    state: present
    settings:
      cliCredential:
        description: string
        enablePassword: string
        id: string
        password: string
        username: string
      httpsRead:
        id: string
        name: string
        password: string
        port: string
        username: string
      httpsWrite:
        id: string
        name: string
        password: string
        port: string
        username: string
      snmpV2cRead:
        description: string
        id: string
        readCommunity: string
      snmpV2cWrite:
        description: string
        id: string
        writeCommunity: string
      snmpV3:
        authPassword: string
        authType: string
        description: string
        id: string
        privacyPassword: string
        privacyType: string
        snmpMode: string
        username: string
- name: Delete by id
  cisco.dnac.device_credential:
    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}}"
    state: absent
    id: string

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 DNAC Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"executionId": "string", "executionStatusUrl": "string", "message": "string"}`

Authors

  • Rafael Campos (@racampos)