Spec-Zone.ru › Ansible 2.11

azure.azcollection.azure_rm_publicipaddress_info – Получение фактов о публичных IP-адресах

Примечание

Этот плагин является частью коллекции azure.azcollection (версия 1.4.0).

Для его установки используйте: ansible-galaxy collection install azure.azcollection.

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

Новое в версии 0.1.2: из azure.azcollection

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

Обзор

  • Получение фактов о конкретном публичном IP-адресе или всех публичных IP-адресах в группе ресурсов.

Требования

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

  • python >= 2.7
  • azure >= 2.0.0

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
ad_user
строка
Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо службы.
adfs_authority_url
строка
добавлено в 0.0.1 azure.azcollection
URL-адрес авторитета Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственным авторитетом ADFS.
api_profile
строка
добавлено в 0.0.1 azure.azcollection
Значение по умолчанию:
"latest"
Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
auth_source
строка
добавлено в 0.0.1 azure.azcollection
    Варианты:
  • auto ←
  • cli
  • credential_file
  • env
  • msi
Управляет источником учетных данных для аутентификации.
Также может быть задан через переменную среды ANSIBLE_AZURE_AUTH_SOURCE.
При значении auto (по умолчанию) приоритет имеет:
модульные параметры -> env -> credential_file -> cli.
При значении env, учетные данные будут считываться из переменных среды.
При значении credential_file, профиль будет считываться из ~/.azure/credentials.
При значении cli, учетные данные будут взяты из профиля Azure CLI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут быть использованы для определения идентификатора подписки, если их несколько, в противном случае используется по умолчанию подписка Azure CLI.
При значении msi, хост-машина должна быть Azure-ресурсом с включенным расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут быть использованы для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, в противном случае выбирается первая подписка.
Ключ msi был добавлен в Ansible 2.6.
cert_validation_mode
строка
добавлено в 0.0.1 azure.azcollection
    Варианты:
  • ignore
  • validate
Управляет поведением проверки сертификатов для Azure-точек конечного доступа. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси HTTPS или работе с Azure Stack может потребоваться отключить это поведение, передав ignore. Также можно задать через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION.
client_id
строка
Идентификатор клиента Azure. Используется при аутентификации с помощью службы.
cloud_environment
строка
добавлено в 0.0.1 azure.azcollection
Значение по умолчанию:
"AzureCloud"
Для облачных сред, отличных от общедоступного облака США, используется имя среды (определённое Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес конечной точки обнаружения метаданных (необходим для Azure Stack). Также может быть задан через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT.
name
строка
Показывать результаты только для определённого публичного IP-адреса.
password
строка
Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо службы.
profile
строка
Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group
строка
Ограничить результаты по группе ресурсов. Требуется при использовании параметра name.
secret
строка
Секрет клиента Azure. Используется при аутентификации с помощью службы.
subscription_id
строка
Ваш идентификатор подписки Azure.
tags
строка
Ограничить результаты, предоставив список тегов. Формат тегов — 'ключ' или 'ключ:значение'.
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: Get facts for one Public IP
  azure_rm_publicipaddress_info:
    resource_group: myResourceGroup
    name: publicip001

- name: Get facts for all Public IPs within a resource groups
  azure_rm_publicipaddress_info:
    resource_group: myResourceGroup

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

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

Ключ Возвращаемое значение Описание
azure_publicipaddresses
список / элементы=строка
всегда
Список словарей с общедоступными IP-адресами.
Обратите внимание, что этот параметр будет устаревшим в версии 2.10, когда структурированный формат станет единственным поддерживаемым форматом.

Пример:
[{'etag': 'W/"a31a6d7d-cb18-40a5-b16d-9f4a36c1b18a"', 'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/publicIPAddresses/pip2001', 'location': 'eastus2', 'name': 'pip2001', 'properties': {'idleTimeoutInMinutes': 4, 'provisioningState': 'Succeeded', 'publicIPAllocationMethod': 'Dynamic', 'resourceGuid': '29de82f4-a7da-440e-bd3d-9cabb79af95a'}, 'type': 'Microsoft.Network/publicIPAddresses'}]
publicipaddresses
сложный
всегда
Список общедоступных IP-адресов.
Содержит подробности, соответствующие параметрам azure_rm_publicipaddress.
Возвращается, когда параметр формата установлен на структурированный.
allocation_method
строка
всегда
Метод распределения общедоступного IP-адреса.
Возможные значения — static и dynamic.

Пример:
static
dns_settings
словарь
всегда
FQDN записи DNS, связанной с общедоступным IP-адресом.

Пример:
{'domain_name_label': 'ansible-b57dc95985712e45eb8b9c2e', 'fqdn': 'ansible-b57dc95985712e45eb8b9c2e.eastus.cloudapp.azure.com', 'reverse_fqdn': None}
etag
строка
всегда
Уникальная неизменяемая строка, которая изменяется при каждом обновлении ресурса.

Пример:
W/'1905ee13-7623-45b1-bc6b-4a12b2fb9d15'
id
строка
всегда
Идентификатор ресурса.

Пример:
/subscriptions/xxx---xxxxx/resourceGroups/v-xisuRG/providers/Microsoft.Network/publicIPAddresses/pipb57dc95224
idle_timeout
целое число
всегда
Тайм-аут бездействия общедоступного IP-адреса.

Пример:
4
ip_address
строка
всегда
Префикс общедоступного IP-адреса, из которого должен быть выделен этот общедоступный IP-адрес.

Пример:
40.121.144.14
ip_tags
список / элементы=строка
всегда
Список тегов, связанных с общедоступным IP-адресом.

Пример:
[{'type': 'FirstPartyUsage', 'value': 'Storage'}]
location
строка
всегда
Расположение ресурса.

Пример:
eastus
name
строка
всегда
Имя общедоступного IP-адреса.

Пример:
pipb57dc95224
provisioning_state
строка
всегда
Состояние подготовки ресурса PublicIP.
Возможные значения — Succeeded.

Пример:
Succeeded
sku
строка
всегда
SKU общедоступного IP-адреса.

Пример:
Basic
tags
словарь
всегда
Теги ресурса.

Пример:
{'delete': 'on-exit', 'testing': 'testing'}
type
строка
всегда
Тип ресурса.

Пример:
Microsoft.Network/publicIPAddresses
version
строка
всегда
Версия общедоступного IP-адреса.
Возможные значения — ipv4 и ipv6.

Пример:
ipv4


Авторы

  • Chris Houseknecht (@chouseknecht)
  • Matt Davis (@nitzmahone)

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

Spec-Zone.ru

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