google.cloud.gcp_compute_router – Создаёт маршрутизатор GCP
Примечание
Этот плагин является частью коллекции google.cloud (версия 1.0.2).
Для его установки используйте: ansible-galaxy collection install google.cloud.
Для использования в playbook, укажите: google.cloud.gcp_compute_router.
Описание
- Представляет ресурс Маршрутизатор.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| auth_kind строка / обязательный |
| Тип используемых учетных данных. | ||
| bgp словарь | Информация BGP, специфичная для этого маршрутизатора. | |||
| advertise_mode строка | По умолчанию: "DEFAULT" | Указанный пользователем флаг, указывающий режим использования для рекламы. Некоторые допустимые значения включают: "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: 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. | ||
Примечания
Примечание
- Ссылка на 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. - для аутентификации можно задать auth_kind, используя переменную среды
GCP_AUTH_KIND. - для аутентификации можно задать scopes, используя переменную среды
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
- Параметры 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, специфичная для этого маршрутизатора. | ||
| advertisedGroups список / элементы=строка | успех | Указанный пользователем список групп префиксов для рекламы в пользовательском режиме. Это поле может быть заполнено только в том случае, если advertiseMode имеет значение CUSTOM и передается всем peer-маршрутизаторам. Эти группы будут рекламироваться дополнительно к любым указанным префиксам. Оставьте это поле пустым, чтобы не рекламировать пользовательские группы. Это поле перечисления имеет одно допустимое значение: ALL_SUBNETS. | ||
| advertisedIpRanges сложный | успех | Указанный пользователем список отдельных диапазонов IP-адресов для рекламы в пользовательском режиме. Это поле может быть заполнено только в том случае, если advertiseMode имеет значение CUSTOM и передается всем peer-маршрутизаторам. Эти диапазоны IP-адресов будут рекламироваться дополнительно к любым указанным группам. Оставьте это поле пустым, чтобы не рекламировать пользовательские диапазоны IP-адресов. | ||
| description строка | успех | Указанное пользователем описание диапазона IP-адресов. | ||
| range строка | успех | Диапазон IP-адресов для рекламы. Значение должно быть строкой в формате CIDR. | ||
| advertiseMode строка | успех | Указанный пользователем флаг, указывающий режим рекламы. | ||
| 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 строка | успех | Регион, в котором находится маршрутизатор. | ||
Авторы
- Google Inc. (@googlecloudplatform)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/google/cloud/gcp_compute_router_module.html
