community / community.general / 0.1.1 / module / onyx_snmp Manages SNMP general configurations on Mellanox ONYX network devices Authors: Sara-Touqan (@sarato) preview | supported by communitycommunity.general.onyx_snmp (0.1.1) — module
Install with ansible-galaxy collection install community.general:==0.1.1
collections: - name: community.general version: 0.1.1
This module provides declarative management of SNMP on Mellanox ONYX network devices.
- name: configure SNMP onyx_snmp: state_enabled: yes contact_name: sara location: Nablus communities_enabled: no multi_communities_enabled: no notify_enabled: yes notify_port: 1 notify_community: community_1 notify_send_test: yes notify_event: temperature-too-high snmp_communities: - community_name: public community_type: read-only state: absent snmp_permissions: - state_enabled: yes permission_type: MELLANOX-CONFIG-DB-MIB
location: description: - Sets the SNMP location. type: str notify_port: description: - Sets the default port to which notifications are sent. type: str contact_name: description: - Sets the SNMP contact name. type: str notify_event: choices: - asic-chip-down - dcbx-pfc-port-oper-state-trap - insufficient-power - mstp-new-bridge-root - ospf-lsdb-approaching-overflow - sm-stop - user-logout - cli-line-executed - dcbx-pfc-port-peer-state-trap - interface-down - mstp-new-root-port - ospf-lsdb-overflow - snmp-authtrap - xstp-new-root-bridge - cpu-util-high - disk-io-high - interface-up - mstp-topology-change - ospf-nbr-state-change - temperature-too-high - xstp-root-port-change - dcbx-ets-module-state-change - disk-space-low - internal-bus-error - netusage-high - paging-high - topology_change - xstp-topology-change - dcbx-ets-port-admin-state-trap - entity-state-change - internal-link-speed-mismatch - new_root - power-redundancy-mismatch - unexpected-cluster-join - dcbx-ets-port-oper-state-trap - expected-shutdown - liveness-failure - ospf-auth-fail - process-crash - unexpected-cluster-leave - dcbx-ets-port-peer-state-trap - health-module-status - low-power - ospf-config-error - process-exit - unexpected-cluster-size - dcbx-pfc-module-state-change - insufficient-fans - low-power-recover - ospf-if-rx-bad-packet - sm-restart - unexpected-shutdown - dcbx-pfc-port-admin-state-trap - insufficient-fans-recover - memusage-high - ospf-if-state-change - sm-start - user-login description: - Specifys which events will be sent as SNMP notifications. type: str state_enabled: description: - Enables/Disables the state of the SNMP configuration. type: bool notify_enabled: description: - Enables/Disables sending of SNMP notifications (traps and informs) from thee system. type: bool engine_id_reset: description: - Sets SNMPv3 engineID to node unique value. type: bool notify_community: description: - Sets the default community for SNMP v1 and v2c notifications sent to hosts which do not have a community override set. type: str notify_send_test: choices: - 'yes' - 'no' description: - Sends a test notification. type: str snmp_communities: description: - List of snmp communities suboptions: community_name: description: - Configures snmp community name. required: true type: str community_type: choices: - read-only - read-write description: - Add this community as either a read-only or read-write community. type: str state: choices: - present - absent description: - Used to decide if you want to delete the given snmp community or not type: str type: list snmp_permissions: description: - Allow SNMPSET requests for items in a MIB. suboptions: permission_type: choices: - MELLANOX-CONFIG-DB-MIB - MELLANOX-EFM-MIB - MELLANOX-POWER-CYCLE - MELLANOX-SW-UPDATE - RFC1213-MIB description: - Configures the request type. type: str state_enabled: description: - Enables/Disables the request. required: true type: bool type: list communities_enabled: description: - Enables/Disables community-based authentication on the system. type: bool multi_communities_enabled: description: - Enables/Disables multiple communities to be configured. type: bool
commands: description: The list of configuration mode commands to send to the device returned: always. sample: - snmp-server enable - no snmp-server enable - snmp-server location <location_name> - snmp-server contact <contact_name> - snmp-server enable communities - no snmp-server enable communities - snmp-server enable mult-communities - no snmp-server enable mult-communities - snmp-server enable notify - snmp-server notify port <port_number> - snmp-server notify community <community_name> - snmp-server notify send-test - snmp-server notify event <event_name> - snmp-server enable set-permission <permission_type> - no snmp-server enable set-permission <permission_type> - snmp-server community <community_name> <community_type> - no snmp-server community <community_name>. - snmp-server engineID reset. type: list