Spec-Zone.ru › Ansible

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

Примечание

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

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

Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Для использования в playbook укажите: fortinet.fortimanager.fmgr_firewall_vip6_dynamicmapping_realservers.

Новое в fortinet.fortimanager 2.1.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_vip6_dynamicmapping_realservers

словарь

Настройка параметров верхнего уровня.

client_ip

строка

Устарело, пожалуйста, переименуйте на client_ip. Только клиенты в этом диапазоне IP могут подключиться к этому реальному серверу.

healthcheck

строка

Включить проверку отзывчивости реального сервера перед пересылкой трафика.

Выбор:

  • "disable"
  • "enable"
  • "vip"

holddown_interval

целое число

Устарело, пожалуйста, переименуйте на holddown_interval. Время в секундах, которое монитор проверки работоспособности продолжает отслеживать...

http_host

строка

Устарело, пожалуйста, переименуйте на http_host. Имя домена HTTP-сервера в HTTP-заголовке.

id

целое число / обязательно

ID реального сервера.

ip

строка

IP-адрес реального сервера.

max_connections

целое число

Устарело, пожалуйста, переименуйте на max_connections. Максимальное количество активных подключений, которые могут быть направлены на реальный сервер.

monitor

любой тип

(список или строка) Название монитора проверки работоспособности, используемого при опросе для определения состояния подключения виртуального сервера.

port

целое число

Порт для связи с реальным сервером.

status

строка

Установите статус реального сервера на активный, чтобы он мог принимать трафик, или на ожидание или отключен, чтобы трафик не отправлялся.

Выбор:

  • "active"
  • "standby"
  • "disable"

translate_host

строка

Устарело, пожалуйста, переименуйте на translate_host. Включить/выключить перевод имени хоста/IP с виртуального сервера на реальный сервер.

Выбор:

  • "disable"
  • "enable"

weight

целое число

Вес реального сервера.

forticloud_access_token

строка

Авторизовать Ansible-клиента с помощью токена доступа к forticloud API.

proposed_method

строка

Переопределённый метод для базового запроса Json RPC.

Выбор:

  • "update"
  • "set"
  • "add"
END_OF_DOCUMENT_MARKER

rc_failed

список / элементы=целое число

Список кодов rc, при которых условия будут игнорироваться.

rc_succeeded

список / элементы=целое число

Список кодов rc, при которых условия будут игнорироваться.

state

строка / обязательно

Направление для создания, обновления или удаления объекта.

Варианты:

  • "present"
  • "absent"

vip6

строка / обязательно

Параметр (vip6) в запрошенном URL.

workspace_locking_adom

строка

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_vip6_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>
        vip6: <your own value>
        dynamic_mapping: <your own value>
        state: present # <value in [present, absent]>
        firewall_vip6_dynamicmapping_realservers:
          client_ip: <string>
          healthcheck: <value in [disable, enable, vip]>
          holddown_interval: <integer>
          http_host: <string>
          id: <integer>
          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

словарь

Результат запроса.

Возвращается: всегда

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_vip6_dynamicmapping_realservers_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API