cisco.dnac.global_credential_snmpv3 – Manage GlobalCredentialSnmpv3 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_snmpv3.

New in version 1.0.0: of cisco.dnac

Synopsis

• Adds global SNMPv3 credentials.

• Updates global SNMPv3 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
authPassword string			SNMPv3CredentialDTO's authPassword.
authType string			SNMPv3CredentialDTO's authType. Available values are 'SHA' and 'MD5'.
comments string			SNMPv3CredentialDTO's comments.
credentialType string			SNMPv3CredentialDTO's credentialType. Available values are 'GLOBAL' and 'APP'.
description string			SNMPv3CredentialDTO's description.
id string			SNMPv3CredentialDTO's id.
instanceTenantId string			SNMPv3CredentialDTO's instanceTenantId.
instanceUuid string			SNMPv3CredentialDTO's instanceUuid.
payload list / elements=dictionary			An object to send in the Request body. Required for state create.
	authPassword string		It is the global credential snmpv3's authPassword.
	authType string		It is the global credential snmpv3's authType.
	comments string		It is the global credential snmpv3's comments.
	credentialType string		It is the global credential snmpv3's credentialType.
	description string		It is the global credential snmpv3's description.
	id string		It is the global credential snmpv3's id.
	instanceTenantId string		It is the global credential snmpv3's instanceTenantId.
	instanceUuid string		It is the global credential snmpv3's instanceUuid.
	privacyPassword string		It is the global credential snmpv3's privacyPassword.
	privacyType string		It is the global credential snmpv3's privacyType.
	snmpMode string / required		It is the global credential snmpv3's snmpMode.
	username string / required		It is the global credential snmpv3's username.
privacyPassword string			SNMPv3CredentialDTO's privacyPassword.
privacyType string			SNMPv3CredentialDTO's privacyType. Available values are 'DES' and 'AES128'.
snmpMode string			SNMPv3CredentialDTO's snmpMode. Available values are 'AUTHPRIV', 'AUTHNOPRIV' and 'NOAUTHNOPRIV'. Required for state update.
username string			SNMPv3CredentialDTO's username. Required for state update.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.global_credential_snmpv3

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

GlobalCredentialSnmpv3 reference

Complete reference of the GlobalCredentialSnmpv3 object model.

GlobalCredentialSnmpv3 reference

SDK reference.

Examples

- name: create_snmpv3_credentials
  cisco.dnac.global_credential_snmpv3:
    state: create  # required
    payload:  # required
    - snmpMode: SomeValue  # string, required
      username: SomeValue  # string, required
      authPassword: SomeValue  # string
      authType: SomeValue  # string
      comments: SomeValue  # string
      credentialType: SomeValue  # string
      description: SomeValue  # string
      id: SomeValue  # string
      instanceTenantId: SomeValue  # string
      instanceUuid: SomeValue  # string
      privacyPassword: SomeValue  # string
      privacyType: SomeValue  # string

- name: update_snmpv3_credentials
  cisco.dnac.global_credential_snmpv3:
    state: update  # required
    snmpMode: # valid values are 'AUTHPRIV',
      # 'AUTHNOPRIV',
      # 'NOAUTHNOPRIV'.
      SomeValue  # string, required
    username: SomeValue  # string, required
    authPassword: SomeValue  # string
    authType: # valid values are 'SHA',
      # 'MD5'.
      SomeValue  # string
    comments: SomeValue  # string
    credentialType: # valid values are 'GLOBAL',
      # 'APP'.
      SomeValue  # string
    description: SomeValue  # string
    id: SomeValue  # string
    instanceTenantId: SomeValue  # string
    instanceUuid: SomeValue  # string
    privacyPassword: SomeValue  # string
    privacyType: # valid values are 'DES',
      # 'AES128'.
      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_snmpv3_credentials

Authors

• Rafael Campos (@racampos)