Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_trafficmanagerprofile_info — Получение фактов о профиле Azure Traffic Manager

Примечание

Этот модуль является частью коллекции azure.azcollection (версия 2.7.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

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

Добавлена в azure.azcollection 0.1.2

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

Описание

  • Получение фактов для определенного профиля Azure Traffic Manager или всех профилей Traffic Manager.

Требования

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

  • python >= 2.7
  • На хосте, выполняющем этот модуль, должна быть установлена коллекция azure.azcollection через galaxy
  • Все пакеты python, перечисленные в requirements.txt коллекции, должны быть установлены через pip на хосте, на котором выполняются модули из azure.azcollection
  • Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection

Параметры

Parameter

Комментарии

ad_user

string

Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным субъектом безопасности.

adfs_authority_url

string

added in azure.azcollection 0.0.1

URL-адрес узла Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и имеете собственный узел ADFS.

api_profile

string

added in azure.azcollection 0.0.1

Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.

Default: "latest"

auth_source

string

added in azure.azcollection 0.0.1

Управляет источником учетных данных для аутентификации.

Также может быть установлен через переменную среды 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.

Варианты:

  • "auto" ← (по умолчанию)
  • "cli"
  • "credential_file"
  • "env"
  • "msi"

cert_validation_mode

string

added in azure.azcollection 0.0.1

Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или в Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть установлен через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION.

Варианты:

  • "ignore"
  • "validate"

client_id

string

Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта безопасности или управляемой идентификации (msi).

Также может быть установлен через переменную среды AZURE_CLIENT_ID.

cloud_environment

string

added in azure.azcollection 0.0.1

Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть установлен через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT.

Default: "AzureCloud"

disable_instance_discovery

boolean

added in azure.azcollection 2.3.0

Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Установка этого значения в true полностью отключит как обнаружение экземпляров, так и проверку полномочий. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя получение метаданных полномочий из https://login.microsoft.com/ для проверки полномочий. Установив это значение в **True**, проверка полномочий отключается. В результате важно убедиться, что настроенный узел полномочий является действительным и заслуживающим доверия.

Устанавливается через профиль файла учетных данных или переменную среды AZURE_DISABLE_INSTANCE_DISCOVERY.

Варианты:

  • false ← (по умолчанию)
  • true

log_mode

string

Родительский аргумент.

log_path

string

Родительский аргумент.

name

string

Ограничение результатов для определенного профиля Traffic Manager.

password

string

Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным субъектом безопасности.

profile

string

Профиль безопасности, найденный в файле ~/.azure/credentials.

resource_group

string

Группа ресурсов для поиска нужного профиля Traffic Manager.

secret

string

Секретный ключ клиента Azure. Используйте при аутентификации с помощью субъекта безопасности.

subscription_id

string

Ваш идентификатор подписки Azure.

Теги

список / элементы=строка

Ограничить результаты, предоставив список тегов. Форматировать теги как ‘ключ’ или ‘ключ:значение’.

арендатор

строка

Идентификатор арендатора Azure. Используется при аутентификации с помощью Сервисного принципала.

отпечаток

строка

Добавлен в azure.azcollection 1.14.0

Отпечаток частного ключа, указанного в x509_certificate_path.

Используется при аутентификации с помощью Сервисного принципала.

Обязательно, если задано x509_certificate_path.

путь_к_сертификату_x509

путь

Добавлен в azure.azcollection 1.14.0

Путь к сертификату X509, используемому для создания сервисного принципала в формате PEM.

Сертификат должен быть присоединен к частному ключу.

Используется при аутентификации с помощью Сервисного принципала.

Примечания

Примечание

  • Для аутентификации с 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 Traffic Manager profile
  azure_rm_trafficmanager_info:
    name: Testing
    resource_group: myResourceGroup

- name: Get facts for all Traffic Manager profiles
  azure_rm_trafficmanager_info:

- name: Get facts by tags
  azure_rm_trafficmanager_info:
    tags:
      - Environment:Test

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

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

Ключ

Описание

tms

complex

Список профилей Traffic Manager.

Возвращается: всегда

dns_config

complex

Настройки DNS профиля Traffic Manager.

Возвращается: всегда

fqdn

string

Полностью квалифицированное доменное имя (FQDN) профиля Traffic Manager.

Возвращается: всегда

Пример: "testTm.trafficmanager.net"

relative_name

string

Относительное имя DNS, предоставленное профилем Traffic Manager.

Возвращается: всегда

Пример: "testTm"

ttl

integer

Время существования DNS (TTL) в секундах.

Возвращается: всегда

Пример: 60

endpoints

complex

Список конечных точек в профиле Traffic Manager.

Возвращается: всегда

geo_mapping

list / elements=string

Список стран/регионов, сопоставленных с этой конечной точкой, когда профиль имеет метод маршрутизации geographic.

Возвращается: всегда

Пример: ["GEO-NA", "GEO-AS"]

id

string

Полностью квалифицированный идентификатор ресурса.

Возвращается: всегда

Пример: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/trafficMan agerProfiles/tmtest/externalEndpoints/e1"

location

string

Расположение конечных точек, когда type=external_endpoints или type=nested_endpoints, и профиль routing_method=performance.

Возвращается: всегда

Пример: "East US"

min_child_endpoints

integer

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

Возвращается: всегда

Пример: 3

name

string

Имя конечной точки.

Возвращается: всегда

Пример: "e1"

priority

string

Приоритет этой конечной точки, когда профиль имеет routing_method=priority.

Возвращается: всегда

Пример: "3"

status

string

Статус конечной точки.

Возвращается: всегда

Пример: "Enabled"

target

string

Полностью квалифицированное доменное имя конечной точки.

Возвращается: всегда

Пример: "8.8.8.8"

target_resource_id

string

URI ресурса Azure конечной точки.

Возвращается: всегда

Пример: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ClassicCompute/dom ainNames/vscjavaci"

type

string

Тип конечной точки.

Возвращается: всегда

Пример: "external_endpoints"

weight

integer

Вес этой конечной точки, когда профиль имеет routing_method=weighted.

Возвращается: всегда

Пример: 10

местоположение

строка

Местоположение профиля Трафик Менеджер.

Возвращается: всегда

Пример: "global"

настройка_мониторинга

сложный

Настройки мониторинга конечных точек профиля Трафик Менеджер.

Возвращается: всегда

интервал

целое число

Интервал мониторинга конечных точек в этом профиле в секундах.

Возвращается: всегда

Пример: 10

путь

строка

Путь, относительный к домену конечной точки, используемый для проверки состояния конечной точки.

Возвращается: всегда

Пример: "/"

порт

целое число

TCP-порт, используемый для проверки состояния конечной точки.

Возвращается: всегда

Пример: 80

протокол

строка

Протокол HTTP, HTTPS или TCP используемый для проверки состояния конечной точки.

Возвращается: всегда

Пример: "HTTP"

таймаут

целое число

Таймаут мониторинга конечных точек в этом профиле в секундах.

Возвращается: всегда

Пример: 30

допустимые_ошибки

целое число

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

Возвращается: всегда

Пример: 3

имя

строка

Имя профиля Трафик Менеджер.

Возвращается: всегда

Пример: "testTm"
... (rest of the translated table) ...

Авторы

  • Hai Cao (@caohai)
  • Yunge Zhu (@yungezz)

Ссылки на сборку

  • Система отслеживания проблем
  • Главная страница
  • Репозиторий (источники)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_trafficmanagerprofile_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API