check_point.mgmt.cp_mgmt_set_domain module – Edit existing object using object name or uid.
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_set_domain
.
New in check_point.mgmt 2.1.0
Synopsis
Edit existing object using object name or uid.
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:
|
|
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:
|
|
Object name. |
|
Domain servers. When this field is provided, ‘set-domain’ command is executed asynchronously. |
|
Adds to collection of values |
|
IPv4 or IPv6 address. If both addresses are required use ipv4-address and ipv6-address fields explicitly. |
|
IPv4 address. |
|
IPv6 address. |
|
Multi Domain server name or UID. |
|
Object name. Must be unique in the domain. |
|
Set this value to be true to prevent starting the new created domain. Choices:
|
|
Domain server type. Choices:
|
|
Remove from collection of values |
|
Object name. Must be unique in the domain. |
|
Collection of tag identifiers. Note, The list of tags can not be modified in a single command together with the domain servers. To modify tags, please use the separate ‘set-domain’ command, without providing the list of domain servers. |
|
Version of checkpoint. If not given one, the latest version taken. |
|
Wait for the task to end. Such as publish task. Choices:
|
|
How many minutes to wait until throwing a timeout error. Default: |
Examples
- name: set-domain
cp_mgmt_set_domain:
comments: This is domain1 comment
name: domain1
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The checkpoint set-domain output. Returned: always. |