cisco.catalystcenter.snmp_properties_v1 module -- Resource module for Snmp Properties V1

Note

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

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.snmp_properties_v1.

New in cisco.catalystcenter 3.1.0

Synopsis

  • Manage operation create of the resource Snmp Properties V1.

  • Adds SNMP properties.

Note

This module has a corresponding action plugin.

Requirements

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

  • catalystcentersdk >= 2.3.7.9

  • python >= 3.5

Parameters

Parameter

Comments

_api_port

integer

The Cisco CATALYST Center port.

Default: :ansible-option-default:`443`

_debug

boolean

Flag for Cisco CATALYST Center SDK to enable debugging.

Choices:

_host

string / required

The Cisco CATALYST Center hostname.

_password

string

The Cisco CATALYST Center password to authenticate.

_username

aliases: user

string

The Cisco CATALYST Center username to authenticate.

Default: :ansible-option-default:`"admin"`

_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

_version

string

Informs the SDK which version of Cisco CATALYST Center to use.

Default: :ansible-option-default:`"2.3.7.6"`

payload

list / elements=dictionary

Snmp Properties's payload.

id

string

Snmp Properties's id.

instanceTenantId

string

Snmp Properties's instanceTenantId.

instanceUuid

string

Snmp Properties's instanceUuid.

intValue

integer

Snmp Properties's intValue.

systemPropertyName

string

Snmp Properties's systemPropertyName.

validate_response_schema

boolean

Flag for Cisco CATALYST Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

Notes

Note

  • SDK Method used are discovery.Discovery.create_update_snmp_properties_v1,

  • Paths used are post /dna/intent/api/v1/snmp-property,

  • Does not support check_mode

  • The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco CATALYST SDK

  • The parameters starting with catalystCenter_ are used by the Cisco CATALYST Python SDK to establish the connection

See Also

See also

Cisco DNA Center documentation for Discovery CreateUpdateSNMPPropertiesV1

Complete reference of the CreateUpdateSNMPPropertiesV1 API.

Examples

- name: Create
  cisco.catalystcenter.snmp_properties_v1:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    state: present
    payload:
      - id: string
        instanceTenantId: string
        instanceUuid: string
        intValue: 0
        systemPropertyName: string

Return Values

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

Key

Description

catalystcenter_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)