Spec-Zone.ru › Ansible

модуль google.cloud.gcp_compute_firewall_info — Сбор сведений о брандмауэре GCP

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: google.cloud.gcp_compute_firewall_info.

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Сбор сведений о брандмауэре GCP

Требования

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

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

Параметры

Параметр

Комментарии

access_token

string

Токен доступа OAuth2, если выбран тип учетных данных accesstoken.

auth_kind

string / обязательный

Тип используемых учетных данных.

Варианты:

  • "application"
  • "machineaccount"
  • "serviceaccount"
  • "accesstoken"

env_type

string

Указывает среду Ansible, в которой выполняется этот модуль.

Не задавайте это значение, если не знаете, что делаете.

Это значение изменяет только строку User Agent для всех запросов к API.

filters

list / elements=string

Список пар значений фильтров. Доступные фильтры перечислены здесь: https://cloud.google.com/sdk/gcloud/reference/topic/filters.

Каждый дополнительный фильтр в списке добавляется как условие AND (filter1 and filter2).

project

string

Проект Google Cloud Platform, который следует использовать.

scopes

list / elements=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
  gcp_compute_firewall_info:
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

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

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

Ключ

Описание

resources

complex

Список ресурсов

Возвращается: всегда

allowed

complex

Список правил ALLOW, указанных для этого брандмауэра. Каждое правило задает пару «протокол и диапазон портов», описывающую разрешенное подключение.

Возвращается: при успехе

ip_protocol

string

IP-протокол, к которому применяется это правило. Тип протокола необходимо указать при создании правила брандмауэра. В качестве значения можно указать одну из следующих общеизвестных строк протоколов (tcp, udp, icmp, esp, ah, sctp, ipip, all) или номер IP-протокола.

Возвращается: при успехе

ports

list / elements=string

Необязательный список портов, к которым применяется это правило. Это поле применимо только для протоколов UDP или TCP. Каждая запись должна быть целым числом или диапазоном. Если значение не указано, правило применяется к подключениям через любой порт.

Примеры значений: [“22”], [“80”,”443”] и [“12345-12349”].

Возвращается: при успехе

creationTimestamp

string

Время создания в текстовом формате RFC3339.

Возвращается: при успехе

denied

complex

Список правил DENY, указанных для этого брандмауэра. Каждое правило задает пару «протокол и диапазон портов», описывающую запрещенное подключение.

Возвращается: при успехе

ip_protocol

string

IP-протокол, к которому применяется это правило. Тип протокола необходимо указать при создании правила брандмауэра. В качестве значения можно указать одну из следующих общеизвестных строк протоколов (tcp, udp, icmp, esp, ah, sctp, ipip, all) или номер IP-протокола.

Возвращается: при успехе

ports

list / elements=string

Необязательный список портов, к которым применяется это правило. Это поле применимо только для протоколов UDP или TCP. Каждая запись должна быть целым числом или диапазоном. Если значение не указано, правило применяется к подключениям через любой порт.

Примеры значений: [“22”], [“80”,”443”] и [“12345-12349”].

Возвращается: при успехе

description

string

Необязательное описание этого ресурса. Укажите это свойство при создании ресурса.

Возвращается: при успехе

destinationRanges

list / elements=string

Если указаны диапазоны адресов назначения, брандмауэр применяется только к трафику, IP-адрес назначения которого входит в эти диапазоны. Диапазоны должны быть заданы в формате CIDR. Поддерживается только IPv4.

Возвращается: при успехе

direction

string

Направление трафика, к которому применяется этот брандмауэр; по умолчанию используется INGRESS. Примечание: для входящего трафика (INGRESS) указывать destinationRanges нельзя; для исходящего трафика (EGRESS) указывать sourceRanges ИЛИ sourceTags нельзя.

Возвращается: при успехе

disabled

boolean

Указывает, отключено ли правило брандмауэра, то есть применяется ли оно к связанной с ним сети. Если значение равно true, правило брандмауэра не применяется, и сеть ведет себя так, как если бы такого правила не существовало. Если значение не задано, правило брандмауэра включено.

Возвращается: при успехе

id

integer

Уникальный идентификатор ресурса.

Возвращается: при успехе

logConfig

complex

Это поле задает параметры ведения журналов для определенного правила брандмауэра.

Если ведение журналов включено, журналы экспортируются в Cloud Logging.

