azure_rm_loadbalancer – Управление балансировщиками нагрузки Azure
Новая версия 2.4.
Описание
- Создание, обновление и удаление балансировщиков нагрузки Azure
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| ad_user строка | Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с сервисным принципалом. | ||
| adfs_authority_url строка добавлен в 2.6 | URL-адрес авторизации Azure AD. Используется при аутентификации с именем пользователя/паролем и собственной службой ADFS. | ||
| api_profile строка добавлен в 2.5 | По умолчанию: "latest" | Выбирает профиль API для взаимодействия с Azure-службами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. | |
| append_tags логическое значение |
| Используется для управления тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. Когда каноническое, любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. | |
| auth_source строка добавлен в 2.5 |
| Управляет источником учетных данных для аутентификации. Если не указано, будет использована переменная среды 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. | |
| backend_address_pools - добавлен в 2.5 | Список пулов обратных адресов. | ||
| name - / обязательно | Имя пула обратных адресов. | ||
| backend_port - | (устарело) Порт обратного конца, который будет открыт для балансировщика нагрузки. Этот параметр устарел и будет удален в версии 2.9. Используйте load_balancing_rules вместо этого. | ||
| cert_validation_mode строка добавлен в 2.5 |
| Управляет поведением проверки сертификатов для 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 - добавлен в 2.5 | Список передних IP-адресов для использования. | ||
| name - / обязательно | Имя конфигурации переднего IP-адреса. | ||
| private_ip_address - добавлен в 2.6 | Ссылка на ресурс общедоступного IP. | ||
| private_ip_allocation_method - добавлен в 2.6 |
| Метод выделения частного IP-адреса. | |
| public_ip_address - | Имя существующего объекта общедоступного IP-адреса в текущей группе ресурсов для сопоставления с группой безопасности. | ||
| subnet - добавлен в 2.6 | Ссылка на ресурс подсети. Должен быть существующим идентификатором ресурса подсети. | ||
| frontend_port - | (устарело) Передний порт, который будет открыт для балансировщика нагрузки. Этот параметр устарел и будет удален в версии 2.9. Используйте load_balancing_rules вместо этого. | ||
| idle_timeout - | По умолчанию: 4 | (устарело) Таймаут для неактивного TCP-соединения в минутах. Этот параметр устарел и будет удален в версии 2.9. Используйте load_balancing_rules вместо этого. | |
| inbound_nat_pools - добавлен в 2.5 | Определяет диапазон внешних портов для входящего NAT на один порт обратного конца на сетевых адаптерах, связанных с балансировщиком нагрузки. Правила входящего NAT создаются автоматически для каждого сетевого адаптера, связанного с балансировщиком нагрузки, используя внешний порт из этого диапазона. Определение пула входящего NAT на вашем балансировщике нагрузки исключает определение правил входящего NAT. Пулы входящего NAT ссылаются на масштабируемые наборы виртуальных машин. Сетевые адаптеры, которые связаны с отдельными виртуальными машинами, не могут ссылаться на пул входящего NAT. Они должны ссылаться на отдельные правила входящего NAT. | ||
| backend_port - | Порт, используемый для внутренних соединений на точке конечного доступа. Допустимые значения находятся в диапазоне от 1 до 65535. | ||
| frontend_ip_configuration_name - / обязательно | Ссылка на адреса переднего плана. | ||
| frontend_port_range_end - / обязательно | Последний порт в диапазоне внешних портов, который будет использоваться для предоставления входящего NAT сетевым адаптерам, связанным с балансировщиком нагрузки. Допустимые значения находятся в диапазоне от 1 до 65535. | ||
| frontend_port_range_start - / обязательно | Первый порт в диапазоне внешних портов, который будет использоваться для предоставления входящего NAT сетевым адаптерам, связанным с балансировщиком нагрузки. Допустимые значения находятся в диапазоне от 1 до 65534. | ||
| name - / обязательно | Имя пула входящего NAT. | ||
| protocol - |
| IP-протокол для пула NAT. | |
| inbound_nat_rules - добавлено в 2.8 | Коллекция правил входящего NAT, используемых балансировщиком нагрузки. Определение правил входящего NAT на балансировщике нагрузки взаимоисключает определение пула входящего NAT. Пулы входящего NAT ссылаются из наборов виртуальных машин. NIC, связанные с отдельными виртуальными машинами, не могут ссылаться на пул входящего NAT. Они должны ссылаться на отдельные правила входящего NAT. | ||
| backend_port - | Порт, используемый для внутренних подключений к конечной точке. Допустимые значения находятся в диапазоне от 0 до 65535. Обратите внимание, что значение 0 включает «любой порт» | ||
| enable_floating_ip - | Настраивает конечную точку виртуальной машины для поддержки плавающего IP-адреса, необходимой для настройки группы доступности SQL AlwaysOn. Это значение необходимо при использовании групп доступности SQL AlwaysOn в SQL Server. Это значение нельзя изменить после создания конечной точки. | ||
| enable_tcp_reset - | Принимайте двунаправленный TCP Reset при таймауте простоя TCP-потока или при неожиданном разрыве подключения. Этот элемент используется только когда protocol установлено в значение Tcp. | ||
| frontend_ip_configuration - / обязательно | Ссылка на адреса IP-адресов фронтальной части. | ||
| frontend_port - | Порт для внешней конечной точки. Номера портов фронтальной части должны быть уникальными для всех правил внутри балансировщика нагрузки. Допустимые значения находятся в диапазоне от 0 до 65534. Обратите внимание, что значение 0 включает «любой порт» | ||
| idle_timeout - | Таймаут для TCP-соединения без активности. Значение может быть установлено в диапазоне от 4 до 30 минут. Значение по умолчанию - 4 минуты. Этот элемент используется только при установке протокола TCP. | ||
| name - / обязательно | Имя правила входящего NAT. | ||
| protocol - |
| IP-протокол для правила входящего NAT. | |
| load_balancing_rules - добавлено в 2.5 | Коллекция объектов, представляющих правила балансировки нагрузки. Получает информацию о подготовке. | ||
| backend_address_pool - / обязательно | Ссылка на пул адресов DIP. Входящий трафик случайным образом распределяется по IP-адресам в пуле адресов бэкенда. | ||
| backend_port - | Порт, используемый для внутренних подключений к конечной точке. Допустимые значения находятся в диапазоне от 0 до 65535. Обратите внимание, что значение 0 включает «любой порт» | ||
| enable_floating_ip - | Настраивает SNAT для ВМ в пуле бэкенда, чтобы использовать адрес publicIP, указанный в фронтальной части правила балансировки нагрузки. | ||
| frontend_ip_configuration - / обязательно | Ссылка на адреса IP-адресов фронтальной части. | ||
| frontend_port - | Порт для внешней конечной точки. Номера портов фронтальной части должны быть уникальными для всех правил внутри балансировщика нагрузки. Допустимые значения находятся в диапазоне от 0 до 65534. Обратите внимание, что значение 0 включает «любой порт» | ||
| idle_timeout - | Таймаут для TCP-соединения без активности. Значение может быть установлено в диапазоне от 4 до 30 минут. Значение по умолчанию - 4 минуты. Этот элемент используется только при установке протокола TCP. | ||
| load_distribution - |
| Политика сохранения сеанса для данного правила; Default означает отсутствие сохранения. | |
| name - / обязательно | Имя правила балансировки нагрузки. | ||
| probe - / обязательно | Имя зонда балансировщика нагрузки, которое должно использоваться этим правилом для проверок состояния. | ||
| protocol - |
| IP-протокол для правила балансировки нагрузки. | |
| load_distribution - |
| (устаревшее) Тип распределения нагрузки, который будет использовать балансировщик нагрузки. Этот параметр устарел и будет удален в версии 2.9. Вместо этого используйте load_balancing_rules. | |
| location - | Действительное расположение Azure. По умолчанию используется расположение группы ресурсов. | ||
| name - / обязательно | Имя балансировщика нагрузки. | ||
| natpool_backend_port - | (устаревшее) Порт бэкенда, используемый пулом NAT. Этот параметр устарел и будет удален в версии 2.9. Вместо этого используйте inbound_nat_pools. | ||
| natpool_frontend_port_end - | (устаревшее) Конечный диапазон портов для пула NAT. Этот параметр устарел и будет удален в версии 2.9. Вместо этого используйте inbound_nat_pools. | ||
| natpool_frontend_port_start - | (устаревшее) Начальный диапазон портов для пула NAT. Этот параметр устарел и будет удален в версии 2.9. Вместо этого используйте inbound_nat_pools. | ||
| natpool_protocol - | (устаревшее) Протокол для пула NAT. Этот параметр устарел и будет удален в версии 2.9. Вместо этого используйте inbound_nat_pools. | ||
| password - | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципом службы. | ||
| probe_fail_count - | По умолчанию: 3 | (устаревшее) Количество неудачных проверок для определения состояния балансировщика нагрузки. Этот параметр устарел и будет удален в версии 2.9. Вместо этого используйте probes. | |
| probe_interval - | По умолчанию: 15 | (устаревшее) Время (в секундах) между проверками состояния конечных точек. Этот параметр устарел и будет удален в версии 2.9. Вместо этого используйте probes. | |
| probe_port - | (устаревшее) Порт, который будет использовать проверка состояния. Этот параметр устарел и будет удален в версии 2.9. Вместо этого используйте probes. | ||
| probe_protocol - |
| (устаревшее) Протокол, который нужно использовать для проверки состояния. Этот параметр устарел и будет удален в версии 2.9. Вместо этого используйте probes. | |
| probe_request_path - | (устаревшее) URL, который будет использовать HTTP-проверка состояния (актуально только если probe_protocol установлен в Http). Этот параметр устарел и будет удален в версии 2.9. Вместо этого используйте probes. | ||
| пробы - добавлен в 2.5 | Список определений проб, используемых для проверки работоспособности конечной точки. | ||
| fail_count - | По умолчанию: 3 | Количество проб, при отсутствии ответа на которые дальнейшая передача трафика конечной точке прекращается. Это значение позволяет выводить конечные точки из ротации быстрее или медленнее, чем типичные временные интервалы, используемые в Azure. псевдонимы: number_of_probes | |
| interval - | По умолчанию: 15 | Интервал, в секундах, с которым проверяется состояние конечной точки на работоспособность. Несколько меньше половины назначенного времени ожидания, что позволяет выполнить две полные проверки перед выводом экземпляра из ротации. Значение по умолчанию равно 15, минимальное значение — 5. | |
| name - / обязательно | Имя пробы. | ||
| port - / обязательно | Порт пробы для связи. Возможные значения — от 1 до 65535 включительно. | ||
| protocol - |
| Протокол конечной точки, подлежащей проверке. Если указано 'Tcp', для успешной проверки требуется получение подтверждения (ACK). Если указано 'Http', для успешной проверки требуется ответ 200 OK от указанного URL. | |
| request_path - | URI, используемый для запроса состояния работоспособности виртуальной машины. Путь требуется, если протокол установлен на http. В противном случае он не допускается. | ||
| profile строка | Профиль безопасности, найденный в файле ~/.azure/credentials. | ||
| protocol - |
| (устаревшее) Протокол (TCP или UDP), который будет использоваться балансировщиком нагрузки. Этот параметр устарел и будет удалён в версии 2.9. Используйте load_balancing_rules вместо него. | |
| public_ip_address_name - | (устаревшее) Имя существующего объекта общедоступного IP-адреса, который нужно связать с группой безопасности. Этот параметр устарел и будет удалён в версии 2.9. Используйте frontend_ip_configurations вместо него. псевдонимы: public_ip_address, public_ip_name, public_ip | ||
| resource_group - / обязательно | Имя группы ресурсов, в которой существует или будет создан балансировщик нагрузки. | ||
| secret строка | Секретный ключ Azure. Используется при аутентификации с помощью принципала службы. | ||
| sku - добавлен в 2.6 |
| SKU балансировщика нагрузки. | |
| state - |
| Утверждение состояния балансировщика нагрузки. Используйте present для создания/обновления балансировщика нагрузки или absent для удаления. | |
| subscription_id строка | Ваш идентификатор подписки Azure. | ||
| tags словарь | Словарь пар «строка:строка» для назначения метаданных объекту. Метаданные метки объекта будут обновлены всеми предоставленными значениями. Для удаления меток установите параметр append_tags в значение false. | ||
| tenant строка | Идентификатор Azure-аренды. Используется при аутентификации с помощью принципала службы. | ||
Примечания
Примечание
- Для аутентификации с Azure можно передавать параметры, устанавливать переменные среды, использовать профиль, сохранённый в файле ~/.azure/credentials, или выполнить вход перед запуском задач или игрового набора с помощью
az login. - Аутентификация также возможна с использованием принципала службы или пользователя 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 в среде.
См. также
См. также
- Вход в Azure CLI
- Как выполнить аутентификацию с помощью команды
az login.
Примеры
- name: create load balancer
azure_rm_loadbalancer:
resource_group: myResourceGroup
name: testloadbalancer1
frontend_ip_configurations:
- name: frontendipconf0
public_ip_address: testpip
backend_address_pools:
- name: backendaddrpool0
probes:
- name: prob0
port: 80
inbound_nat_pools:
- name: inboundnatpool0
frontend_ip_configuration_name: frontendipconf0
protocol: Tcp
frontend_port_range_start: 80
frontend_port_range_end: 81
backend_port: 8080
load_balancing_rules:
- name: lbrbalancingrule0
frontend_ip_configuration: frontendipconf0
backend_address_pool: backendaddrpool0
frontend_port: 80
backend_port: 80
probe: prob0
inbound_nat_rules:
- name: inboundnatrule0
backend_port: 8080
protocol: Tcp
frontend_port: 8080
frontend_ip_configuration: frontendipconf0
Значения возврата
Общие значения возврата описаны здесь, следующие — поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| changed булево | всегда | Изменился ли ресурс |
| state словарь | всегда | Текущее состояние балансировщика нагрузки |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Thomas Stringer (@trstringer)
- Yuwei Zhou (@yuwzho)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/azure_rm_loadbalancer_module.html
