google.cloud.gcp_compute_route_info – Сбор информации о маршруте GCP
Примечание
Этот плагин входит в состав коллекции google.cloud (версия 1.0.2).
Для его установки используйте: 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
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| 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. - для аутентификации можно установить 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 сложный тип | всегда | Список ресурсов | |
| description строка | успех | Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. | |
| destRange строка | успех | Диапазон назначения исходящих пакетов, к которому применяется этот маршрут. Поддерживается только IPv4. | |
| name строка | успех | Имя ресурса. Предоставляется клиентом при создании ресурса. Длина имени должна быть от 1 до 63 символов и соответствовать RFC1035. То есть, длина имени должна быть от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. | |
| network словарь | успех | Сеть, к которой применяется этот маршрут. | |
| nextHopGateway строка | успех | 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 словарь | успех | 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-адресов. | |
| nextHopInstance словарь | успех | 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 строка | успех | Сеть IP-адрес экземпляра, который должен обрабатывать соответствующие пакеты. | |
| nextHopNetwork строка | успех | URL сети, которая должна обрабатывать соответствующие пакеты. | |
| nextHopVpnTunnel словарь | успех | URL туннеля VPN, который должен обрабатывать соответствующие пакеты. | |
| priority целое число | успех | Приоритет этого маршрута. Приоритет используется для разрешения конфликтов в случаях, когда существует более одного совпадающего маршрута с одинаковой длиной префикса. В случае двух маршрутов с одинаковой длиной префикса побеждает маршрут с наименьшим значением приоритета. Значение по умолчанию — 1000. Допустимый диапазон — от 0 до 65535. | |
| tags список / элементы=строка | успех | Список тегов экземпляров, к которым применяется этот маршрут. | |
Авторы
- 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_route_info_module.html