модуль google.cloud.gcp_compute_reservation_info — сбор сведений о резервировании GCP
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.13.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install google.cloud. Для работы с этим модулем потребуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать его в плейбуке, укажите: google.cloud.gcp_compute_reservation_info.
Краткое описание
- Сбор сведений о резервировании GCP
Требования
На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен доступа OAuth2, если тип учетных данных — accesstoken. |
auth_kind string / обязательный | Тип используемых учетных данных. Варианты:
|
env_type string | Указывает, в какой среде Ansible выполняется этот модуль. Не задавайте это значение, если не знаете, что делаете. Этот параметр изменяет только строку User Agent для всех запросов API. |
filters list / элементы=string | Список пар значений фильтров. Доступные фильтры перечислены здесь: https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке будет добавлен как условие AND (filter1 and filter2). |
project string | Проект Google Cloud Platform, который будет использоваться. |
scopes list / элементы=string | Массив используемых областей доступа |
service_account_contents jsonarg | Содержимое JSON-файла учетной записи службы: словарь или JSON-строка, представляющая его. |
service_account_email string | Необязательный адрес электронной почты учетной записи службы, если выбрано machineaccount и пользователь не хочет использовать адрес по умолчанию. |
service_account_file path | Путь к JSON-файлу учетной записи службы, если в качестве типа выбрано serviceaccount. |
zone string / обязательный | Зона, в которой выполняется резервирование. |
Примечания
Примечание
- Для аутентификации можно задать 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 reservation
gcp_compute_reservation_info:
zone: us-central1-a
filters:
- name = test_object
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
resources complex | Список ресурсов Возвращается: всегда |
|
commitment string |
Полный или частичный URL родительского обязательства. Это поле отображается для резервирований, связанных с обязательством. Возвращается: при успехе |
|
creationTimestamp string |
Временная метка создания в текстовом формате RFC3339. Возвращается: при успехе |
|
description string |
Необязательное описание этого ресурса. Возвращается: при успехе |
|
id integer |
Уникальный идентификатор ресурса. Возвращается: при успехе |
|
name string |
Имя ресурса. Указывается клиентом при создании ресурса. Имя должно содержать от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно содержать от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`: первый символ должен быть строчной буквой, все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, которым не может быть дефис. Возвращается: при успехе |
|
specificReservation complex |
Резервирование для экземпляров с заданными конфигурациями машин. Возвращается: при успехе |
|
count integer |
Количество выделенных ресурсов. Возвращается: при успехе |
|
instanceProperties complex |
Свойства экземпляров для резервирования. Возвращается: при успехе |
|
guestAccelerators complex |
Тип и количество гостевых ускорителей. Возвращается: при успехе |
|
acceleratorCount integer |
Количество карт гостевых ускорителей, доступных этому экземпляру. Возвращается: при успехе |
|
acceleratorType string |
Полный или частичный URL типа ускорителя, который нужно подключить к этому экземпляру. Например: `projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100`. При создании шаблона экземпляра укажите только имя ускорителя. Возвращается: при успехе |
|
localSsds complex |
Объем локального SSD, резервируемого для каждого экземпляра. Резервируются диски типа `local-ssd`. Возвращается: при успехе |
|
diskSizeGb integer |
Размер диска в ГБ (степень 2). Возвращается: при успехе |
|
interface string |
Интерфейс диска, используемый для его подключения. Возвращается: при успехе |
|
machineType string |
Имя типа машины для резервирования. Возвращается: при успехе |
|
minCpuPlatform string |
Минимальная платформа ЦП для резервирования. Например, `”Intel Skylake”`. Информацию о доступных платформах ЦП см. на странице https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform#availablezones. Возвращается: при успехе |
|
inUseCount integer |
Количество используемых экземпляров. Возвращается: при успехе |
|
specificReservationRequired boolean |
Если задано значение true, использовать это резервирование могут только виртуальные машины, явно указывающие на него по имени. В противном случае его могут использовать виртуальные машины, связанные с любым резервированием. По умолчанию — false. Возвращается: при успехе |
|
status string |
Статус резервирования. Возвращается: при успехе |
|
zone string |
Зона, в которой выполняется резервирование. Возвращается: при успехе |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/google/cloud/gcp_compute_reservation_info_module.html