Модуль check_point.mgmt.cp_mgmt_show_unused_objects — получение всех неиспользуемых объектов.

Примечание

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

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

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

Чтобы использовать коллекцию в плейбуке, укажите: check_point.mgmt.cp_mgmt_show_unused_objects.

Добавлено в check_point.mgmt 5.0.0

Краткое описание
Параметры
Примеры
Возвращаемые значения

Краткое описание

Получение всех неиспользуемых объектов.
Все операции выполняются через API веб-служб.
Доступно начиная с версии R80 для управления.

Параметры

Параметр	Комментарии
auto_publish_session boolean	Опубликовать текущий сеанс, если после завершения задачи были внесены изменения. Варианты: `false` ← (по умолчанию) `true`
dereference_group_members boolean	Указывает, следует ли раскрывать поле «members» согласно уровню детализации для каждого объекта в ответе. Доступно начиная с версии R80.10 для управления. Варианты: `false` `true`
details_level string	Уровень детализации некоторых полей в ответе может варьироваться от отображения только значения UID объекта до полного подробного представления объекта. Варианты: `"uid"` `"standard"` `"full"`
domains_to_process list / elements=string	Указывает, в каких доменах выполнять команды. Параметр нельзя использовать с уровнем детализации full. Команда должна выполняться только из системного домена, а параметр ignore-warnings должен иметь значение true. Допустимые значения: CURRENT_DOMAIN, ALL_DOMAINS_ON_THIS_SERVER. Доступно начиная с версии R81 для управления.
filter string	Поисковое выражение для фильтрации объектов. Указанный текст должен точно совпадать с текстом, который вводится в обозревателе объектов SmartConsole. Логические операторы в выражении («AND», «OR») необходимо указывать заглавными буквами. Поиск выполняется как по IP-адресам, так и по тексту в имени, комментарии, тегах и других полях. Доступно начиная с версии R81 JHF для управления.
limit integer	Максимальное количество возвращаемых результатов. Этот параметр применим только при получении нескольких объектов.
offset integer	Количество результатов, которые нужно пропустить в начале. Этот параметр применим только при получении нескольких объектов.
order list / elements=dictionary	Сортирует результаты по критериям поиска. По умолчанию результаты сортируются по имени в порядке возрастания. Этот параметр применим только при получении нескольких объектов.
ASC string	Сортирует результаты по указанному полю в порядке возрастания. Варианты: `"name"`
DESC string	Сортирует результаты по указанному полю в порядке убывания. Варианты: `"name"`
show_membership boolean	Указывает, следует ли вычислять и отображать поле «groups» для каждого объекта в ответе. Доступно начиная с версии R80.10 для управления. Варианты: `false` `true`
version string	Версия Check Point. Если версия не указана, используется последняя.
wait_for_task boolean	Ожидать завершения задачи, например задачи публикации. Варианты: `false` `true` ← (по умолчанию)
wait_for_task_timeout integer	Сколько минут ожидать до появления ошибки тайм-аута. По умолчанию: `30`

Примеры

- name: show-unused-objects
  cp_mgmt_show_unused_objects:
    details_level: standard
    limit: 50
    offset: 0

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:

Ключ	Описание
cp_mgmt_show_unused_objects dictionary	Результат выполнения команды show-unused-objects в Check Point. Возвращается: всегда.

Авторы

Eden Brillant (@chkp-edenbr)

Ссылки на коллекцию

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