gcp_compute_disk_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. - Значения переменных среды будут использоваться только в том случае, если значения в плейбуке не заданы.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: a disk facts
gcp_compute_disk_facts:
zone: us-central1-a
filters:
- name = test_object
project: test_project
auth_kind: service_account
service_account_file: "/tmp/auth.pem"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| items сложный | всегда | Список элементов | ||
| creation_timestamp строка | успех | Отметка времени создания в формате RFC3339. | ||
| description строка | успех | Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. | ||
| disk_encryption_key сложный | успех | Шифрует диск с помощью предоставленного пользователем ключа шифрования. После шифрования диска с помощью ключа, предоставленного пользователем, необходимо предоставить тот же ключ, если вы в дальнейшем используете диск (например, для создания моментального снимка диска или образа, или для подключения диска к виртуальной машине). Ключи шифрования, предоставленные пользователем, не защищают доступ к метаданным диска. Если при создании диска вы не предоставляете ключ шифрования, диск будет зашифрован с помощью автоматически сгенерированного ключа, и вам не нужно предоставлять ключ для его дальнейшего использования. | ||
| raw_key строка | успех | Определяет 256-битный ключ шифрования, предоставленный пользователем, закодированный в RFC 4648 base64 для шифрования или дешифрования этого ресурса. | ||
| sha256 строка | успех | Закодированный в RFC 4648 base64 хеш SHA-256 ключа шифрования, предоставленного пользователем, который защищает этот ресурс. | ||
| id целое число | успех | Уникальный идентификатор ресурса. | ||
| labels словарь | успех | Метки, применяемые к этому диску. Список пар ключ-значение. | ||
| last_attach_timestamp строка | успех | Отметка времени последнего подключения в формате RFC3339. | ||
| last_detach_timestamp строка | успех | Отметка времени последнего отключения в формате RFC3339. | ||
| licenses список | успех | Все применимые общедоступные лицензии. | ||
| name строка | успех | Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. То есть длина должна составлять от 1 до 63 символов, а имя должно соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — тире, строчной буквой или цифрой, за исключением последнего символа, который не может быть тире. | ||
| size_gb целое число | успех | Размер постоянного диска в ГБ. Вы можете указать это поле при создании постоянного диска, используя параметр sourceImage или sourceSnapshot, или указать его самостоятельно для создания пустого постоянного диска. Если вы указываете это поле вместе с sourceImage или sourceSnapshot, значение sizeGb не должно быть меньше размера sourceImage или размера снимка. | ||
| source_image строка | успех | Образ источника, используемый для создания этого диска. Если образ источника удален, это поле не будет установлено. Чтобы создать диск с одним из общедоступных образов операционной системы, укажите имя семейства образа. Например, укажите family/debian-8 для использования последнего образа Debian 8: projects/debian-cloud/global/images/family/debian-8 В качестве альтернативы используйте конкретную версию общедоступного образа операционной системы: projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD Чтобы создать диск с частным образом, который вы создали, укажите имя образа в следующем формате: global/images/my-private-image Вы также можете указать частный образ по его семейству образов, что возвращает последнюю версию образа в этом семействе. Замените имя образа на family/family-name: global/images/family/my-private-family . | ||
| source_image_encryption_key сложный | успех | Ключ шифрования источника образа, предоставленный пользователем. Требуется, если образ источника защищен ключом шифрования, предоставленным пользователем. | ||
| raw_key строка | успех | Определяет 256-битный ключ шифрования, предоставленный пользователем, закодированный в RFC 4648 base64 для шифрования или дешифрования этого ресурса. | ||
| sha256 строка | успех | Закодированный в RFC 4648 base64 хеш SHA-256 ключа шифрования, предоставленного пользователем, который защищает этот ресурс. | ||
| source_image_id строка | успех | Значение ID образа, используемого для создания этого диска. Это значение идентифицирует точный образ, который был использован для создания этого постоянного диска. Например, если вы создали постоянный диск из образа, который был позже удален и пересоздан под тем же именем, идентификатор образа источника идентифицирует точную версию образа, который был использован. | ||
| source_snapshot словарь | успех | Моментальный снимок источника, используемый для создания этого диска. Вы можете предоставить его как частичный или полный URL-адрес ресурса. Например, следующие значения являются допустимыми: * `https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot` * `projects/project/global/snapshots/snapshot` * `global/snapshots/snapshot` . | ||
| source_snapshot_encryption_key сложный | успех | Ключ шифрования источника моментального снимка, предоставленный пользователем. Требуется, если моментальный снимок источника защищен ключом шифрования, предоставленным пользователем. | ||
| raw_key строка | успех | Определяет 256-битный ключ шифрования, предоставленный пользователем, закодированный в RFC 4648 base64 для шифрования или дешифрования этого ресурса. | ||
| sha256 строка | успех | Закодированный в RFC 4648 base64 хеш SHA-256 ключа шифрования, предоставленного пользователем, который защищает этот ресурс. | ||
| source_snapshot_id строка | успех | Уникальный ID моментального снимка, используемого для создания этого диска. Это значение идентифицирует точный моментальный снимок, который был использован для создания этого постоянного диска. Например, если вы создали постоянный диск из моментального снимка, который был позже удален и пересоздан под тем же именем, идентификатор моментального снимка источника идентифицирует точную версию моментального снимка, который был использован. | ||
| type строка | успех | URL ресурса типа диска, описывающего тип диска, который следует использовать для создания диска. Укажите это при создании диска. | ||
| users список | успех | Ссылки на пользователей диска (подключенные виртуальные машины) в формате: project/zones/zone/instances/instance . | ||
| zone строка | успех | Ссылка на зону, где находится диск. | ||
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом 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_disk_facts_module.html