racampos.dnac.global_credential_cli (0.0.1) — module

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

Adds global CLI credential.

Updates global CLI credentials.

Requirements

• dnacentersdk

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: create_cli_credentials
  cisco.dnac.global_credential_cli:
    state: create  # required
    payload:  # required
    - enablePassword: SomeValue  # string, required
      password: SomeValue  # string, required
      username: SomeValue  # string, required
      comments: SomeValue  # string
      credentialType: SomeValue  # string
      description: SomeValue  # string
      id: SomeValue  # string
      instanceTenantId: SomeValue  # string
      instanceUuid: SomeValue  # string

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

  
- name: update_cli_credentials
  cisco.dnac.global_credential_cli:
    state: update  # required
    enablePassword: SomeValue  # string, required
    password: SomeValue  # string, required
    username: SomeValue  # string, required
    comments: SomeValue  # string
    credentialType: SomeValue  # string, valid values: 'GLOBAL', 'APP'.
    description: SomeValue  # string
    id: SomeValue  # string
    instanceTenantId: SomeValue  # string
    instanceUuid: SomeValue  # string

Inputs

    
id:
    description:
    - CLICredentialDTO's id.
    type: str

payload:
    description:
    - An object to send in the Request body.
    - Required for state create.
    elements: dict
    suboptions:
      comments:
        description:
        - It is the global credential cli's comments.
        type: str
      credentialType:
        description:
        - It is the global credential cli's credentialType.
        type: str
      description:
        description:
        - It is the global credential cli's description.
        type: str
      enablePassword:
        description:
        - It is the global credential cli's enablePassword.
        required: true
        type: str
      id:
        description:
        - It is the global credential cli's id.
        type: str
      instanceTenantId:
        description:
        - It is the global credential cli's instanceTenantId.
        type: str
      instanceUuid:
        description:
        - It is the global credential cli's instanceUuid.
        type: str
      password:
        description:
        - It is the global credential cli's password.
        required: true
        type: str
      username:
        description:
        - It is the global credential cli's username.
        required: true
        type: str
    type: list

comments:
    description:
    - CLICredentialDTO's comments.
    type: str

password:
    description:
    - CLICredentialDTO's password.
    - Required for state update.
    type: str

username:
    description:
    - CLICredentialDTO's username.
    - Required for state update.
    type: str

description:
    description:
    - CLICredentialDTO's description.
    type: str

instanceUuid:
    description:
    - CLICredentialDTO's instanceUuid.
    type: str

credentialType:
    description:
    - CLICredentialDTO's credentialType.
    - Available values are 'GLOBAL' and 'APP'.
    type: str

enablePassword:
    description:
    - CLICredentialDTO's enablePassword.
    - Required for state update.
    type: str

instanceTenantId:
    description:
    - CLICredentialDTO's instanceTenantId.
    type: str

Outputs

create_cli_credentials:
  contains: null
  description: Adds global CLI credential.
  response:
    contains:
      taskId:
        description: It is the global credential cli's taskId.
        returned: success
        type: dict
      url:
        description: It is the global credential cli's url.
        returned: success
        sample: <url>
        type: str
    description: CLICredentialDTO's response.
    returned: success
    type: dict
  returned: success
  type: dict
  version:
    description: CLICredentialDTO's version.
    returned: success
    sample: '1.0'
    type: str
update_cli_credentials:
  contains: null
  description: Updates global CLI credentials.
  response:
    contains:
      taskId:
        description: It is the global credential cli's taskId.
        returned: changed
        type: dict
      url:
        description: It is the global credential cli's url.
        returned: changed
        sample: <url>
        type: str
    description: CLICredentialDTO's response.
    returned: changed
    type: dict
  returned: changed
  type: dict
  version:
    description: CLICredentialDTO's version.
    returned: changed
    sample: '1.0'
    type: str

See also

• cisco.dnac.plugins.module_utils.definitions.global_credential_cli
• GlobalCredentialCli reference: Complete reference of the GlobalCredentialCli object model. link
• GlobalCredentialCli reference: SDK reference. link