Docs4dev
Docs
ansible / latest / collections / check_point / mgmt / cp_mgmt_set_domain_module.html

check_point.mgmt.cp_mgmt_set_domain – Edit existing object using object name or uid.

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_set_domain.

New in version 2.9: of check_point.mgmt

Synopsis

  • Edit existing object using object name or uid.
  • All operations are performed over Web Services API.

Parameters

Parameter Choices/Defaults Comments
color
string
    Choices:
  • aquamarine
  • black
  • blue
  • crete blue
  • burlywood
  • cyan
  • dark green
  • khaki
  • orchid
  • dark orange
  • dark sea green
  • pink
  • turquoise
  • dark blue
  • firebrick
  • brown
  • forest green
  • gold
  • dark gold
  • gray
  • dark gray
  • light green
  • lemon chiffon
  • coral
  • sea green
  • sky blue
  • magenta
  • purple
  • slate blue
  • violet red
  • navy blue
  • olive
  • orange
  • red
  • sienna
  • yellow
Color of the object. Should be one of existing colors.
comments
string
Comments string.
details_level
string
    Choices:
  • uid
  • standard
  • full
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
    Choices:
  • no
  • yes
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
    Choices:
  • no
  • yes
Apply changes ignoring warnings.
name
string / required
Object name.
servers
dictionary
Domain servers. When this field is provided, 'set-domain' command is executed asynchronously.
add
list / elements=string
Adds to collection of values
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
    Choices:
  • no
  • yes
Set this value to be true to prevent starting the new created domain.
type
string
    Choices:
  • management server
  • log server
  • smc
Domain server type.
remove
list / elements=string
Remove from collection of values
name
string
Object name. Must be unique in the domain.
tags
list / elements=string
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
string
Version of checkpoint. If not given one, the latest version taken.
wait_for_task
boolean
    Choices:
  • no
  • yes ←
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.

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 Returned Description
cp_mgmt_domain
dictionary
always.
The checkpoint set-domain output.



Authors

  • Or Soffer (@chkp-orso)

© 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_set_domain_module.html