Модуль google.cloud.gcp_compute_instance_group_info – Сбор информации о группе виртуальных машин GCP
Примечание
Этот модуль является частью коллекции google.cloud (версия 1.4.1).
Возможно, эта коллекция уже установлена, если вы используете пакет 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 строка | Токен доступа 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_contents jsonarg | Содержимое JSON-файла учетной записи службы, либо в виде словаря, либо как JSON-строка, его представляющая. |
service_account_email строка | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. |
service_account_file путь | Путь к файлу JSON учетной записи службы, если тип учетной записи — serviceaccount. |
zone строка / обязательно | Ссылка на зону, в которой расположена группа виртуальных машин. |
Примечания
Примечание
- для аутентификации можно установить 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 сложный | Список ресурсов Возвращается: всегда |
|
creationTimestamp строка |
Маркер создания в формате RFC3339. Возвращается: успешно |
|
description строка |
Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. Возвращается: успешно |
|
id целое число |
Уникальный идентификатор этой группы экземпляров. Возвращается: успешно |
|
instances список / элементы=строка |
Список экземпляров, связанных с этой группой экземпляров. Все экземпляры должны быть созданы до добавления в группу экземпляров. Все экземпляры, не входящие в этот список, будут удалены из группы экземпляров и не будут удалены. Будет возвращен только полный идентификатор экземпляра. Возвращается: успешно |
|
name строка |
Имя группы экземпляров. Длина имени должна составлять от 1 до 63 символов и соответствовать RFC1035. Возвращается: успешно |
|
namedPorts сложный |
Присваивает имя номеру порта. Например: {name: “http”, port: 80}. Это позволяет системе ссылаться на порты по присвоенному имени вместо номера порта. Имена портов также могут содержать несколько портов. Например: [{name: “http”, port: 80},{name: “http”, port: 8080}] Названные порты применяются ко всем экземплярам в этой группе экземпляров. Возвращается: успешно |
|
name строка |
Имя для этого названного порта. Длина имени должна составлять от 1 до 63 символов и соответствовать RFC1035. Возвращается: успешно |
|
port целое число |
Номер порта, который может быть значением от 1 до 65535. Возвращается: успешно |
|
network словарь |
Сеть, к которой принадлежат все экземпляры в группе экземпляров. Возвращается: успешно |
|
region строка |
Регион, где расположена группа экземпляров (для региональных ресурсов). Возвращается: успешно |
|
subnetwork словарь |
Подсеть, к которой принадлежат все экземпляры в группе экземпляров. Возвращается: успешно |
|
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_info_module.html
