fortinet.fortimanager.fmgr_devprof_system_snmp_community_hosts – Настройка IPv4 SNMP-менеджеров (хостов).
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_devprof_system_snmp_community_hosts.
Новое в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль может настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL | ||
| bypass_validation булево |
| устанавливается в True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров | |
| community строка / обязательно | параметр (community) в запрошенном URL | ||
| devprof строка / обязательно | параметр (devprof) в запрошенном URL | ||
| devprof_system_snmp_community_hosts словарь | параметры верхнего уровня | ||
| ha-direct строка |
| Включить/отключить прямое управление членами кластера HA. | |
| host-type строка |
| Управление тем, отправляет ли SNMP-менеджер SNMP-запросы, получает ли SNMP-сигналы или то и другое. | |
| id целое число | Идентификатор записи хоста. | ||
| ip строка | IPv4-адрес SNMP-менеджера (хоста). | ||
| source-ip строка | Исходный IPv4-адрес для SNMP-сигналов. | ||
| rc_failed список / элементы=строка | список rc-кодов, при которых условия будут считаться ошибочными | ||
| rc_succeeded список / элементы=строка | список rc-кодов, при которых условия будут считаться успешными | ||
| state строка / обязательно |
| направление создания, обновления или удаления объекта | |
| workspace_locking_adom строка | adom для блокировки FortiManager, работающего в режиме рабочей области. значение может быть глобальным и другими, включая корень | ||
| 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: Configure IPv4 SNMP managers (hosts).
fmgr_devprof_system_snmp_community_hosts:
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>
community: <your own value>
state: <value in [present, absent]>
devprof_system_snmp_community_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>
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| 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_devprof_system_snmp_community_hosts_module.html
