fortinet.fortios.fortios_system_snmp_community – Настройка сообщества SNMP в FortiOS и FortiGate Fortinet.

Примечание

Этот плагин входит в коллекцию fortinet.fortios (версия 1.1.8).

Для его установки используйте: ansible-galaxy collection install fortinet.fortios.

Для использования в плейбуке укажите: fortinet.fortios.fortios_system_snmp_community.

Новое в версии 2.9: of fortinet.fortios

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Этот модуль позволяет настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять системные параметры SNMP и категории сообщества. Примеры включают все параметры и значения, которые необходимо настроить перед использованием. Тестировалось с FOS v6.0.0

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

ansible>=2.9.0

Параметры

Параметр			Варианты/Значения по умолчанию	Комментарии
access_token строка				Аутентификация на основе токена. Сгенерировано из GUI Fortigate.
state строка / обязательно			Варианты: present absent	Указывает, нужно ли создать или удалить объект.
system_snmp_community словарь				Конфигурация сообщества SNMP.
	events список / элементы=строка		Варианты: cpu-high mem-low log-full intf-ip vpn-tun-up vpn-tun-down ha-switch ha-hb-failure ips-signature ips-anomaly av-virus av-oversize av-pattern av-fragmented fm-if-change fm-conf-change bgp-established bgp-backward-transition ha-member-up ha-member-down ent-conf-change av-conserve av-bypass av-oversize-passed av-oversize-blocked ips-pkg-update ips-fail-open faz-disconnect wc-ap-up wc-ap-down fswctl-session-up fswctl-session-down load-balance-real-server-down device-new per-cpu-high	События SNMP ловушки.
	hosts список / элементы=строка			Настройка IPv4 SNMP менеджеров (хостов).
		ha_direct строка	Варианты: enable disable	Включить/выключить прямой доступ к членам кластера HA.
		host_type строка	Варианты: any query trap	Управление тем, отправляет ли SNMP менеджер запросы SNMP, получает ли SNMP ловушки или то и другое.
		id целое число / обязательно		Идентификатор записи хоста.
		ip строка		IPv4-адрес SNMP менеджера (хоста).
		source_ip строка		Источник IPv4-адреса для SNMP ловушек.
	hosts6 список / элементы=строка			Настройка IPv6 SNMP менеджеров.
		ha_direct строка	Варианты: enable disable	Включить/выключить прямой доступ к членам кластера HA.
		host_type строка	Варианты: any query trap	Управление тем, отправляет ли SNMP менеджер запросы SNMP, получает ли SNMP ловушки или то и другое.
		id целое число / обязательно		Идентификатор записи хоста6.
		ipv6 строка		Префикс IPv6 адреса SNMP менеджера.
		source_ipv6 строка		Источник IPv6-адреса для SNMP ловушек.
	id целое число / обязательно			Идентификатор сообщества.
	name строка			Имя сообщества.
	query_v1_port целое число			Порт запроса SNMP v1.
	query_v1_status строка		Варианты: enable disable	Включить/выключить запросы SNMP v1.
	query_v2c_port целое число			Порт запроса SNMP v2c.
	query_v2c_status строка		Варианты: enable disable	Включить/выключить запросы SNMP v2c.
	status строка		Варианты: enable disable	Включить/выключить это SNMP сообщество.
	trap_v1_lport целое число			Локальный порт ловушки SNMP v1.
	trap_v1_rport целое число			Удаленный порт ловушки SNMP v1.
	trap_v1_status строка		Варианты: enable disable	Включить/выключить ловушки SNMP v1.
	trap_v2c_lport целое число			Локальный порт ловушки SNMP v2c.
	trap_v2c_rport целое число			Удаленный порт ловушки SNMP v2c.
	trap_v2c_status строка		Варианты: enable disable	Включить/выключить ловушки SNMP v2c.
vdom строка			По умолчанию: "root"	Виртуальная область, определенная ранее. Vdom — виртуальная инстанция FortiGate, которая может быть настроена и использована как отдельное устройство.

Примечания

Примечание

Модуль fortiosapi устарел, httpapi — предпочтительный способ выполнения playbooks

Примеры

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: SNMP community configuration.
    fortios_system_snmp_community:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_snmp_community:
        events: "cpu-high"
        hosts:
         -
            ha_direct: "enable"
            host_type: "any"
            id:  "7"
            ip: "<your_own_value>"
            source_ip: "84.230.14.43"
        hosts6:
         -
            ha_direct: "enable"
            host_type: "any"
            id:  "13"
            ipv6: "<your_own_value>"
            source_ipv6: "<your_own_value>"
        id:  "16"
        name: "default_name_17"
        query_v1_port: "18"
        query_v1_status: "enable"
        query_v2c_port: "20"
        query_v2c_status: "enable"
        status: "enable"
        trap_v1_lport: "23"
        trap_v1_rport: "24"
        trap_v1_status: "enable"
        trap_v2c_lport: "26"
        trap_v2c_rport: "27"
        trap_v2c_status: "enable"

Значения возврата

Общие значения возврата описаны здесь, следующие — поля, уникальные для данного модуля:

Ключ	Возвращаемое значение	Описание
build строка	всегда	Номер сборки изображения FortiGate Пример: 1547
http_method строка	всегда	Последний метод, использованный для предоставления содержимого в FortiGate Пример: PUT
http_status строка	всегда	Последний результат, полученный от FortiGate при последней операции Пример: 200
mkey строка	успех	Главный ключ (id), используемый в последнем вызове FortiGate Пример: id
name строка	всегда	Имя таблицы, используемой для выполнения запроса Пример: urlfilter
path строка	всегда	Путь таблицы, используемой для выполнения запроса Пример: webfilter
revision строка	всегда	Внутренний номер ревизии Пример: 17.0.2.10658
serial строка	всегда	Серийный номер устройства Пример: FGVMEVYYQT3AB5352
status строка	всегда	Указание результата операции Пример: успех
vdom строка	всегда	Используемый виртуальный домен Пример: root
version строка	всегда	Версия FortiGate Пример: v5.6.3

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortios/fortios_system_snmp_community_module.html