Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Для использования в плейбуке укажите: google.cloud.gcp_compute_region_disk_info.

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

Описание

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

Требования

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

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

Параметры

Параметр

Комментарии

access_token

строка

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

auth_kind

строка / обязательно

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

Варианты:

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

env_type

строка

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

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

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

filters

список / элементы=строка

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

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

project

строка

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

region

строка / обязательно

Ссылка на область, в которой находится диск.

scopes

список / элементы=строка

Массив используемых областей

service_account_contents

jsonarg

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

service_account_email

строка

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

service_account_file

путь

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

Примечания

Примечание

  • для аутентификации можно установить 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.
  • значения переменных среды будут использоваться только в том случае, если значения в плейбуке не заданы.
  • опции service_account_email и service_account_file взаимоисключают друг друга.

Примеры

- name: get info on a region disk
  gcp_compute_region_disk_info:
    region: us-central1
    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

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

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

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

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

Возвращено: успех

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

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

Возвращено: успех

region

string

Ссылка на регион, в котором находится диск.

Возвращено: успех

replicaZones

list / elements=string

URL-адреса зон, в которые следует реплицировать диск.

Возвращено: успех

sizeGb

integer

Размер постоянного диска, указанный в ГБ. Это поле можно указать при создании постоянного диска с использованием параметра sourceImage или sourceSnapshot, или указать его отдельно для создания пустого постоянного диска.

Если это поле указано вместе с sourceImage или sourceSnapshot, значение sizeGb не должно быть меньше размера sourceImage или размера снимка.

Возвращено: успех

sourceSnapshot

dictionary

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

Возвращено: успех

ключШифрованияИсточникСнимок

сложный

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

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

сыройКлюч

строка

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

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

sha256

строка

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

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

idИсточникСнимок

строка

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

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

тип

строка

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

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

пользователи

список / элементы=строка

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

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

Авторы

  • 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_region_disk_info_module.html

Spec-Zone.ru

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