модуль check_point.mgmt.cp_mgmt_access_layers — управление ресурсом ACCESS 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_access_layers.

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

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

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

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

Примечание

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

Параметры

Параметр	Описание
config dictionary	Словарь параметров ACCESS LAYERS
add_default_rule boolean	Указывает, следует ли добавлять правило очистки в новый уровень. Варианты: `false` `true`
applications_and_url_filtering boolean	Следует ли включить модуль Applications & URL Filtering на этом уровне. Варианты: `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	Строка комментария.
content_awareness boolean	Следует ли включить модуль Content Awareness на этом уровне. Варианты: `false` `true`
details_level string	Уровень детализации некоторых полей ответа может варьироваться от отображения только значения UID объекта до полностью подробного представления объекта. Варианты: `"uid"` `"standard"` `"full"`
detect_using_x_forward_for boolean	Использовать ли заголовок HTTP X-Forward-For, который добавляется прокси-сервером для отслеживания исходного IP-адреса. Варианты: `false` `true`
firewall boolean	Следует ли включить модуль Firewall на этом уровне. Варианты: `false` `true`
ignore_errors boolean	Применять изменения, игнорируя ошибки. Опубликовать такие изменения не удастся. Если флаг ignore-warnings не указан, предупреждения также будут игнорироваться. Варианты: `false` `true`
ignore_warnings boolean	Применять изменения, игнорируя предупреждения. Варианты: `false` `true`
implicit_cleanup_action string	Действие по умолчанию («для всех остальных случаев») для трафика, который не соответствует ни одному явному или неявному правилу уровня. Варианты: `"drop"` `"accept"`
limit integer	Максимальное количество возвращаемых результатов. ПРИМЕЧАНИЕ. Этот параметр применим только для состояния GATHERED; для состояний конфигурации, таких как MERGED, REPLACED и DELETED, он не применяется.
mobile_access boolean	Следует ли включить модуль Mobile Access на этом уровне. Варианты: `false` `true`
name string	Имя объекта. Должно быть уникальным в домене.
offset integer	Количество результатов, которые следует пропустить в начале. ПРИМЕЧАНИЕ. Этот параметр применим только для состояния GATHERED; для состояний конфигурации, таких как MERGED, REPLACED и DELETED, он не применяется.
order list / elements=dictionary	Сортирует результаты по указанному полю. По умолчанию результаты сортируются по имени в порядке возрастания. Этот параметр используется только при получении нескольких объектов. ПРИМЕЧАНИЕ. Этот параметр применим только для состояния GATHERED; для состояний конфигурации, таких как MERGED, REPLACED и DELETED, он не применяется.
ASC string	Сортирует результаты по указанному полю в порядке возрастания.
DESC string	Сортирует результаты по указанному полю в порядке убывания.
round_trip boolean	Если установлено значение True, при обратной передаче из параметра ответа будут отфильтрованы параметры модуля, что позволит пользователю отправить запрос конфигурации, используя структурированные собранные данные. ПРИМЕЧАНИЕ. Этот параметр имеет значение только для состояния GATHERED. Для состояний конфигурации, таких как MERGED, REPLACED и DELETED, обновления конфигурации не выполняются, поскольку это не параметр конфигурации модуля. Варианты: `false` `true`
shared boolean	Является ли этот уровень общим. Варианты: `false` `true`
tags list / elements=string	Список идентификаторов тегов.
version string	Версия Check Point. Если она не указана, используется последняя версия.
state string	Состояние, в котором должна остаться конфигурация. Состояние gathered получает конфигурацию API модуля с устройства, преобразует её в структурированные данные в соответствии с форматом аргументов модуля и возвращает значение в ключе gathered результата. Варианты: `"merged"` `"replaced"` `"gathered"` `"deleted"`

Примеры

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

- name: Merge Access-layer config
  cp_mgmt_access_layers:
    state: merged
    config:
      name: New Layer 1
      add_default_rule: true
      applications_and_url_filtering: true
      content_awareness: true
      detect_using_x_forward_for: false
      firewall: true
      implicit_cleanup_action: drop
      mobile_access: true
      shared: false
      tags:
        - test_layer
      color: aquamarine
      comments: test description
      details_level: full
      ignore_warnings: false
      ignore_errors: false
      round_trip: true

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

# mgmt_access_layers:
#   after:
#     applications_and_url_filtering: true
#     color: aquamarine
#     comments: test description
#     content_awareness: true
#     detect_using_x_forward_for: false
#     domain: SMC User
#     firewall: true
#     icon: ApplicationFirewall/rulebase
#     implicit_cleanup_action: drop
#     mobile_access: true
#     name: New Layer 1
#     shared: false
#     tags:
#     - test_layer
#     uid: eb74d7fe-81a6-4e6c-aedb-d2d6599f965e
#   before: {}

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

- name: Replace Access-layer config
  cp_mgmt_access_layers:
    state: replaced
    config:
      name: New Layer 1
      add_default_rule: true
      applications_and_url_filtering: true
      content_awareness: false
      detect_using_x_forward_for: false
      firewall: true
      implicit_cleanup_action: drop
      mobile_access: true
      shared: true
      tags:
        - test_layer_replaced
      color: cyan
      comments: test REPLACE description
      details_level: full
      ignore_warnings: false
      ignore_errors: false
      round_trip: true

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

# mgmt_access_layers:
#   after:
#     applications_and_url_filtering: true
#     color: cyan
#     comments: test REPLACE description
#     content_awareness: false
#     detect_using_x_forward_for: false
#     domain: SMC User
#     firewall: true
#     icon: ApplicationFirewall/sharedrulebase
#     implicit_cleanup_action: drop
#     mobile_access: true
#     name: New Layer 1
#     shared: true
#     tags:
#     - test_layer_replaced
#     uid: a4e2bbc1-ec94-4b85-9b00-07ad1279ac12
#   before:
#     applications_and_url_filtering: true
#     color: aquamarine
#     comments: test description
#     content_awareness: true
#     detect_using_x_forward_for: false
#     firewall: true
#     icon: ApplicationFirewall/rulebase
#     implicit_cleanup_action: drop
#     mobile_access: true
#     name: New Layer 1
#     shared: false
#     tags:
#     - test_layer

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

# 1. With Round Trip set to True

- name: Gather Access-layers config by Name
  cp_mgmt_access_layers:
    state: gathered
    config:
      name: New Layer 1
      round_trip: true

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

# gathered:
#   applications_and_url_filtering: true
#   color: aquamarine
#   comments: test description
#   content_awareness: true
#   detect_using_x_forward_for: false
#   domain: SMC User
#   firewall: true
#   icon: ApplicationFirewall/rulebase
#   implicit_cleanup_action: drop
#   mobile_access: true
#   name: New Layer 1
#   shared: false
#   tags:
#   - test_layer
#   uid: eb74d7fe-81a6-4e6c-aedb-d2d6599f965e

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

- name: Gather Access-layers config by Name
  cp_mgmt_access_layers:
    state: gathered
    config:
      name: New Layer 1

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

# gathered:
#   applications_and_url_filtering: true
#   color: turquoise
#   comments: test description
#   content_awareness: true
#   detect_using_x_forward_for: false
#   domain:
#     domain-type: domain
#     name: SMC User
#     uid: 41e821a0-3720-11e3-aa6e-0800200c9fde
#   firewall: true
#   icon: ApplicationFirewall/rulebase
#   implicit_cleanup_action: drop
#   meta-info:
#     creation-time:
#       iso-8601: 2022-11-21T07:34+0000
#       posix: 1669016073937
#     creator: admin
#     last-modifier: admin
#     last-modify-time:
#       iso-8601: 2022-11-21T07:34+0000
#       posix: 1669016074765
#     lock: unlocked
#     validation-state: ok
#   mobile_access: true
#   name: New Layer 1
#   read-only: false
#   shared: false
#   tags:
#   - domain:
#       domain-type: domain
#       name: SMC User
#       uid: 41e821a0-3720-11e3-aa6e-0800200c9fde
#     name: test_layer
#     type: tag
#     uid: 22cc8b0d-984f-47de-b1f6-276b3377eb0c
#   type: access-layer
#   uid: a54e47d3-22fc-4aff-90d9-f644aa4a1522

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

- name: To Gather ALL access-layer and order by Name
  cp_mgmt_access_layers:
    config:
      order:
        - DESC: name
    state: gathered

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

# gathered:
#   - domain:
#       domain-type: domain
#       name: SMC User
#       uid: 41e821a0-3720-11e3-aa6e-0800200c9fde
#     name: New Layer 1
#     type: access-layer
#     uid: a54e47d3-22fc-4aff-90d9-f644aa4a1522
#   - domain:
#       domain-type: domain
#       name: SMC User
#       uid: 41e821a0-3720-11e3-aa6e-0800200c9fde
#     name: Network
#     type: access-layer
#     uid: 63b7fe60-76d2-4287-bca5-21af87337b0a

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

- name: Delete Access-layer config by Name
  cp_mgmt_access_layers:
    state: deleted
    config:
      name: New Layer 1

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

# mgmt_access_layers:
#   after: {}
#   before:
#     applications_and_url_filtering: true
#     color: cyan
#     comments: test REPLACE description
#     content_awareness: false
#     detect_using_x_forward_for: false
#     domain: SMC User
#     firewall: true
#     icon: ApplicationFirewall/sharedrulebase
#     implicit_cleanup_action: drop
#     mobile_access: true
#     name: New Layer 1
#     shared: true
#     tags:
#     - test_layer_replaced
#     uid: a4e2bbc1-ec94-4b85-9b00-07ad1279ac12

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

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

Ключ	Описание
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_access_layers_module.html