check_point.mgmt.cp_mgmt_mds module – Manages mds objects on Checkpoint over Web Services API
Note
This module is part of the check_point.mgmt collection (version 5.2.3).
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_mds
.
New in check_point.mgmt 2.1.0
Synopsis
Manages mds objects on Checkpoint devices including creating, updating and removing objects.
All operations are performed over Web Services API.
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:
|
|
Hardware name. For example, Open server, Smart-1, Other. |
|
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:
|
|
IPv4 or IPv6 address. If both addresses are required use ipv4-address and ipv6-address fields explicitly. |
|
First IP address in the range. |
|
Last IP address in the range. |
|
IPv4 address. |
|
First IPv4 address in the range. |
|
Last IPv4 address in the range. |
|
IPv6 address. |
|
First IPv6 address in the range. |
|
Last IPv6 address in the range. |
|
Object name. |
|
Secure internal connection one time password. |
|
Operating system name. For example, Gaia, Linux, SecurePlatform. |
|
Type of the management server. Choices:
|
|
State of the access rule (present or absent). Choices:
|
|
Collection of tag identifiers. |
|
System version. |
|
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-mds
cp_mgmt_mds:
hardware: open server
ip_address: 1.1.1.1
ip_pool_first: 2.2.2.2
ip_pool_last: 3.3.3.3
name: mymds
os: gaia
server_type: multi-domain server
state: present
- name: set-mds
cp_mgmt_mds:
hardware: Smart-1
ip_address: 1.2.3.4
name: mymds
os: linux
state: present
- name: delete-mds
cp_mgmt_mds:
name: mymds
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. |