check_point.mgmt.cp_mgmt_threat_layers модуль — Управляет ресурсом THREAT LAYERS

Примечание

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

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

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

Для использования в playbook укажите: check_point.mgmt.cp_mgmt_threat_layers.

Новый в check_point.mgmt 5.0.0

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

Описание

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

Примечание

У этого модуля есть соответствующий плагин действий.

Параметры

Параметр	Комментарии
config dictionary	Словарь параметров THREAT LAYERS
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	Версия checkpoint. Если не указана, используется последняя версия.
state string	Состояние, в котором должна оставаться конфигурация Состояние gathered получит конфигурацию API модуля с устройства и преобразует ее в структурированные данные в формате, соответствующем argspec модуля, и значение возвращается в ключе 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 словарь	Результирующая конфигурация после выполнения модуля. Возвращается: при изменении Пример: `"This output will always be in the same format as the module argspec.\n"`
before словарь	Конфигурация до выполнения модуля. Возвращается: когда состояние — merged, replaced, deleted Пример: `"This output will always be in the same format as the module argspec.\n"`
gathered словарь	Факты о сетевом ресурсе, собранные с удаленного устройства в виде структурированных данных. Возвращается: когда состояние — gathered Пример: `"This output will always be in the same format as the module argspec.\n"`

Авторы

Команда автоматизации безопасности Ansible (@justjais) <https://github.com/ansible-security>-

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

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