fortinet.fortimanager.fmgr_devprof_system_snmp_sysinfo модуль — Настройка SNMP информации о системе.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка	Токен доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое	Устанавливается в значение True только в том случае, если схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
devprof строка / обязательно	Параметр (devprof) в запрошенном URL.
devprof_system_snmp_sysinfo словарь	Настройка параметров верхнего уровня.
append_index строка	Устаревшее, переименуйте на append_index. Включить/выключить возможность добавления индекса vdom или интерфейса в некоторых RFC та… Варианты: `"disable"` `"enable"`
contact_info строка	Устаревшее, переименуйте на contact_info. Контактная информация.
description строка	Описание системы.
engine_id строка	Устаревшее, переименуйте на engine_id. Строка локального SNMP engineID
engine_id_type строка	Устаревшее, переименуйте на engine_id_type. Тип локального SNMP engineID Варианты: `"text"` `"hex"` `"mac"`
location строка	Расположение системы.
non_mgmt_vdom_query строка	Устаревшее, переименуйте на non_mgmt_vdom_query. Включить/выключить возможность запроса SNMPv3 из неменеджерских vdom. Варианты: `"disable"` `"enable"`
status строка	Включить/выключить SNMP. Варианты: `"disable"` `"enable"`
trap_free_memory_threshold целое число	Устаревшее, переименуйте на trap_free_memory_threshold. Доступная оперативная память при отправке ловушки.
trap_freeable_memory_threshold целое число	Устаревшее, переименуйте на trap_freeable_memory_threshold. Освобождаемая оперативная память при отправке ловушки.
trap_high_cpu_threshold целое число	Устаревшее, переименуйте на trap_high_cpu_threshold. Использование ЦП при отправке ловушки.
trap_log_full_threshold целое число	Устаревшее, переименуйте на trap_log_full_threshold. Занятость диска журнала при отправке ловушки.
trap_low_memory_threshold целое число	Устаревшее, переименуйте на trap_low_memory_threshold. Использование оперативной памяти при отправке ловушки.
enable_log логическое	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизовать Ansible-клиент с помощью токена доступа к forticloud API.

proposed_method строка	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список rc-кодов, при которых условия будут переопределены для отказа.
rc_succeeded список / элементы=целое число	Список rc-кодов, при которых условия будут переопределены для успеха.
workspace_locking_adom строка	ADOM для блокировки FortiManager в режиме рабочей области, значение может быть глобальным и другими, включая root.
workspace_locking_timeout целое число	Максимальное время в секундах ожидания освобождения блокировки рабочей области другим пользователем. По умолчанию: `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
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: SNMP system info configuration.
      fortinet.fortimanager.fmgr_devprof_system_snmp_sysinfo:
        # 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>
        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 словарь	Результат запроса. Возвращается: всегда
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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_devprof_system_snmp_sysinfo_module.html