google.cloud.gcp_compute_network_info – Сбор информации о сети GCP
Примечание
Этот плагин входит в состав коллекции google.cloud (версия 1.0.2).
Для его установки используйте: 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
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. |
| env_type строка | Указывает, в какой среде Ansible выполняется данный модуль. Это не следует устанавливать, если вы не знаете, что делаете. Это изменяет только строку User Agent для всех запросов к API. | |
| filters список / элементы=строка | Список пар значений фильтров. Доступные фильтры перечислены здесь https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке будет добавлен как условие AND (filter1 и filter2). | |
| project строка | Проект Google Cloud Platform для использования. | |
| 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. - Для аутентификации можно установить 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 сложная структура | всегда | Список ресурсов | ||
| autoCreateSubnetworks логический тип | успех | При установке в значение `true`, сеть создаётся в режиме "автоматического создания подсетей", и для каждого региона будет автоматически создаваться подсеть в диапазоне адресов `10.128.0.0/9`. При установке в значение `false`, сеть создаётся в режиме "настраиваемого создания подсетей", так что пользователь может явно подключить ресурсы подсети. | ||
| creationTimestamp строка | успех | Дата и время создания в формате RFC3339. | ||
| description строка | успех | Необязательное описание этого ресурса. Для изменения этого поля требуется повторное создание ресурса. | ||
| gateway_ipv4 строка | успех | Адрес шлюза для маршрутизации по умолчанию из сети. Это значение выбирается GCP. | ||
| id целое число | успех | Уникальный идентификатор ресурса. | ||
| mtu целое число | успех | Максимальный размер пакета в байтах. Минимальное значение для этого поля составляет 1460, а максимальное — 1500 байт. | ||
| name строка | успех | Имя ресурса. Указывается клиентом при создании ресурса. Длина имени должна составлять от 1 до 63 символов и соответствовать RFC1035. То есть длина имени должна составлять от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. | ||
| routingConfig сложная структура | успех | Конфигурация маршрутизации на уровне сети для этой сети. Используется Cloud Router для определения типа поведения маршрутизации на всей сети. | ||
| routingMode строка | успех | Режим маршрутизации на всей сети. Если установлено значение `REGIONAL`, облачные маршрутизаторы этой сети будут рекламировать маршруты только с подсетями этой сети в том же регионе, что и маршрутизатор. Если установлено значение `GLOBAL`, облачные маршрутизаторы этой сети будут рекламировать маршруты со всеми подсетями этой сети в разных регионах. | ||
| subnetworks список / элементы=строка | успех | Определяемые сервером полностью квалифицированные URL-адреса всех подсетей в этой сети. | ||
Авторы
- Google Inc. (@googlecloudplatform)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/google/cloud/gcp_compute_network_info_module.html