community.azure.azure_rm_loadbalancer_facts – Получение фактов о балансировщике нагрузки

Примечание

Этот плагин входит в состав коллекции community.azure (версия 1.0.0).

Для его установки используйте: ansible-galaxy collection install community.azure.

Для использования в книге задач укажите: community.azure.azure_rm_loadbalancer_facts.

Описание
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Описание

Получение фактов о конкретном балансировщике нагрузки или всех балансировщиках.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется данный модуль.

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.
auth_source строка добавлено в версии 0.0.1 azure.azcollection	Варианты: auto ← 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`, может быть использована для определения идентификатора подписки, если их несколько; иначе используется подписка Azure CLI по умолчанию. При значении `msi`, хост-машина должна быть Azure-ресурсом с включенным расширением MSI. `subscription_id`, или переменная окружения `AZURE_SUBSCRIPTION_ID`, может быть использована для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам; иначе выбирается первая подписка. Переменная `msi` была добавлена в Ansible 2.6.
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`.
name строка		Ограничивает результаты конкретной группой ресурсов.
password строка		Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не служебного принципала.
profile строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group строка		Группа ресурсов для поиска нужного балансировщика.
secret строка		Секрет клиента Azure. Используется при аутентификации с помощью служебного принципала.
subscription_id строка		Ваш идентификатор подписки Azure.
tags строка		Ограничение результатов с помощью списка тегов. Формат тегов 'ключ' или 'ключ:значение'.
tenant строка		Идентификатор арендатора 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: Get facts for one load balancer
  community.azure.azure_rm_loadbalancer_info:
    name: Testing
    resource_group: myResourceGroup

- name: Get facts for all load balancers
  community.azure.azure_rm_loadbalancer_info:

- name: Get facts for all load balancers in a specific resource group
  community.azure.azure_rm_loadbalancer_info:
    resource_group: myResourceGroup

- name: Get facts by tags
  community.azure.azure_rm_loadbalancer_info:
    tags:
      - testing

Возвращаемые значения

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

Ключ	Возвращаемое значение	Описание
azure_loadbalancers список / элементы=строка	всегда	Список словарей балансировщиков нагрузки.

Авторы

Thomas Stringer (@trstringer)

© 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/community/azure/azure_rm_loadbalancer_facts_module.html