azure_rm_routetable_facts – Получение фактов о таблице маршрутизации
Новая версия с 2.7.
Обзор
- Получение фактов о конкретной таблице маршрутизации или всех таблицах маршрутизации в группе ресурсов или подписке.
Требования
Ниже перечислены требования к хосту, на котором выполняется данный модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user строка | Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с сервисным принципалом. | |
| adfs_authority_url строка добавлен в 2.6 | URL-адрес полномочий Azure AD. Используйте при аутентификации с именем пользователя/паролем, и у вас есть собственные полномочия ADFS. | |
| api_profile строка добавлен в 2.5 | Значение по умолчанию: "latest" | Выбирает профиль API для использования при общении с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. |
| auth_source строка добавлен в 2.5 |
| Управляет источником учетных данных для аутентификации. Если не указано, будет использована переменная среды ANSIBLE_AZURE_AUTH_SOURCE и по умолчанию auto если переменная не определена.auto будет следовать стандартному приоритету параметров модуля -> переменных среды -> профиля по умолчанию в файле учетных данных ~/.azure/credentials.При установке в cli, учетные данные будут взяты из профиля Azure CLI по умолчанию.Также может быть установлено через переменную среды ANSIBLE_AZURE_AUTH_SOURCE.При установке в msi, хост-машина должна быть Azure-ресурсом с включённым расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID можно использовать для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, в противном случае выбирается первая подписка.msi был добавлен в Ansible 2.6. |
| cert_validation_mode строка добавлен в 2.5 |
| Управляет поведением проверки сертификатов для Azure-точек входа. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси-сервера HTTPS или с Azure Stack, может потребоваться отключить это поведение, передав ignore. Также может быть установлено через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION. |
| client_id строка | Идентификатор клиента Azure. Используйте при аутентификации с помощью сервисного принципала. | |
| cloud_environment строка добавлен в 2.4 | Значение по умолчанию: "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, или выполнить вход до запуска задач или выполнения 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: Get facts for one route table
azure_rm_routetable_facts:
name: Testing
resource_group: myResourceGroup
- name: Get facts for all route tables
azure_rm_routetable_facts:
resource_group: myResourceGroup
- name: Get facts by tags
azure_rm_routetable_facts:
tags:
- testing
- foo:bar
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| disable_bgp_route_propagation булево | успех | Отключена ли маршрутизация по BGP в этой таблице маршрутизации. |
| id строка | успех | Идентификатор ресурса. |
| name строка | успех | Имя ресурса. |
| resource_group строка | успех | Группа ресурсов таблицы маршрутизации. |
| routes список | успех | Текущие маршруты таблицы маршрутизации. Пример: [{'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/routeTables/foobar/routes/route', 'name': 'route', 'resource_group': 'Testing', 'routeTables': 'foobar', 'address_prefix': '192.0.0.1', 'next_hop_type': 'virtual_networkGateway'}] |
| tags список | успех | Теги таблицы маршрутизации. |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- 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.8/modules/azure_rm_routetable_facts_module.html