Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию azure.azcollection (версия 2.7.0).

Возможная установка этой коллекции, если используется пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для её установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробной информации.

Для использования в playbook укажите: azure.azcollection.azure_rm_routetable_info.

Добавлена в azure.azcollection 0.1.2

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

Обзор

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

Требования

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

  • python >= 2.7
  • На хосте, где выполняется модуль, должна быть установлена коллекция azure.azcollection через galaxy
  • Все пакеты Python, перечисленные в requirements.txt коллекции, должны быть установлены через pip на хосте, который выполняет модули из azure.azcollection
  • Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection

Параметры

Параметр

Комментарии

ad_user

string

Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным субъектом безопасности.

adfs_authority_url

string

added in azure.azcollection 0.0.1

URL-адрес узла проверки подлинности Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и имеете собственный узел проверки подлинности ADFS.

api_profile

string

added in azure.azcollection 0.0.1

Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.

Default: "latest"

auth_source

string

added in azure.azcollection 0.0.1

Управляет источником учетных данных, используемых для аутентификации.

Также может быть установлен через переменную среды 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.

Варианты:

  • "auto" ← (по умолчанию)
  • "cli"
  • "credential_file"
  • "env"
  • "msi"

cert_validation_mode

string

added in azure.azcollection 0.0.1

Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или для Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть установлен через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION.

Варианты:

  • "ignore"
  • "validate"

client_id

string

Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта безопасности или управляемой идентификации (msi).

Также может быть установлен через переменную среды AZURE_CLIENT_ID.

cloud_environment

string

added in azure.azcollection 0.0.1

Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть установлен через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT.

Default: "AzureCloud"

disable_instance_discovery

boolean

added in azure.azcollection 2.3.0

Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Установка этого значения в true полностью отключит как обнаружение экземпляров, так и проверку подлинности. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя извлечение метаданных узла проверки подлинности из https://login.microsoft.com/ для проверки узла проверки подлинности. Установив это значение в **True**, проверка узла проверки подлинности отключается. В результате важно убедиться, что настроенный узел проверки подлинности действителен и заслуживает доверия.

Устанавливается через профиль файла учетных данных или переменную среды AZURE_DISABLE_INSTANCE_DISCOVERY.

Варианты:

  • false ← (по умолчанию)
  • true

log_mode

string

Родительский аргумент.

log_path

string

Родительский аргумент.

name

string

Ограничить результаты для определенной таблицы маршрутизации.

password

string

Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным субъектом безопасности.

profile

string

Профиль безопасности, найденный в файле ~/.azure/credentials.

resource_group

string

Ограничить результаты в определенной группе ресурсов.

secret

string

Секретный ключ клиента Azure. Используйте при аутентификации с помощью субъекта безопасности.

subscription_id

string

Ваш идентификатор подписки Azure.

метки

список / элементы=строка

Ограничить результаты, предоставив список меток. Форматировать метки как ‘ключ’ или ‘ключ:значение’.

арендатор

строка

Идентификатор Azure-арендатора. Используйте при аутентификации с помощью Служебного принципала.

отпечаток_ключа

строка

добавлен в azure.azcollection 1.14.0

Отпечаток частного ключа, указанного в x509_certificate_path.

Используйте при аутентификации с помощью Служебного принципала.

Требуется, если определен x509_certificate_path.

путь_к_сертификату_x509

путь

добавлен в azure.azcollection 1.14.0

Путь к сертификату X509, используемому для создания служебного принципала в формате PEM.

Сертификат должен быть присоединен к закрытому ключу.

Используйте при аутентификации с помощью Служебного принципала.

Примечания

Примечание

  • Для аутентификации с 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, в этой таблице маршрутизации.

Возвращено: success

Пример: false

id

строка

Идентификатор ресурса.

Возвращено: success

Пример: "/subscriptions/xxxx...xxxx/resourceGroups/v-xisuRG/providers/Microsoft.Network/routeTables/tableb57dc95236"

имя

строка

Имя ресурса.

Возвращено: success

Пример: "tableb57dc95236"

группа_ресурсов

строка

Группа ресурсов таблицы маршрутизации.

Возвращено: success

Пример: "v-xisuRG"

маршруты

список / элементы=строка

Текущие маршруты таблицы маршрутизации.

Возвращено: 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": null, "next_hop_type": "virtual_network_gateway", "resource_group": "v-xisuRG", "route_table_name": "tableb57dc95236"}]

метки

словарь

Метки таблицы маршрутизации.

Возвращено: success

Пример: {"key1": "value1", "key2": "value2"}

Авторы

  • Yuwei Zhou (@yuwzho)

Ссылки на сборку

  • Система отслеживания ошибок
  • Главная страница
  • Репозиторий (источники)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_routetable_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API