Модуль google.cloud.gcp_compute_instance_template_info – Сбор информации для GCP InstanceTemplate
Примечание
Этот модуль является частью коллекции google.cloud (версия 1.4.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля требуются дополнительные компоненты, см. Требования для получения подробной информации.
Для использования в playbook, укажите: google.cloud.gcp_compute_instance_template_info.
Краткое описание
- Сбор информации для GCP InstanceTemplate
Требования
Указанные ниже требования необходимы на хосте, который выполняет этот модуль.
- 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. Каждый дополнительный фильтр в списке будет добавлен как условие И (фильтр1 и фильтр2). |
project строка | Проект Google Cloud Platform для использования. |
scopes список / элементы=строка | Массив областей, которые будут использоваться |
service_account_contents jsonarg | Содержимое файла Service Account JSON, либо в виде словаря, либо в виде представляющей его JSON-строки. |
service_account_email строка | Необязательный адрес электронной почты учетной записи сервисного аккаунта, если выбран machineaccount, и пользователь не хочет использовать адрес электронной почты по умолчанию. |
service_account_file путь | Путь к файлу Service Account 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. - Значения переменных среды будут использоваться только в том случае, если значения playbook не установлены.
- Параметры 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 |
Указывает закодированный в base64 RFC 4648, обернутый RSA 2048-битный ключ шифрования, предоставленный клиентом, для шифрования или расшифровки этого ресурса. Возвращается: успех |
|
sha256 string |
Закодированный в base64 RFC 4648 хэш SHA-256 ключа шифрования, предоставленного клиентом, который защищает этот ресурс. Возвращается: успех |
|
index integer |
Присваивает этому диску индекс, начинающийся с нуля, где 0 зарезервировано для загрузочного диска. Например, если у вас много дисков, подключенных к экземпляру, каждый диск будет иметь уникальный порядковый номер. Если не указано, сервер выберет подходящее значение. Возвращается: успех |
|
initializeParams complex |
Указывает параметры для нового диска, который будет создан вместе с новым экземпляром. Используйте параметры инициализации для создания загрузочных дисков или локальных SSD-дисков, подключенных к новому экземпляру. Возвращается: успех |
|
diskName string |
Указывает имя диска. Если не указано, по умолчанию используется имя экземпляра. Возвращается: успех |
|
diskSizeGb integer |
Указывает размер диска в базовых-2 ГБ. Возвращается: успех |
|
diskType string |
Ссылка на тип диска. Указывает тип диска, который нужно использовать для создания экземпляра. Если не указано, по умолчанию используется pd-standard. Возвращается: успех |
|
sourceImage string |
Исходный образ для создания этого диска. При создании нового экземпляра требуется один из initializeParams.sourceImage или disks.source. Чтобы создать диск с одним из общедоступных образов операционной системы, укажите образ по его семейному имени. Возвращается: успех |
|
sourceImageEncryptionKey complex |
Ключ шифрования исходного образа, предоставленный клиентом. Требуется, если исходный образ защищен ключом шифрования, предоставленным клиентом. Шаблоны экземпляров не хранят ключи шифрования, предоставленные клиентом, поэтому вы не можете создавать диски для экземпляров в управляемой группе экземпляров, если исходные образы зашифрованы вашими собственными ключами. Возвращается: success |
|
rawKey string |
Указывает 256-битный ключ шифрования, предоставленный клиентом, закодированный в base64 в соответствии с RFC 4648, для шифрования или расшифровки этого ресурса. Возвращается: success |
|
sha256 string |
Хэш SHA-256, закодированный в base64 в соответствии с RFC 4648, ключа шифрования, предоставленного клиентом, который защищает этот ресурс. Возвращается: success |
|
interface string |
Указывает используемый интерфейс диска для подключения этого диска, который является либо SCSI, либо NVME. По умолчанию используется SCSI. Постоянные диски всегда должны использовать SCSI, и запрос завершится неудачей, если вы попытаетесь подключить постоянный диск в любом другом формате, кроме SCSI. Возвращается: success |
|
licenses list / elements=string |
Любой применимый URI лицензии. Возвращается: success |
|
mode string |
Режим подключения этого диска: READ_WRITE или READ_ONLY. Если не указано, по умолчанию диск подключается в режиме READ_WRITE. Возвращается: success |
|
source dictionary |
Ссылка на диск. При создании нового экземпляра требуется один из параметров initializeParams.sourceImage или disks.source. При желании вы также можете подключить существующие непостоянные диски, не являющиеся корневыми, используя это свойство. Это поле применимо только для постоянных дисков. Обратите внимание, что для InstanceTemplate необходимо указать имя диска, а не URL-адрес диска. Возвращается: success |
|
type string |
Указывает тип диска: SCRATCH или PERSISTENT. Если не указано, по умолчанию используется PERSISTENT. Возвращается: success |
|
guestAccelerators complex |
Список типа и количества плат ускорителей, подключенных к экземпляру. Возвращается: success |
|
acceleratorCount integer |
Количество плат ускорителей гостевой системы, доступных этому экземпляру. Возвращается: success |
|
acceleratorType string |
Полный или частичный URL-адрес ресурса типа ускорителя, доступного этому экземпляру. Возвращается: success |
|
labels dictionary |
Метки для применения к этому адресу. Список пар ключ->значение. Возвращается: success |
|
machineType string |
Тип машины, используемый в шаблоне экземпляра виртуальной машины. Возвращается: success |
|
metadata dictionary |
Ключ/значение метаданных для присвоения экземплярам, созданным из этого шаблона. Эти пары могут состоять из пользовательских метаданных или предопределенных ключей. Возвращается: success |
|
minCpuPlatform string |
Указывает минимальную платформу ЦП для экземпляра виртуальной машины. Допустимые значения - это понятные имена платформ ЦП. Возвращается: success |
|
networkInterfaces complex |
Массив конфигураций для этого интерфейса. Это указывает, как этот интерфейс настроен для взаимодействия с другими сетевыми службами, например, для подключения к Интернету. Поддерживается только один сетевой интерфейс на экземпляр. Возвращается: success |
|
accessConfigs complex |
Массив конфигураций для этого интерфейса. В настоящее время поддерживается только одна конфигурация доступа, ONE_TO_ONE_NAT. Если конфигурации accessConfigs не указаны, этот экземпляр не будет иметь внешнего доступа к Интернету. Возвращается: success |
|
name string |
Имя этой конфигурации доступа. Имя по умолчанию и рекомендуемое имя - External NAT, но вы можете использовать любую произвольную строку. Например, My external IP или Network Access. Возвращается: success |
|
natIP dictionary |
Ссылка на адрес. Внешний IP-адрес, связанный с этим экземпляром. Укажите неиспользуемый статический внешний IP-адрес, доступный для проекта, или оставьте это поле неопределенным, чтобы использовать IP-адрес из общего пула эфемерных IP-адресов. Если вы указываете статический внешний IP-адрес, он должен находиться в том же регионе, что и зона экземпляра. Возвращается: success |
|
networkTier string |
Это обозначает уровень сети, используемый для настройки этой конфигурации доступа. Если AccessConfig указан без допустимого внешнего IP-адреса, эфемерный IP-адрес будет создан с этим networkTier. Если указан AccessConfig с допустимым внешним IP-адресом, он должен соответствовать networkTier, связанному с ресурсом Address, владеющим этим IP-адресом. Возвращается: success |
|
publicPtrDomainName string |
Доменное имя DNS для записи public PTR. Вы можете установить это поле только в том случае, если поле setPublicPtr включено. Возвращается: success |
|
setPublicPtr boolean |
Указывает, следует ли создавать общедоступную DNS PTR-запись для сопоставления внешнего IP-адреса экземпляра с именем DNS-домена. Возвращено: success |
|
type string |
Тип конфигурации. Единственный и параметр по умолчанию - ONE_TO_ONE_NAT. Возвращено: success |
|
aliasIpRanges complex |
Массив диапазонов псевдонимов IP-адресов для этого сетевого интерфейса. Может быть указан только для сетевых интерфейсов в сетях в режиме подсети. Возвращено: success |
|
ipCidrRange string |
Диапазон IP CIDR, представленный этим диапазоном псевдонимов IP-адресов. Этот диапазон IP CIDR должен принадлежать указанной подсети и не может содержать IP-адреса, зарезервированные системой или используемые другими сетевыми интерфейсами. Этот диапазон может быть одним IP-адресом (например, 10.2.3.4), маской сети (например, /24) или строкой в формате CIDR (например, 10.1.2.0/24). Возвращено: success |
|
subnetworkRangeName string |
Необязательное имя вторичного диапазона подсети, указывающее вторичный диапазон, из которого следует выделять диапазон IP CIDR для этого диапазона псевдонимов IP-адресов. Если не указано, будет использоваться основной диапазон подсети. Возвращено: success |
|
name string |
Имя сетевого интерфейса, генерируемое сервером. Для сетевых устройств это eth0, eth1 и т.д. Возвращено: success |
|
network dictionary |
Указывает название существующей сети. При создании экземпляра, если не указана ни сеть, ни подсеть, используется сеть по умолчанию global/networks/default; если сеть не указана, но указана подсеть, сеть определяется неявно. Возвращено: success |
|
networkIP string |
Внутренний сетевой адрес IPv4 для назначения экземпляру для этого сетевого интерфейса. Если не указано пользователем, системой назначается неиспользуемый внутренний IP-адрес. Возвращено: success |
|
subnetwork dictionary |
Ссылка на сеть VPC. Если ресурс сети находится в режиме legacy, не указывайте это свойство. Если сеть находится в режиме автоматической подсети, указание подсети является необязательным. Если сеть находится в режиме пользовательской подсети, это поле должно быть указано. Возвращено: success |
|
scheduling complex |
Задает параметры планирования для этого экземпляра. Возвращено: success |
|
automaticRestart boolean |
Указывает, следует ли автоматически перезапускать экземпляр, если он завершен Compute Engine (не завершен пользователем). Вы можете установить параметр автоматического перезапуска только для стандартных экземпляров. Прерывистые экземпляры не могут быть автоматически перезапущены. Возвращено: success |
|
onHostMaintenance string |
Определяет поведение обслуживания для этого экземпляра. Для стандартных экземпляров поведение по умолчанию - MIGRATE. Для прерывистых экземпляров поведение по умолчанию и единственно возможное - TERMINATE. Дополнительные сведения см. в разделе Настройка параметров планирования экземпляров. Возвращено: success |
|
preemptible boolean |
Определяет, является ли экземпляр прерывистым. Это может быть установлено только во время создания экземпляра, его нельзя установить или изменить после создания экземпляра. Возвращено: success |
|
serviceAccounts complex |
Список учетных записей служб с указанными областями, авторизованными для этого экземпляра. Поддерживается только одна учетная запись службы на виртуальный экземпляр. Возвращено: success |
|
string |
Электронный адрес учетной записи службы. Возвращено: success |
|
scopes list / elements=string |
Список областей, которые должны быть доступны для этой учетной записи службы. Возвращено: success |
|
tags complex |
Список тегов для применения к этому экземпляру. Теги используются для идентификации допустимых источников или целей для сетевых брандмауэров и указываются клиентом во время создания экземпляра. Теги могут быть позже изменены с помощью метода setTags. Каждый тег в списке должен соответствовать RFC1035. Возвращено: success |
|
fingerprint string |
Указывает отпечаток для этого запроса, который по сути является хешем содержимого метаданных и используется для оптимистичной блокировки. Отпечаток изначально генерируется Compute Engine и изменяется после каждого запроса на изменение или обновление метаданных. Вы всегда должны предоставлять актуальный хеш отпечатка для обновления или изменения метаданных. Возвращено: success |
|
items list / elements=string |
Массив тегов. Каждый тег должен иметь длину от 1 до 63 символов и соответствовать RFC1035. Возвращено: success |
Ссылки на коллекцию
© 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_instance_template_info_module.html