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

Примечание

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

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

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

Новое в версии 2.10: of fortinet.fortimanager

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

Обзор

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
loose_validation boolean	Варианты: no yes	Проверка параметров в свободном режиме
method string / обязательно	Варианты: clone delete 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/USER/{USER}
     fmgr_devprof_system_snmp_user_obj:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [clone, set, update]>
        url_params:
           adom: <value in [none, global, custom dom]>
           devprof: <value of string>
           user: <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/{USER}
     fmgr_devprof_system_snmp_user_obj:
        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>
           user: <value of string>
        params:
           -
              option: <value in [object member, chksum, datasrc]>

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

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

Ключ	Возвращаемое значение	Описание
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_user_obj_module.html