модуль google.cloud.gcp_filestore_instance_info — сбор сведений об экземпляре GCP
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.13.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: google.cloud.gcp_filestore_instance_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. |
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 / обязательный | Название зоны Filestore экземпляра. |
Примечания
Примечание
- Для аутентификации можно задать 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
gcp_filestore_instance_info:
zone: us-central1-b
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
Возвращаемые значения
Общие возвращаемые значения описаны здесь. Ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
resources complex | Список ресурсов Возвращается: всегда |
|
createTime string |
Временная метка создания в текстовом формате RFC3339. Возвращается: при успешном выполнении |
|
description string |
Описание экземпляра. Возвращается: при успешном выполнении |
|
etag string |
Назначенный сервером ETag для ресурса экземпляра, предотвращающий перезапись изменений при одновременном обновлении. Возвращается: при успешном выполнении |
|
complex |
Общие файловые ресурсы экземпляра. В этой версии поддерживается только один общий файловый ресурс. Возвращается: при успешном выполнении |
|
integer |
Емкость общего файлового ресурса в ГиБ. Для стандартного уровня она должна составлять не менее 1024 ГиБ, а для премиум-уровня — не менее 2560 ГиБ. Возвращается: при успешном выполнении |
|
string |
Имя общего файлового ресурса (не более 16 символов). Возвращается: при успешном выполнении |
|
labels dictionary |
Метки ресурса для хранения метаданных, предоставленных пользователем. Возвращается: при успешном выполнении |
|
name string |
Имя ресурса экземпляра. Возвращается: при успешном выполнении |
|
networks complex |
Сети VPC, к которым подключен экземпляр. В этой версии поддерживается только одна сеть. Возвращается: при успешном выполнении |
|
ipAddresses list / elements=string |
Список адресов IPv4 или IPv6. Возвращается: при успешном выполнении |
|
modes list / elements=string |
Версии IP, для которых экземпляру назначены IP-адреса. Возвращается: при успешном выполнении |
|
network string |
Имя сети GCE VPC, к которой подключен экземпляр. Возвращается: при успешном выполнении |
|
reservedIpRange string |
Блок CIDR /29, определяющий диапазон IP-адресов, зарезервированных для этого экземпляра. Возвращается: при успешном выполнении |
|
tier string |
Уровень обслуживания экземпляра. Возвращается: при успешном выполнении |
|
zone string |
Название зоны Filestore экземпляра. Возвращается: при успешном выполнении |
Ссылки на коллекцию
© 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_filestore_instance_info_module.html
