Модуль fortinet.fortimanager.fmgr_switchcontroller_managedswitch_snmpcommunity — Способ конфигурации для изменения протокола SNMP

Примечание

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

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

Для её установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Для использования в книге задач укажите: fortinet.fortimanager.fmgr_switchcontroller_managedswitch_snmpcommunity.

Новая функция в fortinet.fortimanager 2.1.0

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

Описание

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое	Устанавливается в True только в случае расхождений схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логическое	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизовать Ansible-клиента с помощью токена доступа к API forticloud.
managed-switch строка	Устарело, пожалуйста, используйте «managed_switch»
managed_switch строка	Параметр (managed-switch) в запрошенном URL.
proposed_method строка	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия для ошибки.
rc_succeeded список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия для успеха.
state строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
switchcontroller_managedswitch_snmpcommunity словарь	Набор параметров верхнего уровня.
events список / элементы=строка	SNMP уведомления Варианты: `"cpu-high"` `"mem-low"` `"log-full"` `"intf-ip"` `"ent-conf-change"`
hosts список / элементы=словарь	Хосты.
id целое число	ID записи хоста.
ip строка	IPv4-адрес SNMP-менеджера
id целое число / обязательно	Идентификатор сообщества SNMP.
name строка	Имя сообщества SNMP.
query_v1_port целое число	Устарело, пожалуйста, переименуйте в query_v1_port. Порт запроса SNMP v1
query_v1_status строка	Устарело, пожалуйста, переименуйте в query_v1_status. Включить/выключить запросы SNMP v1. Варианты: `"disable"` `"enable"`
query_v2c_port целое число	Устарело, пожалуйста, переименуйте в query_v2c_port. Порт запроса SNMP v2c

query-v2c-status string	Устаревший параметр, переименуйте его на query_v2c_status. Включение/выключение запросов SNMP v2c. Варианты: `"disable"` `"enable"`
status string	Включение/выключение этой SNMP-общности. Варианты: `"disable"` `"enable"`
trap-v1-lport integer	Устаревший параметр, переименуйте его на trap_v1_lport. Локальный порт SNMP v2c ловушки.
trap-v1-rport integer	Устаревший параметр, переименуйте его на trap_v1_rport. Удаленный порт SNMP v2c ловушки.
trap-v1-status string	Устаревший параметр, переименуйте его на trap_v1_status. Включение/выключение SNMP v1 ловушек. Варианты: `"disable"` `"enable"`
trap-v2c-lport integer	Устаревший параметр, переименуйте его на trap_v2c_lport. Локальный порт SNMP v2c ловушки.
trap-v2c-rport integer	Устаревший параметр, переименуйте его на trap_v2c_rport. Удаленный порт SNMP v2c ловушки.
trap-v2c-status string	Устаревший параметр, переименуйте его на trap_v2c_status. Включение/выключение SNMP v2c ловушек. Варианты: `"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 (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configuration method to edit Simple Network Management Protocol
      fortinet.fortimanager.fmgr_switchcontroller_managedswitch_snmpcommunity:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        managed_switch: <your own value>
        state: present # <value in [present, absent]>
        switchcontroller_managedswitch_snmpcommunity:
          events:
            - cpu-high
            - mem-low
            - log-full
            - intf-ip
            - ent-conf-change
          hosts:
            -
              id: <integer>
              ip: <string>
          id: <integer>
          name: <string>
          query_v1_port: <integer>
          query_v1_status: <value in [disable, enable]>
          query_v2c_port: <integer>
          query_v2c_status: <value in [disable, enable]>
          status: <value in [disable, enable]>
          trap_v1_lport: <integer>
          trap_v1_rport: <integer>
          trap_v1_status: <value in [disable, enable]>
          trap_v2c_lport: <integer>
          trap_v2c_rport: <integer>
          trap_v2c_status: <value in [disable, enable]>

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

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

Ключ	Описание
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_switchcontroller_managedswitch_snmpcommunity_module.html