gcp_compute_instance_template_facts – Сбор фактов для GCP InstanceTemplate
Новая версия 2.7.
Обзор
- Сбор фактов для GCP InstanceTemplate
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind - / обязательно |
| Тип используемых учетных данных. |
| filters - | Список пар значений фильтров. Доступные фильтры перечислены здесь https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке будет добавлен как условие И (filter1 и filter2) | |
| project - | Значение по умолчанию: null | Проект Google Cloud Platform для использования. |
| scopes - | Массив используемых областей. | |
| service_account_email - | Дополнительный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. | |
| service_account_file - | Путь к файлу JSON учетной записи службы, если тип serviceaccount выбран как тип. |
Примечания
Примечание
- Для аутентификации можно установить service_account_file с помощью переменной среды
GCP_SERVICE_ACCOUNT_FILE. - Для аутентификации можно установить service_account_email с помощью переменной среды
GCP_SERVICE_ACCOUNT_EMAIL. - Для аутентификации можно установить auth_kind с помощью переменной среды
GCP_AUTH_KIND. - Для аутентификации можно установить scopes с помощью переменной среды
GCP_SCOPES. - Значения переменных среды будут использованы только в том случае, если значения в руководстве не заданы.
- Параметры service_account_email и service_account_file взаимоисключают друг друга.
Примеры
- name: a instance template facts
gcp_compute_instance_template_facts:
filters:
- name = test_object
project: test_project
auth_kind: service_account
service_account_file: "/tmp/auth.pem"
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | |||||
|---|---|---|---|---|---|---|---|
| items сложный | всегда | Список элементов | |||||
| creation_timestamp строка | успешно | Маркер создания в формате RFC3339. | |||||
| description строка | успешно | Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. | |||||
| id целое число | успешно | Уникальный идентификатор ресурса. Этот идентификатор определен сервером. | |||||
| name строка | успешно | Имя ресурса. Длина имени составляет от 1 до 63 символов и соответствует RFC1035. | |||||
| properties сложный | успешно | Свойства экземпляра для этой шаблона экземпляра. | |||||
| can_ip_forward логический | успешно | Разрешает экземплярам, созданным на основе этого шаблона, отправлять пакеты с исходными IP-адресами, отличными от их собственных, и принимать пакеты с целевыми IP-адресами, отличными от их собственных. Если эти экземпляры будут использоваться в качестве IP-шлюза или будут установлены как следующий узел в ресурсе маршрута, укажите true. Если не уверены, оставьте значение false. | |||||
| description строка | успешно | Необязательное текстовое описание для экземпляров, созданных из этого шаблона экземпляра. | |||||
| disks сложный | успешно | Массив дисков, связанных с экземплярами, созданными из этого шаблона. | |||||
| auto_delete логический | успешно | Указывает, будет ли диск автоматически удален при удалении экземпляра (но не при отделении диска от экземпляра). Подсказка: Диски должны быть настроены autoDelete=true, чтобы не оставлять ненужные диски при удалении машины. | |||||
| boot логический | успешно | Указывает, что это загрузочный диск. Виртуальная машина будет использовать первый раздел диска в качестве корневой файловой системы. | |||||
| device_name строка | успешно | Указывает уникальное имя устройства по вашему выбору, которое отражается в дереве /dev/disk/by-id/google-* операционной системы Linux, работающей внутри экземпляра. Это имя можно использовать для ссылки на устройство для монтирования, изменения размера и т. д. изнутри экземпляра. | |||||
| disk_encryption_key сложный | успешно | Шифрует или расшифровывает диск с помощью предоставленного клиентом ключа шифрования. | |||||
| raw_key строка | успешно | Указывает 256-битный предоставленный клиентом ключ шифрования, закодированный в base64 RFC 4648 для шифрования или расшифрования этого ресурса. | |||||
| rsa_encrypted_key строка | успешно | Указывает закодированный в base64 RFC 4648, обернутый RSA ключ шифрования 2048-бит, предоставленный клиентом, для шифрования или расшифрования этого ресурса. | |||||
| sha256 строка | успешно | Закодированный в base64 RFC 4648 SHA-256 хеш предоставленного клиентом ключа шифрования, защищающего этот ресурс. | |||||
| index целое число | успешно | Присваивает индекс с нулевым смещением этому диску, где 0 зарезервирован для загрузочного диска. Например, если к экземпляру подключено несколько дисков, каждый диск будет иметь уникальный индекс. Если не указано, сервер выберет соответствующее значение. | |||||
| initialize_params сложный | успешно | Указывает параметры для нового диска, который будет создан вместе с новым экземпляром. Используйте параметры инициализации для создания загрузочных дисков или локальных SSD, подключенных к новому экземпляру. | |||||
| disk_name строка | успешно | Указывает имя диска. Если не указано, по умолчанию используется имя экземпляра. | |||||
| disk_size_gb целое число | успешно | Указывает размер диска в ГБ. | |||||
| disk_type строка | успешно | Ссылка на ресурс gcompute_disk_type. Указывает тип диска, используемый для создания экземпляра. Если не указано, по умолчанию используется pd-standard. | |||||
| source_image строка | успешно | Исходный образ для создания этого диска. При создании нового экземпляра требуется один из initializeParams.sourceImage или disks.source. Чтобы создать диск с одним из общедоступных образов операционных систем, укажите имя семейства образа. | |||||
| source_image_encryption_key сложный | успешно | Ключ шифрования исходного образа, предоставленный клиентом. Требуется, если исходный образ защищен предоставленным клиентом ключом шифрования. Шаблоны экземпляров не хранят ключи шифрования, предоставленные клиентом, поэтому вы не можете создать диски для экземпляров в управляемой группе экземпляров, если исходные образы зашифрованы вашими собственными ключами. | |||||
| raw_key строка | успешно | Указывает 256-битный предоставленный клиентом ключ шифрования, закодированный в base64 RFC 4648 для шифрования или расшифрования этого ресурса. | |||||
| sha256 строка | успешно | Закодированный в base64 RFC 4648 SHA-256 хеш предоставленного клиентом ключа шифрования, защищающего этот ресурс. | |||||
| interface строка | успешно | Указывает интерфейс диска для подключения, который может быть SCSI или NVME. По умолчанию используется SCSI. Постоянные диски всегда должны использовать SCSI, и запрос завершится неудачей, если вы попытаетесь подключить постоянный диск в другом формате, кроме SCSI. | |||||
| mode строка | успешно | Режим подключения диска, либо READ_WRITE или READ_ONLY. Если не указано, по умолчанию используется режим READ_WRITE. | |||||
| source словарь | успешно | Ссылка на ресурс gcompute_disk. При создании нового экземпляра требуется один из initializeParams.sourceImage или disks.source. Если необходимо, вы также можете подключить существующие постоянные диски, не являющиеся корневыми, с помощью этого свойства. Это поле применимо только к постоянным дискам. Обратите внимание, что для InstanceTemplate укажите имя диска, а не URL диска. | |||||
| тип строка | успех | Указывает тип диска, либо SCRATCH, либо PERSISTENT. Если не указано, используется значение по умолчанию PERSISTENT. | |||||
| guest_accelerators сложный | успех | Список типов и количества ускорительных карт, подключённых к экземпляру. | |||||
| accelerator_count целое число | успех | Количество ускорительных карт гостевого экземпляра. | |||||
| accelerator_type строка | успех | Полный или частичный URL ресурса типа ускорителя, доступного для этого экземпляра. | |||||
| machine_type строка | успех | Ссылка на ресурс gcompute_machine_type. | |||||
| metadata словарь | успех | Ключевые пары метаданных, которые будут назначены экземплярам, созданным по этому шаблону. Эти пары могут содержать пользовательские метаданные или предопределённые ключи. | |||||
| network_interfaces сложный | успех | Массив конфигураций для этого интерфейса. Он определяет, как этот интерфейс взаимодействует с другими сетевыми службами, например, как подключается к интернету. На один экземпляр поддерживается только один сетевой интерфейс. | |||||
| access_configs сложный | успех | Массив конфигураций для этого интерфейса. В настоящее время поддерживается только одна конфигурация доступа ONE_TO_ONE_NAT. Если accessConfigs не указаны, то у этого экземпляра нет внешнего доступа к интернету. | |||||
| имя строка | успех | Имя этой конфигурации доступа. Рекомендуемое имя — External NAT, но вы можете использовать любое произвольное имя. Например, Мой внешний IP или Сетевой доступ. | |||||
| nat_ip словарь | успех | Указывает заголовок gcompute_address. Внешний IP-адрес, связанный с этим экземпляром. Укажите свободный статический внешний IP-адрес, доступный для проекта, или оставьте это поле пустым, чтобы использовать IP из общего пула временных IP-адресов. Если вы указываете статический внешний IP-адрес, он должен находиться в той же зоне, что и зона экземпляра. | |||||
| тип строка | успех | Тип конфигурации. По умолчанию и единственный вариант — ONE_TO_ONE_NAT. | |||||
| alias_ip_ranges сложный | успех | Массив диапазонов IP-адресов псевдонимов для этого сетевого интерфейса. Может быть указан только для сетевых интерфейсов в сетях с режимом подсети. | |||||
| ip_cidr_range строка | успех | Диапазон IP CIDR, представленный этим диапазоном IP-адресов псевдонимов. Этот диапазон IP CIDR должен принадлежать указанной подсети и не должен содержать IP-адреса, зарезервированные системой или используемые другими сетевыми интерфейсами. Этот диапазон может быть одиночным IP-адресом (например, 10.2.3.4), маской подсети (например, /24) или строкой в формате CIDR (например, 10.1.2.0/24). | |||||
| subnetwork_range_name строка | успех | Необязательное имя вторичного диапазона подсети, указывающее вторичный диапазон, из которого следует выделять диапазон IP CIDR для этого диапазона IP-адресов псевдонимов. Если не указано, будет использоваться первичный диапазон подсети. | |||||
| имя строка | успех | Имя сетевого интерфейса, сгенерированное сервером. Для сетевых устройств это eth0, eth1 и т. д. | |||||
| network словарь | успех | Указывает заголовок существующего gcompute_network. При создании экземпляра, если ни сеть, ни подсеть не указаны, используется сеть по умолчанию global/networks/default; если сеть не указана, а подсеть указана, сеть определяется автоматически. | |||||
| network_ip строка | успех | Внутренний IPv4-адрес сети, который следует назначить экземпляру для этого сетевого интерфейса. Если пользователь не указывает, система назначает свободный внутренний IP. | |||||
| subnetwork словарь | успех | Ссылка на ресурс gcompute_subnetwork. Если ресурс сети находится в режиме legacy, не предоставляйте этот параметр. Если сеть в режиме автоматической подсети, предоставление подсети необязательно. Если сеть в режиме настраиваемой подсети, это поле должно быть указано. | |||||
| scheduling сложный | успех | Настраивает параметры планирования для этого экземпляра. | |||||
| automatic_restart булево | успех | Указывает, следует ли автоматически перезапускать экземпляр, если он был завершён Compute Engine (а не пользователем). Вы можете задать параметр автоматического перезапуска только для стандартных экземпляров. Предварительно выделенные экземпляры не могут быть автоматически перезапущены. | |||||
| on_host_maintenance строка | успех | Определяет поведение при обслуживании хоста для этого экземпляра. Для стандартных экземпляров поведение по умолчанию — MIGRATE. Для предварительно выделенных экземпляров поведение по умолчанию и единственно возможное — TERMINATE. Для получения дополнительной информации см. Настройка параметров планирования экземпляров. | |||||
| preemptible булево | успех | Определяет, является ли экземпляр предварительно выделенным. Это можно задать только при создании экземпляра, оно не может быть задано или изменено после создания экземпляра. | |||||
| service_accounts сложный | успех | Список учетных записей служб с указанными областями, авторизованными для этого экземпляра. Только одна учётная запись службы на один виртуальный компьютер поддерживается. | |||||
| email строка | успех | Адрес электронной почты учетной записи службы. | |||||
| scopes список | успех | Список областей, которые должны быть доступны для этой учетной записи службы. | |||||
| tags сложный | успех | Список тегов, которые нужно применить к этому экземпляру. Теги используются для идентификации допустимых источников или целей для сетевых брандмауэров и указываются клиентом при создании экземпляра. Теги могут быть изменены позже методом setTags. Каждый тег в списке должен соответствовать RFC1035. | |||||
| fingerprint строка | успех | Указывает отпечаток для этого запроса, который представляет собой хэш содержимого метаданных и используется для оптимистической блокировки. Отпечаток первоначально генерируется Compute Engine и меняется после каждого запроса на изменение или обновление метаданных. Для обновления или изменения метаданных вы всегда должны предоставить актуальный хэш отпечатка. | |||||
| items список | успех | Массив тегов. Каждый тег должен иметь длину от 1 до 63 символов и соответствовать RFC1035. | |||||
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- 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.7/modules/gcp_compute_instance_template_facts_module.html
