cp_mgmt_set_https_advanced_settings

Configure advanced settings for HTTPS Inspection through native controller HTTPAPI with owned sessions

Collection: check_point.mgmt

Full Name: check_point.mgmt.cp_mgmt_set_https_advanced_settings

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

Synopsis

Configure advanced settings for HTTPS Inspection through native controller HTTPAPI with owned sessions

Parameters

Name	Type	Default	Description
auto_publish_session	bool	`false`	Publish this owned session explicitly after the operation; default false.
blocked_certificate_tracking	str		Controls whether to log and send a notification for dropped traffic. None - Does not record the event. Log - Records the event details in SmartView. Alert - Logs the event and executes a command. Mail - Sends an email to the administrator. SNMP Trap - Sends an SNMP alert to the SNMP GU. User Defined Alert - Sends customized alerts. .
blocked_certificates	list		Collection of certificates objects identified by serial number. Drop traffic from servers using the blocked certificate.
bypass_on_client_failure	bool		Whether all requests should be bypassed or blocked-in case of client errors (Client closes the connection due to authentication issues during handshake) true - Fail-open (bypass all requests). false - Fail-close (block all requests. The default value is true.
bypass_on_failure	bool		Whether all requests should be bypassed or blocked-in case of server errors (for example validation error during GW-Server authentication) true - Fail-open (bypass all requests). false - Fail-close (block all requests. The default value is true.
bypass_under_load	dict		Bypass the HTTPS Inspection temporarily to improve connectivity during a heavy load on the Security Gateway. The HTTPS Inspection would resume as soon as the load decreases.
bypass_update_services	bool		Configure the value “true” to bypass traffic to well-known software update services. The default value is true.
certificate_pinned_apps_action	str		Configure the value “bypass” to bypass traffic from certificate-pinned applications approved by Check Point. HTTPS Inspection cannot inspect connections initiated by certificate-pinned applications. Configure the value “detect” to send logs for traffic from certificate-pinned applications approved by Check Point. The default value is bypass.
details_level	str		The level of detail for some of the fields in the response can vary from showing only the UID value of the object to a fully detailed representation of the object.
domains_to_process	list		Indicates which domains to process the commands on. It cannot be used with the details-level full, must be run from the System Domain only and with ignore-warnings true. Valid values are, CURRENT_DOMAIN, ALL_DOMAINS_ON_THIS_SERVER.
ignore_errors	bool		Apply changes ignoring errors. You won’t be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.
ignore_warnings	bool		Apply changes ignoring warnings.
log_sessions	bool		The value “true” configures the Security Gateway to send HTTPS Inspection session logs. The default value is true.
retrieve_intermediate_ca_certificates	bool		Configure the value “true” to use the “Certificate Authority Information Access” extension to retrieve certificates that are missing from the certificate chain. The default value is true.
server_certificate_validation_actions	dict		When a Security Gateway receives an untrusted certificate from a website server, define when to drop the connection and how to track it.
site_categorization_allow_mode	str		Whether all requests should be allowed or blocked until categorization is complete. Background - to allow requests until categorization is complete. Hold- to block requests until categorization is complete. The default value is hold.
version	str		Management API version path; omitted uses the default API version.
wait_for_task	bool	`true`	Wait for returned asynchronous task identifiers; default true.
wait_for_task_timeout	int	`30`	Polling deadline in minutes; default 30, negative values use 30, maximum 1440.

Example

yaml

- name: set-https-advanced-settings
  check_point.mgmt.cp_mgmt_set_https_advanced_settings:
    blocked_certificate_tracking: popup alert
    bypass_on_client_failure: 'false'
    bypass_on_failure: 'false'
    bypass_under_load:
      track: log
    bypass_update_services: 'true'
    certificate_pinned_apps_action: bypass
    log_sessions: 'true'
    retrieve_intermediate_ca_certificates: 'true'
    server_certificate_validation_actions:
      block_expired: 'true'
      block_revoked: 'false'
      block_untrusted: 'true'
      track_errors: snmp trap alert
    site_categorization_allow_mode: background