Модуль google.cloud.gcp_compute_instance_template_info — сбор сведений об InstanceTemplate GCP
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.13.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: google.cloud.gcp_compute_instance_template_info.
Обзор
- Сбор сведений об InstanceTemplate GCP
Требования
Следующие требования должны быть выполнены на хосте, выполняющем этот модуль.
- 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. Каждый дополнительный фильтр в списке будет добавлен как условие AND (filter1 and 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. - Значения переменных среды используются только в том случае, если значения не заданы в плейбуке.
- Параметры service_account_email и service_account_file являются взаимоисключающими.
Примеры
- name: get info on an instance template
gcp_compute_instance_template_info:
filters:
- name = test_object
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
resources complex | Список ресурсов Возвращается: всегда |
|
creationTimestamp string |
Временная метка создания в текстовом формате RFC3339. Возвращается: при успехе |
|
description string |
Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. Возвращается: при успехе |
|
id integer |
Уникальный идентификатор ресурса. Этот идентификатор задается сервером. Возвращается: при успехе |
|
name string |
Имя ресурса. Имя должно содержать от 1 до 63 символов и соответствовать RFC1035. Возвращается: при успехе |
|
properties complex |
Свойства экземпляра для этого шаблона экземпляра. Возвращается: при успехе |
|
canIpForward boolean |
Разрешает экземплярам, созданным на основе этого шаблона, отправлять пакеты с исходными IP-адресами, отличными от их собственных, и получать пакеты с IP-адресами назначения, отличными от их собственных. Если эти экземпляры будут использоваться в качестве IP-шлюза или указываться как следующий переход в ресурсе Route, задайте значение true. Если вы не уверены, оставьте значение false. Возвращается: при успехе |
|
description string |
Необязательное текстовое описание экземпляров, создаваемых на основе этого шаблона экземпляра. Возвращается: при успехе |
|
disks complex |
Массив дисков, связанных с экземплярами, создаваемыми на основе этого шаблона. Возвращается: при успехе |
|
autoDelete boolean |
Определяет, будет ли диск автоматически удаляться при удалении экземпляра (но не при отсоединении диска от экземпляра). Совет: для дисков следует задавать autoDelete=true, чтобы после удаления машины не оставались неиспользуемые диски. Возвращается: при успехе |
|
boot boolean |
Указывает, что это загрузочный диск. Виртуальная машина будет использовать первый раздел диска в качестве корневой файловой системы. Возвращается: при успехе |
|
deviceName string |
Задает уникальное имя устройства на ваш выбор, которое отображается в дереве /dev/disk/by-id/google-* операционной системы Linux, работающей внутри экземпляра. Это имя можно использовать внутри экземпляра для обращения к устройству, например при его монтировании или изменении размера. Возвращается: при успехе |
|
diskEncryptionKey complex |
Шифрует или расшифровывает диск с помощью предоставленного пользователем ключа шифрования. Возвращается: при успехе |
|
rawKey string |
Задает предоставленный пользователем 256-битный ключ шифрования в кодировке base64 по RFC 4648 для шифрования или расшифровки этого ресурса. Возвращается: при успехе |
|
rsaEncryptedKey string |
Задает предоставленный пользователем 2048-битный ключ шифрования, обернутый RSA и закодированный в base64 по RFC 4648, для шифрования или расшифровки этого ресурса. Возвращается: при успехе |
|
sha256 string |
Хеш SHA-256 предоставленного пользователем ключа шифрования, защищающего этот ресурс, закодированный в base64 по RFC 4648. Возвращается: при успехе |
|
index integer |
Назначает этому диску индекс, начинающийся с нуля; значение 0 зарезервировано для загрузочного диска. Например, если к экземпляру подключено несколько дисков, у каждого будет уникальный номер индекса. Если значение не указано, сервер выберет подходящее. Возвращается: при успехе |
|
initializeParams complex |
Задает параметры нового диска, который будет создан вместе с новым экземпляром. Используйте параметры инициализации для создания загрузочных дисков или локальных SSD, подключаемых к новому экземпляру. Возвращается: при успехе |
|
diskName string |
Задает имя диска. Если оно не указано, по умолчанию используется имя экземпляра. Возвращается: при успехе |
|
diskSizeGb integer |
Задает размер диска в ГБ (степенях двойки). Возвращается: при успехе |
|
diskType string |
Ссылка на тип диска. Задает тип диска, используемого для создания экземпляра. Если значение не указано, по умолчанию используется pd-standard. Возвращается: при успехе |
|
sourceImage string |
Исходный образ для создания этого диска. При создании нового экземпляра необходимо указать либо initializeParams.sourceImage, либо disks.source. Чтобы создать диск на основе одного из общедоступных образов операционных систем, укажите образ по имени семейства. Возвращается: при успехе |
|
sourceImageEncryptionKey complex |
Предоставленный пользователем ключ шифрования исходного образа. Обязателен, если исходный образ защищен ключом шифрования, предоставленным пользователем. Шаблоны экземпляров не хранят предоставленные пользователем ключи шифрования, поэтому нельзя создавать диски для экземпляров в управляемой группе экземпляров, если исходные образы зашифрованы вашими собственными ключами. Возвращается: при успехе |
|
rawKey string |
Задает предоставленный пользователем 256-битный ключ шифрования в кодировке base64 по RFC 4648 для шифрования или расшифровки этого ресурса. Возвращается: при успехе |
|
sha256 string |
Хеш SHA-256 предоставленного пользователем ключа шифрования, защищающего этот ресурс, закодированный в base64 по RFC 4648. Возвращается: при успехе |
|
interface string |
Задает интерфейс диска для его подключения: SCSI или NVME. По умолчанию используется SCSI. Для постоянных дисков всегда необходимо использовать SCSI; запрос завершится ошибкой, если попытаться подключить постоянный диск в формате, отличном от SCSI. Возвращается: при успехе |
|
licenses list / elements=string |
Все применимые URI лицензий. Возвращается: при успехе |
|
mode string |
Режим подключения диска: READ_WRITE или READ_ONLY. Если значение не указано, по умолчанию диск подключается в режиме READ_WRITE. Возвращается: при успехе |
|
source dictionary |
Ссылка на диск. При создании нового экземпляра необходимо указать либо initializeParams.sourceImage, либо disks.source. При необходимости с помощью этого свойства можно также подключить существующие постоянные диски, не являющиеся корневыми. Это поле применимо только к постоянным дискам. Обратите внимание: для InstanceTemplate укажите имя диска, а не его URL. Возвращается: при успехе |
|
type string |
Задает тип диска: SCRATCH или PERSISTENT. Если значение не указано, по умолчанию используется PERSISTENT. Возвращается: при успехе |
|
guestAccelerators complex |
Список типов и количества ускорительных карт, подключенных к экземпляру. Возвращается: при успехе |
|
acceleratorCount integer |
Количество ускорительных карт, доступных этому экземпляру. Возвращается: при успехе |
|
acceleratorType string |
Полный или частичный URL ресурса типа ускорителя, доступного этому экземпляру. Возвращается: при успехе |
|
labels dictionary |
Метки, назначаемые этому адресу. Список пар «ключ->значение». Возвращается: при успехе |
|
machineType string |
Тип машины, используемый в шаблоне экземпляра виртуальной машины. Возвращается: при успехе |
|
metadata dictionary |
Пары ключ/значение метаданных, назначаемые экземплярам, создаваемым на основе этого шаблона. Эти пары могут содержать пользовательские метаданные или предопределенные ключи. Возвращается: при успехе |
|
minCpuPlatform string |
Задает минимальную платформу CPU для экземпляра виртуальной машины. Допустимые значения — понятные названия платформ CPU. Возвращается: при успехе |
|
networkInterfaces complex |
Массив конфигураций этого интерфейса. Здесь указывается, как интерфейс взаимодействует с другими сетевыми службами, например подключается к интернету. Для каждого экземпляра поддерживается только один сетевой интерфейс. Возвращается: при успехе |
|
accessConfigs complex |
Массив конфигураций этого интерфейса. В настоящее время поддерживается только одна конфигурация доступа — ONE_TO_ONE_NAT. Если accessConfigs не указаны, у экземпляра не будет внешнего доступа к интернету. Возвращается: при успехе |
|
name string |
Имя этой конфигурации доступа. По умолчанию рекомендуется использовать External NAT, но можно указать любую произвольную строку, например My external IP или Network Access. Возвращается: при успехе |
|
natIP dictionary |
Ссылка на адрес. Внешний IP-адрес, связанный с этим экземпляром. Укажите неиспользуемый статический внешний IP-адрес, доступный проекту, или оставьте это поле незаполненным, чтобы использовать IP-адрес из общего пула эфемерных IP-адресов. Если указан статический внешний IP-адрес, он должен находиться в том же регионе, что и зона экземпляра. Возвращается: при успехе |
|
networkTier string |
Указывает уровень сети, используемый для настройки этой конфигурации доступа. Если указана AccessConfig без действительного внешнего IP-адреса, для нее будет создан эфемерный IP-адрес с этим уровнем сети. Если указана AccessConfig с действительным внешним IP-адресом, его уровень сети должен совпадать с уровнем сети ресурса Address, которому принадлежит этот IP-адрес. Возвращается: при успехе |
|
publicPtrDomainName string |
Доменное имя DNS для общедоступной записи PTR. Это поле можно задать, только если включено поле setPublicPtr. Возвращается: при успехе |
|
setPublicPtr boolean |
Указывает, следует ли создать общедоступную запись DNS PTR, сопоставляющую внешний IP-адрес экземпляра с доменным именем DNS. Возвращается: при успехе |
|
type string |
Тип конфигурации. По умолчанию и как единственный вариант используется ONE_TO_ONE_NAT. Возвращается: при успехе |
|
aliasIpRanges complex |
Массив диапазонов псевдонимов IP-адресов для этого сетевого интерфейса. Их можно указывать только для сетевых интерфейсов в сетях с режимом подсетей. Возвращается: при успехе |
|
ipCidrRange string |
Диапазон IP CIDR, представленный этим диапазоном псевдонимов IP-адресов. Этот диапазон IP CIDR должен принадлежать указанной подсети и не может содержать IP-адреса, зарезервированные системой или используемые другими сетевыми интерфейсами. Диапазон может представлять собой один IP-адрес (например, 10.2.3.4), маску сети (например, /24) или строку в формате CIDR (например, 10.1.2.0/24). Возвращается: при успехе |
|
subnetworkRangeName string |
Необязательное имя дополнительного диапазона подсети, указывающее дополнительный диапазон, из которого выделяется диапазон IP CIDR для этого диапазона псевдонимов IP. Если не указано, будет использоваться основной диапазон подсети. Возвращается: при успехе |
|
name string |
Имя сетевого интерфейса, сгенерированное сервером. Для сетевых устройств используются имена eth0, eth1 и т. д. Возвращается: при успехе |
|
network dictionary |
Указывает имя существующей сети. При создании экземпляра, если не указаны ни сеть, ни подсеть, используется сеть по умолчанию global/networks/default; если сеть не указана, но указана подсеть, сеть определяется автоматически. Возвращается: при успехе |
|
networkIP string |
Внутренний сетевой адрес IPv4, назначаемый экземпляру для этого сетевого интерфейса. Если пользователь не указал адрес, система назначает неиспользуемый внутренний IP-адрес. Возвращается: при успехе |
|
subnetwork dictionary |
Ссылка на сеть VPC. Если ресурс сети работает в устаревшем режиме, не указывайте это свойство. Если сеть работает в режиме автоматических подсетей, указывать подсеть необязательно. Если сеть работает в режиме пользовательских подсетей, это поле необходимо указать. Возвращается: при успехе |
|
scheduling complex |
Задает параметры планирования для этого экземпляра. Возвращается: при успехе |
|
automaticRestart boolean |
Указывает, следует ли автоматически перезапускать экземпляр, если он завершен Compute Engine (а не пользователем). Параметр автоматического перезапуска можно задать только для стандартных экземпляров. Прерываемые экземпляры нельзя перезапускать автоматически. Возвращается: при успехе |
|
onHostMaintenance string |
Определяет поведение этого экземпляра во время обслуживания. Для стандартных экземпляров по умолчанию используется поведение MIGRATE. Для прерываемых экземпляров по умолчанию используется единственное возможное поведение — TERMINATE. Дополнительные сведения см. в разделе «Настройка параметров планирования экземпляра». Возвращается: при успехе |
|
preemptible boolean |
Определяет, является ли экземпляр прерываемым. Это можно задать только при создании экземпляра; после его создания задать или изменить это значение нельзя. Возвращается: при успехе |
|
serviceAccounts complex |
Список учетных записей служб с указанными для них областями доступа, которым разрешено работать с этим экземпляром. Для каждого экземпляра виртуальной машины поддерживается только одна учетная запись службы. Возвращается: при успехе |
|
string |
Возвращается: при успехе |
|
scopes list / elements=string |
Список областей доступа, которые будут доступны этой учетной записи службы. Возвращается: при успехе |
|
tags complex |
Список тегов, применяемых к этому экземпляру. Теги используются для идентификации допустимых источников или целей сетевых брандмауэров и указываются клиентом при создании экземпляра. Позже теги можно изменить с помощью метода setTags. Каждый тег в списке должен соответствовать RFC1035. Возвращается: при успехе |
|
fingerprint string |
Указывает отпечаток для этого запроса — по сути, хеш содержимого метаданных, используемый для оптимистической блокировки. Изначально отпечаток создается Compute Engine и меняется после каждого запроса на изменение или обновление метаданных. Для обновления или изменения метаданных необходимо всегда указывать актуальный хеш отпечатка. Возвращается: при успехе |
|
tag_values list / elements=string |
Массив тегов. Длина каждого тега должна составлять от 1 до 63 символов, а сам тег должен соответствовать RFC1035. Возвращается: при успехе |
Ссылки на коллекцию
© 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_instance_template_info_module.html