Модуль fortinet.fortimanager.fmgr_devprof_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_devprof_system_snmp_sysinfo.

Новое в 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_sysinfo dictionary	Параметры верхнего уровня.
append_index псевдонимы: append-index string	Включить или отключить добавление индекса vdom или интерфейса в некоторые таблицы RFC. Варианты: `"disable"` `"enable"`
contact_info псевдонимы: contact-info string	Контактная информация.
description string	Описание системы.
engine_id псевдонимы: engine-id string	Строка локального engineID SNMP
engine_id_type псевдонимы: engine-id-type string	Тип локального engineID SNMP Варианты: `"text"` `"hex"` `"mac"`
location string	Расположение системы.
non_mgmt_vdom_query псевдонимы: non-mgmt-vdom-query string	Включить или отключить возможность отправки запросов SNMPv3 из VDOM, не предназначенных для управления. Варианты: `"disable"` `"enable"`
status string	Включить или отключить SNMP. Варианты: `"disable"` `"enable"`
trap_free_memory_threshold псевдонимы: trap-free-memory-threshold integer	Использование свободной памяти, при котором отправляется trap.
trap_freeable_memory_threshold псевдонимы: trap-freeable-memory-threshold integer	Использование памяти, которую можно освободить, при котором отправляется trap.
trap_high_cpu_threshold псевдонимы: trap-high-cpu-threshold integer	Использование CPU, при котором отправляется trap.
trap_log_full_threshold псевдонимы: trap-log-full-threshold integer	Использование диска журналов, при котором отправляется trap.
trap_low_memory_threshold псевдонимы: trap-low-memory-threshold integer	Использование памяти, при котором отправляется trap.
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, переопределяющий условия успешного выполнения.
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 system info configuration.
      fortinet.fortimanager.fmgr_devprof_system_snmp_sysinfo:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        devprof: <your own value>
        devprof_system_snmp_sysinfo:
          # status: <value in [disable, enable]>
          # append_index: <value in [disable, enable]>
          # trap_high_cpu_threshold: <integer>
          # trap_log_full_threshold: <integer>
          # engine_id: <string>
          # trap_freeable_memory_threshold: <integer>
          # contact_info: <string>
          # engine_id_type: <value in [text, hex, mac]>
          # description: <string>
          # trap_free_memory_threshold: <integer>
          # trap_low_memory_threshold: <integer>
          # location: <string>
          # non_mgmt_vdom_query: <value in [disable, enable]>

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

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

Ключ	Описание
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_devprof_system_snmp_sysinfo_module.html