Модуль google.cloud.gcp_appengine_firewall_rule_info – сбор сведений о FirewallRule в GCP
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.13.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля требуются дополнительные компоненты. Подробности см. в разделе Требования.
Чтобы использовать модуль в сценарии, укажите: google.cloud.gcp_appengine_firewall_rule_info.
Краткое описание
- Сбор сведений о FirewallRule в 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. |
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 firewall rule
gcp_appengine_firewall_rule_info:
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
Возвращаемые значения
Общие возвращаемые значения описаны здесь. Ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
resources complex | Список ресурсов Возвращается: всегда |
|
action string |
Действие, которое необходимо выполнить, если это правило сработает. Возвращается: при успешном выполнении |
|
description string |
Необязательное текстовое описание этого правила. Возвращается: при успешном выполнении |
|
priority integer |
Положительное целое число, определяющее порядок проверки правил. Сначала проверяются правила с наименьшим значением приоритета. Правило по умолчанию с приоритетом Int32.MaxValue соответствует всему трафику IPv4 и IPv6, если ни одно из предыдущих правил не сработало. Пользователь может изменить только действие этого правила. Возвращается: при успешном выполнении |
|
sourceRange string |
IP-адрес или диапазон в нотации CIDR, для запросов с которого применяется это правило. Возвращается: при успешном выполнении |
Ссылки на коллекцию
© 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_appengine_firewall_rule_info_module.html