check_point.mgmt.cp_mgmt_access_rule_facts – Получение фактов об объектах правил доступа на Check Point через веб-сервисный API

Примечание

Этот плагин входит в коллекцию check_point.mgmt (версия 2.0.0).

Для его установки используйте: ansible-galaxy collection install check_point.mgmt.

Для использования в плейбуке укажите: check_point.mgmt.cp_mgmt_access_rule_facts.

Новый в версии 2.9: коллекции check_point.mgmt

Описание
Параметры
Примеры

Описание

Получение фактов об объектах правил доступа на устройствах Check Point.
Все операции выполняются через веб-сервисный API.
Этот модуль обрабатывает обе операции: получение одного конкретного объекта и нескольких объектов. Для получения конкретного объекта используйте параметр «имя».

Параметры

Параметр			Варианты/Значения по умолчанию	Комментарии
dereference_group_members boolean			Варианты: no yes	Указывает, следует ли выполнять разыменование поля «члены» по уровню деталей для каждого объекта в ответе.
details_level string			Варианты: uid standard full	Уровень детализации некоторых полей в ответе может варьироваться от показа только значения UID объекта до полного подробного представления объекта.
filter string				Выражение для поиска, применяемое к базе правил. Предоставленный текст должен быть точно таким же, как в Smart Console. Логические операторы в выражении («И», «ИЛИ») должны быть предоставлены заглавными буквами. Если оператор не используется, применяется оператор по умолчанию ИЛИ.
filter_settings dictionary				Настройки фильтра.
	packet_search_settings dictionary			Когда «режим поиска» установлен в «пакет», этот объект позволяет задать предпочтения поиска пакетов.
		expand_group_members boolean	Варианты: no yes	Если значение true, при наличии в выражении поиска UID или имени объекта группы, результаты будут включать правила, соответствующие по крайней мере одному члену группы.
		expand_group_with_exclusion_members boolean	Варианты: no yes	Если значение true, при наличии в выражении поиска UID или имени объекта группы с исключениями, результаты будут включать правила, соответствующие хотя бы одному члену части «включая» и не являющимся членом части «исключая».
		match_on_any boolean	Варианты: no yes	Сопоставление с объектом «Любой».
		match_on_group_with_exclusion boolean	Варианты: no yes	Сопоставление с группой с исключениями.
		match_on_negate boolean	Варианты: no yes	Сопоставление с отрицательным значением ячейки.
	search_mode string		Варианты: general packet	При значении «general» включены как Полный поиск по тексту, так и Поиск по пакетам. В этом режиме Поиск по пакетам не будет соответствовать объекту «Любой», отрицательной ячейке или группе с исключениями. При режиме поиска «пакет» по умолчанию включены сопоставления с объектом «Любой», отрицательной ячейкой или группой с исключениями. Можно использовать packet-search-settings для изменения поведения по умолчанию.
hits_settings dictionary				Н/Д
	from_date string			Формат: «ГГГГ-ММ-ДД», «ГГГГ-мм-ддЧЧ:мм:сс».
	target string			Имя или UID целевого шлюза.
	to_date string			Формат: «ГГГГ-ММ-ДД», «ГГГГ-мм-ддЧЧ:мм:сс».
layer string				Слой, к которому относится правило, определенный по имени или UID.
limit integer				Не более указанного количества результатов будет возвращено. Этот параметр актуален только для получения нескольких объектов.
name string				Имя объекта. Должно быть уникальным в домене.
offset integer				Пропустить указанное количество результатов перед началом возвращения. Этот параметр актуален только для получения нескольких объектов.
order list / elements=string				Сортирует результаты по заданному полю. По умолчанию результаты отсортированы по возрастанию имени. Этот параметр актуален только для получения нескольких объектов.
	ASC string		Варианты: name	Сортирует результаты по заданному полю в порядке возрастания.
	DESC string		Варианты: name	Сортирует результаты по заданному полю в порядке убывания.
package string				Имя пакета.
show_as_ranges boolean			Варианты: no yes	При значении true исходные, конечные точки и параметры служб и приложений отображаются как диапазоны IP-адресов и портов, а не как сетевые объекты.
show_hits boolean			Варианты: no yes	Н/Д
show_membership boolean			Варианты: no yes	Указывает, следует ли вычислять и отображать поле «группы» для каждого объекта в ответе.
use_object_dictionary boolean			Варианты: no yes	Н/Д
version string				Версия checkpoint. Если не указана, используется последняя версия.

Примеры

- name: show-access-rule
  cp_mgmt_access_rule_facts:
    layer: Network
    name: Rule 1

- name: show-access-rulebase
  cp_mgmt_access_rule_facts:
    details_level: standard
    limit: 20
    name: Network
    offset: 0
    use_object_dictionary: true

Авторы

Or Soffer (@chkp-orso)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/check_point/mgmt/cp_mgmt_access_rule_facts_module.html