Spec-Zone.ru › Ansible

check_point.mgmt.cp_mgmt_nat_rule_facts модуль – Получение фактов об объектах nat-rule на 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_nat_rule_facts.

Новое в check_point.mgmt 2.0.0

  • Описание
  • Параметры
  • Примеры

Описание

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

Параметры

Параметр

Комментарии

dereference_group_members

boolean

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

Варианты:

  • false
  • true

details_level

string

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

Варианты:

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

filter

string

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

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 или имя объекта группы с исключением, результаты будут включать правила, соответствующие хотя бы одному члену части «include» и не являющиеся членом части «except».

Варианты:

  • 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’, отрицательному элементу или группе с исключениями. При установке search-mode в ‘packet’ по умолчанию включено соответствие объекту ‘Any’, отрицательному элементу или группе с исключениями. packet-search-settings могут быть предоставлены для изменения поведения по умолчанию.

Варианты:

  • "general"
  • "packet"

limit

integer

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

name

string

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

offset

integer

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

order

list / elements=dictionary

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

ASC

string

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

Варианты:

  • "name"

DESC

string

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

Варианты:

  • "name"

package

string

Название пакета.

rule_number

string

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

show_membership

boolean

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

Варианты:

  • false
  • true

use_object_dictionary

boolean

Н/Д

Варианты:

  • false
  • true

version

string

Версия 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–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_nat_rule_facts_module.html

Spec-Zone.ru

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