Модуль fortinet.fortimanager.fmgr_firewall_vip6_dynamicmapping_realservers — выбор реальных серверов, на которые эта VIP-конфигурация балансировки нагрузки будет распределять трафик.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_firewall_vip6_dynamicmapping_realservers.
Добавлено в fortinet.fortimanager 2.1.0
Краткое описание
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры содержат все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom string / обязательный | Параметр (adom) в запрашиваемом URL. |
bypass_validation boolean | Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит работу без проверки параметров. Варианты:
|
dynamic_mapping string / обязательный | Параметр (dynamic_mapping) в запрашиваемом URL. |
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
firewall_vip6_dynamicmapping_realservers dictionary | Набор параметров верхнего уровня. |
|
client_ip псевдонимы: client-ip string |
Подключаться к этому реальному серверу могут только клиенты из указанного диапазона IP-адресов. |
|
healthcheck string |
Включите проверку отклика реального сервера перед перенаправлением трафика. Варианты:
|
|
holddown_interval псевдонимы: holddown-interval integer |
Время в секундах, в течение которого монитор проверки работоспособности продолжает отслеживать неотвечающий сервер, который должен быть активен. |
|
http_host псевдонимы: http-host string |
Доменное имя HTTP-сервера в заголовке HTTP. |
|
id integer / обязательный |
Идентификатор реального сервера. |
|
ip string |
IP-адрес реального сервера. |
|
max_connections псевдонимы: max-connections integer |
Максимальное количество активных подключений, которые можно направить на реальный сервер. |
|
monitor any |
(список или строка) Имя монитора проверки работоспособности, используемого при опросе для определения состояния подключения виртуального сервера. |
|
port integer |
Порт для связи с реальным сервером. |
|
status string |
Задайте для реального сервера активное состояние, чтобы он мог принимать трафик, либо переведите его в режим ожидания или отключите, чтобы трафик не отправлялся на него. Варианты:
|
|
translate_host псевдонимы: translate-host string |
Включить или отключить преобразование имени хоста/IP-адреса виртуального сервера в имя хоста/IP-адрес реального сервера. Варианты:
|
|
weight integer |
Вес реального сервера. |
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method string | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed list / элементы=integer | Список кодов rc, переопределяющий условия, при которых запрос считается неудачным. |
rc_succeeded list / элементы=integer | Список кодов rc, переопределяющий условия, при которых запрос считается успешным. |
revision_note string | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
state string / обязательный | Указание создать, обновить или удалить объект. Варианты:
|
vip6 string / обязательный | Параметр (vip6) в запрашиваемом URL. |
workspace_locking_adom string | ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другое значение, включая root. |
workspace_locking_timeout integer | Максимальное время в секундах ожидания, пока другой пользователь снимет блокировку рабочей области. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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 (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
tasks:
- name: Select the real servers that this server load balancing VIP will distribute traffic to.
fortinet.fortimanager.fmgr_firewall_vip6_dynamicmapping_realservers:
# workspace_locking_adom: <global or your adom name>
adom: <your own value>
vip6: <your own value>
dynamic_mapping: <your own value>
state: present # <value in [present, absent]>
firewall_vip6_dynamicmapping_realservers:
id: 0 # Required variable, integer
# client_ip: <string>
# healthcheck: <value in [disable, enable, vip]>
# holddown_interval: <integer>
# http_host: <string>
# ip: <string>
# max_connections: <integer>
# monitor: <list or string>
# port: <integer>
# status: <value in [active, standby, disable]>
# weight: <integer>
# translate_host: <value in [disable, enable]>
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code integer |
Состояние запроса API. Возвращается: всегда Пример: |
|
response_data list / элементы=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Информация о целевой системе. Возвращается: всегда |
rc integer | Состояние запроса. Возвращается: всегда Пример: |
version_check_warning list / элементы=string | Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: при наличии условий |
Ссылки на коллекцию
© 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_vip6_dynamicmapping_realservers_module.html