azure_rm_route – Управление ресурсами маршрутизации Azure

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

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

Обзор

Создание, обновление или удаление маршрута.

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ad_user строка		Имя пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не службы-принципала.
address_prefix -		CIDR-префикс назначения, к которому применяется маршрут.
adfs_authority_url строка добавлено в 2.6		URL-адрес авторизации Azure AD. Используется при аутентификации с использованием имени пользователя/пароля и собственной авторизацией ADFS.
api_profile строка добавлено в 2.5	Значение по умолчанию: "latest"	Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию `latest` подходит для публичных облаков; будущие значения позволят использовать Azure Stack.
append_tags булево	Варианты: нет да ←	Управление тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноническом значении любые теги, отсутствующие в параметре tags, будут удалены из метаданных объекта.
auth_source строка добавлено в 2.5	Варианты: авто cli credential_file env msi	Управление источником данных для аутентификации. Если не указано, будет использована переменная среды ANSIBLE_AZURE_AUTH_SOURCE и по умолчанию установлено значение `auto` если переменная не определена. `auto` будет следовать умолчанию приоритета параметров модуля -> переменные среды -> профиль по умолчанию в файле credentials `~/.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`. Можно также задать в профиле файла credentials или переменной среды `AZURE_CERT_VALIDATION`.
client_id строка		Идентификатор клиента Azure. Используется при аутентификации с помощью службы-принципала.
cloud_environment строка добавлено в 2.4	Значение по умолчанию: "AzureCloud"	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес конечной точки обнаружения метаданных (необходимо для Azure Stack). Также может быть задан в профиле файла credentials или переменной среды `AZURE_CLOUD_ENVIRONMENT`.
name - / обязательно		Имя маршрута.
next_hop_ip_address -		IP-адрес, к которому должны передаваться пакеты. Значения next hop разрешены только в маршрутах, где тип next hop — VirtualAppliance.
next_hop_type -	Варианты: virtual_network_gateway vnet_local internet virtual_appliance none ←	Тип Azure-узла, к которому должен быть отправлен пакет.
password -		Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не службы-принципала.
profile строка		Профиль безопасности в файле ~/.azure/credentials.
resource_group - / обязательно		Имя группы ресурсов.
route_table_name - / обязательно		Имя таблицы маршрутизации.
secret строка		Секрет клиента Azure. Используется при аутентификации с помощью службы-принципала.
state -	Варианты: absent present ←	Утверждение состояния маршрута. Используйте `present` для создания или обновления и `absent` для удаления.
subscription_id строка		Идентификатор вашей подписки Azure.
tags словарь		Словарь пар "строка:строка" для назначения метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите опцию append_tags в значение false.
tenant строка		Идентификатор Azure-тенанта. Используется при аутентификации с помощью службы-принципала.

Примечания

Примечание

Для аутентификации с Azure можно передать параметры, установить переменные среды, использовать профиль, сохраненный в ~/.azure/credentials, или выполнить вход перед запуском задач или playbook с 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 a route
  azure_rm_route:
    resource_group: myResourceGroup
    name: myRoute
    address_prefix: 10.1.0.0/16
    next_hop_type: virtual_network_gateway
    route_table_name: table

- name: Delete a route
  azure_rm_route:
    resource_group: myResourceGroup
    name: myRoute
    route_table_name: table
    state: absent

Возвращаемые значения

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

Ключ	Возвращаемое значение	Описание
id строка	успех	Текущее состояние маршрута.

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [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.8/modules/azure_rm_route_module.html