fortinet.fortimanager.fmgr_devprof_system_snmp_user – Настройка пользователя SNMP.

Примечание

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

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

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

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

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

Обзор

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

Параметры

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

Примечания

Примечание

Существует только три параметра верхнего уровня, где «method» всегда обязателен, в то время как другие два «params» и «url_params» могут быть необязательными
Из-за сложности схемы 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/USER
     fmgr_devprof_system_snmp_user:
        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:
                -
                    auth-proto: <value in [md5, sha]>
                    auth-pwd:
                      - <value of string>
                    events:
                      - <value in [cpu-high, mem-low, log-full, ...]>
                    ha-direct: <value in [disable, enable]>
                    name: <value of string>
                    notify-hosts:
                      - <value of string>
                    notify-hosts6: <value of string>
                    priv-proto: <value in [aes, des, aes256, ...]>
                    priv-pwd:
                      - <value of string>
                    queries: <value in [disable, enable]>
                    query-port: <value of integer>
                    security-level: <value in [no-auth-no-priv, auth-no-priv, auth-priv]>
                    source-ip: <value of string>
                    source-ipv6: <value of string>
                    status: <value in [disable, enable]>
                    trap-lport: <value of integer>
                    trap-rport: <value of integer>
                    trap-status: <value in [disable, enable]>

   - name: REQUESTING /PM/CONFIG/DEVPROF/{DEVPROF}/SYSTEM/SNMP/USER
     fmgr_devprof_system_snmp_user:
        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 [auth-proto, auth-pwd, events, ...]>
              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 dictionary	всегда	Загрузка, возвращаемая в запросе
status dictionary	всегда	Статус запроса API
url string	всегда	Полный запрашиваемый 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_user_module.html