cisco.catalystcenter.snmpv3_credential module -- Resource module for Snmpv3 Credential

Note

This module is part of the cisco.catalystcenter collection (version 2.3.1).

To install it, use: ansible-galaxy collection install cisco.catalystcenter. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.catalystcenter.snmpv3_credential.

New in cisco.catalystcenter 3.1.0

Synopsis

• Manage operations create and update of the resource Snmpv3 Credential.

• Adds global SNMPv3 credentials.

• Updates global SNMPv3 credential.

Requirements

The below requirements are needed on the host that executes this module.

• catalystcentersdk >= 3.1.6.0.0

• python >= 3.12

Parameters

Parameter	Comments
authPassword string	Auth password for SNMPv3. Required if snmpMode is 'AUTHPRIV' or 'AUTHNOPRIV'. Use 'NO!$DATA!$' if no change required.
authType string	SNMPv3 auth protocol. 'SHA' or 'MD5'. Required if snmpMode is 'AUTHPRIV' or 'AUTHNOPRIV'.
catalystcenter_debug boolean	Flag for Cisco Catalyst Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
catalystcenter_host string / required	The Cisco Catalyst Center hostname.
catalystcenter_password string	The Cisco Catalyst Center password to authenticate.
catalystcenter_port integer	The Cisco Catalyst Center port. Default: :ansible-option-default:`443`
catalystcenter_username string	The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"`
catalystcenter_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
catalystcenter_version string	Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"3.1.6.0"`
comments string	Comments to identify the SNMPv3 credential.
credentialType string	Credential type to identify the application that uses the SNMPv3 credential.
description string	Description for SNMPv3 Credential.
id string	Id of the SNMPv3 Credential.
instanceTenantId string	Deprecated. This attribute will be removed in a future release, should not be used, and any value supplied will be ignored.
instanceUuid string	Deprecated. This attribute will be removed in a future release, should not be used, and any value supplied will be ignored.
privacyPassword string	Privacy password for SNMPv3 privacy. Required if snmpMode is 'AUTHPRIV'. Use 'NO!$DATA!$' if no change required.
privacyType string	SNMPv3 privacy protocol. Required is snmpMode is 'AUTHPRIV'.
snmpMode string	Mode of SNMPv3. 'AUTHPRIV' or 'AUTHNOPRIV' or 'NOAUTHNOPRIV'.
username string	SNMPv3 username.
validate_response_schema boolean	Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)

Notes

Note

• SDK Method used are discovery.Discovery.create_snmpv3_credentials, discovery.Discovery.update_snmpv3_credentials,

• Paths used are post /dna/intent/api/v1/global-credential/snmpv3, put /dna/intent/api/v1/global-credential/snmpv3,

• Does not support check_mode

• The plugin runs on the control node and does not use any ansible connection plugins,

• but instead uses the embedded connection manager from Cisco CATALYST SDK

See Also

See also

Cisco DNA Center documentation for Discovery CreateSNMPv3Credentials

Complete reference of the CreateSNMPv3Credentials API.

Cisco DNA Center documentation for Discovery UpdateSNMPv3Credentials

Complete reference of the UpdateSNMPv3Credentials API.

Examples

---
- name: Create
  cisco.catalystcenter.snmpv3_credential:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    state: present
    authPassword: string
    authType: string
    comments: string
    credentialType: string
    description: string
    id: string
    instanceTenantId: string
    instanceUuid: string
    privacyPassword: string
    privacyType: string
    snmpMode: string
    username: string
- name: Update all
  cisco.catalystcenter.snmpv3_credential:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    state: present
    authPassword: string
    authType: string
    comments: string
    credentialType: string
    description: string
    id: string
    instanceTenantId: string
    instanceUuid: string
    privacyPassword: string
    privacyType: string
    snmpMode: string
    username: string

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
dnac_response dictionary	A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)