cisco.dnac.global_credential_cli – Manage GlobalCredentialCli 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_cli.

New in version 1.0.0: of cisco.dnac

Synopsis

• Adds global CLI credential.

• Updates global CLI credentials.

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
comments string			CLICredentialDTO's comments.
credentialType string			CLICredentialDTO's credentialType. Available values are 'GLOBAL' and 'APP'.
description string			CLICredentialDTO's description.
enablePassword string			CLICredentialDTO's enablePassword. Required for state update.
id string			CLICredentialDTO's id.
instanceTenantId string			CLICredentialDTO's instanceTenantId.
instanceUuid string			CLICredentialDTO's instanceUuid.
password string			CLICredentialDTO's password. Required for state update.
payload list / elements=dictionary			An object to send in the Request body. Required for state create.
	comments string		It is the global credential cli's comments.
	credentialType string		It is the global credential cli's credentialType.
	description string		It is the global credential cli's description.
	enablePassword string / required		It is the global credential cli's enablePassword.
	id string		It is the global credential cli's id.
	instanceTenantId string		It is the global credential cli's instanceTenantId.
	instanceUuid string		It is the global credential cli's instanceUuid.
	password string / required		It is the global credential cli's password.
	username string / required		It is the global credential cli's username.
username string			CLICredentialDTO's username. Required for state update.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.global_credential_cli

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

GlobalCredentialCli reference

Complete reference of the GlobalCredentialCli object model.

GlobalCredentialCli reference

SDK reference.

Examples

- 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

- 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: # valid values are 'GLOBAL',
      # 'APP'.
      SomeValue  # string
    description: SomeValue  # string
    id: SomeValue  # string
    instanceTenantId: SomeValue  # string
    instanceUuid: SomeValue  # string

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

Authors

• Rafael Campos (@racampos)