fortinet.fortimanager.fmgr_devprof_system_snmp_community – Настройка сообщества SNMP.

Примечание

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

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

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

Добавлен в версии 2.10: библиотеки fortinet.fortimanager

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

Обзор

Этот модуль позволяет настроить устройство FortiManager.
Примеры включают все параметры и значения, которые необходимо скорректировать перед использованием из источников данных.

Параметры

Параметр			Варианты/Значения по умолчанию	Комментарии
adom строка / обязательно				параметр (adom) в запрошенном URL
bypass_validation булево			Варианты: нет ← да	устанавливается в True только когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров
devprof строка / обязательно				параметр (devprof) в запрошенном URL
devprof_system_snmp_community словарь				устанавливаемые параметры верхнего уровня
	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 temperature-high voltage-alert ha-member-up ha-member-down ent-conf-change av-conserve av-bypass av-oversize-passed av-oversize-blocked ips-pkg-update power-supply-failure amc-bypass faz-disconnect fan-failure bgp-established bgp-backward-transition wc-ap-up wc-ap-down fswctl-session-up fswctl-session-down ips-fail-open load-balance-real-server-down device-new enter-intf-bypass exit-intf-bypass per-cpu-high power-blade-down confsync_failure	нет описания
	hosts список / элементы=строка			нет описания
		ha-direct строка	Варианты: отключить включить	Включить/выключить прямое управление членами кластера HA.
		host-type строка	Варианты: любой запрос ловушки	Управление тем, отправляет ли SNMP-менеджер SNMP-запросы, получает ли SNMP-ловушки или оба.
		id целое число		Идентификатор записи хоста.
		ip строка		IPv4-адрес SNMP-менеджера (хоста).
		source-ip строка		Исходный IPv4-адрес для SNMP-ловушек.
	hosts6 список / элементы=строка			нет описания
		ha-direct строка	Варианты: отключить включить	Включить/выключить прямое управление членами кластера HA.
		host-type строка	Варианты: любой запрос ловушки	Управление тем, отправляет ли SNMP-менеджер SNMP-запросы, получает ли SNMP-ловушки или оба.
		id целое число		Идентификатор записи хоста6.
		ipv6 строка		Префикс IPv6-адреса SNMP-менеджера.
		source-ipv6 строка		Исходный IPv6-адрес для SNMP-ловушек.
	id целое число			Идентификатор сообщества.
	name строка			Имя сообщества.
	query-v1-port целое число			Порт запроса SNMP v1 (по умолчанию = 161).
	query-v1-status строка		Варианты: отключить включить	Включить/выключить SNMP v1-запросы.
	query-v2c-port целое число			Порт запроса SNMP v2c (по умолчанию = 161).
	query-v2c-status строка		Варианты: отключить включить	Включить/выключить SNMP v2c-запросы.
	status строка		Варианты: отключить включить	Включить/выключить это SNMP-сообщество.
	trap-v1-lport целое число			Локальный порт ловушки SNMP v1 (по умолчанию = 162).
	trap-v1-rport целое число			Удаленный порт ловушки SNMP v1 (по умолчанию = 162).
	trap-v1-status строка		Варианты: отключить включить	Включить/выключить SNMP v1-ловушки.
	trap-v2c-lport целое число			Локальный порт ловушки SNMP v2c (по умолчанию = 162).
	trap-v2c-rport целое число			Удаленный порт ловушки SNMP v2c (по умолчанию = 162).
	trap-v2c-status строка		Варианты: отключить включить	Включить/выключить SNMP v2c-ловушки.
rc_failed список / элементы=строка				список кодов rc, с которыми будут переопределены условия сбоя
rc_succeeded список / элементы=строка				список кодов rc, с которыми будут переопределены условия успеха
state строка / обязательно			Варианты: present absent	направление для создания, обновления или удаления объекта
workspace_locking_adom строка				adom для блокировки FortiManager, работающего в режиме рабочего пространства, значение может быть глобальным и другими, включая root
workspace_locking_timeout целое число			По умолчанию: 300	максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство

Примечания

Примечание

Режим блокировки рабочего пространства поддерживается в этом модуле FortiManager, параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают выполнить работу.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно выполнение одного модуля может завершиться ошибкой, когда возвращается ненулевой код rc. Также можно переопределить условия для завершения ошибкой или успехом с помощью параметров rc_failed и rc_succeeded

Примеры

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: SNMP community configuration.
     fmgr_devprof_system_snmp_community:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        devprof: <your own value>
        state: <value in [present, absent]>
        devprof_system_snmp_community:
           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
             - temperature-high
             - voltage-alert
             - ha-member-up
             - ha-member-down
             - ent-conf-change
             - av-conserve
             - av-bypass
             - av-oversize-passed
             - av-oversize-blocked
             - ips-pkg-update
             - power-supply-failure
             - amc-bypass
             - faz-disconnect
             - fan-failure
             - bgp-established
             - bgp-backward-transition
             - wc-ap-up
             - wc-ap-down
             - fswctl-session-up
             - fswctl-session-down
             - ips-fail-open
             - load-balance-real-server-down
             - device-new
             - enter-intf-bypass
             - exit-intf-bypass
             - per-cpu-high
             - power-blade-down
             - confsync_failure
           hosts:
             -
                 ha-direct: <value in [disable, enable]>
                 host-type: <value in [any, query, trap]>
                 id: <value of integer>
                 ip: <value of string>
                 source-ip: <value of string>
           hosts6:
             -
                 ha-direct: <value in [disable, enable]>
                 host-type: <value in [any, query, trap]>
                 id: <value of integer>
                 ipv6: <value of string>
                 source-ipv6: <value of string>
           id: <value of integer>
           name: <value of string>
           query-v1-port: <value of integer>
           query-v1-status: <value in [disable, enable]>
           query-v2c-port: <value of integer>
           query-v2c-status: <value in [disable, enable]>
           status: <value in [disable, enable]>
           trap-v1-lport: <value of integer>
           trap-v1-rport: <value of integer>
           trap-v1-status: <value in [disable, enable]>
           trap-v2c-lport: <value of integer>
           trap-v2c-rport: <value of integer>
           trap-v2c-status: <value in [disable, enable]>

Возвращаемые значения

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

Ключ	Возвращаемое значение	Описание
request_url string	всегда	Полный URL запроса Пример: /sys/login/user
response_code integer	всегда	Статус запроса API
response_message string	всегда	Дескриптивное сообщение ответа API Пример: OK.

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

© 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/fortimanager/fmgr_devprof_system_snmp_community_module.html