Модуль google.cloud.gcp_compute_region_instance_group_manager_info – Сбор информации о GCP RegionInstanceGroupManager
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.4.1).
Эта коллекция, возможно, уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.
Чтобы использовать его в плейбуке, укажите: google.cloud.gcp_compute_region_instance_group_manager_info.
Описание
- Сбор информации о GCP RegionInstanceGroupManager
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- 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. Каждый дополнительный фильтр в списке будет добавлен как условие AND (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 instance group manager
gcp_compute_region_instance_group_manager_info:
region: us-central1
filters:
- name = test_object
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
resources complex | Список ресурсов Возвращается: всегда |
|
autoHealingPolicies complex |
Политика автовосстановления для этой управляемой группы экземпляров. Возвращается: успех |
|
healthCheck string |
URL для проверки работоспособности, которая сигнализирует о необходимости автовосстановления. Возвращается: успех |
|
initialDelaySec integer |
Количество секунд, которое управляемая группа экземпляров ожидает, прежде чем применять политики автовосстановления к новым экземплярам или недавно воссозданным экземплярам. Возвращается: успех |
|
baseInstanceName string |
Базовое имя экземпляра для использования экземпляров в этой группе. Значение должно быть длиной от 1 до 58 символов. Экземпляры называются путем добавления дефиса и случайной четырехсимвольной строки к базовому имени экземпляра. Базовое имя экземпляра должно соответствовать RFC1035. Возвращается: успех |
|
creationTimestamp string |
Метка времени создания для этой управляемой группы экземпляров в текстовом формате RFC3339. Возвращается: успех |
|
currentActions complex |
Список действий с экземплярами и количество экземпляров в этой управляемой группе экземпляров, запланированных для каждого из этих действий. Возвращается: успех |
|
abandoning integer |
Общее количество экземпляров в управляемой группе экземпляров, которые запланированы на отказ. Отказ от экземпляра удаляет его из управляемой группы экземпляров без его удаления. Возвращается: успех |
|
creating integer |
Количество экземпляров в управляемой группе экземпляров, которые запланированы на создание или в настоящее время создаются. Если группа не может создать ни один из этих экземпляров, она пытается снова, пока не создаст экземпляр успешно. Если вы отключили повторы создания, это поле не будет заполнено; вместо этого будет заполнено поле creatingWithoutRetries. Возвращается: успех |
|
creatingWithoutRetries integer |
Количество экземпляров, которые управляемая группа экземпляров попытается создать. Группа пытается создать каждый экземпляр только один раз. Если группа не может создать ни один из этих экземпляров, она соответствующим образом уменьшает значение targetSize группы. Возвращается: успех |
|
deleting integer |
Количество экземпляров в управляемой группе экземпляров, которые запланированы на удаление или в настоящее время удаляются. Возвращается: успех |
|
none integer |
Количество экземпляров в управляемой группе экземпляров, которые работают и не имеют запланированных действий. Возвращается: успех |
|
recreating integer |
Количество экземпляров в управляемой группе экземпляров, которые запланированы на пересоздание или в настоящее время пересоздаются. Пересоздание экземпляра удаляет существующий постоянный диск корневого уровня и создает новый диск из образа, определенного в шаблоне экземпляра. Возвращается: успех |
|
refreshing integer |
Количество экземпляров в управляемой группе экземпляров, которые перенастраиваются с помощью свойств, не требующих перезапуска или действия пересоздания. Например, установка или удаление пулов целевых объектов для экземпляра. Возвращается: успех |
|
restarting integer |
Количество экземпляров в управляемой группе экземпляров, которые запланированы на перезапуск или в настоящее время перезапускаются. Возвращается: успех |
|
description string |
Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. Возвращается: успех |
|
id integer |
Уникальный идентификатор этого ресурса. Возвращается: успех |
|
instanceGroup dictionary |
Управляемая группа виртуальных машин. Возвращаемое значение: success |
|
instanceTemplate dictionary |
Шаблон виртуальной машины, указанный для этой управляемой группы виртуальных машин. Группа использует этот шаблон для создания всех новых виртуальных машин в управляемой группе виртуальных машин. Возвращаемое значение: success |
|
name string |
Имя управляемой группы виртуальных машин. Длина имени должна составлять от 1 до 63 символов и соответствовать RFC1035. Возвращаемое значение: success |
|
namedPorts complex |
Названные порты, настроенные для групп виртуальных машин, дополняющих эту управляемую группу виртуальных машин. Возвращаемое значение: success |
|
name string |
Имя для этого названного порта. Длина имени должна составлять от 1 до 63 символов и соответствовать RFC1035. Возвращаемое значение: success |
|
port integer |
Номер порта, который может быть значением от 1 до 65535. Возвращаемое значение: success |
|
region string |
Регион, в котором расположена управляемая группа виртуальных машин. Возвращаемое значение: success |
|
targetPools list / elements=string |
Ресурсы TargetPool, к которым добавляются экземпляры в поле instanceGroup. Целевые пулы автоматически применяются ко всем экземплярам в управляемой группе виртуальных машин. Возвращаемое значение: success |
|
targetSize integer |
Целевое количество запущенных экземпляров для этой управляемой группы виртуальных машин. Удаление или отказ от экземпляров уменьшает это число. Изменение размера группы изменяет это число. Возвращаемое значение: 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_region_instance_group_manager_info_module.html
