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

Примечание

Этот модуль является частью коллекции 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_access_layers.

Новая функция в check_point.mgmt 5.0.0

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

Описание

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

Примечание

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

Параметры

Параметр	Комментарии
config dictionary	Словарь параметров ACCESS LAYERS
add_default_rule boolean	Указывает, следует ли включать правило очистки в новый слой. Варианты: `false` `true`
applications_and_url_filtering boolean	Включать ли модуль «Приложения и фильтрация URL» на слое. Варианты: `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	Включать ли модуль «Определение контента» на слое. Варианты: `false` `true`
details_level string	Уровень детализации для некоторых полей в ответе может варьироваться от отображения только значения UID объекта до полного подробного представления объекта. Варианты: `"uid"` `"standard"` `"full"`
detect_using_x_forward_for boolean	Использовать ли заголовок HTTP X-Forward-For, который добавляется прокси-сервером для отслеживания исходного IP-адреса. Варианты: `false` `true`
firewall boolean	Включать ли модуль брандмауэра на слое. Варианты: `false` `true`
ignore_errors boolean	Применить изменения, игнорируя ошибки. Вы не сможете опубликовать такие изменения. Если флаг ignore-warnings был опущен, предупреждения также будут игнорироваться. Варианты: `false` `true`
ignore_warnings boolean	Применить изменения, игнорируя предупреждения. Варианты: `false` `true`
implicit_cleanup_action string	Действие по умолчанию «catch-all» для трафика, который не соответствует ни явным, ни неявным правилам в слое. Варианты: `"drop"` `"accept"`
limit integer	Максимальное количество возвращаемых результатов. ПРИМЕЧАНИЕ. Этот параметр является допустимым только для состояния GATHERED, для состояний конфигурации, таких как MERGED, REPLACED и DELETED, он не будет применим.
mobile_access boolean	Включать ли модуль «Мобильный доступ» на слое. Варианты: `false` `true`
name string	Имя объекта. Должно быть уникальным в домене.
offset integer	Количество результатов, которые необходимо пропустить изначально. ПРИМЕЧАНИЕ. Этот параметр является допустимым только для состояния GATHERED, для состояний конфигурации, таких как MERGED, REPLACED и DELETED, он не будет применим.

order список / элементы=словарь	Сортирует результаты по заданному полю. По умолчанию результаты сортируются по имени в порядке возрастания. Этот параметр актуален только для получения нескольких объектов. ПРИМЕЧАНИЕ: этот параметр является допустимым только для состояния GATHERED, для состояний конфигурации, таких как MERGED, REPLACED и DELETED, он не будет применим.
ASC строка	Сортирует результаты по заданному полю в порядке возрастания.
DESC строка	Сортирует результаты по заданному полю в порядке убывания.
round_trip булево	Если установлено в значение True, цикл «туда и обратно» отфильтрует параметры модуля из параметра ответа, что позволит пользователю выполнить запрос конфигурации, используя структурированные собранные данные. ПРИМЕЧАНИЕ: этот параметр актуален только для состояния GATHERED, так как для состояний конфигурации, таких как MERGED, REPLACED и DELETED, он не будет выполнять никаких обновлений конфигурации, так как это не параметр конфигурации модуля. Варианты: `false` `true`
shared булево	Является ли этот слой общим. Варианты: `false` `true`
tags список / элементы=строка	Коллекция идентификаторов тегов.
version строка	Версия контрольной точки. Если не указана, берется последняя версия.
state строка	Состояние, в котором должна оставаться конфигурация. Состояние gathered получит конфигурацию API модуля с устройства и преобразует ее в структурированные данные в формате, соответствующем argspec модуля, а значение возвращается в ключе 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 словарь	Результирующая конфигурация после выполнения модуля. Возвращается: при изменении Пример: `"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_access_layers_module.html