модуль google.cloud.gcp_compute_network_info — сбор сведений о сети GCP
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.13.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля требуются дополнительные компоненты. Подробнее см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: google.cloud.gcp_compute_network_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 and filter2). |
project string | Проект Google Cloud Platform, который будет использоваться. |
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 network
gcp_compute_network_info:
filters:
- name = test_object
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
resources complex | Список ресурсов Возвращается: всегда |
|
autoCreateSubnetworks boolean |
Если задано значение `true`, сеть создаётся в «режиме автоматических подсетей», и для каждого региона автоматически создаётся подсеть в диапазоне адресов `10.128.0.0/9`. Если задано значение `false`, сеть создаётся в «режиме пользовательских подсетей», позволяя пользователю явно подключать ресурсы подсетей. Возвращается: при успехе |
|
creationTimestamp string |
Метка времени создания в текстовом формате RFC3339. Возвращается: при успехе |
|
description string |
Необязательное описание этого ресурса. Чтобы изменить это поле, ресурс необходимо создать заново. Возвращается: при успехе |
|
gateway_ipv4 string |
Адрес шлюза для маршрутизации по умолчанию за пределы сети. Это значение выбирается GCP. Возвращается: при успехе |
|
id integer |
Уникальный идентификатор ресурса. Возвращается: при успехе |
|
mtu integer |
Максимальный размер блока передачи в байтах. Минимальное значение этого поля — 1460, максимальное — 1500 байт. Возвращается: при успехе |
|
name string |
Имя ресурса. Указывается клиентом при создании ресурса. Имя должно содержать от 1 до 63 символов и соответствовать RFC1035. В частности, оно должно содержать от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`: первый символ должен быть строчной буквой, а все последующие — дефисом, строчной буквой или цифрой, за исключением последнего символа, которым не может быть дефис. Возвращается: при успехе |
|
routingConfig complex |
Конфигурация маршрутизации на уровне сети. Cloud Router использует её, чтобы определить, какой тип поведения маршрутизации в масштабах сети следует применять. Возвращается: при успехе |
|
routingMode string |
Режим маршрутизации для всей сети. Если задано значение `REGIONAL`, облачные маршрутизаторы этой сети будут объявлять маршруты только к подсетям этой сети в том же регионе, что и маршрутизатор. Если задано значение `GLOBAL`, облачные маршрутизаторы этой сети будут объявлять маршруты ко всем подсетям этой сети во всех регионах. Возвращается: при успехе |
|
subnetworks list / элементы=string |
Полные URL-адреса всех подсетей в этой сети, определённые сервером. Возвращается: при успехе |
Ссылки на коллекцию
© 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_network_info_module.html
