Spec-Zone.ru › Ansible

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

Новая функция в fortinet.fortimanager 2.0.0

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

Описание

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

Параметры

Параметр

Комментарии

access_token

строка

Токен для доступа к FortiManager без использования имени пользователя и пароля.

adom

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

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

bypass_validation

булево

Устанавливается в значение True только при различиях между схемой модуля и структурой API FortiManager, модуль продолжает выполнение без проверки параметров.

Варианты:

  • false ← (по умолчанию)
  • true

enable_log

булево

Включить/выключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

firewall_vip6_realservers

словарь

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

client_ip

строка

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

healthcheck

строка

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

Варианты:

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

holddown_interval

целое число

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

http_host

строка

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

id

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

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

ip

строка

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

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"

rc_failed

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

Список кодов rc, с которыми будут переопределены условия завершения неудачей.

rc_succeeded

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

Список кодов rc, с которыми будут переопределены условия успешного завершения.

END_OF_DOCUMENT_MARKER

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
  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_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

словарь

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

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

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

Spec-Zone.ru

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