Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
chkp-orso authored Nov 13, 2019
1 parent 7fd1e1d commit 804a32a
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Check Point Ansible Mgmt Collection
This Ansible collection provides control over a Check Point management server using
This Ansible collection provides control over a Check Point Management server using
Check Point's web-services APIs.

The Ansible Check Point modules reference can be found here:
https://docs.ansible.com/ansible/latest/modules/list_of_network_modules.html#check-point
<br>Note - look only at the `cp_mgmt_*` modules, cause the `checkpoint_*` will be depricated.
<br>Note - look only at the `cp_mgmt_*` modules, cause the `checkpoint_*` will be deprecated.

Installation instructions
-------------------------
Expand All @@ -14,12 +14,12 @@ Requirements
------------
* Ansible 2.9+ is required.
* The Check Point server should be using the versions detailed in this SK: https://supportcenter.checkpoint.com/supportcenter/portal?eventSubmit_doGoviewsolutiondetails=&solutionid=sk114661
* The Check Point server should be open for API communication from the ansible server.
Open SmartConsole ans check "Manage & Settings > Blades > Management API > Advanced settings".
* The Check Point server should be open for API communication from the Ansible server.
Open SmartConsole and check "Manage & Settings > Blades > Management API > Advanced settings".

Usage
-----
1. Edit the `hosts` so that it would contain a section similar to this one:
1. Edit the `hosts` so that it will contain a section similar to this one:
```
[check_point]
%YOUR_IP%
Expand Down Expand Up @@ -62,18 +62,18 @@ Note - If you want to run against Ansible version 2.9 instead of the collection,

### Notes:
1. Because this Ansible module is controlling the management server remotely via the web API,
the ansible server needs to have access to the Check Point API server.
the Ansible server needs to have access to the Check Point API server.
Open `SmartConsole`, navigate to "Manage & Settings > Blades > Management API > Advanced settings"
and check the API server's accessibility set
2. Ansible has a feature called "Check Mode" that enables you to test the
changes without actually changing anything.
3. The login and logout happens automatically.
4. If you want to login to specific domain, in the playbook above in the `vars`secion insert the domain name to
4. If you want to login to a specific domain, in the playbook above in the `vars`secion change the domain name to
`ansible_checkpoint_domain`
5. There are two ways to publish changes:
a. Set the `auto_publish_session` to `true` as displayed in the example playbook above.
This option will publish only the task which this parameter belongs to.
b. Add the task to publish with the `cp_mgmt_publish` module.
b. Add the task to publish to the `cp_mgmt_publish` module.
This option will publish all the tasks above this task.
6. It is recommended by Check Point to use this collection over the modules of Ansible version 2.9
7. If you still want to use Ansible version 2.9 instead of this collection (not recommended):
Expand Down

0 comments on commit 804a32a

Please sign in to comment.