Spec-Zone.ru › Ansible

Модуль fortinet.fortios.fortios_system_snmp_community — настройка сообщества SNMP в Fortinet FortiOS и FortiGate.

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля требуются дополнительные компоненты; подробную информацию см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_system_snmp_community.

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

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

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

  • Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя функцию system_snmp и категорию community. В примерах приведены все параметры и значения, которые перед использованием необходимо скорректировать с учётом источников данных. Проверено на FOS v6.0.0

Требования

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

  • ansible>=2.16

Параметры

Параметр

Комментарии

access_token

string

Аутентификация на основе токена. Создаётся в графическом интерфейсе FortiGate.

enable_log

boolean

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

Варианты:

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

member_path

string

Путь к атрибуту элемента, с которым выполняется операция.

Если атрибутов несколько, они разделяются символом косой черты.

Параметр с пометкой member_path можно использовать для выполнения операции с элементом.

member_state

string

Добавить или удалить элемент в указанном пути к атрибуту.

Если задан параметр member_state, параметр state игнорируется.

Варианты:

  • "present"
  • "absent"

state

string / обязательный

Указывает, нужно ли создать или удалить объект.

Варианты:

  • "present"
  • "absent"

system_snmp_community

dictionary

Настройка сообщества SNMP.

events

list / elements=string

События SNMP trap.

Варианты:

  • "cpu-high"
  • "mem-low"
  • "log-full"
  • "intf-ip"
  • "vpn-tun-up"
  • "vpn-tun-down"
  • "ha-switch"
  • "ha-hb-failure"
  • "ips-signature"
  • "ips-anomaly"
  • "av-virus"
  • "av-oversize"
  • "av-pattern"
  • "av-fragmented"
  • "fm-if-change"
  • "fm-conf-change"
  • "bgp-established"
  • "bgp-backward-transition"
  • "ha-member-up"
  • "ha-member-down"
  • "ent-conf-change"
  • "av-conserve"
  • "av-bypass"
  • "av-oversize-passed"
  • "av-oversize-blocked"
  • "ips-pkg-update"
  • "ips-fail-open"
  • "temperature-high"
  • "voltage-alert"
  • "power-supply"
  • "faz-disconnect"
  • "faz"
  • "fan-failure"
  • "wc-ap-up"
  • "wc-ap-down"
  • "fswctl-session-up"
  • "fswctl-session-down"
  • "load-balance-real-server-down"
  • "device-new"
  • "per-cpu-high"
  • "dhcp"
  • "pool-usage"
  • "ippool"
  • "interface"
  • "ospf-nbr-state-change"
  • "ospf-virtnbr-state-change"
  • "bfd"
  • "power-supply-failure"

hosts

list / elements=dictionary

Настройка диспетчеров SNMP IPv4 (узлов).

ha_direct

string

Включить или отключить прямое управление участниками кластера HA.

Варианты:

  • "enable"
  • "disable"

host_type

string

Определяет, отправляет ли диспетчер SNMP запросы SNMP, получает traps SNMP или выполняет обе операции. Если тип IP-адреса — подсеть, traps отправляться не будут.

Варианты:

  • "any"
  • "query"
  • "trap"

id

integer / обязательный

Идентификатор записи узла. См. <a href=’#notes’>примечания</a>.

interface

string

Укажите исходящий интерфейс для подключения к серверу. Источник: system.interface.name.

interface_select_method

string

Укажите способ выбора исходящего интерфейса для подключения к серверу.

Варианты:

  • "auto"
  • "sdwan"
  • "specify"

ip

string

IPv4-адрес диспетчера SNMP (узла).

source_ip

string

Исходный IPv4-адрес для traps SNMP.

vrf_select

integer

Идентификатор VRF, используемый для подключения к серверу.

hosts6

list / elements=dictionary

Настройка диспетчеров SNMP IPv6.

ha_direct

string

Включить или отключить прямое управление участниками кластера HA.

Варианты:

  • "enable"
  • "disable"

host_type

string

Определяет, отправляет ли диспетчер SNMP запросы SNMP, получает traps SNMP или выполняет обе операции.

Варианты:

  • "any"
  • "query"
  • "trap"

id

integer / обязательный

Идентификатор записи узла IPv6. См. <a href=’#notes’>примечания</a>.

interface

string

Укажите исходящий интерфейс для подключения к серверу. Источник: system.interface.name.

interface_select_method

string

Укажите способ выбора исходящего интерфейса для подключения к серверу.

Варианты:

  • "auto"
  • "sdwan"
  • "specify"

ipv6

string

Префикс IPv6-адреса диспетчера SNMP.

source_ipv6

string

