Модуль google.cloud.gcp_compute_instance_group_manager_info – Сбор информации о GCP InstanceGroupManager
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.4.1).
Эта коллекция, возможно, уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.
Для использования в playbook, укажите: google.cloud.gcp_compute_instance_group_manager_info.
Обзор
- Сбор информации о GCP InstanceGroupManager
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- 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). |
| ... | ... |
Примечания
Примечание
- для аутентификации можно установить 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. - Значения переменных окружения будут использоваться только если значения в playbook не заданы.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: get info on an instance group manager
gcp_compute_instance_group_manager_info:
zone: us-west1-a
filters:
- name = test_object
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
resources complex | Список ресурсов Возвращается: всегда |
|
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 строка |
Имя этого имени порта. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. Возвращаемое значение: успех |
|
port целое число |
Номер порта, значение которого может быть от 1 до 65535. Возвращаемое значение: успех |
|
region строка |
Регион, в котором находится эта управляемая группа виртуальных машин (для региональных ресурсов). Возвращаемое значение: успех |
|
targetPools список / элементы=строка |
Ресурсы TargetPool, к которым добавляются экземпляры в поле instanceGroup. Целевые пулы автоматически применяются ко всем экземплярам в управляемой группе виртуальных машин. Возвращаемое значение: успех |
|
targetSize целое число |
Целевое количество работающих экземпляров для этой управляемой группы виртуальных машин. Удаление или отказ от экземпляров уменьшает это число. Изменение размера группы изменяет это число. Возвращаемое значение: успех |
|
zone строка |
Зона, в которой находится управляемая группа виртуальных машин. Возвращаемое значение: успех |
Ссылки на сборку
© 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_instance_group_manager_info_module.html
