check_point.mgmt.cp_mgmt_nat_rule_facts – Получение фактов объектов nat-rule на Checkpoint через API веб-служб

Примечание

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

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

Для использования в книге задач укажите: check_point.mgmt.cp_mgmt_nat_rule_facts.

Введено в версии 2.9: коллекции check_point.mgmt

Обзор
Параметры
Примеры

Обзор

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

Параметры

Параметр			Варианты/Значения по умолчанию	Комментарии
dereference_group_members boolean			Варианты: no yes	Указывает, нужно ли делать разыменование поля "members" по уровню детализации для каждого объекта в ответе.
details_level string			Варианты: uid standard full	Уровень детализации для некоторых полей в ответе может варьироваться от отображения только значения UID объекта до полного подробного представления объекта.
filter string				Выражение для поиска, фильтрующее базу правил. Предоставляемый текст должен быть точно таким же, как и в Smart Console. Логические операторы в выражении ('AND', 'OR') должны быть предоставлены заглавными буквами. Если оператор не используется, применяется оператор OR по умолчанию.
filter_settings dictionary				Настройка параметров фильтра.
	packet_search_settings dictionary			Когда 'search-mode' задан как 'packet', этот объект позволяет установить параметры поиска пакетов.
		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', включены как поиск по полному тексту, так и поиск по пакетам. В этом режиме поиск по пакетам не будет соответствовать объекту «Любой», отрицательному элементу или группе с исключением. Когда search-mode задан как 'packet', по умолчанию включено соответствие объекту «Любой», отрицательному элементу или группе с исключением. packet-search-settings могут быть предоставлены для изменения поведения по умолчанию.
limit integer				Максимальное количество возвращаемых результатов. Этот параметр актуален только для получения нескольких объектов.
offset integer				Количество результатов, которые нужно пропустить вначале. Этот параметр актуален только для получения нескольких объектов.
order list / elements=string				Сортировка результатов по критериям поиска. Автоматически сортирует результаты по имени в порядке возрастания. Этот параметр актуален только для получения нескольких объектов.
	ASC string		Варианты: name	Сортировка результатов по заданному полю в порядке возрастания.
	DESC string		Варианты: name	Сортировка результатов по заданному полю в порядке убывания.
package string				Имя пакета.
rule_number string				Номер правила.
show_membership boolean			Варианты: no yes	Указывает, нужно ли вычислять и показывать поле «groups» для каждого объекта в ответе.
use_object_dictionary boolean			Варианты: no yes	Н/Д
version string				Версия checkpoint. Если не указана, берется последняя версия.

Примеры

- name: show-nat-rule
  cp_mgmt_nat_rule_facts:
    package: standard

- name: show-nat-rulebase
  cp_mgmt_nat_rule_facts:
    details_level: standard
    limit: 2
    offset: 1
    package: standard
    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_nat_rule_facts_module.html