Spec-Zone.ru › Ansible 2.4

azure_rm_publicipaddress - Управление общедоступными IP-адресами Azure.

Новое в версии 2.1.

  • Обзор
  • Требования (к хосту, на котором выполняется модуль)
  • Параметры
  • Примеры
  • Возвращаемые значения
  • Примечания
    • Статус

Обзор

  • Создание, обновление и удаление общедоступного IP-адреса. Позволяет задавать и обновлять метод выделения адреса и метку доменного имени. Используйте модуль azure_rm_networkinterface для ассоциации общедоступного IP-адреса с сетевым интерфейсом.

Требования (к хосту, на котором выполняется модуль)

  • python >= 2.7
  • azure >= 2.0.0

Параметры

параметр обязательно по умолчанию варианты комментарии
ad_user
нет
Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с сервисным принципалом.
allocation_method
нет Dynamic
  • Dynamic
  • Static
Управление тем, остается ли назначенный общедоступный IP-адрес постоянно назначенным объекту. Если не установлено значение 'Static', IP-адрес может измениться в любой момент при перезагрузке виртуальной машины, с которой он связан.
append_tags
нет True
Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом значении любые теги, отсутствующие в параметре tags, будут удалены из метаданных объекта.
client_id
нет
Идентификатор клиента Azure. Используется при аутентификации с сервисным принципалом.
cloud_environment
нет AzureCloud
Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment), или URL-адрес конечной точки обнаружения метаданных (необходим для Azure Stack). Также может быть задан через файл профиля аутентификации или переменную среды AZURE_CLOUD_ENVIRONMENT.
domain_name_label
нет
Настраиваемая часть FQDN, назначенная общедоступному IP-адресу. Это явное значение. Если значение не указано, любое существующее значение будет удалено для существующего общедоступного IP-адреса.
алиасы: domain_name_label
location
нет местоположение группы ресурсов
Действительное расположение Azure. По умолчанию - расположение группы ресурсов.
name
да
Имя общедоступного IP-адреса.
password
нет
Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с сервисным принципалом.
profile
нет
Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group
да
Имя группы ресурсов, к которой относится общедоступный IP-адрес.
secret
нет
Секрет клиента Azure. Используется при аутентификации с сервисным принципалом.
state
нет present
  • absent
  • present
Утверждение состояния общедоступного IP-адреса. Используйте 'present' для создания или обновления, и 'absent' для удаления.
subscription_id
нет
Ваш идентификатор подписки Azure.
tags
нет
Словарь пар строка:строка, назначаемых в качестве метаданных объекту. Метаданные тегов объекта будут обновлены любыми предоставленными значениями. Чтобы удалить теги, установите опцию append_tags в значение false.
tenant
нет
Идентификатор клиента Azure. Используется при аутентификации с сервисным принципалом.

Примеры

- name: Create a public ip address
  azure_rm_publicipaddress:
    resource_group: testing
    name: my_public_ip
    allocation_method: Static
    domain_name: foobar

- name: Delete public ip
  azure_rm_publicipaddress:
    resource_group: testing
    name: my_public_ip
    state: absent

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

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

имя описание возвращается тип пример
state
Факты о текущем состоянии объекта.
всегда словарь {'dns_settings': {}, 'name': 'publicip002', 'tags': {}, 'public_ip_allocation_method': 'Static', 'provisioning_state': 'Succeeded', 'ip_address': '52.160.103.93', 'etag': '"/"a5e56955-12df-445a-bda4-dc129d22c12f"', 'location': 'westus', 'idle_timeout_in_minutes': 4, 'type': 'Microsoft.Network/publicIPAddresses'}

Примечания

Примечание

  • Для аутентификации с 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 в среде.

Статус

Этот модуль помечен как бета-версия, что означает, что его интерфейс не гарантируется совместимым с предыдущими версиями.

Для помощи в разработке модулей, если вы это сделаете, ознакомьтесь с Информация о сообществе и сотрудничество, Тестирование Ansible и Разработка модулей.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/azure_rm_publicipaddress_module.html

Spec-Zone.ru

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