Модуль fortinet.fortimanager.fmgr_firewall_vip6_realservers – выбор реальных серверов, на которые эта виртуальная IP-адресация балансировки нагрузки будет распределять трафик.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_firewall_vip6_realservers.
Добавлено в fortinet.fortimanager 2.0.0
Краткое описание
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо изменить в соответствии с источниками данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom string / обязательный | Параметр (adom) в запрошенном URL. |
bypass_validation boolean | Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Допустимые значения:
|
enable_log boolean | Включить/отключить ведение журнала для задачи. Допустимые значения:
|
firewall_vip6_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 |
IPv6-адрес реального сервера. |
|
max_connections псевдонимы: max-connections integer |
Максимальное количество активных соединений, которые можно направить на реальный сервер. |
|
monitor any |
(список или строка) Имя монитора проверки работоспособности, используемого при опросе для определения состояния подключения виртуального сервера. |
|
port integer |
Порт для связи с реальным сервером. |
|
status string |
Установите для реального сервера состояние «активен», чтобы он мог принимать трафик, или «резервный» либо «отключён», чтобы трафик на него не направлялся. Допустимые значения:
|
|
translate_host псевдонимы: translate-host string |
Включить/отключить преобразование имени хоста/IP-адреса виртуального сервера в имя хоста/IP-адрес реального сервера. Допустимые значения:
|
|
verify_cert псевдонимы: verify-cert string |
Включить/отключить проверку сертификата реального сервера. Допустимые значения:
|
|
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 или другие ADOM, включая 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
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_vip6_realservers:
bypass_validation: false
adom: ansible
vip6: "ansible-test-vip6" # name
state: present
firewall_vip6_realservers:
healthcheck: disable # <value in [disable, enable, vip]>
id: 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 virtual IP for IPv6
fortinet.fortimanager.fmgr_fact:
facts:
selector: "firewall_vip6_realservers"
params:
adom: "ansible"
vip6: "ansible-test-vip6" # name
realservers: "your_value"
Возвращаемые значения
Общие возвращаемые значения описаны здесь. Ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
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_realservers_module.html
