Split arguments that can accept either a String or list of objects to two (#82)

* Update version parameter name in simple-cluster

* Remove uid param from publish module

* Support 'top' and 'bottom' in position param

* Add state param

* Update galaxy.yml

* Split arguments that can accept either a String or list of objects to two

Author: chkp-edenbr

galaxy.yml

@@ -9,7 +9,7 @@ namespace: check_point
 name: mgmt
 
 # The version of the collection. Must be compatible with semantic versioning
-version: 3.0.0
+version: 3.1.0
 
 # The path to the Markdown (.md) readme file. This path is relative to the root of the collection
 readme: README.md

plugins/module_utils/checkpoint.py

@@ -435,7 +435,7 @@ def get_relevant_show_rulebase_command(api_call_object):
         return 'show-threat-rulebase'
     elif api_call_object == "threat-exception":
         return 'show-threat-rule-exception-rulebase'
-    #uncomment code below when https & nat modules are added as crud modules
+# uncomment code below when https & nat modules are added as crud modules
     # elif api_call_object == 'nat-rule':
     #     return 'show-nat-rulebase'
     # elif api_call_object == 'https-rule':

plugins/modules/cp_mgmt_access_role.py

@@ -40,7 +40,7 @@
       - Object name.
     type: str
     required: True
-  machines:
+  machines_list:
     description:
       - Machines that can access the system.
     type: list
@@ -59,6 +59,11 @@
         description:
           - When source is "Active Directory" use "base-dn" to refine the query in AD database.
         type: str
+  machines:
+    description:
+      - Any or All Identified.
+    type: str
+    choices: ['any', 'all identified']
   networks:
     description:
       - Collection of Network objects identified by the name or UID that can access the system.
@@ -73,7 +78,7 @@
       - Collection of tag identifiers.
     type: list
     elements: str
-  users:
+  users_list:
     description:
       - Users that can access the system.
     type: list
@@ -92,6 +97,11 @@
         description:
           - When source is "Active Directory" use "base-dn" to refine the query in AD database.
         type: str
+  users:
+    description:
+      - Any or All Identified.
+    type: str
+    choices: ['any', 'all identified']
   color:
     description:
       - Color of the object. Should be one of existing colors.
@@ -123,7 +133,6 @@
 EXAMPLES = """
 - name: add-access-role
   cp_mgmt_access_role:
-    machines: all identified
     name: New Access Role 1
     networks: any
     remote_access_clients: any
@@ -132,10 +141,11 @@
 
 - name: set-access-role
   cp_mgmt_access_role:
-    machines: any
+    users_list:
+        - source: "Internal User Groups"
+          selection: usersGroup
     name: New Access Role 1
     state: present
-    users: all identified
 
 - name: delete-access-role
   cp_mgmt_access_role:
@@ -157,19 +167,21 @@
 def main():
     argument_spec = dict(
         name=dict(type='str', required=True),
-        machines=dict(type='list', elements='dict', options=dict(
+        machines_list=dict(type='list', elements='dict', options=dict(
             source=dict(type='str'),
             selection=dict(type='list', elements='str'),
             base_dn=dict(type='str')
         )),
+        machines=dict(type='str', choices=['any', 'all identified']),
         networks=dict(type='list', elements='str'),
         remote_access_clients=dict(type='str'),
         tags=dict(type='list', elements='str'),
-        users=dict(type='list', elements='dict', options=dict(
+        users_list=dict(type='list', elements='dict', options=dict(
             source=dict(type='str'),
             selection=dict(type='list', elements='str'),
             base_dn=dict(type='str')
         )),
+        users=dict(type='str', choices=['any', 'all identified']),
         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',
@@ -185,6 +197,18 @@ def main():
     module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True)
     api_call_object = 'access-role'
 
+    if module.params["machines_list"] is not None:
+        if module.params["machines"] is not None:
+            raise AssertionError("The use of both 'machines_list' and 'machines' arguments isn't allowed")
+        module.params["machines"] = module.params["machines_list"]
+    module.params.pop("machines_list")
+
+    if module.params["users_list"] is not None:
+        if module.params["users"] is not None:
+            raise AssertionError("The use of both 'users_list' and 'users' arguments isn't allowed")
+        module.params["users"] = module.params["users_list"]
+    module.params.pop("users_list")
+
     result = api_call(module, api_call_object)
     module.exit_json(**result)
 

plugins/modules/cp_mgmt_access_rule.py

@@ -218,7 +218,7 @@
         description:
           - N/A
         type: str
-  vpn:
+  vpn_list:
     description:
       - Communities or Directional.
     type: list
@@ -228,7 +228,7 @@
         description:
           - List of community name or UID.
         type: list
-        elements: dict
+        elements: str
       directional:
         description:
           - Communities directional match condition.
@@ -243,6 +243,11 @@
             description:
               - To community name or UID.
             type: str
+  vpn:
+    description:
+      - Any or All_GwToGw.
+    type: str
+    choices: ['Any', 'All_GwToGw']
   comments:
     description:
       - Comments string.
@@ -273,6 +278,7 @@
     service:
     - SMTP
     - AOL
+    vpn: All_GwToGw
     state: present
 
 - name: set-access-rule
@@ -353,23 +359,30 @@ def main():
             frequency=dict(type='str', choices=['once a day', 'once a week', 'once a month', 'custom frequency...']),
             interaction=dict(type='str')
         )),
-        vpn=dict(type='list', elements='dict', options=dict(
-            community=dict(type='list', elements='dict'),
+        vpn_list=dict(type='list', elements='dict', options=dict(
+            community=dict(type='list', elements='str'),
             directional=dict(type='list', elements='dict', options=dict(
                 to=dict(type='str')
             ))
         )),
+        vpn=dict(type='str', choices=['Any', 'All_GwToGw']),
         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['vpn']['options']['directional']['options']['from'] = dict(type='str')
+    argument_spec['vpn_list']['options']['directional']['options']['from'] = dict(type='str')
     argument_spec.update(checkpoint_argument_spec_for_objects)
 
     module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True)
     api_call_object = 'access-rule'
 
+    if module.params["vpn_list"] is not None:
+        if module.params["vpn"] is not None:
+            raise AssertionError("The use of both 'vpn_list' and 'vpn' arguments isn't allowed")
+        module.params["vpn"] = module.params["vpn_list"]
+    module.params.pop("vpn_list")
+
     if module.params['action'] is None and module.params['position'] is None:
         result = api_call(module, api_call_object)
     else:

plugins/modules/cp_mgmt_access_rules.py

@@ -370,4 +370,4 @@ def main():
 
 
 if __name__ == '__main__':
-    main()
+    main()