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

Change the scheduled job's recurrence or command. Scheduled jobs run as admin.

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: Add new scheduled job
  check_point.gaia.cp_gaia_scheduled_job:
    name: "startup_job"
    command: "/home/admin/job.sh"
    recurrence: {"type": "system-startup"}

Inputs

    
name:
    description: Scheduled job name.
    required: true
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description: Ansible state which can be C(present) or C(absent).
    required: false
    type: str

command:
    description: Command (expert CLI style).
    required: false
    type: str

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

recurrence:
    description: Recurrence.
    required: false
    suboptions:
      days:
        description: Days of the month. Relevant for "monthly" recurrence type.
        elements: int
        required: false
        type: list
      hourly:
        description: Hours of day in 24 hour format. Can choose multiple hours. Relevant
          for "hourly" recurrence type.
        required: false
        suboptions:
          hours_of_day:
            description: Hours of day in 24 hour format.
            elements: int
            required: false
            type: list
          minute:
            description: Time minute.
            required: false
            type: int
        type: dict
      interval:
        description: Time interval in minutes. Relevant for "interval" recurrence type.
        required: false
        type: int
      months:
        description: Month numbers. Relevant for "monthly" recurrence type.
        elements: int
        required: false
        type: list
      time_of_day:
        description: Time of day in 24 hour format. Relevant for "daily", "weekly" and
          "monthly" recurrence types.
        required: false
        suboptions:
          hour:
            description: Time hour.
            required: false
            type: int
          minute:
            description: Time minute.
            required: false
            type: int
        type: dict
      type:
        choices:
        - system-startup
        - interval
        - hourly
        - daily
        - weekly
        - monthly
        description: Job recurrence type.
        required: false
        type: str
      weekdays:
        description: Days of the week. Relevant for "weekly" recurrence type.
        elements: str
        required: false
        type: list
    type: dict

Outputs

scheduled_job:
  description: The updated scheduled job details.
  returned: always.
  type: dict