Spec-Zone.ru › Ansible

Модуль google.cloud.gcp_compute_network — создание сети GCP

Примечание

Этот модуль входит в коллекцию google.cloud (версия 1.13.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: 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

Параметры

Параметр

Комментарии

access_token

string

Токен доступа OAuth2, если тип учетных данных — accesstoken.

auth_kind

string / обязательный

Тип используемых учетных данных.

Варианты:

  • "application"
  • "machineaccount"
  • "serviceaccount"
  • "accesstoken"

auto_create_subnetworks

boolean

Если задано значение `true`, сеть создается в режиме автоматического создания подсетей, и для каждого региона автоматически создается подсеть в диапазоне адресов `10.128.0.0/9`.

Если задано значение `false`, сеть создается в режиме пользовательских подсетей, чтобы пользователь мог явно подключать ресурсы подсетей.

Варианты:

  • false
  • true

description

string

Необязательное описание этого ресурса. Чтобы изменить это поле, ресурс необходимо создать заново.

env_type

string

Указывает, в какой среде Ansible выполняется этот модуль.

Не задавайте это значение, если не знаете, что делаете.

Это влияет только на строку User Agent для всех запросов API.

mtu

integer

Максимальный размер передаваемого блока (MTU) в байтах. Минимальное значение этого поля — 1460, максимальное — 1500 байт.

name

string / обязательный

Имя ресурса. Указывается клиентом при создании ресурса. Имя должно содержать от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно содержать от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`: первый символ должен быть строчной латинской буквой, а все последующие символы, кроме последнего, могут быть дефисом, строчной латинской буквой или цифрой; последний символ не может быть дефисом.

project

string

Проект Google Cloud Platform, который будет использоваться.

routing_config

dictionary

Конфигурация маршрутизации на уровне этой сети. Используется Cloud Router для определения типа маршрутизации, применяемого во всей сети.

routing_mode

string / обязательный

Режим маршрутизации, применяемый во всей сети. Если задано значение `REGIONAL`, облачные маршрутизаторы этой сети будут объявлять маршруты только для подсетей этой сети, расположенных в том же регионе, что и маршрутизатор. Если задано значение `GLOBAL`, облачные маршрутизаторы этой сети будут объявлять маршруты для всех подсетей этой сети во всех регионах.

Допустимые варианты: «REGIONAL», «GLOBAL»

scopes

list / elements=string

Массив используемых областей доступа

service_account_contents

jsonarg

Содержимое JSON-файла учетной записи службы в виде словаря или JSON-строки, представляющей его.

service_account_email

string

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

service_account_file

path

Путь к JSON-файлу учетной записи службы, если в качестве типа выбрано serviceaccount.

state

string

Должен ли указанный объект существовать в GCP

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

Примечания

Примечание

  • Справочник 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.
  • Для аутентификации можно задать access_token с помощью переменной окружения GCP_ACCESS_TOKEN.
  • Для аутентификации можно задать 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

boolean

Если задано значение `true`, сеть создается в режиме автоматического создания подсетей, и для каждого региона автоматически создается подсеть в диапазоне адресов `10.128.0.0/9`.

Если задано значение `false`, сеть создается в режиме пользовательских подсетей, чтобы пользователь мог явно подключать ресурсы подсетей.

Возвращается: при успехе

creationTimestamp

string

Время создания в текстовом формате RFC3339.

Возвращается: при успехе

description

string

Необязательное описание этого ресурса. Чтобы изменить это поле, ресурс необходимо создать заново.

Возвращается: при успехе

gateway_ipv4

string

Адрес шлюза для маршрутизации по умолчанию за пределы сети. Это значение выбирается GCP.

Возвращается: при успехе

id

integer

Уникальный идентификатор ресурса.

Возвращается: при успехе

mtu

integer

Максимальный размер передаваемого блока (MTU) в байтах. Минимальное значение этого поля — 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 / elements=string

Полные URL-адреса всех подсетей в этой сети, определяемые сервером.

Возвращается: при успехе

Авторы

  • Google Inc. (@googlecloudplatform)

Ссылки на коллекцию

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (исходный код)

© 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_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API