модуль google.cloud.gcp_compute_instance_group_info — сбор сведений о группе экземпляров GCP
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.13.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install google.cloud. Для работы с этим модулем необходимы дополнительные требования; подробности см. в разделе Требования.
Чтобы использовать его в плейбуке, укажите: google.cloud.gcp_compute_instance_group_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 / elements=string | Список пар значений фильтров. Доступные фильтры перечислены здесь: https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке добавляется как условие AND (filter1 and filter2). |
project string | Проект Google Cloud Platform, который нужно использовать. |
scopes list / elements=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 an instance group
gcp_compute_instance_group_info:
zone: us-central1-a
filters:
- name = test_object
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
resources complex | Список ресурсов Возвращается: всегда |
|
creationTimestamp string |
Временная метка создания в текстовом формате RFC3339. Возвращается: при успехе |
|
description string |
Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. Возвращается: при успехе |
|
id integer |
Уникальный идентификатор этой группы экземпляров. Возвращается: при успехе |
|
instances list / elements=string |
Список экземпляров, связанных с этой группой экземпляров. Все экземпляры необходимо создать до добавления в группу экземпляров. Все экземпляры, отсутствующие в этом списке, будут удалены из группы экземпляров, но не будут удалены как ресурсы. Возвращается только полный идентификатор экземпляра. Возвращается: при успехе |
|
name string |
Имя группы экземпляров. Имя должно содержать от 1 до 63 символов и соответствовать RFC1035. Возвращается: при успехе |
|
namedPorts complex |
Назначает номеру порта имя. Например: {name: “http”, port: 80}. Это позволяет системе обращаться к портам по назначенным именам, а не по номерам. Именованные порты также могут включать несколько портов. Например: [{name: “http”, port: 80},{name: “http”, port: 8080}] Именованные порты применяются ко всем экземплярам в этой группе экземпляров. Возвращается: при успехе |
|
name string |
Имя этого именованного порта. Имя должно содержать от 1 до 63 символов и соответствовать RFC1035. Возвращается: при успехе |
|
port integer |
Номер порта — значение от 1 до 65535. Возвращается: при успехе |
|
network dictionary |
Сеть, к которой относятся все экземпляры в группе экземпляров. Возвращается: при успехе |
|
region string |
Регион, в котором находится группа экземпляров (для региональных ресурсов). Возвращается: при успехе |
|
subnetwork dictionary |
Подсеть, к которой относятся все экземпляры в группе экземпляров. Возвращается: при успехе |
|
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_instance_group_info_module.html
