Spec-Zone.ru › Ansible

модуль fortinet.fortios.fortios_wireless_controller_snmp — настройка 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_wireless_controller_snmp.

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

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

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

  • Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры функции wireless_controller и категории snmp. В примерах представлены все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием. Протестировано с 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"

vdom

string

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

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

wireless_controller_snmp

dictionary

Настройка SNMP.

community

list / elements=dictionary

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

hosts

list / elements=dictionary

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

id

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

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

ip

string

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

hosts6

list / elements=dictionary

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

id

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

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

ipv6

string

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

id

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

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

name

string

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

query_v1_status

string

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

Варианты:

  • "enable"
  • "disable"

query_v2c_status

string

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

Варианты:

  • "enable"
  • "disable"

status

string

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

Варианты:

  • "enable"
  • "disable"

trap_v1_status

string

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

Варианты:

  • "enable"
  • "disable"

trap_v2c_status

string

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

Варианты:

  • "enable"
  • "disable"

contact_info

string

Контактная информация.

engine_id

string

Строка engineID SNMP контроллера доступа (не более 24 символов).

trap_high_cpu_threshold

integer

Загрузка ЦП, при которой отправляется ловушка.

trap_high_mem_threshold

integer

Использование памяти, при котором отправляется ловушка.

user

list / elements=dictionary

Настройка пользователя SNMP.

auth_proto

string

Протокол аутентификации.

Варианты:

  • "md5"
  • "sha"
  • "sha224"
  • "sha256"
  • "sha384"
  • "sha512"

auth_pwd

string

Пароль для протокола аутентификации.

name

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

Имя пользователя SNMP.

notify_hosts

list / elements=string

Настройка хостов уведомлений пользователя SNMP.

notify_hosts6

list / elements=string

Настройка хостов уведомлений IPv6 пользователя SNMP.

priv_proto

string

Протокол конфиденциальности (шифрования).

Варианты:

  • "aes"
  • "des"
  • "aes256"
  • "aes256cisco"

priv_pwd

string

Пароль для протокола конфиденциальности (шифрования).

queries

string

Включить или отключить запросы SNMP для этого пользователя.

Варианты:

  • "enable"
  • "disable"

security_level

string

Уровень безопасности для аутентификации и шифрования сообщений.

Варианты:

  • "no-auth-no-priv"
  • "auth-no-priv"
  • "auth-priv"

status

string

Включение пользователя SNMP.

Варианты:

  • "enable"
  • "disable"

trap_status

string

Включить или отключить ловушки для этого пользователя SNMP.

Варианты:

  • "enable"
  • "disable"

Примечания

Примечание

  • Устаревший fortiosapi объявлен нерекомендуемым; предпочтительный способ запуска плейбуков — httpapi
  • Модуль поддерживает check_mode.

Примеры

- name: Configure SNMP.
  fortinet.fortios.fortios_wireless_controller_snmp:
      vdom: "{{ vdom }}"
      wireless_controller_snmp:
          community:
              -
                  hosts:
                      -
                          id: "5"
                          ip: "<your_own_value>"
                  hosts6:
                      -
                          id: "8"
                          ipv6: "<your_own_value>"
                  id: "10"
                  name: "default_name_11"
                  query_v1_status: "enable"
                  query_v2c_status: "enable"
                  status: "enable"
                  trap_v1_status: "enable"
                  trap_v2c_status: "enable"
          contact_info: "<your_own_value>"
          engine_id: "<your_own_value>"
          trap_high_cpu_threshold: "80"
          trap_high_mem_threshold: "80"
          user:
              -
                  auth_proto: "md5"
                  auth_pwd: "<your_own_value>"
                  name: "default_name_24"
                  notify_hosts: "<your_own_value>"
                  notify_hosts6: "<your_own_value>"
                  priv_proto: "aes"
                  priv_pwd: "<your_own_value>"
                  queries: "enable"
                  security_level: "no-auth-no-priv"
                  status: "enable"
                  trap_status: "enable"

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

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

Ключ

Описание

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_wireless_controller_snmp_module.html

Spec-Zone.ru

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