модуль fortinet.fortimanager.fmgr_devprof_system_snmp_user — настройка пользователя SNMP.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

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

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortimanager.fmgr_devprof_system_snmp_user.

Добавлено в fortinet.fortimanager 1.0.0

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательно	Параметр (adom) в запрашиваемом URL.
bypass_validation boolean	Установите значение True только в том случае, если схема модуля отличается от структуры API FortiManager: модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
devprof string / обязательно	Параметр (devprof) в запрашиваемом URL.
devprof_system_snmp_user dictionary	Параметры верхнего уровня.
auth_proto псевдонимы: auth-proto string	Протокол аутентификации. Варианты: `"md5"` `"sha"` `"sha224"` `"sha256"` `"sha384"` `"sha512"`
auth_pwd псевдонимы: auth-pwd any	(список) Пароль для протокола аутентификации.
events list / элементы=string	Уведомления SNMP Варианты: `"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"` `"dhcp"` `"pool-usage"` `"power-redundancy-degrade"` `"power-redundancy-failure"` `"ospf-nbr-state-change"` `"ospf-virtnbr-state-change"` `"disk-failure"` `"disk-overload"` `"faz-main-failover"` `"faz-alt-failover"` `"slbc"` `"faz"` `"power-supply"` `"ippool"` `"interface"` `"security_level_change"` `"cert-expiry"` `"dio"` `"sensor"` `"bfd"`
ha_direct псевдонимы: ha-direct string	Включить/отключить прямое управление участниками кластера HA. Варианты: `"disable"` `"enable"`
interface any	(список) Укажите исходящий интерфейс для связи с сервером.
interface_select_method псевдонимы: interface-select-method string	Укажите способ выбора исходящего интерфейса для связи с сервером. Варианты: `"auto"` `"sdwan"` `"specify"`
mib_view псевдонимы: mib-view string	Представление MIB для управления доступом SNMP.
name string / обязательно	Имя пользователя SNMP.
notify_hosts псевдонимы: notify-hosts any	(список) Менеджеры SNMP, которым отправляются уведомления
notify_hosts6 псевдонимы: notify-hosts6 string	Менеджеры SNMP IPv6, которым отправляются уведомления
priv_proto псевдонимы: priv-proto string	Шифрование Варианты: `"aes"` `"des"` `"aes256"` `"aes256cisco"`
priv_pwd псевдонимы: priv-pwd any	(список) Пароль для шифрования
queries string	Включить/отключить SNMP-запросы для этого пользователя. Варианты: `"disable"` `"enable"`
query_port псевдонимы: query-port integer	Порт запросов SNMPv3
security_level псевдонимы: security-level string	Уровень безопасности для аутентификации и шифрования сообщений. Варианты: `"no-auth-no-priv"` `"auth-no-priv"` `"auth-priv"`
source_ip псевдонимы: source-ip string	IP-адрес источника для SNMP-ловушки.
source_ipv6 псевдонимы: source-ipv6 string	IPv6-адрес источника для SNMP-ловушки.
status string	Включить/отключить этого пользователя SNMP. Варианты: `"disable"` `"enable"`
trap_lport псевдонимы: trap-lport integer	Локальный порт ловушек SNMPv3
trap_rport псевдонимы: trap-rport integer	Удалённый порт ловушек SNMPv3
trap_status псевдонимы: trap-status string	Включить/отключить ловушки для этого пользователя SNMP. Варианты: `"disable"` `"enable"`
vdoms any	(список) VDOM для управления доступом SNMP.
vrf_select псевдонимы: vrf-select integer	Идентификатор VRF, используемый для подключения к серверу.
enable_log boolean	Включить/отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method string	Переопределяемый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / элементы=integer	Список кодов rc, переопределяющий условия сбоя.
rc_succeeded list / элементы=integer	Список кодов rc, переопределяющий условия успешного выполнения.
state string / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom string	ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области; значение может быть global или другим, включая root.
workspace_locking_timeout integer	Максимальное время ожидания в секундах, пока другой пользователь освободит блокировку рабочей области. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, для всех входных аргументов используется соглашение об именовании с подчёркиваниями (snake_case). Замените аргументы, например “var-name”, на “var_name”. Старые имена аргументов по-прежнему доступны, но при их использовании будут выдаваться предупреждения об устаревании. Это предупреждение можно отключить, установив deprecation_warnings=False в ansible.cfg.
Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области; для этого используются параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
Обычно выполнение модуля может завершиться ошибкой, если возвращён ненулевой код rc. Условия сбоя или успешного выполнения можно переопределить с помощью параметров rc_failed и rc_succeeded.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.

Примеры

- name: Example playbook
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: SNMP user configuration.
      fortinet.fortimanager.fmgr_devprof_system_snmp_user:
        bypass_validation: false
        adom: ansible
        devprof: "ansible-test" # system template name, could find it in FortiManager UI: Device Manager --> Provisioning Templates --> System Templates
        state: present
        devprof_system_snmp_user:
          auth_proto: md5
          auth_pwd: "fortinet"
          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: disable
          name: "ansible-test"

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the scripts
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "devprof_system_snmp_user"
          params:
            adom: "ansible"
            devprof: "ansible-test" # system template name, could find it in FortiManager UI: Device Manager --> Provisioning Templates --> System Templates
            user: "your_value"

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

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

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Текстовое описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение о том, что используемые в сценарии параметры не поддерживаются текущей версией FortiManager. Возвращается: при сложном типе

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_devprof_system_snmp_user_module.html