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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_firewall_service_custom.

Добавлено в fortinet.fortimanager 1.0.0

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

Обзор

Этот модуль позволяет настраивать устройство FortiManager.
Примеры содержат все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрашиваемом URL.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
firewall_service_custom dictionary	Заданные параметры верхнего уровня.
app_category псевдонимы: app-category any	(список) Идентификатор категории приложения.
app_service_type псевдонимы: app-service-type string	Тип службы приложения. Варианты: `"disable"` `"app-id"` `"app-category"`
application any	(список) Идентификатор приложения.
category string	Категория службы.
check_reset_range псевдонимы: check-reset-range string	Настройка типа проверки сообщений об ошибках ICMP. Варианты: `"disable"` `"default"` `"strict"`
color integer	Цвет значка в графическом интерфейсе.
comment any	(словарь или строка) Комментарий.
explicit_proxy псевдонимы: explicit-proxy string	Включить или отключить службу явного веб-прокси. Варианты: `"disable"` `"enable"`
fabric_object псевдонимы: fabric-object string	Настройка глобального объекта Security Fabric. Варианты: `"disable"` `"enable"`
fqdn string	Полное доменное имя.
global_object псевдонимы: global-object integer	Глобальный объект.
helper string	Имя помощника. Варианты: `"disable"` `"auto"` `"ftp"` `"tftp"` `"ras"` `"h323"` `"tns"` `"mms"` `"sip"` `"pptp"` `"rtsp"` `"dns-udp"` `"dns-tcp"` `"pmap"` `"rsh"` `"dcerpc"` `"mgcp"` `"gtp-c"` `"gtp-u"` `"gtp-b"` `"pfcp"`
icmpcode integer	Код ICMP.
icmptype integer	Тип ICMP.
iprange string	Начало и конец диапазона IP-адресов, связанного со службой.
name string / обязательный	Имя пользовательской службы.
protocol string	Тип протокола согласно номерам IANA. Варианты: `"ICMP"` `"IP"` `"TCP/UDP/SCTP"` `"ICMP6"` `"HTTP"` `"FTP"` `"CONNECT"` `"SOCKS"` `"ALL"` `"SOCKS-TCP"` `"SOCKS-UDP"` `"TCP/UDP/UDP-Lite/SCTP"`
protocol_number псевдонимы: protocol-number integer	Номер протокола IP.
proxy string	Включить или отключить службу веб-прокси. Варианты: `"disable"` `"enable"`
sctp_portrange псевдонимы: sctp-portrange string	Несколько диапазонов портов SCTP.
session_ttl псевдонимы: session-ttl any	(целое число или строка) Время жизни сеанса (TTL)
tcp_halfclose_timer псевдонимы: tcp-halfclose-timer integer	Время ожидания закрытия TCP-сеанса при отсутствии ответа на пакет FIN
tcp_halfopen_timer псевдонимы: tcp-halfopen-timer integer	Время ожидания закрытия TCP-сеанса при отсутствии ответа на пакет открытия сеанса
tcp_portrange псевдонимы: tcp-portrange string	Несколько диапазонов портов TCP.
tcp_rst_timer псевдонимы: tcp-rst-timer integer	Задать длительность состояния TCP CLOSE в секундах
tcp_timewait_timer псевдонимы: tcp-timewait-timer integer	Задать длительность состояния TCP TIME-WAIT в секундах
udp_idle_timer псевдонимы: udp-idle-timer integer	Тайм-аут полуоткрытого состояния UDP
udp_portrange псевдонимы: udp-portrange string	Несколько диапазонов портов UDP.
udplite_portrange псевдонимы: udplite-portrange string	Несколько диапазонов портов UDP-Lite.
uuid string	Универсальный уникальный идентификатор
visibility string	Включить или отключить отображение службы в графическом интерфейсе. Варианты: `"disable"` `"enable"`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method string	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / элементы=integer	Список кодов rc, переопределяющий условия возникновения ошибки.
rc_succeeded list / элементы=integer	Список кодов rc, переопределяющий условия успешного выполнения.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state string / обязательный	Указание создать, обновить или удалить объект. Варианты: `"present"` `"absent"`
workspace_locking_adom string	ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другое имя, включая root.
workspace_locking_timeout integer	Максимальное время в секундах ожидания освобождения блокировки рабочей области другим пользователем. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, все входные аргументы именуются в соответствии с соглашением об именовании через подчёркивания (snake_case). Замените аргументы, например “var-name”, на “var_name”. Старые имена аргументов по-прежнему доступны, но при их использовании будут выдаваться предупреждения об устаревании. Это предупреждение можно игнорировать, задав deprecation_warnings=False в ansible.cfg.
Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области; для этого используются параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
Как правило, выполнение модуля может завершиться ошибкой, если возвращён ненулевой код rc. Условия ошибки или успешного выполнения также можно переопределить с помощью параметров rc_failed и rc_succeeded.
Чтобы создать или обновить объект, используйте директиву state present.
Чтобы удалить объект, используйте директиву state absent.

Примеры

- name: Example playbook
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure custom services.
      fortinet.fortimanager.fmgr_firewall_service_custom:
        bypass_validation: false
        adom: ansible
        state: present
        firewall_service_custom:
          app_service_type: disable # <value in [disable, app-id, app-category]>
          color: 1
          comment: "comment"
          helper: auto # <value in [disable, auto, ftp, ...]>
          name: "ansible-test"
          protocol: ALL # <value in [ICMP, IP, TCP/UDP/SCTP, ...]>
          proxy: enable # <value in [disable, enable]>
          visibility: enable # <value in [disable, enable]>

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the custom services
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_service_custom"
          params:
            adom: "ansible"
            custom: "your_value"

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

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / elements=string	Ответ API. Возвращается: всегда
response_message string	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / elements=string	Предупреждение, если используемые в сценарии параметры не поддерживаются текущей версией FortiManager. Возвращается: при наличии соответствующих условий

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_firewall_service_custom_module.html