cisco.dnac.global_credential_http_read – Manage GlobalCredentialHttpRead 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_read.

New in version 1.0.0: of cisco.dnac

Synopsis
Requirements
Parameters
See Also
Examples
Return Values

Synopsis ¶

Adds HTTP read credentials.
Updates global HTTP Read credential.

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

Examples ¶

- name: create_http_read_credentials
  cisco.dnac.global_credential_http_read:
    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_read_credential
  cisco.dnac.global_credential_http_read:
    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_read_credentials

Authors¶

Rafael Campos (@racampos)

cisco.dnac.global_credential_http_read – Manage GlobalCredentialHttpRead objects of Discovery¶

Synopsis¶

Requirements¶

Parameters¶

See Also¶

Examples¶

Return Values¶