check_point.gaia.cp_gaia_scheduled_snapshot_facts (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

Show the snapshot scheduler configuration.

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: Show the snapshot scheduler configuration
  check_point.gaia.cp_gaia_scheduled_snapshot_facts:

Inputs

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

Outputs

ansible_facts:
  contains:
    description:
      description: Description of the scheduled snapshot.
      returned: always
      type: str
    enabled:
      description: State of the snapshot scheduler.
      returned: always
      type: bool
    host:
      contains:
        ip_address:
          description: IP_Address of the target.
          returned: always
          type: str
        password:
          description: Password for scp/ftp targets.
          returned: always
          type: str
        target:
          description: Host target type. choices=['lvm', 'ftp', 'scp'].
          returned: always
          type: str
        upload_path:
          description: Upload path for scp/ftp targets.
          returned: always
          type: str
        username:
          description: Username for scp/ftp targets.
          returned: always
          type: str
      description: Target host for the snapshots creation.
      returned: always
      type: dict
    name_prefix:
      description: Prefix for the snapshots name created by the scheduler.
      returned: always
      type: str
    recurrence:
      contains:
        days:
          description: Recurrence days.
          elements: int
          returned: always
          type: list
        months:
          description: Recurrence months.
          elements: int
          returned: always
          type: list
        pattern:
          description: Recurrence pattern. choices=['daily', 'monthly', 'weekly'].
          returned: always
          type: str
        time:
          contains:
            hour:
              description: Time hour.
              returned: always
              type: int
            minute:
              description: Time minute.
              returned: always
              type: int
          description: Recurrence time.
          returned: always
          type: dict
        weekdays:
          description: Recurrence weekdays.
          elements: str
          returned: always
          type: list
      description: Recurrence of the scheduled snapshot.
      returned: always
      type: dict
    retention_policy:
      contains:
        keep_disk_space_above_in_GB:
          description: Minimum diskspace to keep on the local machine (GB).
          returned: always
          type: int
        max_snapshots_to_keep:
          description: Maximum snapshots to keep.
          returned: always
          type: int
        min_snapshots_to_keep:
          description: Minimum snapshots to keep.
          returned: always
          type: int
      description: Retention policy for the snapshot scheduler.
      returned: always
      type: dict
  description: The checkpoint object facts.
  returned: always.
  type: dict