cisco.dnac.global_credential_netconf – Manage GlobalCredentialNetconf 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_netconf.

New in version 1.0.0: of cisco.dnac

Synopsis

• Adds global netconf credentials.

• Updates global netconf 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			NetconfCredentialDTO's comments.
credentialType string			NetconfCredentialDTO's credentialType. Available values are 'GLOBAL' and 'APP'.
description string			NetconfCredentialDTO's description.
id string			NetconfCredentialDTO's id.
instanceTenantId string			NetconfCredentialDTO's instanceTenantId.
instanceUuid string			NetconfCredentialDTO's instanceUuid.
netconfPort string			NetconfCredentialDTO's netconfPort. 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 netconf's comments.
	credentialType string		It is the global credential netconf's credentialType.
	description string		It is the global credential netconf's description.
	id string		It is the global credential netconf's id.
	instanceTenantId string		It is the global credential netconf's instanceTenantId.
	instanceUuid string		It is the global credential netconf's instanceUuid.
	netconfPort string / required		It is the global credential netconf's netconfPort.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.global_credential_netconf

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

GlobalCredentialNetconf reference

Complete reference of the GlobalCredentialNetconf object model.

GlobalCredentialNetconf reference

SDK reference.

Examples

- name: create_netconf_credentials
  cisco.dnac.global_credential_netconf:
    state: create  # required
    payload:  # required
    - netconfPort: SomeValue  # string, required
      comments: SomeValue  # string
      credentialType: SomeValue  # string
      description: SomeValue  # string
      id: SomeValue  # string
      instanceTenantId: SomeValue  # string
      instanceUuid: SomeValue  # string

- name: update_netconf_credentials
  cisco.dnac.global_credential_netconf:
    state: update  # required
    netconfPort: 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

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_netconf_credentials

Authors

• Rafael Campos (@racampos)