gcp_compute_router – Создаёт маршрутизатор GCP

Новая версия с 2.7.

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

Описание

Представляет ресурс маршрутизатора.

Требования

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

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

Параметры

Параметр			Варианты/Значения по умолчанию	Комментарии
auth_kind - / обязательно			Варианты: machineaccount serviceaccount application	Тип используемых учетных данных.
bgp -				Информация BGP, специфичная для этого маршрутизатора.
	advertise_mode -		Варианты: DEFAULT ← CUSTOM	Указанный пользователем флаг, указывающий, какой режим использовать для рекламы. Допустимые значения этого поля перечисления: DEFAULT, CUSTOM.
	advertised_groups -			Указанный пользователем список групп префиксов для рекламы в режиме CUSTOM. Это поле может быть заполнено только в случае, если advertiseMode равен CUSTOM и реклама выполняется всем peer-маршрутизаторам. Эти группы будут рекламироваться в дополнение к любым указанным префиксам. Оставьте это поле пустым, чтобы не рекламировать дополнительные группы. Это поле перечисления имеет одно допустимое значение: ALL_SUBNETS.
	advertised_ip_ranges -			Указанный пользователем список отдельных диапазонов IP-адресов для рекламы в режиме CUSTOM. Это поле может быть заполнено только в случае, если advertiseMode равен CUSTOM и реклама выполняется всем peer-маршрутизаторам. Эти диапазоны IP-адресов будут рекламироваться в дополнение к любым указанным группам. Оставьте это поле пустым, чтобы не рекламировать дополнительные диапазоны IP-адресов.
		description -		Описание, указанное пользователем, для диапазона IP-адресов.
		range -		Диапазон IP-адресов для рекламы. Значение должно быть строкой в формате CIDR.
	asn - / обязательно			Локальный номер автономной системы BGP (ASN). Должен быть частным ASN в соответствии с RFC6996, 16-разрядным или 32-разрядным. Значение будет фиксированным для этого ресурса маршрутизатора. Все VPN-туннели, подключенные к этому маршрутизатору, будут иметь тот же локальный ASN.
description -				Необязательное описание этого ресурса.
name - / обязательно				Имя ресурса. Длина имени должна составлять 1-63 символа и соответствовать RFC1035. То есть длина должна быть 1-63 символа, и имя должно соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
network - / обязательно				Ссылка на сеть, к которой принадлежит этот маршрутизатор.
project -			По умолчанию: null	Проект Google Cloud Platform для использования.
region - / обязательно				Регион, в котором находится маршрутизатор.
scopes -				Массив используемых областей.
service_account_email -				Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию.
service_account_file -				Путь к файлу JSON учетной записи службы, если в качестве типа выбрано serviceaccount.
state -			Варианты: present ← absent	Нужно ли создать объект в GCP

Примечания

Примечание

Ссылка на API: https://cloud.google.com/compute/docs/reference/rest/v1/routers
Маршрутизатор Google Cloud: https://cloud.google.com/router/docs/
Для аутентификации можно установить service_account_file с помощью переменной среды GCP_SERVICE_ACCOUNT_FILE.
Для аутентификации можно установить 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
  gcp_compute_network:
      name: "network-router"
      project: "{{ gcp_project }}"
      auth_kind: "{{ gcp_cred_kind }}"
      service_account_file: "{{ gcp_cred_file }}"
      state: present
  register: network

- name: create a router
  gcp_compute_router:
      name: "test_object"
      network: "{{ network }}"
      bgp:
        asn: 64514
        advertise_mode: CUSTOM
        advertised_groups:
        - ALL_SUBNETS
        advertised_ip_ranges:
        - range: 1.2.3.4
        - range: 6.7.0.0/16
      region: us-central1
      project: "test_project"
      auth_kind: "service_account"
      service_account_file: "/tmp/auth.pem"
      state: present

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:

Ключевые данные			Возвращаемое значение	Описание
bgp сложный			успех	Информация о BGP, специфичная для этого маршрутизатора.
	advertise_mode строка		успех	Указанный пользователем флаг, определяющий режим использования для рекламы. Допустимые значения этого поля перечисления: DEFAULT, CUSTOM .
	advertised_groups список		успех	Указанный пользователем список групп префиксов для рекламы в пользовательском режиме. Это поле может быть заполнено только в том случае, если advertiseMode имеет значение CUSTOM и рекламируется всем peer-маршрутизаторам. Эти группы будут рекламироваться дополнительно к любым указанным префиксам. Оставьте это поле пустым, чтобы не рекламировать пользовательские группы. Это поле перечисления имеет одно допустимое значение: ALL_SUBNETS .
	advertised_ip_ranges сложный		успех	Указанный пользователем список отдельных диапазонов IP-адресов для рекламы в пользовательском режиме. Это поле может быть заполнено только в том случае, если advertiseMode имеет значение CUSTOM и рекламируется всем peer-маршрутизаторам. Эти диапазоны IP-адресов будут рекламироваться дополнительно к любым указанным группам. Оставьте это поле пустым, чтобы не рекламировать пользовательские диапазоны IP-адресов.
		description строка	успех	Указанное пользователем описание для диапазона IP-адресов.
		range строка	успех	Диапазон IP-адресов для рекламы. Значение должно быть строкой в формате CIDR.
	asn целое число		успех	Местный номер автономной системы BGP (ASN). Должен быть частным ASN RFC6996, 16-битовым или 32-битовым. Значение будет фиксироваться для этого ресурса маршрутизатора. Все VPN-туннели, подключенные к этому маршрутизатору, будут иметь тот же локальный ASN.
creation_timestamp строка			успех	Маркер времени создания в текстовом формате RFC3339.
description строка			успех	Необязательное описание этого ресурса.
id целое число			успех	Уникальный идентификатор ресурса.
name строка			успех	Имя ресурса. Имя должно содержать 1–63 символа и соответствовать RFC1035. То есть, имя должно содержать от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
network словарь			успех	Ссылка на сеть, к которой принадлежит этот маршрутизатор.
region строка			успех	Регион, в котором находится маршрутизатор.

Статус

Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

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.7/modules/gcp_compute_router_module.html