check_point.gaia.cp_gaia_scheduled_snapshot (5.0.1) — module

Install collection

Install with ansible-galaxy collection install check_point.gaia:==5.0.1

Add to requirements.yml

  collections:
    - name: check_point.gaia
      version: 5.0.1

Description

Set scheduled snapshot.

Requirements

• supported starting from gaia_api >= 1.6

Usage examples

Scanned by Steampunk Spotter

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

- name: Set scheduled snapshot
  check_point.gaia.cp_gaia_scheduled_snapshot:
    recurrence: {"pattern": "weekly", "weekdays": ["Mon","Wed"], time: {"minute": 30,"hour": 13}}
    name_prefix: "weeklySnap"
    host: {"username": "username","upload_path": "/home/admin/", "password": "secret", "target": "lvm"}
    enabled: True
    description: "weekly"

Inputs

    
host:
    description: Target host for the snapshots creation.
    required: false
    suboptions:
      ip_address:
        description: IP_Address of the target.
        required: false
        type: str
      password:
        description: Password for scp/ftp targets.
        required: false
        type: str
      target:
        choices:
        - lvm
        - ftp
        - scp
        description: Host target type. choices=['lvm', 'ftp', 'scp'].
        required: false
        type: str
      upload_path:
        description: Upload path for scp/ftp targets.
        required: false
        type: str
      username:
        description: Username for scp/ftp targets.
        required: false
        type: str
    type: dict

enabled:
    description: State of the snapshot scheduler.
    required: false
    type: bool

version:
    description: Gaia API version for example 1.6.
    required: false
    type: str

recurrence:
    description: Recurrence of the scheduled snapshot.
    required: false
    suboptions:
      days:
        description: Recurrence days.
        elements: int
        required: false
        type: list
      months:
        description: Recurrence months.
        elements: int
        required: false
        type: list
      pattern:
        choices:
        - daily
        - monthly
        - weekly
        description: Recurrence pattern. choices=['daily', 'monthly', 'weekly'].
        required: false
        type: str
      time:
        description: Recurrence time.
        required: false
        suboptions:
          hour:
            description: Time hour.
            required: false
            type: int
          minute:
            description: Time minute.
            required: false
            type: int
        type: dict
      weekdays:
        description: Recurrence weekdays.
        elements: str
        required: false
        type: list
    type: dict

description:
    description: Description of the scheduled snapshot.
    required: false
    type: str

name_prefix:
    description: Prefix for the snapshots name created by the scheduler.
    required: false
    type: str

retention_policy:
    description: Retention policy for the snapshot scheduler.
    required: false
    suboptions:
      keep_disk_space_above_in_GB:
        description: Minimum diskspace to keep on the local machine (GB).
        required: false
        type: int
      max_snapshots_to_keep:
        description: Maximum snapshots to keep.
        required: false
        type: int
      min_snapshots_to_keep:
        description: Minimum snapshots to keep.
        required: false
        type: int
    type: dict

Outputs

scheduled_snapshot:
  description: The checkpoint object updated.
  returned: always.
  type: dict