Spec-Zone.ru › Ansible

Модуль google.cloud.gcp_compute_network_endpoint_group_info — Сбор информации о группе конечных точек GCP NetworkEndpointGroup

Примечание

Этот модуль является частью коллекции google.cloud (версия 1.4.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля требуются дополнительные зависимости. Подробности см. в разделе Требования.

Для использования в книге задач укажите: google.cloud.gcp_compute_network_endpoint_group_info.

  • Описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Описание

  • Сбор информации о группе конечных точек GCP NetworkEndpointGroup

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

  • python >= 2.6
  • requests >= 2.18.4
  • google-auth >= 1.3.0

Параметры

Параметр

Комментарии

access_token

строка

Токен доступа OAuth2, если тип учетных данных — accesstoken.

auth_kind

строка / обязательно

Тип используемых учетных данных.

Варианты:

  • "application"
  • "machineaccount"
  • "serviceaccount"
  • "accesstoken"

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_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 a network endpoint group
  gcp_compute_network_endpoint_group_info:
    zone: us-central1-a
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

Значения возврата

Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:

Ключ

Описание

resources

сложный

Список ресурсов

Возвращается: всегда

defaultPort

целое число

Порт по умолчанию, используемый, если номер порта не указан в сетевом конечном пункте.

Возвращается: успех

description

строка

Необязательное описание этого ресурса. Укажите это свойство при создании ресурса.

Возвращается: успех

id

целое число

Уникальный идентификатор ресурса.

Возвращается: успех

name

строка

Имя ресурса; предоставляется клиентом при создании ресурса. Длина имени должна составлять от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно иметь длину от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.

Возвращается: успех

network

словарь

Сеть, к которой принадлежат все сетевые конечные точки в группе NEG.

Используется сеть проекта «по умолчанию», если не указано иное.

Возвращается: успех

networkEndpointType

строка

Тип сетевых конечных точек в этой группе сетевых конечных точек.

Возвращается: успех

size

целое число

Количество сетевых конечных точек в группе сетевых конечных точек.

Возвращается: успех

subnetwork

словарь

Необязательная подсеть, к которой принадлежат все сетевые конечные точки в группе NEG.

Возвращается: успех

zone

строка

Зона расположения группы сетевых конечных точек.

Возвращается: успех

Авторы

  • Google Inc. (@googlecloudplatform)

Ссылки на сборку

  • Система отслеживания ошибок
  • Главная страница
  • Репозиторий (источники)

© 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_network_endpoint_group_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API