google.cloud.gcp_compute_network – Создаёт сеть GCP

Примечание

Этот плагин входит в состав коллекции google.cloud (версия 1.0.1).

Для его установки используйте: ansible-galaxy collection install google.cloud.

Для использования в playbook укажите: google.cloud.gcp_compute_network.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Управляет ресурсами сети VPC или устаревшей сетью в GCP.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
auth_kind строка / обязательно		Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
auto_create_subnetworks булево		Варианты: no yes	При значении `true`, сеть создается в режиме "автоматическое создание подсетей", и для каждого региона будет автоматически создаваться подсеть в адресном пространстве `10.128.0.0/9`. При значении `false`, сеть создается в режиме "настройка подсетей вручную", поэтому пользователь может явно подключить ресурсы подсетей.
description строка			Необязательное описание этого ресурса. Для изменения этого поля ресурс необходимо пересоздать.
env_type строка			Указывает, в какой среде Ansible вы выполняете этот модуль. Не устанавливайте это значение, если вы не знаете, что делаете. Это влияет только на строку User Agent для всех запросов API.
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 строка		Варианты: present ← absent	Нужно ли создавать данный объект в 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.
Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
Параметры 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 булево		success	При значении `true`, сеть создается в режиме "автоматическое создание подсетей", и для каждого региона будет автоматически создаваться подсеть в адресном пространстве `10.128.0.0/9`. При значении `false`, сеть создается в режиме "настройка подсетей вручную", поэтому пользователь может явно подключить ресурсы подсетей.
creationTimestamp строка		success	Дата и время создания в формате RFC3339.
description строка		success	Необязательное описание этого ресурса. Для изменения этого поля ресурс необходимо пересоздать.
gateway_ipv4 строка		success	Адрес шлюза для маршрутизации по умолчанию из сети. Это значение выбирается GCP.
id целое число		success	Уникальный идентификатор ресурса.
name строка		success	Имя ресурса. Предоставляется клиентом при создании ресурса. Длина имени должна быть от 1 до 63 символов и соответствовать RFC1035. То есть длина имени должна составлять 1–63 символа и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
routingConfig сложный		success	Конфигурация маршрутизации на уровне сети для этой сети. Используется Cloud Router для определения типа поведения маршрутизации на всей сети.
	routingMode строка	success	Режим маршрутизации на всей сети. Если установлено значение `REGIONAL`, облачные маршрутизаторы этой сети будут рекламировать только маршруты с подсетями этой сети в том же регионе, что и маршрутизатор. Если установлено значение `GLOBAL`, облачные маршрутизаторы этой сети будут рекламировать маршруты со всеми подсетями этой сети в разных регионах.
subnetworks список / элементы=строка		success	Определяемые сервером полные URL-адреса всех подсетей в этой сети.

Авторы

Google Inc. (@googlecloudplatform)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/google/cloud/gcp_compute_network_module.html