модуль google.cloud.gcp_compute_global_address — создание GlobalAddress в GCP
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.13.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля могут потребоваться дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в playbook, укажите: google.cloud.gcp_compute_global_address.
Краткое описание
- Представляет ресурс глобального адреса. Глобальные адреса используются для балансировки нагрузки HTTP(S).
Требования
На хосте, на котором выполняется этот модуль, должны быть установлены следующие компоненты.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен доступа OAuth2, если тип учётных данных — accesstoken. |
address string | Статический внешний IP-адрес, представленный этим ресурсом. |
address_type string | Тип резервируемого адреса. * EXTERNAL — общедоступный/внешний одиночный IP-адрес. * INTERNAL — внутренние диапазоны IP-адресов, принадлежащие какой-либо сети. Допустимые варианты: “EXTERNAL”, “INTERNAL” По умолчанию: |
auth_kind string / обязательный | Тип используемых учётных данных. Варианты:
|
description string | Необязательное описание этого ресурса. |
env_type string | Указывает, в какой среде Ansible выполняется этот модуль. Не задавайте это значение, если не знаете, что делаете. Это влияет только на строку User Agent для запросов к API. |
ip_version string | Версия IP, используемая этим адресом. Значение по умолчанию — `IPV4`. Допустимые варианты: “IPV4”, “IPV6” |
name string / обязательный | Имя ресурса. Указывается клиентом при создании ресурса. Имя должно содержать от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно содержать от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`: первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, кроме последнего символа, который не может быть дефисом. |
network dictionary | URL сети, в которой нужно зарезервировать диапазон IP-адресов. Диапазон IP-адресов должен относиться к пространству RFC1918. Сеть нельзя удалить, если на неё ссылаются какие-либо зарезервированные диапазоны IP-адресов. Это поле следует задавать только при использовании внутреннего адреса. Это поле представляет ссылку на ресурс Network в GCP. Его можно задать двумя способами. Во-первых, можно указать словарь с ключом ‘selfLink’ и значением selfLink ресурса. Также можно добавить `register: name-of-resource` в задачу gcp_compute_network, а затем задать для этого поля network значение “{{ name-of-resource }}” |
prefix_length integer | Длина префикса диапазона IP-адресов. Если значение отсутствует, поле address обозначает один IP-адрес. Это поле неприменимо к адресам с addressType=EXTERNAL или с addressType=INTERNAL, если purpose=PRIVATE_SERVICE_CONNECT. |
project string | Проект Google Cloud Platform, который следует использовать. |
purpose string | Назначение ресурса. Возможные значения: * VPC_PEERING — для пиринговых сетей * PRIVATE_SERVICE_CONNECT — для сетей Private Service Connect (только [бета-версия](https://terraform.io/docs/providers/google/guides/provider_versions.html)). |
scopes list / элементы=string | Массив используемых областей действия |
service_account_contents jsonarg | Содержимое JSON-файла учётной записи службы в виде словаря или JSON-строки, представляющей его. |
service_account_email string | Необязательный адрес электронной почты учётной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес электронной почты по умолчанию. |
service_account_file path | Путь к JSON-файлу учётной записи службы, если в качестве типа выбрано serviceaccount. |
state string | Должен ли указанный объект существовать в GCP Варианты:
|
Примечания
Примечание
- Справочник API: https://cloud.google.com/compute/docs/reference/v1/globalAddresses
- Резервирование статического внешнего IP-адреса: https://cloud.google.com/compute/docs/ip-addresses/reserve-static-external-ip-address
- Для аутентификации можно задать 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: create a global address
google.cloud.gcp_compute_global_address:
name: test_object
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Возвращаемые значения
Общие возвращаемые значения описаны здесь. Ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
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 (только [бета-версия](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_module.html