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

Примечание

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

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

Для использования в книге задач укажите: fortinet.fortimanager.fmgr_devprof_system_snmp_user.

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

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
adom строка / обязательно			параметр (adom) в запрошенном URL
bypass_validation логическое		Варианты: нет ← да	устанавливается в True только при расхождениях схемы модуля со структурой API FortiManager; модуль продолжает выполнение без проверки параметров
devprof строка / обязательно			параметр (devprof) в запрошенном URL
devprof_system_snmp_user словарь			настройки верхнего уровня
	auth-proto строка	Варианты: md5 sha	Протокол аутентификации.
	auth-pwd строка		нет описания
	events список / элементы=строка	Варианты: cpu-high mem-low log-full intf-ip vpn-tun-up vpn-tun-down ha-switch fm-conf-change ips-signature ips-anomaly temperature-high voltage-alert av-virus av-oversize av-pattern av-fragmented ha-hb-failure fan-failure ha-member-up ha-member-down ent-conf-change av-conserve av-bypass av-oversize-passed av-oversize-blocked ips-pkg-update fm-if-change power-supply-failure amc-bypass faz-disconnect bgp-established bgp-backward-transition wc-ap-up wc-ap-down fswctl-session-up fswctl-session-down ips-fail-open load-balance-real-server-down device-new enter-intf-bypass exit-intf-bypass per-cpu-high power-blade-down confsync_failure	нет описания
	ha-direct строка	Варианты: выключено включено	Включение/выключение прямого управления членами кластера HA.
	name строка		Имя пользователя SNMP.
	notify-hosts строка		нет описания
	notify-hosts6 строка		SNMP-менеджеры IPv6 для отправки уведомлений (ловушек).
	priv-proto строка	Варианты: aes des aes256 aes256cisco	Протокол конфиденциальности (шифрования).
	priv-pwd строка		нет описания
	queries строка	Варианты: выключено включено	Включение/выключение запросов SNMP для этого пользователя.
	query-port целое число		Порт запросов SNMPv3 (по умолчанию = 161).
	security-level строка	Варианты: no-auth-no-priv auth-no-priv auth-priv	Уровень безопасности для аутентификации сообщений и шифрования.
	source-ip строка		IP-адрес источника для SNMP-ловушки.
	source-ipv6 строка		Адрес IPv6 источника для SNMP-ловушки.
	status строка	Варианты: выключено включено	Включение/выключение этого пользователя SNMP.
	trap-lport целое число		Локальный порт ловушек SNMPv3 (по умолчанию = 162).
	trap-rport целое число		Удаленный порт ловушек SNMPv3 (по умолчанию = 162).
	trap-status строка	Варианты: выключено включено	Включение/выключение ловушек для этого пользователя SNMP.
rc_failed список / элементы=строка			список rc-кодов, при которых выполнение будет прервано
rc_succeeded список / элементы=строка			список rc-кодов, при которых выполнение будет успешно завершено
state строка / обязательно		Варианты: present absent	направление для создания, обновления или удаления объекта
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 user configuration.
     fmgr_devprof_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, ...]
        adom: <your own value>
        devprof: <your own value>
        state: <value in [present, absent]>
        devprof_system_snmp_user:
           auth-proto: <value in [md5, sha]>
           auth-pwd: <value of string>
           events:
             - cpu-high
             - mem-low
             - log-full
             - intf-ip
             - vpn-tun-up
             - vpn-tun-down
             - ha-switch
             - fm-conf-change
             - ips-signature
             - ips-anomaly
             - temperature-high
             - voltage-alert
             - av-virus
             - av-oversize
             - av-pattern
             - av-fragmented
             - ha-hb-failure
             - fan-failure
             - ha-member-up
             - ha-member-down
             - ent-conf-change
             - av-conserve
             - av-bypass
             - av-oversize-passed
             - av-oversize-blocked
             - ips-pkg-update
             - fm-if-change
             - power-supply-failure
             - amc-bypass
             - faz-disconnect
             - bgp-established
             - bgp-backward-transition
             - wc-ap-up
             - wc-ap-down
             - fswctl-session-up
             - fswctl-session-down
             - ips-fail-open
             - load-balance-real-server-down
             - device-new
             - enter-intf-bypass
             - exit-intf-bypass
             - per-cpu-high
             - power-blade-down
             - confsync_failure
           ha-direct: <value in [disable, enable]>
           name: <value of string>
           notify-hosts: <value of string>
           notify-hosts6: <value of string>
           priv-proto: <value in [aes, des, aes256, ...]>
           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]>
           source-ip: <value of string>
           source-ipv6: <value of string>
           status: <value in [disable, enable]>
           trap-lport: <value of integer>
           trap-rport: <value of integer>
           trap-status: <value in [disable, enable]>

Значения возврата

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

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