google.cloud.gcp_compute_network – Создаёт сеть GCP
Примечание
Этот плагин входит в состав коллекции google.cloud (версия 1.0.2).
Для его установки используйте: ansible-galaxy collection install google.cloud.
Для использования в книге задач, укажите: google.cloud.gcp_compute_network.
Обзор
- Управляет ресурсами сети VPC или устаревшей сетью в GCP.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. | |
| auto_create_subnetworks логическое значение |
| При установке в «истина», сеть создается в режиме «авто-подсеть» и автоматически создает подсеть для каждого региона в диапазоне адресов `10.128.0.0/9`. При установке в «ложь», сеть создается в режиме «специальная подсеть», поэтому пользователь может явно подключить ресурсы подсети. | |
| description строка | Необязательное описание этого ресурса. Для изменения этого поля необходимо создать новый ресурс. | ||
| env_type строка | Указывает, в какой среде Ansible выполняется этот модуль. Не устанавливайте это значение, если вы не знаете, что делаете. Это изменяет только строку User Agent для любых запросов к API. | ||
| mtu целое число | Максимальный размер блока в байтах. Минимальное значение этого поля — 1460 байт, максимальное — 1500 байт. | ||
| name строка / обязательно | Имя ресурса. Предоставляется клиентом при создании ресурса. Длина имени должна составлять 1–63 символа и соответствовать RFC1035. То есть длина имени должна составлять 1–63 символа и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. | ||
| project строка | Проект Google Cloud Platform для использования. | ||
| routing_config словарь | Конфигурация маршрутизации на уровне сети для этой сети. Используется Cloud Router для определения типа поведения маршрутизации на всей сети. | ||
| routing_mode строка / обязательно | Режим маршрутизации на всей сети для использования. Если установлено значение `REGIONAL`, облачные маршрутизаторы этой сети будут рекламировать маршруты только с подсетями этой сети в том же регионе, что и маршрутизатор. Если установлено значение `GLOBAL`, облачные маршрутизаторы этой сети будут рекламировать маршруты со всеми подсетями этой сети по всем регионам. Некоторые допустимые значения: «REGIONAL», «GLOBAL» | ||
| scopes список / элементы=строка | Массив используемых областей | ||
| service_account_contents jsonarg | Содержимое файла JSON учетной записи службы, либо в словаре, либо в виде строки JSON, представляющей его. | ||
| service_account_email строка | Необязательный адрес электронной почты учетной записи службы, если выбрано «machineaccount», и пользователь не хочет использовать адрес электронной почты по умолчанию. | ||
| service_account_file путь | Путь к файлу JSON учетной записи службы, если выбран тип «serviceaccount». | ||
| state строка |
| Нужно ли наличие объекта в GCP | |
Примечания
Примечание
- Ссылка на API: https://cloud.google.com/compute/docs/reference/rest/v1/networks
- Официальная документация: https://cloud.google.com/vpc/docs/vpc
- для аутентификации можно установить 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: create a network
google.cloud.gcp_compute_network:
name: test_object
auto_create_subnetworks: 'true'
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Возвращаемые значения
Общие возвращаемые значения описаны в документации. Ниже приведены поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| autoCreateSubnetworks логическое значение | успешно | При установке в «истина», сеть создается в режиме «авто-подсеть» и автоматически создает подсеть для каждого региона в диапазоне адресов `10.128.0.0/9`. При установке в «ложь», сеть создается в режиме «специальная подсеть», поэтому пользователь может явно подключить ресурсы подсети. | |
| 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_module.html
