azure_rm_loadbalancer - Управление балансировщиками нагрузки Azure.
Новая версия с 2.4.
- Обзор
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Обзор
- Создание, обновление и удаление балансировщиков нагрузки Azure
Требования (к хосту, на котором выполняется модуль)
- python >= 2.7
- azure >= 2.0.0
Параметры
| параметр | обязательный | значение по умолчанию | возможные значения | комментарии |
|---|---|---|---|---|
| ad_user | нет | Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо сервисного принципала. | ||
| append_tags | нет | True | Управление полем тегов: каноническое или добавляет к существующим. При каноническом режиме, любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. | |
| backend_port | нет | Порт бэкенда, который будет доступен для балансировщика. | ||
| client_id | нет | Идентификатор клиента Azure. Используется при аутентификации с сервисным принципалом. | ||
| cloud_environment | нет | AzureCloud | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment), или URL-адрес обнаружения метаданных (требуется для Azure Stack). Также может быть задан в профиле файла аутентификации или переменной среды AZURE_CLOUD_ENVIRONMENT. | |
| frontend_port | нет | Порт фронта, который будет доступен для балансировщика. | ||
| idle_timeout | нет | 4 | Тайм-аут для неактивного TCP-соединения в минутах. | |
| load_distribution | нет |
| Тип распределения нагрузки, который будет использовать балансировщик. | |
| location | нет | location группы ресурсов | Действительное расположение Azure. По умолчанию - расположение группы ресурсов. | |
| name | да | Имя балансировщика. | ||
| natpool_backend_port | нет | Порт бэкенда, используемый NAT-пулом. | ||
| natpool_frontend_port_end | нет | Конец диапазона портов для NAT-пула. | ||
| natpool_frontend_port_start | нет | Начало диапазона портов для NAT-пула. | ||
| natpool_protocol | нет | Протокол для NAT-пула. | ||
| password | нет | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо сервисного принципала. | ||
| probe_fail_count | нет | 3 | Количество неудачных попыток зондирования балансировщиком для определения работоспособности. | |
| probe_interval | нет | 15 | Время (в секундах) зондирования конечной точки для определения состояния. | |
| probe_port | нет | Порт, который будет использоваться для зондирования работоспособности. | ||
| probe_protocol | нет |
| Протокол для зондирования работоспособности. | |
| probe_request_path | нет | URL, который будет использоваться HTTP-зондированием (актуально только если probe_protocol установлен в Http). | ||
| profile | нет | Профиль безопасности, найденный в файле ~/.azure/credentials. | ||
| protocol | нет |
| Протокол (TCP или UDP), используемый балансировщиком. | |
| public_ip_address_name | нет | Имя существующего объекта общедоступного IP-адреса для ассоциации с группой безопасности. псевдонимы: public_ip_address, public_ip_name, public_ip | ||
| resource_group | да | Имя группы ресурсов, где находится или будет создан балансировщик. | ||
| secret | нет | Секрет клиента Azure. Используется при аутентификации с сервисным принципалом. | ||
| state | нет | present |
| Указывает состояние балансировщика. Используйте 'present' для создания или обновления балансировщика, и 'absent' для удаления. |
| subscription_id | нет | Ваш идентификатор подписки Azure. | ||
| tags | нет | Словарь пар ключ-значение для назначения метаданных объекту. Метаданные теги объекта будут обновлены всеми предоставленными значениями. Для удаления тегов установите параметр append_tags в false. | ||
| tenant | нет | Идентификатор клиента Azure. Используется при аутентификации с сервисным принципалом. |
Примеры
- 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 |
Примечания
Примечание
- Для аутентификации с 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 в среде.
Статус
Этот модуль помечен как предварительный, что означает, что он не гарантирует обратной совместимости интерфейса.
Для получения помощи в разработке модулей, если вы так решите, пожалуйста, ознакомьтесь с Информацией о сообществе и участии в разработке, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/azure_rm_loadbalancer_module.html
