gcp_compute_route_info – Сбор информации о маршруте GCP
Новое в версии 2.7.
Обзор
- Сбор информации о маршруте GCP
- Этот модуль назывался
gcp_compute_route_factsдо Ansible 2.9. Способ использования не изменился.
Псевдонимы: gcp_compute_route_facts
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- 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. Каждый дополнительный фильтр в списке будет добавлен как условие AND (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, используя переменную окружения c(gcp_service_account_file).
- для аутентификации можно установить service_account_contents, используя переменную окружения c(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: 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 . | |
| 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 список | успех | Список меток экземпляров, на которые распространяется этот маршрут. | |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом 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.9/modules/gcp_compute_route_info_module.html