Note
This plugin is part of the check_point.mgmt collection (version 2.1.1).
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_add_domain
.
New in version 2.9: of check_point.mgmt
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
color string |
| Color of the object. Should be one of existing colors. | |
comments string | Comments string. | ||
details_level 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. | |
ignore_errors boolean |
| 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 boolean |
| Apply changes ignoring warnings. | |
name string / required | Object name. | ||
servers list / elements=string | Domain servers. When this field is provided, 'set-domain' command is executed asynchronously. | ||
active boolean |
| Activate domain server. Only one domain server is allowed to be active | |
ip_address string | IPv4 or IPv6 address. If both addresses are required use ipv4-address and ipv6-address fields explicitly. | ||
ipv4_address string | IPv4 address. | ||
ipv6_address string | IPv6 address. | ||
multi_domain_server string | Multi Domain server name or UID. | ||
name string | Object name. Must be unique in the domain. | ||
skip_start_domain_server boolean |
| Set this value to be true to prevent starting the new created domain. | |
type string |
| Domain server type. | |
version string | Version of checkpoint. If not given one, the latest version taken. | ||
wait_for_task boolean |
| Wait for the task to end. Such as publish task. | |
wait_for_task_timeout integer | Default: 30 | How many minutes to wait until throwing a timeout error. |
- name: add-domain cp_mgmt_add_domain: name: domain1 servers: ip_address: 192.0.2.1 multi_domain_server: MDM_Server name: domain1_ManagementServer_1
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
cp_mgmt_domain dictionary | always. | The checkpoint add-domain output. |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/check_point/mgmt/cp_mgmt_add_domain_module.html