azure.azcollection.azure_rm_route_info – Получение информации о маршруте

Примечание

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

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

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

Новое в версии 2.0.0: из azure.azcollection

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

Описание

Получить информацию о маршруте.

Требования

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

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 логический тип	Варианты: no да ←	Управляет тем, является ли поле тегов стандартным или оно просто добавляется к существующим тегам. В случае стандартного тега все теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
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` может быть использована для определения идентификатора подписки, если их несколько, в противном случае используется подписка по умолчанию 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 строка / обязательно		Имя группы ресурсов.
route_table_name строка / обязательно		Имя таблицы маршрутизации.
secret строка		Секрет клиента Azure. Используйте при аутентификации с принципалом службы.
subscription_id строка		Идентификатор вашей подписки Azure.
tags словарь		Словарь пар "строка:строка" для задания метаданных объекта. Метаданные теги объекта будут обновлены всеми предоставленными значениями. Для удаления тегов установите параметр append_tags в значение false.
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 route
  azure_rm_route_info:
    resource_group: myResourceGroup
    name: routename
    route_table_name: routetabename


- name: List routes
  azure_rm_route_info:
    resource_group: myResourceGroup
    route_table_name: routetabename

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

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

Ключ		Возвращаемое	Описание
routes сложный тип		всегда	Список результатов словарей, где ключ — имя маршрута, а значения — факты для этого маршрута.
	address_prefix строка	всегда	CIDR назначения, к которому применяется маршрут. Пример: 10.0.0.0/25
	etag строка	всегда	Уникальная неизменяемая строка, которая меняется при каждом обновлении ресурса. Пример: fda240c5-6f42-4eb0-8f05-b1599dc722fe
	id строка	всегда	Идентификатор ресурса. Пример: /subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/routeTables/table01/routes/route01
	name строка	всегда	Имя ресурса, уникальное в пределах группы ресурсов. Это имя может быть использовано для доступа к ресурсу. Пример: route01
	next_hop_ip_address строка	всегда	IP-адрес, к которому должны перенаправляться пакеты. Значения Next hop допустимы только в маршрутах, где тип next hop — VirtualAppliance. Пример: 10.0.0.0
	next_hop_type строка	всегда	Тип Azure-узла, к которому должен быть отправлен пакет. Пример: VirtualAppliance
	provisioning_state строка	всегда	Состояние подготовки ресурса маршрута. Пример: Успешно

Авторы

GuopengLin (@t-glin)
Fred-Sun (@Fred-Sun)
Haiyuan Zhang (@haiyuazhang)

© 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_route_info_module.html