google.cloud.gcp_compute_firewall_info – Сбор информации о брандмауэре GCP

Примечание

Этот плагин входит в коллекцию google.cloud (версия 1.0.1).

Для его установки используйте: 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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_kind строка / обязательно	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
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 с помощью переменной среды 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 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		успех	Направление трафика, к которому применяется этот брандмауэр; по умолчанию ВХОДЯЩИЙ. Примечание: для входного трафика не поддерживается указание destinationRanges; для исходящего трафика не поддерживается указание 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 ИЛИ IP-адрес источника принадлежит тегу, указанному в свойстве sourceTags. Для применения брандмауэра не требуется, чтобы соединение соответствовало обоим свойствам. Поддерживается только IPv4.
	sourceServiceAccounts list / elements=string		успех	Если указаны учётные записи сервисов источника, брандмауэр будет применяться только к трафику, исходящему от виртуальной машины с учётной записью сервиса в этом списке. Учётные записи сервисов не могут использоваться для управления трафиком к внешнему IP-адресу виртуальной машины, потому что учётные записи сервисов связаны с виртуальной машиной, а не с IP-адресом. sourceRanges может быть установлен одновременно с sourceServiceAccounts. Если оба установлены, брандмауэр будет применяться к трафику, у которого IP-адрес источника находится в sourceRanges ИЛИ IP-адрес источника принадлежит виртуальной машине с учётной записью сервиса, указанной в sourceServiceAccount. Для применения брандмауэра не требуется, чтобы соединение соответствовало обоим свойствам. sourceServiceAccounts не могут использоваться одновременно с sourceTags или targetTags.
	sourceTags list / elements=string		успех	Если указаны теги источника, брандмауэр будет применяться только к трафику, у которого IP-адрес источника принадлежит тегу, указанному в тегах источника. Теги источника не могут использоваться для управления трафиком к внешнему IP-адресу виртуальной машины. Поскольку теги связаны с виртуальной машиной, а не с IP-адресом. Может быть установлено одно или оба из sourceRanges и sourceTags. Если оба свойства установлены, брандмауэр будет применяться к трафику, у которого IP-адрес источника находится в sourceRanges ИЛИ IP-адрес источника принадлежит тегу, указанному в свойстве 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/google/cloud/gcp_compute_firewall_info_module.html