check_point.gaia.cp_gaia_scheduled_job_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 scheduled job information.

Requirements

• supported starting from gaia_api >= 1.7

Usage examples

Scanned by Steampunk Spotter

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

- name: Show scheduled jobs
  check_point.gaia.cp_gaia_scheduled_job_facts:

Scanned by Steampunk Spotter

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

- name: Show scheduled job by specifying it's name
  check_point.gaia.cp_gaia_scheduled_job_facts):
    name: test_job

Inputs

    
name:
    description: Scheduled job name to show. If not specified, all scheduled jobs information
      is returned.
    required: false
    type: str

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

Outputs

ansible_facts:
  contains:
    jobs:
      contains:
        command:
          description: Command (expert CLI style).
          returned: always
          type: str
        name:
          description: Scheduled job name.
          returned: always
          type: str
        recurrence:
          contains:
            days:
              description: Days of the month. Relevant for "monthly" recurrence type.
              elements: int
              returned: always
              type: list
            hourly:
              contains:
                hours_of_day:
                  description: Hours of day in 24 hour format.
                  elements: int
                  returned: always
                  type: list
                minute:
                  description: Time minute.
                  returned: always
                  type: int
              description: Hours of day in 24 hour format. Can choose multiple hours.
                Relevant for "hourly" recurrence type.
              returned: always
              type: dict
            interval:
              description: Time interval in minutes. Relevant for "interval" recurrence
                type.
              returned: always
              type: int
            months:
              description: Month numbers. Relevant for "monthly" recurrence type.
              elements: int
              returned: always
              type: list
            time_of_day:
              contains:
                hour:
                  description: Time hour.
                  returned: always
                  type: int
                minute:
                  description: Time minute.
                  returned: always
                  type: int
              description: Time of day in 24 hour format. Relevant for "daily", "weekly"
                and "monthly" recurrence types.
              returned: always
              type: dict
            type:
              description: Job recurrence type.
              returned: always
              type: str
            weekdays:
              description: Days of the week. Relevant for "weekly" recurrence type.
              elements: str
              returned: always
              type: list
          description: Recurrence.
          returned: always
          type: dict
      description: All jobs.
      elements: dict
      returned: always
      type: list
  description: The checkpoint object facts.
  returned: always.
  type: dict