On this page
check_point.mgmt.cp_mgmt_service_icmp – Manages service-icmp objects on Check Point over Web Services API
Note
This plugin is part of the check_point.mgmt collection (version 2.1.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_service_icmp.
New in version 2.9: of check_point.mgmt
Synopsis
- Manages service-icmp objects on Check Point devices including creating, updating and removing objects.
 - All operations are performed over Web Services API.
 
Parameters
| Parameter | Choices/Defaults | Comments | 
|---|---|---|
| auto_publish_session
        
        boolean
         | 
      
       
  | 
      
        
        Publish the current session if changes have been performed after task completes.
         | 
     
| color
        
        string
         | 
      
       
  | 
      
        
        Color of the object. Should be one of existing colors.
         | 
     
| comments
        
        string
         | 
      
        
        Comments string.
         | 
     |
| details_level
        
        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.
         | 
     
| groups
        
        list / elements=string
         | 
      
        
        Collection of group identifiers.
         | 
     |
| icmp_code
        
        integer
         | 
      
        
        As listed in, <a href="http,//www.iana.org/assignments/icmp-parameters" target="_blank">RFC 792</a>.
         | 
     |
| icmp_type
        
        integer
         | 
      
        
        As listed in, <a href="http,//www.iana.org/assignments/icmp-parameters" target="_blank">RFC 792</a>.
         | 
     |
| ignore_errors
        
        boolean
         | 
      
       
  | 
      
        
        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
        
        boolean
         | 
      
       
  | 
      
        
        Apply changes ignoring warnings.
         | 
     
| keep_connections_open_after_policy_installation
        
        boolean
         | 
      
       
  | 
      
        
        Keep connections open after policy has been installed even if they are not allowed under the new policy. This overrides the settings in the Connection Persistence page. If you change this property, the change will not affect open connections, but only future connections.
         | 
     
| name
        
        string / required
         | 
      
        
        Object name.
         | 
     |
| state
        
        string
         | 
      
       
  | 
      
        
        State of the access rule (present or absent). Defaults to present.
         | 
     
| tags
        
        list / elements=string
         | 
      
        
        Collection of tag identifiers.
         | 
     |
| 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.
         | 
     
| wait_for_task_timeout
        
        integer
         | 
      Default: 
        30
         | 
      
        
        How many minutes to wait until throwing a timeout error.
         | 
     
Examples
- name: add-service-icmp
  cp_mgmt_service_icmp:
    icmp_code: 7
    icmp_type: 5
    name: Icmp1
    state: present
- name: set-service-icmp
  cp_mgmt_service_icmp:
    icmp_code: 13
    icmp_type: 45
    name: icmp1
    state: present
- name: delete-service-icmp
  cp_mgmt_service_icmp:
    name: icmp3
    state: absent
  Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | 
|---|---|---|
| cp_mgmt_service_icmp
        
        dictionary
         | 
      always, except when deleting the object. | 
        
        The checkpoint object created or updated.
          | 
     
Authors
- Or Soffer (@chkp-orso)
 
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
 https://docs.ansible.com/ansible/latest/collections/check_point/mgmt/cp_mgmt_service_icmp_module.html