Модуль google.cloud.gcp_compute_network_info — Сбор информации о сети GCP
Примечание
Этот модуль является частью коллекции google.cloud (версия 1.4.1).
Эта коллекция, возможно, уже установлена, если вы используете пакет 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 строка | Токен доступа OAuth2, если тип учетных данных — accesstoken. |
auth_kind строка / обязательно | Тип используемых учетных данных. Доступные значения:
|
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_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 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 целое число |
Максимальный размер блока передачи (MTU) в байтах. Минимальное значение для этого поля составляет 1460, а максимальное — 1500 байт. Возвращаемое значение: успех |
|
name строка |
Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. То есть, длина имени должна составлять от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. Возвращаемое значение: успех |
|
routingConfig сложное |
Конфигурация маршрутизации на уровне сети для данной сети. Используется маршрутизатором Cloud для определения типа поведения маршрутизации на всей сети. Возвращаемое значение: успех |
|
routingMode строка |
Режим маршрутизации для всей сети. Если установлено в `REGIONAL`, маршрутизаторы облака этой сети будут рекламировать маршруты только с подсетями этой сети в том же регионе, что и маршрутизатор. Если установлено в `GLOBAL`, маршрутизаторы облака этой сети будут рекламировать маршруты со всеми подсетями этой сети по всем регионам. Возвращаемое значение: успех |
|
subnetworks список / элементы=строка |
Определённые сервером полные URL-адреса всех подсетей в этой сети. Возвращаемое значение: успех |
Ссылки на сборку
© 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_info_module.html
