Модуль fortinet.fortimanager.fmgr_firewall_vip_dynamicmapping_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_dynamicmapping_realservers.

Впервые в fortinet.fortimanager 2.0.0

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Этот модуль позволяет настраивать устройство FortiManager.
Примеры включают все параметры и значения, которые необходимо скорректировать из источников данных перед использованием.

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation булево	Устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
dynamic_mapping строка / обязательно	Параметр (dynamic_mapping) в запрошенном URL.
enable_log булево	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
firewall_vip_dynamicmapping_realservers словарь	Набор параметров верхнего уровня.
address строка	Адрес.
client_ip любой тип	(список) Устарело, переименуйте на client_ip. Клиентский IP.
health_check_proto строка	Устарело, переименуйте на health_check_proto. Протокол проверки работоспособности. Варианты: `"ping"` `"http"`
healthcheck строка	Проверка работоспособности. Варианты: `"disable"` `"enable"` `"vip"`
holddown_interval целое число	Устарело, переименуйте на holddown_interval. Интервал удержания.
http_host строка	Устарело, переименуйте на http_host. Хост HTTP.
id целое число	Идентификатор.
ip строка	IP-адрес.
max_connections целое число	Устарело, переименуйте на max_connections. Максимальное количество подключений.
monitor любой тип	(список или строка) Монитор.
port целое число	Порт.
seq целое число / обязательно	Seq.
status строка	Статус. Варианты: `"active"` `"standby"` `"disable"`
translate_host строка	Устарело, переименуйте на translate_host. Включить/выключить перевод имени хоста/IP-адреса с виртуального сервера на реальный сервер. Варианты: `"disable"` `"enable"`
type строка	Тип. Варианты: `"ip"` `"address"`

END_OF_DOCUMENT_MARKER

вес целое число	Вес.
forticloud_access_token строка	Авторизация клиента Ansible с помощью маркера доступа к API forticloud.
proposed_method строка	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, при которых условия будут переопределены на отказ.
rc_succeeded список / элементы=целое число	Список кодов rc, при которых условия будут переопределены на успех.
состояние строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
vip строка / обязательно	Параметр (vip) в запрошенном URL.
workspace_locking_adom строка	Область для блокировки в режиме работы FortiManager в рабочем пространстве. Значение может быть глобальным и другими, включая корневой.
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 (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: Select the real servers that this server load balancing VIP will distribute traffic to.
      fortinet.fortimanager.fmgr_firewall_vip_dynamicmapping_realservers:
        # 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>
        vip: <your own value>
        dynamic_mapping: <your own value>
        state: present # <value in [present, absent]>
        firewall_vip_dynamicmapping_realservers:
          client_ip: <list or string>
          healthcheck: <value in [disable, enable, vip]>
          holddown_interval: <integer>
          http_host: <string>
          ip: <string>
          max_connections: <integer>
          monitor: <list or string>
          port: <integer>
          seq: <integer>
          status: <value in [active, standby, disable]>
          weight: <integer>
          address: <string>
          id: <integer>
          type: <value in [ip, address]>
          translate_host: <value in [disable, enable]>
          health_check_proto: <value in [ping, http]>

Значения возврата

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

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