azure.azcollection.azure_rm_loadbalancer – Управление балансировщиками нагрузки Azure

Примечание

Этот плагин является частью коллекции azure.azcollection (версия 1.3.1).

Для его установки используйте: 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 логическое значение		Варианты: нет да ←	Используется для управления тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноническом варианте все теги, отсутствующие в параметре tags, будут удалены из метаданных объекта.
auth_source строка добавлен в 0.0.1 в azure.azcollection		Варианты: авто ← cli credential_file env msi	Управляет источником учетных данных для аутентификации. Также может быть установлен через переменную среды `ANSIBLE_AZURE_AUTH_SOURCE`. При значении `auto` (значение по умолчанию) приоритет имеет параметры модуля -> `env` -> `credential_file` -> `cli`. При значении `env`, учетные данные будут считываться из переменных среды При значении `credential_file`, профиль будет считан из `~/.azure/credentials`. При значении `cli`, учетные данные будут взяты из профиля Azure CLI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` могут использоваться для идентификации идентификатора подписки, если их несколько, иначе используется стандартная подписка az 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		Варианты: ignore validate	Управляет поведением проверки сертификатов для 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 строка	Варианты: Tcp Udp Все	IP-протокол для пула NAT.
inbound_nat_rules строка			Коллекция правил входящего NAT, используемых балансировщиком нагрузки. Определение правил входящего NAT на балансировщике нагрузки исключает определение пула входящего NAT. Пулы входящих NAT ссылаются на масштабируемые наборы виртуальных машин. Сетевые адаптеры, связанные с отдельными виртуальными машинами, не могут ссылаться на пул входящего NAT. Они должны ссылаться на отдельные правила входящего NAT.
	backend_port строка		Порт, используемый для внутренних соединений на конечной точке. Допустимые значения находятся в диапазоне от 0 до 65535. Значение 0 разрешает "любой порт".
	enable_floating_ip строка		Настраивает конечную точку виртуальной машины для возможности плавающего IP, необходимой для настройки группы доступности SQL AlwaysOn. Это значение требуется при использовании групп доступности SQL AlwaysOn в SQL Server. Это значение нельзя изменить после создания конечной точки.
	enable_tcp_reset строка		Получать двустороннее TCP-сброс при таймауте простоя TCP-потока или при неожиданном завершении соединения. Этот элемент используется только при protocol=Tcp.
	frontend_ip_configuration строка / обязательно		Ссылка на внешние IP-адреса.
	frontend_port строка		Порт для внешней конечной точки. Номера портов внешнего конечного узла должны быть уникальными для всех правил в балансировщике нагрузки. Допустимые значения находятся в диапазоне от 0 до 65534. Значение 0 разрешает "любой порт".

	idle_timeout строка		Таймаут для неактивного TCP-соединения. Значение может быть установлено в пределах от 4 до 30 минут. Значение по умолчанию составляет `4` минут. Этот элемент используется только при protocol=Tcp.
	name строка / обязательно		Имя правила входящего NAT.
	protocol строка	Варианты: Tcp Udp All	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 строка	Варианты: По умолчанию ← SourceIP SourceIPProtocol	Политика сохранения сеанса для этого правила; `Default` означает отсутствие сохранения.
	name строка / обязательно		Имя правила балансировки нагрузки.
	probe строка / обязательно		Имя зонда балансировщика нагрузки, которое это правило должно использовать для проверки состояния.
	protocol строка	Варианты: Tcp Udp All	IP-протокол для правила балансировки нагрузки.
load_distribution строка		Варианты: Default SourceIP SourceIPProtocol	(устарело) Тип распределения нагрузки, который будет использовать балансировщик нагрузки. Этот параметр устарел и будет удален в версии 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 строка		Варианты: Tcp Http Https	(устарело) Протокол для проверки состояния. Этот параметр устарел и будет удален в версии 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`, минимальное значение равно `5`.
	name строка / обязательно		Имя зонда.
	port строка / обязательно		Порт зондирования для связи зонда. Возможные значения находятся в диапазоне от 1 до 65535 включительно.
	protocol строка	Варианты: Tcp Http Https	Протокол конечной точки, подлежащей зондированию. Если указан `Tcp`, для успешной проверки зонда требуется получение подтверждения (ACK). Если указан `Http` или `Https`, для успешной проверки зонда требуется ответ 200 OK с указанного URL.
	request_path строка		URI, используемый для запроса состояния работоспособности ВМ. Путь обязателен, если protocol=Http или protocol=Https. В противном случае он не допускается.
profile строка			Профиль безопасности, находящийся в файле ~/.azure/credentials.
protocol строка		Варианты: Tcp Udp	(устарело) Протокол (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 строка		Варианты: Basic Standard	SKU балансировщика нагрузки.

state string	Choices: absent present ←	Укажите состояние балансировщика нагрузки. Используйте `present` для создания/обновления балансировщика или `absent` для удаления.
subscription_id string		Идентификатор вашей подписки Azure.
tags dictionary		Словарь пар «строка:строка» для назначения метаданных объекту. Метаданные метки объекта будут обновлены любыми предоставленными значениями. Для удаления меток установите параметр append_tags в значение false.
tenant string		Идентификатор Azure-аренды. Используйте при аутентификации с помощью принципала службы.

Примечания

Примечание

Для аутентификации с Azure вы можете передать параметры, установить переменные среды, использовать профиль, хранящийся в ~/.azure/credentials, или войти в систему перед запуском задач или игры с помощью 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

Значения возврата

Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:

Ключ	Возвращаемое значение	Описание
changed boolean	всегда	Изменился ли ресурс.
state dictionary	всегда	Текущее состояние балансировщика нагрузки.

Авторы

Thomas Stringer (@trstringer)
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.10/collections/azure/azcollection/azure_rm_loadbalancer_module.html