/ home / racampos / racampos.dnac / 0.0.1 / module / global_credential

racampos.dnac.global_credential (0.0.1) — module

Manage GlobalCredential objects of Discovery

| "added in version" 1.0 of racampos.dnac"

Authors: first last (@GitHubID)

preview | supported by community

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install racampos.dnac:==0.0.1

Add to requirements.yml

  collections:
    - name: racampos.dnac
      version: 0.0.1

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: query_result

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: query_result

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

delete_global_credentials_by_id:
  contains: null
  description: Deletes global credential for the given ID.
  response:
    contains:
      taskId:
        description: It is the global credential's taskId.
        returned: success
        type: dict
      url:
        description: It is the global credential's url.
        returned: success
        sample: <url>
        type: str
    description: Response, property of the response body.
    returned: success
    type: dict
  returned: success
  type: dict
  version:
    description: Version, property of the response body.
    returned: success
    sample: '1.0'
    type: str
get_credential_sub_type_by_credential_id:
  contains: null
  description: Returns the credential sub type for the given Id.
  response:
    description: Response, property of the response body.
    returned: always
    sample: <response>
    type: str
  returned: always
  type: dict
  version:
    description: Version, property of the response body.
    returned: always
    sample: '1.0'
    type: str
get_global_credentials:
  contains: null
  description: Returns global credential for the given credential sub type.
  response:
    contains:
      comments:
        description: It is the global credential's comments.
        returned: always
        sample: <comments>
        type: str
      credentialType:
        description: It is the global credential's credentialType.
        returned: always
        sample: <credentialtype>
        type: str
      description:
        description: It is the global credential's description.
        returned: always
        sample: <description>
        type: str
      id:
        description: It is the global credential's id.
        returned: always
        sample: '478012'
        type: str
      instanceTenantId:
        description: It is the global credential's instanceTenantId.
        returned: always
        sample: <instancetenantid>
        type: str
      instanceUuid:
        description: It is the global credential's instanceUuid.
        returned: always
        sample: <instanceuuid>
        type: str
    description: Response, property of the response body (list of objects).
    returned: always
    type: list
  returned: always
  type: dict
  version:
    description: Version, property of the response body.
    returned: always
    sample: '1.0'
    type: str
update_global_credentials:
  contains: null
  description: Update global credential for network devices in site(s).
  response:
    contains:
      taskId:
        description: It is the global credential's taskId.
        returned: changed
        type: dict
      url:
        description: It is the global credential's url.
        returned: changed
        sample: <url>
        type: str
    description: SitesInfoDTO's response.
    returned: changed
    type: dict
  returned: changed
  type: dict
  version:
    description: SitesInfoDTO's version.
    returned: changed
    sample: '1.0'
    type: str

Install collection

Add to requirements.yml

Description

Requirements

Usage examples

Inputs

Outputs

See also