Модуль fortinet.fortimanager.fmgr_webproxy_forwardserver — настройка адресов серверов-переадресации.

Примечание

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

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

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

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

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

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

Обзор

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
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"`
webproxy_forwardserver dictionary	Набор параметров верхнего уровня.
addr_type псевдонимы: addr-type string	Тип адреса сервера прокси-переадресации Варианты: `"fqdn"` `"ip"` `"ipv6"`
authentication string	Тип аутентификации. Варианты: `"disabled"` `"immediately"` `"upon-challenge"`
comment string	Комментарий.
fqdn string	Полное доменное имя сервера переадресации
healthcheck string	Включить или отключить проверку работоспособности сервера переадресации. Варианты: `"disable"` `"enable"`
interface any	(список) Укажите исходящий интерфейс для связи с сервером.
interface_select_method псевдонимы: interface-select-method string	Укажите способ выбора исходящего интерфейса для связи с сервером. Варианты: `"auto"` `"sdwan"` `"specify"`
ip string	IP-адрес сервера прокси-переадресации.
ippool any	(список) Пул IP-адресов.
ipv6 string	IPv6-адрес сервера прокси-переадресации.
masquerade string	Включить или отключить использование IP-адреса исходящего интерфейса в качестве IP-адреса клиента Варианты: `"disable"` `"enable"`
monitor string	URL для мониторинга работоспособности сервера переадресации
name string / обязательный	Имя сервера.
password any	(список) Пароль для аутентификации HTTP.
port integer	Номер порта, на котором сервер переадресации ожидает HTTP-сеансы
protocol list / элементы=string	Протокол. Варианты: `"http"` `"ftp"` `"socks"`
server_down_option псевдонимы: server-down-option string	Действие, выполняемое при обнаружении неработоспособности сервера переадресации Варианты: `"block"` `"pass"`
user string	Имя пользователя для базовой аутентификации прокси-сервера.
username string	Имя пользователя для аутентификации HTTP.
vrf_select псевдонимы: vrf-select integer	Идентификатор VRF, используемый для подключения к серверу.
workspace_locking_adom string	ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другой ADOM, включая root.
workspace_locking_timeout integer	Максимальное время в секундах ожидания снятия блокировки рабочей области другим пользователем. По умолчанию: `300`

Примечания

Примечание

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

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Configure forward-server addresses.
      fortinet.fortimanager.fmgr_webproxy_forwardserver:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        webproxy_forwardserver:
          name: "your value" # Required variable, string
          # addr_type: <value in [fqdn, ip, ipv6]>
          # comment: <string>
          # fqdn: <string>
          # healthcheck: <value in [disable, enable]>
          # ip: <string>
          # monitor: <string>
          # port: <integer>
          # server_down_option: <value in [block, pass]>
          # password: <list or string>
          # username: <string>
          # ipv6: <string>
          # masquerade: <value in [disable, enable]>
          # interface: <list or string>
          # interface_select_method: <value in [auto, sdwan, specify]>
          # vrf_select: <integer>
          # ippool: <list or string>
          # protocol: ["http", "ftp", "socks"]
          # authentication: <value in [disabled, immediately, upon-challenge]>
          # user: <string>

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

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / элементы=string	Ответ API. Возвращается: всегда
response_message string	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / элементы=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_webproxy_forwardserver_module.html