google.cloud.gcp_compute_target_instance_info – Сбор информации о GCP TargetInstance
Примечание
Этот плагин входит в состав коллекции google.cloud (версия 1.0.2).
Для установки используйте: ansible-galaxy collection install google.cloud.
Для использования в книге задач укажите: google.cloud.gcp_compute_target_instance_info.
Описание
- Сбор информации о GCP TargetInstance
Требования
Ниже перечислены требования, необходимые на хосте, на котором будет выполняться этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
|
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
строка / обязательно
|
URL зоны, в которой находится экземпляр целевого сервера.
|
Примечания
Примечание
- для аутентификации можно установить service_account_file с помощью переменной среды
gcp_service_account_file. - для аутентификации можно установить service_account_contents с помощью переменной среды
GCP_SERVICE_ACCOUNT_CONTENTS. - для аутентификации можно установить service_account_email с помощью переменной среды
GCP_SERVICE_ACCOUNT_EMAIL. - для аутентификации можно установить auth_kind с помощью переменной среды
GCP_AUTH_KIND. - для аутентификации можно установить scopes с помощью переменной среды
GCP_SCOPES. - значения переменных среды будут использоваться только в том случае, если значения в книге задач не заданы.
- параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: get info on a target instance
gcp_compute_target_instance_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
строка
|
успех |
Необязательное описание этого ресурса.
|
|
|
instance
словарь
|
успех |
URL виртуальной машины, которая обрабатывает трафик для этого целевого экземпляра. Принимает ссылки на себя или частичные пути в формате `projects/project/zones/zone/instances/instance' или `zones/zone/instances/instance`.
|
|
|
name
строка
|
успех |
Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно содержать от 1 до 63 символов и соответствовать RFC1035. То есть, длина имени должна быть от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
|
|
|
natPolicy
строка
|
успех |
Параметр NAT, управляющий способом NAT-преобразования IP-адресов для экземпляра.
В настоящее время поддерживается только NO_NAT (значение по умолчанию).
|
|
|
zone
строка
|
успех |
URL зоны, в которой находится экземпляр целевого сервера.
|
|
Авторы
- Google Inc. (@googlecloudplatform)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/google/cloud/gcp_compute_target_instance_info_module.html
