check_point.mgmt.cp_mgmt_time module – Manages time objects on Check Point over Web Services API
Note
This module is part of the check_point.mgmt collection (version 6.4.1).
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_time
.
New in check_point.mgmt 1.0.0
Synopsis
Manages time objects on Check Point devices including creating, updating and removing objects.
All operations are performed over Web Services API.
Available from R80 management version.
Parameters
Parameter |
Comments |
---|---|
Publish the current session if changes have been performed after task completes. Choices:
|
|
Color of the object. Should be one of existing colors. Choices:
|
|
Comments string. |
|
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. Choices:
|
|
End time. Note, Each gateway may interpret this time differently according to its time zone. |
|
Date in format dd-MMM-yyyy. |
|
Date and time represented in international ISO 8601 format. Time zone information is ignored. |
|
Number of milliseconds that have elapsed since 00,00,00, 1 January 1970. |
|
Time in format HH,mm. |
|
End never. Choices:
|
|
Collection of group identifiers. |
|
Hours recurrence. Note, Each gateway may interpret this time differently according to its time zone. |
|
Is hour range enabled. Choices:
|
|
Time in format HH,MM. |
|
Hour range index. |
|
Time in format HH,MM. |
|
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. Choices:
|
|
Apply changes ignoring warnings. Choices:
|
|
Object name. |
|
Days recurrence. |
|
Valid on specific days. Multiple options, support range of days in months. Example,[“1”,”3”,”9-20”]. |
|
Valid on month. Example, “1”, “2”,”12”,”Any”. |
|
Valid on “Daily”, “Weekly”, “Monthly” base. |
|
Valid on weekdays. Example, “Sun”, “Mon”…”Sat”. |
|
Starting time. Note, Each gateway may interpret this time differently according to its time zone. |
|
Date in format dd-MMM-yyyy. |
|
Date and time represented in international ISO 8601 format. Time zone information is ignored. |
|
Number of milliseconds that have elapsed since 00,00,00, 1 January 1970. |
|
Time in format HH,mm. |
|
Start immediately. Choices:
|
|
State of the access rule (present or absent). Choices:
|
|
Collection of tag identifiers. |
|
Version of checkpoint. If not given one, the latest version taken. |
|
Wait for the task to end. Such as publish task. Choices:
|
|
How many minutes to wait until throwing a timeout error. Default: |
Examples
- name: add-time
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
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
cp_mgmt_time:
name: timeObject1
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The checkpoint object created or updated. Returned: always, except when deleting the object. |