Merge pull request #28 from chkp-ameera/master

add new modules and update version to 5.0.0

Author: chkp-majds

CHANGELOG.rst

@@ -4,6 +4,22 @@ Check_Point.gaia Release Notes
 
 .. contents:: Topics
 
+v5.0.0
+======
+
+Release Summary
+---------------
+
+This is release 5.0.0 of ``check_point.gaia``, released on 2023-10-01.
+
+New Modules
+-----------
+
+- check_point.gaia.cp_gaia_expert_password – manage expert password of a Check Point machine over Web Services API.
+- check_point.gaia.cp_gaia_expert_password_facts – get expert hash password of a Check Point machine over Web Services API.
+- check_point.gaia.cp_gaia_time_and_date – manage time and date and timezone of a Check Point machine over Web Services API.
+- check_point.gaia.cp_gaia_time_and_date_facts – get time and date and timezone of a Check Point machine over Web Services API.
+
 v4.1.1
 ======
 

README.md

@@ -117,7 +117,10 @@ Modules
 * `cp_gaia_task_facts` –  show task in a Check Point machine over Web Services API.
 * `cp_gaia_timezones_facts` –  show time zones in a Check Point machine over Web Services API.
 * `cp_gaia_version_facts` –  show gaia version in a Check Point machine over Web Services API.
-
+* `cp_gaia_expert_password` – manage expert password of a Check Point machine over Web Services API.
+* `cp_gaia_expert_password_facts` – get expert hash password of a Check Point machine over Web Services API.
+* `cp_gaia_time_and_date` – manage time and date and timezone of a Check Point machine over Web Services API.
+* `cp_gaia_time_and_date_facts` – get time and date and timezone of a Check Point machine over Web Services API.
 
 ### Code of Conduct
 This collection follows the Ansible project's

galaxy.yml

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

plugins/modules/cp_gaia_expert_password.py

@@ -0,0 +1,86 @@
+#!/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
+
+
+DOCUMENTATION = """
+author: Ameer Asli (@chkp-ameera)
+description:
+- Sets expert password.
+module: cp_gaia_expert_password
+short_description: Sets expert password.
+version_added: '5.0.0'
+notes:
+- Supports C(check_mode).
+requirements:
+- supported starting from gaia_api >= 1.7
+options:
+    version:
+      description: Gaia API version for example 1.7.
+      required: False
+      type: str
+    password:
+        description: expert new password.
+        required: False
+        type: str
+    password_hash:
+        description: An encrypted representation of the password.
+        required: False
+        type: str
+"""
+
+
+EXAMPLES = """
+- name: Setting expert new password
+  check_point.gaia.cp_gaia_expert_password:
+    password: newpass
+"""
+
+
+RETURN = """
+expert_password:
+  description: The checkpoint object updated.
+  returned: always.
+  type: dict
+"""
+
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.check_point.gaia.plugins.module_utils.checkpoint import chkp_api_call, checkpoint_argument_spec_for_all
+
+
+def main():
+    # arguments for the module:
+    fields = dict(
+        password=dict(type='str', no_log=True),
+        password_hash=dict(type='str', no_log=True)
+    )
+    fields.update(checkpoint_argument_spec_for_all)
+    module = AnsibleModule(argument_spec=fields, supports_check_mode=True)
+    api_call_object = 'expert-password'
+
+    res = chkp_api_call(module, api_call_object, False)
+    module.exit_json(**res)
+
+
+if __name__ == "__main__":
+    main()

plugins/modules/cp_gaia_expert_password_facts.py

@@ -0,0 +1,83 @@
+#!/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
+
+
+DOCUMENTATION = """
+author: Ameer Asli (@chkp-ameera)
+description:
+- Show the expert hash password.
+module: cp_gaia_expert_password_facts
+options:
+  version:
+    description: Gaia API version for example 1.7.
+    required: False
+    type: str
+short_description: Show expert hash password.
+version_added: '5.0.0'
+notes:
+- Supports C(check_mode).
+requirements:
+- supported starting from gaia_api >= 1.7
+
+
+"""
+
+
+EXAMPLES = """
+- name: Show expert hash password
+  check_point.gaia.cp_gaia_expert_password_facts:
+
+
+"""
+
+
+RETURN = """
+ansible_facts:
+    description: The checkpoint object facts.
+    returned: always.
+    type: dict
+    contains:
+        password_hash:
+            description: An encrypted representation of the password.
+            returned: always
+            type: str
+"""
+
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.check_point.gaia.plugins.module_utils.checkpoint import chkp_facts_api_call, checkpoint_argument_spec_for_all
+
+
+def main():
+    # arguments for the module:
+    fields = dict()
+    fields.update(checkpoint_argument_spec_for_all)
+    module = AnsibleModule(argument_spec=fields, supports_check_mode=True)
+    api_call_object = 'expert-password'
+
+    res = chkp_facts_api_call(module, api_call_object, False)
+    module.exit_json(ansible_facts=res["ansible_facts"])
+
+
+if __name__ == "__main__":
+    main()

plugins/modules/cp_gaia_time_and_date.py

@@ -0,0 +1,103 @@
+#!/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
+
+
+DOCUMENTATION = """
+author: Ameer Asli (@chkp-ameera)
+description:
+- Show the time and date configuration.
+module: cp_gaia_time_and_date
+short_description: Show the time and date configuration.
+version_added: '5.0.0'
+notes:
+- Supports C(check_mode).
+requirements:
+- supported starting from gaia_api >= 1.6
+options:
+    version:
+      description: Gaia API version for example 1.7.
+      required: False
+      type: str
+    time:
+      description: Time to set, in HH:MM[:SS] format.
+      required: False
+      type: str
+    date:
+      description: Date to set, in YYYY-MM-DD format.
+      required: False
+      type: str
+    timezone:
+      description: Timezone in Area / Region format. See timezone list via cp_gaia_timezones_facts.
+      required: False
+      type: str
+    wait_for_task:
+      description: Wait for task or return immediately.
+      required: False
+      default: True
+      type: bool
+"""
+
+
+EXAMPLES = """
+- name: Setting new time and date
+  check_point.gaia.cp_gaia_time_and_date:
+    time: newpass
+    date: newpass
+    timezone: newpass
+"""
+
+
+RETURN = """
+set_time_and_date:
+  description: The checkpoint object updated.
+  returned: always.
+  type: dict
+"""
+
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.check_point.gaia.plugins.module_utils.checkpoint import checkpoint_argument_spec_for_all
+from ansible_collections.check_point.gaia.plugins.module_utils.checkpoint import chkp_api_operation
+from ansible_collections.check_point.gaia.plugins.module_utils.checkpoint import checkpoint_argument_spec_for_async
+
+
+def main():
+    # arguments for the module:
+    fields = dict(
+        time=dict(type='str'),
+        date=dict(type='str'),
+        timezone=dict(type='str')
+    )
+    fields.update(checkpoint_argument_spec_for_async)
+    fields.update(checkpoint_argument_spec_for_all)
+    module = AnsibleModule(argument_spec=fields, supports_check_mode=True)
+    api_call_object = 'set-time-and-date'
+
+    # Run the command:
+    res = chkp_api_operation(module, api_call_object)
+
+    module.exit_json(**res)
+
+
+if __name__ == "__main__":
+    main()