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

Примечание

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

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

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

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

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

Обзор

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

Параметры

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

Примечания

Примечание

Существует только три параметра верхнего уровня, где «метод» всегда требуется, а два других «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
     fmgr_firewall_service_custom:
        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:
                -
                    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
     fmgr_firewall_service_custom:
        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:
           -
              attr: <value of string>
              fields:
                -
                   - <value in [app-category, app-service-type, application, ...]>
              filter:
                - <value of string>
              get used: <value of integer>
              loadsub: <value of integer>
              option: <value in [count, object member, datasrc, ...]>
              range:
                - <value of integer>
              sortings:
                -
                    varidic.attr_name: <value in [1, -1]>

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

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

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