Модуль google.cloud.gcp_compute_instance_info – Сбор информации о виртуальной машине GCP
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.4.1).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля требуются дополнительные зависимости. Подробности см. в разделе Требования.
Чтобы использовать его в книге задач, укажите: google.cloud.gcp_compute_instance_info.
Описание
- Сбор информации о виртуальной машине 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/compute/docs/reference/rest/v1/instances/list Каждый дополнительный фильтр в списке будет добавлен как условие И (filter1 и filter2). |
project строка | Проект Google Cloud Platform, который будет использоваться. |
scopes список / элементы=строка | Массив используемых областей видимости |
service_account_contents jsonarg | Содержимое JSON-файла учетной записи службы, либо в виде словаря, либо в виде JSON-строки, представляющей его. |
service_account_email строка | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. |
service_account_file путь | Путь к файлу JSON учетной записи службы, если тип serviceaccount выбран в качестве типа. |
zone строка / обязательно | Ссылка на зону, где находится виртуальная машина. |
Примечания
Примечание
- для аутентификации можно установить 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
gcp_compute_instance_info:
zone: us-central1-a
filters:
- name = test_object
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
resources complex | Список ресурсов Возвращается: всегда |
|
canIpForward boolean |
Позволяет этому экземпляру отправлять и получать пакеты с несовпадающими IP-адресами назначения или источника. Это необходимо, если вы планируете использовать этот экземпляр для переадресации маршрутов. Возвращается: успех |
|
confidentialInstanceConfig complex |
Конфигурация для конфиденциальных вычислений (требуется установить тип машины на любой из типов n2d-* и загрузочный диск типа pd-ssd). Возвращается: успех |
|
enableConfidentialCompute boolean |
Включает конфиденциальные вычисления. Возвращается: успех |
|
cpuPlatform string |
Платформа ЦП, используемая этим экземпляром. Возвращается: успех |
|
creationTimestamp string |
Метка времени создания в текстовом формате RFC3339. Возвращается: успех |
|
deletionProtection boolean |
Следует ли защищать ресурс от удаления. Возвращается: успех |
|
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 |
Указывает размер диска в GB (base-2). Возвращается: успех |
|
diskType string |
Ссылка на тип диска. Указывает тип диска, который будет использоваться для создания экземпляра. Если не указано, по умолчанию используется pd-standard. Возвращается: success |
|
sourceImage string |
Исходный образ для создания этого диска. При создании нового экземпляра требуется один из параметров initializeParams.sourceImage или disks.source. Для создания диска с одним из общедоступных образов операционной системы укажите образ по его семейному имени. Возвращается: success |
|
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 |
|
mode string |
Режим подключения этого диска: READ_WRITE или READ_ONLY. Если не указано, по умолчанию диск подключается в режиме READ_WRITE. Возвращается: success |
|
source dictionary |
Ссылка на диск. При создании нового экземпляра требуется один из параметров initializeParams.sourceImage или disks.source. При желании вы также можете подключить существующие непостоянные диски, не являющиеся корневыми, используя это свойство. Это поле применимо только для постоянных дисков. Возвращается: success |
|
type string |
Указывает тип диска: SCRATCH или PERSISTENT. Если не указано, по умолчанию используется PERSISTENT. Возвращается: success |
|
guestAccelerators complex |
Список типа и количества плат ускорителей, подключенных к экземпляру. Возвращается: success |
|
acceleratorCount integer |
Количество плат ускорителей, предоставляемых этому экземпляру. Возвращается: success |
|
acceleratorType string |
Полный или частичный URL ресурса типа ускорителя, предоставляемого этому экземпляру. Возвращается: success |
|
hostname string |
Имя хоста создаваемого экземпляра. Указанное имя хоста должно соответствовать RFC1035. Если имя хоста не указано, имя хоста по умолчанию — [INSTANCE_NAME].c.[PROJECT_ID].internal при использовании глобальной DNS и [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal при использовании зональной DNS. Возвращается: success |
|
id integer |
Уникальный идентификатор ресурса. Этот идентификатор определяется сервером. Возвращается: success |
|
labelFingerprint string |
Отпечаток, используемый для оптимистичной блокировки этого ресурса. Используется внутренне во время обновлений. Возвращается: success |
|
labels dictionary |
Метки для применения к этому экземпляру. Список пар ключ->значение. Возвращается: success |
|
machineType string |
Ссылка на тип машины, который определяет тип ВМ. Возвращается: success |
|
metadata dictionary |
Ключ/значение метаданных для присвоения экземплярам, созданным из этого шаблона. Эти пары могут состоять из пользовательских метаданных или предопределенных ключей. Возвращается: success |
|
minCpuPlatform string |
Указывает минимальную платформу ЦП для виртуальной машины. Допустимые значения — понятные имена платформ ЦП. Возвращено: success |
|
name string |
Имя ресурса, предоставленное клиентом при первоначальном создании ресурса. Имя ресурса должно состоять из 1–63 символов и соответствовать RFC1035. В частности, имя должно состоять из 1–63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. Возвращено: 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 для общедоступной записи 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 |
Указывает название существующей сети. Если не указать название сети, будет выбран сетевой интерфейс по умолчанию, который может иметь уже настроенный SSH. Возвращено: 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 |
|
shieldedInstanceConfig complex |
Конфигурация различных параметров, связанных с защищенными экземплярами. Возвращается: success |
|
enableIntegrityMonitoring boolean |
Определяет, включен ли для экземпляра мониторинг целостности. Возвращается: success |
|
enableSecureBoot boolean |
Определяет, включена ли для экземпляра безопасная загрузка. Возвращается: success |
|
enableVtpm boolean |
Определяет, включен ли для экземпляра vTPM. Возвращается: success |
|
status string |
Статус экземпляра. Одно из следующих значений: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED и TERMINATED. Как пользователь, используйте RUNNING, чтобы машина оставалась «включенной», и TERMINATED, чтобы выключить машину. Возвращается: success |
|
statusMessage string |
Необязательное, понятное человеку объяснение состояния. Возвращается: success |
|
tags complex |
Список тегов, которые нужно применить к этому экземпляру. Теги используются для идентификации допустимых источников или целей для сетевых брандмауэров и указываются клиентом во время создания экземпляра. Теги могут быть позже изменены с помощью метода setTags. Каждый тег в списке должен соответствовать RFC1035. Возвращается: success |
|
fingerprint string |
Указывает отпечаток для этого запроса, который по сути является хэшем содержимого метаданных и используется для оптимистичной блокировки. Отпечаток изначально генерируется Compute Engine и изменяется после каждого запроса на изменение или обновление метаданных. Вы всегда должны предоставлять актуальный хэш отпечатка для обновления или изменения метаданных. Возвращается: success |
|
items list / elements=string |
Массив тегов. Каждый тег должен иметь длину от 1 до 63 символов и соответствовать RFC1035. Возвращается: success |
|
zone string |
Ссылка на зону, в которой находится машина. Возвращается: 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_info_module.html