модуль check_point.mgmt.cp_mgmt_threat_layers — управление ресурсом «Слои защиты от угроз»

Примечание

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

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

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

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

Этот модуль ресурса позволяет добавлять, удалять и изменять слои защиты от угроз CP.
Этот модуль ресурса также собирает факты о конфигурации слоев защиты от угроз.
Доступен начиная с версии R80 системы управления.

Примечание

Этому модулю соответствует плагин действий.

Параметры

Параметр	Комментарии
config dictionary	Словарь параметров слоев защиты от угроз
add_default_rule boolean	Определяет, нужно ли включить правило по умолчанию в новый слой. Варианты: `false` `true`
auto_publish_session boolean	Опубликовать текущий сеанс после выполнения задачи, если были внесены изменения. Варианты: `false` `true`
color string	Цвет объекта. Должен быть одним из существующих цветов. Варианты: `"aquamarine"` `"black"` `"blue"` `"crete blue"` `"burlywood"` `"cyan"` `"dark green"` `"khaki"` `"orchid"` `"dark orange"` `"dark sea green"` `"pink"` `"turquoise"` `"dark blue"` `"firebrick"` `"brown"` `"forest green"` `"gold"` `"dark gold"` `"gray"` `"dark gray"` `"light green"` `"lemon chiffon"` `"coral"` `"sea green"` `"sky blue"` `"magenta"` `"purple"` `"slate blue"` `"violet red"` `"navy blue"` `"olive"` `"orange"` `"red"` `"sienna"` `"yellow"`
comments string	Строка комментария.
details_level string	Уровень детализации некоторых полей в ответе может варьироваться от отображения только значения UID объекта до полностью подробного представления объекта. Варианты: `"uid"` `"standard"` `"full"`
ignore_errors boolean	Применить изменения, игнорируя ошибки. Такие изменения нельзя будет опубликовать. Если флаг ignore-warnings не указан, предупреждения также будут игнорироваться. Варианты: `false` `true`
ignore_warnings boolean	Применить изменения, игнорируя предупреждения. Варианты: `false` `true`
limit integer	Максимальное количество возвращаемых результатов. ПРИМЕЧАНИЕ. Этот параметр применим только для состояния GATHERED. Для таких состояний конфигурации, как MERGED, REPLACED и DELETED, он неприменим.
name string	Имя объекта. Должно быть уникальным в домене.
offset integer	Количество результатов, которые нужно пропустить в начале. ПРИМЕЧАНИЕ. Этот параметр применим только для состояния GATHERED. Для таких состояний конфигурации, как MERGED, REPLACED и DELETED, он неприменим.
order list / elements=dictionary	Сортирует результаты по указанному полю. По умолчанию результаты сортируются по имени в порядке возрастания. Этот параметр применим только при получении нескольких объектов. ПРИМЕЧАНИЕ. Этот параметр применим только для состояния GATHERED. Для таких состояний конфигурации, как MERGED, REPLACED и DELETED, он неприменим.
ASC string	Сортирует результаты по указанному полю в порядке возрастания.
DESC string	Сортирует результаты по указанному полю в порядке убывания.
round_trip string	Если задано значение True, при обратном преобразовании параметры модуля будут отфильтрованы из параметра ответа, что позволит пользователю выполнить запрос конфигурации с использованием структурированных собранных данных. ПРИМЕЧАНИЕ. Этот параметр актуален только для состояния GATHERED. Для таких состояний конфигурации, как MERGED, REPLACED и DELETED, он не приведет к обновлению конфигурации, поскольку не является параметром конфигурации модуля.
tags list / elements=string	Набор идентификаторов тегов.
version string	Версия Check Point. Если она не указана, используется последняя версия.
state string	Состояние, в котором должна остаться конфигурация. Состояние gathered получает конфигурацию API модуля с устройства и преобразует ее в структурированные данные в формате, соответствующем спецификации аргументов модуля. Значение возвращается в ключе gathered результата. Варианты: `"merged"` `"replaced"` `"gathered"` `"deleted"`

Примеры

# Using MERGED state
# -------------------

- name: To Add Merge Threat-Layers config
  cp_mgmt_threat_layers:
    state: merged
    config:
      name: New Layer 1
      add_default_rule: true
      tags:
        - test_threat_layer
      color: turquoise
      comments: test description
      ignore_warnings: false
      ignore_errors: false
      round_trip: true

# RUN output:
# -----------

# mgmt_threat_layers:
#   after:
#     color: turquoise
#     comments: test description
#     icon: ApplicationFirewall/rulebase
#     ips-layer: false
#     name: New Layer 1
#     tags:
#     - test_threat_layer
#   before: {}

# Using REPLACED state
# --------------------

- name: Replace Threat-layer config
  cp_mgmt_threat_layers:
    state: replaced
    config:
      name: New Layer 1
      add_default_rule: true
      tags:
        - test_threat_layer_replaced
      color: cyan
      comments: REPLACED description
      ignore_warnings: false
      ignore_errors: false
      round_trip: true

# RUN output:
# -----------

# mgmt_threat_layers:
#   after:
#     color: cyan
#     comments: REPLACED description
#     icon: ApplicationFirewall/rulebase
#     ips-layer: false
#     name: New Layer 1
#     tags:
#     - test_threat_layer_replaced
#   before:
#     color: turquoise
#     comments: test description
#     icon: ApplicationFirewall/rulebase
#     ips-layer: false
#     name: New Layer 1
#     tags:
#     - test_threat_layer

