gcp_compute_instance_facts – Сбор фактов для экземпляра GCP
Новая версия 2.7.
Обзор
- Сбор фактов для экземпляра GCP
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- 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. | |
| zone - / обязательно | Ссылка на зону, где находится машина. |
Примечания
Примечание
- Для аутентификации можно установить service_account_file, используя переменную среды
GCP_SERVICE_ACCOUNT_FILE. - Для аутентификации можно установить service_account_email, используя переменную среды
GCP_SERVICE_ACCOUNT_EMAIL. - Для аутентификации можно установить auth_kind, используя переменную среды
GCP_AUTH_KIND. - Для аутентификации можно установить scopes, используя переменную среды
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: a instance facts
gcp_compute_instance_facts:
zone: us-central1-a
filters:
- name = test_object
project: test_project
auth_kind: service_account
service_account_file: "/tmp/auth.pem"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | ||||
|---|---|---|---|---|---|---|
| items сложный | всегда | Список элементов | ||||
| can_ip_forward логическое | успех | Разрешает этому экземпляру отправлять и получать пакеты с несовпадающими IP-адресами назначения или источника. Это необходимо, если вы планируете использовать этот экземпляр для переадресации маршрутов. | ||||
| cpu_platform строка | успех | Платформа процессора, используемая этим экземпляром. | ||||
| creation_timestamp строка | успех | Маркер создания в формате RFC3339. | ||||
| 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. При необходимости вы также можете подключить существующие постоянные диски, не являющиеся корневыми, используя этот параметр. Этот параметр применим только для постоянных дисков. | ||||
| type строка | успех | Указывает тип диска: SCRATCH или PERSISTENT. Если не указано, по умолчанию используется PERSISTENT. | ||||
| guest_accelerators сложный | успех | Список типов и количества адаптеров ускорителей, подключенных к экземпляру. | ||||
| accelerator_count целое число | успех | Количество адаптеров ускорителей гостевой системы, доступных для этого экземпляра. | ||||
| accelerator_type строка | успех | Полный или частичный URL ресурса типа ускорителя, доступный для этого экземпляра. | ||||
| id целое число | успех | Уникальный идентификатор ресурса. Этот идентификатор определяется сервером. | ||||
| label_fingerprint строка | успех | Отпечаток запроса, который представляет собой хэш содержимого метаданных и используется для оптимистической блокировки. Отпечаток первоначально генерируется Compute Engine и изменяется после каждого запроса на изменение или обновление метаданных. Вы всегда должны указывать обновленный отпечаток хэша, чтобы обновить или изменить метаданные. | ||||
| machine_type строка | успех | Ссылка на тип машины, который определяет тип виртуальной машины. | ||||
| метаданные словарь | успех | Пара пары ключ/значение метаданных, которые нужно назначить экземплярам, созданным из этой шаблона. Эти пары могут состоять из пользовательских метаданных или предопределенных ключей. | ||||
| min_cpu_platform строка | успех | Указывает минимальную платформу процессора для виртуальной машины. Допустимые значения — дружественные имена платформ процессоров. | ||||
| имя строка | успех | Имя ресурса, предоставленное клиентом при первоначальном создании ресурса. Имя ресурса должно содержать от 1 до 63 символов и соответствовать RFC1035. То есть имя должно содержать от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. | ||||
| сетевые_интерфейсы сложный | успех | Массив конфигураций для этого интерфейса. Это определяет, как этот интерфейс настроен для взаимодействия с другими сетевыми службами, например, для подключения к интернету. На каждый экземпляр разрешен только один сетевой интерфейс. | ||||
| access_configs сложный | успех | Массив конфигураций для этого интерфейса. В настоящее время поддерживается только одна конфигурация доступа ONE_TO_ONE_NAT. Если конфигурации доступа не указаны, этот экземпляр не будет иметь внешнего доступа к интернету. | ||||
| имя строка | успех | Имя этой конфигурации доступа. По умолчанию и рекомендуется имя External NAT, но вы можете использовать любое произвольное строковое значение. Например, My external IP или Network Access. | ||||
| 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 и т. д. | ||||
| сеть словарь | успех | Указывает заголовок существующего ресурса gcompute_network. При создании экземпляра, если ни сеть, ни подсеть не указаны, используется сеть по умолчанию global/networks/default; если сеть не указана, но указана подсеть, сеть определяется. | ||||
| network_ip строка | успех | Внутренний IPv4-адрес сети для назначения экземпляру для этого сетевого интерфейса. Если пользователь не указывает, система назначает неиспользуемый внутренний IP-адрес. | ||||
| подсеть словарь | успех | Ссылка на ресурс gcompute_subnetwork. Если сетевой ресурс находится в режиме legacy, не предоставляйте это свойство. Если сеть находится в режиме автоматической подсети, указание подсети является необязательным. Если сеть находится в режиме пользовательской подсети, это поле должно быть указано. | ||||
| планирование сложный | успех | Устанавливает параметры планирования для этого экземпляра. | ||||
| автоматический_перезапуск булево | успех | Указывает, следует ли автоматически перезапускать экземпляр, если он был завершен Compute Engine (не пользователем). Вы можете установить параметр автоматического перезапуска только для стандартных экземпляров. Предварительные экземпляры не могут быть автоматически перезапущены. | ||||
| при_техническом_обслуживании_хоста строка | успех | Определяет поведение при техническом обслуживании для этого экземпляра. Для стандартных экземпляров поведение по умолчанию — MIGRATE. Для предварительных экземпляров поведение по умолчанию и единственно возможное — TERMINATE. Дополнительную информацию см. в разделе Настройка параметров планирования экземпляров. | ||||
| предварительный булево | успех | Определяет, является ли экземпляр предварительным. Это можно задать только при создании экземпляра, после создания экземпляра его нельзя задать или изменить. | ||||
| service_accounts сложный | успех | Список учетных записей служб со специфицированными областями, авторизованными для этого экземпляра. Для каждого экземпляра виртуальной машины поддерживается только одна учетная запись службы. | ||||
| email строка | успех | Электронный адрес учетной записи службы. | ||||
| scopes список | успех | Список областей, которые должны быть доступны для этой учетной записи службы. | ||||
| статус строка | успех | Статус экземпляра. Одно из следующих значений: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED и TERMINATED. | ||||
| сообщение_о_статусе строка | успех | Необязательное, удобочитаемое объяснение статуса. | ||||
| теги сложный | успех | Список тегов для применения к этому экземпляру. Теги используются для идентификации допустимых источников или целей сетевых брандмауэров и указываются клиентом при создании экземпляра. Теги могут быть изменены позже методом setTags. Каждый тег в списке должен соответствовать RFC1035. | ||||
| отпечаток строка | успех | Указывает отпечаток для этого запроса, который представляет собой хэш содержимого метаданных и используется для оптимистической блокировки. Отпечаток первоначально генерируется Compute Engine и изменяется после каждого запроса на изменение или обновление метаданных. Для обновления или изменения метаданных необходимо всегда предоставлять актуальный хэш отпечатка. | ||||
| элементы список | успех | Массив тегов. Каждый тег должен содержать от 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.7/modules/gcp_compute_instance_facts_module.html
