Spec-Zone.ru › Ansible

Модуль check_point.mgmt.cp_mgmt_https_rule_facts — получение сведений об объектах https-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_https_rule_facts.

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

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

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

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

Параметры

Параметр

Комментарии

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"

layer

string

Слой, содержащий объект. Идентифицируется по имени или UID.

limit

integer

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

name

string

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

offset

integer

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

order

list / elements=dictionary

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

ASC

string

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

Варианты:

  • "name"

DESC

string

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

Варианты:

  • "name"

package

string

Имя пакета.

show_membership

boolean

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

Варианты:

  • false
  • true

use_object_dictionary

boolean

Получение соответствия между идентификаторами объектов и полными описаниями объектов.

Варианты:

  • false
  • true

version

string

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

Примеры

- name: show-https-rule
  cp_mgmt_https_rule_facts:
    name: FirstRule
    layer: Default Outbound Layer

- name: show-https-rulebase
  cp_mgmt_https_rule_facts:
    details_level: standard
    limit: 20
    name: Default Outbound Layer
    offset: 0
    use_object_dictionary: false

Авторы

  • 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_https_rule_facts_module.html

Spec-Zone.ru

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