Модуль google.cloud.gcp_appengine_firewall_rule_info – Сбор информации о правиле брандмауэра GCP

Примечание

Этот модуль входит в коллекцию google.cloud (версия 1.4.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля требуются дополнительные зависимости. Подробности см. в разделе Требования.

Для использования в playbook укажите: google.cloud.gcp_appengine_firewall_rule_info.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Сбор информации о правиле брандмауэра GCP

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0

Параметры

Параметр	Комментарии
access_token строка	Токен доступа OAuth2, если тип аутентификации — accesstoken.
auth_kind строка / обязательно	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
env_type строка	Указывает, в какой среде Ansible выполняется этот модуль. Не устанавливайте это значение, если вы не знаете, что делаете. Это лишь изменяет строку User Agent для всех API-запросов.
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.
Значения переменных среды будут использованы только в том случае, если значения в playbook не заданы.
Параметры service_account_email и service_account_file взаимоисключающие.

Примеры

- name: get info on a firewall rule
  gcp_appengine_firewall_rule_info:
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

Возвращаемые значения

Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:

Ключ	Описание
resources сложный	Список ресурсов Возвращается: всегда
action строка	Действие, которое следует предпринять, если это правило соответствует. Возвращается: успех
description строка	Необязательное текстовое описание этого правила. Возвращается: успех
priority целое число	Положительное целое число, определяющее порядок оценки правил. Правила с наименьшим приоритетом оцениваются первыми. Правило по умолчанию с приоритетом Int32.MaxValue соответствует всем трафику IPv4 и IPv6, когда предыдущее правило не соответствует. Только действие этого правила может быть изменено пользователем. Возвращается: успех
sourceRange строка	IP-адрес или диапазон, определенный с использованием нотации CIDR, для запросов, к которым применяется это правило. Возвращается: успех

Авторы

Google Inc. (@googlecloudplatform)

Ссылки на коллекцию

© 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_appengine_firewall_rule_info_module.html