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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 / required	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager; модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (default) `true`
enable_log boolean	Включить/отключить ведение журнала для задачи. Варианты: `false` ← (default) `true`
firewall_vip_realservers dictionary	Набор параметров верхнего уровня.
address string	Динамический адрес реального сервера.
client-ip any	(list) Устарело, переименуйте в client_ip. Только клиенты в этом диапазоне IP могут подключаться к этому реальному серверу.
healthcheck string	Включить проверку готовности реального сервера перед переадресацией трафика. Варианты: `"disable"` `"enable"` `"vip"`
holddown-interval integer	Устарело, переименуйте в holddown_interval. Время в секундах, в течение которого монитор проверки работоспособности продолжает мониторинг и …
http-host string	Устарело, переименуйте в http_host. Доменное имя HTTP-сервера в заголовке HTTP.
id integer	Идентификатор реального сервера.
ip string	IP-адрес реального сервера.
max-connections integer	Устарело, переименуйте в max_connections. Максимальное число активных соединений, которые могут быть направлены на реальный сервер.
monitor any	(list or str) Имя монитора проверки работоспособности, используемого при опросе для определения состояния подключения виртуального сервера.
port integer	Порт для связи с реальным сервером.
seq integer / required	Seq.
status string	Установите статус реального сервера как активный, чтобы он мог принимать трафик, или как ожидающий или отключенный, чтобы трафик не отправлялся. Варианты: `"active"` `"standby"` `"disable"`
translate-host string	Устарело, переименуйте в translate_host. Включить/отключить преобразование имени хоста/IP с виртуального сервера на реальный сервер. Варианты: `"disable"` `"enable"`
type string	Тип адреса. Варианты: `"ip"` `"address"`
weight integer	Вес реального сервера.
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.

proposed_method строка	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия для возврата ошибки.
rc_succeeded список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия для успешного выполнения.
state строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
vip строка / обязательно	Параметр (vip) в запрошенном URL.
workspace_locking_adom строка	ADOM для блокировки FortiManager в режиме рабочей области. Значение может быть глобальным и другими, включая root.
workspace_locking_timeout целое число	Максимальное время ожидания в секундах, пока другой пользователь не разблокирует рабочую область. По умолчанию: `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: 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 словарь	Результат запроса. Возвращается: всегда
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_firewall_vip_realservers_module.html