Модуль fortinet.fortimanager.fmgr_firewall_vip_realservers — выбор реальных серверов, на которые этот VIP балансировки нагрузки сервера будет распределять трафик.

Примечание

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

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

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

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

Добавлено в 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`
firewall_vip_realservers dictionary	Набор параметров верхнего уровня.
address string	Динамический адрес реального сервера.
client_ip псевдонимы: client-ip any	(список) К этому реальному серверу могут подключаться только клиенты из этого диапазона IP-адресов.
health_check_proto псевдонимы: health-check-proto string	Протокол проверки работоспособности. Варианты: `"ping"` `"http"`
healthcheck string	Включите проверку доступности реального сервера перед перенаправлением трафика. Варианты: `"disable"` `"enable"` `"vip"`
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	Порт для связи с реальным сервером.
seq integer / обязательный	Порядковый номер.
status string	Установите для реального сервера статус «активен», чтобы он мог принимать трафик, либо статус ожидания или «отключен», чтобы трафик на него не отправлялся. Варианты: `"active"` `"standby"` `"disable"`
translate_host псевдонимы: translate-host string	Включить или отключить преобразование имени хоста/IP-адреса виртуального сервера в имя хоста/IP-адрес реального сервера. Варианты: `"disable"` `"enable"`
type string	Тип адреса. Варианты: `"ip"` `"address"`
verify_cert псевдонимы: verify-cert string	Включить или отключить проверку сертификата реального сервера. Варианты: `"disable"` `"enable"`
weight integer	Вес реального сервера.
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"`
vip string / обязательный	Параметр (vip) в запрашиваемом URL.
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: Select the real servers that this server load balancing VIP will distribute traffic to.
      fortinet.fortimanager.fmgr_firewall_vip_realservers:
        bypass_validation: false
        adom: ansible
        vip: "ansible-test-vip" # name
        state: present
        firewall_vip_realservers: # available only when type is set to 'server-load-balance' in vip
          healthcheck: enable # <value in [disable, enable, vip]>
          ip: "222.222.222.1"
          port: 1
          seq: 1
          status: active # <value in [active, standby, disable]>

- 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 real servers of IPv4 virtual ip
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_vip_realservers" # available only when type is set to 'server-load-balance' in vip
          params:
            adom: "ansible"
            vip: "ansible-test-vip" # name
            realservers: "your_value"

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

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

Ключ	Описание
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_firewall_vip_realservers_module.html