fortinet.fortimanager.fmgr_firewall_service_custom_obj – Настройка пользовательских служб.

Примечание

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

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

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

Добавлено в версии 2.10: для fortinet.fortimanager

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

Обзор

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
loose_validation boolean	Варианты: no yes	Проверка параметров выполняется смягчённым способом.
method строка / обязательно	Варианты: clone delete get move 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/OBJ/FIREWALL/SERVICE/CUSTOM/{CUSTOM}
     fmgr_firewall_service_custom_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]>
           custom: <value of string>
        params:
           -
              data:
                 app-category:
                   - <value of integer>
                 app-service-type: <value in [disable, app-id, app-category]>
                 application:
                   - <value of integer>
                 category: <value of string>
                 check-reset-range: <value in [disable, default, strict]>
                 color: <value of integer>
                 comment: <value of string>
                 fqdn: <value of string>
                 helper: <value in [disable, auto, ftp, ...]>
                 icmpcode: <value of integer>
                 icmptype: <value of integer>
                 iprange: <value of string>
                 name: <value of string>
                 protocol: <value in [ICMP, IP, TCP/UDP/SCTP, ...]>
                 protocol-number: <value of integer>
                 proxy: <value in [disable, enable]>
                 sctp-portrange: <value of string>
                 session-ttl: <value of integer>
                 tcp-halfclose-timer: <value of integer>
                 tcp-halfopen-timer: <value of integer>
                 tcp-portrange: <value of string>
                 tcp-timewait-timer: <value of integer>
                 udp-idle-timer: <value of integer>
                 udp-portrange: <value of string>
                 visibility: <value in [disable, enable]>

   - name: REQUESTING /PM/CONFIG/OBJ/FIREWALL/SERVICE/CUSTOM/{CUSTOM}
     fmgr_firewall_service_custom_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]>
           custom: <value of string>
        params:
           -
              option: <value in [object member, chksum, datasrc]>

   - name: REQUESTING /PM/CONFIG/OBJ/FIREWALL/SERVICE/CUSTOM/{CUSTOM}
     fmgr_firewall_service_custom_obj:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [move]>
        url_params:
           adom: <value in [none, global, custom dom]>
           custom: <value of string>
        params:
           -
              option: <value in [before, after]>
              target: <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_firewall_service_custom_obj_module.html