cisco.dnac.global_credential – Manage GlobalCredential objects of Discovery

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

New in version 1.0.0: of cisco.dnac

Synopsis

• Returns global credential for the given credential sub type.

• Deletes global credential for the given ID.

• Update global credential for network devices in site(s).

• Returns the credential sub type for the given Id.

Note

This module has a corresponding action plugin.

Requirements

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

• dnacentersdk

Parameters

Parameter	Choices/Defaults	Comments
credential_sub_type string		Credential type as CLI / SNMPV2_READ_COMMUNITY / SNMPV2_WRITE_COMMUNITY / SNMPV3 / HTTP_WRITE / HTTP_READ / NETCONF. Required for state query.
global_credential_id string / required		ID of global-credential. Global credential Uuid.
id string		Global Credential ID. Required for state query.
order string		Order query parameter.
siteUuids list / elements=string		SitesInfoDTO's siteUuids (list of strings).
sort_by string		SortBy query parameter.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.global_credential

The official documentation on the cisco.dnac.plugins.module_utils.definitions.global_credential module.

GlobalCredential reference

Complete reference of the GlobalCredential object model.

GlobalCredential reference

SDK reference.

Examples

- name: get_global_credentials
  cisco.dnac.global_credential:
    state: query  # required
    credential_sub_type: SomeValue  # string, required
    order: SomeValue  # string
    sort_by: SomeValue  # string
  register: nm_get_global_credentials

- name: delete_global_credentials_by_id
  cisco.dnac.global_credential:
    state: delete  # required
    global_credential_id: SomeValue  # string, required

- name: update_global_credentials
  cisco.dnac.global_credential:
    state: update  # required
    global_credential_id: SomeValue  # string, required
    siteUuids:
    - SomeValue  # string

- name: get_credential_sub_type_by_credential_id
  cisco.dnac.global_credential:
    state: query  # required
    id: SomeValue  # string, required
  register: nm_get_credential_sub_type_by_credential_id

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: discovery.delete_global_credentials_by_id

Authors

• Rafael Campos (@racampos)