check_point.mgmt.cp_mgmt_export_management (5.2.3) — module

Install collection

Install with ansible-galaxy collection install check_point.mgmt:==5.2.3

Add to requirements.yml

  collections:
    - name: check_point.mgmt
      version: 5.2.3

Description

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.

All operations are performed over Web Services API.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: export-management
  cp_mgmt_export_management:
    domain_name: domain1
    file_path: /var/log/domain1_backup.tgz
    is_domain_backup: true

Inputs

    
version:
    description:
    - Version of checkpoint. If not given one, the latest version taken.
    type: str

file_path:
    description:
    - Path in which the exported database file is saved.<br><font color="red">Required
      only</font> when not using pre-export-verification-only flag.
    type: str

domain_name:
    description:
    - Domain name to be exported.<br><font color="red">Required only for</font> exporting
      a Domain from the Multi-Domain Server or backing up Domain.
    type: str

include_logs:
    description:
    - Export logs without log indexes.
    type: bool

is_smc_to_mds:
    description:
    - If true, the exported Security Management Server will be suitable for import on
      the Multi-Domain Server only.
    type: bool

wait_for_task:
    default: true
    description:
    - Wait for the task to end. Such as publish task.
    type: bool

target_version:
    description:
    - Target version.
    type: str

ignore_warnings:
    description:
    - Ignoring the verification warnings. By Setting this parameter to 'true' export will
      not be blocked by warnings.
    type: bool

is_domain_backup:
    description:
    - If true, the exported Domain will be suitable for import on the same Multi-Domain
      Server only.
    type: bool

auto_publish_session:
    default: false
    description:
    - Publish the current session if changes have been performed after task completes.
    type: bool

include_logs_indexes:
    description:
    - Export logs with log indexes.
    type: bool

wait_for_task_timeout:
    default: 30
    description:
    - How many minutes to wait until throwing a timeout error.
    type: int

include_endpoint_database:
    description:
    - Include export of the Endpoint Security Management database.
    type: bool

pre_export_verification_only:
    description:
    - If true, only runs the pre-export verifications instead of the full export.
    type: bool

include_endpoint_configuration:
    description:
    - Include export of the Endpoint Security Management configuration files.
    type: bool

Outputs

cp_mgmt_export_management:
  description: The checkpoint export-management output.
  returned: always.
  type: dict