gcp_compute_interconnect_attachment – Создаёт подключение к межсетевому соединению GCP
Новая версия 2.8.
Описание
- Представляет ресурс подключения к межсетевому соединению (присоединение VLAN). Для получения дополнительной информации см. Создание подключений VLAN.
Требования
Ниже перечислены требования к хосту, на котором выполняется данный модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. |
| candidate_subnets - | До 16 кандидатов префиксов, которые могут быть использованы для ограничения выделения cloudRouterIpAddress и customerRouterIpAddress для данного подключения. Все префиксы должны находиться в пространстве адресов link-local (169.254.0.0/16) и должны быть /29 или короче (/28, /27 и т.д.). Google попытается выбрать неиспользуемый /29 из предоставленного(ых) префикса(ов). Запрос завершится неудачей, если все возможные /29 будут заняты на кромке Google. Если не указано, Google случайным образом выберет неиспользуемый /29 из всего пространства link-local. | |
| description - | Необязательное описание этого ресурса. | |
| edge_availability_domain - | Желаемая область доступности для подключения. Доступно только для типа PARTNER во время создания. Для повышения надёжности клиенты должны настроить пару подключений, по одному на каждую область доступности. Выбранная область доступности будет предоставлена партнёру через ключ сопоставления, чтобы предоставленная цепь находилась в указанной области. Если не указано, значение будет по умолчанию AVAILABILITY_DOMAIN_ANY. | |
| interconnect - | URL базового объекта межсетевого соединения, через который будет проходить трафик данного подключения. Требуется, если тип DEDICATED, не должно быть установлено, если тип PARTNER. | |
| name - / обязательно | Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно быть длиной от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть тире, строчной буквой или цифрой, за исключением последнего символа, который не может быть тире. | |
| project строка | Проект Google Cloud Platform, который следует использовать. | |
| region - / обязательно | Область, в которой находится региональное подключение к межсетевому соединению. | |
| router - / обязательно | URL маршрутизатора облака, который будет использоваться для динамической маршрутизации. Этот маршрутизатор должен находиться в той же области, что и это подключение к межсетевому соединению. Подключение к межсетевому соединению автоматически соединит межсетевое соединение с сетью и областью, в которой настроен маршрутизатор облака. Это поле представляет собой ссылку на ресурс маршрутизатора в GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом 'selfLink' и значением selfLink вашего ресурса. Во-вторых, вы можете добавить `register: name-of-resource` к задаче gcp_compute_router, а затем установить это поле маршрутизатора на "{{ name-of-resource }}" | |
| scopes список | Массив используемых областей. | |
| service_account_contents строка | Строка, представляющая содержимое JSON-файла учетной записи службы. Это не должно передаваться как словарь, а строка, содержащая точное содержимое файла JSON учетной записи службы (корректный JSON). | |
| service_account_email строка | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию. | |
| service_account_file путь | Путь к файлу JSON учетной записи службы, если тип serviceaccount выбран в качестве типа. | |
| state - |
| Указывает, должен ли данный объект существовать в GCP |
| type - |
| Тип подключения к межсетевому соединению, который вы хотите создать. По умолчанию DEDICATED. |
| vlan_tag8021q - | Тег VLAN IEEE 802.1Q для данного подключения, в диапазоне от 2 до 4094. |
Примечания
Примечание
- Для аутентификации можно установить 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. - Значения переменных среды будут использоваться только в том случае, если значения в playbook не установлены.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: create a interconnect attachment
gcp_compute_interconnect_attachment:
name: test_object
region: us-central1
project: test_project
auth_kind: serviceaccount
interconnect: https://googleapis.com/compute/v1/projects/test_project/global/interconnects/...
router: https://googleapis.com/compute/v1/projects/test_project/regions/us-central1/routers/...
service_account_file: "/tmp/auth.pem"
state: present
register: disk
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| candidateSubnets список | успешно | До 16 кандидатов префиксов, которые можно использовать для ограничения выделения cloudRouterIpAddress и customerRouterIpAddress для этого подключения. Все префиксы должны быть в пространстве адресов link-local (169.254.0.0/16) и должны быть /29 или короче (/28, /27 и т.д.). Google попытается выбрать неиспользуемый /29 из предоставленного кандидата префикса(ов). Запрос завершится ошибкой, если все возможные /29 заняты на краю Google. Если не указано, Google случайным образом выберет неиспользуемый /29 из всего пространства link-local. | |
| cloudRouterIpAddress строка | успешно | IPv4-адрес + длина префикса для настройки интерфейса маршрутизатора Google для этого подключения. | |
| creationTimestamp строка | успешно | Отметка времени создания в формате RFC3339. | |
| customerRouterIpAddress строка | успешно | IPv4-адрес + длина префикса для настройки подсетевого интерфейса маршрутизатора клиента для этого подключения. | |
| description строка | успешно | Необязательное описание этого ресурса. | |
| edgeAvailabilityDomain строка | успешно | Желаемая область доступности для подключения. Доступно только для типа PARTNER во время создания. Для повышения надежности клиенты должны настроить пару подключений, по одному на каждую область доступности. Выбранная область доступности будет предоставлена партнеру через ключ сопряжения, чтобы предоставленный канал находился в указанной области. Если не указано, значение по умолчанию будет AVAILABILITY_DOMAIN_ANY. | |
| googleReferenceId строка | успешно | Идентификатор Google, используемый при подаче запросов в службу поддержки Google или для отладки проблем с подключением к бэкенду. | |
| id строка | успешно | Уникальный идентификатор ресурса. Этот идентификатор задаётся сервером. | |
| interconnect строка | успешно | URL базового объекта Interconnect, через который будет проходить трафик этого подключения. Требуется, если тип DEDICATED, не должен быть установлен, если тип PARTNER. | |
| name строка | успешно | Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно иметь длину от 1 до 63 символов и соответствовать RFC1035. То есть, длина имени должна быть от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. | |
| pairingKey строка | успешно | [Только для вывода типа PARTNER. Отсутствует для DEDICATED]. Непрозрачный идентификатор подключения PARTNER, используемый для инициирования подготовки с выбранным партнером. Формат «XXXXX/region/domain». | |
| partnerAsn строка | успешно | [Только для вывода типа PARTNER. Отсутствует для DEDICATED]. Необязательный ASN BGP для маршрутизатора, который должен быть предоставлен партнером уровня 3, если он настроил BGP от имени клиента. | |
| privateInterconnectInfo сложная структура | успешно | Информация, специфичная для подключения Interconnect. Этот параметр заполняется, если подключение Interconnect, к которому оно подключено, имеет тип DEDICATED. | |
| tag8021q целое число | успешно | Тег инкапсуляции 802.1q, используемый для трафика между Google и клиентом, входящего и исходящего из этой сети и региона. | |
| region строка | успешно | Регион, в котором находится региональное подключение Interconnect. | |
| router словарь | успешно | URL маршрутизатора Google Cloud, используемого для динамической маршрутизации. Этот маршрутизатор должен находиться в том же регионе, что и это подключение Interconnect. Подключение Interconnect автоматически подключит Interconnect к сети и региону, в котором настроен маршрутизатор Google Cloud. | |
| state строка | успешно | [Только для вывода] Текущее состояние функциональности этого подключения. | |
| type строка | успешно | Тип подключения InterconnectAttachment, который вы хотите создать. По умолчанию — DEDICATED. | |
| vlanTag8021q целое число | успешно | Тег VLAN IEEE 802.1Q для этого подключения в диапазоне от 2 до 4094. | |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом 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.8/modules/gcp_compute_interconnect_attachment_module.html
