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

Примечание

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

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

Чтобы использовать его в книге задач, укажите: azure.azcollection.azure_rm_routetable_info.

Новое в версии 0.1.2: of azure.azcollection

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

Обзор

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

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ad_user строка		Имя пользователя Active Directory. Используется при аутентификации пользователем Active Directory, а не служебным принципалом.
adfs_authority_url строка добавлено в 0.0.1 of azure.azcollection		URL-адрес авторитета Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственном авторитете ADFS.
api_profile строка добавлено в 0.0.1 of azure.azcollection	Значение по умолчанию: "latest"	Выбирает профиль API для использования при общении с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
auth_source строка добавлено в 0.0.1 of 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` может использоваться для определения идентификатора подписки, если их несколько, иначе используется подписка az cli по умолчанию. При установке в `msi`, хост-машина должна быть Azure-ресурсом с включённым расширением MSI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` может использоваться для определения идентификатора подписки, если ресурс имеет доступ к нескольким подпискам, иначе выбирается первая подписка. `msi` был добавлен в Ansible 2.6.
cert_validation_mode строка добавлено в 0.0.1 of azure.azcollection	Варианты: ignore validate	Управляет поведением проверки сертификатов для Azure-узлов. По умолчанию все модули проверяют сертификат сервера, но при использовании прокси HTTPS или при работе с Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также может быть задано в профиле файла учетных данных или переменной среды `AZURE_CERT_VALIDATION`.
client_id строка		Идентификатор клиента Azure. Используется при аутентификации служебным принципалом.
cloud_environment строка добавлено в 0.0.1 of 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 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 булево	success	Выключено ли распространение маршрутов BGP в этой таблице маршрутизации.
id строка	success	Идентификатор ресурса. Пример: /subscriptions/xxxx...xxxx/resourceGroups/v-xisuRG/providers/Microsoft.Network/routeTables/tableb57dc95236
name строка	success	Имя ресурса. Пример: tableb57dc95236
resource_group строка	success	Группа ресурсов, к которой относится таблица маршрутизации. Пример: v-xisuRG
routes список / элементы=строка	success	Текущие маршруты таблицы маршрутизации. Пример: [{'address_prefix': '10.1.0.0/24', 'id': '/subscriptions/xxx...xxx/resourceGroups/v-xisuRG/providers/Microsoft.Network/routeTables/tableb57dc95236/routes/routeb57dc95540', 'name': 'routeb57dc95540', 'next_hop_ip_address': None, 'next_hop_type': 'virtual_network_gateway', 'resource_group': 'v-xisuRG', 'route_table_name': 'tableb57dc95236'}]
tags словарь	success	Теги таблицы маршрутизации. Пример: {'key1': 'value1', 'key2': 'value2'}

Авторы

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.10/collections/azure/azcollection/azure_rm_routetable_info_module.html