google.cloud.gcp_compute_global_address модуль – Создаёт 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.
Описание
- Представляет ресурс Global Address. 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 / required | Тип используемых учетных данных. Варианты:
|
description string | Необязательное описание этого ресурса. |
env_type string | Указывает, в какой среде Ansible вы запускаете этот модуль. Это не должно устанавливаться, если вы не знаете, что делаете. Это только изменяет строку User Agent для любых запросов API. |
ip_version string | Версия IP, которая будет использоваться этим адресом. Значение по умолчанию — `IPV4`. Некоторые допустимые варианты: “IPV4”, “IPV6” |
name string / required | Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно быть длиной от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. |
network dictionary | URL сети, в которой необходимо зарезервировать диапазон IP-адресов. Диапазон IP-адресов должен находиться в пространстве RFC1918. Сеть не может быть удалена, если есть какие-либо зарезервированные диапазоны IP-адресов, ссылающиеся на нее. Это должно быть установлено только при использовании внутреннего адреса. Это поле представляет собой ссылку на ресурс сети в GCP. Его можно указать двумя способами. Во-первых, вы можете разместить словарь с ключом ‘selfLink’ и значением selfLink вашего ресурса. В качестве альтернативы вы можете добавить `register: name-of-resource` к задаче gcp_compute_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 / elements=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 строка | Статический внешний 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 или addressType=INTERNAL, когда purpose=PRIVATE_SERVICE_CONNECT. Возвращается: успешно |
purpose строка | Назначение ресурса. Возможные значения: * VPC_PEERING — для сетей-партнеров * PRIVATE_SERVICE_CONNECT — для сетей Private Service Connect (только для бета-версии). Возвращается: успешно |
region строка | Ссылка на регион, в котором находится региональный адрес. Возвращается: успешно |
Ссылки на коллекцию
© 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_module.html