W3cubDocs

/Ansible

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

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_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 Choices/Defaults Comments
auto_publish_session
boolean
    Choices:
  • no
  • yes
Publish the current session if changes have been performed after task completes.
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.
hardware
string
Hardware name. For example, Open server, Smart-1, Other.
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.
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
    Choices:
  • multi-domain server
  • multi-domain log server
Type of the management server.
state
string
    Choices:
  • present ←
  • absent
State of the access rule (present or absent). Defaults to present.
tags
list / elements=string
Collection of tag identifiers.
version
string
System version.
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: 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 Returned Description
cp_mgmt_mds
dictionary
always, except when deleting the object.
The checkpoint object created or updated.


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_mds_module.html