google.cloud.gcp_compute_instance_template_info – Сбор информации для GCP InstanceTemplate
Примечание
Этот плагин входит в коллекцию google.cloud (версия 1.0.2).
Для его установки используйте: 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
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. |
| env_type строка | Указывает, в какой среде Ansible выполняется этот модуль. Не устанавливайте это значение, если вы не знаете, что делаете. Это изменяет только строку User Agent для всех запросов к API. | |
| filters список / элементы=строка | Список пар значений фильтров. Доступные фильтры перечислены здесь https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке будет добавлен как условие И (filter1 и 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. - для аутентификации можно установить 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-шлюза или будут установлены как следующий хоп в ресурсе маршрута, укажите 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 | успех | Указывает размер диска в GB в двоичной системе. | |||||
| diskType string | успех | Ссылка на тип диска. Указывает тип диска, который нужно использовать для создания экземпляра. Если не указано, по умолчанию используется pd-standard. | |||||
| sourceImage string | успех | Источник образа для создания этого диска. При создании нового экземпляра требуется одно из значений initializeParams.sourceImage или disks.source. Для создания диска с одним из общедоступных образов операционных систем укажите имя семейства образа. | |||||
| sourceImageEncryptionKey complex | успех | Ключ шифрования, предоставленный клиентом, для исходного образа. Требуется, если исходный образ защищен ключом шифрования, предоставленным клиентом. Шаблоны экземпляров не хранят ключи шифрования, предоставленные клиентом, поэтому вы не можете создать диски для экземпляров в управляемой группе экземпляров, если исходные образы зашифрованы вашими собственными ключами. | |||||
| rawKey string | успех | Указывает 256-битный предоставленный клиентом ключ шифрования, закодированный в base64 RFC 4648, для шифрования или дешифрования этого ресурса. | |||||
| sha256 string | успех | Закодированный в base64 RFC 4648 SHA-256 хэш предоставленного клиентом ключа шифрования, защищающего этот ресурс. | |||||
| 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 | success | Количество карт гостевых ускорителей, экспонированных для этого экземпляра. | |||||
| acceleratorType string | success | Полный или частичный URL ресурса типа ускорителя, который необходимо экспонировать для этого экземпляра. | |||||
| labels dictionary | success | Метки для применения к этому адресу. Список пар ключ-значение. | |||||
| machineType string | success | Тип машины для использования в шаблоне виртуальной машины. | |||||
| metadata dictionary | success | Пары ключ/значение метаданных, которые необходимо назначить экземплярам, созданным из этого шаблона. Эти пары могут содержать пользовательские метаданные или предопределённые ключи. | |||||
| minCpuPlatform string | success | Указывает минимальную платформу процессора для виртуального экземпляра. Применимые значения — это дружественные имена платформ процессоров. | |||||
| networkInterfaces complex | success | Массив конфигураций для этого интерфейса. Это определяет, как этот интерфейс настроен для взаимодействия с другими сетевыми службами, например, для подключения к интернету. Поддерживается только один сетевой интерфейс на экземпляр. | |||||
| accessConfigs complex | success | Массив конфигураций для этого интерфейса. В настоящее время поддерживается только одна конфигурация доступа ONE_TO_ONE_NAT. Если конфигурации доступа не указаны, у этого экземпляра не будет внешнего доступа к интернету. | |||||
| name string | success | Имя этой конфигурации доступа. Рекомендуемое имя — External NAT, но вы можете использовать любое произвольное строковое значение. Например, My external IP или Network Access. | |||||
| natIP dictionary | success | Ссылка на адрес. Внешний IP-адрес, связанный с этим экземпляром. Укажите неиспользуемый статический внешний IP-адрес, доступный для проекта, или оставьте это поле неопределённым, чтобы использовать IP из общего пула временных IP-адресов. Если вы указываете статический внешний IP-адрес, он должен находиться в той же области, что и зона экземпляра. | |||||
| networkTier string | success | Это обозначает сетевой уровень, используемый для настройки этой конфигурации доступа. Если конфигурация доступа указана без действительного внешнего IP-адреса, будет создан временный IP с этим сетевым уровнем. Если указана конфигурация доступа с действительным внешним IP-адресом, она должна совпадать с сетевым уровнем ресурса «Адрес», владеющего этим IP. | |||||
| publicPtrDomainName string | success | Доменное имя DNS для записи PTR для публичного адреса. Вы можете установить это поле только в том случае, если поле setPublicPtr включено. | |||||
| setPublicPtr boolean | success | Определяет, необходимо ли создавать запись DNS PTR для публичного адреса, чтобы сопоставить внешний IP-адрес экземпляра с доменным именем. | |||||
| type string | success | Тип конфигурации. По умолчанию и единственный вариант — ONE_TO_ONE_NAT. | |||||
| aliasIpRanges complex | success | Массив диапазонов IP-адресов псевдонимов для этого сетевого интерфейса. Может быть указан только для сетевых интерфейсов на сетях в режиме подсети. | |||||
| ipCidrRange string | success | Диапазон IP CIDR, представленный этим диапазоном псевдонимных IP-адресов. Этот диапазон IP CIDR должен принадлежать указанной подсети и не может содержать IP-адреса, зарезервированные системой или используемые другими сетевыми интерфейсами. Этот диапазон может быть одним IP-адресом (например, 10.2.3.4), маской сети (например, /24) или строкой в формате CIDR (например, 10.1.2.0/24). | |||||
| subnetworkRangeName string | success | Необязательное имя вторичного диапазона подсети, указывающее вторичный диапазон, из которого нужно выделить диапазон IP CIDR для этого диапазона псевдонимных IP-адресов. Если он не указан, будет использоваться основной диапазон подсети. | |||||
| name string | success | Имя сетевого интерфейса, сгенерированное сервером. Для сетевых устройств это eth0, eth1 и т. д. | |||||
| network dictionary | success | Указывает название существующей сети. При создании экземпляра, если сеть или подсеть не указаны, используется сеть по умолчанию global/networks/default; если сеть не указана, но указана подсеть, сеть определяется неявно. | |||||
| networkIP string | success | Внутренний IPv4-адрес сети, который нужно назначить экземпляру для этого сетевого интерфейса. Если пользователь не указывает, система назначает неиспользуемый внутренний IP-адрес. | |||||
| subnetwork dictionary | success | Ссылка на сеть VPC. Если ресурс сети в режиме «legacy», не указывайте это свойство. Если сеть в режиме автоматической подсети, указание подсети необязательно. Если сеть в режиме настраиваемой подсети, это поле должно быть указано. | |||||
| scheduling complex | success | Устанавливает параметры планирования для этого экземпляра. | |||||
| automaticRestart boolean | success | Определяет, должен ли экземпляр автоматически перезапускаться, если он был завершён Compute Engine (а не пользователем). Вы можете установить параметр автоматического перезапуска только для стандартных экземпляров. Для предварительно назначенных экземпляров автоматический перезапуск невозможен. | |||||
| onHostMaintenance string | success | Определяет поведение при обслуживании хоста для этого экземпляра. Для стандартных экземпляров поведение по умолчанию — MIGRATE. Для предварительно назначенных экземпляров поведение по умолчанию и единственное возможное поведение — TERMINATE. Дополнительную информацию см. в разделе Установка параметров планирования экземпляров. | |||||
| preemptible boolean | success | Определяет, является ли экземпляр предварительно назначенным. Это можно задать только при создании экземпляра, оно не может быть задано или изменено после создания экземпляра. | |||||
| serviceAccounts complex | success | Список учётных записей сервисов с указанными разрешениями, авторизованными для этого экземпляра. Поддерживается только одна учётная запись сервиса на виртуальный экземпляр. | |||||
| email string | success | Электронный адрес учётной записи сервиса. | |||||
| scopes list / elements=string | success | Список разрешений, которые будут доступны для этой учётной записи сервиса. | |||||
| теги сложный | успех | Список тегов, применяемых к этому экземпляру. Теги используются для идентификации допустимых источников или целей сетевых брандмауэров и указываются клиентом при создании экземпляра. Теги могут быть изменены позднее методом setTags. Каждый тег в списке должен соответствовать RFC1035. | |||||
| отпечаток строка | успех | Указывает отпечаток для этого запроса, представляющий собой по сути хеш содержимого метаданных и используемый для оптимистической блокировки. Отпечаток первоначально генерируется Compute Engine и изменяется после каждого запроса на изменение или обновление метаданных. Для обновления или изменения метаданных вы всегда должны предоставить актуальный хеш отпечатка. | |||||
| элементы список / элементы=строка | успех | Массив тегов. Каждый тег должен иметь длину от 1 до 63 символов и соответствовать RFC1035. | |||||
Авторы
- Google Inc. (@googlecloudplatform)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/google/cloud/gcp_compute_instance_template_info_module.html
