ansible.builtin.cp_mgmt_time (v2.9.17) — module

Manages time objects on Check Point over Web Services API

| "added in version" 2.9 of ansible.builtin"

Authors: Or Soffer (@chkp-orso)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.17

Description

Manages time objects on Check Point devices including creating, updating and removing objects.

All operations are performed over Web Services API.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: delete-time
  cp_mgmt_time:
    name: timeObject1
    state: absent

Inputs

    
end:
    description:
    - End time. Note, Each gateway may interpret this time differently according to its
      time zone.
    suboptions:
      date:
        description:
        - Date in format dd-MMM-yyyy.
        type: str
      iso_8601:
        description:
        - Date and time represented in international ISO 8601 format. Time zone information
          is ignored.
        type: str
      posix:
        description:
        - Number of milliseconds that have elapsed since 00,00,00, 1 January 1970.
        type: int
      time:
        description:
        - Time in format HH,mm.
        type: str
    type: dict

name:
    description:
    - Object name.
    required: true
    type: str

tags:
    description:
    - Collection of tag identifiers.
    type: list

color:
    choices:
    - aquamarine
    - black
    - blue
    - crete blue
    - burlywood
    - cyan
    - dark green
    - khaki
    - orchid
    - dark orange
    - dark sea green
    - pink
    - turquoise
    - dark blue
    - firebrick
    - brown
    - forest green
    - gold
    - dark gold
    - gray
    - dark gray
    - light green
    - lemon chiffon
    - coral
    - sea green
    - sky blue
    - magenta
    - purple
    - slate blue
    - violet red
    - navy blue
    - olive
    - orange
    - red
    - sienna
    - yellow
    description:
    - Color of the object. Should be one of existing colors.
    type: str

start:
    description:
    - Starting time. Note, Each gateway may interpret this time differently according
      to its time zone.
    suboptions:
      date:
        description:
        - Date in format dd-MMM-yyyy.
        type: str
      iso_8601:
        description:
        - Date and time represented in international ISO 8601 format. Time zone information
          is ignored.
        type: str
      posix:
        description:
        - Number of milliseconds that have elapsed since 00,00,00, 1 January 1970.
        type: int
      time:
        description:
        - Time in format HH,mm.
        type: str
    type: dict

state:
    choices:
    - present
    - absent
    default: present
    description:
    - State of the access rule (present or absent).
    type: str

groups:
    description:
    - Collection of group identifiers.
    type: list

version:
    description:
    - Version of checkpoint. If not given one, the latest version taken.
    type: str

comments:
    description:
    - Comments string.
    type: str

end_never:
    description:
    - End never.
    type: bool

start_now:
    description:
    - Start immediately.
    type: bool

recurrence:
    description:
    - Days recurrence.
    suboptions:
      days:
        description:
        - Valid on specific days. Multiple options, support range of days in months. Example,["1","3","9-20"].
        type: list
      month:
        description:
        - Valid on month. Example, "1", "2","12","Any".
        type: str
      pattern:
        description:
        - Valid on "Daily", "Weekly", "Monthly" base.
        type: str
      weekdays:
        description:
        - Valid on weekdays. Example, "Sun", "Mon"..."Sat".
        type: list
    type: dict

hours_ranges:
    description:
    - Hours recurrence. Note, Each gateway may interpret this time differently according
      to its time zone.
    suboptions:
      enabled:
        description:
        - Is hour range enabled.
        type: bool
      from:
        description:
        - Time in format HH,MM.
        type: str
      index:
        description:
        - Hour range index.
        type: int
      to:
        description:
        - Time in format HH,MM.
        type: str
    type: list

details_level:
    choices:
    - uid
    - standard
    - full
    description:
    - 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.
    type: str

ignore_errors:
    description:
    - 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.
    type: bool

wait_for_task:
    default: true
    description:
    - Wait for the task to end. Such as publish task.
    type: bool

ignore_warnings:
    description:
    - Apply changes ignoring warnings.
    type: bool

auto_publish_session:
    default: false
    description:
    - Publish the current session if changes have been performed after task completes.
    type: bool

wait_for_task_timeout:
    default: 30
    description:
    - How many minutes to wait until throwing a timeout error.
    type: int

Outputs

cp_mgmt_time:
  description: The checkpoint object created or updated.
  returned: always, except when deleting the object.
  type: dict