Модуль check_point.mgmt.cp_mgmt_access_rule_facts — получение сведений об объектах правил доступа Check Point через API веб-служб

async_response

boolean

добавлено в check_point.mgmt 6.6.0

Выполнить команду в асинхронном режиме и вернуть UID задачи. Используйте команду show-task, чтобы проверить ход выполнения задачи.

Доступно с пользовательским HF.

Варианты:

• false ← (по умолчанию)
• true

dereference_group_members

boolean

Указывает, следует ли раскрывать поле “members” с учетом уровня детализации для каждого объекта в ответе.

Доступно начиная с версии R80.10 для управления.

Варианты:

• false
• true

details_level

string

Уровень детализации некоторых полей в ответе может варьироваться от отображения только значения UID объекта до полностью подробного представления объекта.

Варианты:

• "uid"
• "standard"
• "full"

filter

string

Выражение поиска для фильтрации базы правил. Указанный текст должен точно соответствовать тексту, который был бы введен в Smart Console. Логические операторы в выражении (‘AND’, ‘OR’) следует указывать прописными буквами. Если оператор не указан, используется оператор OR по умолчанию.

filter_settings

dictionary

Задает параметры фильтрации.

Доступно начиная с версии R80.10 для управления.

packet_search_settings

dictionary

Если для ‘search-mode’ задано значение ‘packet’, этот объект позволяет задать параметры поиска пакетов.

expand_group_members

boolean

Если задано значение true и выражение поиска содержит UID или имя объекта-группы, результаты будут включать правила, соответствующие хотя бы одному участнику группы.

Доступно начиная с версии R80.20 для управления.

Варианты:

• false
• true

expand_group_with_exclusion_members

boolean

Если задано значение true и выражение поиска содержит UID или имя объекта-группы с исключением, результаты будут включать правила, соответствующие хотя бы одному участнику части “include”, но не входящие в часть “except”.

Доступно начиная с версии R80.20 для управления.

Варианты:

• false
• true

match_on_any

boolean

Следует ли сопоставлять объект ‘Any’.

Варианты:

• false
• true

match_on_group_with_exclusion

boolean

Следует ли сопоставлять группу с исключением.

Варианты:

• false
• true

match_on_negate

boolean

Следует ли сопоставлять ячейку с отрицанием.

Варианты:

• false
• true

search_mode

string

При значении ‘general’ включаются полнотекстовый поиск и поиск пакетов. В этом режиме поиск пакетов не будет сопоставлять объект ‘Any’, ячейку с отрицанием или группу с исключением. При значении ‘packet’ для search-mode по умолчанию включается сопоставление объекта ‘Any’, ячейки с отрицанием и группы с исключением. Чтобы изменить поведение по умолчанию, можно указать packet-search-settings.

Варианты:

• "general"
• "packet"

hits_settings

dictionary

Н/Д

from_date

string

Формат: ‘YYYY-MM-DD’, ‘YYYY-mm-ddThh:mm:ss’.

target

string

Имя или UID целевого шлюза.

to_date

string

Формат: ‘YYYY-MM-DD’, ‘YYYY-mm-ddThh:mm:ss’.

layer

string

Слой, которому принадлежит правило, указанный по имени или UID.

limit

integer

Возвращается не более указанного количества результатов. Этот параметр применяется только при получении нескольких объектов.

Допустимые значения: от 1 до 500.

name

string

Имя объекта. Должно быть уникальным в домене.

offset

integer

Пропустить указанное количество результатов перед началом их возврата. Этот параметр применяется только при получении нескольких объектов.

order

list / элементы=dictionary

Сортирует результаты по указанному полю. По умолчанию результаты сортируются по имени в порядке возрастания. Этот параметр применяется только при получении нескольких объектов.

ASC

string

Сортирует результаты по указанному полю в порядке возрастания.

Варианты:

• "name"

DESC

string

Сортирует результаты по указанному полю в порядке убывания.

Варианты:

• "name"

package

string

Имя пакета.

show_as_ranges

boolean

Если задано значение true, параметры source, destination и services & applications отображаются в виде диапазонов IP-адресов и номеров портов, а не сетевых объектов.<br /> Объекты, которые не представлены с помощью IP-адресов или номеров портов, отображаются как объекты.<br /> Кроме того, ответ для каждого правила не содержит параметры source, source-negate, destination, destination-negate, service и service-negate, а вместо них содержит параметры source-ranges, destination-ranges и service-ranges.<br /><br /> Обратите внимание: запрос на отображение правил в виде диапазонов ограничен 20 правилами на запрос; в противном случае возвращается ошибка. Чтобы запросить больше правил, ограничьте запрос с помощью параметров offset и limit.

Доступно начиная с версии R80.20 для управления.

Варианты:

• false
• true

show_hits

boolean

Н/Д

Варианты:

• false
• true

show_membership

boolean

Указывает, следует ли вычислять и отображать поле “groups” для каждого объекта в ответе.

Доступно начиная с версии R80.10 для управления.

Варианты:

• false
• true

use_object_dictionary

boolean

Н/Д

Варианты:

• false
• true

version

string

Версия Check Point. Если версия не указана, используется последняя версия.

wait_for_task

boolean

добавлено в check_point.mgmt 6.6.0

Ожидать завершения задачи, например задачи публикации.

Варианты:

• false
• true ← (по умолчанию)

wait_for_task_timeout

integer

добавлено в check_point.mgmt 6.6.0

Количество минут ожидания до возникновения ошибки тайм-аута.

По умолчанию: 30