google.cloud.gcp_compute_disk_info – Сбор информации о диске GCP
Примечание
Этот плагин входит в коллекцию google.cloud (версия 1.0.2).
Для его установки используйте: ansible-galaxy collection install google.cloud.
Для использования в книге задач, укажите: google.cloud.gcp_compute_disk_info.
Описание
- Сбор информации о диске GCP
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- 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. | |
| zone строка / обязательно | Ссылка на зону, в которой находится диск. |
Примечания
Примечание
- для аутентификации можно установить 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. - Значения переменных среды будут использованы только в том случае, если значения в книге задач не заданы.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: get info on a disk
gcp_compute_disk_info:
zone: us-central1-a
filters:
- name = test_object
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
Возвращаемые значения
Общие возвращаемые значения описаны в этом разделе, а ниже приведены поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| resources complex | всегда | Список ресурсов | ||
| creationTimestamp string | успех | Отметка времени создания в формате RFC3339. | ||
| description string | успех | Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. | ||
| diskEncryptionKey complex | успех | Шифрует диск с помощью предоставленного пользователем ключа шифрования. После шифрования диска с помощью предоставленного пользователем ключа, вы должны предоставить тот же ключ, если будете использовать диск позднее (например, для создания моментальной копии диска или образа, или для подключения диска к виртуальной машине). Ключи шифрования, предоставленные пользователем, не защищают доступ к метаданным диска. Если вы не предоставите ключ шифрования при создании диска, то диск будет зашифрован с помощью автоматически сгенерированного ключа, и вам не нужно будет предоставлять ключ для использования диска позднее. | ||
| kmsKeyName string | успех | Имя ключа шифрования, хранящегося в Google Cloud KMS. Служебный аккаунт вашей системы Compute Engine (`service-{{PROJECT_NUMBER}}@compute-system.iam.gserviceaccount.com`) должен иметь роль `roles/cloudkms.cryptoKeyEncrypterDecrypter` для использования этой функции. | ||
| kmsKeyServiceAccount string | успех | Служебный аккаунт, используемый для запроса шифрования для данного ключа KMS. Если отсутствует, используется служебный аккаунт агента Compute Engine. | ||
| rawKey string | успех | Указывает 256-битный ключ шифрования, предоставленный пользователем, закодированный в RFC 4648 base64 для шифрования или дешифрования этого ресурса. | ||
| sha256 string | успех | Закодированный в RFC 4648 base64 хэш SHA-256 ключа шифрования, предоставленного пользователем, который защищает этот ресурс. | ||
| id integer | успех | Уникальный идентификатор ресурса. | ||
| labelFingerprint string | успех | Отпечаток, используемый для оптимистической блокировки этого ресурса. Используется внутри при обновлениях. | ||
| labels dictionary | успех | Метки для применения к этому диску. Список пар ключ-значение. | ||
| lastAttachTimestamp string | успех | Отметка времени последнего подключения в формате RFC3339. | ||
| lastDetachTimestamp string | успех | Отметка времени последнего отключения в формате RFC3339. | ||
| licenses list / elements=string | успех | Любые применимые общедоступные лицензии. | ||
| name string | успех | Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. То есть, имя должно быть длиной от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. | ||
| physicalBlockSizeBytes integer | успех | Физический размер блока постоянного диска в байтах. Если он не указан в запросе, используется значение по умолчанию. В настоящее время поддерживаются размеры 4096 и 16384; другие размеры могут быть добавлены в будущем. Если запрашивается неподдерживаемое значение, сообщение об ошибке укажет поддерживаемые значения для проекта вызывающего. | ||
| sizeGb integer | успех | Размер постоянного диска в ГБ. Вы можете указать это поле при создании постоянного диска, используя параметр sourceImage или sourceSnapshot, или указать его самостоятельно, чтобы создать пустой постоянный диск. Если вы указываете это поле вместе с sourceImage или sourceSnapshot, значение sizeGb не должно быть меньше размера sourceImage или размера снимка. | ||
| sourceImage string | успех | Образ, используемый для создания этого диска. Если исходный образ удален, это поле не будет установлено. Для создания диска с одним из общедоступных образов операционных систем укажите имя образа по его семейству. Например, укажите family/debian-9 для использования последнего образа Debian 9: projects/debian-cloud/global/images/family/debian-9 или используйте определенную версию общедоступного образа операционной системы: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD Для создания диска с частным образом, который вы создали, укажите имя образа в следующем формате: global/images/my-private-image. Также вы можете указать частный образ по его семейству, что возвращает последнюю версию образа в этом семействе. Замените имя образа на family/family-name: global/images/family/my-private-family. | ||
| sourceImageEncryptionKey complex | успех | Ключ шифрования, предоставленный пользователем, для исходного образа. Требуется, если исходный образ защищен ключом шифрования, предоставленным пользователем. | ||
| kmsKeyName string | успех | Имя ключа шифрования, хранящегося в Google Cloud KMS. | ||
| kmsKeyServiceAccount string | успех | Служебный аккаунт, используемый для запроса шифрования для данного ключа KMS. Если отсутствует, используется служебный аккаунт агента Compute Engine. | ||
| rawKey string | успех | Указывает 256-битный ключ шифрования, предоставленный пользователем, закодированный в RFC 4648 base64 для шифрования или дешифрования этого ресурса. | ||
| sha256 string | успех | Закодированный в RFC 4648 base64 хэш SHA-256 ключа шифрования, предоставленного пользователем, который защищает этот ресурс. | ||
| sourceImageId string | успех | Идентификатор образа, используемого для создания этого диска. Это значение идентифицирует конкретный образ, который был использован для создания этого постоянного диска. Например, если вы создали постоянный диск из образа, который позже был удален и воссоздан под тем же именем, идентификатор исходного образа будет идентифицировать точную версию образа, которая была использована. | ||
| sourceSnapshot dictionary | успех | Исходный снимок, используемый для создания этого диска. Вы можете указать его как частичный или полный URL-адрес ресурса. | ||
| sourceSnapshotEncryptionKey complex | успех | Ключ шифрования, предоставленный пользователем, для исходного снимка. Требуется, если исходный снимок защищен ключом шифрования, предоставленным пользователем. | ||
| kmsKeyName string | успех | Имя ключа шифрования, хранящегося в Google Cloud KMS. | ||
| kmsKeyServiceAccount string | успех | Служебный аккаунт, используемый для запроса шифрования для данного ключа KMS. Если отсутствует, используется служебный аккаунт агента Compute Engine. | ||
| rawKey string | успех | Указывает 256-битный ключ шифрования, предоставленный пользователем, закодированный в RFC 4648 base64 для шифрования или дешифрования этого ресурса. | ||
| sha256 string | успех | Закодированный в RFC 4648 base64 хэш SHA-256 ключа шифрования, предоставленного пользователем, который защищает этот ресурс. | ||
| sourceSnapshotId string | успех | Уникальный идентификатор снимка, используемого для создания этого диска. Это значение идентифицирует конкретный снимок, который был использован для создания этого постоянного диска. Например, если вы создали постоянный диск из снимка, который позже был удален и воссоздан под тем же именем, идентификатор исходного снимка будет идентифицировать точную версию снимка, которая была использована. | ||
| type string | успех | URL ресурса типа диска, описывающего тип диска, который нужно использовать для создания диска. Укажите это при создании диска. | ||
| пользователи список / элементы=строка | успех | Ссылки на пользователей диска (прикреплённые экземпляры) в формате: проект/зоны/зона/экземпляры/экземпляр. | ||
| зона строка | успех | Ссылка на зону, в которой находится диск. | ||
Авторы
- 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_disk_info_module.html
