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 логическое |
| Используется для управления тем, является ли поле тегов стандартным или оно просто добавляет теги к существующим. В случае каноничности любые теги, отсутствующие в параметре 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 - / обязательно | Ссылка на IP-адреса переднего плана. | ||
| frontend_port_range_end - / обязательно | Последний порт в диапазоне внешних портов, которые будут использоваться для предоставления входящего NAT сетевым адаптерам, связанным с балансировщиком нагрузки. Допустимые значения находятся в диапазоне от 1 до 65535. | ||
| frontend_port_range_start - / обязательно | Первый порт в диапазоне внешних портов, которые будут использоваться для предоставления входящего NAT сетевым адаптерам, связанным с балансировщиком нагрузки. Допустимые значения находятся в диапазоне от 1 до 65534. | ||
| name - / обязательно | Имя пула входящего NAT. | ||
| protocol - |
| IP-протокол для пула NAT. | |
| inbound_nat_rules - added in 2.8 | Коллекция правил inbound NAT, используемых балансировщиком нагрузки. Определение правил inbound NAT на балансировщике нагрузки исключает определение пула inbound NAT. Пулы inbound NAT ссылаются из наборов виртуальных машин. NIC, связанные с отдельными виртуальными машинами, не могут ссылаться на пул Inbound NAT. Они должны ссылаться на отдельные правила inbound NAT. | ||
| backend_port - | Порт, используемый для внутренних подключений на конечной точке. Допустимые значения находятся в диапазоне от 0 до 65535. Обратите внимание, что значение 0 включает «Любой порт». | ||
| enable_floating_ip - | Настраивает конечную точку виртуальной машины для поддержки плавающего IP-адреса, необходимого для настройки группы доступности SQL AlwaysOn. Это значение требуется при использовании групп доступности SQL AlwaysOn в SQL Server. Это значение нельзя изменить после создания конечной точки. | ||
| enable_tcp_reset - | Прием двунаправленного TCP-сброса при истечении таймаута простоя TCP-потока или неожиданном разрыве соединения. Этот элемент используется только при protocol=Tcp. | ||
| frontend_ip_configuration - / required | Ссылка на адреса IP-адресов внешней стороны. | ||
| frontend_port - | Порт внешней конечной точки. Номера портов frontend должны быть уникальными для всех правил в балансировщике нагрузки. Допустимые значения находятся в диапазоне от 0 до 65534. Обратите внимание, что значение 0 включает «Любой порт». | ||
| idle_timeout - | Таймаут для TCP-соединения с простоями. Значение может быть установлено в диапазоне от 4 до 30 минут. Значение по умолчанию составляет 4 минут.Этот элемент используется только при protocol=Tcp. | ||
| name - / required | Имя правила inbound nat. | ||
| protocol - |
| IP-протокол для правила inbound nat. | |
| load_balancing_rules - added in 2.5 | Коллекция объектов, представляющих правила балансировки нагрузки. Получает сведения о подготовке. | ||
| backend_address_pool - / required | Ссылка на пул DIP-адресов. Входящий трафик случайным образом распределяется по IP-адресам в пуле конечных IP-адресов. | ||
| backend_port - | Порт, используемый для внутренних подключений на конечной точке. Допустимые значения находятся в диапазоне от 0 до 65535. Обратите внимание, что значение 0 включает «Любой порт». | ||
| enable_floating_ip - | Настраивает SNAT для виртуальных машин в пуле конечных точек, чтобы они использовали IP-адрес publicIP, указанный в frontend правила балансировки нагрузки. | ||
| frontend_ip_configuration - / required | Ссылка на адреса IP-адресов внешней стороны. | ||
| frontend_port - | Порт внешней конечной точки. Номера портов frontend должны быть уникальными для всех правил в балансировщике нагрузки. Допустимые значения находятся в диапазоне от 0 до 65534. Обратите внимание, что значение 0 включает «Любой порт». | ||
| idle_timeout - | Таймаут для TCP-соединения с простоями. Значение может быть установлено в диапазоне от 4 до 30 минут. Значение по умолчанию составляет 4 минут.Этот элемент используется только при установке протокола в TCP. | ||
| load_distribution - |
| Политика сохранения сеанса для этого правила; Default — это отсутствие сохранения. | |
| name - / required | Имя правила балансировки нагрузки. | ||
| probe - / required | Имя зонда балансировщика нагрузки, которое это правило должно использовать для проверки работоспособности. | ||
| protocol - |
| IP-протокол для правила балансировки нагрузки. | |
| load_distribution - |
| (устарело) Тип распределения нагрузки, который будет использовать балансировщик нагрузки. Этот параметр устарел и будет удален в версии 2.9. Используйте load_balancing_rules вместо него. | |
| location - | Действительное расположение Azure. По умолчанию — расположение группы ресурсов. | ||
| name - / required | Имя балансировщика нагрузки. | ||
| natpool_backend_port - | (устарело) Порт backend, используемый пулом 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 string | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо служебного принципала. | ||
| probe_fail_count - | Default: 3 | (устарело) Количество сбоев зондирования для определения работоспособности балансировщиком нагрузки. Этот параметр устарел и будет удален в версии 2.9. Используйте probes вместо него. | |
| probe_interval - | Default: 15 | (устарело) Время (в секундах) между проверками работоспособности конечных точек. Этот параметр устарел и будет удален в версии 2.9. Используйте probes вместо него. | |
| probe_port - | (устарело) Порт, который будет использовать зонд проверки. Этот параметр устарел и будет удален в версии 2.9. Используйте probes вместо него. | ||
| probe_protocol - |
| (устарело) Протокол, используемый для проверки работоспособности. Этот параметр устарел и будет удален в версии 2.9. Используйте probes вместо него. | |
| probe_request_path - | (устаревшее) URL, который будет использовать HTTP- или HTTPS-зонд (актуально только если probe_protocol=Http или probe_protocol=Https). Этот параметр устарел и будет удален в версии 2.9. Используйте вместо него probes. | ||
| probes - добавлен в 2.5 | Список определений зондов, используемых для проверки состояния конечной точки. | ||
| fail_count - | По умолчанию: 3 | Количество зондов, при отсутствии ответа на которые будет прекращена дальнейшая доставка трафика на конечную точку. Это значение позволяет выводить конечные точки из ротации быстрее или медленнее, чем обычно в Azure. псевдонимы: number_of_probes | |
| interval - | По умолчанию: 15 | Интервал в секундах, с которым будет проверяться состояние конечной точки. Ненамного меньше половины назначенного времени ожидания, что позволяет выполнить два полных зондирования перед выводом экземпляра из ротации. Значение по умолчанию — 15, минимальное значение — 5. | |
| name - / обязательно | Имя зонда. | ||
| port - / обязательно | Порт зонда для связи. Возможные значения находятся в диапазоне от 1 до 65535 включительно. | ||
| protocol - |
| Протокол конечной точки, которая подлежит зондированию. Если указано Tcp, для успешного зондирования требуется получение подтверждения (ACK).Если указано Http или Https, для успешного зондирования требуется ответ 200 OK от указанного URL. | |
| request_path - | URI, используемый для запроса состояния готовности виртуальной машины. Путь требуется, если protocol=Http или protocol=Https. В противном случае он запрещен. | ||
| 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, или выполнить вход перед выполнением задач или playbook с помощью
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.9/modules/azure_rm_loadbalancer_module.html
