Add lsm modules

Author: chkp-shirango

plugins/modules/cp_mgmt_lsm_cluster.py

@@ -0,0 +1,282 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+#
+# Ansible module to manage CheckPoint Firewall (c) 2019
+#
+# Ansible is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ansible is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+from __future__ import (absolute_import, division, print_function)
+
+__metaclass__ = type
+
+ANSIBLE_METADATA = {'metadata_version': '1.1',
+                    'status': ['preview'],
+                    'supported_by': 'community'}
+
+DOCUMENTATION = """
+---
+module: cp_mgmt_lsm_cluster
+short_description: Manages lsm-cluster objects on Checkpoint over Web Services API
+description:
+  - Manages lsm-cluster objects on Checkpoint devices including creating, updating and removing objects.
+  - All operations are performed over Web Services API.
+version_added: "2.9"
+author: "Shiran Golzar (@chkp-shirango)"
+options:
+  main_ip_address:
+    description:
+      - Main IP address.
+    type: str
+  name_prefix:
+    description:
+      - A prefix added to the profile name and creates the LSM cluster name.
+    type: str
+  name_suffix:
+    description:
+      - A suffix added to the profile name and creates the LSM cluster name.
+    type: str
+  security_profile:
+    description:
+      - LSM profile.
+    type: str
+  interfaces:
+    description:
+      - Interfaces.
+    type: list
+    suboptions:
+      name:
+        description:
+          - Interface name.
+        type: str
+      ip_address_override:
+        description:
+          - IP address override. Net mask is defined by the attached LSM profile.
+        type: str
+      member_network_override:
+        description:
+          - Member network override. Net mask is defined by the attached LSM profile.
+        type: str
+  members:
+    description:
+      - Members.
+    type: list
+    suboptions:
+      name:
+        description:
+          - Object name.
+        type: str
+      provisioning_settings:
+        description:
+          - Provisioning settings. This field is relevant just for SMB clusters.
+        type: dict
+        suboptions:
+          provisioning_profile:
+            description:
+              - Provisioning profile.
+            type: str
+      provisioning_state:
+        description:
+          - Provisioning state. This field is relevant just for SMB clusters. By default the state is 'manual'- enable provisioning but not attach
+            to profile.If 'using-profile' state is provided a provisioning profile must be provided in provisioning-settings.
+        type: str
+        choices: ['off', 'manual', 'using-profile']
+      sic:
+        description:
+          - Secure Internal Communication.
+        type: dict
+        suboptions:
+          ip_address:
+            description:
+              - IP address. When IP address is provided- initiate trusted communication immediately using this IP address.
+            type: str
+          one_time_password:
+            description:
+              - One-time password. When one-time password is provided without ip-address- trusted communication is
+                automatically initiated when the gateway connects to the Security Management server for the first time.
+            type: str
+      tags:
+        description:
+          - Collection of tag identifiers.
+        type: list
+      color:
+        description:
+          - Color of the object. Should be one of existing colors.
+        type: str
+        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:
+        description:
+          - Comments string.
+        type: str
+  color:
+    description:
+      - Color of the object. Should be one of existing colors.
+    type: str
+    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:
+    description:
+      - Comments string.
+    type: str
+  details_level:
+    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
+    choices: ['uid', 'standard', 'full']
+  ignore_warnings:
+    description:
+      - Apply changes ignoring warnings.
+    type: bool
+  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
+extends_documentation_fragment: check_point.mgmt.checkpoint_objects
+"""
+
+EXAMPLES = """
+- name: add-lsm-cluster
+  cp_mgmt_lsm_cluster:
+    interfaces:
+    - ip_address_override: 192.168.8.197
+      member_network_override: 192.168.8.0
+      name: eth0
+      new_name: WAN
+    - ip_address_override: 10.8.197.1
+      member_network_override: 10.8.197.0
+      name: eth1
+      new_name: LAN1
+    - member_network_override: 10.10.10.0
+      name: eth2
+    main_ip_address: 192.168.8.197
+    members:
+    - name: Gaia_gw1
+      sic:
+        ip_address: 192.168.8.200
+        one_time_password: aaaa
+    - name: Gaia_gw2
+      sic:
+        ip_address: 192.168.8.202
+        one_time_password: aaaa
+    name_prefix: Gaia_
+    security_profile: gaia_cluster
+    state: present
+
+- name: set-lsm-cluster
+  cp_mgmt_lsm_cluster:
+    interfaces:
+    - ip_address_override: 192.168.8.197
+      member_network_override: 192.168.8.0
+      name: eth0
+      new_name: WAN
+    - ip_address_override: 10.8.197.1
+      member_network_override: 10.8.197.0
+      name: eth1
+      new_name: LAN1
+    - member_network_override: 10.10.10.0
+      name: eth2
+    members:
+    - name: Gaia_gw1
+      sic:
+        ip_address: 192.168.8.200
+        one_time_password: aaaa
+    - name: Gaia_gw2
+      sic:
+        ip_address: 192.168.8.202
+        one_time_password: aaaa
+    name: Gaia_gaia_cluster
+    state: present
+
+- name: delete-lsm-cluster
+  cp_mgmt_lsm_cluster:
+    name: lsm_cluster
+    state: absent
+"""
+
+RETURN = """
+cp_mgmt_lsm_cluster:
+  description: The checkpoint object created or updated.
+  returned: always, except when deleting the object.
+  type: dict
+"""
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.check_point.mgmt.plugins.module_utils.checkpoint import checkpoint_argument_spec_for_objects, api_call
+
+
+def main():
+    argument_spec = dict(
+        main_ip_address=dict(type='str'),
+        name_prefix=dict(type='str'),
+        name_suffix=dict(type='str'),
+        security_profile=dict(type='str', required=True),
+        interfaces=dict(type='list', options=dict(
+            name=dict(type='str'),
+            ip_address_override=dict(type='str'),
+            member_network_override=dict(type='str')
+        )),
+        members=dict(type='list', options=dict(
+            name=dict(type='str'),
+            provisioning_settings=dict(type='dict', options=dict(
+                provisioning_profile=dict(type='str')
+            )),
+            provisioning_state=dict(type='str', choices=['off', 'manual', 'using-profile']),
+            sic=dict(type='dict', options=dict(
+                ip_address=dict(type='str'),
+                one_time_password=dict(type='str')
+            )),
+            tags=dict(type='list'),
+            color=dict(type='str', 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=dict(type='str')
+        )),
+        color=dict(type='str', 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=dict(type='str'),
+        details_level=dict(type='str', choices=['uid', 'standard', 'full']),
+        ignore_warnings=dict(type='bool'),
+        ignore_errors=dict(type='bool'),
+    )
+    argument_spec.update(checkpoint_argument_spec_for_objects)
+
+    module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True)
+
+    # Create lsm-cluster name
+    name = module.params['security_profile']
+
+    if module.params['name_prefix']:
+        name = module.params['name_prefix'] + name
+    if module.params['name_suffix']:
+        name = name + module.params['name_suffix']
+    module.params['name'] = name
+
+    api_call_object = 'lsm-cluster'
+
+    result = api_call(module, api_call_object)
+    module.exit_json(**result)
+
+
+if __name__ == '__main__':
+    main()