Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

Введено в azure.azcollection 0.1.2

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

Обзор

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

Требования

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

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

api_profile

string

added in azure.azcollection 0.0.1

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

Default: "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.

Default: "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

log_mode

string

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

log_path

string

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

name

string

Показывать результаты только для определенного общедоступного IP-адреса.

password

string

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

profile

string

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

resource_group

string

Ограничить результаты по группе ресурсов. Требуется при использовании параметра name.

secret

string

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

subscription_id

string

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

метки

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

Ограничить результаты, указав список меток. Форматировать метки как ‘ключ’ или ‘ключ:значение’.

арендатор

строка

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

отпечаток пальца

строка

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

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

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

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

путь_к_сертификату_x509

путь

добавлен в 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: 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
    tags:
      - key:value

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

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

Ключ

Описание

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": null}

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"

зоны

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

Список зон доступности, указывающий, из какой зоны IP-адрес должен быть выделен для нужд ресурса.

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

Пример: ["1", "2"]

Авторы

  • Крис Хаускнект (@chouseknecht)
  • Мэтт Дэвис (@nitzmahone)

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

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

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

Spec-Zone.ru

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