Модуль google.cloud.gcp_compute_subnetwork_info — Сбор информации о подсети GCP

Примечание

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

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

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

Чтобы использовать его в плане, укажите: google.cloud.gcp_compute_subnetwork_info.

Обзор
Требования
Параметры
Примечания
Примеры
Значения возврата

Обзор

Сбор информации о подсети GCP

Требования

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

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 вы запускаете этот модуль. Этого параметра следует избегать, если вы не уверены. Изменяет только строку имени пользователя для запросов к API.
filters список / элементы=строка	Список пар значений фильтров. Доступные фильтры перечислены здесь https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке будет добавлен как условие И (filter1 и filter2).
project строка	Проект Google Cloud Platform для использования.
region строка / обязательно	Регион GCP для этой подсети.
scopes список / элементы=строка	Массив используемых областей
service_account_contents jsonarg	Содержание файла JSON учетной записи службы, представленное либо в виде словаря, либо в виде JSON-строки.
service_account_email строка	Необязательный адрес электронной почты учетной записи службы, если выбран тип machineaccount, и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь	Путь к файлу JSON учетной записи службы, если тип учетных данных — serviceaccount.

Примечания

Примечание

для аутентификации можно задать 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 subnetwork
  gcp_compute_subnetwork_info:
    region: us-west1
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

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

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

Ключ	Описание
resources сложный	Список ресурсов Возвращается: всегда
creationTimestamp строка	Маркер создания в формате RFC3339. Возвращается: успех
description строка	Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. Это поле можно установить только во время создания ресурса. Возвращается: успех
gatewayAddress строка	Адрес шлюза для маршрутов по умолчанию для достижения адресов назначения за пределами этой подсети. Возвращается: успех
id целое число	Уникальный идентификатор ресурса. Возвращается: успех
ipCidrRange строка	Диапазон внутренних адресов, принадлежащих этой подсети. Укажите это свойство при создании подсети. Например, 10.0.0.0/8 или 192.168.0.0/16. Диапазоны должны быть уникальными и не перекрываться в пределах сети. Поддерживается только IPv4. Возвращается: успех
name строка	Имя ресурса, указанное клиентом при первоначальном создании ресурса. Длина имени должна составлять от 1 до 63 символов и соответствовать RFC1035. То есть, длина имени должна быть от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9][a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. Возвращается:* успех
network словарь	Сеть, к которой принадлежит эта подсеть. Только сети, которые находятся в распределенном режиме, могут иметь подсети. Возвращается: успех
privateIpGoogleAccess логическое значение	При включенном значении, ВМ в этой подсети без внешних IP-адресов могут получить доступ к Google API и службам, используя Private Google Access. Возвращается: успех
privateIpv6GoogleAccess строка	Тип доступа к частному IPv6 Google для ВМ в этой подсети. Возвращается: успех
region строка	Регион GCP для этой подсети. Возвращается: успех
secondaryIpRanges сложный	Массив конфигураций для вторичных диапазонов IP-адресов для виртуальных машин, содержащихся в этой подсети. Основной IP такой виртуальной машины должен принадлежать первичному диапазону ipCidrRange подсети. Алиасные IP-адреса могут принадлежать как основному, так и вторичному диапазонам. Возвращается: успех
ipCidrRange строка	Диапазон IP-адресов, принадлежащих вторичному диапазону подсети. Укажите это свойство при создании подсети. Диапазоны должны быть уникальными и не перекрываться со всеми основными и вторичными диапазонами IP в пределах сети. Поддерживается только IPv4. Возвращается: успех
rangeName строка	Имя, связанное со вторичным диапазоном подсети, используемое при добавлении диапазона алиас IP к виртуальной машине. Длина имени должна составлять от 1 до 63 символов и соответствовать RFC1035. Имя должно быть уникальным в пределах подсети. Возвращается: успех

Авторы

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_subnetwork_info_module.html