cisco.dnac.http_write_credential module – Resource module for Http Write Credential
Note
This module is part of the cisco.dnac collection (version 6.25.1).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install cisco.dnac
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.dnac.http_write_credential
.
New in cisco.dnac 3.1.0
Synopsis
This module represents an alias of the module http_write_credential_v1
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.4.9
python >= 3.5
Parameters
Parameter |
Comments |
---|---|
Comments to identify the HTTP(S) Write credential. |
|
Credential type to identify the application that uses the HTTP(S) Write credential. |
|
Description for HTTP(S) Write Credential. |
|
Flag for Cisco DNA Center SDK to enable debugging. Choices:
|
|
The Cisco DNA Center hostname. |
|
The Cisco DNA Center password to authenticate. |
|
The Cisco DNA Center port. Default: |
|
The Cisco DNA Center username to authenticate. Default: |
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Cisco DNA Center to use. Default: |
|
Id of the HTTP(S) Write Credential in UUID format. |
|
Deprecated. |
|
Deprecated. |
|
HTTP(S) Write Password. |
|
HTTP(S) Port. Valid port should be in the range of 1 to 65535. |
|
Flag for HTTPS Write. Choices:
|
|
HTTP(S) Write Username. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
Notes
Note
SDK Method used are discovery.Discovery.create_http_write_credentials_v1, discovery.Discovery.update_http_write_credentials_v1,
Paths used are post /dna/intent/api/v1/global-credential/http-write, put /dna/intent/api/v1/global-credential/http-write,
It should be noted that this module is an alias of http_write_credential_v1
Does not support
check_mode
The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK
The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection
See Also
See also
- Cisco DNA Center documentation for Discovery CreateHTTPWriteCredentialsV1
Complete reference of the CreateHTTPWriteCredentialsV1 API.
- Cisco DNA Center documentation for Discovery UpdateHTTPWriteCredentialsV1
Complete reference of the UpdateHTTPWriteCredentialsV1 API.
Examples
- name: Update all
cisco.dnac.http_write_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
id: string
instanceTenantId: string
instanceUuid: string
password: string
port: 0
secure: true
username: string
- name: Create
cisco.dnac.http_write_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
id: string
instanceTenantId: string
instanceUuid: string
password: string
port: 0
secure: true
username: string
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: |