Spec-Zone.ru › Ansible

модуль google.cloud.gcp_compute_region_instance_group_manager_info — Сбор сведений о GCP RegionInstanceGroupManager

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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

string

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

auth_kind

string / обязательный

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

Варианты:

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

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, который будет использоваться.

region

string / обязательный

Регион, в котором находится группа управляемых экземпляров.

scopes

list / элементы=string

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

service_account_contents

jsonarg

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

service_account_email

string

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

service_account_file

path

Путь к 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

Управляемая группа экземпляров.

Возвращается: при успехе

instanceTemplate

dictionary

Шаблон экземпляра, указанный для этой группы управляемых экземпляров. Группа использует этот шаблон для создания всех новых экземпляров в группе.

Возвращается: при успехе

name

string

Имя группы управляемых экземпляров. Оно должно содержать от 1 до 63 символов и соответствовать RFC1035.

Возвращается: при успехе

namedPorts

complex

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

Возвращается: при успехе

name

string

Имя этого именованного порта. Оно должно содержать от 1 до 63 символов и соответствовать RFC1035.

Возвращается: при успехе

port

integer

Номер порта — значение от 1 до 65535.

Возвращается: при успехе

region

string

Регион, в котором находится группа управляемых экземпляров.

Возвращается: при успехе

targetPools

list / элементы=string

Ресурсы TargetPool, в которые добавляются экземпляры из поля instanceGroup. Целевые пулы автоматически применяются ко всем экземплярам группы управляемых экземпляров.

Возвращается: при успехе

targetSize

integer

Целевое количество работающих экземпляров для этой группы управляемых экземпляров. Удаление экземпляров или отказ от управления ими уменьшает это число. Изменение размера группы изменяет это число.

Возвращается: при успехе

Авторы

  • Google Inc. (@googlecloudplatform)

Ссылки на коллекцию

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (исходный код)

© 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_region_instance_group_manager_info_module.html

Spec-Zone.ru

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