Spec-Zone.ru › Ansible

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

Примечание

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

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

Для её установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля требуются дополнительные компоненты, см. Требования для получения подробностей.

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

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

Описание

  • Управляет ресурсом сети VPC или сети legacy в GCP.

Требования

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

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

Параметры

Параметр

Комментарии

access_token

строка

Токен доступа OAuth2, если тип аутентификации accesstoken.

auth_kind

строка / обязательно

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

Варианты:

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

auto_create_subnetworks

логическое

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

При значении `false`, сеть создаётся в режиме «настраиваемых подсетей», поэтому пользователь может явно подключить ресурсы подсети.

Варианты:

  • false
  • true

description

строка

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

env_type

строка

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

Это поле следует устанавливать только в том случае, если вам это известно.

Это поле изменяет только строку пользовательского агента для всех запросов к 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 для определения типа поведения маршрутизации на всей сети.

routing_mode

строка / обязательно

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

Некоторые допустимые значения: «REGIONAL», «GLOBAL»

scopes

список / элементы=строка

Массив областей, которые будут использоваться

service_account_contents

jsonarg

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

service_account_email

строка

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

service_account_file

путь

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

state

строка

Указывает, должен ли заданный объект существовать в 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`, сеть создается в режиме «настройка подсетей вручную», поэтому пользователь может явно подключить ресурсы подсетей.

Возвращаемое значение: success

creationTimestamp

string

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

Возвращаемое значение: success

description

string

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

Возвращаемое значение: success

gateway_ipv4

string

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

Возвращаемое значение: success

id

integer

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

Возвращаемое значение: success

mtu

integer

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

Возвращаемое значение: success

name

string

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

Возвращаемое значение: success

routingConfig

complex

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

Возвращаемое значение: success

routingMode

string

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

Возвращаемое значение: success

subnetworks

list / elements=string

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

Возвращаемое значение: success

Авторы

  • Google Inc. (@googlecloudplatform)

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

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

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

Spec-Zone.ru

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