cp_mgmt_address_range
Manages address-range objects on Check Point over Web Services API through native controller HTTPAPI with owned sessions
Collection: check_point.mgmt
Full Name: check_point.mgmt.cp_mgmt_address_range
Controller module — runs on the local controller, not on remote hosts.
Synopsis
Manages address-range objects on Check Point 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. | ||
| groups | list | Collection of group identifiers. | ||
| 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_first | str | First IP address in the range. If both IPv4 and IPv6 address ranges are required, use the ipv4-address-first and the ipv6-address-first fields instead. | ||
| ip_address_last | str | Last IP address in the range. If both IPv4 and IPv6 address ranges are required, use the ipv4-address-first and the ipv6-address-first fields instead. | ||
| ipv4_address_first | str | First IPv4 address in the range. | ||
| ipv4_address_last | str | Last IPv4 address in the range. | ||
| ipv6_address_first | str | First IPv6 address in the range. | ||
| ipv6_address_last | str | Last IPv6 address in the range. | ||
| name | str | yes | Object name. | |
| nat_settings | dict | NAT settings. | ||
| state | str | present | Desired object presence. | |
| tags | list | Collection of tag identifiers. | ||
| version | str | Management API version path; omitted uses the default API 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-address-range
check_point.mgmt.cp_mgmt_address_range:
ip_address_first: 192.0.2.1
ip_address_last: 192.0.2.10
name: New Address Range 1
state: present
- name: set-address-range
check_point.mgmt.cp_mgmt_address_range:
color: dark green
ip_address_first: 192.0.2.1
ip_address_last: 192.0.2.1
name: New Address Range 1
state: present
- name: delete-address-range
check_point.mgmt.cp_mgmt_address_range:
name: New Address Range 2
state: absent