Spec-Zone.ru › Ansible

fortinet.fortimanager.fmgr_system_snmp_community модуль — Настройка сообщества SNMP.

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

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

Впервые в fortinet.fortimanager 2.0.0

  • Обзор
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Обзор

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

Параметры

Параметр

Комментарии

access_token

строка

Токен для доступа к FortiManager без использования имени пользователя и пароля.

bypass_validation

логическое

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

Выбор:

  • false ← (по умолчанию)
  • true

enable_log

логическое

Включить/выключить ведение журнала для задачи.

Выбор:

  • false ← (по умолчанию)
  • true

forticloud_access_token

строка

Авторизовать Ansible-клиент с помощью токена доступа к API forticloud.

proposed_method

строка

Переопределённый метод для базового запроса Json RPC.

Выбор:

  • "update"
  • "set"
  • "add"

rc_failed

список / элементы=целое число

Список кодов rc, с которыми будут переопределены условия ошибки.

rc_succeeded

список / элементы=целое число

Список кодов rc, с которыми будут переопределены условия успеха.

state

строка / обязательно

Директива для создания, обновления или удаления объекта.

Выбор:

  • "present"
  • "absent"

system_snmp_community

словарь

Настройка параметров верхнего уровня.

events

список / элементы=строка

События SNMP-ловушки.

disk_low - Слишком высокое использование диска.

ha_switch - Переключение HA.

intf_ip_chg - Изменена IP-адрес интерфейса.

sys_reboot - Перезагрузка системы.

cpu_high - Слишком высокое использование процессора.

mem_low - Недостаточно доступной памяти.

log-alert - Сообщение об оповещении по журналу.

log-rate - Обнаружено высокое входящее темп журнала.

log-data-rate - Обнаружено высокое входящее темп данных журнала.

lic-gbday - Обнаружено высокое значение лицензионных логов ГБ/день.

lic-dev-quota - Обнаружено высокое значение лицензионного лимита устройств.

cpu-high-exclude-nice - Использование процессора за исключением 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"

hosts

список / элементы=словарь

Хосты.

id

целое число

Идентификатор записи хоста.

interface

строка

Разрешить имя интерфейса.

ip

строка

Разрешить IP-адрес хоста.

hosts6

список / элементы=словарь

Хосты6.

id

целое число

Идентификатор записи хоста.

interface

строка

Разрешить имя интерфейса.

ip

строка

Разрешить IP-адрес хоста.

id

целое число / обязательно

Идентификатор сообщества.

name

строка

Имя сообщества.

query_v1_port

целое число

Порт запроса SNMP v1.
END_OF_DOCUMENT_MARKER

query_v1_status

string

Включить/отключить запрос SNMP v1.

disable - Отключить настройку.

enable - Включить настройку.

Варианты:

  • "disable"
  • "enable"

query_v2c_port

integer

Порт запроса SNMP v2c.

query_v2c_status

string

Включить/отключить запрос SNMP v2c.

disable - Отключить настройку.

enable - Включить настройку.

Варианты:

  • "disable"
  • "enable"

status

string

Включить/отключить сообщество.

disable - Отключить настройку.

enable - Включить настройку.

Варианты:

  • "disable"
  • "enable"

trap_v1_rport

integer

Удаленный порт SNMP v1 ловушки.

trap_v1_status

string

Включить/отключить ловушку SNMP v1.

disable - Отключить настройку.

enable - Включить настройку.

Варианты:

  • "disable"
  • "enable"

trap_v2c_rport

integer

Удаленный порт SNMP v2c ловушки.

trap_v2c_status

string

Включить/отключить ловушку SNMP v2c.

disable - Отключить настройку.

enable - Включить настройку.

Варианты:

  • "disable"
  • "enable"

workspace_locking_adom

string

ADOM для блокировки рабочего пространства FortiManager, значение может быть глобальным и другими, включая 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 помогают выполнить эту задачу.
  • Для создания или обновления объекта используйте директиву state present.
  • Для удаления объекта используйте директиву state absent.
  • Обычно выполнение одного модуля может завершиться неудачно, если возвращён ненулевой код rc. Вы также можете переопределить условия завершения с помощью параметров rc_failed и rc_succeeded.

Примеры

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: SNMP community configuration.
      fortinet.fortimanager.fmgr_system_snmp_community:
        bypass_validation: false
        state: present
        system_snmp_community:
          id: 1
          name: ansible-test-snmp
          status: disable

- 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 communities
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "system_snmp_community"
          params:
            community: "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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_system_snmp_community_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API