Updated modules batch 3

Author: chkp-edenbr

plugins/httpapi/checkpoint.py

@@ -7,13 +7,13 @@
 
 DOCUMENTATION = """
 ---
-author: Ansible Networking Team
-httpapi : checkpoint
+author: Ansible Networking Team (@rcarrillocruz)
+name: checkpoint
 short_description: HttpApi Plugin for Checkpoint devices
 description:
   - This HttpApi plugin provides methods to connect to Checkpoint
     devices over a HTTP(S)-based api.
-version_added: "2.8"
+version_added: "2.8.0"
 options:
   domain:
     type: str

plugins/module_utils/checkpoint.py

@@ -60,6 +60,11 @@
 
 delete_params = ['name', 'uid', 'layer', 'exception-group-name', 'rule-name', 'package']
 
+remove_from_set_payload = {'lsm-cluster': ['security-profile', 'name-prefix', 'name-suffix', 'main-ip-address'],
+                           'md-permissions-profile': ['permission-level']}
+
+remove_from_add_payload = {'lsm-cluster': ['name']}
+
 
 # parse failure message with code and response
 def parse_fail_message(code, response):
@@ -84,6 +89,14 @@ def is_checkpoint_param(parameter):
     return True
 
 
+def contains_show_identifier_param(payload):
+    identifier_params = ["name", "uid", "assigned-domain"]
+    for param in identifier_params:
+        if payload.get(param) is not None:
+            return True
+    return False
+
+
 # build the payload from the parameters which has value (not None), and they are parameter of checkpoint API as well
 def get_payload_from_parameters(params):
     payload = {}
@@ -210,7 +223,7 @@ def discard_and_fail(module, code, response, connection, version):
 
 # handle publish command, and wait for it to end if the user asked so
 def handle_publish(module, connection, version):
-    if module.params['auto_publish_session']:
+    if 'auto_publish_session' in module.params and module.params['auto_publish_session']:
         publish_code, publish_response = send_request(connection, version, 'publish')
         if publish_code != 200:
             discard_and_fail(module, publish_code, publish_response, connection, version)
@@ -275,6 +288,8 @@ def api_command(module, command):
                 del response['tasks']
 
         result[command] = response
+
+        handle_publish(module, connection, version)
     else:
         discard_and_fail(module, code, response, connection, version)
 
@@ -287,8 +302,8 @@ def api_call_facts(module, api_call_object, api_call_object_plural_version):
     connection = Connection(module._socket_path)
     version = get_version(module)
 
-    # if there is neither name nor uid, the API command will be in plural version (e.g. show-hosts instead of show-host)
-    if payload.get("name") is None and payload.get("uid") is None:
+    # if there isn't an identifier param, the API command will be in plural version (e.g. show-hosts instead of show-host)
+    if not contains_show_identifier_param(payload):
         api_call_object = api_call_object_plural_version
 
     response = handle_call(connection, version, 'show-' + api_call_object, payload, module, False, False)
@@ -331,12 +346,10 @@ def api_call(module, api_call_object):
         if equals_code == 200:
             # else objects are equals and there is no need for set request
             if not equals_response['equals']:
-                if 'lsm-cluster' == api_call_object:
-                    build_lsm_cluster_payload(payload, 'set')
+                build_payload(api_call_object, payload, remove_from_set_payload)
                 handle_call_and_set_result(connection, version, 'set-' + api_call_object, payload, module, result)
         elif equals_code == 404:
-            if 'lsm-cluster' == api_call_object:
-                build_lsm_cluster_payload(payload, 'add')
+            build_payload(api_call_object, payload, remove_from_add_payload)
             handle_call_and_set_result(connection, version, 'add-' + api_call_object, payload, module, result)
     elif module.params['state'] == 'absent':
         handle_delete(equals_code, payload, delete_params, connection, version, api_call_object, module, result)
@@ -406,17 +419,6 @@ def build_rulebase_payload(api_call_object, payload, position_number):
     return rulebase_payload
 
 
-def build_lsm_cluster_payload(payload, operator):
-    fields = ['security-profile', 'name-prefix', 'name-suffix', 'main-ip-address']
-    if operator == 'add':
-        del payload['name']
-    else:
-        for field in fields:
-            if field in payload.keys():
-                del payload[field]
-    return payload
-
-
 def build_rulebase_command(api_call_object):
     rulebase_command = 'show-' + api_call_object.split('-')[0] + '-rulebase'
 
@@ -426,6 +428,14 @@ def build_rulebase_command(api_call_object):
     return rulebase_command
 
 
+# remove from payload unrecognized params (used for cases where add payload differs from that of a set)
+def build_payload(api_call_object, payload, params_to_remove):
+    if api_call_object in params_to_remove:
+        for param in params_to_remove[api_call_object]:
+            del payload[param]
+    return payload
+
+
 # extract rule from rulebase response
 def extract_rule_from_rulebase_response(response):
     rule = response['rulebase'][0]

plugins/modules/cp_mgmt_show_software_package_details.py

@@ -32,7 +32,7 @@
 description:
   - Gets the software package information from the cloud.
   - All operations are performed over Web Services API.
-version_added: "2.9"
+version_added: "2.0.0"
 author: "Or Soffer (@chkp-orso)"
 options:
   name:

plugins/modules/cp_mgmt_show_task.py

@@ -32,13 +32,14 @@
 description:
   - Show task progress and details.
   - All operations are performed over Web Services API.
-version_added: "2.9"
+version_added: "2.0.0"
 author: "Or Soffer (@chkp-orso)"
 options:
   task_id:
     description:
       - Unique identifier of one or more tasks.
     type: list
+    elements: 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
@@ -67,7 +68,7 @@
 
 def main():
     argument_spec = dict(
-        task_id=dict(type='list'),
+        task_id=dict(type='list', elements='str'),
         details_level=dict(type='str', choices=['uid', 'standard', 'full'])
     )
     argument_spec.update(checkpoint_argument_spec_for_commands)

plugins/modules/cp_mgmt_show_tasks.py

@@ -32,7 +32,7 @@
 description:
   - Retrieve all tasks and show their progress and details.
   - All operations are performed over Web Services API.
-version_added: "2.9"
+version_added: "2.0.0"
 author: "Or Soffer (@chkp-orso)"
 options:
   initiator:
@@ -66,6 +66,7 @@
     description:
       - Sorts results by the given field. By default the results are sorted in the descending order by the task's last update date.
     type: list
+    elements: dict
     suboptions:
       ASC:
         description:
@@ -113,7 +114,7 @@ def main():
         to_date=dict(type='str'),
         limit=dict(type='int'),
         offset=dict(type='int'),
-        order=dict(type='list', options=dict(
+        order=dict(type='list', elements='dict', options=dict(
             ASC=dict(type='str', choices=['name']),
             DESC=dict(type='str', choices=['name'])
         )),

plugins/modules/cp_mgmt_simple_gateway.py

@@ -32,7 +32,7 @@
 description:
   - Manages simple-gateway objects on Check Point devices including creating, updating and removing objects.
   - All operations are performed over Web Services API.
-version_added: "2.9"
+version_added: "1.0.0"
 author: "Or Soffer (@chkp-orso)"
 options:
   name:
@@ -105,6 +105,7 @@
     description:
       - Network interfaces. When a gateway is updated with a new interfaces, the existing interfaces are removed.
     type: list
+    elements: dict
     suboptions:
       name:
         description:
@@ -183,6 +184,7 @@
         description:
           - Collection of tag identifiers.
         type: list
+        elements: str
       topology:
         description:
           - N/A
@@ -381,18 +383,22 @@
     description:
       - Server(s) to send alerts to.
     type: list
+    elements: str
   send_logs_to_backup_server:
     description:
       - Backup server(s) to send logs to.
     type: list
+    elements: str
   send_logs_to_server:
     description:
       - Server(s) to send logs to.
     type: list
+    elements: str
   tags:
     description:
       - Collection of tag identifiers.
     type: list
+    elements: str
   threat_emulation:
     description:
       - Threat Emulation blade enabled.
@@ -447,6 +453,7 @@
     description:
       - Collection of group identifiers.
     type: list
+    elements: str
   ignore_warnings:
     description:
       - Apply changes ignoring warnings.
@@ -512,7 +519,7 @@ def main():
             maximum_memory_pool_size=dict(type='int'),
             memory_pool_size=dict(type='int')
         )),
-        interfaces=dict(type='list', options=dict(
+        interfaces=dict(type='list', elements='dict', options=dict(
             name=dict(type='str'),
             anti_spoofing=dict(type='bool'),
             anti_spoofing_settings=dict(type='dict', options=dict(
@@ -532,7 +539,7 @@ def main():
                 auto_calculated=dict(type='bool'),
                 specific_zone=dict(type='str')
             )),
-            tags=dict(type='list'),
+            tags=dict(type='list', elements='str'),
             topology=dict(type='str', choices=['automatic', 'external', 'internal']),
             topology_settings=dict(type='dict', options=dict(
                 interface_leads_to_dmz=dict(type='bool'),
@@ -589,13 +596,13 @@ def main():
             turn_on_qos_logging=dict(type='bool'),
             update_account_log_every=dict(type='int')
         )),
-        one_time_password=dict(type='str'),
+        one_time_password=dict(type='str', no_log=True),
         os_name=dict(type='str'),
         save_logs_locally=dict(type='bool'),
-        send_alerts_to_server=dict(type='list'),
-        send_logs_to_backup_server=dict(type='list'),
-        send_logs_to_server=dict(type='list'),
-        tags=dict(type='list'),
+        send_alerts_to_server=dict(type='list', elements='str'),
+        send_logs_to_backup_server=dict(type='list', elements='str'),
+        send_logs_to_server=dict(type='list', elements='str'),
+        tags=dict(type='list', elements='str'),
         threat_emulation=dict(type='bool'),
         threat_extraction=dict(type='bool'),
         url_filtering=dict(type='bool'),
@@ -613,7 +620,7 @@ def main():
                                         'yellow']),
         comments=dict(type='str'),
         details_level=dict(type='str', choices=['uid', 'standard', 'full']),
-        groups=dict(type='list'),
+        groups=dict(type='list', elements='str'),
         ignore_warnings=dict(type='bool'),
         ignore_errors=dict(type='bool')
     )

plugins/modules/cp_mgmt_simple_gateway_facts.py

@@ -34,7 +34,7 @@
   - All operations are performed over Web Services API.
   - This module handles both operations, get a specific object and get several objects,
     For getting a specific object use the parameter 'name'.
-version_added: "2.9"
+version_added: "1.0.0"
 author: "Or Soffer (@chkp-orso)"
 options:
   name:
@@ -63,6 +63,7 @@
       - Sorts results by the given field. By default the results are sorted in the ascending order by name.
         This parameter is relevant only for getting few objects.
     type: list
+    elements: dict
     suboptions:
       ASC:
         description:
@@ -110,15 +111,15 @@ def main():
         details_level=dict(type='str', choices=['uid', 'standard', 'full']),
         limit=dict(type='int'),
         offset=dict(type='int'),
-        order=dict(type='list', options=dict(
+        order=dict(type='list', elements='dict', options=dict(
             ASC=dict(type='str', choices=['name']),
             DESC=dict(type='str', choices=['name'])
         )),
         show_membership=dict(type='bool')
     )
     argument_spec.update(checkpoint_argument_spec_for_facts)
 
-    module = AnsibleModule(argument_spec=argument_spec)
+    module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True)
 
     api_call_object = "simple-gateway"
     api_call_object_plural_version = "simple-gateways"

plugins/modules/cp_mgmt_tag.py

@@ -32,7 +32,7 @@
 description:
   - Manages tag objects on Check Point devices including creating, updating and removing objects.
   - All operations are performed over Web Services API.
-version_added: "2.9"
+version_added: "1.0.0"
 author: "Or Soffer (@chkp-orso)"
 options:
   name:
@@ -44,6 +44,7 @@
     description:
       - Collection of tag identifiers.
     type: list
+    elements: str
   color:
     description:
       - Color of the object. Should be one of existing colors.
@@ -101,7 +102,7 @@
 def main():
     argument_spec = dict(
         name=dict(type='str', required=True),
-        tags=dict(type='list'),
+        tags=dict(type='list', elements='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',

plugins/modules/cp_mgmt_tag_facts.py

@@ -34,7 +34,7 @@
   - All operations are performed over Web Services API.
   - This module handles both operations, get a specific object and get several objects,
     For getting a specific object use the parameter 'name'.
-version_added: "2.9"
+version_added: "1.0.0"
 author: "Or Soffer (@chkp-orso)"
 options:
   name:
@@ -63,6 +63,7 @@
       - Sorts results by the given field. By default the results are sorted in the ascending order by name.
         This parameter is relevant only for getting few objects.
     type: list
+    elements: dict
     suboptions:
       ASC:
         description:
@@ -103,14 +104,14 @@ def main():
         details_level=dict(type='str', choices=['uid', 'standard', 'full']),
         limit=dict(type='int'),
         offset=dict(type='int'),
-        order=dict(type='list', options=dict(
+        order=dict(type='list', elements='dict', options=dict(
             ASC=dict(type='str', choices=['name']),
             DESC=dict(type='str', choices=['name'])
         ))
     )
     argument_spec.update(checkpoint_argument_spec_for_facts)
 
-    module = AnsibleModule(argument_spec=argument_spec)
+    module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True)
 
     api_call_object = "tag"
     api_call_object_plural_version = "tags"