cisco.dnac.snmp_property – Manage SnmpProperty 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.snmp_property.

New in version 1.0.0: of cisco.dnac

Synopsis

• Returns SNMP properties.

• Adds SNMP properties.

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
payload list / elements=dictionary			An object to send in the Request body. Required for state create.
	id string		It is the snmp property's id.
	instanceTenantId string		It is the snmp property's instanceTenantId.
	instanceUuid string		It is the snmp property's instanceUuid.
	intValue integer		It is the snmp property's intValue.
	systemPropertyName string		It is the snmp property's systemPropertyName.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.snmp_property

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

SnmpProperty reference

Complete reference of the SnmpProperty object model.

SnmpProperty reference

SDK reference.

Examples

- name: get_snmp_properties
  cisco.dnac.snmp_property:
    state: query  # required
  register: nm_get_snmp_properties

- name: create_update_snmp_properties
  cisco.dnac.snmp_property:
    state: create  # required
    payload:  # required
    - id: SomeValue  # string
      instanceTenantId: SomeValue  # string
      instanceUuid: SomeValue  # string
      intValue: 1  #  integer
      systemPropertyName: 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_update_snmp_properties

Authors

• Rafael Campos (@racampos)