# Using GATHERED state
# --------------------

# 1. With Round Trip set to True

- name: To Gather threat-layer by Name
  cp_mgmt_threat_layers:
    config:
      name: New Layer 1
      round_trip: true
    state: gathered

# RUN output:
# -----------

# gathered:
#   color: turquoise
#   comments: test description
#   domain: SMC User
#   icon: ApplicationFirewall/rulebase
#   ips-layer: false
#   name: New Layer 1
#   read-only: false
#   tags:
#   - test_threat_layer
#   uid: 4dc060e2-0ed6-48c5-9b0f-3d2fbeb552ba

# 2. With Round Trip set to False which is the default behaviour

- name: To Gather threat-layer by Name
  cp_mgmt_threat_layers:
    config:
      name: New Layer 1
    state: gathered

# RUN output:
# -----------

# gathered:
#   color: turquoise
#   comments: test description
#   domain:
#     domain-type: domain
#     name: SMC User
#     uid: 41e821a0-3720-11e3-aa6e-0800200c9fde
#   icon: ApplicationFirewall/rulebase
#   ips-layer: false
#   meta-info:
#     creation-time:
#       iso-8601: 2022-11-21T07:30+0000
#       posix: 1669015820472
#     creator: admin
#     last-modifier: admin
#     last-modify-time:
#       iso-8601: 2022-11-21T07:30+0000
#       posix: 1669015821024
#     lock: unlocked
#     validation-state: ok
#   name: New Layer 1
#   read-only: false
#   tags:
#   - domain:
#       domain-type: domain
#       name: SMC User
#       uid: 41e821a0-3720-11e3-aa6e-0800200c9fde
#     name: test_threat_layer
#     type: tag
#     uid: 59f23149-ed5e-439f-9012-0cdf222a1c97
#   type: threat-layer
#   uid: ca196a80-fdc4-4e7b-8b25-e3eed125a25f

# 3. Gather ALL threat-layer config with DESC order filter

- name: To Gather ALL threat-layer and order by Name
  cp_mgmt_threat_layers:
    config:
      order:
        - DESC: name
    state: gathered

# RUN output:
# -----------

# gathered:
#   - color: black
#     comments: ''
#     domain:
#       domain-type: domain
#       name: SMC User
#       uid: 41e821a0-3720-11e3-aa6e-0800200c9fde
#     icon: ApplicationFirewall/sharedrulebase
#     ips-layer: true
#     meta-info:
#       creation-time:
#         iso-8601: 2020-01-20T09:43+0000
#         posix: 1579513387322
#       creator: System
#       last-modifier: System
#       last-modify-time:
#         iso-8601: 2020-01-20T09:43+0000
#         posix: 1579513387377
#       lock: unlocked
#       validation-state: ok
#     name: IPS
#     read-only: false
#     tags: []
#     type: threat-layer
#     uid: 90678011-1bcb-4296-8154-fa58c23ecf3b
#   - color: black
#     comments: ''
#     domain:
#       domain-type: domain
#       name: SMC User
#       uid: 41e821a0-3720-11e3-aa6e-0800200c9fde
#     icon: ApplicationFirewall/rulebase
#     ips-layer: false
#     meta-info:
#       creation-time:
#         iso-8601: 2020-01-20T09:43+0000
#         posix: 1579513386848
#       creator: System
#       last-modifier: System
#       last-modify-time:
#         iso-8601: 2020-01-20T09:43+0000
#         posix: 1579513387396
#       lock: unlocked
#       validation-state: ok
#     name: Standard Threat Prevention
#     read-only: false
#     tags: []
#     type: threat-layer
#     uid: 0dbe7c44-6d3f-4f28-8f2b-0e6790e57f8a

# Using DELETED state
# -------------------

- name: Delete Threat-layer config by Name and Layer
  cp_mgmt_threat_layers:
    config:
      layer: IPS
      name: First threat layer
      round_trip: true
    state: deleted

# RUN output:
# -----------

# mgmt_threat_layers:
#   after: {}
#   before:
#     action: Optimized
#     comments: This is the THREAT RULE
#     destination:
#     - Any
#     destination_negate: false
#     enabled: true
#     install_on:
#     - Policy Targets
#     layer: 90678011-1bcb-4296-8154-fa58c23ecf3b
#     name: First threat layer
#     protected_scope:
#     - All_Internet
#     protected_scope_negate: false
#     service:
#     - Any
#     service_negate: false
#     source:
#     - Any
#     source_negate: false
#     track: None
#     track_settings:
#       packet_capture: true

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

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

Ключ	Описание
after dictionary	Конфигурация после выполнения модуля. Возвращается: если состояние изменено Пример: `"This output will always be in the same format as the module argspec.\n"`
before dictionary	Конфигурация до выполнения модуля. Возвращается: если состояние — merged, replaced или deleted Пример: `"This output will always be in the same format as the module argspec.\n"`
gathered dictionary	Сведения о сетевом ресурсе, собранные с удаленного устройства в виде структурированных данных. Возвращается: если состояние — gathered Пример: `"This output will always be in the same format as the module argspec.\n"`

Авторы

Команда Ansible Security Automation (@justjais) <https://github.com/ansible-security>-

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

© 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_threat_layers_module.html