cisco.catalystcenter.sites_device_credentials_apply module -- Resource module for Sites Device Credentials Apply

Note

This module is part of the cisco.catalystcenter collection (version 2.3.1).

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

New in cisco.catalystcenter 6.15.0

Synopsis

• Manage operation create of the resource Sites Device Credentials Apply. - > When sync is triggered at a site with the credential that are associated to the same site, network devices in impacted sites child sites which are inheriting the credential get managed in inventory with the associated site credential. Credential gets configured on network devices before these get managed in inventory. Please make a note that cli credential wouldn't be configured on AAA authenticated devices but they just get managed with the associated site cli credential.

Note

This module has a corresponding action plugin.

Requirements

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

• catalystcentersdk >= 3.1.6.0.0

• python >= 3.12

Parameters

Parameter	Comments
catalystcenter_debug boolean	Flag for Cisco Catalyst Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
catalystcenter_host string / required	The Cisco Catalyst Center hostname.
catalystcenter_password string	The Cisco Catalyst Center password to authenticate.
catalystcenter_port integer	The Cisco Catalyst Center port. Default: :ansible-option-default:`443`
catalystcenter_username string	The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"`
catalystcenter_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
catalystcenter_version string	Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"3.1.6.0"`
configureDevice boolean	If the value is true and the devices at the applied site are locally authenticated, the applied CLI credentials will be configured on the devices. Authentication will then be performed using the applied CLI credentials. If the authentication is successful, the devices will be updated in the inventory with the applied CLI credentials. If the value is true and the devices are AAA authenticated, authentication will be performed on the devices using the applied CLI credentials. If the authentication is successful, the devices will be updated in the inventory with the applied CLI credentials. If the value is false, the devices will be directly updated in the inventory with the applied CLI credentials, without any authentication being performed. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
deviceCredentialId string	It must be cli/snmpV2Read/snmpV2Write/snmpV3 Id.
siteId string	Site Id.
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 network_settings.NetworkSettings.sync_network_devices_credential,

• Paths used are post /dna/intent/api/v1/sites/deviceCredentials/apply,

• Does not support check_mode

• The plugin runs on the control node and does not use any ansible connection plugins,

• but instead uses the embedded connection manager from Cisco CATALYST SDK

See Also

See also

Cisco DNA Center documentation for Network Settings SyncNetworkDevicesCredential

Complete reference of the SyncNetworkDevicesCredential API.

Examples

---
- name: Create
  cisco.catalystcenter.sites_device_credentials_apply:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    configureDevice: true
    deviceCredentialId: string
    siteId: 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:`{"response": {"count": 0}, "version": "string"}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)