Модуль fortinet.fortimanager.fmgr_devprof_system_snmp_community — Настройка сообщества SNMP.

Примечание

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

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

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

Чтобы использовать в книге задач, укажите: fortinet.fortimanager.fmgr_devprof_system_snmp_community.

Добавлена в fortinet.fortimanager 1.0.0

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

Обзор

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое	Устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
devprof строка / обязательно	Параметр (devprof) в запрошенном URL.
devprof_system_snmp_community словарь	Настроены верхнеуровневые параметры.
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"` `"temperature-high"` `"voltage-alert"` `"ha-member-up"` `"ha-member-down"` `"ent-conf-change"` `"av-conserve"` `"av-bypass"` `"av-oversize-passed"` `"av-oversize-blocked"` `"ips-pkg-update"` `"power-supply-failure"` `"amc-bypass"` `"faz-disconnect"` `"fan-failure"` `"bgp-established"` `"bgp-backward-transition"` `"wc-ap-up"` `"wc-ap-down"` `"fswctl-session-up"` `"fswctl-session-down"` `"ips-fail-open"` `"load-balance-real-server-down"` `"device-new"` `"enter-intf-bypass"` `"exit-intf-bypass"` `"per-cpu-high"` `"power-blade-down"` `"confsync_failure"` `"dhcp"` `"pool-usage"` `"power-redundancy-degrade"` `"power-redundancy-failure"` `"ospf-nbr-state-change"` `"ospf-virtnbr-state-change"` `"disk-failure"` `"disk-overload"` `"faz-main-failover"` `"faz-alt-failover"` `"slbc"` `"faz"` `"power-supply"` `"ippool"` `"interface"`
hosts список / элементы=словарь	Хосты.
ha-direct строка	Устаревшее, пожалуйста, переименуйте на ha_direct. Включить/выключить прямое управление членами кластера HA. Варианты: `"disable"` `"enable"`
host-type строка	Устаревшее, пожалуйста, переименуйте на host_type. Управление тем, отправляет ли SNMP-менеджер SNMP-запросы, получает ли SNMP-ловушки… Варианты: `"any"` `"query"` `"trap"`
id целое число	Идентификатор записи хоста.
interface любой	(список) Укажите исходящий интерфейс для связи с сервером.
interface-select-method строка	Устаревшее, пожалуйста, переименуйте на interface_select_method. Укажите способ выбора исходящего интерфейса для связи с сервером. Варианты: `"auto"` `"sdwan"` `"specify"`
ip строка	IPv4-адрес SNMP-менеджера
source-ip строка	Устаревшее, пожалуйста, переименуйте на source_ip. Исходный IPv4-адрес для SNMP-ловушек.
hosts6 список / элементы=словарь	Хосты6.
ha-direct строка	Устаревшее, пожалуйста, переименуйте на ha_direct. Включить/выключить прямое управление членами кластера HA. Варианты: `"disable"` `"enable"`

host-type string	Устарело, переименуйте в host_type. Управляет тем, отправляет ли менеджер SNMP запросы SNMP, принимает ли ловушки SNMP… Choices: `"any"` `"query"` `"trap"`
id integer	Идентификатор записи Host6.
interface any	(список) Укажите исходящий интерфейс для доступа к серверу.
interface-select-method string	Устарело, переименуйте в interface_select_method. Укажите, как выбрать исходящий интерфейс для доступа к серверу. Choices: `"auto"` `"sdwan"` `"specify"`
ipv6 string	Префикс IPv6-адреса менеджера SNMP.
source-ipv6 string	Устарело, переименуйте в source_ipv6. Исходящий IPv6-адрес для ловушек SNMP.
id integer / required	Идентификатор сообщества.
mib-view string	Устарело, переименуйте в mib_view. Представление MIB для управления доступом SNMP.
name string	Имя сообщества.
query-v1-port integer	Устарело, переименуйте в query_v1_port. Порт запроса SNMP v1
query-v1-status string	Устарело, переименуйте в query_v1_status. Включить/выключить запросы SNMP v1. Choices: `"disable"` `"enable"`
query-v2c-port integer	Устарело, переименуйте в query_v2c_port. Порт запроса SNMP v2c
query-v2c-status string	Устарело, переименуйте в query_v2c_status. Включить/выключить запросы SNMP v2c. Choices: `"disable"` `"enable"`
status string	Включить/выключить это сообщество SNMP. Choices: `"disable"` `"enable"`
trap-v1-lport integer	Устарело, переименуйте в trap_v1_lport. Локальный порт ловушки SNMP v1
trap-v1-rport integer	Устарело, переименуйте в trap_v1_rport. Удаленный порт ловушки SNMP v1
trap-v1-status string	Устарело, переименуйте в trap_v1_status. Включить/выключить ловушки SNMP v1. Choices: `"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. Choices: `"disable"` `"enable"`
vdoms any	(список) VDOMs для управления доступом SNMP.

enable_log boolean	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method string	Переопределённый метод для основного запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список кодов rc, при которых будет выполнено условие ошибки.
rc_succeeded list / elements=integer	Список кодов rc, при которых будет выполнено условие успешного завершения.
state string / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom string	ADOM для блокировки FortiManager, работающего в режиме рабочего пространства; значение может быть глобальным и другими, включая корневой.
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
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: SNMP community configuration.
      fortinet.fortimanager.fmgr_devprof_system_snmp_community:
        bypass_validation: false
        adom: ansible
        devprof: "ansible-test" # system template name, could find it in FortiManager UI: Device Manager --> Provisioning Templates --> System Templates
        state: present
        devprof_system_snmp_community:
          events:
            - 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
            - temperature-high
            - voltage-alert
            - ha-member-up
            - ha-member-down
            - ent-conf-change
            - av-conserve
            - av-bypass
            - av-oversize-passed
            - av-oversize-blocked
            - ips-pkg-update
            - power-supply-failure
            - amc-bypass
            - faz-disconnect
            - fan-failure
            - bgp-established
            - bgp-backward-transition
            - wc-ap-up
            - wc-ap-down
            - fswctl-session-up
            - fswctl-session-down
            - ips-fail-open
            - load-balance-real-server-down
            - device-new
            - enter-intf-bypass
            - exit-intf-bypass
            - per-cpu-high
            - power-blade-down
            - confsync_failure
          hosts:
            - ha-direct: enable
              host-type: any
              id: 1
          id: 1
          name: "ansible-test"

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the communities in system template
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "devprof_system_snmp_community"
          params:
            adom: "ansible"
            devprof: "ansible-test" # system template name, could find it in FortiManager UI: Device Manager --> Provisioning Templates --> System Templates
            community: "your_value"

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

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

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