fortinet.fortimanager.fmgr_devprof_system_snmp_community – Настройка сообщества SNMP.

Примечание

Этот плагин входит в коллекцию fortinet.fortimanager (версия 1.0.5).

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

Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_devprof_system_snmp_community.

Новое в версии 2.10: модуля fortinet.fortimanager

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

Обзор

Этот модуль позволяет настроить устройство FortiManager, позволяя пользователю [ добавить, получить, установить, обновить ] следующие API.
/pm/config/adom/{adom}/devprof/{devprof}/system/snmp/community
Примеры включают все параметры и значения, которые необходимо скорректировать перед использованием.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
loose_validation boolean	Варианты: no yes	Верификация параметров в свободном режиме
method строка / обязательный	Варианты: add get set update	Метод запроса
params список / элементы=строка		Параметры для каждого метода Полный список параметров см. в https://ansible-galaxy-fortimanager-docs.readthedocs.io/en/latest
url_params словарь		Параметры для URL каждого запроса API Также см. полный список параметров URL в https://ansible-galaxy-fortimanager-docs.readthedocs.io/en/latest
workspace_locking_adom строка		Имя домена для блокировки, если FortiManager работает в режиме рабочей области Может быть глобальным или любым другим именем пользовательского домена
workspace_locking_timeout целое число	Значение по умолчанию: 300	Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочую область

Примечания

Примечание

Существуют только три параметра верхнего уровня, где «метод» всегда требуется, а два других «параметры» и «параметры URL» могут быть необязательными.
Из-за сложности схемы API fortimanager проверка выполняется вне процедуры проверки параметров Ansible.
Синтаксис OPTIONS не соответствует стандартному указанию аргументов Ansible, но с учетом структуры схемы API fortimanager нам требуется тривиальное преобразование при заполнении плейбука ansible.

Примеры

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:

   - name: REQUESTING /PM/CONFIG/DEVPROF/{DEVPROF}/SYSTEM/SNMP/COMMUNITY
     fmgr_devprof_system_snmp_community:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [add, set, update]>
        url_params:
           adom: <value in [none, global, custom dom]>
           devprof: <value of string>
        params:
           -
              data:
                -
                    events:
                      - <value in [cpu-high, mem-low, log-full, ...]>
                    hosts:
                      -
                          ha-direct: <value in [disable, enable]>
                          host-type: <value in [any, query, trap]>
                          id: <value of integer>
                          ip: <value of string>
                          source-ip: <value of string>
                    hosts6:
                      -
                          ha-direct: <value in [disable, enable]>
                          host-type: <value in [any, query, trap]>
                          id: <value of integer>
                          ipv6: <value of string>
                          source-ipv6: <value of string>
                    id: <value of integer>
                    name: <value of string>
                    query-v1-port: <value of integer>
                    query-v1-status: <value in [disable, enable]>
                    query-v2c-port: <value of integer>
                    query-v2c-status: <value in [disable, enable]>
                    status: <value in [disable, enable]>
                    trap-v1-lport: <value of integer>
                    trap-v1-rport: <value of integer>
                    trap-v1-status: <value in [disable, enable]>
                    trap-v2c-lport: <value of integer>
                    trap-v2c-rport: <value of integer>
                    trap-v2c-status: <value in [disable, enable]>

   - name: REQUESTING /PM/CONFIG/DEVPROF/{DEVPROF}/SYSTEM/SNMP/COMMUNITY
     fmgr_devprof_system_snmp_community:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [get]>
        url_params:
           adom: <value in [none, global, custom dom]>
           devprof: <value of string>
        params:
           -
              attr: <value of string>
              fields:
                -
                   - <value in [events, id, name, ...]>
              filter:
                - <value of string>
              get used: <value of integer>
              loadsub: <value of integer>
              option: <value in [count, object member, datasrc, ...]>
              range:
                - <value of integer>
              sortings:
                -
                    varidic.attr_name: <value in [1, -1]>

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

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

Ключ	Возвращаемое значение	Описание
data словарь	всегда	Полезная нагрузка, возвращенная в запросе
status словарь	всегда	Статус запроса API
url строка	всегда	Полный URL запроса Пример: /sys/login/user

Авторы

Frank Shen (@fshen01)
Link Zheng (@zhengl)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/fortinet/fortimanager/fmgr_devprof_system_snmp_community_module.html