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

Примечание

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

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

Чтобы использовать его в книге задач, укажите: fortinet.fortimanager.fmgr_system_snmp_community.

В версии 2.10: плагин fortinet.fortimanager

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

Обзор

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

Параметры

Параметр			Варианты/Значения по умолчанию	Комментарии
bypass_validation boolean			Варианты: нет ← да	устанавливается в True только при различиях в схеме модуля и структуре API FortiManager, модуль продолжает выполнение без валидации параметров
rc_failed список / элементы=строка				список кодов rc, при которых условия неудачи будут переопределены
rc_succeeded список / элементы=строка				список кодов rc, при которых условия успеха будут переопределены
state строка / обязательно			Варианты: present absent	указание на создание, обновление или удаление объекта
system_snmp_community словарь				установленные параметры верхнего уровня
	events список / элементы=строка		Варианты: disk_low ha_switch intf_ip_chg sys_reboot cpu_high mem_low log-alert log-rate log-data-rate lic-gbday lic-dev-quota cpu-high-exclude-nice	без описания
	hosts список / элементы=строка			без описания
		id целое число	Значение по умолчанию: 0	Идентификатор записи узла.
		interface строка		Разрешенное имя интерфейса.
		ip строка	Значение по умолчанию: "0.0.0.0 0.0.0.0"	Разрешенный IP-адрес узла.
	hosts6 список / элементы=строка			без описания
		id целое число	Значение по умолчанию: 0	Идентификатор записи узла.
		interface строка		Разрешенное имя интерфейса.
		ip строка	Значение по умолчанию: "::/0"	Разрешенный IP-адрес узла.
	id целое число		Значение по умолчанию: 0	Идентификатор сообщества.
	name строка			Имя сообщества.
	query_v1_port целое число		Значение по умолчанию: 161	Порт запроса SNMP v1.
	query_v1_status строка		Варианты: отключено включено ←	Включение/выключение запросов SNMP v1. отключено - Отключение функции. включено - Включение функции.
	query_v2c_port целое число		Значение по умолчанию: 161	Порт запроса SNMP v2c.
	query_v2c_status строка		Варианты: отключено включено ←	Включение/выключение запросов SNMP v2c. отключено - Отключение функции. включено - Включение функции.
	status строка		Варианты: отключено включено ←	Включение/выключение сообщества. отключено - Отключение функции. включено - Включение функции.
	trap_v1_rport целое число		Значение по умолчанию: 162	Удаленный порт SNMP v1 трапов.
	trap_v1_status строка		Варианты: отключено включено ←	Включение/выключение SNMP v1 трапов. отключено - Отключение функции. включено - Включение функции.
	trap_v2c_rport целое число		Значение по умолчанию: 162	Удаленный порт SNMP v2c трапов.
	trap_v2c_status строка		Варианты: отключено включено ←	Включение/выключение SNMP v2c трапов. отключено - Отключение функции. включено - Включение функции.
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_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, ...]
        state: <value in [present, absent]>
        system_snmp_community:
           events:
             - disk_low
             - ha_switch
             - intf_ip_chg
             - sys_reboot
             - cpu_high
             - mem_low
             - log-alert
             - log-rate
             - log-data-rate
             - lic-gbday
             - lic-dev-quota
             - cpu-high-exclude-nice
           hosts:
             -
                 id: <value of integer>
                 interface: <value of string>
                 ip: <value of string>
           hosts6:
             -
                 id: <value of integer>
                 interface: <value of string>
                 ip: <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_rport: <value of integer>
           trap_v1_status: <value in [disable, enable]>
           trap_v2c_rport: <value of integer>
           trap_v2c_status: <value in [disable, enable]>

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

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

Ключ	Возвращаемое значение	Описание
request_url строка	всегда	Полный запрашиваемый URL Пример: /sys/login/user
response_code целое число	всегда	Статус запроса API
response_message строка	всегда	Дескриптивное сообщение ответа 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_system_snmp_community_module.html