yadro.tatlin_uni.tatlin_sp_snmp module – Configure SP SNMP settings

Note

This module is part of the yadro.tatlin_uni collection (version 1.0.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install yadro.tatlin_uni.

To use it in a playbook, specify: yadro.tatlin_uni.tatlin_sp_snmp.

New in version 1.0.0: of yadro.tatlin_uni

Synopsis

  • This module is intended to configure SNMP servers` URIs (IP address or domain name & port) list and community name

  • This module supports check mode

Parameters

Parameter

Comments

community

string

SNMP community name

connection

dictionary / required

connection describes Tatlin Storage Processor (SP) connection configuration.

Only session connection supported.

Authorization is executed automatically with corresponding endpoint. ‘auth/login’ by default.

Client receives x-auth-token and uses it for following requests.

base_url

string / required

Tatlin REST API entrypoint.

password

string

Tatlin user password.

timeout

integer

Tatlin REST API request timeout.

Default: 60

username

string

Tatlin username to login.

validate_certs

boolean

Responsible for SSL certificates validation.

If set to False certificates won’t validated.

Choices:

  • no

  • yes ← (default)

servers

list / elements=dictionary

SNMP servers` addresses

ip

string / required

ip address of trap receiver

port

string / required

port of trap recevier

state

string

present sets listed SNMP servers and community name

absent deletes listed SNMP servers

If no servers listed with absent all servers addresses and community name will be removed

Choices:

  • present ← (default)

  • absent

Examples

---
- name: Set SNMP config
  yadro.tatlin_uni.tatlin_sp_snmp:
    connection: "{{ connection }}"
    community: tatlin
    servers:
      - ip: 127.0.1.2
        port: 162
      - ip: example.com
        port: 162
    state: present

- name: Remove SNMP server
  yadro.tatlin_uni.tatlin_sp_snmp:
    connection: "{{ connection }}"
    servers:
      - ip: example.com
        port: 162
    state: absent

- name: Reset config
  yadro.tatlin_uni.tatlin_sp_snmp:
    connection: "{{ connection }}"
    state: absent

Return Values

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

Key

Description

error

string

Error details if raised

Returned: on error

msg

string

Operation status message

Returned: always

Authors

  • Sergey Kovalev (@kvlvs)