check_point.mgmt.cp_mgmt_import_management (5.2.3) — module

Import the primary Security Management Server database or the primary Multi-Domain Server database or the single Domain database and the applicable Check Point configuration.

| "added in version" 5.0.0 of check_point.mgmt"

Authors: Eden Brillant (@chkp-edenbr)

preview | supported by community

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

Import the primary Security Management Server database or the primary Multi-Domain Server database or the single Domain database and the applicable Check Point configuration. <br/>After the import starts, the session expires and you must login again.

All operations are performed over Web Services API.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: import-management
  cp_mgmt_import_management:
    file_path: /var/log/domain1_exported.tgz

Inputs

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

file_path:
    description:
    - Path to the exported database file to be imported.
    required: true
    type: str

domain_name:
    description:
    - Domain name to be imported. Must be unique in the Multi-Domain Server.<br><font
      color="red">Required only for</font> importing the Security Management Server into
      the Multi-Domain Server.
    type: str

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

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

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

domain_ip_address:
    description:
    - IPv4 address for the imported Domain.<br><font color="red">Required only for</font>
      importing the Security Management Server into the Multi-Domain Server.
    type: str

domain_server_name:
    description:
    - Multi-Domain Server name for the imported Domain.<br><font color="red">Required
      only for</font> importing the Security Management Server into the Multi-Domain Server.
    type: str

keep_cloud_sharing:
    description:
    - Preserve the connection of the Management Server to Check Point's Infinity Portal.<br>Use
      this flag after ensuring that the original Management Server does not communicate
      with Infinity Portal.<br>Note, resuming the connection is also possible after import
      with set-cloud-services.
    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:
    - Import logs with log indexes.
    type: bool

verify_domain_restore:
    description:
    - If true, verify that the restore operation is valid for this input file and this
      environment. <br>Note, Restore operation will not be executed.
    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 import of the Endpoint Security Management database.
    type: bool

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

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

Outputs

cp_mgmt_import_management:
  description: The checkpoint import-management output.
  returned: always.
  type: dict