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

Примечание

Этот плагин является частью коллекции community.azure (версия 1.0.0).

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

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

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

Описание

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

Требования

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

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.
auth_source строка добавлен в 0.0.1 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 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 строка		Ограничить результаты конкретной группой ресурсов.
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
  community.azure.azure_rm_routetable_info:
    name: Testing
    resource_group: myResourceGroup

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

- name: Get facts by tags
  community.azure.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 список / элементы=строка	успех	Текущие маршруты таблицы маршрутизации. Пример: [{'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 словарь	успех	Теги таблицы маршрутизации. Пример: {'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/community/azure/azure_rm_routetable_facts_module.html