Возвращается: при успехе

enable

boolean

Это поле указывает, нужно ли включить ведение журналов для определенного правила брандмауэра. Если ведение журналов включено, журналы экспортируются в Stackdriver.

Возвращается: при успехе

metadata

string

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

Возвращается: при успехе

name

string

Имя ресурса. Указывается клиентом при создании ресурса. Имя должно содержать от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно содержать от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`: первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, которым не может быть дефис.

Возвращается: при успехе

network

dictionary

URL ресурса сети для этого правила брандмауэра. Если при создании правила брандмауэра значение не указано, используется сеть по умолчанию: global/networks/default. Если вы решили указать это свойство, можно задать полный или частичный URL сети. Например, все следующие URL допустимы: https://www.googleapis.com/compute/v1/projects/myproject/global/ networks/my-network projects/myproject/global/networks/my-network global/networks/default .

Возвращается: при успехе

priority

integer

Приоритет этого правила. Это целое число от 0 до 65535 включительно. Если значение не задано, предполагается значение 1000. Относительные приоритеты определяют порядок применения конфликтующих правил. Меньшее значение приоритета означает более высокий приоритет (например, правило с приоритетом 0 имеет более высокий приоритет, чем правило с приоритетом 1). Правила DENY имеют приоритет над правилами ALLOW с таким же приоритетом.

Возвращается: при успехе

sourceRanges

list / elements=string

Если указаны диапазоны адресов источника, брандмауэр применяется только к трафику, IP-адрес источника которого входит в эти диапазоны. Диапазоны должны быть заданы в формате CIDR. Можно задать sourceRanges, sourceTags или оба параметра. Если заданы оба свойства, брандмауэр применяется к трафику, IP-адрес источника которого входит в sourceRanges ИЛИ принадлежит тегу из свойства sourceTags. Для применения брандмауэра подключению не обязательно соответствовать обоим свойствам. Поддерживается только IPv4.

Возвращается: при успехе

sourceServiceAccounts

list / elements=string

Если указаны учетные записи службы источника, брандмауэр применяется только к трафику, исходящему от экземпляра, которому назначена учетная запись службы из этого списка. Учетные записи службы источника нельзя использовать для управления трафиком к внешнему IP-адресу экземпляра, так как учетные записи службы связаны с экземпляром, а не с IP-адресом. Параметр sourceRanges можно задавать одновременно с sourceServiceAccounts. Если заданы оба параметра, брандмауэр применяется к трафику, IP-адрес источника которого входит в sourceRanges ИЛИ принадлежит экземпляру, которому назначена учетная запись службы из sourceServiceAccount. Для применения брандмауэра подключению не обязательно соответствовать обоим свойствам. Параметр sourceServiceAccounts нельзя использовать одновременно с sourceTags или targetTags.

Возвращается: при успехе

sourceTags

list / elements=string

Если указаны теги источника, брандмауэр применяется только к трафику, IP-адрес источника которого принадлежит экземпляру с тегом из списка тегов источника. Теги источника нельзя использовать для управления трафиком к внешнему IP-адресу экземпляра, поскольку теги связаны с экземпляром, а не с IP-адресом. Можно задать sourceRanges, sourceTags или оба параметра. Если заданы оба свойства, брандмауэр применяется к трафику, IP-адрес источника которого входит в sourceRanges ИЛИ принадлежит тегу из свойства sourceTags. Для применения брандмауэра подключению не обязательно соответствовать обоим свойствам.

Возвращается: при успехе

targetServiceAccounts

list / elements=string

Список учетных записей службы, определяющий группы экземпляров в сети, которым разрешено устанавливать сетевые подключения, указанные в allowed[].

Параметр targetServiceAccounts нельзя использовать одновременно с targetTags или sourceTags. Если не указаны ни targetServiceAccounts, ни targetTags, правило брандмауэра применяется ко всем экземплярам в указанной сети.

Возвращается: при успехе

targetTags

list / elements=string

Список тегов экземпляров, определяющий группы экземпляров в сети, которым разрешено устанавливать сетевые подключения, указанные в allowed[].

Если targetTags не указаны, правило брандмауэра применяется ко всем экземплярам в указанной сети.

Возвращается: при успехе

Авторы

  • Google Inc. (@googlecloudplatform)

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

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (исходный код)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API