cp_mgmt_time

Manages time objects on Check Point over Web Services API through native controller HTTPAPI with owned sessions

Collection: check_point.mgmt

Full Name: check_point.mgmt.cp_mgmt_time

Controller module — runs on the local controller, not on remote hosts.

Synopsis

Manages time objects on Check Point over Web Services API through native controller HTTPAPI with owned sessions

Parameters

Name	Type	Required	Default	Description
auto_publish_session	bool		`false`	Publish this owned session explicitly after the operation; default false.
color	str			Color of the object. Should be one of existing colors.
comments	str			Comments string.
details_level	str			The level of detail for some of the fields in the response can vary from showing only the UID value of the object to a fully detailed representation of the object.
end	dict			End time. Note, Each gateway may interpret this time differently according to its time zone.
end_never	bool			End never.
groups	list			Collection of group identifiers.
hours_ranges	list			Hours recurrence. Note, Each gateway may interpret this time differently according to its time zone.
ignore_errors	bool			Apply changes ignoring errors. You won’t be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.
ignore_warnings	bool			Apply changes ignoring warnings.
name	str	yes		Object name.
recurrence	dict			Days recurrence.
start	dict			Starting time. Note, Each gateway may interpret this time differently according to its time zone.
start_now	bool			Start immediately.
state	str		`present`	Desired object presence.
tags	list			Collection of tag identifiers.
version	str			Management API version path; omitted uses the default API version.
wait_for_task	bool		`true`	Wait for returned asynchronous task identifiers; default true.
wait_for_task_timeout	int		`30`	Polling deadline in minutes; default 30, negative values use 30, maximum 1440.

Example

yaml

- name: add-time
  check_point.mgmt.cp_mgmt_time:
    end:
      date: 24-Nov-2014
      time: '21:22'
    end_never: 'false'
    hours_ranges:
      - enabled: true
        from: 00:00
        index: 1
        to: 00:00
      - enabled: false
        from: 00:00
        index: 2
        to: 00:00
    name: timeObject1
    recurrence:
      days:
        - '1'
      month: Any
      pattern: Daily
      weekdays:
        - Sun
        - Mon
    start_now: 'true'
    state: present

- name: set-time
  check_point.mgmt.cp_mgmt_time:
    hours_ranges:
      - from: 00:22
        to: 00:33
    name: timeObject1
    recurrence:
      month: Any
      pattern: Weekly
      weekdays:
        - Fri
    state: present

- name: delete-time
  check_point.mgmt.cp_mgmt_time:
    name: timeObject1
    state: absent