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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.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 string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрашиваемом URL.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
devprof string / обязательный	Параметр (devprof) в запрашиваемом URL.
devprof_system_snmp_community dictionary	Параметры верхнего уровня.
events list / elements=string	События SNMP trap. Варианты: `"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"` `"security_level_change"` `"cert-expiry"` `"dio"` `"sensor"` `"bfd"`
hosts list / elements=dictionary	Узлы.
ha_direct псевдонимы: ha-direct string	Включить/отключить прямое управление участниками кластера HA. Варианты: `"disable"` `"enable"`
host_type псевдонимы: host-type string	Указывает, отправляет ли менеджер SNMP-запросы, принимает SNMP-trap или выполняет обе операции. Варианты: `"any"` `"query"` `"trap"`
id integer	Идентификатор записи узла.
interface any	(список) Укажите исходящий интерфейс для связи с сервером.
interface_select_method псевдонимы: interface-select-method string	Укажите способ выбора исходящего интерфейса для связи с сервером. Варианты: `"auto"` `"sdwan"` `"specify"`
ip string	IPv4-адрес менеджера SNMP.
source_ip псевдонимы: source-ip string	Исходный IPv4-адрес для SNMP-trap.
vrf_select псевдонимы: vrf-select integer	Идентификатор VRF, используемый для подключения к серверу.
hosts6 list / elements=dictionary	Узлы IPv6.
ha_direct псевдонимы: ha-direct string	Включить/отключить прямое управление участниками кластера HA. Варианты: `"disable"` `"enable"`
host_type псевдонимы: host-type string	Указывает, отправляет ли менеджер SNMP-запросы, принимает SNMP-trap или выполняет обе операции. Варианты: `"any"` `"query"` `"trap"`
id integer	Идентификатор записи узла IPv6.
interface any	(список) Укажите исходящий интерфейс для связи с сервером.
interface_select_method псевдонимы: interface-select-method string	Укажите способ выбора исходящего интерфейса для связи с сервером. Варианты: `"auto"` `"sdwan"` `"specify"`
ipv6 string	Префикс IPv6-адреса менеджера SNMP.
source_ipv6 псевдонимы: source-ipv6 string	Исходный IPv6-адрес для SNMP-trap.
vrf_select псевдонимы: vrf-select integer	Идентификатор VRF, используемый для подключения к серверу.
id integer / обязательный	Идентификатор сообщества.
mib_view псевдонимы: mib-view string	Представление MIB для управления доступом SNMP.
name string	Имя сообщества.
query_v1_port псевдонимы: query-v1-port integer	Порт запросов SNMP v1.
query_v1_status псевдонимы: query-v1-status string	Включить/отключить запросы SNMP v1. Варианты: `"disable"` `"enable"`
query_v2c_port псевдонимы: query-v2c-port integer	Порт запросов SNMP v2c.
query_v2c_status псевдонимы: query-v2c-status string	Включить/отключить запросы SNMP v2c. Варианты: `"disable"` `"enable"`
status string	Включить/отключить это сообщество SNMP. Варианты: `"disable"` `"enable"`
trap_v1_lport псевдонимы: trap-v1-lport integer	Локальный порт для SNMP-trap v1.
trap_v1_rport псевдонимы: trap-v1-rport integer	Удалённый порт для SNMP-trap v1.
trap_v1_status псевдонимы: trap-v1-status string	Включить/отключить SNMP-trap v1. Варианты: `"disable"` `"enable"`
trap_v2c_lport псевдонимы: trap-v2c-lport integer	Локальный порт для SNMP-trap v2c.
trap_v2c_rport псевдонимы: trap-v2c-rport integer	Удалённый порт для SNMP-trap v2c.
trap_v2c_status псевдонимы: trap-v2c-status string	Включить/отключить SNMP-trap v2c. Варианты: `"disable"` `"enable"`
vdoms any	(список) VDOM для управления доступом 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, работающем в режиме рабочей области. Значением может быть global или другой ADOM, включая 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 помогают управлять этим режимом.
Обычно выполнение модуля может завершиться ошибкой, если возвращается ненулевое значение rc. Условия завершения с ошибкой или успешного выполнения также можно переопределить с помощью параметров rc_failed и rc_succeeded.
Чтобы создать или обновить объект, используйте директиву state present.
Чтобы удалить объект, используйте директиву state absent.

Примеры

- name: Example playbook
  hosts: fortimanagers
  gather_facts: false
  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 dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / elements=string	Ответ API. Возвращается: всегда
response_message string	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / elements=string	Предупреждение о том, что используемые в сценарии параметры не поддерживаются текущей версией 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_devprof_system_snmp_community_module.html