Spec-Zone.ru › Ansible

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

Примечание

Этот модуль является частью коллекции check_point.mgmt (версия 5.2.3).

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

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

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

Новый в check_point.mgmt 1.0.0

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

Обзор

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

Параметры

Параметр

Комментарии

dereference_group_members

boolean

Указывает, нужно ли разыменовывать поле «members» по уровню детализации для каждого объекта в ответе.

Варианты:

  • false
  • true

details_level

string

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

Варианты:

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

filter

string

Выражение для поиска, позволяющее отфильтровать базу правил. Указанный текст должен быть точно таким же, как и в Smart Console. Логические операторы в выражении («И», «ИЛИ») должны быть указаны в верхнем регистре. Если оператор не используется, применяется оператор ИЛИ по умолчанию.

filter_settings

dictionary

Устанавливает параметры фильтра.

packet_search_settings

dictionary

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

expand_group_members

boolean

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

Варианты:

  • false
  • true

expand_group_with_exclusion_members

boolean

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

Варианты:

  • false
  • true

match_on_any

boolean

Соответствие объекту ‘Любой’.

Варианты:

  • false
  • true

match_on_group_with_exclusion

boolean

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

Варианты:

  • false
  • true

match_on_negate

boolean

Соответствие отрицательному элементу.

Варианты:

  • false
  • true

search_mode

string

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

Варианты:

  • "general"
  • "packet"

hits_settings

dictionary

Н/Д

from_date

string

Формат, ‘ГГГГ-ММ-ДД’, ‘ГГГГ-мм-ддЧЧ:мм:сс’.

target

string

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

to_date

string

Формат, ‘ГГГГ-ММ-ДД’, ‘ГГГГ-мм-ддЧЧ:мм:сс’.

layer

string

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

limit

integer

Максимальное количество возвращаемых результатов. Данный параметр актуален только для получения небольшого количества объектов.

name

string

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

offset

integer

Пропустить указанное количество результатов перед началом возврата. Данный параметр актуален только для получения небольшого количества объектов.

order

list / elements=dictionary

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

ASC

string

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

Варианты:

  • "name"

DESC

string

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

Варианты:

  • "name"

package

string

Имя пакета.

show_as_ranges

boolean

При значении true параметры источника, назначения и сервисов/приложений отображаются как диапазоны IP-адресов и номеров портов, а не как сетевые объекты.
Объекты, которые не могут быть представлены с помощью IP-адресов или номеров портов, отображаются как объекты.
Кроме того, ответ для каждой правила не содержит параметров source, source-negate, destination, destination-negate, service и service-negate, а вместо этого содержит параметры source-ranges, destination-ranges и service-ranges.

Обратите внимание, что запрос на отображение правил как диапазонов ограничен 20 правилами на запрос; в противном случае возвращается ошибка. Если вы хотите запросить больше правил, используйте параметры offset и limit для ограничения запроса.

Варианты:

  • false
  • true

show_hits

boolean

Не применимо

Варианты:

  • false
  • true

show_membership

boolean

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

Варианты:

  • false
  • true

use_object_dictionary

boolean

Не применимо

Варианты:

  • false
  • true

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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/check_point/mgmt/cp_mgmt_access_rule_facts_module.html

Spec-Zone.ru

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