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 | Значение по умолчанию: null | URL-адрес авторизации Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственной авторизации ADFS. | |
| api_profile - добавлено в 2.5 | Значение по умолчанию: "latest" | Выбирает профиль API для использования при взаимодействии с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. | |
| append_tags boolean |
| Управляет тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноничности любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта. | |
| 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 | |
| load_balancing_rules - добавлено в 2.5 | Коллекция объектов, представляющих правила балансировки нагрузки. Получает данные настройки. | ||
| backend_address_pool - / обязательно | Ссылка на пул DIP. Входящий трафик случайным образом распределяется по IP-адресам в пуле бэкенд-IP-адресов. | ||
| backend_port - | Порт, используемый для внутренних подключений на конечной точке. Допустимые значения находятся в диапазоне от 0 до 65535. Обратите внимание, что значение 0 включает «Любой порт» | ||
| enable_floating_ip - | Настраивает SNAT для виртуальных машин в пуле бэкенда, чтобы использовать общедоступный IP-адрес, указанный в фронтенде правила балансировки нагрузки. | ||
| 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 вместо этого. | ||
| 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. Аутентификация возможна с помощью принципала службы или пользователя 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 load balancer
azure_rm_loadbalancer:
resource_group: testrg
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
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое | Описание |
|---|---|---|
| changed boolean | всегда | Изменился ли ресурс |
| state словарь | всегда | Текущее состояние балансировщика нагрузки |
Статус
- Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.7/modules/azure_rm_loadbalancer_module.html
