модуль fortinet.fortimanager.fmgr_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_system_snmp_user.

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

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

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

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method string	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список кодов rc, с помощью которого переопределяются условия сбоя.
rc_succeeded list / elements=integer	Список кодов rc, с помощью которого переопределяются условия успешного выполнения.
state string / обязательный	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
system_snmp_user dictionary	Набор параметров верхнего уровня.
auth_proto псевдонимы: auth-proto string	Протокол аутентификации. md5 — протокол аутентификации HMAC-MD5-96. sha — протокол аутентификации HMAC-SHA-96. Варианты: `"md5"` `"sha"` `"sha224"` `"sha256"` `"sha384"` `"sha512"`
auth_pwd псевдонимы: auth-pwd any	(список) Пароль для протокола аутентификации.
events list / elements=string	Уведомления SNMP disk_low — слишком высокая загрузка диска. ha_switch — переключение HA. intf_ip_chg — изменён IP-адрес интерфейса. sys_reboot — перезагрузка системы. cpu_high — слишком высокая загрузка CPU. mem_low — мало доступной памяти. log-alert — сообщение оповещения на основе журнала. log-rate — обнаружена высокая скорость поступления записей журнала. log-data-rate — обнаружена высокая скорость поступления данных журнала. lic-gbday — обнаружен высокий объём лицензированных данных журнала в ГБ/день. lic-dev-quota — обнаружено превышение квоты лицензированных устройств. cpu-high-exclude-nice — порог загрузки CPU без учёта NICE. Варианты: `"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 псевдонимы: notify-hosts string	Узлы для отправки уведомлений
notify_hosts6 псевдонимы: notify-hosts6 string	Узлы IPv6 для отправки уведомлений
notify_port псевдонимы: notify-port integer	Порт уведомлений.
priv_proto псевдонимы: priv-proto string	Шифрование aes — протокол симметричного шифрования CFB128-AES-128. des — протокол симметричного шифрования CBC-DES. Варианты: `"aes"` `"des"` `"aes256"` `"aes256cisco"`
priv_pwd псевдонимы: priv-pwd any	(список) Пароль для шифрования
queries string	Включить или отключить запросы для этого пользователя. disable — отключить настройку. enable — включить настройку. Варианты: `"disable"` `"enable"`
query_port псевдонимы: query-port integer	Порт запросов SNMPv3.
security_level псевдонимы: 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	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_system_snmp_user:
        bypass_validation: false
        state: present
        system_snmp_user:
          auth_proto: md5 # <value in [md5, sha]>
          auth_pwd: fortinet
          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: ansible-test-snmpuser
          queries: disable
          security_level: no-auth-no-priv # <value in [no-auth-no-priv, auth-no-priv, auth-priv]>

- 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 SNMP users
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "system_snmp_user"
          params:
            user: "your_value"

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

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / elements=string	Ответ API. Возвращается: всегда
response_message string	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Сведения о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / elements=string	Предупреждение, если используемые в плейбуке параметры не поддерживаются текущей версией 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_system_snmp_user_module.html