fortinet.fortios.fortios_switch_controller_snmp_community модуль — Настройка сообществ SNMP v1/v2c FortiSwitch глобально в FortiOS и FortiGate Fortinet.
Примечание
Этот модуль входит в коллекцию fortinet.fortios (версия 2.3.7).
Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля необходимы дополнительные требования. Подробнее см. Требования.
Для использования в книге задач укажите: fortinet.fortios.fortios_switch_controller_snmp_community.
Новинка в fortinet.fortios 2.0.0
Обзор
- Этот модуль может настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять функцию switch_controller и категорию snmp_community. Примеры включают все параметры и значения, которые нужно настроить в источниках данных перед использованием. Тестировано на FOS v6.0.0.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- ansible>=2.15
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Аутентификация на основе токена. Сгенерировано из графического интерфейса Fortigate. |
enable_log логическое | Включить/выключить ведение журнала для задачи. Варианты:
|
member_path строка | Путь к атрибуту члена для обработки. Разделен символом косой черты, если атрибутов несколько. Параметр, помеченный member_path, подходит для выполнения операции с членом. |
member_state строка | Добавить или удалить члена по указанному пути к атрибуту. При указании member_state опция state игнорируется. Варианты:
|
state строка / обязательно | Указывает, нужно ли создать или удалить объект. Варианты:
|
switch_controller_snmp_community словарь | Настройка SNMP сообществ FortiSwitch v1/v2c глобально. |
|
events список / элементы=строка |
SNMP уведомления (ловушки) для отправки. Варианты:
|
|
hosts список / элементы=словарь |
Настройка IPv4 SNMP менеджеров (хостов). |
|
id целое число / обязательно |
Идентификатор записи хоста. см. <a href=’#notes’>Примечания</a>. |
|
ip строка |
IPv4 адрес SNMP менеджера (хоста). |
|
id целое число / обязательно |
Идентификатор SNMP сообщества. см. <a href=’#notes’>Примечания</a>. |
|
name строка |
Имя SNMP сообщества. |
|
query_v1_port целое число |
Порт запроса SNMP v1. |
|
query_v1_status строка |
Включить/выключить запросы SNMP v1. Варианты:
|
|
query_v2c_port целое число |
Порт запроса SNMP v2c. |
|
query_v2c_status строка |
Включить/выключить запросы SNMP v2c. Варианты:
|
|
status строка |
Включить/выключить это SNMP сообщество. Варианты:
|
|
trap_v1_lport целое число |
SNMP v2c локальный порт ловушки. |
|
trap_v1_rport целое число |
SNMP v2c удаленный порт ловушки. |
|
trap_v1_status строка |
Включить/выключить SNMP v1 ловушки. Варианты:
|
|
trap_v2c_lport integer |
Порт ловушки SNMP v2c. |
|
trap_v2c_rport integer |
Удаленный порт ловушки SNMP v2c. |
|
trap_v2c_status string |
Включить/выключить ловушки SNMP v2c. Варианты:
|
vdom string | Виртуальная область, среди определенных ранее. VDOM — это виртуальная инстанция FortiGate, которая может быть настроена и использована как отдельное устройство. По умолчанию: |
Примечания
Примечание
- Мы настоятельно рекомендуем использовать собственное значение в качестве идентификатора вместо 0. Хотя «0» является специальным маркером, позволяющим бэкенду назначить последнюю доступную цифру для объекта, у него есть ограничения. Дополнительные сведения см. в разделе «Вопросы и ответы».
- Модуль legacy fortiosapi устарел; предпочтительный способ запуска playbooks — httpapi.
- Модуль поддерживает режим проверки (check_mode).
Примеры
- name: Configure FortiSwitch SNMP v1/v2c communities globally.
fortinet.fortios.fortios_switch_controller_snmp_community:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
switch_controller_snmp_community:
events: "cpu-high"
hosts:
-
id: "5"
ip: "<your_own_value>"
id: "7"
name: "default_name_8"
query_v1_port: "161"
query_v1_status: "disable"
query_v2c_port: "161"
query_v2c_status: "disable"
status: "disable"
trap_v1_lport: "162"
trap_v1_rport: "162"
trap_v1_status: "disable"
trap_v2c_lport: "162"
trap_v2c_rport: "162"
trap_v2c_status: "disable"
Значения возврата
Общие значения возврата описаны в этом документе. Ниже приведены поля, уникальные для данного модуля:
Ключ | Описание |
|---|---|
build string | Номер сборки образа Fortigate. Возвращаемое значение: всегда Пример: |
http_method string | Последний метод, используемый для подготовки контента в FortiGate. Возвращаемое значение: всегда Пример: |
http_status string | Последний результат, полученный от FortiGate после последней операции. Возвращаемое значение: всегда Пример: |
mkey string | Главный ключ (идентификатор), используемый в последнем вызове FortiGate. Возвращаемое значение: успех Пример: |
name string | Название таблицы, использованной для выполнения запроса. Возвращаемое значение: всегда Пример: |
Ссылки на коллекцию
© 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_switch_controller_snmp_community_module.html
