cp_mgmt_mds
Manages mds objects on Checkpoint over Web Services API through native controller HTTPAPI with owned sessions
Collection: check_point.mgmt
Full Name: check_point.mgmt.cp_mgmt_mds
Controller module — runs on the local controller, not on remote hosts.
Synopsis
Manages mds objects on Checkpoint over Web Services API through native controller HTTPAPI with owned sessions
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| auto_publish_session | bool | false | Publish this owned session explicitly after the operation; default false. | |
| color | str | Color of the object. Should be one of existing colors. | ||
| comments | str | Comments string. | ||
| details_level | str | 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. | ||
| hardware | str | Hardware name. For example, Open server, Smart-1, Other. | ||
| ignore_errors | bool | 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 | bool | Apply changes ignoring warnings. | ||
| ip_address | str | IPv4 or IPv6 address. If both addresses are required use ipv4-address and ipv6-address fields explicitly. | ||
| ip_pool_first | str | First IP address in the range. | ||
| ip_pool_last | str | Last IP address in the range. | ||
| ipv4_address | str | IPv4 address. | ||
| ipv4_pool_first | str | First IPv4 address in the range. | ||
| ipv4_pool_last | str | Last IPv4 address in the range. | ||
| ipv6_address | str | IPv6 address. | ||
| ipv6_pool_first | str | First IPv6 address in the range. | ||
| ipv6_pool_last | str | Last IPv6 address in the range. | ||
| name | str | yes | Object name. | |
| one_time_password | str | Secure internal connection one time password. | ||
| os | str | Operating system name. For example, Gaia, Linux, SecurePlatform. | ||
| server_type | str | Type of the management server. | ||
| state | str | present | Desired object presence. | |
| tags | list | Collection of tag identifiers. | ||
| version | str | System version. | ||
| wait_for_task | bool | true | Wait for returned asynchronous task identifiers; default true. | |
| wait_for_task_timeout | int | 30 | Polling deadline in minutes; default 30, negative values use 30, maximum 1440. |
Example
yaml
- name: add-mds
check_point.mgmt.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
check_point.mgmt.cp_mgmt_mds:
hardware: Smart-1
ip_address: 1.2.3.4
name: mymds
os: linux
state: present
- name: delete-mds
check_point.mgmt.cp_mgmt_mds:
name: mymds
state: absent