check_point.mgmt.cp_mgmt_set_app_control_update_schedule module – Set the Application Control and URL Filtering update schedule.

Note

This module is part of the check_point.mgmt collection (version 6.5.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install check_point.mgmt.

To use it in a playbook, specify: check_point.mgmt.cp_mgmt_set_app_control_update_schedule.

New in check_point.mgmt 6.5.0

Synopsis

  • Set the Application Control and URL Filtering update schedule.

  • All operations are performed over Web Services API.

  • Available from R82 JHF management version.

Parameters

Parameter

Comments

auto_publish_session

boolean

Publish the current session if changes have been performed after task completes.

Choices:

  • false ← (default)

  • true

schedule_gateway_update

dictionary

Application Control & URL Filtering Update Schedule on Gateway.

enabled

boolean

Enable/Disable Application Control & URL Filtering Update Schedule on Gateway.

Choices:

  • false

  • true

schedule

dictionary

Schedule Configuration.

recurrence

dictionary

Days recurrence.

days

list / elements=string

Days of the month to run the update.<br> Valid values, interval in the range of 1 to 31. <font color=”red”>Required only when</font> pattern is set to ‘Monthly’.

interval_hours

integer

The amount of hours between updates. <font color=”red”>Required only when</font> pattern is set to ‘Interval’.

interval_minutes

integer

The amount of minutes between updates. <font color=”red”>Required only when</font> pattern is set to ‘Interval’.

interval_seconds

integer

The amount of seconds between updates. <font color=”red”>Required only when</font> pattern is set to ‘Interval’.

pattern

string

Days recurrence pattern.

Choices:

  • "Daily"

  • "Weekly"

  • "Monthly"

  • "Interval"

weekdays

list / elements=string

Days of the week to run the update.<br> Valid values, group of values from {‘Sun’, ‘Mon’, ‘Tue’, ‘Wed’, ‘Thu’, ‘Fri’, ‘Sat’}. <font color=”red”>Required only when</font> pattern is set to ‘Weekly’.

time

string

Time in format HH,mm.

schedule_management_update

dictionary

Application Control & URL Filtering Update Schedule on Management Server.

enabled

boolean

Enable/Disable Application Control & URL Filtering Update Schedule on Management Server.

Choices:

  • false

  • true

schedule

dictionary

Schedule Configuration.

recurrence

dictionary

Days recurrence.

days

list / elements=string

Days of the month to run the update.<br> Valid values, interval in the range of 1 to 31. <font color=”red”>Required only when</font> pattern is set to ‘Monthly’.

pattern

string

Days recurrence pattern.

Choices:

  • "Daily"

  • "Weekly"

  • "Monthly"

weekdays

list / elements=string

Days of the week to run the update.<br> Valid values, group of values from {‘Sun’, ‘Mon’, ‘Tue’, ‘Wed’, ‘Thu’, ‘Fri’, ‘Sat’}. <font color=”red”>Required only when</font> pattern is set to ‘Weekly’.

time

string

Time in format HH,mm.

version

string

Version of checkpoint. If not given one, the latest version taken.

wait_for_task

boolean

Wait for the task to end. Such as publish task.

Choices:

  • false

  • true ← (default)

wait_for_task_timeout

integer

How many minutes to wait until throwing a timeout error.

Default: 30

Examples

- name: set-app-control-update-schedule
  cp_mgmt_set_app_control_update_schedule:
    schedule_gateway_update:
      schedule:
        recurrence:
          interval_hours: 4
          interval_minutes: 30
          interval_seconds: 10
          pattern: interval
    state: present

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

cp_mgmt_set_app_control_update_schedule

dictionary

The checkpoint set-app-control-update-schedule output.

Returned: always.

Authors

  • Dor Berenstein (@chkp-dorbe)