fortinet.fortimanager.fmgr_system_snmp_sysinfo – Настройка SNMP.

Примечание

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

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

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

Новое в версии 2.10: модуля fortinet.fortimanager

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
bypass_validation boolean		Варианты: нет ← да	Устанавливается в True только при расхождении схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров.
rc_failed список / элементы=строка			Список кодов rc, при которых выполнение завершится с ошибкой.
rc_succeeded список / элементы=строка			Список кодов rc, при которых выполнение завершится успешно.
state строка / обязательно		Варианты: present absent	Директива для создания, обновления или удаления объекта.
system_snmp_sysinfo словарь			Параметры верхнего уровня.
	contact_info строка		Контактная информация.
	description строка		Описание системы.
	engine-id строка		Строка локального идентификатора SNMP-движка (максимум 24 символа).
	location строка		Местоположение системы.
	status строка	Варианты: отключено ← включено	Включение/выключение SNMP. отключено - Отключение. включено - Включение.
	trap-cpu-high-exclude-nice-threshold целое число	По умолчанию: 80	Порог для SNMP-ловушки при высокой загрузке ЦП (исключая процессы NICE).
	trap-high-cpu-threshold целое число	По умолчанию: 80	Порог для SNMP-ловушки при высокой загрузке ЦП.
	trap-low-memory-threshold целое число	По умолчанию: 80	Порог для SNMP-ловушки при низкой доступной памяти.
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 configuration.
     fmgr_system_snmp_sysinfo:
        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, ...]
        system_snmp_sysinfo:
           contact_info: <value of string>
           description: <value of string>
           engine-id: <value of string>
           location: <value of string>
           status: <value in [disable, enable]>
           trap-cpu-high-exclude-nice-threshold: <value of integer>
           trap-high-cpu-threshold: <value of integer>
           trap-low-memory-threshold: <value of integer>

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

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

Ключ	Возвращаемое значение	Описание
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_sysinfo_module.html