check_point.mgmt.cp_mgmt_mds module – Manages mds objects on Checkpoint over Web Services API

Note

This module is part of the check_point.mgmt collection (version 2.3.0).

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

New in version 2.9: of check_point.mgmt

Synopsis

  • Manages mds objects on Checkpoint devices including creating, updating and removing objects.

  • All operations are performed over Web Services API.

Parameters

Parameter

Comments

auto_publish_session

boolean

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

Choices:

  • no

  • yes

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

hardware

string

Hardware name. For example, Open server, Smart-1, Other.

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:

  • no

  • yes

ignore_warnings

boolean

Apply changes ignoring warnings.

Choices:

  • no

  • yes

ip_address

string

IPv4 or IPv6 address. If both addresses are required use ipv4-address and ipv6-address fields explicitly.

ip_pool_first

string

First IP address in the range.

ip_pool_last

string

Last IP address in the range.

ipv4_address

string

IPv4 address.

ipv4_pool_first

string

First IPv4 address in the range.

ipv4_pool_last

string

Last IPv4 address in the range.

ipv6_address

string

IPv6 address.

ipv6_pool_first

string

First IPv6 address in the range.

ipv6_pool_last

string

Last IPv6 address in the range.

name

string / required

Object name.

one_time_password

string

Secure internal connection one time password.

os

string

Operating system name. For example, Gaia, Linux, SecurePlatform.

server_type

string

Type of the management server.

Choices:

  • multi-domain server

  • multi-domain log server

state

string

State of the access rule (present or absent). Defaults to present.

Choices:

  • present ← (default)

  • absent

tags

list / elements=string

Collection of tag identifiers.

version

string

System version.

wait_for_task

boolean

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

Choices:

  • no

  • yes ← (default)

wait_for_task_timeout

integer

How many minutes to wait until throwing a timeout error.

Default: 30

Examples

- name: add-mds
  cp_mgmt_mds:
    hardware: open server
    ip_address: 1.1.1.1
    ip_pool_first: 2.2.2.2
    ip_pool_last: 3.3.3.3
    name: mymds
    os: gaia
    server_type: multi-domain server
    state: present

- name: set-mds
  cp_mgmt_mds:
    hardware: Smart-1
    ip_address: 1.2.3.4
    name: mymds
    os: linux
    state: present

- name: delete-mds
  cp_mgmt_mds:
    name: mymds
    state: absent

Return Values

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

Key

Description

cp_mgmt_mds

dictionary

The checkpoint object created or updated.

Returned: always, except when deleting the object.

Authors

  • Or Soffer (@chkp-orso)