W3cubDocs

/Ansible

check_point.mgmt.cp_mgmt_set_global_domain module – Edit Global domain object using domain name or UID.

Note

This module is part of the check_point.mgmt collection (version 6.4.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_global_domain.

New in check_point.mgmt 5.0.0

Synopsis

  • Edit Global domain object using domain name or UID. When the list of Multi Domain Server is edited, the command is handled asynchronously. A list of task identifiers is returned to a user. In this case, the changes to the Global domain object are done in a public session and so should not be published. If the domain is changed in other parameters than the Multi Domain Servers, i.e. comments, color or tags, such changes are done in the user’s private session and therefore should be published. In this case, the returned command output is similar to the one of ‘show-global-domain’.
  • All operations are performed over Web Services API.
  • Available from R80 management version.

Parameters

Parameter

Comments

auto_publish_session

boolean

Publish the current session if changes have been performed after task completes.

Choices:

  • false ← (default)
  • true

color

string

Color of the object. Should be one of existing colors.

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"

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.

Choices:

  • "uid"
  • "standard"
  • "full"

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.

Choices:

  • false
  • true

ignore_warnings

boolean

Apply changes ignoring warnings.

Choices:

  • false
  • true

name

string

Object name.

servers

dictionary

Multi Domain Servers. When the field is provided, ‘set-global-domain’ command is executed asynchronously.

add

list / elements=string

Adds to collection of values

remove

list / elements=string

Removes from collection of values

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-global-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

Wait for the task to end. Such as publish task.

Choices:

  • false
  • true ← (default)

wait_for_task_timeout

integer

How many minutes to wait until throwing a timeout error.

Default: 30

Examples

- name: set-global-domain
  cp_mgmt_set_global_domain:
    name: Global
    tags:
      - tag1
    comments: "This is a Global domain"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

cp_mgmt_set_global_domain

dictionary

The checkpoint set-global-domain output.

Returned: always.

Authors

  • Eden Brillant (@chkp-edenbr)

© 2012–2018 Michael DeHaan
© 2018–2025 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_global_domain_module.html