cp_mgmt_export_management
Export the primary Security Management Server database or the primary Multi-Domain Server database or the single Domain database and the applicable Check Point configuration through native controller HTTPAPI with owned sessions
Collection: check_point.mgmt
Full Name: check_point.mgmt.cp_mgmt_export_management
Controller module — runs on the local controller, not on remote hosts.
Synopsis
Export the primary Security Management Server database or the primary Multi-Domain Server database or the single Domain database and the applicable Check Point configuration through native controller HTTPAPI with owned sessions
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| auto_publish_session | bool | false | Publish this owned session explicitly after the operation; default false. | |
| domain_name | str | Domain name to be exported. Required only for exporting a Domain from the Multi-Domain Server or backing up Domain. | ||
| file_path | str | Path in which the exported database file is saved. Required only when not using pre-export-verification-only flag. | ||
| ignore_warnings | bool | Ignoring the verification warnings. By Setting this parameter to ’true’ export will not be blocked by warnings. | ||
| include_endpoint_configuration | bool | Include export of the Endpoint Security Management configuration files. | ||
| include_endpoint_database | bool | Include export of the Endpoint Security Management database. | ||
| include_logs | bool | Export logs without log indexes. | ||
| include_logs_indexes | bool | Export logs with log indexes. | ||
| is_domain_backup | bool | If true, the exported Domain will be suitable for import on the same Multi-Domain Server only. | ||
| is_smc_to_mds | bool | If true, the exported Security Management Server will be suitable for import on the Multi-Domain Server only. | ||
| pre_export_verification_only | bool | If true, only runs the pre-export verifications instead of the full export. | ||
| target_version | str | Target version. | ||
| 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: export-management
check_point.mgmt.cp_mgmt_export_management:
domain_name: domain1
file_path: /var/log/domain1_backup.tgz
is_domain_backup: true