Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_virtualhubconnection — Управление экземпляром Azure VirtualHub

Примечание

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

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

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

Чтобы использовать его в playbook, укажите: azure.azcollection.azure_rm_virtualhubconnection.

Новый в azure.azcollection 1.14.0

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

Описание

  • Создание, обновление и удаление экземпляра Azure VirtualHub.

Требования

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

  • 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.

allow_hub_to_remote_vnet_transit

boolean

Включить или отключить транзит VirtualHub в RemoteVnet.

Варианты:

  • false
  • true

allow_remote_vnet_to_use_hub_vnet_gateways

boolean

Разрешить RemoteVnet использовать шлюзы Virtual Hub.

Варианты:

  • false
  • true

api_profile

string

added in azure.azcollection 0.0.1

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

По умолчанию: "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.

По умолчанию: "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

enable_internet_security

boolean

Включить безопасность интернета.

Варианты:

  • false
  • true

log_mode

string

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

log_path

string

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

name

string / required

Имя подключения VirtualHub.

password

string

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

profile

строка

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

remote_virtual_network

словарь

Идентификатор удалённой виртуальной сети для подключения.

id

строка

Идентификатор удалённой виртуальной сети.

resource_group

строка / обязательно

Имя группы ресурсов VirtualHub.

routing_configuration

словарь

Настройка маршрутизации, указывающая связанные и распространяемые таблицы маршрутизации в этом подключении.

propagated_route_tables

словарь

Список таблиц маршрутизации, которым следует рекламировать маршруты.

ids

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

-Список идентификаторов ресурсов всех таблиц маршрутизации виртуального узла.

id

строка

Идентификатор таблицы маршрутизации.

labels

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

Список меток.

vnet_routes

словарь

Список маршрутов, управляющих маршрутизацией из VirtualHub в подключение виртуальной сети.

static_routes

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

Список всех статических маршрутов.

address_prefixes

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

Список всех префиксов адресов.

name

строка

Имя StaticRoute, уникальное в рамках VnetRoute.

next_hop_ip_address

строка

IP-адрес следующего узла.

secret

строка

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

state

строка

Утвердить состояние подключения VirtualHub.

Используйте present для создания или обновления подключения VirtualHub и absent для его удаления.

Варианты:

  • "absent"
  • "present" ← (по умолчанию)

subscription_id

строка

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

tenant

строка

Идентификатор Azure-аренды. Используется при аутентификации с помощью сервисного принципала.

thumbprint

строка

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

Отпечаток цифрового ключа, указанного в x509_certificate_path.

Используется при аутентификации с помощью сервисного принципала.

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

vhub_name

строка / обязательно

Имя VirtualHub.

x509_certificate_path

путь

добавлено в 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: Create virtual hub connection
  azure_rm_virtualhubconnection:
    resource_group: myRG
    vhub_name: testhub
    name: Myconnection
    enable_internet_security: false
    allow_remote_vnet_to_use_hub_vnet_gateways: true
    allow_hub_to_remote_vnet_transit: true
    remote_virtual_network:
      id: /subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/testvnet
    routing_configuration:
      propagated_route_tables:
        labels:
          - labels1
          - labels3
        ids:
          - id: /subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Network/virtualHubs/testhub01/hubRouteTables/testtable
      vnet_routes:
        static_routes:
          - name: route1
            address_prefixes:
              - 10.1.0.0/16
              - 10.2.0.0/16
            next_hop_ip_address: 10.0.0.68
          - name: route2
            address_prefixes:
              - 10.4.0.0/16
            next_hop_ip_address: 10.0.0.65

- name: Delete virtual hub connection
  azure_rm_virtualhubconnection:
    resource_group: myRG
    vhub_name: testhub
    name: Myconnection
    state: absent

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

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

Ключ

Описание

state

сложный

Список результатов в формате словарей для информации о подключении виртуального концентратора.

Возвращается: всегда

allow_hub_to_remote_vnet_transit

булево

Включить транзит концентратора в удаленную сеть VNet.

Возвращается: всегда

Пример: true

allow_remote_vnet_to_use_hub_vnet_gateways

булево

Разрешить удаленной сети VNet использовать шлюзы сети VNet концентратора.

Возвращается: всегда

Пример: true

enable_internet_security

булево

Включить безопасность интернета, по умолчанию включено.

Возвращается: всегда

Пример: true

etag

строка

Уникальная для чтения строка, изменяющаяся при каждом обновлении ресурса.

Возвращается: всегда

Пример: "31102041-49e7-4cac-8573-aac1e1a16793"

id

строка

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

Возвращается: всегда

Пример: "/subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Network/virtualHubs/vhub/hubVirtualNetworkConnections/MyConnection"

name

строка

Имя ресурса.

Возвращается: всегда

Пример: "MyConnection"

provisioning_state

строка

Состояние подготовки ресурса подключения к виртуальному концентратору.

Возвращается: всегда

Пример: "Succeeded"

remote_virtual_network

сложный

Имя или идентификатор удаленной сети VNet для подключения.

Возвращается: всегда

id

строка

Идентификатор удаленной сети VNet для подключения.

Возвращается: всегда

Пример: "/subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/testvnet"

routing_configuration

сложный

Информация о конфигурации маршрутизации

Возвращается: всегда

associated_route_table

сложный

Идентификатор ресурса таблицы маршрутизации, связанной с этой конфигурацией маршрутизации.

Возвращается: всегда

id

строка

Идентификатор таблицы маршрутизации.

Возвращается: всегда

Пример: "/subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Network/virtualHubs/testhub/hubRouteTables/rt_name"

propagated_route_tables

сложный

Список идентификаторов ресурсов таблиц маршрутизации, прошедших распространение, разделенные пробелами.

Возвращается: всегда

ids

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

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

Возвращается: всегда

Пример: [{"id": "/subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Network/virtualHubs/testhub/hubRouteTables/rt_name"}]

labels

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

Список меток для прошедших распространение таблиц маршрутизации, разделенные пробелами.

Возвращается: всегда

Пример: ["labels1", "labels2"]

vnet_routes

сложный

Имя статического маршрута, уникального в рамках маршрута Vnet.

Возвращается: всегда

static_routes

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

Имя статического маршрута.

Возвращается: всегда

address_prefixes

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

Список адресов-префиксов, разделенных пробелами.

Возвращается: всегда

Пример: ["10.1.0.0/16", "10.2.0.0/16"]

name

строка

Имя статического маршрутизатора.

Возвращается: всегда

Пример: "route1"

next_hop_ip_address

строка

Адрес следующей переадресации.

Возвращается: всегда

Пример: "10.0.0.65"

Авторы

  • Fred-Sun (@Fred-Sun)
  • Xu Zhang (@xuzhang3)

Ссылки на коллекцию

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

© 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_virtualhubconnection_module.html

Spec-Zone.ru

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