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

Примечание

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

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

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

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

Новый в fortinet.fortimanager 1.0.0

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

Описание

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation булево	Устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log булево	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
firewall_service_custom словарь	Установленные параметры верхнего уровня.
app-category любой	(список) Устарело, пожалуйста, переименуйте на app_category. Идентификатор категории приложения.
app-service-type строка	Устарело, пожалуйста, переименуйте на app_service_type. Тип службы приложения. Варианты: `"disable"` `"app-id"` `"app-category"`
application любой	(список) Идентификатор приложения.
category строка	Категория службы.
check-reset-range строка	Устарело, пожалуйста, переименуйте на check_reset_range. Настройка типа проверки сообщений об ошибках ICMP. Варианты: `"disable"` `"default"` `"strict"`
color целое число	Цвет значка на графическом интерфейсе.
comment любой	(словарь или строка) Комментарий.
explicit-proxy строка	Устарело, пожалуйста, переименуйте на explicit_proxy. Включить/выключить явную службу веб-прокси. Варианты: `"disable"` `"enable"`
fabric-object строка	Устарело, пожалуйста, переименуйте на fabric_object. Параметр глобального объекта Security Fabric. Варианты: `"disable"` `"enable"`
fqdn строка	Полное доменное имя.
global-object целое число	Устарело, пожалуйста, переименуйте на global_object. Глобальный объект.
helper строка	Имя помощника. Варианты: `"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 целое число	Код ICMP.
icmptype целое число	Тип ICMP.
iprange строка	Начальный и конечный IP-адреса диапазона, связанного со службой.

END_OF_DOCUMENT_MARKER

name string / required	Имя пользовательского сервиса.
protocol string	Тип протокола на основе номеров IANA. Choices: `"ICMP"` `"IP"` `"TCP/UDP/SCTP"` `"ICMP6"` `"HTTP"` `"FTP"` `"CONNECT"` `"SOCKS"` `"ALL"` `"SOCKS-TCP"` `"SOCKS-UDP"` `"TCP/UDP/UDP-Lite/SCTP"`
protocol-number integer	Устарело, пожалуйста, переименуйте в protocol_number. Номер IP-протокола.
proxy string	Включить/отключить веб-прокси-сервис. Choices: `"disable"` `"enable"`
sctp-portrange string	Устарело, пожалуйста, переименуйте в sctp_portrange. Несколько диапазонов портов SCTP.
session-ttl any	(int или str) Устарело, пожалуйста, переименуйте в session_ttl. Время жизни сессии
tcp-halfclose-timer integer	Устарело, пожалуйста, переименуйте в tcp_halfclose_timer. Время ожидания закрытия TCP-сессии, ожидающей пакета FIN без ответа
tcp-halfopen-timer integer	Устарело, пожалуйста, переименуйте в tcp_halfopen_timer. Время ожидания закрытия TCP-сессии, ожидающей открытия сессии без ответа…
tcp-portrange string	Устарело, пожалуйста, переименуйте в tcp_portrange. Несколько диапазонов TCP-портов.
tcp-rst-timer integer	Устарело, пожалуйста, переименуйте в tcp_rst_timer. Устанавливает длительность состояния TCP CLOSE в секундах
tcp-timewait-timer integer	Устарело, пожалуйста, переименуйте в tcp_timewait_timer. Устанавливает длительность состояния TCP TIME-WAIT в секундах
udp-idle-timer integer	Устарело, пожалуйста, переименуйте в udp_idle_timer. Время ожидания полузакрытия UDP
udp-portrange string	Устарело, пожалуйста, переименуйте в udp_portrange. Несколько диапазонов UDP-портов.
udplite-portrange string	Устарело, пожалуйста, переименуйте в udplite_portrange. Несколько диапазонов портов UDP-Lite.
uuid string	Универсальный уникальный идентификатор
visibility string	Включить/отключить видимость сервиса в графическом интерфейсе. Choices: `"disable"` `"enable"`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method string	Переопределённый метод для базового запроса Json RPC. Choices: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список кодов rc, с которыми будут переопределены условия сбоя.
rc_succeeded list / elements=integer	Список кодов rc, с которыми будут переопределены условия успеха.
state string / required	Директива для создания, обновления или удаления объекта. Choices: `"present"` `"absent"`

workspace_locking_adom string	ADOM для блокировки в режиме рабочего пространства FortiManager, значение может быть глобальным и другими, включая корневой.
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 выполняют необходимые действия.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно выполнение одного модуля может завершиться неудачей при возвращении ненулевого кода rc. Вы также можете переопределить условия завершения успехом или неудачей с помощью параметров rc_failed и rc_succeeded

Примеры

- name: Example playbook
  hosts: fortimanagers
  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 словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Дескриптивное сообщение ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_firewall_service_custom_module.html