gcp_compute_instance_template_info – Сбор информации о GCP InstanceTemplate
Новая версия 2.7.
Обзор
- Сбор информации о GCP InstanceTemplate
- Этот модуль назывался
gcp_compute_instance_template_factsдо Ansible 2.9. Способ использования не изменился.
Псевдонимы: gcp_compute_instance_template_facts
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- 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, используя переменную окружения c(gcp_service_account_file).
- для аутентификации можно установить service_account_contents, используя переменную окружения c(GCP_SERVICE_ACCOUNT_CONTENTS).
- для аутентификации можно установить service_account_email, используя переменную окружения
GCP_SERVICE_ACCOUNT_EMAIL. - для аутентификации можно установить 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-шлюза или будут установлены как следующий хоп в ресурсе маршрутизации, укажите 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 бит, закодированный в RFC 4648 base64 для шифрования или расшифровки этого ресурса. | |||||
| rsaEncryptedKey string | успех | Указывает закодированный в RFC 4648 base64 ключ шифрования, обернутый RSA, длиной 2048 бит, предоставленный пользователем, для шифрования или расшифровки этого ресурса. | |||||
| sha256 string | успех | Закодированный в RFC 4648 base64 SHA-256 хэш предоставленного пользователем ключа шифрования, защищающего этот ресурс. | |||||
| index integer | успех | Назначает индекс с нуля этому диску, где 0 зарезервирован для загрузочного диска. Например, если у экземпляра несколько присоединённых дисков, каждый диск будет иметь свой уникальный индекс. Если не указано, сервер выберет подходящее значение. | |||||
| initializeParams complex | успех | Указывает параметры для нового диска, который будет создан вместе с новым экземпляром. Используйте параметры инициализации для создания загрузочных дисков или локальных SSD, подключенных к новому экземпляру. | |||||
| diskName string | успех | Указывает имя диска. Если не указано, по умолчанию используется имя экземпляра. | |||||
| diskSizeGb integer | успех | Указывает размер диска в ГБ (с основанием 2). | |||||
| diskType string | успех | Ссылка на тип диска. Указывает тип диска для создания экземпляра. Если не указано, по умолчанию используется pd-стандарт. | |||||
| sourceImage string | успех | Образ источника для создания этого диска. При создании нового экземпляра требуется либо initializeParams.sourceImage, либо disks.source. Чтобы создать диск с одним из общедоступных образов операционной системы, укажите имя семейства образа. | |||||
| sourceImageEncryptionKey complex | успех | Ключ шифрования источника образа, предоставленный пользователем. Требуется, если образ источника защищен предоставленным пользователем ключом шифрования. Шаблоны экземпляров не хранят предоставленные пользователем ключи шифрования, поэтому вы не можете создавать диски для экземпляров в управляемой группе экземпляров, если образы источников зашифрованы вашими собственными ключами. | |||||
| rawKey string | успех | Указывает предоставленный пользователем ключ шифрования длиной 256 бит, закодированный в RFC 4648 base64 для шифрования или расшифровки этого ресурса. | |||||
| sha256 string | успех | Закодированный в RFC 4648 base64 SHA-256 хэш предоставленного пользователем ключа шифрования, защищающего этот ресурс. | |||||
| interface string | успех | Указывает интерфейс диска для подключения этого диска, который может быть SCSI или NVME. По умолчанию используется SCSI. Постоянные диски всегда должны использовать SCSI, и запрос завершится ошибкой, если вы попытаетесь подключить постоянный диск в другом формате, кроме SCSI. | |||||
| mode string | успех | Режим подключения этого диска: READ_WRITE или READ_ONLY. Если не указано, по умолчанию используется режим READ_WRITE. | |||||
| источник словарь | успех | Ссылка на диск. При создании нового экземпляра требуется один из initializeParams.sourceImage или disks.source. При необходимости можно также прикрепить существующие некорневые постоянные диски, используя это свойство. Это поле применимо только для постоянных дисков. Обратите внимание, что для InstanceTemplate укажите имя диска, а не URL диска. | |||||
| тип строка | успех | Указывает тип диска: SCRATCH или PERSISTENT. Если не указано, по умолчанию используется PERSISTENT. | |||||
| guestAccelerators сложный | успех | Список типов и количества ускорительных карт, подключенных к экземпляру. | |||||
| количествоУскорителей целое число | успех | Количество ускорительных карт гостевой системы, доступных для этого экземпляра. | |||||
| типУскорителя строка | успех | Полный или частичный URL ресурса типа ускорителя, который необходимо предоставить этому экземпляру. | |||||
| метки словарь | успех | Метки для применения к этому адресу. Список пар ключ->значение. | |||||
| типМашины строка | успех | Тип машины, который нужно использовать в шаблоне экземпляра виртуальной машины. | |||||
| метаданные словарь | успех | Ключевые пары «метаданные/значение», которые нужно назначить экземплярам, созданным из этого шаблона. Эти пары могут содержать пользовательские метаданные или предопределенные ключи. | |||||
| minCpuPlatform строка | успех | Указывает минимальную платформу процессора для экземпляра виртуальной машины. Допустимые значения — понятные имена платформ процессоров. | |||||
| сетевыеИнтерфейсы сложный | успех | Массив конфигураций для этого интерфейса. Определяет, как этот интерфейс настроен для взаимодействия с другими сетевыми службами, например, для подключения к интернету. Для каждого экземпляра поддерживается только один сетевой интерфейс. | |||||
| accessConfigs сложный | успех | Массив конфигураций для этого интерфейса. В настоящее время поддерживается только одна конфигурация доступа ONE_TO_ONE_NAT. Если конфигурации доступа accessConfigs не указаны, этот экземпляр не будет иметь внешнего доступа к интернету. | |||||
| имя строка | успех | Имя этой конфигурации доступа. Рекомендуемое имя — External NAT, но вы можете использовать любое произвольное имя. Например, Мой внешний IP-адрес или Сетевой доступ. | |||||
| natIP словарь | успех | Ссылка на адрес. Внешний IP-адрес, связанный с этим экземпляром. Укажите неиспользуемый статический внешний IP-адрес, доступный для проекта, или оставьте это поле неопределённым, чтобы использовать IP из общего пула временных IP-адресов. Если вы указываете статический внешний IP-адрес, он должен находиться в той же области, что и зона экземпляра. | |||||
| тип строка | успех | Тип конфигурации. По умолчанию и единственный вариант — ONE_TO_ONE_NAT. | |||||
| aliasIpRanges сложный | успех | Массив диапазонов IP-адресов псевдонимов для этого сетевого интерфейса. Может быть указан только для сетевых интерфейсов на сетях в режиме подсети. | |||||
| ipCidrRange строка | успех | Диапазон IP CIDR, представленный этим диапазоном псевдонимов IP. Этот диапазон IP CIDR должен принадлежать указанной подсети и не должен содержать IP-адреса, зарезервированные системой или используемые другими сетевыми интерфейсами. Этот диапазон может представлять собой один IP-адрес (например, 10.2.3.4), маску (например, /24) или строку в формате CIDR (например, 10.1.2.0/24). | |||||
| имяДиапазонаПодсети строка | успех | Необязательное имя вторичного диапазона подсети, указывающее вторичный диапазон, из которого необходимо выделить диапазон IP CIDR для этого диапазона псевдонимов IP. Если не указано, будет использован первичный диапазон подсети. | |||||
| имя строка | успех | Имя сетевого интерфейса, сгенерированное сервером. Для сетевых устройств это eth0, eth1 и т. д. | |||||
| сеть словарь | успех | Указывает заголовок существующей сети. При создании экземпляра, если ни сеть, ни подсеть не указаны, используется сеть по умолчанию global/networks/default; если сеть не указана, но указана подсеть, сеть определяется автоматически. | |||||
| сетевойIP строка | успех | Внутренний IPv4-адрес сети для назначения экземпляру для этого сетевого интерфейса. Если пользователь его не указывает, система назначает неиспользуемый внутренний IP-адрес. | |||||
| подсеть словарь | успех | Ссылка на VPC-сеть. Если ресурс сети находится в режиме «legacy», не предоставляйте это свойство. Если сеть находится в режиме автоматической подсети, предоставление подсети необязательно. Если сеть находится в режиме пользовательской подсети, это поле должно быть указано. | |||||
| планирование сложный | успех | Устанавливает параметры планирования для этого экземпляра. | |||||
| автоматическийЗапуск булево | успех | Указывает, нужно ли автоматически перезапускать экземпляр, если он был завершен Compute Engine (а не пользователем). Вы можете установить параметр автоматического перезапуска только для стандартных экземпляров. Для предварительных экземпляров автоматический перезапуск невозможен. | |||||
| приОбслуживанииХоста строка | успех | Определяет поведение при обслуживании хоста для этого экземпляра. Для стандартных экземпляров поведение по умолчанию — MIGRATE. Для предварительных экземпляров поведение по умолчанию и единственное возможное — TERMINATE. Дополнительную информацию см. в разделе Настройка параметров планирования экземпляров. | |||||
| предварительный булево | успех | Определяет, является ли экземпляр предварительным. Это можно установить только при создании экземпляра, изменить после создания экземпляра нельзя. | |||||
| serviceAccounts сложный | успех | Список учетных записей сервисов со специфицированными областями, авторизованных для этого экземпляра. Для каждого экземпляра виртуальной машины поддерживается только одна учетная запись сервиса. | |||||
| email string | success | Адрес электронной почты учетной записи службы. | |||||
| scopes list | success | Список областей, которые необходимо предоставить для этой учетной записи службы. | |||||
| tags complex | success | Список тегов, которые необходимо применить к этому экземпляру. Теги используются для определения допустимых источников или целей для сетевых брандмауэров и задаются клиентом при создании экземпляра. Позже теги можно изменить с помощью метода setTags. Каждый тег в списке должен соответствовать RFC1035. | |||||
| fingerprint string | success | Указывает отпечаток для этого запроса, который представляет собой по сути хеш содержимого метаданных и используется для оптимистической блокировки. Отпечаток первоначально генерируется Compute Engine и изменяется после каждого запроса на изменение или обновление метаданных. Для обновления или изменения метаданных вы всегда должны предоставить обновленный хеш отпечатка. | |||||
| items list | success | Массив тегов. Каждый тег должен иметь длину от 1 до 63 символов и соответствовать RFC1035. | |||||
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [preview]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Google Inc. (@googlecloudplatform)
Подсказка
Если вы заметите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/gcp_compute_instance_template_info_module.html
