модуль google.cloud.gcp_compute_global_address_info — Сбор сведений о GCP GlobalAddress
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.13.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля требуются дополнительные компоненты. Подробнее см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: google.cloud.gcp_compute_global_address_info.
Обзор
- Сбор сведений о GCP GlobalAddress
Требования
На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен доступа OAuth2, если выбран тип учётных данных accesstoken. |
auth_kind string / обязательно | Тип используемых учётных данных. Варианты:
|
env_type string | Указывает, в какой среде Ansible выполняется этот модуль. Не задавайте этот параметр, если не уверены в своих действиях. Он изменяет только строку User Agent для всех запросов к API. |
filters list / элементы=string | Список пар значений фильтров. Доступные фильтры перечислены здесь: https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке добавляется как условие AND (filter1 and filter2). |
project string | Проект Google Cloud Platform, который будет использоваться. |
scopes list / элементы=string | Массив используемых областей действия |
service_account_contents jsonarg | Содержимое JSON-файла сервисного аккаунта — в виде словаря или JSON-строки, представляющей его. |
service_account_email string | Необязательный адрес электронной почты сервисного аккаунта, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию. |
service_account_file path | Путь к JSON-файлу сервисного аккаунта, если в качестве типа выбрано serviceaccount. |
Примечания
Примечание
- для аутентификации можно задать service_account_file с помощью переменной среды
GCP_SERVICE_ACCOUNT_FILE. - для аутентификации можно задать service_account_contents с помощью переменной среды
GCP_SERVICE_ACCOUNT_CONTENTS. - Для аутентификации можно задать service_account_email с помощью переменной среды
GCP_SERVICE_ACCOUNT_EMAIL. - Для аутентификации можно задать access_token с помощью переменной среды
GCP_ACCESS_TOKEN. - Для аутентификации можно задать auth_kind с помощью переменной среды
GCP_AUTH_KIND. - Для аутентификации можно задать scopes с помощью переменной среды
GCP_SCOPES. - Значения переменных среды будут использоваться, только если значения не заданы в плейбуке.
- Параметры service_account_email и service_account_file являются взаимоисключающими.
Примеры
- name: get info on a global address
gcp_compute_global_address_info:
filters:
- name = test_object
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
Возвращаемые значения
Общие возвращаемые значения описаны здесь. Ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
resources complex | Список ресурсов Возвращается: всегда |
|
address string |
Статический внешний IP-адрес, представленный этим ресурсом. Возвращается: при успехе |
|
addressType string |
Тип резервируемого адреса. * EXTERNAL означает общедоступный/внешний одиночный IP-адрес. * INTERNAL означает внутренние диапазоны IP-адресов, принадлежащие какой-либо сети. Возвращается: при успехе |
|
creationTimestamp string |
Временная метка создания в текстовом формате RFC3339. Возвращается: при успехе |
|
description string |
Необязательное описание этого ресурса. Возвращается: при успехе |
|
id integer |
Уникальный идентификатор ресурса. Этот идентификатор задаётся сервером. Возвращается: при успехе |
|
ipVersion string |
Версия IP, используемая этим адресом. Значение по умолчанию — `IPV4`. Возвращается: при успехе |
|
name string |
Имя ресурса. Задаётся клиентом при создании ресурса. Имя должно содержать от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно содержать от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`: первый символ должен быть строчной латинской буквой, а все последующие символы — дефисом, строчной латинской буквой или цифрой, за исключением последнего символа, который не может быть дефисом. Возвращается: при успехе |
|
network dictionary |
URL сети, в которой резервируется диапазон IP-адресов. Диапазон IP-адресов должен входить в пространство RFC1918. Сеть нельзя удалить, если на неё ссылаются какие-либо зарезервированные диапазоны IP-адресов. Этот параметр следует задавать только при использовании внутреннего адреса. Возвращается: при успехе |
|
prefixLength integer |
Длина префикса диапазона IP-адресов. Если значение отсутствует, это означает, что поле address содержит один IP-адрес. Это поле неприменимо к адресам с addressType=EXTERNAL или addressType=INTERNAL, если purpose=PRIVATE_SERVICE_CONNECT. Возвращается: при успехе |
|
purpose string |
Назначение ресурса. Возможные значения: * VPC_PEERING — для пиринговых сетей; * PRIVATE_SERVICE_CONNECT — для сетей Private Service Connect (только [Beta](https://terraform.io/docs/providers/google/guides/provider_versions.html)). Возвращается: при успехе |
|
region string |
Ссылка на регион, в котором находится региональный адрес. Возвращается: при успехе |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/google/cloud/gcp_compute_global_address_info_module.html
