azure.azcollection.azure_rm_loadbalancer – Управление балансировщиками нагрузки Azure
Примечание
Этот плагин является частью коллекции azure.azcollection (версия 1.4.0).
Для его установки используйте: ansible-galaxy collection install azure.azcollection.
Для использования в книге задач укажите: azure.azcollection.azure_rm_loadbalancer.
Введено в версии 0.1.2: of azure.azcollection
Обзор
- Создание, обновление и удаление балансировщиков нагрузки Azure.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| ad_user строка | Имя пользователя Active Directory. Используется при аутентификации пользователем Active Directory, а не главным принципом службы. | ||
| adfs_authority_url строка добавлено в 0.0.1 из azure.azcollection | URL-адрес полномочий Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственных полномочий ADFS. | ||
| api_profile строка добавлено в 0.0.1 из azure.azcollection | По умолчанию: "latest" | Выбирает профиль API для взаимодействия с Azure-службами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. | |
| append_tags логическое значение |
| Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом значении все теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. | |
| auth_source строка добавлено в 0.0.1 из azure.azcollection |
| Управляет источником учетных данных для аутентификации. Также может быть задано через переменную среды ANSIBLE_AZURE_AUTH_SOURCE.При значении auto (по умолчанию) приоритет: параметры модуля -> env -> credential_file -> cli.При значении env, учетные данные будут считываться из переменных средыПри значении credential_file, профиль будет считан из ~/.azure/credentials.При значении cli, учетные данные будут взяты из профиля Azure CLI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут использоваться для указания идентификатора подписки, если их несколько; в противном случае используется стандартная подписка Azure CLI.При значении msi, хост-машина должна быть Azure-ресурсом с включённым расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID может быть использована для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам; в противном случае выбирается первая подписка.msi был добавлен в Ansible 2.6. | |
| backend_address_pools строка | Список пулов адресов бэкенда. | ||
| name строка / обязательно | Имя пула адресов бэкенда. | ||
| backend_port строка | (устарело) Порт бэкенда, который будет экспонирован для балансировщика нагрузки. Этот параметр устарел и будет удалён в версии 2.9. Используйте вместо него load_balancing_rules. | ||
| cert_validation_mode строка добавлено в 0.0.1 из azure.azcollection |
| Управляет поведением проверки сертификата для Azure-узлов. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или при работе с Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть задано через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION. | |
| client_id строка | Идентификатор клиента Azure. Используется при аутентификации главным принципом службы. | ||
| cloud_environment строка добавлено в 0.0.1 из azure.azcollection | По умолчанию: "AzureCloud" | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment), или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть задано через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT. | |
| frontend_ip_configurations строка | Список используемых внешних IP-адресов. | ||
| name строка / обязательно | Имя конфигурации внешнего IP-адреса. | ||
| private_ip_address строка | Ссылка на ресурс общедоступного IP-адреса. | ||
| private_ip_allocation_method строка |
| Метод выделения частного IP-адреса. | |
| public_ip_address строка | Имя существующего объекта общедоступного IP-адреса в текущей группе ресурсов для ассоциации с группой безопасности. | ||
| subnet строка | Ссылка на ресурс подсети. Должен быть существующий идентификатор ресурса подсети. | ||
| frontend_port строка | (устарело) Внешний порт, который будет экспонирован для балансировщика нагрузки. Этот параметр устарел и будет удалён в версии 2.9. Используйте вместо него load_balancing_rules. | ||
| idle_timeout строка | По умолчанию: 4 | (устарело) Таймаут для соединения TCP без активности в минутах. Этот параметр устарел и будет удалён в версии 2.9. Используйте вместо него load_balancing_rules. | |
| inbound_nat_pools строка | Определяет диапазон внешних портов для входящего 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 строка | Коллекция правил входящего NAT, используемых балансировщиком нагрузки. Определение правил входящего NAT на вашем балансировщике нагрузки исключает определение пула входящего NAT. Пулы входящих NAT ссылаются на виртуальные машины масштабируемых наборов. Сетевые адаптеры, связанные с отдельными виртуальными машинами, не могут ссылаться на пул входящих NAT. Они должны ссылаться на отдельные правила входящего NAT. | ||
| backend_port строка | Порт, используемый для внутренних подключений на конечной точке. Допустимые значения находятся в диапазоне от 0 до 65535. Значение 0 включает "Любой порт". | ||
| enable_floating_ip строка | Настраивает конечную точку виртуальной машины для функции плавающего IP, необходимой для настройки группы доступности AlwaysOn SQL. Это значение требуется при использовании групп доступности AlwaysOn SQL в SQL Server. Это значение нельзя изменить после создания конечной точки. | ||
| enable_tcp_reset строка | Получает двусторонние TCP-сбросы при таймауте бездействия TCP-потока или неожиданном разрыве подключения. Этот элемент используется только при protocol=Tcp. | ||
| frontend_ip_configuration строка / обязательно | Ссылка на внешние IP-адреса. | ||
| frontend_port строка | Порт для внешней конечной точки. Номера внешних портов должны быть уникальными для всех правил в балансировщике нагрузки. Допустимые значения находятся в диапазоне от 0 до 65534. Значение 0 включает "Любой порт". | ||
| idle_timeout строка | Таймаут для неактивного TCP-соединения. Значение может быть установлено от 4 до 30 минут. Значение по умолчанию — %%%CODE_BLOCK_23%% минут. Этот элемент используется только при protocol=Tcp. | ||
| name строка / обязательно | Имя правила входящего NAT. | ||
| protocol строка |
| IP-протокол для правила входящего NAT. | |
| load_balancing_rules строка | Коллекция объектов, представляющая правила балансировки нагрузки. Получает сведения о развертывании. | ||
| backend_address_pool строка / обязательно | Ссылка на пул DIP-адресов. Входящий трафик случайным образом балансируется по IP-адресам в конечных IP-адресах. | ||
| backend_port строка | Порт, используемый для внутренних соединений на конечной точке. Допустимые значения находятся в диапазоне от 0 до 65535. Обратите внимание, что значение 0 позволяет использовать «любой порт». | ||
| enable_floating_ip строка | Настраивает SNAT для виртуальных машин в конечном пуле, чтобы использовать общедоступный IP-адрес, указанный в переднем интерфейсе правила балансировки нагрузки. | ||
| frontend_ip_configuration строка / обязательно | Ссылка на адреса переднего интерфейса. | ||
| 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 или HTTPS (актуально только если probe_protocol=Http или probe_protocol=Https). Этот параметр устарел и будет удален в версии 2.9. Используйте probes вместо этого. | ||
| probes строка | Список определений зондов, используемых для проверки работоспособности конечных точек. | ||
| fail_count строка | По умолчанию: 3 | Количество проверок, при отсутствии ответа приведет к прекращению дальнейшей доставки трафика на конечную точку. Это позволяет выводить конечные точки из вращения быстрее или медленнее, чем обычно в Azure. псевдонимы: number_of_probes | |
| interval строка | По умолчанию: 15 | Интервал (в секундах) для проверки работоспособности конечной точки. Немного меньше половины назначенного таймаута, что позволяет выполнить две полные проверки перед выводом экземпляра из вращения. Значение по умолчанию — 15, минимальное значение — %%%CODE_BLOCK_27%%. | |
| 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 строка |
| SKU балансировщика нагрузки. | |
| состояние строка |
| Утвердите состояние балансировщика нагрузки. Используйте present, чтобы создать/обновить балансировщик нагрузки, или absent, чтобы удалить его. | |
| subscription_id строка | Ваш идентификатор подписки Azure. | ||
| метки словарь | Словарь пар «строка:строка» для назначения метаданных объекту. Метаданные метки объекта будут обновлены любыми предоставленными значениями. Чтобы удалить метки, установите параметр append_tags в значение false. | ||
| арендатор строка | Идентификатор арендатора 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
Значения возврата
Общие значения возврата документированы здесь, следующие являются полями, уникальными для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| изменён логическое значение | всегда | Указывает, изменился ли ресурс. |
| состояние словарь | всегда | Текущее состояние балансировщика нагрузки. |
Авторы
- Thomas Stringer (@trstringer)
- Yuwei Zhou (@yuwzho)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/azure/azcollection/azure_rm_loadbalancer_module.html
