add docs directory and update docs link to our pkg in galaxy

Author: chkp-majds

docs/cp_gaia_alias_interface.rst

@@ -0,0 +1,91 @@
+.. _cp_gaia_alias_interface_module:
+
+
+cp_gaia_alias_interface -- Modify alias interface.
+==================================================
+
+.. contents::
+   :local:
+   :depth: 1
+
+
+Synopsis
+--------
+
+Modify alias interface.
+
+
+
+
+
+
+Parameters
+----------
+
+  version (False, str, None)
+    Gaia API version for example 1.6.
+
+
+  state (False, str, present)
+    Ansible state which can be \ :literal:`present`\  or \ :literal:`absent`\ .
+
+
+  name (True, str, None)
+    Interface name with format "\<parent interface\>:\<id\>", for example  eth0:1, eth0:2 .. etc.
+
+
+  ipv4_address (False, str, None)
+    Interface IPv4 address.
+
+
+  ipv4_mask_length (False, int, None)
+    Interface IPv4 address mask length.
+
+
+
+
+
+Notes
+-----
+
+.. note::
+   - Supports \ :literal:`check\_mode`\ .
+
+
+
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+    
+    - name: Set comment field of a alias interface
+      check_point.gaia.cp_gaia_alias_interface:
+        comments: "eth0:1 interface"
+        name: eth0:1
+
+
+
+Return Values
+-------------
+
+alias_interface (always., dict, )
+  The updated interface details.
+
+
+
+
+
+Status
+------
+
+
+
+
+
+Authors
+~~~~~~~
+
+- Duane Toler (@duanetoler)
+

docs/cp_gaia_alias_interface_facts.rst

@@ -0,0 +1,102 @@
+.. _cp_gaia_alias_interface_facts_module:
+
+
+cp_gaia_alias_interface_facts -- Show alias interface/s.
+========================================================
+
+.. contents::
+   :local:
+   :depth: 1
+
+
+Synopsis
+--------
+
+Show alias interface.
+
+
+
+
+
+
+Parameters
+----------
+
+  version (False, str, None)
+    Gaia API version for example 1.6.
+
+
+  name (False, str, None)
+    Interface name to show. If not specified, all alias interfaces information is returned.
+
+
+
+
+
+Notes
+-----
+
+.. note::
+   - Supports \ :literal:`check\_mode`\ .
+
+
+
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+    
+    - name: Show alias interface
+      check_point.gaia.cp_gaia_alias_interface_facts:
+    - name: Show alias interface by specifying it's name
+      check_point.gaia.cp_gaia_alias_interface_facts:
+        name: eth0:1
+
+
+
+Return Values
+-------------
+
+ansible_facts (always., dict, )
+  The interface/s facts.
+
+
+  objects (always, list, )
+    List of interfaces.
+
+
+    name (always, str, )
+      Interface name.
+
+
+    ipv4_address (always, str, )
+      Interface IPv4 address.
+
+
+    ipv4_mask_length (always, int, )
+      Interface IPv4 address mask length.
+
+
+    enabled (always, bool, )
+      Interface State.
+
+
+
+
+
+
+
+Status
+------
+
+
+
+
+
+Authors
+~~~~~~~
+
+- Duane Toler (@duanetoler)
+

docs/cp_gaia_allowed_clients.rst

@@ -0,0 +1,100 @@
+.. _cp_gaia_allowed_clients_module:
+
+
+cp_gaia_allowed_clients -- Modify the configuration of allowed clients.
+=======================================================================
+
+.. contents::
+   :local:
+   :depth: 1
+
+
+Synopsis
+--------
+
+Modify the configuration of allowed clients.
+
+
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- supported starting from gaia\_api \>= 1.6
+
+
+
+Parameters
+----------
+
+  version (False, str, None)
+    Gaia API version for example 1.6.
+
+
+  allowed_networks (False, list, None)
+    Configure allowed clients as network.
+
+
+    subnet (False, str, None)
+      The network subnet.
+
+
+    mask_length (False, int, None)
+      The network mask length.
+
+
+
+  allowed_hosts (False, list, None)
+    Configure allowed clients as hosts, valid valuse are IPv4/Ipv6 addresses.
+
+
+  allowed_any_host (False, bool, None)
+    Allowed all hosts.
+
+
+
+
+
+Notes
+-----
+
+.. note::
+   - Supports \ :literal:`check\_mode`\ .
+
+
+
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+    
+    - name: Set allowed clients
+      check_point.gaia.cp_gaia_allowed_clients:
+        allowed_networks: [{"subnet": "44.4.44.0", "mask_length": 24}, {"subnet": "55.4.55.0", "mask_length": 24}]
+
+
+
+Return Values
+-------------
+
+allowed_clients (always., dict, )
+  The checkpoint object updated.
+
+
+
+
+
+Status
+------
+
+
+
+
+
+Authors
+~~~~~~~
+
+- Ameer Asli (@chkp-ameera)
+

docs/cp_gaia_allowed_clients_facts.rst

@@ -0,0 +1,100 @@
+.. _cp_gaia_allowed_clients_facts_module:
+
+
+cp_gaia_allowed_clients_facts -- Show the configuration of allowed clients.
+===========================================================================
+
+.. contents::
+   :local:
+   :depth: 1
+
+
+Synopsis
+--------
+
+Show the configuration of allowed clients.
+
+
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- supported starting from gaia\_api \>= 1.6
+
+
+
+Parameters
+----------
+
+  version (False, str, None)
+    Gaia API version for example 1.6.
+
+
+
+
+
+Notes
+-----
+
+.. note::
+   - Supports \ :literal:`check\_mode`\ .
+
+
+
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+    
+    - name: Show allowed clients
+      check_point.gaia.cp_gaia_allowed_clients_facts:
+
+
+
+Return Values
+-------------
+
+ansible_facts (always., dict, )
+  The checkpoint object facts.
+
+
+  allowed_any_host (always, bool, )
+    Allowed any host to access the server.
+
+
+  allowed_hosts (always, list, )
+    Lists of allowed hosts.
+
+
+  allowed_networks (always, list, )
+    List of allowed networks.
+
+
+    subnet (, str, )
+      The network subnet.
+
+
+    mask_length (, int, )
+      The network mask length.
+
+
+
+
+
+
+
+Status
+------
+
+
+
+
+
+Authors
+~~~~~~~
+
+- Ameer Asli (@chkp-ameera)
+