check_point.mgmt.cp_mgmt_set_domain (5.2.3) — module

Install collection

Install with ansible-galaxy collection install check_point.mgmt:==5.2.3

Add to requirements.yml

  collections:
    - name: check_point.mgmt
      version: 5.2.3

Description

Edit existing object using object name or uid.

All operations are performed over Web Services API.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: set-domain
  cp_mgmt_set_domain:
    comments: This is domain1 comment
    name: domain1

Inputs

    
name:
    description:
    - Object name.
    required: true
    type: str

tags:
    description:
    - 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.
    elements: str
    type: list

color:
    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
    description:
    - Color of the object. Should be one of existing colors.
    type: str

servers:
    description:
    - Domain servers. When this field is provided, 'set-domain' command is executed asynchronously.
    suboptions:
      add:
        description:
        - Adds to collection of values
        elements: dict
        suboptions:
          ip_address:
            description:
            - IPv4 or IPv6 address. If both addresses are required use ipv4-address and
              ipv6-address fields explicitly.
            type: str
          ipv4_address:
            description:
            - IPv4 address.
            type: str
          ipv6_address:
            description:
            - IPv6 address.
            type: str
          multi_domain_server:
            description:
            - Multi Domain server name or UID.
            type: str
          name:
            description:
            - Object name. Must be unique in the domain.
            type: str
          skip_start_domain_server:
            description:
            - Set this value to be true to prevent starting the new created domain.
            type: bool
          type:
            choices:
            - management server
            - log server
            - smc
            description:
            - Domain server type.
            type: str
        type: list
      remove:
        description:
        - Remove from collection of values
        elements: str
        suboptions:
          name:
            description:
            - Object name. Must be unique in the domain.
            type: str
        type: list
    type: dict

version:
    description:
    - Version of checkpoint. If not given one, the latest version taken.
    type: str

comments:
    description:
    - Comments string.
    type: str

details_level:
    choices:
    - uid
    - standard
    - full
    description:
    - 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.
    type: str

ignore_errors:
    description:
    - 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.
    type: bool

wait_for_task:
    default: true
    description:
    - Wait for the task to end. Such as publish task.
    type: bool

ignore_warnings:
    description:
    - Apply changes ignoring warnings.
    type: bool

auto_publish_session:
    default: false
    description:
    - Publish the current session if changes have been performed after task completes.
    type: bool

wait_for_task_timeout:
    default: 30
    description:
    - How many minutes to wait until throwing a timeout error.
    type: int

Outputs

cp_mgmt_domain:
  description: The checkpoint set-domain output.
  returned: always.
  type: dict