fortinet.fortios.fortios_system_snmp_user – Настройка пользователя SNMP в FortiOS и FortiGate Fortinet.

Примечание

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

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

Для использования в книге задач укажите: fortinet.fortios.fortios_system_snmp_user.

В версии 2.9: модуля fortinet.fortios

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

Обзор

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

Требования

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

ansible>=2.9.0

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
access_token строка			Аутентификация на основе токена. Сгенерировано в веб-интерфейсе Fortigate.
state строка / обязательно		Варианты: present absent	Указывает, нужно ли создать или удалить объект.
system_snmp_user словарь			Настройка пользователя SNMP.
	auth_proto строка	Варианты: md5 sha	Протокол аутентификации.
	auth_pwd строка		Пароль для протокола аутентификации.
	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 (ловушки) для отправки.
	ha_direct строка	Варианты: enable disable	Включить/выключить прямое управление членами кластера HA.
	name строка / обязательно		Имя пользователя SNMP.
	notify_hosts список / элементы=строка		SNMP-менеджеры для отправки уведомлений (ловушек).
	notify_hosts6 список / элементы=строка		SNMP-менеджеры IPv6 для отправки уведомлений (ловушек).
	priv_proto строка	Варианты: aes des aes256 aes256cisco	Протокол конфиденциальности (шифрования).
	priv_pwd строка		Пароль для протокола конфиденциальности (шифрования).
	queries строка	Варианты: enable disable	Включить/выключить запросы SNMP для этого пользователя.
	query_port целое число		Порт запросов SNMPv3.
	security_level строка	Варианты: no-auth-no-priv auth-no-priv auth-priv	Уровень безопасности для аутентификации сообщений и шифрования.
	source_ip строка		IP-адрес источника для SNMP-ловушки.
	source_ipv6 строка		IPv6-адрес источника для SNMP-ловушки.
	status строка	Варианты: enable disable	Включить/выключить этого пользователя SNMP.
	trap_lport целое число		Локальный порт SNMPv3 для ловушки.
	trap_rport целое число		Удаленный порт SNMPv3 для ловушки.
	trap_status строка	Варианты: enable disable	Включить/выключить ловушки для этого пользователя SNMP.
vdom строка		По умолчанию: "root"	Виртуальная область, среди ранее определенных. VDOM — это виртуальная копия FortiGate, которую можно настроить и использовать как отдельное устройство.

Примечания

Примечание

Устаревший модуль fortiosapi устарел; httpapi — предпочтительный способ запуска книг задач.

Примеры

- 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 user configuration.
    fortios_system_snmp_user:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_snmp_user:
        auth_proto: "md5"
        auth_pwd: "<your_own_value>"
        events: "cpu-high"
        ha_direct: "enable"
        name: "default_name_7"
        notify_hosts: "<your_own_value>"
        notify_hosts6: "<your_own_value>"
        priv_proto: "aes"
        priv_pwd: "<your_own_value>"
        queries: "enable"
        query_port: "13"
        security_level: "no-auth-no-priv"
        source_ip: "84.230.14.43"
        source_ipv6: "<your_own_value>"
        status: "enable"
        trap_lport: "18"
        trap_rport: "19"
        trap_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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/fortinet/fortios/fortios_system_snmp_user_module.html