fortinet.fortimanager.fmgr_webproxy_forwardserver модуль — Настройка адресов обратных серверов.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation булево	Устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log булево	Включить/отключить протоколирование для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизовать клиента Ansible с помощью токена доступа к API forticloud.
proposed_method строка	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое	Список кодов rc, с которыми будут переопределены условия для ошибки.
rc_succeeded список / элементы=целое	Список кодов rc, с которыми будут переопределены условия для успеха.
state строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
webproxy_forwardserver словарь	Установленные параметры верхнего уровня.
addr-type строка	Устарело, переименуйте на addr_type. Тип адреса сервера обратного прокси. Варианты: `"fqdn"` `"ip"` `"ipv6"`
comment строка	Комментарий.
fqdn строка	Полное доменное имя сервера обратного прокси.
healthcheck строка	Включить/отключить проверку состояния сервера обратного прокси. Варианты: `"disable"` `"enable"`
ip строка	IP-адрес сервера обратного прокси.
ipv6 строка	IPv6-адрес сервера обратного прокси.
masquerade строка	Включить/отключить использование IP-адреса исходящего интерфейса в качестве IP-адреса клиента. Варианты: `"disable"` `"enable"`
monitor строка	URL для мониторинга проверки состояния сервера обратного прокси.
name строка / обязательно	Имя сервера.
password любой	(список) Пароль HTTP-аутентификации.
port целое	Номер порта, на котором сервер обратного прокси ожидает получения HTTP-сессий.

END_OF_DOCUMENT_MARKER

server-down-option string	Устаревший параметр, пожалуйста, переименуйте его на server_down_option. Действие, которое следует выполнить, когда сервер переадресации оказывается недоступным Варианты: `"block"` `"pass"`
username string	Имя пользователя для аутентификации HTTP.
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 (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure forward-server addresses.
      fortinet.fortimanager.fmgr_webproxy_forwardserver:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: present # <value in [present, absent]>
        webproxy_forwardserver:
          addr_type: <value in [fqdn, ip, ipv6]>
          comment: <string>
          fqdn: <string>
          healthcheck: <value in [disable, enable]>
          ip: <string>
          monitor: <string>
          name: <string>
          port: <integer>
          server_down_option: <value in [block, pass]>
          password: <list or string>
          username: <string>
          ipv6: <string>
          masquerade: <value in [disable, enable]>

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

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

Ключ	Описание
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 список / элементы=строка	Предупреждение, если параметры, используемые в playbook, не поддерживаются текущей версией 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_webproxy_forwardserver_module.html