Модуль google.cloud.gcp_compute_subnetwork_info — получение сведений о подсети GCP
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.13.0).
Возможно, эта коллекция уже установлена, если вы используете пакет 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 string | Токен доступа OAuth2, если тип учетных данных — accesstoken. |
auth_kind string / обязательный | Тип используемых учетных данных. Варианты:
|
env_type string | Указывает, в какой среде Ansible выполняется этот модуль. Не задавайте этот параметр, если не знаете, что делаете. Этот параметр изменяет только строку User Agent для запросов к API. |
filters list / элементы=string | Список пар значений фильтров. Доступные фильтры перечислены здесь: https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке добавляется как условие AND (filter1 и filter2). |
project string | Проект Google Cloud Platform, который следует использовать. |
region string / обязательный | Регион GCP для этой подсети. |
scopes list / элементы=string | Массив используемых областей доступа |
service_account_contents jsonarg | Содержимое JSON-файла учетной записи службы: в виде словаря или JSON-строки, представляющей его. |
service_account_email string | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию. |
service_account_file path | Путь к 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 complex | Список ресурсов Возвращается: всегда |
|
creationTimestamp string |
Время создания в текстовом формате RFC3339. Возвращается: при успешном выполнении |
|
description string |
Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. Это поле можно задать только во время создания ресурса. Возвращается: при успешном выполнении |
|
gatewayAddress string |
Адрес шлюза для маршрутов по умолчанию, используемых для доступа к адресам назначения за пределами этой подсети. Возвращается: при успешном выполнении |
|
id integer |
Уникальный идентификатор ресурса. Возвращается: при успешном выполнении |
|
ipCidrRange string |
Диапазон внутренних адресов, принадлежащих этой подсети. Укажите это свойство при создании подсети. Например, 10.0.0.0/8 или 192.168.0.0/16. Диапазоны в пределах одной сети должны быть уникальными и не пересекаться. Поддерживается только IPv4. Возвращается: при успешном выполнении |
|
name string |
Имя ресурса, заданное клиентом при его создании. Имя должно содержать от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно содержать от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`: первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой; последний символ не может быть дефисом. Возвращается: при успешном выполнении |
|
network dictionary |
Сеть, к которой относится эта подсеть. Подсети могут входить только в сети, работающие в распределенном режиме. Возвращается: при успешном выполнении |
|
privateIpGoogleAccess boolean |
Если параметр включен, виртуальные машины в этой подсети без внешних IP-адресов могут обращаться к API и сервисам Google с помощью Private Google Access. Возвращается: при успешном выполнении |
|
privateIpv6GoogleAccess string |
Тип частного доступа Google по IPv6 для виртуальных машин в этой подсети. Возвращается: при успешном выполнении |
|
region string |
Регион GCP для этой подсети. Возвращается: при успешном выполнении |
|
secondaryIpRanges complex |
Массив конфигураций вторичных диапазонов IP-адресов для экземпляров виртуальных машин в этой подсети. Основной IP-адрес такой виртуальной машины должен входить в основной диапазон ipCidrRange подсети. Псевдонимы IP-адресов могут входить как в основной, так и во вторичный диапазон. Возвращается: при успешном выполнении |
|
ipCidrRange string |
Диапазон IP-адресов, относящихся к вторичному диапазону этой подсети. Укажите это свойство при создании подсети. Диапазоны должны быть уникальными и не пересекаться с основными и вторичными диапазонами IP-адресов в сети. Поддерживается только IPv4. Возвращается: при успешном выполнении |
|
rangeName string |
Имя, связанное с вторичным диапазоном этой подсети и используемое при добавлении диапазона псевдонимов IP-адресов к экземпляру виртуальной машины. Имя должно содержать от 1 до 63 символов и соответствовать RFC1035. Имя должно быть уникальным в пределах подсети. Возвращается: при успешном выполнении |
Ссылки на коллекцию
© 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_compute_subnetwork_info_module.html
