cp_mgmt_set_domain
Edit existing object using object name or uid through native controller HTTPAPI with owned sessions
Collection: check_point.mgmt
Full Name: check_point.mgmt.cp_mgmt_set_domain
Controller module — runs on the local controller, not on remote hosts.
Synopsis
Edit existing object using object name or uid 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. | ||
| 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. | ||
| name | str | yes | Object name. | |
| servers | dict | Domain servers. When this field is provided, ‘set-domain’ command is executed asynchronously. | ||
| tags | list | 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 | 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: set-domain
check_point.mgmt.cp_mgmt_set_domain:
comments: This is domain1 comment
name: domain1