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

Примечание

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

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

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

Введено в версии 2.10: of fortinet.fortimanager

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

Обзор

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
loose_validation boolean	Варианты: no yes	Проверка параметров выполняется в свободном стиле
method string / обязательно	Варианты: add get set update	Метод запроса
params list / элементы=строка		Параметры для каждого метода Полный список параметров см. в 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 строка		Имя adom для блокировки в случае работы FortiManager в режиме рабочей области Может быть глобальным или любым другим пользовательским именем adom
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/DEVPROF/ADOM/{ADOM}
     fmgr_pm_devprof_adom_obj:
        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]>
        params:
           -
              data:
                -
                    description: <value of string>
                    enabled options:
                      - <value in [none, dns, ntp, ...]>
                    name: <value of string>
                    oid: <value of integer>
                    scope member:
                      -
                          name: <value of string>
                          vdom: <value of string>
                    type: <value in [devprof]>

   - name: REQUESTING /PM/DEVPROF/ADOM/{ADOM}
     fmgr_pm_devprof_adom_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]>
        params:
           -
              fields:
                -
                   - <value in [description, enabled options, name, ...]>

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

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

Ключ	Возвращено	Описание
data словарь	всегда	Загруженный payload в запросе
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_pm_devprof_adom_obj_module.html