azure_rm_routetable_info – Получение фактов о таблице маршрутизации

Новая версия 2.9.

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

Описание

Получение фактов о конкретной таблице маршрутизации или всех таблицах маршрутизации в группе ресурсов или подписке.

Псевдонимы: azure_rm_routetable_facts

Требования

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

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	Варианты: auto cli credential_file env msi	Управляет источником учетных данных для аутентификации. Если не указано, используется переменная среды 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	Варианты: ignore validate	Управляет поведением проверки сертификатов для 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, или войти в систему перед выполнением задач или игры с помощью 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_info:
    name: Testing
    resource_group: myResourceGroup

- name: Get facts for all route tables
  azure_rm_routetable_info:
    resource_group: myResourceGroup

- name: Get facts by tags
  azure_rm_routetable_info:
    tags:
      - testing
      - foo:bar

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

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

Ключ	Возвращаемое значение	Описание
disable_bgp_route_propagation логический тип	успех	Отключены ли маршруты, полученные с помощью BGP в этой таблице маршрутизации.
id строка	успех	Идентификатор ресурса. Пример: /subscriptions/xxxx...xxxx/resourceGroups/v-xisuRG/providers/Microsoft.Network/routeTables/tableb57dc95236
name строка	успех	Имя ресурса. Пример: tableb57dc95236
resource_group строка	успех	Группа ресурсов таблицы маршрутизации. Пример: v-xisuRG
routes список	успех	Текущие маршруты таблицы маршрутизации. Пример: [{'id': '/subscriptions/xxx...xxx/resourceGroups/v-xisuRG/providers/Microsoft.Network/routeTables/tableb57dc95236/routes/routeb57dc95540', 'name': 'routeb57dc95540', 'resource_group': 'v-xisuRG', 'route_table_name': 'tableb57dc95236', 'address_prefix': '10.1.0.0/24', 'next_hop_type': 'virtual_network_gateway', 'next_hop_ip_address': None}]
tags словарь	успех	Теги таблицы маршрутизации. Пример: {'key1': 'value1', 'key2': 'value2'}

Статус

Данный модуль не гарантирует обратной совместимости интерфейса. [preview]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

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.9/modules/azure_rm_routetable_info_module.html