fortios_system_snmp_user – Настройка пользователя SNMP в FortiOS и FortiGate Fortinet
Новая в версии 2.9.
Обзор
- Этот модуль позволяет настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять системную функцию system_snmp и категорию пользователей. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировалось с FOS v6.0.5
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- fortiosapi>=0.9.8
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| host строка | IP-адрес FortiOS или FortiGate. | ||
| https логическое значение |
| Указывает, должны ли запросы к FortiGate использовать протокол HTTPS. | |
| password строка | Значение по умолчанию: "" | Пароль FortiOS или FortiGate. | |
| ssl_verify логическое значение |
| Обеспечивает, что сертификат FortiGate должен быть проверен надёжным центром сертификации. | |
| state строка / обязательно |
| Указывает, нужно ли создать или удалить объект. | |
| system_snmp_user словарь | Значение по умолчанию: null | Настройка пользователя SNMP. | |
| auth_proto строка |
| Протокол аутентификации. | |
| auth_pwd строка | Пароль для протокола аутентификации. | ||
| events список |
| SNMP уведомления (ловушки) для отправки. | |
| ha_direct строка |
| Включение/выключение прямого управления членами кластера HA. | |
| name строка / обязательно | Имя пользователя SNMP. | ||
| notify_hosts список | SNMP-менеджеры для отправки уведомлений (ловушек). | ||
| notify_hosts6 список | SNMP-менеджеры IPv6 для отправки уведомлений (ловушек). | ||
| priv_proto строка |
| Протокол конфиденциальности (шифрования). | |
| priv_pwd строка | Пароль для протокола конфиденциальности (шифрования). | ||
| queries строка |
| Включение/выключение SNMP-запросов для этого пользователя. | |
| query_port целое число | Порт запросов SNMPv3. | ||
| security_level строка |
| Уровень безопасности для проверки подлинности сообщений и шифрования. | |
| source_ip строка | IP-адрес источника для SNMP-ловушки. | ||
| source_ipv6 строка | IPv6-адрес источника для SNMP-ловушки. | ||
| status строка |
| Включение/выключение этого пользователя SNMP. | |
| trap_lport целое число | Локальный порт SNMPv3 ловушки. | ||
| trap_rport целое число | Удаленный порт SNMPv3 ловушки. | ||
| trap_status строка |
| Включение/выключение ловушек для этого пользователя SNMP. | |
| username строка | Имя пользователя FortiOS или FortiGate. | ||
| vdom строка | Значение по умолчанию: "root" | Виртуальная область (vdom) среди ранее определенных. VDOM — это виртуальная инстанция FortiGate, которая может быть настроена и использоваться как отдельное устройство. | |
Примечания
Примечание
- Требуется библиотека fortiosapi, разработанная Fortinet
- Выполняется как local_action в вашем playbook
Примеры
- hosts: localhost
vars:
host: "192.168.122.40"
username: "admin"
password: ""
vdom: "root"
ssl_verify: "False"
tasks:
- name: SNMP user configuration.
fortios_system_snmp_user:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
https: "False"
state: "present"
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 |
Статус
- Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.9/modules/fortios_system_snmp_user_module.html