Модуль google.cloud.gcp_compute_global_address_info – Сбор информации о GCP GlobalAddress
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.4.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.
Чтобы использовать его в playbook, укажите: google.cloud.gcp_compute_global_address_info.
Описание
- Сбор информации о GCP GlobalAddress
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен доступа OAuth2, если тип учетных данных — accesstoken. |
auth_kind строка / обязательно | Тип используемых учетных данных. Варианты:
|
env_type строка | Указывает, в какой среде Ansible выполняется этот модуль. Необходимо устанавливать только в случае необходимости. Это изменяет только строку User Agent для всех запросов API. |
filters список / элементы=строка | Список пар значений фильтра. Доступные фильтры перечислены здесь https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке будет добавлен как условие И (filter1 и filter2). |
project строка | Проект Google Cloud Platform, который использовать. |
scopes список / элементы=строка | Массив используемых областей |
service_account_contents jsonarg | Содержимое JSON-файла учетной записи службы, либо в виде словаря, либо как JSON-строка, его представляющая. |
service_account_email строка | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию. |
service_account_file путь | Путь к файлу 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. - Значения переменных среды будут использоваться только в том случае, если значения playbook не заданы.
- Параметры 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 — для ([Beta](https://terraform.io/docs/providers/google/guides/provider_versions.html) только) сетей Private Service Connect. Возвращаемое значение: успех |
|
region string |
Ссылка на регион, в котором находится региональный адрес. Возвращаемое значение: успех |
Ссылки на сборку
© 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/google/cloud/gcp_compute_global_address_info_module.html
