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" | Указанный пользователем флаг для указания режима рекламы. Допустимые значения этого поля перечисления: DEFAULT, CUSTOM . Некоторые допустимые значения включают: "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. | |||
| 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: имя-ресурса` к задаче gcp_compute_network и затем установить это поле сети в "{{ имя-ресурса }}" | |||
| project строка | Проект Google Cloud Platform для использования. | |||
| region строка / обязательно | Регион, в котором находится маршрутизатор. | |||
| scopes список | Массив используемых областей. | |||
| service_account_contents jsonarg | Содержание файла 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 с помощью переменной среды c(gcp_service_account_file).
- для аутентификации можно установить service_account_contents с помощью переменной среды c(GCP_SERVICE_ACCOUNT_CONTENTS).
- для аутентификации можно установить 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: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| bgp complex | success | Информация о BGP, специфичная для этого маршрутизатора. | ||
| advertisedGroups list | success | Список префиксных групп, указанных пользователем, для рекламы в пользовательском режиме. Это поле может быть заполнено только в том случае, если advertiseMode равен CUSTOM и реклама производится всем узлам маршрутизатора. Эти группы будут рекламироваться в дополнение к любым указанным префиксам. Оставьте это поле пустым, чтобы не рекламировать пользовательские группы. Это поле перечисления имеет одно допустимое значение: ALL_SUBNETS . | ||
| advertisedIpRanges complex | success | Список отдельных диапазонов IP-адресов, указанных пользователем, для рекламы в пользовательском режиме. Это поле может быть заполнено только в том случае, если advertiseMode равен CUSTOM и реклама производится всем узлам маршрутизатора. Эти IP-диапазоны будут рекламироваться в дополнение к любым указанным группам. Оставьте это поле пустым, чтобы не рекламировать пользовательские IP-диапазоны. | ||
| description string | success | Описание диапазона IP-адресов, указанное пользователем. | ||
| range string | success | Диапазон IP-адресов для рекламы. Значение должно быть строкой в формате CIDR. | ||
| advertiseMode string | success | Флаг, указанный пользователем, для указания режима рекламы. Допустимые значения этого поля перечисления: DEFAULT, CUSTOM . | ||
| asn integer | success | Локальный номер автономной системы BGP (ASN). Должен быть частным ASN RFC6996, 16-битовым или 32-битовым. Значение будет фиксировано для этого ресурса маршрутизатора. Все VPN-туннели, которые подключаются к этому маршрутизатору, будут иметь одинаковый локальный ASN. | ||
| creationTimestamp string | success | Дата и время создания в формате RFC3339. | ||
| description string | success | Необязательное описание этого ресурса. | ||
| id integer | success | Уникальный идентификатор ресурса. | ||
| name string | success | Имя ресурса. Длина имени должна быть от 1 до 63 символов и соответствовать RFC1035. То есть, длина должна быть от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть тире, строчной буквой или цифрой, за исключением последнего символа, который не может быть тире. | ||
| network dictionary | success | Ссылка на сеть, к которой принадлежит этот маршрутизатор. | ||
| region string | success | Регион, в котором находится маршрутизатор. | ||
Статус
- Данный модуль не гарантирует обратной совместимости интерфейса. [preview]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.9/modules/gcp_compute_router_module.html
