Модуль google.cloud.gcp_compute_reservation_info – Сбор информации о резервации GCP
Примечание
Этот модуль является частью коллекции google.cloud (версия 1.4.1).
Возможно, эта коллекция уже установлена, если вы используете пакет 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 строка | Токен доступа OAuth2, если тип учетных данных — accesstoken. |
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_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 |
Размер диска в base-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. Возвращаемое значение: success |
|
status string |
Статус резервации. Возвращаемое значение: success |
|
zone string |
Зона, где создана резервация. Возвращаемое значение: success |
Ссылки на коллекцию
© 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_reservation_info_module.html
