File: //lib/python3.9/site-packages/ansible_collections/cisco/dnac/plugins/modules/cli_credential.py
# -*- coding: utf-8 -*-
# Copyright (c) 2021, Cisco Systems
# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
DOCUMENTATION = r"""
---
module: cli_credential
short_description: Resource module for Cli Credential
description:
- Manage operations create and update of the resource Cli Credential.
- Adds global CLI credential.
- Updates global CLI credentials.
version_added: '3.1.0'
extends_documentation_fragment:
- cisco.dnac.module
author: Rafael Campos (@racampos)
options:
comments:
description: Cli Credential's comments.
type: str
credentialType:
description: Cli Credential's credentialType.
type: str
description:
description: Cli Credential's description.
type: str
enablePassword:
description: Cli Credential's enablePassword.
type: str
id:
description: Cli Credential's id.
type: str
instanceTenantId:
description: Cli Credential's instanceTenantId.
type: str
instanceUuid:
description: Cli Credential's instanceUuid.
type: str
password:
description: Cli Credential's password.
type: str
username:
description: Cli Credential's username.
type: str
requirements:
- dnacentersdk >= 2.5.5
- python >= 3.5
seealso:
- name: Cisco DNA Center documentation for Discovery CreateCLICredentials
description: Complete reference of the CreateCLICredentials API.
link: https://developer.cisco.com/docs/dna-center/#!create-cli-credentials
- name: Cisco DNA Center documentation for Discovery UpdateCLICredentials
description: Complete reference of the UpdateCLICredentials API.
link: https://developer.cisco.com/docs/dna-center/#!update-cli-credentials
notes:
- SDK Method used are
discovery.Discovery.create_cli_credentials,
discovery.Discovery.update_cli_credentials,
- Paths used are
post /dna/intent/api/v1/global-credential/cli,
put /dna/intent/api/v1/global-credential/cli,
"""
EXAMPLES = r"""
- name: Update all
cisco.dnac.cli_credential:
dnac_host: "{{dnac_host}}"
dnac_username: "{{dnac_username}}"
dnac_password: "{{dnac_password}}"
dnac_verify: "{{dnac_verify}}"
dnac_port: "{{dnac_port}}"
dnac_version: "{{dnac_version}}"
dnac_debug: "{{dnac_debug}}"
state: present
comments: string
credentialType: string
description: string
enablePassword: string
id: string
instanceTenantId: string
instanceUuid: string
password: string
username: string
- name: Create
cisco.dnac.cli_credential:
dnac_host: "{{dnac_host}}"
dnac_username: "{{dnac_username}}"
dnac_password: "{{dnac_password}}"
dnac_verify: "{{dnac_verify}}"
dnac_port: "{{dnac_port}}"
dnac_version: "{{dnac_version}}"
dnac_debug: "{{dnac_debug}}"
state: present
comments: string
credentialType: string
description: string
enablePassword: string
id: string
instanceTenantId: string
instanceUuid: string
password: string
username: string
"""
RETURN = r"""
dnac_response:
description: A dictionary or list with the response returned by the Cisco DNAC Python SDK
returned: always
type: dict
sample: >
{
"response": {
"taskId": "string",
"url": "string"
},
"version": "string"
}
"""