> Source: [sk114661](https://support.checkpoint.com/results/sk/sk114661)

# sk114661 - How to automate your management server using "Ansible

| Property | Value |
|----------|-------|
| Solution ID | sk114661 |
| Date Created | 2016-11-24 |
| Last Modified | 2025-12-01 |
| Technical Level | General |
| Products | Security Management Server |
| Versions | R82.10, R82, R81.20, R81.10 (EOS), R81 (EOS) |

## Solution

This article describes how to automate your management server using "Ansible".

**Ansible** ([www.ansible.com](http://www.ansible.com)) is a popular automation tool.

The "Ansible Check Point Management" module lets you automate Check Point management tasks (e.g. add objects, manipulate the Rule Base, install policy) into the Ansible automation platform.

### Description

Provide Ansible "playbooks" with simple access to Check Point Management APIs.

The ansible module is written in Python and its source code is available. You are welcome to review code, suggest enhancements or modify it by opening a issue or send a pull request to:  
<https://github.com/CheckPointSW/CheckPointAnsibleMgmtCollection>

### Instructions

To enable the integration, install the necessary Hotfix, based on your Management Server version:

|---------------------------|----------------------------------------------------|
| Management Server Version | Hotfix information                                 |
| R80.40 and higher         | Integrated. No Jumbo Hotfix installation required. |
| R80.30                    | Available from R80.30 Jumbo Hotfix Take 135        |
| R80.20                    | Available from R80.20 Jumbo Hotfix Take 134        |
| R80.10                    | Available from R80.10 Jumbo Hotfix Take 270        |

### Usage

We recommend that you download the latest Check Point management collection from Ansible Galaxy, available here: <https://galaxy.ansible.com/check_point/mgmt>  

The Ansible inventory (for example, /etc/ansible/hosts needs to contain a section similar to this:  
**Note** - The example uses the collection from Ansible Galaxy.

|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `[checkpoint] ` ` # Check Point Security Management server's IP address ` `172.27.254.10` `[checkpoint:vars] ` `# If the Gaia web portal on your Security Management server is not setup with proper CA certificates that can be verified from the Ansible server, then it is necessary to disable validation of these certificates by using the ansible_httpapi_validate_certs. To do this you need to set ansible_httpapi_validate_certs=False in your inventory.`` ` `ansible_httpapi_validate_certs=False` `ansible_httpapi_use_ssl=True ` `ansible_network_os=check_point.mgmt.checkpoint` `ansible_user=[Check Point admin username] ` `ansible_password=[Check Point admin password]` |

**for Smart-1 Cloud**: you have to use API key instead of username and password:

|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ``` [checkpoint]� mytest-tenant.maas.checkpoint.com ``` ``` [checkpoint:vars]� ansible_httpapi_validate_certs=False ansible_httpapi_use_ssl=True� ansible_network_os=check_point.mgmt.checkpoint ansible_api_key=[Check Point api user from your management]� ansible_cloud_mgmt_id=[please see note below] # ansible_cloud_mgmt_id is shown in your SMART-1 Cloud tenant: settings > General ``` |

<br />

<br />

The playbook should use "connection httpapi"

|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| --- hosts: 172.27.254.10 **connection: httpapi** # Add or delete host object in Check Point management server - name: add-host or delete-host check_point.mgmt.cp_mgmt_host: color: red name: My test host ip_address: 192.168.1.1 |

<br />

For more information on the community supported Check Point network modules in Ansible, refer to <https://docs.ansible.com/ansible/latest/collections/check_point/mgmt/index.html#plugins-in-check-point-mgmt>

### Latest version of Check Point management collection for Ansible and examples

For more information and installation instructions, refer to the Read Me under: <https://galaxy.ansible.com/check_point/mgmt>.  
The source code an be found in Check Points official GitHub account: <https://github.com/CheckPointSW/CheckPointAnsibleMgmtCollection>  

Use case example in a playbook can be found in Check Points community GitHub account: <https://github.com/CheckPointSW-Community/AnsibleFest2020-Demos>  

<br />

### Limitations

* Sensitive fields, such as vpn-community shared-secret, or lsm-gateway sic, cannot be updated via Ansible.

<br />

<br />

<br />

<br />

---

# Agent Instructions

This content is from the Check Point Support Center (https://support.checkpoint.com), the official knowledge base for Check Point cybersecurity products.

## Navigating This Knowledge Base

- **Complete index**: [llms.txt](https://support.checkpoint.com/llms.txt)
- **All SK articles**: [SecureKnowledge Sitemap](https://support.checkpoint.com/sitemaps/secureknowledge-sitemap-index.xml)
- **SK article URL pattern**: `https://support.checkpoint.com/results/sk/{skId}`
- **Markdown responses**: AI bot User-Agents automatically receive `text/markdown` content