cisco.dnac.global_credential_http_write – Manage GlobalCredentialHttpWrite 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_http_write.

New in version 1.0.0: of cisco.dnac

Synopsis

• Adds global HTTP write credentials.

• Updates global HTTP write 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			HTTPWriteCredentialDTO's comments.
credentialType string			HTTPWriteCredentialDTO's credentialType. Available values are 'GLOBAL' and 'APP'.
description string			HTTPWriteCredentialDTO's description.
id string			HTTPWriteCredentialDTO's id.
instanceTenantId string			HTTPWriteCredentialDTO's instanceTenantId.
instanceUuid string			HTTPWriteCredentialDTO's instanceUuid.
password string			HTTPWriteCredentialDTO'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 http write's comments.
	credentialType string		It is the global credential http write's credentialType.
	description string		It is the global credential http write's description.
	id string		It is the global credential http write's id.
	instanceTenantId string		It is the global credential http write's instanceTenantId.
	instanceUuid string		It is the global credential http write's instanceUuid.
	password string / required		It is the global credential http write's password.
	port integer / required		It is the global credential http write's port.
	secure boolean	Choices: no yes	It is the global credential http write's secure.
	username string / required		It is the global credential http write's username.
port integer			HTTPWriteCredentialDTO's port. Required for state update.
secure boolean		Choices: no yes	HTTPWriteCredentialDTO's secure.
username string			HTTPWriteCredentialDTO's username. Required for state update.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.global_credential_http_write

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

GlobalCredentialHttpWrite reference

Complete reference of the GlobalCredentialHttpWrite object model.

GlobalCredentialHttpWrite reference

SDK reference.

Examples

- name: create_http_write_credentials
  cisco.dnac.global_credential_http_write:
    state: create  # required
    payload:  # required
    - password: SomeValue  # string, required
      port: 1  #  integer, required
      username: SomeValue  # string, required
      comments: SomeValue  # string
      credentialType: SomeValue  # string
      description: SomeValue  # string
      id: SomeValue  # string
      instanceTenantId: SomeValue  # string
      instanceUuid: SomeValue  # string
      secure: True  # boolean

- name: update_http_write_credentials
  cisco.dnac.global_credential_http_write:
    state: update  # required
    password: SomeValue  # string, required
    port: 1  #  integer, 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
    secure: True  # boolean

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_http_write_credentials

Authors

• Rafael Campos (@racampos)