Модуль fortinet.fortios.fortios_system_snmp_user — Настройка пользователя SNMP в FortiOS и FortiGate Fortinet.
Примечание
Этот модуль является частью коллекции fortinet.fortios (версия 2.3.7).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля требуются дополнительные условия, см. Требования для получения подробностей.
Для использования в плейбуке укажите: fortinet.fortios.fortios_system_snmp_user.
Добавлен в fortinet.fortios 2.0.0
Обзор
- Этот модуль позволяет настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять функцию system_snmp и категорию пользователя. Примеры включают все параметры и значения, которые необходимо настроить перед использованием. Тестировалось с FOS v6.0.0
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- ansible>=2.15
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Аутентификация на основе токенов. Сгенерировано в графическом интерфейсе Fortigate. |
enable_log булево | Включить/выключить ведение журнала для задачи. Варианты:
|
member_path строка | Путь к атрибуту элемента для обработки. Разделяется символом косой черты, если атрибутов несколько. Параметр, помеченный member_path, подходит для выполнения операций с элементами. |
member_state строка | Добавить или удалить элемент в указанном пути атрибута. При указании member_state параметр state игнорируется. Варианты:
|
state строка / обязательно | Указывает, необходимо ли создать или удалить объект. Варианты:
|
system_snmp_user словарь | Настройка пользователя SNMP. |
|
auth_proto строка |
Протокол аутентификации. Варианты:
|
|
auth_pwd строка |
Пароль для протокола аутентификации. |
|
events список / элементы=строка |
Уведомления SNMP (ловушки), которые нужно отправлять. Варианты:
|
|
ha_direct строка |
Включить/выключить непосредственное управление участниками кластера HA. Варианты:
|
|
mib_view строка |
Просмотр MIB для управления доступом SNMP. Имя из system.snmp.mib-view. |
|
name строка / обязательно |
Имя пользователя SNMP. |
|
notify_hosts список / элементы=строка |
Управляющие SNMP, которым нужно отправлять уведомления (ловушки). |
|
notify_hosts6 список / элементы=строка |
Управляющие SNMP IPv6, которым нужно отправлять уведомления (ловушки). |
|
priv_proto строка |
Протокол конфиденциальности (шифрования). Варианты:
|
|
priv_pwd строка |
Пароль для протокола конфиденциальности (шифрования). |
|
queries строка |
Включить/выключить запросы SNMP для данного пользователя. Варианты:
|
|
query_port целое число |
Порт запросов SNMPv3. |
|
security_level string |
Уровень безопасности для аутентификации и шифрования сообщений. Варианты:
|
|
source_ip string |
IP-адрес источника для SNMP-ловушки. |
|
source_ipv6 string |
IPv6-адрес источника для SNMP-ловушки. |
|
status string |
Включить/выключить этого пользователя SNMP. Варианты:
|
|
trap_lport integer |
Локальный порт SNMPv3-ловушки. |
|
trap_rport integer |
Удаленный порт SNMPv3-ловушки. |
|
trap_status string |
Включить/выключить ловушки для этого пользователя SNMP. Варианты:
|
|
vdoms list / elements=dictionary |
VDOMы для контроля доступа SNMP. |
|
name string / обязательно |
Имя VDOM. Имя VDOM из исходной системы. |
vdom string | Виртуальная область (VDOM) среди тех, которые определены ранее. VDOM — виртуальная инстанция FortiGate, которая может быть настроена и использована как отдельное устройство. По умолчанию: |
Примечания
Примечание
- Модуль fortiosapi устарел, предпочтительный способ выполнения playbooks — httpapi
- Модуль поддерживает режим check_mode.
Примеры
- name: SNMP user configuration.
fortinet.fortios.fortios_system_snmp_user:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_snmp_user:
auth_proto: "md5"
auth_pwd: "<your_own_value>"
events: "cpu-high"
ha_direct: "enable"
mib_view: "<your_own_value> (source system.snmp.mib-view.name)"
name: "default_name_8"
notify_hosts: "<your_own_value>"
notify_hosts6: "<your_own_value>"
priv_proto: "aes"
priv_pwd: "<your_own_value>"
queries: "enable"
query_port: "161"
security_level: "no-auth-no-priv"
source_ip: "84.230.14.43"
source_ipv6: "<your_own_value>"
status: "enable"
trap_lport: "162"
trap_rport: "162"
trap_status: "enable"
vdoms:
-
name: "default_name_23 (source system.vdom.name)"
Значения возврата
Общие значения возврата документированы здесь, следующие — поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
build строка | Номер сборки образа fortigate Возвращается: всегда Пример: |
http_method строка | Последний метод, используемый для предоставления содержимого в FortiGate Возвращается: всегда Пример: |
http_status строка | Последний результат, предоставленный FortiGate по последней операции Возвращается: всегда Пример: |
mkey строка | Главный ключ (id), используемый в последнем вызове FortiGate Возвращается: успех Пример: |
name строка | Имя таблицы, используемой для выполнения запроса Возвращается: всегда Пример: |
path строка | Путь к таблице, используемой для выполнения запроса Возвращается: всегда Пример: |
revision строка | Внутренний номер ревизии Возвращается: всегда Пример: |
serial строка | Серийный номер устройства Возвращается: всегда Пример: |
status строка | Указание результата операции Возвращается: всегда Пример: |
vdom строка | Используемый виртуальный домен Возвращается: всегда Пример: |
version строка | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на сборку
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_system_snmp_user_module.html
