Merge pull request #43 from chkp-shirango/master

Fix documentation

Author: chkp-shirango

plugins/modules/cp_mgmt_add_domain.py

@@ -43,41 +43,41 @@
   servers:
     description:
       - Domain servers. When this field is provided, 'set-domain' command is executed asynchronously.
-    type: dict
+    type: list
     suboptions:
+      name:
+        description:
+          - Object name. Must be unique in the domain.
+        type: str
+      ip_address:
+        description:
+          - IPv4 or IPv6 address. If both addresses are required use ipv4-address and ipv6-address fields explicitly.
+        type: str
+      ipv4_address:
+        description:
+          - IPv4 address.
+        type: str
+      ipv6_address:
+        description:
+          - IPv6 address.
+        type: str
+      multi_domain_server:
+        description:
+          - Multi Domain server name or UID.
+        type: str
+      active:
+        description:
+          - Activate domain server. Only one domain server is allowed to be active
+        type: bool
+      skip_start_domain_server:
+        description:
+          - Set this value to be true to prevent starting the new created domain.
+        type: bool
+      type:
         description:
-          - Adds to collection of values
-        type: list
-        suboptions:
-          name:
-            description:
-              - Object name. Must be unique in the domain.
-            type: str
-          ip_address:
-            description:
-              - IPv4 or IPv6 address. If both addresses are required use ipv4-address and ipv6-address fields explicitly.
-            type: str
-          ipv4_address:
-            description:
-              - IPv4 address.
-            type: str
-          ipv6_address:
-            description:
-              - IPv6 address.
-            type: str
-          multi_domain_server:
-            description:
-              - Multi Domain server name or UID.
-            type: str
-          skip_start_domain_server:
-            description:
-              - Set this value to be true to prevent starting the new created domain.
-            type: bool
-          type:
-            description:
-              - Domain server type.
-            type: str
-            choices: ['management server', 'log server', 'smc']
+          - Domain server type.
+        type: str
+        choices: ['management server', 'log server', 'smc']
   color:
     description:
       - Color of the object. Should be one of existing colors.
@@ -108,7 +108,7 @@
       - Collection of tag identifiers. Note, The list of tags can not be modified in a single command together with the domain servers. To modify
         tags, please use the separate 'set-domain' command, without providing the list of domain servers.
     type: list
-extends_documentation_fragment: checkpoint_objects
+extends_documentation_fragment: check_point.mgmt.checkpoint_commands
 """
 
 EXAMPLES = """
@@ -119,7 +119,6 @@
       ip_address: 192.0.2.1
       multi_domain_server: MDM_Server
       name: domain1_ManagementServer_1
-    state: present
 """
 
 RETURN = """
@@ -160,9 +159,9 @@ def main():
     argument_spec.update(checkpoint_argument_spec_for_commands)
 
     module = AnsibleModule(argument_spec=argument_spec)
-    api_call_object = 'add-domain'
+    command = 'add-domain'
 
-    result = api_command(module, api_call_object)
+    result = api_command(module, command)
     module.exit_json(**result)
 
 

plugins/modules/cp_mgmt_delete_domain.py

@@ -54,14 +54,13 @@
     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: checkpoint_objects
+extends_documentation_fragment: check_point.mgmt.checkpoint_commands
 """
 
 EXAMPLES = """
 - name: delete-domain
   cp_mgmt_delete_domain:
     name: domain1
-    state: absent
 """
 
 RETURN = """
@@ -85,9 +84,9 @@ def main():
     argument_spec.update(checkpoint_argument_spec_for_commands)
 
     module = AnsibleModule(argument_spec=argument_spec)
-    api_call_object = 'delete-domain'
+    command = 'delete-domain'
 
-    result = api_command(module, api_call_object)
+    result = api_command(module, command)
     module.exit_json(**result)
 
 

plugins/modules/cp_mgmt_identity_tag.py

@@ -73,7 +73,7 @@
     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: checkpoint_objects
+extends_documentation_fragment: check_point.mgmt.checkpoint_objects
 """
 
 EXAMPLES = """

plugins/modules/cp_mgmt_identity_tag_facts.py

@@ -85,7 +85,7 @@
       - Indicates which domains to process the commands on. It cannot be used with the details-level full, must be run from the System Domain only and
         with ignore-warnings true. Valid values are, CURRENT_DOMAIN, ALL_DOMAINS_ON_THIS_SERVER.
     type: list
-extends_documentation_fragment: checkpoint_facts
+extends_documentation_fragment: check_point.mgmt.checkpoint_facts
 """
 
 EXAMPLES = """

plugins/modules/cp_mgmt_install_database.py

@@ -39,7 +39,7 @@
     description:
       - Check Point host(s) with one or more Management Software Blades enabled. The targets can be identified by their name or unique identifier.
     type: list
-extends_documentation_fragment: checkpoint_commands
+extends_documentation_fragment: check_point.mgmt.checkpoint_commands
 """
 
 EXAMPLES = """

plugins/modules/cp_mgmt_mds.py

@@ -126,7 +126,7 @@
     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: checkpoint_objects
+extends_documentation_fragment: check_point.mgmt.checkpoint_objects
 """
 
 EXAMPLES = """

plugins/modules/cp_mgmt_set_domain.py

@@ -79,15 +79,15 @@
               - Domain server type.
             type: str
             choices: ['management server', 'log server', 'smc']
-        remove:
+      remove:
+        description:
+          - Remove from collection of values
+        type: list
+        suboptions:
+          name:
             description:
-              - Remove from collection of values
-            type: list
-            suboptions:
-              name:
-                description:
-                  - Object name. Must be unique in the domain.
-                type: str
+               - Object name. Must be unique in the domain.
+            type: str
   color:
     description:
       - Color of the object. Should be one of existing colors.
@@ -118,7 +118,7 @@
       - Collection of tag identifiers. Note, The list of tags can not be modified in a single command together with the domain servers. To modify
         tags, please use the separate 'set-domain' command, without providing the list of domain servers.
     type: list
-extends_documentation_fragment: checkpoint_objects
+extends_documentation_fragment: check_point.mgmt.checkpoint_commands
 """
 
 EXAMPLES = """
@@ -169,9 +169,9 @@ def main():
     argument_spec.update(checkpoint_argument_spec_for_commands)
 
     module = AnsibleModule(argument_spec=argument_spec)
-    api_call_object = 'set-domain'
+    command = 'set-domain'
 
-    result = api_command(module, api_call_object)
+    result = api_command(module, command)
     module.exit_json(**result)
 
 

plugins/modules/cp_mgmt_trusted_client.py

@@ -135,7 +135,7 @@
     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: checkpoint_objects
+extends_documentation_fragment: check_point.mgmt.checkpoint_objects
 """
 
 EXAMPLES = """

plugins/modules/cp_mgmt_trusted_client_facts.py

@@ -80,7 +80,7 @@
           - Sorts results by the given field in descending order.
         type: str
         choices: ['name']
-extends_documentation_fragment: checkpoint_facts
+extends_documentation_fragment: check_point.mgmt.checkpoint_facts
 """
 
 EXAMPLES = """