Spec-Zone.ru › Ansible

Модуль google.cloud.gcp_compute_disk_info – Сбор информации о диске GCP

Примечание

Этот модуль является частью коллекции google.cloud (версия 1.4.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля требуются дополнительные компоненты, см. Требования для получения подробной информации.

Для использования в playbook, укажите: google.cloud.gcp_compute_disk_info.

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Сбор информации о диске GCP

Требования

Ниже указаны требования, необходимые на хосте, на котором выполняется этот модуль.

  • python >= 2.6
  • requests >= 2.18.4
  • google-auth >= 1.3.0

Параметры

Параметр

Комментарии

access_token

string

Токен доступа OAuth2, если тип учетных данных — accesstoken.

auth_kind

string / required

Тип используемых учетных данных.

Варианты:

  • "application"
  • "machineaccount"
  • "serviceaccount"
  • "accesstoken"

env_type

string

Указывает, в какой среде Ansible выполняется этот модуль.

Это не должно устанавливаться, если вы не знаете, что делаете.

Это изменяет только строку User Agent для любых запросов API.

filters

list / elements=string

Список пар значений фильтров. Доступные фильтры перечислены здесь https://cloud.google.com/sdk/gcloud/reference/topic/filters.

Каждый дополнительный фильтр в списке будет добавлен как условие AND (filter1 и filter2).

project

string

Проект Google Cloud Platform для использования.

scopes

list / elements=string

Массив областей, которые будут использоваться

service_account_contents

jsonarg

Содержимое файла JSON учетной записи службы, либо в виде словаря, либо в виде представляющей его JSON-строки.

service_account_email

string

Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес электронной почты по умолчанию.

service_account_file

path

Путь к файлу JSON учетной записи службы, если в качестве типа выбран serviceaccount.

zone

string / required

Ссылка на зону, где находится диск.

Примечания

Примечание

  • для аутентификации можно установить service_account_file с помощью переменной среды GCP_SERVICE_ACCOUNT_FILE.
  • для аутентификации можно установить service_account_contents с помощью переменной среды GCP_SERVICE_ACCOUNT_CONTENTS.
  • Для аутентификации можно установить service_account_email с помощью переменной среды GCP_SERVICE_ACCOUNT_EMAIL.
  • Для аутентификации можно установить access_token с помощью переменной среды GCP_ACCESS_TOKEN.
  • Для аутентификации можно установить auth_kind с помощью переменной среды GCP_AUTH_KIND.
  • Для аутентификации можно установить scopes с помощью переменной среды GCP_SCOPES.
  • Значения переменных среды будут использоваться только в том случае, если значения playbook не установлены.
  • Параметры 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 Service Agent.

Возвращается: успешно

rawKey

string

Указывает 256-битный ключ шифрования, предоставленный клиентом, закодированный в base64 RFC 4648, для шифрования или дешифрования этого ресурса.

Возвращается: успешно

sha256

string

Хэш SHA-256, закодированный в base64 RFC 4648, ключа шифрования, предоставленного клиентом, который защищает этот ресурс.

Возвращается: успешно

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, в будущем могут быть добавлены другие размеры.

Если запрашивается неподдерживаемое значение, сообщение об ошибке будет содержать список поддерживаемых значений для проекта вызывающего абонента.

Возвращается: успешно

provisionedIops

integer

Указывает, сколько операций ввода-вывода в секунду должно быть выделено для диска.

Возвращается: успешно

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.

Возвращено: success

rawKey

string

Указывает 256-битный ключ шифрования, предоставленный клиентом и закодированный в base64 RFC 4648, для шифрования или дешифрования этого ресурса.

Возвращено: success

sha256

string

Хеш SHA-256, закодированный в base64 RFC 4648, предоставленного клиентом ключа шифрования, который защищает этот ресурс.

Возвращено: success

sourceImageId

string

Значение ID образа, используемого для создания этого диска. Это значение идентифицирует именно тот образ, который использовался для создания этого постоянного диска. Например, если вы создали постоянный диск из образа, который позже был удален и создан заново под тем же именем, ID исходного образа будет идентифицировать именно ту версию образа, которая использовалась.

Возвращено: success

sourceSnapshot

dictionary

Исходный снимок, использованный для создания этого диска. Вы можете указать его как частичный или полный URL-адрес ресурса.

Возвращено: success

sourceSnapshotEncryptionKey

complex

Предоставленный клиентом ключ шифрования исходного снимка. Требуется, если исходный снимок защищен ключом шифрования, предоставленным клиентом.

Возвращено: success

kmsKeyName

string

Имя ключа шифрования, хранящегося в Google Cloud KMS.

Возвращено: success

kmsKeyServiceAccount

string

Учетная запись сервиса, используемая для запроса шифрования для данного ключа KMS.

При отсутствии используется учетная запись сервиса агента Compute Engine.

Возвращено: success

rawKey

string

Указывает 256-битный ключ шифрования, предоставленный клиентом и закодированный в base64 RFC 4648, для шифрования или дешифрования этого ресурса.

Возвращено: success

sha256

string

Хеш SHA-256, закодированный в base64 RFC 4648, предоставленного клиентом ключа шифрования, который защищает этот ресурс.

Возвращено: success

sourceSnapshotId

string

Уникальный ID снимка, используемый для создания этого диска. Это значение идентифицирует именно тот снимок, который использовался для создания этого постоянного диска. Например, если вы создали постоянный диск из снимка, который позже был удален и создан заново под тем же именем, ID исходного снимка будет идентифицировать именно ту версию снимка, которая использовалась.

Возвращено: success

type

string

URL ресурса типа диска, описывающий, какой тип диска использовать для создания диска. Укажите это при создании диска.

Возвращено: success

users

list / elements=string

Ссылки на пользователей диска (подключенные экземпляры) в формате: project/zones/zone/instances/instance.

Возвращено: success

zone

string

Ссылка на зону, где находится диск.

Возвращено: success

Авторы

  • Google Inc. (@googlecloudplatform)

Ссылки на коллекцию

  • Система отслеживания ошибок
  • Домашняя страница
  • Репозиторий (исходники)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/google/cloud/gcp_compute_disk_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API