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

Примечание

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

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

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

Введено в версии 2.10: плагина fortinet.fortimanager

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

Обзор

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
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 строка		Имя домена 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/PKG/ADOM/{ADOM}
     fmgr_pm_pkg_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:
                -
                    name: <value of string>
                    obj ver: <value of integer>
                    oid: <value of integer>
                    package setting:
                       central-nat: <value in [disable, enable]>
                       consolidated-firewall-mode: <value in [disable, enable]>
                       fwpolicy-implicit-log: <value in [disable, enable]>
                       fwpolicy6-implicit-log: <value in [disable, enable]>
                       inspection-mode: <value in [proxy, flow]>
                       ngfw-mode: <value in [profile-based, policy-based]>
                       ssl-ssh-profile: <value of string>
                    scope member:
                      -
                          name: <value of string>
                          vdom: <value of string>
                    type: <value in [pkg, folder]>

   - name: REQUESTING /PM/PKG/ADOM/{ADOM}
     fmgr_pm_pkg_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 [name, obj ver, oid, ...]>

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

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

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