CheckpointFWBackupStatus Deprecated

Deprecated. Use ssh command instead. Connect to a CheckPoint firewall appliance using SSH and retrieve the status for backup tasks. The user account being used to access the device must be set to use the SSH shell and not the built-in CheckPoint CLI. For more information, consult the CheckPoint documentation.

python · Check Point Firewall

Details

IDCheckpointFWBackupStatus
Languagepython
From Version5.0.0
Docker Imagedemisto/python:2.7.18.27799
Tagscheckpoint

README

Connects a Checkpoint firewall appliance using SSH and retrieves the status of backup tasks. The user account that accesses the device must be setup to use the SSH shell and not the built in Checkpoint CLI. Consult the Checkpoint documentation for instructions on how to do this.

Script Data


Name Description
Script Type python
Tags checkpoint

Dependencies


This script uses the following commands and scripts.

  • ssh

Inputs


Argument Name Description
devices The list of devices to backup (comma-separated).
waittimeout The wait time in seconds. If not provided, it will not wait.

Outputs


Path Description Type
CheckpointBackup.DeviceName The name of the backed-up device. Unknown
CheckpointBackup.System The backed up system. Unknown
CheckpointBackup.Status The status of the backup process. Unknown
CheckpointBackup.Path The path of the backup file. Unknown
commonfields:
  id: CheckpointFWBackupStatus
  version: -1
name: CheckpointFWBackupStatus
script: ''
type: python
subtype: python2
tags:
- checkpoint
comment: Deprecated. Use ssh command instead. Connect to a CheckPoint firewall appliance using SSH and retrieve the status
  for backup tasks. The user account being used to access the device must be set to
  use the SSH shell and not the built-in CheckPoint CLI. For more information, consult the CheckPoint documentation.
enabled: true
args:
- name: devices
  required: true
  default: true
  description: A comma-separated list of devices to backup.
- name: waittimeout
  description: The wait-out time, in seconds. If not provided, does not wait.
outputs:
- contextPath: CheckpointBackup.DeviceName
  description: Name of the backed-up device.
- contextPath: CheckpointBackup.System
  description: System that was backed up.
- contextPath: CheckpointBackup.Status
  description: Status of the backup process.
- contextPath: CheckpointBackup.Path
  description: Path of the backup file.
scripttarget: 0
deprecated: true
dependson:
  must:
  - ssh
timeout: 0s
fromversion: 5.0.0
tests:
- No tests
dockerimage: demisto/python:2.7.18.27799