модуль google.cloud.gcp_compute_route_info — сбор сведений о маршруте GCP
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.13.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: google.cloud.gcp_compute_route_info.
Краткое описание
- Сбор сведений о маршруте GCP
Требования
На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен доступа OAuth2, если тип учётных данных — accesstoken. |
auth_kind string / обязательный | Тип используемых учётных данных. Варианты:
|
env_type string | Указывает, в какой среде Ansible выполняется этот модуль. Не задавайте этот параметр, если не уверены в своих действиях. Он изменяет только строку User Agent для запросов API. |
filters list / элементы=string | Список пар значений фильтров. Доступные фильтры перечислены здесь: https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке добавляется как условие AND (filter1 и filter2). |
project string | Проект Google Cloud Platform, который следует использовать. |
scopes list / элементы=string | Массив областей доступа, которые будут использоваться |
service_account_contents jsonarg | Содержимое JSON-файла учётной записи службы: словарь или JSON-строка, представляющая его. |
service_account_email string | Необязательный адрес электронной почты учётной записи службы, если выбрано machineaccount и пользователь не хочет использовать адрес по умолчанию. |
service_account_file path | Путь к JSON-файлу учётной записи службы, если в качестве типа выбрано serviceaccount. |
Примечания
Примечание
- для аутентификации можно задать 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: get info on a route
gcp_compute_route_info:
filters:
- name = test_object
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
resources complex | Список ресурсов Возвращается: всегда |
|
description string |
Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. Возвращается: при успешном выполнении |
|
destRange string |
Диапазон адресов назначения исходящих пакетов, к которым применяется этот маршрут. Поддерживается только IPv4. Возвращается: при успешном выполнении |
|
name string |
Имя ресурса. Указывается клиентом при создании ресурса. Имя должно содержать от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно содержать от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`: первый символ должен быть строчной буквой, а все последующие символы, кроме последнего, — дефисом, строчной буквой или цифрой; последний символ не может быть дефисом. Возвращается: при успешном выполнении |
|
network dictionary |
Сеть, к которой применяется этот маршрут. Возвращается: при успешном выполнении |
|
nextHopGateway string |
URL шлюза, который должен обрабатывать соответствующие пакеты. В настоящее время можно указать только интернет-шлюз, используя полный или частичный допустимый URL: * https://www.googleapis.com/compute/v1/projects/project/global/gateways/default-internet-gateway * projects/project/global/gateways/default-internet-gateway * global/gateways/default-internet-gateway. Возвращается: при успешном выполнении |
|
nextHopIlb dictionary |
URL правила перенаправления типа loadBalancingScheme=INTERNAL, которое должно обрабатывать соответствующие пакеты. Правило перенаправления можно указать только как частичный или полный URL. Например, допустимы все следующие URL: https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule regions/region/forwardingRules/forwardingRule. Обратите внимание, что этот параметр можно использовать, только если destinationRange — это общедоступный диапазон IP-адресов CIDR (не RFC 1918). Возвращается: при успешном выполнении |
|
nextHopInstance dictionary |
URL экземпляра, который должен обрабатывать соответствующие пакеты. Можно указать полный или частичный URL. Например: * https://www.googleapis.com/compute/v1/projects/project/zones/zone/ instances/instance * projects/project/zones/zone/instances/instance * zones/zone/instances/instance. Возвращается: при успешном выполнении |
|
nextHopIp string |
Сетевой IP-адрес экземпляра, который должен обрабатывать соответствующие пакеты. Возвращается: при успешном выполнении |
|
nextHopNetwork string |
URL сети, которая должна обрабатывать соответствующие пакеты. Возвращается: при успешном выполнении |
|
nextHopVpnTunnel dictionary |
URL VpnTunnel, который должен обрабатывать соответствующие пакеты. Возвращается: при успешном выполнении |
|
priority integer |
Приоритет этого маршрута. Приоритет используется для разрешения равенства, если найдено несколько совпадающих маршрутов с одинаковой длиной префикса. Если длина префикса у двух маршрутов одинакова, выбирается маршрут с наименьшим числовым значением приоритета. Значение по умолчанию — 1000. Допустимый диапазон — от 0 до 65535. Возвращается: при успешном выполнении |
|
tags list / элементы=string |
Список тегов экземпляров, к которым применяется этот маршрут. Возвращается: при успешном выполнении |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/google/cloud/gcp_compute_route_info_module.html
