.. Document meta :orphan: .. Anchors .. _ansible_collections.cisco.dnac.global_credential_http_write_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.global_credential_http_write -- Manage GlobalCredentialHttpWrite objects of Discovery ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This plugin is part of the `cisco.dnac collection `_ (version 2.0.7). To install it use: :code:`ansible-galaxy collection install cisco.dnac`. To use it in a playbook, specify: :code:`cisco.dnac.global_credential_http_write`. .. version_added .. versionadded:: 1.0.0 of cisco.dnac .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Adds global HTTP write credentials. - Updates global HTTP write credentials. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk .. Options Parameters ---------- .. raw:: html

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.

.. Notes .. Seealso See Also -------- .. seealso:: :ref:`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 Examples -------- .. code-block:: yaml+jinja - 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 .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. raw:: html

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

.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Parsing errors