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 bool |
| Используется для управления тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноническом значении любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. | |
| 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-адреса. | ||
| public_ip_address | Имя существующего объекта общедоступного IP-адреса в текущей группе ресурсов для ассоциации с группой безопасности. | ||
| private_ip_address (добавлено в 2.6) | Ссылка на ресурс общедоступного IP. | ||
| private_ip_allocation_method (добавлено в 2.6) |
| Метод выделения частного 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. | ||
| name обязательно | Имя пула Входящей NAT. | ||
| frontend_ip_configuration_name обязательно | Ссылка на передние IP-адреса. | ||
| protocol |
| IP-протокол для пула NAT | |
| frontend_port_range_start обязательно | Первый порт в диапазоне внешних портов, который будет использоваться для предоставления Входящей NAT для сетевых адаптеров, связанных с балансировщиком нагрузки. Допустимые значения находятся в диапазоне от 1 до 65534. | ||
| frontend_port_range_end обязательно | Последний порт в диапазоне внешних портов, который будет использоваться для предоставления Входящей NAT для сетевых адаптеров, связанных с балансировщиком нагрузки. Допустимые значения находятся в диапазоне от 1 до 65535. | ||
| backend_port | Порт, используемый для внутренних подключений на точке входа. Допустимые значения находятся в диапазоне от 1 до 65535. | ||
| load_balancing_rules (добавлено в 2.5) | Коллекция объектов, представляющих правила балансировки нагрузки. Получает подготовку. | ||
| name обязательно | Имя правила балансировки нагрузки. | ||
| frontend_ip_configuration обязательно | Ссылка на передние IP-адреса. | ||
| backend_address_pool обязательно | Ссылка на пул внутренних IP-адресов. Входящий трафик случайно распределяется по IP-адресам в пуле бэкенд-IP-адресов. | ||
| probe обязательно | Имя зонда балансировщика нагрузки, который это правило должно использовать для проверки состояния. | ||
| protocol |
| IP-протокол для правила балансировки нагрузки. | |
| load_distribution |
| Политика сохранения сеанса для данного правила; Default — без сохранения сеанса. | |
| frontend_port | Порт для внешнего конечного узла. Порты переднего плана должны быть уникальными для всех правил в балансировщике нагрузки. Допустимые значения находятся в диапазоне от 0 до 65534. Примечание: значение 0 включает "Любой порт" | ||
| backend_port | Порт, используемый для внутренних подключений на точке входа. Допустимые значения находятся в диапазоне от 0 до 65535. Примечание: значение 0 включает "Любой порт" | ||
| idle_timeout | Тайм-аут для неактивного TCP-соединения. Значение может быть установлено в диапазоне от 4 до 30 минут. Значение по умолчанию составляет 4 минуты. Этот элемент используется только при установке протокола TCP. | ||
| enable_floating_ip | Настраивает SNAT для виртуальных машин в пуле бэкенда, чтобы использовать адрес publicIP, указанный в фронтэнде правила балансировки нагрузки. | ||
| 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) | Список определений проверок для проверки работоспособности конечных точек. | ||
| name обязательно | Имя проверки. | ||
| port обязательно | Порт проверки для связи с проверкой. Возможные значения от 1 до 65535 включительно. | ||
| protocol |
| Протокол конечной точки, подлежащей проверке. Если указан 'Tcp', для успешной проверки требуется получение подтверждения (ACK). Если указан 'Http', для успешной проверки требуется ответ 200 OK с указанного URL. | |
| interval | По умолчанию: 15 | Интервал (в секундах) проверки состояния работоспособности конечной точки. Ненамного меньше половины выделенного тайм-аута, что позволяет выполнить две полные проверки перед выведением экземпляра из вращения. Значение по умолчанию — 15, минимальное значение — 5. | |
| fail_count | По умолчанию: 3 | Количество проверок, по результатам которых, при отсутствии ответа, прекратится дальнейшая доставка трафика на конечную точку. Это значение позволяет выводить конечные точки из вращения быстрее или медленнее, чем типичные значения, используемые в Azure. псевдонимы: number_of_probes | |
| 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 в среде.
Примеры
# 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 | всегда | Текущее состояние балансировщика нагрузки |
Статус
Этот модуль помечен как предварительный, что означает, что он не гарантирует обратную совместимость интерфейса.
Обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Дополнительная информация по этому вопросу приведена в разделе Обслуживание и поддержка модулей.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- 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.6/modules/azure_rm_loadbalancer_module.html
