fortinet.fortimanager.fmgr_system_snmp_user – Настройка пользователя SNMP.

Примечание

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

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

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

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

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
bypass_validation boolean		Варианты: нет ← да	устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager; модуль продолжает выполнение без проверки параметров
rc_failed list / elements=string			список кодов rc, при которых условия будут нарушаться
rc_succeeded list / elements=string			список кодов rc, при которых условия будут выполняться
state string / required		Варианты: present absent	директива для создания, обновления или удаления объекта
system_snmp_user dictionary			параметры верхнего уровня
	auth-proto string	Варианты: md5 sha ←	Протокол аутентификации. md5 - протокол аутентификации HMAC-MD5-96. sha - протокол аутентификации HMAC-SHA-96.
	auth-pwd string		нет описания
	events list / elements=string	Варианты: 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	нет описания
	name string		Имя пользователя SNMP.
	notify-hosts string		Хосты для отправки уведомлений (ловушек).
	notify-hosts6 string		Хосты IPv6 для отправки уведомлений (ловушек).
	priv-proto string	Варианты: aes ← des	Протокол конфиденциальности (шифрования). aes - симметричный протокол шифрования CFB128-AES-128. des - симметричный протокол шифрования CBC-DES.
	priv-pwd string		нет описания
	queries string	Варианты: disable enable ←	Включить/выключить запросы для этого пользователя. disable - Выключить. enable - Включить.
	query-port integer	Значение по умолчанию: 161	Порт запросов SNMPv3.
	security-level string	Варианты: no-auth-no-priv ← auth-no-priv auth-priv	Уровень безопасности для аутентификации сообщений и шифрования. no-auth-no-priv - Сообщение без аутентификации и без конфиденциальности (шифрования). auth-no-priv - Сообщение с аутентификацией, но без конфиденциальности (шифрования). auth-priv - Сообщение с аутентификацией и конфиденциальностью (шифрованием).
workspace_locking_adom string			область для блокировки FortiManager, работающего в режиме рабочей области, значение может быть глобальным или другим, включая root
workspace_locking_timeout integer		Значение по умолчанию: 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 user configuration.
     fmgr_system_snmp_user:
        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_user:
           auth-proto: <value in [md5, sha]>
           auth-pwd: <value of string>
           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
           name: <value of string>
           notify-hosts: <value of string>
           notify-hosts6: <value of string>
           priv-proto: <value in [aes, des]>
           priv-pwd: <value of string>
           queries: <value in [disable, enable]>
           query-port: <value of integer>
           security-level: <value in [no-auth-no-priv, auth-no-priv, auth-priv]>

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

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

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