azure_rm_loadbalancer - Управление балансировщиками Azure.
Новая версия с 2.4.
Обзор
- Создание, обновление и удаление балансировщиков Azure.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| ad_user | По умолчанию: None | Имя пользователя Active Directory. Используется при аутентификации пользователем Active Directory, а не службой-принципалом. | |
| api_profile (добавлено в 2.5) |
| Выбирает профиль API для использования при взаимодействии с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. | |
| append_tags | По умолчанию: yes | Используется для управления тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноническом формате любые теги, не найденные в параметре tags, будут удалены из метаданных объекта. | |
| auth_source (добавлено в 2.5) |
| Управляет источником учетных данных для аутентификации. auto будет следовать умолчанию приоритета параметров модуля -> переменных среды -> профиля по умолчанию в файле учетных данных ~/.azure/credentials. При установке в cli, учетные данные будут взяты из профиля Azure CLI по умолчанию.Также может быть задано через переменную среды ANSIBLE_AZURE_AUTH_SOURCE. | |
| backend_address_pools (добавлено в 2.5) | Список пулов адресов бэкенда | ||
| name обязательно | Имя пула адресов бэкенда. | ||
| backend_port | (устарело) Порт бэкенда, который будет экспонирован для балансировщика нагрузки. Этот параметр устарел и будет удален в версии 2.9. Используйте load_balancing_rules вместо этого. | ||
| cert_validation_mode (добавлено в 2.5) |
None | Управляет поведением проверки сертификатов для Azure-точек конечного доступа. По умолчанию все модули проверяют серверный сертификат, но когда используется HTTPS-прокси или подключение к Azure Stack, может потребоваться отключить это поведение, передав ignore. Также может быть задано через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION. | |
| client_id | По умолчанию: None | 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-адреса фронтена. | ||
| public_ip_address обязательно | Имя существующего объекта публичного IP-адреса в текущей группе ресурсов для ассоциации с группой безопасности. | ||
| 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. | ||
| frontend_port_range_start обязательно | Первый порт в диапазоне внешних портов, который будет использоваться для предоставления входного NAT сетевым адаптерам, связанным с балансировщиком нагрузки. Допустимые значения в диапазоне от 1 до 65534. | ||
| protocol |
| IP-протокол для пула NAT | |
| name обязательно | Имя пула входного NAT. | ||
| frontend_ip_configuration_name обязательно | Ссылка на IP-адреса фронтена. | ||
| backend_port | Порт, используемый для внутренних соединений на точке конечного доступа. Допустимые значения от 1 до 65535. | ||
| frontend_port_range_end обязательно | Последний порт в диапазоне внешних портов, который будет использоваться для предоставления входного NAT сетевым адаптерам, связанным с балансировщиком нагрузки. Допустимые значения в диапазоне от 1 до 65535. | ||
| load_balancing_rules (добавлено в 2.5) | Коллекция объектов, представляющих правила балансировки нагрузки. Получает данные о развёртывании. | ||
| load_distribution |
| Политика сохранения сессий для этого правила; Default означает отсутствие сохранения. | |
| name обязательно | Имя правила балансировки нагрузки. | ||
| frontend_ip_configuration обязательно | Ссылка на IP-адреса фронтена. | ||
| probe обязательно | Имя зонда балансировщика нагрузки, которое должно использоваться этим правилом для проверок состояния. | ||
| protocol |
| IP-протокол для правила балансировки нагрузки. | |
| idle_timeout | Таймаут для TCP-соединения в режиме простоя. Значение может быть установлено от 4 до 30 минут. Значение по умолчанию — 4 минуты. Этот элемент используется только в том случае, когда протокол установлен в TCP. | ||
| enable_floating_ip | Конфигурирует SNAT для ВМ в пуле бэкенда для использования публичного IP-адреса, указанного в фронте правила балансировки нагрузки. | ||
| backend_address_pool обязательно | Ссылка на пул внутренних IP-адресов. Входящий трафик случайным образом балансируется по IP-адресам в пуле бэкенда. | ||
| frontend_port | Порт для внешней точки конечного доступа. Номера портов фронтена должны быть уникальными для всех правил в балансировщике нагрузки. Допустимые значения от 0 до 65534. Обратите внимание, что значение 0 активирует «Любой порт» | ||
| backend_port | Порт, используемый для внутренних соединений на точке конечного доступа. Допустимые значения от 0 до 65535. Обратите внимание, что значение 0 активирует «Любой порт» | ||
| 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 | По умолчанию: None | Пароль пользователя 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 вместо него. | ||
| probes (добавлен в 2.5) | Список определений проверок, используемых для проверки работоспособности конечной точки. | ||
| fail_count | По умолчанию: 3 | Количество проверок, при отсутствии ответа которых прекратится передача трафика на конечную точку. Это значение позволяет выводить конечные точки из ротации быстрее или медленнее, чем обычно в Azure. псевдонимы: number_of_probes | |
| protocol |
| Протокол конечной точки, подлежащей проверке. Если указан 'Tcp', для успешной проверки требуется получение ACK. Если указан 'Http', для успешной проверки требуется ответ 200 OK с указанного URL. | |
| name обязательно | Имя проверки. | ||
| interval | По умолчанию: 15 | Интервал (в секундах) для частоты проверки работоспособности конечной точки. Немного меньше половины назначенного времени ожидания, что позволяет выполнить две полные проверки перед выводом экземпляра из ротации. Значение по умолчанию — 15, минимальное значение — 5. | |
| port обязательно | Порт проверки для связи проверки. Возможные значения от 1 до 65535 включительно. | ||
| request_path | URI, используемый для запроса состояния работоспособности виртуальной машины. Путь необходим, если протокол установлен на http. В противном случае он не разрешён. | ||
| profile | По умолчанию: None | Профиль безопасности, найденный в файле ~/.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 | По умолчанию: None | Секрет клиента Azure. Используйте при аутентификации с помощью сервисного принципала. | |
| state |
| Утверждение состояния балансировщика нагрузки. Используйте present для создания/обновления балансировщика нагрузки или absent для удаления. | |
| subscription_id | По умолчанию: None | Ваш идентификатор подписки Azure. | |
| tags | По умолчанию: None | Словарь пар ключ-значение типа строка:строка, назначаемый в качестве метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Чтобы удалить теги, установите параметр append_tags в false. | |
| tenant | По умолчанию: None | Идентификатор клиента 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 в среде.
Примеры
# TODO: this example needs update for 2.5+ module args
- name: Create a load balancer
azure_rm_loadbalancer:
name: myloadbalancer
location: eastus
resource_group: my-rg
public_ip: mypublicip
probe_protocol: Tcp
probe_port: 80
probe_interval: 10
probe_fail_count: 3
protocol: Tcp
load_distribution: Default
frontend_port: 80
backend_port: 8080
idle_timeout: 4
natpool_frontend_port_start: 1030
natpool_frontend_port_end: 1040
natpool_backend_port: 80
natpool_protocol: Tcp
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие являются полями, уникальными для данного модуля:
| Ключ | Возвращаемое | Описание |
|---|---|---|
| changed bool | всегда | Изменился ли ресурс |
| state dict | всегда | Текущее состояние балансировщика нагрузки |
Статус
Этот модуль помечен как предварительный просмотр, что означает, что он не гарантирует обратную совместимость интерфейса.
Автор
- Thomas Stringer (@tstringer)
- 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.5/modules/azure_rm_loadbalancer_module.html
