fortinet.fortimanager.fmgr_devprof_device_profile_fortianalyzer – без описания

Примечание

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

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

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

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

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

Обзор

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
loose_validation логическое значение	Варианты: no yes	Проверка параметров выполняется нестрого
method строка / обязательно	Варианты: 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	Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочую область

Примечания

Примечание

Существует только три параметра верхнего уровня, где «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}/DEVICE/PROFILE/FORTIANALYZER
     fmgr_devprof_device_profile_fortianalyzer:
        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:
           -
              option: <value in [object member, chksum, datasrc]>

   - name: REQUESTING /PM/CONFIG/DEVPROF/{DEVPROF}/DEVICE/PROFILE/FORTIANALYZER
     fmgr_devprof_device_profile_fortianalyzer:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [set, update]>
        url_params:
           adom: <value in [none, global, custom dom]>
           devprof: <value of string>
        params:
           -
              data:
                 managed-sn: <value of string>
                 target: <value in [none, this-fmg, managed, ...]>
                 target-ip: <value of string>
                 target-sn:
                   - <value of string>

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

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

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