Spec-Zone.ru › Ansible 2.7

azure_rm_routetable – Управление ресурсом таблицы маршрутизации Azure.

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

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

Обзор

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

Требования

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

  • python >= 2.7
  • azure >= 2.0.0

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
ad_user
-
Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы.
adfs_authority_url
-
добавлено в 2.6
По умолчанию:
null
URL-адрес службы Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственной службой ADFS.
api_profile
-
добавлено в 2.5
По умолчанию:
"latest"
Выбирает профиль API для взаимодействия с сервисами Azure. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
append_tags
boolean
    Варианты:
  • нет
  • да ←
Управляет тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом формате любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта.
auth_source
-
добавлено в 2.5
    Варианты:
  • auto
  • cli
  • credential_file
  • env
  • msi
Управляет источником учетных данных для аутентификации.
Если не указано, используется переменная среды ANSIBLE_AZURE_AUTH_SOURCE, и по умолчанию будет auto если переменная не определена.
auto будет следовать стандартному приоритету параметров модуля -> переменных среды -> профиля по умолчанию в файле учетных данных ~/.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
    Варианты:
  • validate
  • ignore
Управляет поведением проверки сертификатов для конечных точек Azure. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси HTTPS или с Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть установлена через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION.
client_id
-
Идентификатор клиента Azure. Используйте при аутентификации с принципалом службы.
cloud_environment
-
добавлено в 2.4
По умолчанию:
"AzureCloud"
Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment), или URL-адрес конечной точки обнаружения метаданных (необходим для Azure Stack). Также может быть установлен через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT.
disable_bgp_route_propagation
boolean
    Варианты:
  • нет ←
  • да
Указывает, следует ли отключить маршрутизацию, полученную по BGP в этой таблице маршрутизации.
location
-
Регион ресурса.
Выводится из resource_group если не указано.
name
- / обязательно
Имя таблицы маршрутизации.
password
-
Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы.
profile
-
Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group
- / обязательно
Имя группы ресурсов.
secret
-
Секрет клиента Azure. Используйте при аутентификации с принципалом службы.
state
-
    Варианты:
  • absent
  • present ←
Утверждает состояние таблицы маршрутизации. Используйте 'present' для создания или обновления и 'absent' для удаления.
subscription_id
-
Ваш идентификатор подписки Azure.
tags
-
Словарь пар строка:строка для назначения метаданных объекту. Метаданные-теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в false.
tenant
-
Идентификатор арендатора Azure. Используйте при аутентификации с принципалом службы.

Примечания

Примечание

  • Для аутентификации с Azure вы можете передавать параметры, устанавливать переменные среды или использовать профиль, хранящийся в ~/.azure/credentials. Аутентификация возможна с использованием принципала службы или пользователя 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 в среде.

Примеры

- name: Create a route table
  azure_rm_routetable:
    name: foobar
    resource_group: Testing
    disable_bgp_route_propagation: False
    tags:
      purpose: testing

- name: Update the subnet (idempotent)
  azure_rm_subnet:
    name: subnet
    virtual_network_name: virtualnetwork
    resource_group: Testing
    address_prefix_cidr: "10.1.0.0/16"
    route_table: foobar

- name: Delete a route table
  azure_rm_routetable:
    name: foobar
    resource_group: Testing
    state: absent

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

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

Ключ Возвращаемое значение Описание
changed
boolean
всегда
Изменился ли ресурс.

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



Статус

  • Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
  • Этот модуль поддерживается сообществом 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.7/modules/azure_rm_routetable_module.html

Spec-Zone.ru

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