Модуль google.cloud.gcp_compute_route_info – Сбор информации о маршруте GCP
Примечание
Этот модуль является частью коллекции google.cloud (версия 1.4.1).
Возможно, эта коллекция уже установлена, если вы используете пакет 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 строка | Токен доступа OAuth2, если тип аутентификации — accesstoken. |
auth_kind строка / обязательный | Тип используемых учетных данных. Варианты:
|
env_type строка | Указывает среду Ansible, в которой выполняется этот модуль. Не устанавливайте это значение, если вы не знаете, что делаете. Это лишь изменяет строку User Agent для любых запросов к API. |
filters список / элементы=строка | Список пар значений фильтров. Доступные фильтры перечислены здесь https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке будет добавлен как условие И (filter1 и filter2). |
project строка | Проект Google Cloud Platform для использования. |
scopes список / элементы=строка | Массив используемых областей |
service_account_contents jsonarg | Содержимое файла JSON учетной записи сервиса, либо в виде словаря, либо как JSON-строка, его представляющая. |
service_account_email строка | Дополнительный адрес электронной почты учетной записи сервиса, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. |
service_account_file путь | Путь к файлу 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 Обратите внимание, что это может использоваться только тогда, когда destRange является общедоступным (не RFC 1918) диапазоном IP CIDR. Возвращается: успех |
|
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 туннеля VPN, который должен обрабатывать соответствующие пакеты. Возвращается: успех |
|
priority integer |
Приоритет этого маршрута. Приоритет используется для разрешения коллизий в случаях, когда существует несколько совпадающих маршрутов с одинаковой длиной префикса. В случае двух маршрутов с одинаковой длиной префикса выигрывает тот, у которого значение приоритета меньше. Значение по умолчанию равно 1000. Допустимый диапазон — от 0 до 65535. Возвращается: успех |
|
tags list / elements=string |
Список тегов экземпляров, к которым применяется этот маршрут. Возвращается: успех |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/google/cloud/gcp_compute_route_info_module.html