Spec-Zone.ru › Ansible 2.7

bigip_profile_http – Управление профилями HTTP на BIG-IP

Новое в версии 2.7.

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата
  • Статус

Обзор

  • Управление профилями HTTP на BIG-IP.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

  • f5-sdk >= 3.0.16

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
description
-
Описание профиля.
dns_resolver
-
Указывает имя настроенного DNS-резолвера. Этот параметр обязателен, когда proxy_type установлено в explicit.
Формат имени может быть либо с префиксом раздела (/Common/foo), либо просто как имя объекта (foo).
Для удаления записи можно установить значение none или '', однако профиль proxy_type не должен быть установлен как explicit.
encrypt_cookie_secret
-
Пароль для шифрования cookie.
При создании нового профиля, если этот параметр не указан, используется значение родительского профиля по умолчанию.
encrypt_cookies
список
Имена cookie, которые система должна зашифровать.
Для полного удаления записи следует установить значение none или ''.
При создании нового профиля, если этот параметр не указан, используется значение родительского профиля по умолчанию.
insert_xforwarded_for
boolean
    Варианты:
  • no
  • yes
При указании система вставляет заголовок X-Forwarded-For в HTTP-запрос с адресом IP клиента, для использования с пулингом подключений.
При создании нового профиля, если этот параметр не указан, используется значение родительского профиля по умолчанию.
name
- / обязательно
Указывает имя профиля.
parent
-
По умолчанию:
"/Common/http"
Указывает профиль, из которого этот профиль наследует настройки.
При создании нового профиля, если этот параметр не указан, используется профиль по умолчанию, предоставляемый системой http.
partition
-
По умолчанию:
"Common"
Раздел устройства для управления ресурсами.
password
- / обязательно
Пароль для учетной записи пользователя, используемой для подключения к BIG-IP.
Вы можете опустить этот параметр, установив переменную окружения F5_PASSWORD.

псевдонимы: pass, pwd
provider
-
добавлено в 2.5
По умолчанию:
null
Объект типа dict, содержащий данные подключения.
password
- / обязательно
Пароль для учетной записи пользователя, используемой для подключения к BIG-IP.
Вы можете опустить этот параметр, установив переменную окружения F5_PASSWORD.

псевдонимы: pass, pwd
server
- / обязательно
Хост BIG-IP.
Вы можете опустить этот параметр, установив переменную окружения F5_SERVER.
server_port
-
По умолчанию:
443
Порт сервера BIG-IP.
Вы можете опустить этот параметр, установив переменную окружения F5_SERVER_PORT.
ssh_keyfile
-
Указывает SSH-ключевой файл для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli.
Вы можете опустить этот параметр, установив переменную окружения ANSIBLE_NET_SSH_KEYFILE.
timeout
-
По умолчанию:
10
Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истекает до завершения операции, модуль выдаст ошибку.
transport
- / обязательно
    Варианты:
  • rest
  • cli ←
Настраивает транспортное подключение для подключения к удаленному устройству.
user
- / обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве.
Вы можете опустить этот параметр, установив переменную окружения F5_USER.
validate_certs
boolean
    Варианты:
  • no
  • yes ←
Если no, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых лично, с самоподписанными сертификатами.
Вы можете опустить этот параметр, установив переменную окружения F5_VALIDATE_CERTS.
proxy_type
-
    Варианты:
  • reverse
  • transparent
  • explicit
Указывает режим прокси для профиля.
При создании нового профиля, если этот параметр не указан, используется значение родительского профиля по умолчанию.
redirect_rewrite
-
    Варианты:
  • none
  • all
  • matching
  • nodes
Указывает, переписывает ли система URI, которые являются частью ответов HTTP с перенаправлением (3XX).
При установке в none система не будет переписывать URI в ответах HTTP с перенаправлением.
При установке в all система переписывает URI во всех ответах HTTP с перенаправлением.
При установке в matching система переписывает URI в ответах HTTP с перенаправлением, которые соответствуют запросу URI.
При установке в nodes если URI содержит IP-адрес узла вместо имени хоста, система меняет его на адрес виртуального сервера.
При создании нового профиля, если этот параметр не указан, используется значение родительского профиля по умолчанию.
server
- / обязательно
Хост BIG-IP.
Вы можете опустить этот параметр, установив переменную окружения F5_SERVER.
server_port
-
добавлено в 2.2
По умолчанию:
443
Порт сервера BIG-IP.
Вы можете опустить этот параметр, установив переменную окружения F5_SERVER_PORT.
state
-
    Варианты:
  • present ←
  • absent
При установке в present, гарантирует, что профиль существует.
При установке в absent, гарантирует удаление профиля.
update_password
-
    Варианты:
  • always ←
  • on_create
always будет обновлять пароли, если encrypt_cookie_secret указан.
on_create будет устанавливать пароль только для вновь созданных профилей.
user
- / обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве.
Вы можете опустить этот параметр, установив переменную окружения F5_USER.
validate_certs
boolean
добавлено в 2.0
    Варианты:
  • no
  • yes ←
Если no, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых лично, с самоподписанными сертификатами.
Вы можете опустить этот параметр, установив переменную окружения F5_VALIDATE_CERTS.

Примечания

Примечание

  • Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
  • Требуется пакет f5-sdk Python на хосте. Это так же просто, как pip install f5-sdk.
  • Требуется версия ПО BIG-IP >= 12.
  • Модули F5 изменяют только рабочую конфигурацию продукта F5. Чтобы убедиться, что конфигурация, специфичная для BIG-IP, сохраняется на диске, необходимо включить хотя бы одну задачу, использующую модуль bigip_config для сохранения рабочей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения вашей рабочей конфигурации.

Примеры

- name: Create HTTP profile
  bigip_profile_http:
    name: my_profile
    password: secret
    server: lb.mydomain.com
    insert_xforwarded_for: yes
    redirect_rewrite: all
    state: present
    user: admin
  delegate_to: localhost

- name: Remove HTTP profile
  bigip_profile_http:
    name: my_profile
    state: absent
    server: lb.mydomain.com
    user: admin
    password: secret
  delegate_to: localhost

- name: Add HTTP profile for transparent proxy
  bigip_profile_http:
    name: my_profile
    server: lb.mydomain.com
    user: admin
    proxy_type: transparent
    password: secret
  delegate_to: localhost

Возвращаемые значения

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

Ключ Возвращаемое Описание
description
строка
changed
Описание профиля.

Пример:
Мой профиль
dns_resolver
строка
changed
Настроенный DNS-резолвер.

Пример:
/Common/FooBar
encrypt_cookies
список
changed
Имена куки для шифрования.

Пример:
['MyCookie1', 'MyCookie2']
insert_xforwarded_for
булево
changed
Вставить заголовок X-Forwarded-For.

Пример:
True
proxy_type
строка
changed
Укажите режим прокси профиля.

Пример:
explicit
redirect_rewrite
строка
changed
Переписать URI, которые являются частью ответов 3xx.

Пример:
all


Статус

  • Гарантия обратной совместимости для этого модуля не предоставляется. [превью]
  • Этот модуль поддерживается партнёром Ansible. [сертифицировано]

Авторы

  • Wojciech Wypior (@wojtek0806)

Подсказка

Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/bigip_profile_http_module.html

Spec-Zone.ru

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