check_point.mgmt.cp_mgmt_objects_facts модуль — Получение фактов об объектах Checkpoint через 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_objects_facts.
Добавлен в check_point.mgmt 3.0.0
Описание
- Получение фактов об объектах на устройствах Checkpoint.
- Все операции выполняются через API веб-служб.
- Этот модуль обрабатывает как операции получения конкретного объекта, так и получения нескольких объектов. Для получения конкретного объекта используйте параметр «name».
Параметры
Параметр | Комментарии |
|---|---|
dereference_group_members boolean | Указывает, нужно ли дескриференцировать поле «members» на уровне детализации для каждого объекта в ответе. Варианты:
|
details_level string | Уровень детализации некоторых полей в ответе может варьироваться от отображения только значения UID объекта до полного подробного представления объекта. Варианты:
|
domains_to_process list / elements=string | Указывает, на каких доменах обрабатывать команды. Не может использоваться с параметром details-level full, должен выполняться только из системного домена и с параметром ignore-warnings true. Допустимые значения: CURRENT_DOMAIN, ALL_DOMAINS_ON_THIS_SERVER. |
filter string | Выражение для поиска и фильтрации объектов. Предоставляемый текст должен быть точно таким же, как в Smart Console. Логические операторы в выражении («И», «ИЛИ») должны быть в верхнем регистре. По умолчанию поиск включает как текстовый, так и IP-поиск. Чтобы использовать только IP-поиск, установите параметр «ip-only» в значение true. |
ip_only boolean | При использовании параметра «filter», используйте это поле для поиска объектов только по их IP-адресу, без текстового поиска.
* Check Point Host — сервер типа Управление сетевой политикой, Ведение журнала и статус, SmartEvent и т. д. * При проверке одного IP-адреса на начало с другого (частичного) IP-адреса учитываются только полные октеты * Примеры IP-поиска см. в разделе Примеры. Варианты:
|
limit integer | Максимальное количество возвращаемых результатов. Этот параметр актуален только для получения конкретного объекта. |
offset integer | Количество результатов, которые необходимо пропустить изначально. Этот параметр актуален только для получения конкретного объекта. |
order list / elements=dictionary | Сортирует результаты по критериям поиска. Автоматически сортирует результаты по имени в порядке возрастания. Этот параметр актуален только для получения конкретного объекта. |
|
ASC string |
Сортирует результаты по заданному полю в порядке возрастания. Варианты:
|
|
DESC string |
Сортирует результаты по заданному полю в порядке убывания. Варианты:
|
show_membership boolean | Указывает, нужно ли рассчитывать и отображать поле «groups» для каждого объекта в ответе. Варианты:
|
type string | Тип объектов, например, host, service-tcp, network, address-range… |
uid string | Уникальный идентификатор объекта. |
uids list / elements=string | Список UID объектов для получения. |
version string | Версия Check Point. Если не указана, используется последняя версия. |
Примеры
- name: show-objects
cp_mgmt_objects_facts:
limit: 50
offset: 0
order:
- ASC: name
type: group
- name: show-object
cp_mgmt_objects_facts:
uid: ef82887c-d08f-49a3-a18f-a376be633848
Ссылки на коллекцию
© 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_objects_facts_module.html