Spec-Zone.ru › Ansible 2.7

azure_rm_appgateway – Управление экземпляром Application Gateway.

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

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

Обзор

  • Создание, обновление и удаление экземпляра Application Gateway.

Требования

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

  • python >= 2.7
  • azure >= 2.0.0

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
ad_user
-
Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы.
adfs_authority_url
-
добавлен в 2.6
 Значение по умолчанию:
null
URL-адрес авторизации Azure AD. Используется при аутентификации с именем пользователя/паролем и собственной авторизацией ADFS.
api_profile
-
добавлен в 2.5
 Значение по умолчанию:
"latest"
Выбирает профиль API для использования при взаимодействии с Azure-службами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
append_tags
boolean
    Варианты:
  • no
  • да ←
Используется для управления тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноническом формате любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
auth_source
-
добавлен в 2.5
    Варианты:
  • auto
  • cli
  • credential_file
  • env
  • msi
Управляет источником учетных данных для аутентификации.
Если не указано, будет использована переменная среды ANSIBLE_AZURE_AUTH_SOURCE и по умолчанию auto если переменная не определена.
auto будет следовать стандартному приоритету параметров модуля -> переменные среды -> профиль по умолчанию в файле учетных данных ~/.azure/credentials.
При установке в cli, учетные данные будут взяты из профиля Azure CLI по умолчанию.
Также может быть задано через переменную среды ANSIBLE_AZURE_AUTH_SOURCE.
При установке в msi, хост-машина должна быть Azure-ресурсом с включенным расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID можно использовать для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам; в противном случае выбирается первая подписка.
msi был добавлен в Ansible 2.6.
authentication_certificates
-
Сертификаты аутентификации ресурса шлюза приложений.
data
-
Открытые данные сертификата - закодированный в base64 формат pfx.
name
-
Имя ресурса, уникальное в группе ресурсов. Это имя может быть использовано для доступа к ресурсу.
backend_address_pools
-
Список пулов адресов бэкенда ресурса шлюза приложений.
backend_addresses
-
Список адресов бэкенда.
fqdn
-
Полное доменное имя (FQDN).
ip_address
-
IP-адрес.
name
-
Ресурс, уникальный в пределах группы ресурсов. Это имя можно использовать для доступа к ресурсу.
backend_http_settings_collection
-
Настройки HTTP-бэкенда ресурса шлюза приложений.
affinity_cookie_name
-
Имя cookie, используемое для cookie-аффинити.
authentication_certificates
-
Список ссылок на сертификаты аутентификации шлюза приложений.
id
-
Идентификатор ресурса.
cookie_based_affinity
-
    Варианты:
  • enabled
  • disabled
Аффинити на основе cookie.
host_name
-
Заголовок хоста, который будет отправлен на серверы бэкенда.
name
-
Имя ресурса, уникальное в группе ресурсов. Это имя можно использовать для доступа к ресурсу.
path
-
Путь, который должен использоваться в качестве префикса для всех запросов http. Значение null означает, что префикс пути не будет добавлен. Значение по умолчанию - null.
pick_host_name_from_backend_address
-
Выбирать ли заголовок хоста из имени хоста сервера бэкенда. Значение по умолчанию - false.
port
-
Порт.
protocol
-
    Варианты:
  • http
  • https
Протокол.
request_timeout
-
Таймаут запроса в секундах. Шлюз приложений завершит запрос, если ответ не будет получен в течение RequestTimeout. Допустимые значения от 1 секунды до 86400 секунд.
cert_validation_mode
-
добавлен в 2.5
    Варианты:
  • validate
  • ignore
Управляет поведением проверки сертификатов для Azure-конечных точек. По умолчанию все модули проверяют сертификат сервера, но при использовании HTTPS-прокси или при работе с Azure Stack может потребоваться отключить это поведение, передав ignore. Также можно настроить через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION.
client_id
-
Идентификатор Azure клиента. Используется при аутентификации с принципалом службы.
cloud_environment
-
добавлен в 2.4
 Значение по умолчанию:
