google.cloud.gcp_compute_address – Создаёт адрес GCP

Примечание

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

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

Для использования в книге задач укажите: google.cloud.gcp_compute_address.

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

Обзор

Представляет ресурс типа «Адрес».
Каждый виртуальный компьютерный экземпляр имеет временный внутренний IP-адрес и, необязательно, внешний IP-адрес. Для связи между экземплярами в одной сети можно использовать внутренний IP-адрес экземпляра. Для связи с интернетом и экземплярами за пределами той же сети необходимо указать внешний IP-адрес экземпляра.
Внутренние IP-адреса временные и принадлежат экземпляру только на протяжении всего его существования; если экземпляр удаляется и создаётся заново, экземпляру назначается новый внутренний IP-адрес, либо движком Compute Engine, либо вами. Внешние IP-адреса могут быть временными или статическими.

Требования

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

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
address строка		Статический внешний IP-адрес, представленный этим ресурсом. Поддерживается только IPv4. Адрес может быть указан только для адресов типа INTERNAL. IP-адрес должен находиться в указанной подсети (если она указана).
address_type строка	По умолчанию: "EXTERNAL"	Тип адреса, который необходимо зарезервировать. Некоторые допустимые значения: "INTERNAL", "EXTERNAL"
auth_kind строка / обязательно	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
description строка		Необязательное описание этого ресурса.
env_type строка		Указывает, в какой среде Ansible выполняется этот модуль. Устанавливать это значение не рекомендуется, если вы не знаете, что делаете. Это влияет только на строку User Agent для всех запросов к API.
name строка / обязательно		Имя ресурса. Длина имени должна быть от 1 до 63 символов и соответствовать RFC1035. То есть длина должна быть от 1 до 63 символов, и имя должно соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
network_tier строка		Уровень сети, используемый для настройки этого адреса. Если это поле не указано, предполагается, что это PREMIUM. Допустимые значения: "PREMIUM", "STANDARD"
project строка		Проект Google Cloud Platform, который необходимо использовать.
purpose строка		Цель данного ресурса, которая может быть одной из следующих: - GCE_ENDPOINT для адресов, используемых виртуальными машинами, диапазонами alias IP, внутренними балансировщиками и подобными ресурсами. Устанавливать это значение следует только при использовании внутреннего адреса. Допустимые значения: "GCE_ENDPOINT"
region строка / обязательно		URL региона, в котором находится региональный адрес. Это поле не применимо к глобальным адресам.
scopes список / элементы=строка		Массив используемых областей
service_account_contents jsonarg		Содержание файла JSON учетной записи сервиса, либо в виде словаря, либо как строка JSON, которая его представляет.
service_account_email строка		Необязательный адрес электронной почты учетной записи сервиса, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь		Путь к файлу JSON учетной записи сервиса, если выбран тип serviceaccount.
state строка	Варианты: present ← absent	Должен ли данный объект существовать в GCP
subnetwork словарь		URL подсети, в которой нужно зарезервировать адрес. Если указан IP-адрес, он должен находиться в диапазоне IP-адресов подсети. Это поле может быть использовано только с типом INTERNAL и целями GCE_ENDPOINT/DNS_RESOLVER. Это поле представляет ссылку на ресурс Subnetwork в GCP. Его можно указать двумя способами. Во-первых, можно разместить словарь с ключом 'selfLink' и значением selfLink вашего ресурса. Во-вторых, можно добавить `register: имя-ресурса` к задаче gcp_compute_subnetwork, а затем установить это поле subnetwork в "{{ имя-ресурса }}"

Примечания

Примечание

Ссылка на API: https://cloud.google.com/compute/docs/reference/beta/addresses
Резервирование статического внешнего IP-адреса: https://cloud.google.com/compute/docs/instances-and-network
Резервирование статического внутреннего IP-адреса: https://cloud.google.com/compute/docs/ip-addresses/reserve-static-internal-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 address
  google.cloud.gcp_compute_address:
    name: test-address1
    region: us-west1
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

Возвращаемые значения

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

Ключ	Возвращаемое значение	Описание
address строка	успешно	Статический внешний IP-адрес, представленный этим ресурсом. Поддерживается только IPv4. Адрес может быть указан только для типов адресов INTERNAL. IP-адрес должен находиться внутри указанной подсети, если таковая есть.
addressType строка	успешно	Тип адреса для резервирования.
creationTimestamp строка	успешно	Дата и время создания в формате RFC3339.
description строка	успешно	Необязательное описание этого ресурса.
id целое число	успешно	Уникальный идентификатор ресурса.
name строка	успешно	Имя ресурса. Длина имени должна составлять от 1 до 63 символов и соответствовать RFC1035. То есть длина имени должна составлять от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
networkTier строка	успешно	Уровень сети, используемый для настройки этого адреса. Если этот параметр не указан, предполагается, что это PREMIUM.
purpose строка	успешно	Цель этого ресурса, которая может быть одной из следующих: - GCE_ENDPOINT для адресов, используемых виртуальными машинами, псевдонимами диапазонов IP-адресов, внутренними балансировщиками и аналогичными ресурсами. Этот параметр должен быть установлен только при использовании внутреннего адреса.
region строка	успешно	URL региона, в котором находится региональный адрес. Этот параметр не применим к глобальным адресам.
status строка	успешно	Статус адреса, который может быть одним из следующих: RESERVING, RESERVED или IN_USE. Адрес, который находится в состоянии RESERVING, в настоящее время резервируется. Адрес RESERVED в настоящее время зарезервирован и доступен для использования. Адрес IN_USE в настоящее время используется другим ресурсом и недоступен.
subnetwork словарь	успешно	URL подсети, в которой необходимо зарезервировать адрес. Если указан IP-адрес, он должен находиться в диапазоне IP-адресов подсети. Этот параметр может быть использован только с типом INTERNAL с целями GCE_ENDPOINT/DNS_RESOLVER.
users список / элементы=строка	успешно	URL ресурсов, которые используют этот адрес.

Авторы

Google Inc. (@googlecloudplatform)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/google/cloud/gcp_compute_address_module.html