PARALLAX

cp_mgmt_set_compliance_settings

Edit existing Compliance Settings through native controller HTTPAPI with owned sessions

Collection: check_point.mgmt

Full Name: check_point.mgmt.cp_mgmt_set_compliance_settings

Controller module — runs on the local controller, not on remote hosts.

Synopsis

Edit existing Compliance Settings through native controller HTTPAPI with owned sessions

Parameters

NameTypeRequiredDefaultDescription
auto_publish_sessionboolfalsePublish this owned session explicitly after the operation; default false.
automatic_scan_schedulerdictSchedule for an automatic full Compliance scan.
enable_email_alertsboolEnables or disables sending email alerts to SmartEvent (only for alerts). The default value is true.
enable_smart_event_logsboolEnables or disables sending logs to SmartEvent. The default value is true.
initialize_best_practicesboolIf true, creates all the default Best Practices again. After the first scan completes, the value of this parameter is automatically set to false. The default value is true for initial setup and false after first scan.
partial_scan_delayintControls when the partial scan starts after publishing a session. The partial scan checks only the relevant firewall best practices. If the value is < 0, the partial scan is disabled. If the value is 0, the partial scan starts immediately after publishing. If the value is > 0, the partial scan is delayed by the specified number of seconds after publishing. The default value is ‘0’.
versionstrManagement API version path; omitted uses the default API version.
wait_for_taskbooltrueWait for returned asynchronous task identifiers; default true.
wait_for_task_timeoutint30Polling deadline in minutes; default 30, negative values use 30, maximum 1440.

Example

yaml
- name: set-compliance-settings
  check_point.mgmt.cp_mgmt_set_compliance_settings:
    automatic_scan_scheduler:
      scan_day: sunday
      scan_time: 08:00:00
      scheduled_scan_on: false
    partial_scan_delay: -1
Search
    ↑ ↓ move↵ openesc close