gcp_compute_instance_group_facts – Сбор фактов для группы виртуальных машин GCP
Новая в версии 2.7.
Обзор
- Сбор фактов для группы виртуальных машин GCP
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. |
| filters - | Список пар значений фильтров. Доступные фильтры перечислены здесь https://cloud.google.com/sdk/gcloud/reference/topic/filters.
Каждый дополнительный фильтр в списке будет добавлен как условие И (filter1 и filter2). | |
| project строка | Проект Google Cloud Platform для использования. | |
| scopes список | Массив используемых областей видимости. | |
| service_account_contents строка | Строка, представляющая содержимое файла JSON учетной записи службы. Не следует передавать это как словарь, а как строку с точным содержимым файла JSON учетной записи службы (действительный JSON). | |
| service_account_email строка | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес электронной почты по умолчанию. | |
| service_account_file путь | Путь к файлу JSON учетной записи службы, если в качестве типа выбран serviceaccount. | |
| zone - / обязательно | Ссылка на зону, в которой находится группа виртуальных машин. |
Примечания
Примечание
- Для аутентификации можно установить service_account_file с помощью переменной среды
GCP_SERVICE_ACCOUNT_FILE. - Для аутентификации можно установить service_account_email с помощью переменной среды
GCP_SERVICE_ACCOUNT_EMAIL. - Для аутентификации можно установить service_account_contents с помощью переменной среды
GCP_SERVICE_ACCOUNT_CONTENTS. - Для аутентификации можно установить auth_kind с помощью переменной среды
GCP_AUTH_KIND. - Для аутентификации можно установить scopes с помощью переменной среды
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения в Playbook не заданы.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: " a instance group facts"
gcp_compute_instance_group_facts:
zone: us-central1-a
filters:
- name = test_object
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: facts
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже перечислены поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| items сложное | всегда | Список элементов | ||
| 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 строка | успех | Ссылка на зону, в которой находится группа виртуальных машин. | ||
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Google Inc. (@googlecloudplatform)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/gcp_compute_instance_group_facts_module.html