Spec-Zone.ru › Ansible

google.cloud.gcp_compute_router модуль — Создаёт маршрутизатор GCP

Примечание

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

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

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

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

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

Обзор

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

Требования

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

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

Параметры

Параметр

Комментарии

access_token

строка

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

auth_kind

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

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

Варианты:

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

bgp

словарь

Информация BGP, специфичная для данного маршрутизатора.

advertise_mode

строка

Указанный пользователем флаг, определяющий режим использования для объявления.

Некоторые допустимые значения включают: «DEFAULT», «CUSTOM»

По умолчанию: "DEFAULT"

advertised_groups

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

Указанный пользователем список групп префиксов для объявления в режиме CUSTOM.

Это поле может быть заполнено только в том случае, если advertiseMode — CUSTOM и объявляется всем узлам маршрутизатора. Эти группы будут объявлены дополнительно к любым указанным префиксам. Оставьте это поле пустым, чтобы не объявлять пользовательские группы.

Это поле перечисления имеет единственное допустимое значение: ALL_SUBNETS.

advertised_ip_ranges

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

Указанный пользователем список отдельных диапазонов IP-адресов для объявления в режиме CUSTOM. Это поле может быть заполнено только в том случае, если advertiseMode — CUSTOM и объявляется всем узлам маршрутизатора. Эти IP-диапазоны будут объявлены дополнительно к любым указанным группам.

Оставьте это поле пустым, чтобы не объявлять пользовательские диапазоны IP-адресов.

description

строка

Указанное пользователем описание для диапазона IP-адресов.

range

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

Диапазон IP-адресов для объявления. Значение должно быть строкой в формате CIDR.

asn

целое число / обязательно

Местный номер автономной системы BGP (ASN). Должен быть частным ASN RFC6996, 16-битный или 32-битный. Значение будет фиксированным для этого ресурса маршрутизатора. Все VPN-туннели, подключенные к этому маршрутизатору, будут иметь одинаковый локальный ASN.

description

строка

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

env_type

строка

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

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

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

name

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

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

network

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

Ссылка на сеть, к которой принадлежит этот маршрутизатор.

Это поле представляет ссылку на ресурс сети в GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом «selfLink» и значением selfLink вашего ресурса. Во-вторых, вы можете добавить `register: name-of-resource` к задаче gcp_compute_network, а затем установить это поле network в «{{ name-of-resource }}»

project

строка

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

region

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

Регион, в котором находится маршрутизатор.

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/routers
  • Маршрутизатор Google Cloud: https://cloud.google.com/router/docs/
  • для аутентификации можно установить 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: network-router
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: network

- name: create a router
  google.cloud.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: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

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

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

Ключ

Описание

bgp

сложный

Информация BGP, специфичная для данного маршрутизатора.

Возвращено: success

advertisedGroups

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

Пользовательский список групп префиксов для рекламы в пользовательском режиме.

Это поле может быть заполнено только в том случае, если advertiseMode CUSTOM и рекламируется всем peer маршрутизатора. Эти группы будут рекламироваться в дополнение к любым указанным префиксам. Оставьте это поле пустым, чтобы не рекламировать пользовательских групп.

Это поле перечисления имеет одно допустимое значение: ALL_SUBNETS .

Возвращено: success

advertisedIpRanges

сложный

Пользовательский список отдельных IP-диапазонов для рекламы в пользовательском режиме. Это поле может быть заполнено только в том случае, если advertiseMode CUSTOM и рекламируется всем peer маршрутизатора. Эти IP-диапазоны будут рекламироваться в дополнение к любым указанным группам.

Оставьте это поле пустым, чтобы не рекламировать пользовательских IP-диапазонов.

Возвращено: success

description

строка

Пользовательское описание IP-диапазона.

Возвращено: success

range

строка

Диапазон IP-адресов для рекламы. Значение должно быть строкой в формате CIDR.

Возвращено: success

advertiseMode

строка

Пользовательский флаг для указания режима рекламы.

Возвращено: success

asn

целое число

Локальный номер автономной системы BGP (ASN). Должен быть частным ASN RFC6996, 16-битным или 32-битным. Значение будет фиксироваться для этого ресурса маршрутизатора. Все VPN-туннели, подключенные к этому маршрутизатору, будут иметь одинаковый локальный ASN.

Возвращено: success

creationTimestamp

строка

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

Возвращено: success

description

строка

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

Возвращено: success

id

целое число

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

Возвращено: success

name

строка

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

Возвращено: success

network

словарь

Ссылка на сеть, к которой принадлежит этот маршрутизатор.

Возвращено: success

region

строка

Регион, в котором находится маршрутизатор.

Возвращено: 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_router_module.html

Spec-Zone.ru

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