gcp_compute_router – Создаёт маршрутизатор GCP
Новая версия с 2.7.
Описание
- Представляет ресурс маршрутизатора.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. | ||
| bgp - | Информация BGP, специфичная для этого маршрутизатора. | |||
| advertise_mode - |
| Пользовательский флаг, указывающий, какой режим использовать для рекламы. Допустимые значения этого перечисления: 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 - / обязательно | Ссылка на сеть, к которой принадлежит этот маршрутизатор. Это поле представляет ссылку на ресурс сети в GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом 'selfLink' и значением selfLink вашего ресурса. Во-вторых, вы можете добавить `register: имя-ресурса` к задаче gcp_compute_network и затем установить это поле network в "{{ имя-ресурса }}" | |||
| project строка | Проект Google Cloud Platform для использования. | |||
| region - / обязательно | Регион, в котором находится маршрутизатор. | |||
| scopes список | Массив используемых областей. | |||
| service_account_contents строка | Строка, представляющая содержимое файла JSON учетной записи службы. Это не должно передаваться как словарь, а как строка с точным содержимым файла JSON учетной записи службы (валидный JSON). | |||
| service_account_email строка | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. | |||
| service_account_file путь | Путь к файлу JSON учетной записи службы, если в качестве типа выбран serviceaccount. | |||
| state - |
| Должен ли данный объект существовать в 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. - Для аутентификации можно задать service_account_contents с помощью переменной окружения
GCP_SERVICE_ACCOUNT_CONTENTS. - Для аутентификации можно задать auth_kind с помощью переменной окружения
GCP_AUTH_KIND. - Для аутентификации можно задать scopes с помощью переменной окружения
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения в книге задач не заданы.
- Параметры 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: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Возвращаемые значения
Общие возвращаемые значения описаны в документе, а ниже указаны поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| bgp сложный | успех | Информация BGP, специфичная для этого маршрутизатора. | ||
| advertisedGroups список | успех | Указанный пользователем список групп префиксов для объявления в пользовательском режиме. Это поле может быть заполнено только в том случае, если advertiseMode равен CUSTOM и объявляется всем peer-маршрутизаторам. Эти группы будут объявлены дополнительно к любым указанным префиксам. Оставьте это поле пустым, чтобы не объявлять никаких пользовательских групп. В этом поле перечисления есть одно допустимое значение: ALL_SUBNETS . | ||
| advertisedIpRanges сложный | успех | Указанный пользователем список отдельных диапазонов IP-адресов для объявления в пользовательском режиме. Это поле может быть заполнено только в том случае, если advertiseMode равен CUSTOM и объявляется всем peer-маршрутизаторам. Эти диапазоны IP-адресов будут объявлены дополнительно к любым указанным группам. Оставьте это поле пустым, чтобы не объявлять никаких пользовательских диапазонов IP-адресов. | ||
| description строка | успех | Указанное пользователем описание диапазона IP-адресов. | ||
| range строка | успех | Диапазон IP-адресов для объявления. Значение должно быть строкой в формате CIDR. | ||
| advertiseMode строка | успех | Указанный пользователем флаг для указания режима объявления. Допустимые значения этого поля перечисления: DEFAULT, CUSTOM . | ||
| asn целое число | успех | Локальный номер автономной системы BGP (ASN). Должен быть частным ASN RFC6996, 16-битовым или 32-битовым. Значение будет фиксированным для этого ресурса маршрутизатора. Все VPN-туннели, подключенные к этому маршрутизатору, будут иметь одинаковый локальный ASN. | ||
| creationTimestamp строка | успех | Маркер времени создания в текстовом формате 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.8/modules/gcp_compute_router_module.html
