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

Примечание

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

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

Чтобы использовать его в книге задач, укажите: fortinet.fortimanager.fmgr_pm_pkg_obj.

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

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

Описание

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
loose_validation логический	Варианты: нет да	Проверка параметров выполняется нестрого
method строка / обязательно	Варианты: удалить получить установить обновить	Метод запроса
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/PKG/{PKG_PATH}
     fmgr_pm_pkg_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]>
           pkg_path: <value of string>
        params:
           -
              fields:
                -
                   - <value in [name, obj ver, oid, ...]>

   - name: REQUESTING /PM/PKG/{PKG_PATH}
     fmgr_pm_pkg_obj:
        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]>
           pkg_path: <value of string>
        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]>

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

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

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