Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию 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_nat_rule_facts.

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

  • Краткое описание
  • Параметры
  • Примеры

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

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

Параметры

Параметр

Комментарии

dereference_group_members

логическое значение

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

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

Варианты:

  • false
  • true

details_level

строка

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

Варианты:

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

filter

строка

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

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

filter_settings

словарь

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

packet_search_settings

словарь

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

expand_group_members

логическое значение

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

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

Варианты:

  • false
  • true

expand_group_with_exclusion_members

логическое значение

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

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

Варианты:

  • false
  • true

match_on_any

логическое значение

Следует ли учитывать объект «Any» при поиске.

Варианты:

  • false
  • true

match_on_group_with_exclusion

логическое значение

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

Варианты:

  • false
  • true

match_on_negate

логическое значение

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

Варианты:

  • false
  • true

search_mode

строка

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

Варианты:

  • "general"
  • "packet"

limit

целое число

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

name

строка

Имя правила. Этот параметр используется только при получении сведений об одном объекте. Требуется версия не ниже 1.7.1.

Доступно начиная с версии R81 системы управления.

offset

целое число

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

order

список / элементы=словарь

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

ASC

строка

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

Варианты:

  • "name"

DESC

строка

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

Варианты:

  • "name"

package

строка

Имя пакета.

rule_number

строка

Номер правила.

show_membership

логическое значение

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

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

Варианты:

  • false
  • true

use_object_dictionary

логическое значение

Н/Д

Варианты:

  • false
  • true

version

строка

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

Примеры

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

- 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–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_nat_rule_facts_module.html

Spec-Zone.ru

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