/ home / cisco / cisco.dnac / 2.0.7 / module / global_credential

cisco.dnac.global_credential (2.0.7) — module

Manage GlobalCredential objects of Discovery

| "added in version" 1.0.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:==2.0.7

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 2.0.7

Description

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.

Requirements

dnacentersdk

Usage examples

Scanned by Steampunk Spotter

- 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

Scanned by Steampunk Spotter

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

Scanned by Steampunk Spotter

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

Scanned by Steampunk Spotter

- 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

Inputs

    
id:
    description:
    - Global Credential ID.
    - Required for state query.
    type: str

order:
    description:
    - Order query parameter.
    type: str

sort_by:
    description:
    - SortBy query parameter.
    type: str

siteUuids:
    description:
    - SitesInfoDTO's siteUuids (list of strings).
    type: list

credential_sub_type:
    description:
    - 'Credential type as CLI / SNMPV2_READ_COMMUNITY / SNMPV2_WRITE_COMMUNITY / SNMPV3
      / HTTP_WRITE / HTTP_READ / NETCONF.

      '
    - Required for state query.
    type: str

global_credential_id:
    description:
    - ID of global-credential.
    - Global credential Uuid.
    required: true
    type: str

Outputs

dnac_response:
  description: A dictionary with the response returned by the DNA Center Python SDK
  returned: always
  sample:
    response: 29
    version: '1.0'
  type: dict
missing_params:
  description: Provided arguments do not comply with the schema of the DNA Center
    Python SDK function
  returned: when the function request schema is not satisfied
  sample: null
  type: list
sdk_function:
  description: The DNA Center SDK function used to execute the task
  returned: always
  sample: discovery.delete_global_credentials_by_id
  type: str

Install collection

Add to requirements.yml

Description

Requirements

Usage examples

Inputs

Outputs

See also