"AzureCloud"
Для облачных сред, отличных от общедоступного облака США, имя среды (как определено Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть настроен через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT.
frontend_ip_configurations
-
IP-адреса переднего плана ресурса шлюза приложений.
name
-
Имя ресурса, уникальное в группе ресурсов. Это имя можно использовать для доступа к ресурсу.
private_ip_address
-
Private IP-адрес конфигурации IP сети.
private_ip_allocation_method
-
    Варианты:
  • static
  • dynamic
Метод выделения частного IP-адреса.
public_ip_address
-
Ссылка на ресурс Public IP.
subnet
-
Ссылка на ресурс подсети.
frontend_ports
-
Список портов переднего плана ресурса шлюза приложений.
name
-
Имя ресурса, уникальное в группе ресурсов. Это имя можно использовать для доступа к ресурсу.
port
-
Порт переднего плана
gateway_ip_configurations
-
Список подсетей, используемых шлюзом приложений.
name
-
Имя ресурса, уникальное в группе ресурсов. Это имя можно использовать для доступа к ресурсу.
subnet
-
Ссылка на ресурс подсети. Подсеть, из которой шлюз приложений получает свой частный адрес.
http_listeners
-
Список прослушивателей HTTP ресурса шлюза приложений.
frontend_ip_configuration
-
Ресурс конфигурации IP-адреса переднего плана шлюза приложений.
frontend_port
-
Ресурс порта переднего плана шлюза приложений.
host_name
-
Имя хоста прослушивателя http.
name
-
Имя ресурса, уникальное в группе ресурсов. Это имя можно использовать для доступа к ресурсу.
protocol
-
    Варианты:
  • http
  • https
Протокол.
require_server_name_indication
-
Применимо только если протокол https. Включает SNI для многохостинга.
ssl_certificate
-
Ресурс сертификата SSL шлюза приложений.
location
-
Расположение ресурса. Если не указано, используется расположение из группы ресурсов по умолчанию.
name
- / обязательно
Имя шлюза приложений.
password
-
Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо сервисного принципала.
profile
-
Профиль безопасности, найденный в файле ~/.azure/credentials.
request_routing_rules
-
Список правил маршрутизации запросов ресурса шлюза приложений.
backend_address_pool
-
Ресурс пула адресов обратного плана шлюза приложений.
backend_http_settings
-
Ресурс порта переднего плана шлюза приложений.
http_listener
-
Ресурс прослушивателя HTTP шлюза приложений.
name
-
Имя ресурса, уникальное в группе ресурсов. Это имя можно использовать для доступа к ресурсу.
rule_type
-
    Варианты:
  • basic
  • path_based_routing
Тип правила.
resource_group
- / обязательно
Имя группы ресурсов.
secret
-
Секрет клиента Azure. Используется при аутентификации с помощью сервисного принципала.
sku
-
SKU ресурса шлюза приложений.
capacity
-
Емкость (количество экземпляров) шлюза приложений.
name
-
    Варианты:
  • standard_small
  • standard_medium
  • standard_large
  • waf_medium
  • waf_large
Имя SKU шлюза приложений.
tier
-
    Варианты:
  • standard
  • waf
Уровень шлюза приложений.
ssl_certificates
-
Сертификаты SSL ресурса шлюза приложений.
data
-
Сертификат pfx в кодировке base-64.
name
-
Имя ресурса, уникальное в группе ресурсов. Это имя можно использовать для доступа к ресурсу.
password
-
Пароль к файлу pfx, указанному в данных.
ssl_policy
-
Политика SSL ресурса шлюза приложений.
cipher_suites
-
    Варианты:
  • tls_ecdhe_rsa_with_aes_256_gcm_sha384
  • tls_ecdhe_rsa_with_aes_128_gcm_sha256
  • tls_ecdhe_rsa_with_aes_256_cbc_sha384
  • tls_ecdhe_rsa_with_aes_128_cbc_sha256
  • tls_ecdhe_rsa_with_aes_256_cbc_sha
  • tls_ecdhe_rsa_with_aes_128_cbc_sha
  • tls_dhe_rsa_with_aes_256_gcm_sha384
  • tls_dhe_rsa_with_aes_128_gcm_sha256
  • tls_dhe_rsa_with_aes_256_cbc_sha
  • tls_dhe_rsa_with_aes_128_cbc_sha
  • tls_rsa_with_aes_256_gcm_sha384
  • tls_rsa_with_aes_128_gcm_sha256
  • tls_rsa_with_aes_256_cbc_sha256
  • tls_rsa_with_aes_128_cbc_sha256
  • tls_rsa_with_aes_256_cbc_sha
  • tls_rsa_with_aes_128_cbc_sha
  • tls_ecdhe_ecdsa_with_aes_256_gcm_sha384
  • tls_ecdhe_ecdsa_with_aes_128_gcm_sha256
  • tls_ecdhe_ecdsa_with_aes_256_cbc_sha384
  • tls_ecdhe_ecdsa_with_aes_128_cbc_sha256
  • tls_ecdhe_ecdsa_with_aes_256_cbc_sha
  • tls_ecdhe_ecdsa_with_aes_128_cbc_sha
  • tls_dhe_dss_with_aes_256_cbc_sha256
  • tls_dhe_dss_with_aes_128_cbc_sha256
  • tls_dhe_dss_with_aes_256_cbc_sha
  • tls_dhe_dss_with_aes_128_cbc_sha
  • tls_rsa_with_3des_ede_cbc_sha
  • tls_dhe_dss_with_3des_ede_cbc_sha
Список наборов шифров SSL, которые необходимо включить в указанном порядке для шлюза приложений.
disabled_ssl_protocols
-
    Варианты:
  • tls_v1_0
  • tls_v1_1
  • tls_v1_2
Список протоколов SSL, которые необходимо отключить на шлюзе приложений.
min_protocol_version
-
    Варианты:
  • tls_v1_0
  • tls_v1_1
  • tls_v1_2
Минимальная версия протокола Ssl, которую необходимо поддерживать на шлюзе приложений.
policy_name
-
    Варианты:
  • ssl_policy20150501
  • ssl_policy20170401
  • ssl_policy20170401_s
Имя политики SSL predefined.
policy_type
-
    Выберите:
  • predefined
  • custom
Тип политики SSL.
state
-
    Выберите:
  • absent
  • present ←
Укажите состояние общедоступного IP-адреса. Используйте 'present' для создания или обновления, а 'absent' — для удаления.
subscription_id
-
Ваш идентификатор подписки Azure.
tags
-
Словарь пар «строка:строка» для назначения метаданных объекту. Метаданные метки объекта будут обновлены любыми предоставленными значениями. Для удаления меток установите параметр append_tags в значение false.
tenant
-
Идентификатор клиента Azure. Используйте при аутентификации с помощью службы-принципала.

Примечания

Примечание

  • Для аутентификации в Azure вы можете передать параметры, установить переменные среды или использовать профиль, сохранённый в ~/.azure/credentials. Аутентификация возможна с помощью службы-принципала или пользователя Active Directory. Для аутентификации через службу-принципал передайте subscription_id, client_id, secret и tenant или установите переменные среды AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET и AZURE_TENANT.
  • Для аутентификации через пользователя Active Directory передайте ad_user и password или установите AZURE_AD_USER и AZURE_PASSWORD в среде.
  • В качестве альтернативы данные учетных данных можно сохранить в ~/.azure/credentials. Это ini-файл, содержащий раздел [default] и следующие ключи: subscription_id, client_id, secret и tenant или subscription_id, ad_user и password. Также можно добавить дополнительные профили. Укажите профиль, передав profile или установив AZURE_PROFILE в среде.

Примеры

- name: Create instance of Application Gateway
  azure_rm_appgateway:
    resource_group: myresourcegroup
    name: myappgateway
    sku:
      name: standard_small
      tier: standard
      capacity: 2
    gateway_ip_configurations:
      - subnet:
          id: "{{ subnet_id }}"
        name: app_gateway_ip_config
    frontend_ip_configurations:
      - subnet:
          id: "{{ subnet_id }}"
        name: sample_gateway_frontend_ip_config
    frontend_ports:
      - port: 90
        name: ag_frontend_port
    backend_address_pools:
      - backend_addresses:
          - ip_address: 10.0.0.4
        name: test_backend_address_pool
    backend_http_settings_collection:
      - port: 80
        protocol: http
        cookie_based_affinity: enabled
        name: sample_appgateway_http_settings
    http_listeners:
      - frontend_ip_configuration: sample_gateway_frontend_ip_config
        frontend_port: ag_frontend_port
        name: sample_http_listener
    request_routing_rules:
      - rule_type: Basic
        backend_address_pool: test_backend_address_pool
        backend_http_settings: sample_appgateway_http_settings
        http_listener: sample_http_listener
        name: rule1

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

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

Ключ Возвращаемое значение Описание
id
строка
 всегда
Идентификатор ресурса.

Пример:
id


Статус

  • Этот модуль не гарантирует обратной совместимости интерфейса. [preview]
  • Этот модуль поддерживается сообществом Ansible. [community]

Авторы

  • Zim Kalinowski (@zikalino)

Подсказка

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

© 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/azure_rm_appgateway_module.html

Spec-Zone.ru

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