Spec-Zone.ru › Ansible

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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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 и категорию сообщества. Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием. Тестировалось с FOS v6.0.0

Требования

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

  • ansible>=2.15

Параметры

Параметр

Комментарии

access_token

строка

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

enable_log

логический

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

Варианты:

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

member_path

строка

Путь к атрибуту элемента для обработки.

Разделяется слешем, если атрибутов несколько.

Параметр, помеченный member_path, допустим для выполнения операций с элементом.

member_state

строка

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

При указании member_state опция state игнорируется.

Варианты:

  • "present"
  • "absent"

state

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

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

Варианты:

  • "present"
  • "absent"

system_snmp_community

словарь

Конфигурация SNMP сообщества.

events

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

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

Варианты:

  • "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"
  • "faz-disconnect"
  • "faz"
  • "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"
  • "ospf-nbr-state-change"
  • "ospf-virtnbr-state-change"
  • "temperature-high"
  • "voltage-alert"
  • "power-supply"
  • "fan-failure"
  • "power-supply-failure"

hosts

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

Настройка IPv4 SNMP менеджеров (хостов).

ha_direct

строка

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

Варианты:

  • "enable"
  • "disable"

host_type

строка

Управляет тем, отправляет ли SNMP-менеджер запросы SNMP, получает ли SNMP-ловушки или то и другое. При типе IP подсети не будет отправляться ловушки.

Варианты:

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

id

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

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

ip

строка

IPv4 адрес SNMP менеджера (хоста).

source_ip

строка

Исходный IPv4 адрес для SNMP ловушек.

hosts6

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

Настройка IPv6 SNMP менеджеров.

ha_direct

строка

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

Варианты:

  • "enable"
  • "disable"

host_type

строка

Управляет тем, отправляет ли SNMP-менеджер запросы SNMP, получает ли SNMP-ловушки или то и другое.

Варианты:

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

id

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

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

ipv6

строка

Префикс IPv6 адреса SNMP менеджера.
END_OF_DOCUMENT_MARKER

source_ipv6

string

Исходный IPv6-адрес для SNMP-ловушек.

id

integer / required

Идентификатор сообщества. См. <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

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

trap_v1_rport

integer

Удаленный порт SNMP v1 trap.

trap_v1_status

string

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

Варианты:

  • "enable"
  • "disable"

trap_v2c_lport

integer

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

trap_v2c_rport

integer

Удаленный порт SNMP v2c trap.

trap_v2c_status

string

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

Варианты:

  • "enable"
  • "disable"

vdoms

list / elements=dictionary

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

name

string / required

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

vdom

string

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

Значение по умолчанию: "root"

Примечания

Примечание

  • Мы настоятельно рекомендуем использовать собственное значение в качестве id вместо 0. Хотя «0» — это специальный заполнитель, позволяющий бэкенду назначать последний доступный номер для объекта, он имеет ограничения. Более подробную информацию см. в разделе «Вопросы и ответы».
  • Устаревший fortiosapi был заменен, httpapi — предпочтительный способ запуска playbook'ов.
  • Модуль поддерживает 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"
                  ip: "<your_own_value>"
                  source_ip: "84.230.14.43"
          hosts6:
              -
                  ha_direct: "enable"
                  host_type: "any"
                  id: "13"
                  ipv6: "<your_own_value>"
                  source_ipv6: "<your_own_value>"
          id: "16"
          mib_view: "<your_own_value> (source system.snmp.mib-view.name)"
          name: "default_name_18"
          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_31 (source system.vdom.name)"

Значения возврата

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

Ключ

Описание

build

строка

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

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

Пример: "1547"

http_method

строка

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

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

Пример: "PUT"

http_status

строка

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

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

Пример: "200"

mkey

строка

Главный ключ (id), используемый в последнем вызове FortiGate

Возвращается: успех

Пример: "id"

name

строка

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

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

Пример: "urlfilter"

path

строка

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

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

Пример: "webfilter"

revision

строка

Внутренний номер ревизии

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

Пример: "17.0.2.10658"

serial

строка

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

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

Пример: "FGVMEVYYQT3AB5352"

status

строка

Указание результата операции

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

Пример: "success"

vdom

строка

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

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

Пример: "root"

version

строка

Версия 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_system_snmp_community_module.html

Spec-Zone.ru

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