google.cloud.gcp_compute_global_address – Создаёт GCP GlobalAddress

Примечание

Этот плагин входит в коллекцию google.cloud (версия 1.0.2).

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

Для использования в плейбуке укажите: google.cloud.gcp_compute_global_address.

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Представляет ресурс Global Address. Global Address используются для HTTP(S) балансировки нагрузки.

Требования

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

python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
address строка		Статический внешний IP-адрес, представленный этим ресурсом.
address_type строка	По умолчанию: "EXTERNAL"	Тип адреса для резервирования. * EXTERNAL — указывает на публичный/внешний одиночный IP-адрес. * INTERNAL — указывает на внутренние IP-диапазоны, принадлежащие какой-либо сети. Допустимые значения: "EXTERNAL", "INTERNAL"
auth_kind строка / обязательно	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
description строка		Необязательное описание этого ресурса.
env_type строка		Указывает, в какой среде Ansible выполняется этот модуль. Устанавливать это значение следует только в том случае, если вы знаете, что делаете. Это влияет только на строку User Agent для всех запросов к API.
ip_version строка		Версия IP, которая будет использоваться этим адресом. Значение по умолчанию — `IPV4`. Допустимые значения: "IPV4", "IPV6"
name строка / обязательно		Имя ресурса. Предоставляется клиентом при создании ресурса. Длина имени должна составлять от 1 до 63 символов и соответствовать RFC1035. То есть, имя должно содержать от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
network словарь		URL сети, в которой необходимо зарезервировать IP-диапазон. IP-диапазон должен находиться в пространстве RFC1918. Сеть не может быть удалена, если на неё ссылаются какие-либо зарезервированные IP-диапазоны. Это поле должно быть установлено только при использовании внутреннего адреса. Это поле представляет ссылку на ресурс сети в GCP. Оно может быть указано двумя способами. Во-первых, можно поместить словарь с ключом 'selfLink' и значением selfLink вашего ресурса. Во-вторых, можно добавить `register: имя-ресурса` к задаче gcp_compute_network, а затем установить это поле network в "{{ имя-ресурса }}"
prefix_length целое число		Длина префикса IP-диапазона. Если отсутствует, это означает, что поле address представляет собой одиночный IP-адрес. Это поле не применимо к адресам с addressType=EXTERNAL.
project строка		Проект Google Cloud Platform, который необходимо использовать.
purpose строка		Цель ресурса. Для глобальных внутренних адресов может быть * VPC_PEERING — для сетей-партнёров. Это поле должно быть установлено только при использовании внутреннего адреса. Допустимые значения: "VPC_PEERING"
scopes список / элементы=строка		Массив используемых областей
service_account_contents jsonarg		Содержание файла JSON учетной записи службы, либо в виде словаря, либо как строка JSON, которая его представляет.
service_account_email строка		Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь		Путь к файлу JSON учетной записи службы, если в качестве типа выбран serviceaccount.
state строка	Варианты: present ← absent	Указывает, должен ли данный объект существовать в 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.
Для аутентификации можно установить auth_kind с помощью переменной среды GCP_AUTH_KIND.
Для аутентификации можно установить scopes с помощью переменной среды GCP_SCOPES.
Значения переменных среды будут использоваться только в том случае, если значения в плейбуке не заданы.
Параметры 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 строка	успех	Статический внешний IP-адрес, представленный этим ресурсом.
addressType строка	успех	Тип адреса для резервирования. * EXTERNAL — указывает на публичный/внешний одиночный IP-адрес. * INTERNAL — указывает на внутренние IP-диапазоны, принадлежащие какой-либо сети.
creationTimestamp строка	успех	Дата и время создания в формате RFC3339.
description строка	успех	Необязательное описание этого ресурса.
id целое число	успех	Уникальный идентификатор ресурса. Этот идентификатор задаётся сервером.
ipVersion строка	успех	Версия IP, которая будет использоваться этим адресом. Значение по умолчанию — `IPV4`.
name строка	успех	Имя ресурса. Предоставляется клиентом при создании ресурса. Длина имени должна составлять от 1 до 63 символов и соответствовать RFC1035. То есть, имя должно содержать от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
network словарь	успех	URL сети, в которой необходимо зарезервировать IP-диапазон. IP-диапазон должен находиться в пространстве RFC1918. Сеть не может быть удалена, если на неё ссылаются какие-либо зарезервированные IP-диапазоны.
prefixLength целое число	успех	Длина префикса IP-диапазона. Если отсутствует, это означает, что поле address представляет собой одиночный IP-адрес. Это поле не применимо к адресам с addressType=EXTERNAL.
purpose строка	успех	Цель ресурса. Для глобальных внутренних адресов может быть * VPC_PEERING — для сетей-партнёров.
region строка	успех	Ссылка на регион, где находится региональный адрес.

Авторы

Google Inc. (@googlecloudplatform)

© 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/google/cloud/gcp_compute_global_address_module.html