Исходный IPv6-адрес для traps SNMP.

vrf_select

integer

Идентификатор VRF, используемый для подключения к серверу.

id

integer / обязательный

Идентификатор сообщества. См. <a href=’#notes’>примечания</a>.

mib_view

string

Представление MIB для управления доступом SNMP. Источник: system.snmp.mib-view.name.

name

string

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

query_v1_port

integer

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

query_v1_status

string

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

Варианты:

  • "enable"
  • "disable"

query_v2c_port

integer

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

query_v2c_status

string

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

Варианты:

  • "enable"
  • "disable"

status

string

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

Варианты:

  • "enable"
  • "disable"

trap_v1_lport

integer

Локальный порт traps SNMP v1.

trap_v1_rport

integer

Удалённый порт traps SNMP v1.

trap_v1_status

string

Включить или отключить traps SNMP v1.

Варианты:

  • "enable"
  • "disable"

trap_v2c_lport

integer

Локальный порт traps SNMP v2c.

trap_v2c_rport

integer

Удалённый порт traps SNMP v2c.

trap_v2c_status

string

Включить или отключить traps SNMP v2c.

Варианты:

  • "enable"
  • "disable"

vdoms

list / elements=dictionary

VDOM для управления доступом SNMP.

name

string / обязательный

Имя VDOM. Источник: system.vdom.name.

vdom

string

Виртуальный домен из ранее определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство.

По умолчанию: "root"

Примечания

Примечание

  • Настоятельно рекомендуем указывать собственное значение id, а не 0. Значение «0» является специальным заполнителем, позволяющим серверной части назначить объекту последний доступный номер, однако у этого способа есть ограничения. Подробнее см. в разделе «Вопросы и ответы».
  • Устаревший fortiosapi объявлен нерекомендуемым к использованию; для запуска плейбуков предпочтителен httpapi.
  • Модуль поддерживает check_mode.

Примеры

- name: SNMP community configuration.
  fortinet.fortios.fortios_system_snmp_community:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_snmp_community:
          events: "cpu-high"
          hosts:
              -
                  ha_direct: "enable"
                  host_type: "any"
                  id: "7"
                  interface: "<your_own_value> (source system.interface.name)"
                  interface_select_method: "auto"
                  ip: "<your_own_value>"
                  source_ip: "84.230.14.43"
                  vrf_select: "0"
          hosts6:
              -
                  ha_direct: "enable"
                  host_type: "any"
                  id: "16"
                  interface: "<your_own_value> (source system.interface.name)"
                  interface_select_method: "auto"
                  ipv6: "<your_own_value>"
                  source_ipv6: "<your_own_value>"
                  vrf_select: "0"
          id: "22"
          mib_view: "<your_own_value> (source system.snmp.mib-view.name)"
          name: "default_name_24"
          query_v1_port: "161"
          query_v1_status: "enable"
          query_v2c_port: "161"
          query_v2c_status: "enable"
          status: "enable"
          trap_v1_lport: "162"
          trap_v1_rport: "162"
          trap_v1_status: "enable"
          trap_v2c_lport: "162"
          trap_v2c_rport: "162"
          trap_v2c_status: "enable"
          vdoms:
              -
                  name: "default_name_37 (source system.vdom.name)"

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

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

Ключ

Описание

build

string

Номер сборки образа FortiGate

Возвращается: всегда

Пример: "1547"

http_method

string

Последний метод, использованный для передачи содержимого в FortiGate

Возвращается: всегда

Пример: "PUT"

http_status

string

Последний результат, полученный от FortiGate при последней выполненной операции

Возвращается: всегда

Пример: "200"

mkey

string

Мастер-ключ (идентификатор), использованный при последнем вызове FortiGate

Возвращается: при успешном выполнении

Пример: "id"

name

string

Имя таблицы, использованной для выполнения запроса

Возвращается: всегда

Пример: "urlfilter"

path

string

Путь к таблице, использованной для выполнения запроса

Возвращается: всегда

Пример: "webfilter"

revision

string

Внутренний номер редакции

Возвращается: всегда

Пример: "17.0.2.10658"

serial

string

Серийный номер устройства

Возвращается: всегда

Пример: "FGVMEVYYQT3AB5352"

status

string

Результат выполнения операции

Возвращается: всегда

Пример: "success"

vdom

string

Используемый виртуальный домен

Возвращается: всегда

Пример: "root"

version

string

Версия FortiGate

Возвращается: всегда

Пример: "v5.6.3"

Авторы

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Ссылки на коллекцию

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (исходный код)

© 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/fortios/fortios_system_snmp_community_module.html

Spec-Zone.ru

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