Модуль fortinet.fortimanager.fmgr_system_snmp_sysinfo — настройка SNMP.

Примечание

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

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

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

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

Добавлено в 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 / элементы=integer	Список кодов rc, с помощью которого переопределяются условия сбоя.
rc_succeeded list / элементы=integer	Список кодов rc, с помощью которого переопределяются условия успешного выполнения.
system_snmp_sysinfo dictionary	Параметры верхнего уровня.
contact_info string	Контактная информация.
description string	Описание системы.
engine_id псевдонимы: engine-id string	Строка локального идентификатора SNMP engineID
location string	Расположение системы.
status string	Включить/отключить SNMP. disable — отключить настройку. enable — включить настройку. Варианты: `"disable"` `"enable"`
trap_cpu_high_exclude_nice_threshold псевдонимы: trap-cpu-high-exclude-nice-threshold integer	Пороговое значение использования ЦП для SNMP-ловушки
trap_high_cpu_threshold псевдонимы: trap-high-cpu-threshold integer	Пороговое значение использования ЦП для SNMP-ловушки.
trap_low_memory_threshold псевдонимы: trap-low-memory-threshold integer	Пороговое значение использования памяти для SNMP-ловушки.
workspace_locking_adom string	ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области; значением может быть global или другие ADOM, включая 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.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: SNMP configuration.
      fortinet.fortimanager.fmgr_system_snmp_sysinfo:
        # workspace_locking_adom: <global or your adom name>
        system_snmp_sysinfo:
          # contact_info: <string>
          # description: <string>
          # engine_id: <string>
          # location: <string>
          # status: <value in [disable, enable]>
          # trap_cpu_high_exclude_nice_threshold: <integer>
          # trap_high_cpu_threshold: <integer>
          # trap_low_memory_threshold: <integer>

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

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

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