├── .github └── workflows │ └── ansible-test.yml ├── CHANGELOG.rst ├── README.md ├── docs ├── cp_gaia_alias_interface.rst ├── cp_gaia_alias_interface_facts.rst ├── cp_gaia_allowed_clients.rst ├── cp_gaia_allowed_clients_facts.rst ├── cp_gaia_api_versions_facts.rst ├── cp_gaia_asset_facts.rst ├── cp_gaia_banner.rst ├── cp_gaia_banner_facts.rst ├── cp_gaia_bond_interface.rst ├── cp_gaia_bond_interface_facts.rst ├── cp_gaia_bridge_interface.rst ├── cp_gaia_bridge_interface_facts.rst ├── cp_gaia_dhcp_server.rst ├── cp_gaia_dhcp_server_facts.rst ├── cp_gaia_diagnostics_facts.rst ├── cp_gaia_diagnostics_topics_facts.rst ├── cp_gaia_dns.rst ├── cp_gaia_dns_facts.rst ├── cp_gaia_dynamic_content.rst ├── cp_gaia_dynamic_content_layer_facts.rst ├── cp_gaia_dynamic_content_layers_facts.rst ├── cp_gaia_expert_password.rst ├── cp_gaia_expert_password_facts.rst ├── cp_gaia_extended_commands_facts.rst ├── cp_gaia_features_facts.rst ├── cp_gaia_grub_password.rst ├── cp_gaia_grub_password_facts.rst ├── cp_gaia_hostname.rst ├── cp_gaia_hostname_facts.rst ├── cp_gaia_hostname_on_login_page.rst ├── cp_gaia_hostname_on_login_page_facts.rst ├── cp_gaia_initial_setup.rst ├── cp_gaia_ipv6.rst ├── cp_gaia_ipv6_facts.rst ├── cp_gaia_loopback_interface.rst ├── cp_gaia_loopback_interface_facts.rst ├── cp_gaia_maestro_changes.rst ├── cp_gaia_maestro_gateways.rst ├── cp_gaia_maestro_gateways_facts.rst ├── cp_gaia_maestro_ports.rst ├── cp_gaia_maestro_ports_facts.rst ├── cp_gaia_maestro_security_groups.rst ├── cp_gaia_maestro_security_groups_facts.rst ├── cp_gaia_maestro_sites.rst ├── cp_gaia_maestro_sites_facts.rst ├── cp_gaia_message_of_the_day.rst ├── cp_gaia_message_of_the_day_facts.rst ├── cp_gaia_ntp.rst ├── cp_gaia_ntp_facts.rst ├── cp_gaia_password_policy.rst ├── cp_gaia_password_policy_facts.rst ├── cp_gaia_physical_interface.rst ├── cp_gaia_physical_interfaces_facts.rst ├── cp_gaia_proxy.rst ├── cp_gaia_proxy_facts.rst ├── cp_gaia_put_file.rst ├── cp_gaia_radius_server.rst ├── cp_gaia_radius_server_facts.rst ├── cp_gaia_remote_syslog.rst ├── cp_gaia_remote_syslog_facts.rst ├── cp_gaia_role.rst ├── cp_gaia_role_facts.rst ├── cp_gaia_routes_aggregate_facts.rst ├── cp_gaia_routes_bgp_facts.rst ├── cp_gaia_routes_direct_facts.rst ├── cp_gaia_routes_facts.rst ├── cp_gaia_routes_kernel_facts.rst ├── cp_gaia_routes_ospf_facts.rst ├── cp_gaia_routes_rip_facts.rst ├── cp_gaia_routes_static_facts.rst ├── cp_gaia_run_reboot.rst ├── cp_gaia_run_script.rst ├── cp_gaia_scheduled_job.rst ├── cp_gaia_scheduled_job_facts.rst ├── cp_gaia_scheduled_job_mail.rst ├── cp_gaia_scheduled_job_mail_facts.rst ├── cp_gaia_scheduled_snapshot.rst ├── cp_gaia_scheduled_snapshot_facts.rst ├── cp_gaia_simulate_packet.rst ├── cp_gaia_snmp.rst ├── cp_gaia_snmp_custom_trap.rst ├── cp_gaia_snmp_custom_trap_facts.rst ├── cp_gaia_snmp_facts.rst ├── cp_gaia_snmp_pre_defined_traps.rst ├── cp_gaia_snmp_pre_defined_traps_facts.rst ├── cp_gaia_snmp_trap_receiver.rst ├── cp_gaia_snmp_trap_receiver_facts.rst ├── cp_gaia_snmp_user.rst ├── cp_gaia_snmp_user_facts.rst ├── cp_gaia_ssh_server_settings.rst ├── cp_gaia_ssh_server_settings_facts.rst ├── cp_gaia_static_route.rst ├── cp_gaia_static_route_facts.rst ├── cp_gaia_syslog.rst ├── cp_gaia_syslog_facts.rst ├── cp_gaia_system_group.rst ├── cp_gaia_system_group_facts.rst ├── cp_gaia_tacacs_server.rst ├── cp_gaia_tacacs_server_facts.rst ├── cp_gaia_task_facts.rst ├── cp_gaia_time_and_date.rst ├── cp_gaia_time_and_date_facts.rst ├── cp_gaia_timezones_facts.rst ├── cp_gaia_user.rst ├── cp_gaia_user_facts.rst ├── cp_gaia_version_facts.rst ├── cp_gaia_virtual_gateway.rst ├── cp_gaia_virtual_gateway_facts.rst ├── cp_gaia_virtual_switch.rst ├── cp_gaia_virtual_switch_facts.rst ├── cp_gaia_virtual_systems_facts.rst ├── cp_gaia_vlan_interface.rst ├── cp_gaia_vlan_interface_facts.rst └── cp_gaia_vsnext_state_facts.rst ├── galaxy.yml ├── meta └── runtime.yml ├── plugins ├── httpapi │ └── checkpoint.py ├── module_utils │ └── checkpoint.py └── modules │ ├── cp_gaia_alias_interface.py │ ├── cp_gaia_alias_interface_facts.py │ ├── cp_gaia_allowed_clients.py │ ├── cp_gaia_allowed_clients_facts.py │ ├── cp_gaia_api_versions_facts.py │ ├── cp_gaia_asset_facts.py │ ├── cp_gaia_banner.py │ ├── cp_gaia_banner_facts.py │ ├── cp_gaia_bond_interface.py │ ├── cp_gaia_bond_interface_facts.py │ ├── cp_gaia_bridge_interface.py │ ├── cp_gaia_bridge_interface_facts.py │ ├── cp_gaia_dhcp_server.py │ ├── cp_gaia_dhcp_server_facts.py │ ├── cp_gaia_diagnostics_facts.py │ ├── cp_gaia_diagnostics_topics_facts.py │ ├── cp_gaia_dns.py │ ├── cp_gaia_dns_facts.py │ ├── cp_gaia_dynamic_content.py │ ├── cp_gaia_dynamic_content_layer_facts.py │ ├── cp_gaia_dynamic_content_layers_facts.py │ ├── cp_gaia_expert_password.py │ ├── cp_gaia_expert_password_facts.py │ ├── cp_gaia_extended_commands_facts.py │ ├── cp_gaia_features_facts.py │ ├── cp_gaia_grub_password.py │ ├── cp_gaia_grub_password_facts.py │ ├── cp_gaia_hostname.py │ ├── cp_gaia_hostname_facts.py │ ├── cp_gaia_hostname_on_login_page.py │ ├── cp_gaia_hostname_on_login_page_facts.py │ ├── cp_gaia_initial_setup.py │ ├── cp_gaia_ipv6.py │ ├── cp_gaia_ipv6_facts.py │ ├── cp_gaia_loopback_interface.py │ ├── cp_gaia_loopback_interface_facts.py │ ├── cp_gaia_maestro_changes.py │ ├── cp_gaia_maestro_gateways.py │ ├── cp_gaia_maestro_gateways_facts.py │ ├── cp_gaia_maestro_ports.py │ ├── cp_gaia_maestro_ports_facts.py │ ├── cp_gaia_maestro_security_groups.py │ ├── cp_gaia_maestro_security_groups_facts.py │ ├── cp_gaia_maestro_sites.py │ ├── cp_gaia_maestro_sites_facts.py │ ├── cp_gaia_message_of_the_day.py │ ├── cp_gaia_message_of_the_day_facts.py │ ├── cp_gaia_ntp.py │ ├── cp_gaia_ntp_facts.py │ ├── cp_gaia_password_policy.py │ ├── cp_gaia_password_policy_facts.py │ ├── cp_gaia_physical_interface.py │ ├── cp_gaia_physical_interfaces_facts.py │ ├── cp_gaia_proxy.py │ ├── cp_gaia_proxy_facts.py │ ├── cp_gaia_put_file.py │ ├── cp_gaia_radius_server.py │ ├── cp_gaia_radius_server_facts.py │ ├── cp_gaia_remote_syslog.py │ ├── cp_gaia_remote_syslog_facts.py │ ├── cp_gaia_role.py │ ├── cp_gaia_role_facts.py │ ├── cp_gaia_routes_aggregate_facts.py │ ├── cp_gaia_routes_bgp_facts.py │ ├── cp_gaia_routes_direct_facts.py │ ├── cp_gaia_routes_facts.py │ ├── cp_gaia_routes_kernel_facts.py │ ├── cp_gaia_routes_ospf_facts.py │ ├── cp_gaia_routes_rip_facts.py │ ├── cp_gaia_routes_static_facts.py │ ├── cp_gaia_run_reboot.py │ ├── cp_gaia_run_script.py │ ├── cp_gaia_scheduled_job.py │ ├── cp_gaia_scheduled_job_facts.py │ ├── cp_gaia_scheduled_job_mail.py │ ├── cp_gaia_scheduled_job_mail_facts.py │ ├── cp_gaia_scheduled_snapshot.py │ ├── cp_gaia_scheduled_snapshot_facts.py │ ├── cp_gaia_simulate_packet.py │ ├── cp_gaia_snmp.py │ ├── cp_gaia_snmp_custom_trap.py │ ├── cp_gaia_snmp_custom_trap_facts.py │ ├── cp_gaia_snmp_facts.py │ ├── cp_gaia_snmp_pre_defined_traps.py │ ├── cp_gaia_snmp_pre_defined_traps_facts.py │ ├── cp_gaia_snmp_trap_receiver.py │ ├── cp_gaia_snmp_trap_receiver_facts.py │ ├── cp_gaia_snmp_user.py │ ├── cp_gaia_snmp_user_facts.py │ ├── cp_gaia_ssh_server_settings.py │ ├── cp_gaia_ssh_server_settings_facts.py │ ├── cp_gaia_static_route.py │ ├── cp_gaia_static_route_facts.py │ ├── cp_gaia_syslog.py │ ├── cp_gaia_syslog_facts.py │ ├── cp_gaia_system_group.py │ ├── cp_gaia_system_group_facts.py │ ├── cp_gaia_tacacs_server.py │ ├── cp_gaia_tacacs_server_facts.py │ ├── cp_gaia_task_facts.py │ ├── cp_gaia_time_and_date.py │ ├── cp_gaia_time_and_date_facts.py │ ├── cp_gaia_timezones_facts.py │ ├── cp_gaia_user.py │ ├── cp_gaia_user_facts.py │ ├── cp_gaia_version_facts.py │ ├── cp_gaia_virtual_gateway.py │ ├── cp_gaia_virtual_gateway_facts.py │ ├── cp_gaia_virtual_switch.py │ ├── cp_gaia_virtual_switch_facts.py │ ├── cp_gaia_virtual_systems_facts.py │ ├── cp_gaia_vlan_interface.py │ ├── cp_gaia_vlan_interface_facts.py │ └── cp_gaia_vsnext_state_facts.py └── tests └── unit └── modules ├── test_cp_gaia_allowed_clients.py ├── test_cp_gaia_allowed_clients_facts.py ├── test_cp_gaia_api_versions_facts.py ├── test_cp_gaia_asset_facts.py ├── test_cp_gaia_banner.py ├── test_cp_gaia_banner_facts.py ├── test_cp_gaia_bond_interface.py ├── test_cp_gaia_bond_interface_facts.py ├── test_cp_gaia_bridge_interface.py ├── test_cp_gaia_bridge_interface_facts.py ├── test_cp_gaia_dhcp_server.py ├── test_cp_gaia_dhcp_server_facts.py ├── test_cp_gaia_diagnostics_facts.py ├── test_cp_gaia_diagnostics_topics_facts.py ├── test_cp_gaia_dns.py ├── test_cp_gaia_dns_facts.py ├── test_cp_gaia_extended_commands_facts.py ├── test_cp_gaia_features_facts.py ├── test_cp_gaia_hostname.py ├── test_cp_gaia_hostname_facts.py ├── test_cp_gaia_hostname_on_login_page.py ├── test_cp_gaia_hostname_on_login_page_facts.py ├── test_cp_gaia_initial_setup.py ├── test_cp_gaia_ipv6.py ├── test_cp_gaia_ipv6_facts.py ├── test_cp_gaia_message_of_the_day.py ├── test_cp_gaia_message_of_the_day_facts.py ├── test_cp_gaia_ntp.py ├── test_cp_gaia_ntp_facts.py ├── test_cp_gaia_password_policy.py ├── test_cp_gaia_password_policy_facts.py ├── test_cp_gaia_physical_interface.py ├── test_cp_gaia_physical_interfaces_facts.py ├── test_cp_gaia_proxy.py ├── test_cp_gaia_proxy_facts.py ├── test_cp_gaia_put_file.py ├── test_cp_gaia_radius_server.py ├── test_cp_gaia_radius_server_facts.py ├── test_cp_gaia_remote_syslog.py ├── test_cp_gaia_remote_syslog_facts.py ├── test_cp_gaia_role.py ├── test_cp_gaia_role_facts.py ├── test_cp_gaia_routes_aggregate_facts.py ├── test_cp_gaia_routes_bgp_facts.py ├── test_cp_gaia_routes_direct_facts.py ├── test_cp_gaia_routes_facts.py ├── test_cp_gaia_routes_kernel_facts.py ├── test_cp_gaia_routes_ospf_facts.py ├── test_cp_gaia_routes_rip_facts.py ├── test_cp_gaia_routes_static_facts.py ├── test_cp_gaia_run_reboot.py ├── test_cp_gaia_run_script.py ├── test_cp_gaia_scheduled_job.py ├── test_cp_gaia_scheduled_job_facts.py ├── test_cp_gaia_scheduled_job_mail.py ├── test_cp_gaia_scheduled_job_mail_facts.py ├── test_cp_gaia_scheduled_snapshot.py ├── test_cp_gaia_scheduled_snapshot_facts.py ├── test_cp_gaia_ssh_server_settings.py ├── test_cp_gaia_ssh_server_settings_facts.py ├── test_cp_gaia_static_route.py ├── test_cp_gaia_static_route_facts.py ├── test_cp_gaia_syslog.py ├── test_cp_gaia_syslog_facts.py ├── test_cp_gaia_tacacs_server.py ├── test_cp_gaia_tacacs_server_facts.py ├── test_cp_gaia_task_facts.py ├── test_cp_gaia_timezones_facts.py ├── test_cp_gaia_user.py ├── test_cp_gaia_user_facts.py ├── test_cp_gaia_version_facts.py ├── test_cp_gaia_vlan_interface.py └── test_cp_gaia_vlan_interface_facts.py /docs/cp_gaia_alias_interface.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_alias_interface_module: 2 | 3 | 4 | cp_gaia_alias_interface -- Modify alias interface. 5 | ================================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Modify alias interface. 16 | 17 | 18 | 19 | 20 | 21 | 22 | Parameters 23 | ---------- 24 | 25 | version (False, str, None) 26 | Gaia API version for example 1.6. 27 | 28 | 29 | state (False, str, present) 30 | Ansible state which can be :literal:`present` or :literal:`absent`. 31 | 32 | 33 | name (True, str, None) 34 | Interface name with format "\:\", for example eth0:1, eth0:2 .. etc. 35 | 36 | 37 | ipv4_address (True, str, None) 38 | Interface IPv4 address. 39 | 40 | 41 | ipv4_mask_length (True, int, None) 42 | Interface IPv4 address mask length. 43 | 44 | 45 | virtual_system_id (False, int, None) 46 | Virtual System ID. 47 | 48 | 49 | 50 | 51 | 52 | Notes 53 | ----- 54 | 55 | .. note:: 56 | - Supports :literal:`check\_mode`. 57 | 58 | 59 | 60 | 61 | Examples 62 | -------- 63 | 64 | .. code-block:: yaml+jinja 65 | 66 | 67 | - name: Set comment field of a alias interface 68 | check_point.gaia.cp_gaia_alias_interface: 69 | comments: "eth0:1 interface" 70 | name: eth0:1 71 | 72 | 73 | 74 | Return Values 75 | ------------- 76 | 77 | alias_interface (always., dict, ) 78 | The updated interface details. 79 | 80 | 81 | 82 | 83 | 84 | Status 85 | ------ 86 | 87 | 88 | 89 | 90 | 91 | Authors 92 | ~~~~~~~ 93 | 94 | - Duane Toler (@duanetoler) 95 | 96 | -------------------------------------------------------------------------------- /docs/cp_gaia_alias_interface_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_alias_interface_facts_module: 2 | 3 | 4 | cp_gaia_alias_interface_facts -- Show alias interface/s. 5 | ======================================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Show alias interface. 16 | 17 | 18 | 19 | 20 | 21 | 22 | Parameters 23 | ---------- 24 | 25 | version (False, str, None) 26 | Gaia API version for example 1.6. 27 | 28 | 29 | name (False, str, None) 30 | Interface name to show. If not specified, all alias interfaces information is returned. 31 | 32 | 33 | virtual_system_id (False, int, None) 34 | Virtual System ID. 35 | 36 | 37 | 38 | 39 | 40 | Notes 41 | ----- 42 | 43 | .. note:: 44 | - Supports :literal:`check\_mode`. 45 | 46 | 47 | 48 | 49 | Examples 50 | -------- 51 | 52 | .. code-block:: yaml+jinja 53 | 54 | 55 | - name: Show alias interface 56 | check_point.gaia.cp_gaia_alias_interface_facts: 57 | - name: Show alias interface by specifying it's name 58 | check_point.gaia.cp_gaia_alias_interface_facts: 59 | name: eth0:1 60 | 61 | 62 | 63 | Return Values 64 | ------------- 65 | 66 | ansible_facts (always., dict, ) 67 | The interface/s facts. 68 | 69 | 70 | objects (always, list, ) 71 | List of interfaces. 72 | 73 | 74 | name (always, str, ) 75 | Interface name. 76 | 77 | 78 | ipv4_address (always, str, ) 79 | Interface IPv4 address. 80 | 81 | 82 | ipv4_mask_length (always, int, ) 83 | Interface IPv4 address mask length. 84 | 85 | 86 | enabled (always, bool, ) 87 | Interface State. 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | Status 96 | ------ 97 | 98 | 99 | 100 | 101 | 102 | Authors 103 | ~~~~~~~ 104 | 105 | - Duane Toler (@duanetoler) 106 | 107 | -------------------------------------------------------------------------------- /docs/cp_gaia_allowed_clients.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_allowed_clients_module: 2 | 3 | 4 | cp_gaia_allowed_clients -- Modify the configuration of allowed clients. 5 | ======================================================================= 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Modify the configuration of allowed clients. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.6 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.6. 32 | 33 | 34 | allowed_networks (False, list, None) 35 | Configure allowed clients as network. 36 | 37 | 38 | subnet (False, str, None) 39 | The network subnet. 40 | 41 | 42 | mask_length (False, int, None) 43 | The network mask length. 44 | 45 | 46 | 47 | allowed_hosts (False, list, None) 48 | Configure allowed clients as hosts, valid valuse are IPv4/Ipv6 addresses. 49 | 50 | 51 | allowed_any_host (False, bool, None) 52 | Allowed all hosts. 53 | 54 | 55 | virtual_system_id (False, int, None) 56 | Virtual System ID. 57 | 58 | 59 | 60 | 61 | 62 | Notes 63 | ----- 64 | 65 | .. note:: 66 | - Supports :literal:`check\_mode`. 67 | 68 | 69 | 70 | 71 | Examples 72 | -------- 73 | 74 | .. code-block:: yaml+jinja 75 | 76 | 77 | - name: Set allowed clients 78 | check_point.gaia.cp_gaia_allowed_clients: 79 | allowed_networks: [{"subnet": "44.4.44.0", "mask_length": 24}, {"subnet": "55.4.55.0", "mask_length": 24}] 80 | 81 | 82 | 83 | Return Values 84 | ------------- 85 | 86 | allowed_clients (always., dict, ) 87 | The checkpoint object updated. 88 | 89 | 90 | 91 | 92 | 93 | Status 94 | ------ 95 | 96 | 97 | 98 | 99 | 100 | Authors 101 | ~~~~~~~ 102 | 103 | - Ameer Asli (@chkp-ameera) 104 | 105 | -------------------------------------------------------------------------------- /docs/cp_gaia_allowed_clients_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_allowed_clients_facts_module: 2 | 3 | 4 | cp_gaia_allowed_clients_facts -- Show the configuration of allowed clients. 5 | =========================================================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Show the configuration of allowed clients. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.6 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.6. 32 | 33 | 34 | virtual_system_id (False, int, None) 35 | Virtual System ID. 36 | 37 | 38 | 39 | 40 | 41 | Notes 42 | ----- 43 | 44 | .. note:: 45 | - Supports :literal:`check\_mode`. 46 | 47 | 48 | 49 | 50 | Examples 51 | -------- 52 | 53 | .. code-block:: yaml+jinja 54 | 55 | 56 | - name: Show allowed clients 57 | check_point.gaia.cp_gaia_allowed_clients_facts: 58 | 59 | 60 | 61 | Return Values 62 | ------------- 63 | 64 | ansible_facts (always., dict, ) 65 | The checkpoint object facts. 66 | 67 | 68 | allowed_any_host (always, bool, ) 69 | Allowed any host to access the server. 70 | 71 | 72 | allowed_hosts (always, list, ) 73 | Lists of allowed hosts. 74 | 75 | 76 | allowed_networks (always, list, ) 77 | List of allowed networks. 78 | 79 | 80 | subnet (, str, ) 81 | The network subnet. 82 | 83 | 84 | mask_length (, int, ) 85 | The network mask length. 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | Status 94 | ------ 95 | 96 | 97 | 98 | 99 | 100 | Authors 101 | ~~~~~~~ 102 | 103 | - Ameer Asli (@chkp-ameera) 104 | 105 | -------------------------------------------------------------------------------- /docs/cp_gaia_api_versions_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_api_versions_facts_module: 2 | 3 | 4 | cp_gaia_api_versions_facts -- Show api versions. 5 | ================================================ 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Show api versions. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.6 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.6. 32 | 33 | 34 | virtual_system_id (False, int, None) 35 | Virtual System ID. 36 | 37 | 38 | 39 | 40 | 41 | Notes 42 | ----- 43 | 44 | .. note:: 45 | - Supports :literal:`check\_mode`. 46 | 47 | 48 | 49 | 50 | Examples 51 | -------- 52 | 53 | .. code-block:: yaml+jinja 54 | 55 | 56 | - name: Show api versions 57 | check_point.gaia.cp_gaia_api_versions_facts: 58 | 59 | 60 | 61 | Return Values 62 | ------------- 63 | 64 | ansible_facts (always., dict, ) 65 | The api versions facts. 66 | 67 | 68 | current_version (always, str, ) 69 | Represents the latest supported version by the installed REST engine. 70 | 71 | 72 | supported_versions (always, list, ) 73 | Represents all the previous versions supported by the installed REST engine. 74 | 75 | 76 | 77 | 78 | 79 | 80 | Status 81 | ------ 82 | 83 | 84 | 85 | 86 | 87 | Authors 88 | ~~~~~~~ 89 | 90 | - Ameer Asli (@chkp-ameera) 91 | 92 | -------------------------------------------------------------------------------- /docs/cp_gaia_banner.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_banner_module: 2 | 3 | 4 | cp_gaia_banner -- Setting the banner message. 5 | ============================================= 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Setting the banner message. 16 | 17 | 18 | 19 | 20 | 21 | 22 | Parameters 23 | ---------- 24 | 25 | version (False, str, None) 26 | Gaia API version for example 1.6. 27 | 28 | 29 | msg (False, str, This system is for authorized use only.) 30 | Banner message for the web, ssh and serial login. Empty string returns to default. 31 | 32 | 33 | enabled (False, bool, None) 34 | Banner message enabled. 35 | 36 | 37 | virtual_system_id (False, int, None) 38 | Virtual System ID. 39 | 40 | 41 | 42 | 43 | 44 | Notes 45 | ----- 46 | 47 | .. note:: 48 | - Supports :literal:`check\_mode`. 49 | 50 | 51 | 52 | 53 | Examples 54 | -------- 55 | 56 | .. code-block:: yaml+jinja 57 | 58 | 59 | - banner: Changing the banner message 60 | check_point.gaia.cp_gaia_banner: 61 | msg: new_message 62 | 63 | 64 | 65 | Return Values 66 | ------------- 67 | 68 | banner (always., dict, ) 69 | The checkpoint object updated. 70 | 71 | 72 | 73 | 74 | 75 | Status 76 | ------ 77 | 78 | 79 | 80 | 81 | 82 | Authors 83 | ~~~~~~~ 84 | 85 | - Ameer Asli (@chkp-ameera) 86 | 87 | -------------------------------------------------------------------------------- /docs/cp_gaia_banner_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_banner_facts_module: 2 | 3 | 4 | cp_gaia_banner_facts -- Show banner message settings. 5 | ===================================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Show banner message. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.6 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.6. 32 | 33 | 34 | virtual_system_id (False, int, None) 35 | Virtual System ID. 36 | 37 | 38 | 39 | 40 | 41 | Notes 42 | ----- 43 | 44 | .. note:: 45 | - Supports :literal:`check\_mode`. 46 | 47 | 48 | 49 | 50 | Examples 51 | -------- 52 | 53 | .. code-block:: yaml+jinja 54 | 55 | 56 | - name: Show banner message 57 | check_point.gaia.cp_gaia_banner_facts: 58 | 59 | 60 | 61 | Return Values 62 | ------------- 63 | 64 | ansible_facts (always., dict, ) 65 | The checkpoint object facts. 66 | 67 | 68 | message (always, str, ) 69 | Banner message. 70 | 71 | 72 | enabled (always, bool, ) 73 | If banner enabled. 74 | 75 | 76 | 77 | 78 | 79 | 80 | Status 81 | ------ 82 | 83 | 84 | 85 | 86 | 87 | Authors 88 | ~~~~~~~ 89 | 90 | - Ameer Asli (@chkp-ameera) 91 | 92 | -------------------------------------------------------------------------------- /docs/cp_gaia_diagnostics_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_diagnostics_facts_module: 2 | 3 | 4 | cp_gaia_diagnostics_facts -- Show diagnostics. 5 | ============================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Show diagnostics. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.6 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.6. 32 | 33 | 34 | virtual_system_id (False, int, None) 35 | Virtual System ID. 36 | 37 | 38 | category (True, str, None) 39 | Category. 40 | 41 | 42 | topic (True, str, None) 43 | Category. 44 | 45 | 46 | 47 | 48 | 49 | Notes 50 | ----- 51 | 52 | .. note:: 53 | - Supports :literal:`check\_mode`. 54 | 55 | 56 | 57 | 58 | Examples 59 | -------- 60 | 61 | .. code-block:: yaml+jinja 62 | 63 | 64 | - name: Show diagnostics 65 | check_point.gaia.cp_gaia_diagnostics_facts: 66 | category: os 67 | topic: memory 68 | 69 | 70 | 71 | Return Values 72 | ------------- 73 | 74 | ansible_facts (always., dict, ) 75 | The diagnostics facts. 76 | 77 | 78 | total (always, int, ) 79 | How much to show. 80 | 81 | 82 | from (always, int, ) 83 | Starting from. 84 | 85 | 86 | to (always, int, ) 87 | Ending to. 88 | 89 | 90 | objects (always, list, ) 91 | List for memory, disk, or CPU based on the "topic" parameter. 92 | 93 | 94 | 95 | 96 | 97 | 98 | Status 99 | ------ 100 | 101 | 102 | 103 | 104 | 105 | Authors 106 | ~~~~~~~ 107 | 108 | - Ameer Asli (@chkp-ameera) 109 | 110 | -------------------------------------------------------------------------------- /docs/cp_gaia_diagnostics_topics_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_diagnostics_topics_facts_module: 2 | 3 | 4 | cp_gaia_diagnostics_topics_facts -- Show diagnostics topics. 5 | ============================================================ 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Show diagnostics topics. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.6 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.6. 32 | 33 | 34 | virtual_system_id (False, int, None) 35 | Virtual System ID. 36 | 37 | 38 | 39 | 40 | 41 | Notes 42 | ----- 43 | 44 | .. note:: 45 | - Supports :literal:`check\_mode`. 46 | 47 | 48 | 49 | 50 | Examples 51 | -------- 52 | 53 | .. code-block:: yaml+jinja 54 | 55 | 56 | - name: Show diagnostics_topics 57 | check_point.gaia.cp_gaia_diagnostics_topics_facts: 58 | 59 | 60 | 61 | Return Values 62 | ------------- 63 | 64 | ansible_facts (always., dict, ) 65 | The diagnostics topics facts. 66 | 67 | 68 | os (always, list, ) 69 | The topics which are valid for show-diagnostics. 70 | 71 | 72 | 73 | 74 | 75 | 76 | Status 77 | ------ 78 | 79 | 80 | 81 | 82 | 83 | Authors 84 | ~~~~~~~ 85 | 86 | - Ameer Asli (@chkp-ameera) 87 | 88 | -------------------------------------------------------------------------------- /docs/cp_gaia_dns.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_dns_module: 2 | 3 | 4 | cp_gaia_dns -- Setting DNS configuration. 5 | ========================================= 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Setting DNS configuration. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.6 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.6. 32 | 33 | 34 | virtual_system_id (False, int, None) 35 | Virtual System ID. 36 | 37 | 38 | suffix (False, str, None) 39 | Use empty-string in order to remove the setting. 40 | 41 | 42 | primary (False, str, None) 43 | Use empty-string in order to remove the setting. 44 | 45 | 46 | tertiary (False, str, None) 47 | Use empty-string in order to remove the setting. 48 | 49 | 50 | secondary (False, str, None) 51 | Use empty-string in order to remove the setting. 52 | 53 | 54 | 55 | 56 | 57 | Notes 58 | ----- 59 | 60 | .. note:: 61 | - Supports :literal:`check\_mode`. 62 | 63 | 64 | 65 | 66 | Examples 67 | -------- 68 | 69 | .. code-block:: yaml+jinja 70 | 71 | 72 | - name: Setting dns servers for the system 73 | check_point.gaia.cp_gaia_dns: 74 | suffix: "checkpoint.com" 75 | primary: "1.2.3.4" 76 | tertiary: "3.4.5.6" 77 | secondary: "2.3.4.5" 78 | 79 | 80 | 81 | Return Values 82 | ------------- 83 | 84 | dns (always., dict, ) 85 | The checkpoint object updated. 86 | 87 | 88 | 89 | 90 | 91 | Status 92 | ------ 93 | 94 | 95 | 96 | 97 | 98 | Authors 99 | ~~~~~~~ 100 | 101 | - Majd Sharkia (@chkp-majds) 102 | 103 | -------------------------------------------------------------------------------- /docs/cp_gaia_dns_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_dns_facts_module: 2 | 3 | 4 | cp_gaia_dns_facts -- Show DNS settings. 5 | ======================================= 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Show DNS settings. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.6 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.6. 32 | 33 | 34 | virtual_system_id (False, int, None) 35 | Virtual System ID. 36 | 37 | 38 | 39 | 40 | 41 | Notes 42 | ----- 43 | 44 | .. note:: 45 | - Supports :literal:`check\_mode`. 46 | 47 | 48 | 49 | 50 | Examples 51 | -------- 52 | 53 | .. code-block:: yaml+jinja 54 | 55 | 56 | - name: Show current dns configuration 57 | check_point.gaia.cp_gaia_dns_facts: 58 | 59 | 60 | 61 | Return Values 62 | ------------- 63 | 64 | ansible_facts (always., dict, ) 65 | The checkpoint object facts. 66 | 67 | 68 | suffix (always., str, ) 69 | Use empty-string in order to remove the setting. 70 | 71 | 72 | primary (always., str, ) 73 | Use empty-string in order to remove the setting. 74 | 75 | 76 | tertiary (always., str, ) 77 | Use empty-string in order to remove the setting. 78 | 79 | 80 | secondary (always., str, ) 81 | Use empty-string in order to remove the setting. 82 | 83 | 84 | 85 | 86 | 87 | 88 | Status 89 | ------ 90 | 91 | 92 | 93 | 94 | 95 | Authors 96 | ~~~~~~~ 97 | 98 | - Majd Sharkia (@chkp-majds) 99 | 100 | -------------------------------------------------------------------------------- /docs/cp_gaia_dynamic_content.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_dynamic_content_module: 2 | 3 | 4 | cp_gaia_dynamic_content -- installing policy 5 | ============================================ 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Installing policy 16 | 17 | 18 | 19 | 20 | 21 | 22 | Parameters 23 | ---------- 24 | 25 | version (False, str, None) 26 | GAIA api version for ex 1.8 27 | 28 | 29 | virtual_system_id (False, int, None) 30 | Virtual System ID. 31 | 32 | 33 | policy_path (True, str, None) 34 | path for the policy json 35 | 36 | 37 | dry_run (True, bool, None) 38 | dry\_run set to true will apply the change, wheres set to false it will only validate the changes 39 | 40 | 41 | tags (True, list, None) 42 | list of tags for the operation 43 | 44 | 45 | comments (True, str, None) 46 | comments for the operation 47 | 48 | 49 | wait_for_task (False, bool, False) 50 | Wait for task or return immediately. 51 | 52 | 53 | 54 | 55 | 56 | Notes 57 | ----- 58 | 59 | .. note:: 60 | - its advisable to perform with wait\_for\_task set to false and refer to show\_task command 61 | 62 | 63 | 64 | 65 | Examples 66 | -------- 67 | 68 | .. code-block:: yaml+jinja 69 | 70 | 71 | - name: Initial setup 72 | check_point.gaia.cp_gaia_dynamic_content: 73 | policy_path: "/home/admin/policy.json" 74 | dry_run: false 75 | tags: ["JIRA-12345", "apply layer1"] 76 | comments: "testing the api" 77 | wait_for_task: true 78 | 79 | 80 | 81 | Return Values 82 | ------------- 83 | 84 | change_summary (always., dict, ) 85 | change-summary after installing the new policy. 86 | 87 | 88 | 89 | 90 | 91 | Status 92 | ------ 93 | 94 | 95 | 96 | 97 | 98 | Authors 99 | ~~~~~~~ 100 | 101 | - Ophir Khill (@chkp-ophirk) 102 | 103 | -------------------------------------------------------------------------------- /docs/cp_gaia_dynamic_content_layer_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_dynamic_content_layer_facts_module: 2 | 3 | 4 | cp_gaia_dynamic_content_layer_facts -- getting information of the chosen dynamic layer. 5 | ======================================================================================= 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | getting information of a chosen dynamic layer. 16 | 17 | 18 | 19 | 20 | 21 | 22 | Parameters 23 | ---------- 24 | 25 | version (False, str, None) 26 | Gaia API version for example 1.6. 27 | 28 | 29 | virtual_system_id (False, int, None) 30 | Virtual System ID. 31 | 32 | 33 | name (True, str, None) 34 | dynamic layer to show 35 | 36 | 37 | wait_for_task (False, bool, True) 38 | Wait for task or return immediately. 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | Examples 49 | -------- 50 | 51 | .. code-block:: yaml+jinja 52 | 53 | 54 | - name: show dynamic layer 55 | check_point.gaia.cp_gaia_dynamic_content_layer_facts: 56 | name: dynamic_layer 57 | 58 | 59 | 60 | Return Values 61 | ------------- 62 | 63 | layer_summary (always., dict, ) 64 | the details of the installed policy on the requested layer 65 | 66 | 67 | 68 | 69 | 70 | Status 71 | ------ 72 | 73 | 74 | 75 | 76 | 77 | Authors 78 | ~~~~~~~ 79 | 80 | - Ophir Khill (@chkp-ophirk) 81 | 82 | -------------------------------------------------------------------------------- /docs/cp_gaia_dynamic_content_layers_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_dynamic_content_layers_facts_module: 2 | 3 | 4 | cp_gaia_dynamic_content_layers_facts -- get the names and meta-data of all dynamic layers. 5 | ========================================================================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | get the names and metadata of all dynamic layers 16 | 17 | 18 | 19 | 20 | 21 | 22 | Parameters 23 | ---------- 24 | 25 | version (False, str, None) 26 | Gaia API version for example 1.6. 27 | 28 | 29 | virtual_system_id (False, int, None) 30 | Virtual System ID. 31 | 32 | 33 | wait_for_task (False, bool, True) 34 | Wait for task or return immediately. 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | Examples 45 | -------- 46 | 47 | .. code-block:: yaml+jinja 48 | 49 | 50 | - name: show dynamic layers 51 | check_point.gaia.cp_gaia_dynamic_content_layers_facts: 52 | 53 | 54 | 55 | Return Values 56 | ------------- 57 | 58 | hostname (always., dict, ) 59 | the names and metadata of all dynamic layers. 60 | 61 | 62 | 63 | 64 | 65 | Status 66 | ------ 67 | 68 | 69 | 70 | 71 | 72 | Authors 73 | ~~~~~~~ 74 | 75 | - Ophir Khill (@chkp-ophirk) 76 | 77 | -------------------------------------------------------------------------------- /docs/cp_gaia_expert_password.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_expert_password_module: 2 | 3 | 4 | cp_gaia_expert_password -- Sets expert password. 5 | ================================================ 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Sets expert password. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.7 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.7. 32 | 33 | 34 | password (False, str, None) 35 | expert new password. 36 | 37 | 38 | password_hash (False, str, None) 39 | An encrypted representation of the password. 40 | 41 | 42 | virtual_system_id (False, int, None) 43 | Virtual System ID. 44 | 45 | 46 | 47 | 48 | 49 | Notes 50 | ----- 51 | 52 | .. note:: 53 | - Supports :literal:`check\_mode`. 54 | 55 | 56 | 57 | 58 | Examples 59 | -------- 60 | 61 | .. code-block:: yaml+jinja 62 | 63 | 64 | - name: Setting expert new password 65 | check_point.gaia.cp_gaia_expert_password: 66 | password: newpass 67 | 68 | 69 | 70 | Return Values 71 | ------------- 72 | 73 | expert_password (always., dict, ) 74 | The checkpoint object updated. 75 | 76 | 77 | 78 | 79 | 80 | Status 81 | ------ 82 | 83 | 84 | 85 | 86 | 87 | Authors 88 | ~~~~~~~ 89 | 90 | - Ameer Asli (@chkp-ameera) 91 | 92 | -------------------------------------------------------------------------------- /docs/cp_gaia_expert_password_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_expert_password_facts_module: 2 | 3 | 4 | cp_gaia_expert_password_facts -- Show expert hash password. 5 | =========================================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Show the expert hash password. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.7 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.7. 32 | 33 | 34 | virtual_system_id (False, int, None) 35 | Virtual System ID. 36 | 37 | 38 | 39 | 40 | 41 | Notes 42 | ----- 43 | 44 | .. note:: 45 | - Supports :literal:`check\_mode`. 46 | 47 | 48 | 49 | 50 | Examples 51 | -------- 52 | 53 | .. code-block:: yaml+jinja 54 | 55 | 56 | - name: Show expert hash password 57 | check_point.gaia.cp_gaia_expert_password_facts: 58 | 59 | 60 | 61 | Return Values 62 | ------------- 63 | 64 | ansible_facts (always., dict, ) 65 | The checkpoint object facts. 66 | 67 | 68 | password_hash (always, str, ) 69 | An encrypted representation of the password. 70 | 71 | 72 | 73 | 74 | 75 | 76 | Status 77 | ------ 78 | 79 | 80 | 81 | 82 | 83 | Authors 84 | ~~~~~~~ 85 | 86 | - Ameer Asli (@chkp-ameera) 87 | 88 | -------------------------------------------------------------------------------- /docs/cp_gaia_extended_commands_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_extended_commands_facts_module: 2 | 3 | 4 | cp_gaia_extended_commands_facts -- Show available extended commands. 5 | ==================================================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Show available extended commands. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.7 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.6. 32 | 33 | 34 | virtual_system_id (False, int, None) 35 | Virtual System ID. 36 | 37 | 38 | 39 | 40 | 41 | Notes 42 | ----- 43 | 44 | .. note:: 45 | - Supports :literal:`check\_mode`. 46 | 47 | 48 | 49 | 50 | Examples 51 | -------- 52 | 53 | .. code-block:: yaml+jinja 54 | 55 | 56 | - name: Show extended commands 57 | check_point.gaia.cp_gaia_extended_commands_facts: 58 | 59 | 60 | 61 | Return Values 62 | ------------- 63 | 64 | ansible_facts (always., dict, ) 65 | The extended commands facts. 66 | 67 | 68 | extended_commands (always, list, ) 69 | Available extended commands. 70 | 71 | 72 | name (always, str, ) 73 | Extended command name. 74 | 75 | 76 | description (always, str, ) 77 | Extended command description. 78 | 79 | 80 | path (always, str, ) 81 | Extended command path. 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | Status 90 | ------ 91 | 92 | 93 | 94 | 95 | 96 | Authors 97 | ~~~~~~~ 98 | 99 | - Ameer Asli (@chkp-ameera) 100 | 101 | -------------------------------------------------------------------------------- /docs/cp_gaia_features_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_features_facts_module: 2 | 3 | 4 | cp_gaia_features_facts -- Show available features. 5 | ================================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Show available features. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.7 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.6. 32 | 33 | 34 | virtual_system_id (False, int, None) 35 | Virtual System ID. 36 | 37 | 38 | 39 | 40 | 41 | Notes 42 | ----- 43 | 44 | .. note:: 45 | - Supports :literal:`check\_mode`. 46 | 47 | 48 | 49 | 50 | Examples 51 | -------- 52 | 53 | .. code-block:: yaml+jinja 54 | 55 | 56 | - name: Show features 57 | check_point.gaia.cp_gaia_features_facts: 58 | 59 | 60 | 61 | Return Values 62 | ------------- 63 | 64 | ansible_facts (always., dict, ) 65 | The features facts. 66 | 67 | 68 | features (always, list, ) 69 | Available features. 70 | 71 | 72 | name (always, str, ) 73 | feature name. 74 | 75 | 76 | description (always, str, ) 77 | feature description. 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | Status 86 | ------ 87 | 88 | 89 | 90 | 91 | 92 | Authors 93 | ~~~~~~~ 94 | 95 | - Ameer Asli (@chkp-ameera) 96 | 97 | -------------------------------------------------------------------------------- /docs/cp_gaia_grub_password.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_grub_password_module: 2 | 3 | 4 | cp_gaia_grub_password -- Sets GRUB password. 5 | ============================================ 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Sets GRUB password. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.7 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.7. 32 | 33 | 34 | virtual_system_id (False, int, None) 35 | Virtual System ID. 36 | 37 | 38 | password (False, str, None) 39 | GRUB new password. 40 | 41 | 42 | password_hash (False, str, None) 43 | An encrypted representation of the password. 44 | 45 | 46 | 47 | 48 | 49 | Notes 50 | ----- 51 | 52 | .. note:: 53 | - Supports :literal:`check\_mode`. 54 | 55 | 56 | 57 | 58 | Examples 59 | -------- 60 | 61 | .. code-block:: yaml+jinja 62 | 63 | 64 | - name: Setting GRUB new password 65 | check_point.gaia.cp_gaia_grub_password: 66 | password: newpass 67 | 68 | 69 | 70 | Return Values 71 | ------------- 72 | 73 | grub_password (always., dict, ) 74 | The checkpoint object updated. 75 | 76 | 77 | 78 | 79 | 80 | Status 81 | ------ 82 | 83 | 84 | 85 | 86 | 87 | Authors 88 | ~~~~~~~ 89 | 90 | - Ameer Asli (@chkp-ameera) 91 | 92 | -------------------------------------------------------------------------------- /docs/cp_gaia_grub_password_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_grub_password_facts_module: 2 | 3 | 4 | cp_gaia_grub_password_facts -- Show GRUB hash password. 5 | ======================================================= 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Show the GRUB hash password. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.7 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.7. 32 | 33 | 34 | virtual_system_id (False, int, None) 35 | Virtual System ID. 36 | 37 | 38 | 39 | 40 | 41 | Notes 42 | ----- 43 | 44 | .. note:: 45 | - Supports :literal:`check\_mode`. 46 | 47 | 48 | 49 | 50 | Examples 51 | -------- 52 | 53 | .. code-block:: yaml+jinja 54 | 55 | 56 | - name: Show GRUB hash password 57 | check_point.gaia.cp_gaia_grub_password_facts: 58 | 59 | 60 | 61 | Return Values 62 | ------------- 63 | 64 | ansible_facts (always., dict, ) 65 | The checkpoint object facts. 66 | 67 | 68 | password_hash (always, str, ) 69 | An encrypted representation of the password. 70 | 71 | 72 | 73 | 74 | 75 | 76 | Status 77 | ------ 78 | 79 | 80 | 81 | 82 | 83 | Authors 84 | ~~~~~~~ 85 | 86 | - Ameer Asli (@chkp-ameera) 87 | 88 | -------------------------------------------------------------------------------- /docs/cp_gaia_hostname.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_hostname_module: 2 | 3 | 4 | cp_gaia_hostname -- Setting the hostname of a machine. 5 | ====================================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Setting the hostname of a machine. 16 | 17 | 18 | 19 | 20 | 21 | 22 | Parameters 23 | ---------- 24 | 25 | version (False, str, None) 26 | Gaia API version for example 1.6. 27 | 28 | 29 | virtual_system_id (False, int, None) 30 | Virtual System ID. 31 | 32 | 33 | name (True, str, None) 34 | New hostname to change. Hostname can be a combination of letters and numbers, it cannot be in IP format or start/end with characters such as ''.'' And ''-''. 35 | 36 | 37 | 38 | 39 | 40 | Notes 41 | ----- 42 | 43 | .. note:: 44 | - Supports :literal:`check\_mode`. 45 | 46 | 47 | 48 | 49 | Examples 50 | -------- 51 | 52 | .. code-block:: yaml+jinja 53 | 54 | 55 | - name: Changing a hostname 56 | check_point.gaia.cp_gaia_hostname: 57 | name: new-hostname 58 | 59 | 60 | 61 | Return Values 62 | ------------- 63 | 64 | hostname (always., dict, ) 65 | The checkpoint object updated. 66 | 67 | 68 | 69 | 70 | 71 | Status 72 | ------ 73 | 74 | 75 | 76 | 77 | 78 | Authors 79 | ~~~~~~~ 80 | 81 | - Yuval Feiger (@chkp-yuvalfe) 82 | 83 | -------------------------------------------------------------------------------- /docs/cp_gaia_hostname_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_hostname_facts_module: 2 | 3 | 4 | cp_gaia_hostname_facts -- Show hostname settings. 5 | ================================================= 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Show hostname settings. 16 | 17 | 18 | 19 | 20 | 21 | 22 | Parameters 23 | ---------- 24 | 25 | version (False, str, None) 26 | Gaia API version for example 1.6. 27 | 28 | 29 | virtual_system_id (False, int, None) 30 | Virtual System ID. 31 | 32 | 33 | 34 | 35 | 36 | Notes 37 | ----- 38 | 39 | .. note:: 40 | - Supports :literal:`check\_mode`. 41 | 42 | 43 | 44 | 45 | Examples 46 | -------- 47 | 48 | .. code-block:: yaml+jinja 49 | 50 | 51 | - name: Show current hostname 52 | check_point.gaia.cp_gaia_hostname_facts: 53 | 54 | 55 | 56 | Return Values 57 | ------------- 58 | 59 | ansible_facts (always., dict, ) 60 | The checkpoint object facts. 61 | 62 | 63 | name (always, str, ) 64 | Hostname. 65 | 66 | 67 | 68 | 69 | 70 | 71 | Status 72 | ------ 73 | 74 | 75 | 76 | 77 | 78 | Authors 79 | ~~~~~~~ 80 | 81 | - Yuval Feiger (@chkp-yuvalfe) 82 | 83 | -------------------------------------------------------------------------------- /docs/cp_gaia_hostname_on_login_page.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_hostname_on_login_page_module: 2 | 3 | 4 | cp_gaia_hostname_on_login_page -- Enable/disable the hostname on login page message. 5 | ==================================================================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Setting the hostname on login page message. 16 | 17 | 18 | 19 | 20 | 21 | 22 | Parameters 23 | ---------- 24 | 25 | version (False, str, None) 26 | Gaia API version for example 1.6. 27 | 28 | 29 | virtual_system_id (False, int, None) 30 | Virtual System ID. 31 | 32 | 33 | enabled (False, bool, False) 34 | Hostname on WebUI login page enabled. 35 | 36 | 37 | 38 | 39 | 40 | Notes 41 | ----- 42 | 43 | .. note:: 44 | - Supports :literal:`check\_mode`. 45 | 46 | 47 | 48 | 49 | Examples 50 | -------- 51 | 52 | .. code-block:: yaml+jinja 53 | 54 | 55 | - hostname_on_login_page: Changing the banner message 56 | check_point.gaia.cp_gaia_hostname_on_login_page: 57 | enabled: true 58 | 59 | 60 | 61 | Return Values 62 | ------------- 63 | 64 | hostname_on_login_page (always., dict, ) 65 | The checkpoint object updated. 66 | 67 | 68 | 69 | 70 | 71 | Status 72 | ------ 73 | 74 | 75 | 76 | 77 | 78 | Authors 79 | ~~~~~~~ 80 | 81 | - Ameer Asli (@chkp-ameera) 82 | 83 | -------------------------------------------------------------------------------- /docs/cp_gaia_hostname_on_login_page_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_hostname_on_login_page_facts_module: 2 | 3 | 4 | cp_gaia_hostname_on_login_page_facts -- Show hostname\_on\_login\_page message settings. 5 | ======================================================================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Show Hostname on login page message settings. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.6 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.6. 32 | 33 | 34 | virtual_system_id (False, int, None) 35 | Virtual System ID. 36 | 37 | 38 | 39 | 40 | 41 | Notes 42 | ----- 43 | 44 | .. note:: 45 | - Supports :literal:`check\_mode`. 46 | 47 | 48 | 49 | 50 | Examples 51 | -------- 52 | 53 | .. code-block:: yaml+jinja 54 | 55 | 56 | - name: Show hostname_on_login_page message settings 57 | check_point.gaia.cp_gaia_hostname_on_login_page_facts: 58 | 59 | 60 | 61 | Return Values 62 | ------------- 63 | 64 | ansible_facts (always., dict, ) 65 | The checkpoint object facts. 66 | 67 | 68 | enabled (always, bool, ) 69 | Hostname on Gaia Portal login page enabled (true/false). 70 | 71 | 72 | 73 | 74 | 75 | 76 | Status 77 | ------ 78 | 79 | 80 | 81 | 82 | 83 | Authors 84 | ~~~~~~~ 85 | 86 | - Ameer Asli (@chkp-ameera) 87 | 88 | -------------------------------------------------------------------------------- /docs/cp_gaia_ipv6.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_ipv6_module: 2 | 3 | 4 | cp_gaia_ipv6 -- Enables/Disables IPv6 support in the machine's operating system. 5 | ================================================================================ 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Enables/Disables IPv6 support in the machine's operating system. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.6 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.6. 32 | 33 | 34 | virtual_system_id (False, int, None) 35 | Virtual System ID. 36 | 37 | 38 | enabled (False, bool, None) 39 | No Documentation available. 40 | 41 | 42 | 43 | 44 | 45 | Notes 46 | ----- 47 | 48 | .. note:: 49 | - Supports :literal:`check\_mode`. 50 | 51 | 52 | 53 | 54 | Examples 55 | -------- 56 | 57 | .. code-block:: yaml+jinja 58 | 59 | 60 | - name: Set IPv6 status 61 | check_point.gaia.cp_gaia_ipv6: 62 | enabled: true 63 | 64 | 65 | 66 | Return Values 67 | ------------- 68 | 69 | ipv6 (always., dict, ) 70 | The checkpoint object updated. 71 | 72 | 73 | 74 | 75 | 76 | Status 77 | ------ 78 | 79 | 80 | 81 | 82 | 83 | Authors 84 | ~~~~~~~ 85 | 86 | - Majd Sharkia (@chkp-majds) 87 | 88 | -------------------------------------------------------------------------------- /docs/cp_gaia_ipv6_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_ipv6_facts_module: 2 | 3 | 4 | cp_gaia_ipv6_facts -- Check IPv6 support in the machine's operating system. 5 | =========================================================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Check IPv6 support in the machine's operating system. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.6 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.6. 32 | 33 | 34 | virtual_system_id (False, int, None) 35 | Virtual System ID. 36 | 37 | 38 | 39 | 40 | 41 | Notes 42 | ----- 43 | 44 | .. note:: 45 | - Supports :literal:`check\_mode`. 46 | 47 | 48 | 49 | 50 | Examples 51 | -------- 52 | 53 | .. code-block:: yaml+jinja 54 | 55 | 56 | - name: Show IPv6 status 57 | check_point.gaia.cp_gaia_ipv6_facts: 58 | 59 | 60 | 61 | Return Values 62 | ------------- 63 | 64 | ansible_facts (always., dict, ) 65 | The checkpoint object facts. 66 | 67 | 68 | enabled (always, bool, ) 69 | Ipv6 enabled (true/false). 70 | 71 | 72 | reboot_required (always, bool, ) 73 | Notifying when reboot is required in order for the changes to take effect (Refer to 'run-reboot' API). 74 | 75 | 76 | 77 | 78 | 79 | 80 | Status 81 | ------ 82 | 83 | 84 | 85 | 86 | 87 | Authors 88 | ~~~~~~~ 89 | 90 | - Majd Sharkia (@chkp-majds) 91 | 92 | -------------------------------------------------------------------------------- /docs/cp_gaia_loopback_interface.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_loopback_interface_module: 2 | 3 | 4 | cp_gaia_loopback_interface -- Modify loopback interface. 5 | ======================================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Modify loopback interface. 16 | 17 | 18 | 19 | 20 | 21 | 22 | Parameters 23 | ---------- 24 | 25 | version (False, str, None) 26 | Gaia API version for example 1.6. 27 | 28 | 29 | virtual_system_id (False, int, None) 30 | Virtual System ID. 31 | 32 | 33 | state (False, str, present) 34 | Ansible state which can be :literal:`present` or :literal:`absent`. 35 | 36 | 37 | name (False, str, None) 38 | Interface name with format :literal:`loop\`\ , for example "loop00", "loop01" 39 | 40 | Not required when adding new loopback interface 41 | 42 | Newly-created loopback interface name returned in dict details 43 | 44 | 45 | ipv4_address (False, str, None) 46 | Interface IPv4 address. 47 | 48 | 49 | ipv4_mask_length (False, int, None) 50 | Interface IPv4 address mask length. 51 | 52 | 53 | ipv6_address (False, str, None) 54 | Interface IPv6 address. 55 | 56 | 57 | ipv6_autoconfig (False, bool, None) 58 | Configure IPv6 auto-configuration. 59 | 60 | 61 | ipv6_mask_length (False, int, None) 62 | Interface IPv6 address mask length. 63 | 64 | 65 | comments (False, str, None) 66 | Interface Comments. 67 | 68 | 69 | enabled (False, bool, None) 70 | Interface State. 71 | 72 | 73 | 74 | 75 | 76 | Notes 77 | ----- 78 | 79 | .. note:: 80 | - Supports :literal:`check\_mode`. 81 | 82 | 83 | 84 | 85 | Examples 86 | -------- 87 | 88 | .. code-block:: yaml+jinja 89 | 90 | 91 | - name: Set comment field of a loopback interface 92 | check_point.gaia.cp_gaia_loopback_interface: 93 | comments: "loop01 interface" 94 | name: loop01 95 | 96 | 97 | 98 | Return Values 99 | ------------- 100 | 101 | loopback_interface (always., dict, ) 102 | The updated interface details. 103 | 104 | 105 | 106 | 107 | 108 | Status 109 | ------ 110 | 111 | 112 | 113 | 114 | 115 | Authors 116 | ~~~~~~~ 117 | 118 | - Duane Toler (@duanetoler) 119 | 120 | -------------------------------------------------------------------------------- /docs/cp_gaia_maestro_changes.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_maestro_changes_module: 2 | 3 | 4 | cp_gaia_maestro_changes -- Handle pending changes, either apply or delete them. 5 | =============================================================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Handle pending changes, either apply or delete them. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.8 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.6. 32 | 33 | 34 | state (False, str, present) 35 | Ansible state which can be :literal:`present` or :literal:`absent`. absent will delete the pending changes, present will apply them 36 | 37 | 38 | virtual_system_id (False, int, None) 39 | Virtual System ID. 40 | 41 | 42 | 43 | 44 | 45 | Notes 46 | ----- 47 | 48 | .. note:: 49 | - Supports :literal:`check\_mode`. 50 | 51 | 52 | 53 | 54 | Examples 55 | -------- 56 | 57 | .. code-block:: yaml+jinja 58 | 59 | 60 | - name: Delete pending changes 61 | check_point.gaia.cp_gaia_user: 62 | state: absent 63 | 64 | 65 | 66 | 67 | 68 | Status 69 | ------ 70 | 71 | 72 | 73 | 74 | 75 | Authors 76 | ~~~~~~~ 77 | 78 | - Roi Tal (@chkp-roital) 79 | 80 | -------------------------------------------------------------------------------- /docs/cp_gaia_maestro_gateways.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_maestro_gateways_module: 2 | 3 | 4 | cp_gaia_maestro_gateways -- Modify Security Group Members. 5 | ========================================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Assign, re-assign or un-assign Gateways to Security Groups, and change GW descriptions. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.8 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.6. 32 | 33 | 34 | id (True, str, None) 35 | The serial of the Gateway you wish to modify 36 | 37 | 38 | security_group (False, int, None) 39 | Choose ID of Security Group to assign this Gateway to 40 | 41 | 42 | description (False, str, None) 43 | Description of this Gateway 44 | 45 | 46 | virtual_system_id (False, int, None) 47 | Virtual System ID. 48 | 49 | 50 | 51 | 52 | 53 | Notes 54 | ----- 55 | 56 | .. note:: 57 | - Supports :literal:`check\_mode`. 58 | 59 | 60 | 61 | 62 | Examples 63 | -------- 64 | 65 | .. code-block:: yaml+jinja 66 | 67 | 68 | - name: Assign GW to SG and add description 69 | check_point.gaia.cp_gaia_gateways: 70 | id: 1007RT1992 71 | security_group: 1 72 | description: "1007RT1992 GW Description" 73 | 74 | 75 | 76 | Return Values 77 | ------------- 78 | 79 | maestro_gateway (always., dict, ) 80 | The updated Maestro Gateway details. 81 | 82 | 83 | 84 | 85 | 86 | Status 87 | ------ 88 | 89 | 90 | 91 | 92 | 93 | Authors 94 | ~~~~~~~ 95 | 96 | - Roi Tal (@chkp-roital) 97 | 98 | -------------------------------------------------------------------------------- /docs/cp_gaia_maestro_ports.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_maestro_ports_module: 2 | 3 | 4 | cp_gaia_maestro_ports -- Set Port configuration. 5 | ================================================ 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Set Port configuration. Note that at least one of 'id' or 'interface-name' must be provided. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.8 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.6. 32 | 33 | 34 | id (False, str, None) 35 | Port ID (e.g. '1/13/1'). 36 | 37 | 38 | interface_name (False, str, None) 39 | Interface name in case this port is an Uplink or MGMT interface (e.g. 'eth1-25'). 40 | 41 | 42 | enabled (False, bool, None) 43 | Setting this to false will disable this port, setting to true will enable it. AKA 'admin state'. 44 | 45 | 46 | mtu (False, int, None) 47 | MTU of this port. 48 | 49 | 50 | auto_negotiation (False, bool, None) 51 | If true, Auto Negotiation will be turned on, and vice versa. 52 | 53 | 54 | qsfp_mode (False, str, None) 55 | Port QSFP mode. 56 | 57 | 58 | type (False, str, None) 59 | Port type. 60 | 61 | 62 | virtual_system_id (False, int, None) 63 | Virtual System ID. 64 | 65 | 66 | 67 | 68 | 69 | Notes 70 | ----- 71 | 72 | .. note:: 73 | - Supports :literal:`check\_mode`. 74 | 75 | 76 | 77 | 78 | Examples 79 | -------- 80 | 81 | .. code-block:: yaml+jinja 82 | 83 | 84 | - name: Change port QSFP mode 85 | check_point.gaia.cp_gaia_ports: 86 | id: 1/1/1 87 | qsfp_mode: 4x25G 88 | 89 | 90 | 91 | Return Values 92 | ------------- 93 | 94 | maestro_port (always., dict, ) 95 | The updated Port details. 96 | 97 | 98 | 99 | 100 | 101 | Status 102 | ------ 103 | 104 | 105 | 106 | 107 | 108 | Authors 109 | ~~~~~~~ 110 | 111 | - Roi Tal (@chkp-roital) 112 | 113 | -------------------------------------------------------------------------------- /docs/cp_gaia_maestro_sites.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_maestro_sites_module: 2 | 3 | 4 | cp_gaia_maestro_sites -- Set site description. 5 | ============================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Set site description. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.8 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.6. 32 | 33 | 34 | site_id (True, int, None) 35 | ID of site. 36 | 37 | 38 | descriptions (False, list, None) 39 | Provide optional site description per Security Group. 40 | 41 | 42 | security_group (optional, int, None) 43 | The Site Security Group 44 | 45 | 46 | description (optional, str, None) 47 | Site description 48 | 49 | 50 | 51 | virtual_system_id (False, int, None) 52 | Virtual System ID. 53 | 54 | 55 | 56 | 57 | 58 | Notes 59 | ----- 60 | 61 | .. note:: 62 | - Supports :literal:`check\_mode`. 63 | 64 | 65 | 66 | 67 | Examples 68 | -------- 69 | 70 | .. code-block:: yaml+jinja 71 | 72 | 73 | - name: Set site 1 description 74 | check_point.gaia.cp_gaia_sites: 75 | site_id: 1 76 | descriptions: [{security_group: 1, description: "New Description"}] 77 | 78 | 79 | 80 | Return Values 81 | ------------- 82 | 83 | maestro_site (always., dict, ) 84 | The updated site details. 85 | 86 | 87 | 88 | 89 | 90 | Status 91 | ------ 92 | 93 | 94 | 95 | 96 | 97 | Authors 98 | ~~~~~~~ 99 | 100 | - Roi Tal (@chkp-roital) 101 | 102 | -------------------------------------------------------------------------------- /docs/cp_gaia_message_of_the_day.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_message_of_the_day_module: 2 | 3 | 4 | cp_gaia_message_of_the_day -- Setting the message of the day of a machine. 5 | ========================================================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Setting message of the day. 16 | 17 | 18 | 19 | 20 | 21 | 22 | Parameters 23 | ---------- 24 | 25 | version (False, str, None) 26 | Gaia API version for example 1.6. 27 | 28 | 29 | virtual_system_id (False, int, None) 30 | Virtual System ID. 31 | 32 | 33 | msg (False, str, None) 34 | New message of the day for web, ssh and serial login. 35 | 36 | 37 | enabled (False, bool, None) 38 | Enable/Disable message of the day. 39 | 40 | 41 | 42 | 43 | 44 | Notes 45 | ----- 46 | 47 | .. note:: 48 | - Supports :literal:`check\_mode`. 49 | 50 | 51 | 52 | 53 | Examples 54 | -------- 55 | 56 | .. code-block:: yaml+jinja 57 | 58 | 59 | - message_of_the_day: Changing the message of the day 60 | check_point.gaia.cp_gaia_message_of_the_day: 61 | msg: "Hello today" 62 | 63 | 64 | 65 | Return Values 66 | ------------- 67 | 68 | message_of_the_day (always., dict, ) 69 | The checkpoint object updated. 70 | 71 | 72 | 73 | 74 | 75 | Status 76 | ------ 77 | 78 | 79 | 80 | 81 | 82 | Authors 83 | ~~~~~~~ 84 | 85 | - Ameer Asli (@chkp-ameera) 86 | 87 | -------------------------------------------------------------------------------- /docs/cp_gaia_message_of_the_day_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_message_of_the_day_facts_module: 2 | 3 | 4 | cp_gaia_message_of_the_day_facts -- Show message of the day settings. 5 | ===================================================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Show message of the day settings. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.6 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.6. 32 | 33 | 34 | virtual_system_id (False, int, None) 35 | Virtual System ID. 36 | 37 | 38 | 39 | 40 | 41 | Notes 42 | ----- 43 | 44 | .. note:: 45 | - Supports :literal:`check\_mode`. 46 | 47 | 48 | 49 | 50 | Examples 51 | -------- 52 | 53 | .. code-block:: yaml+jinja 54 | 55 | 56 | - name: Show message of the day 57 | check_point.gaia.cp_gaia_message_of_the_day_facts: 58 | 59 | 60 | 61 | Return Values 62 | ------------- 63 | 64 | ansible_facts (always., dict, ) 65 | The checkpoint object facts. 66 | 67 | 68 | enabled (always, bool, ) 69 | Message of the day enabled (true/false). 70 | 71 | 72 | message (always, str, ) 73 | Message of the day for web, ssh and serial login. 74 | 75 | 76 | 77 | 78 | 79 | 80 | Status 81 | ------ 82 | 83 | 84 | 85 | 86 | 87 | Authors 88 | ~~~~~~~ 89 | 90 | - Ameer Asli (@chkp-ameera) 91 | 92 | -------------------------------------------------------------------------------- /docs/cp_gaia_ntp.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_ntp_module: 2 | 3 | 4 | cp_gaia_ntp -- Sets NTP status and servers. 5 | =========================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Sets NTP status and servers. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.6 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.6. 32 | 33 | 34 | virtual_system_id (False, int, None) 35 | Virtual System ID. 36 | 37 | 38 | enabled (False, bool, None) 39 | NTP active status. 40 | 41 | 42 | servers (False, list, None) 43 | Servers to set. Note there cannot be more than one primary/secondary servers. 44 | 45 | 46 | version (False, int, None) 47 | NTP server version. Valid values are 1-4. 48 | 49 | 50 | type (False, str, None) 51 | Server type. 52 | 53 | 54 | address (False, str, None) 55 | Server address (IPv4/IPv6). 56 | 57 | 58 | 59 | 60 | 61 | 62 | Notes 63 | ----- 64 | 65 | .. note:: 66 | - Supports :literal:`check\_mode`. 67 | 68 | 69 | 70 | 71 | Examples 72 | -------- 73 | 74 | .. code-block:: yaml+jinja 75 | 76 | 77 | - name: Setting ntp servers for the system 78 | check_point.gaia.cp_gaia_ntp: 79 | enabled: false 80 | servers: [{"version": 1, "type": "primary", "address": "1.1.1.1"}] 81 | 82 | 83 | 84 | Return Values 85 | ------------- 86 | 87 | ntp (always., dict, ) 88 | The checkpoint object updated. 89 | 90 | 91 | 92 | 93 | 94 | Status 95 | ------ 96 | 97 | 98 | 99 | 100 | 101 | Authors 102 | ~~~~~~~ 103 | 104 | - Ameer Asli (@chkp-ameera) 105 | 106 | -------------------------------------------------------------------------------- /docs/cp_gaia_ntp_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_ntp_facts_module: 2 | 3 | 4 | cp_gaia_ntp_facts -- Show NTP settings. 5 | ======================================= 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Show the NTP state, servers(primary and secondary) and the current NTP server. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.6 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.6. 32 | 33 | 34 | virtual_system_id (False, int, None) 35 | Virtual System ID. 36 | 37 | 38 | 39 | 40 | 41 | Notes 42 | ----- 43 | 44 | .. note:: 45 | - Supports :literal:`check\_mode`. 46 | 47 | 48 | 49 | 50 | Examples 51 | -------- 52 | 53 | .. code-block:: yaml+jinja 54 | 55 | 56 | - name: Show current NTP configuration 57 | check_point.gaia.cp_gaia_ntp_facts: 58 | 59 | 60 | 61 | Return Values 62 | ------------- 63 | 64 | ansible_facts (always., dict, ) 65 | The checkpoint object facts. 66 | 67 | 68 | enabled (always, bool, ) 69 | active status. 70 | 71 | 72 | servers (always, list, ) 73 | Servers list. 74 | 75 | 76 | address (always, str, ) 77 | Ipv4-address or Ipv6-address. 78 | 79 | 80 | version (always, int, ) 81 | NTP version. 82 | 83 | 84 | type (always, str, ) 85 | NTP type. 86 | 87 | 88 | status (always, str, ) 89 | NTP status. 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | Status 98 | ------ 99 | 100 | 101 | 102 | 103 | 104 | Authors 105 | ~~~~~~~ 106 | 107 | - Ameer Asli (@chkp-ameera) 108 | 109 | -------------------------------------------------------------------------------- /docs/cp_gaia_proxy.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_proxy_module: 2 | 3 | 4 | cp_gaia_proxy -- Change proxy setting. 5 | ====================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Change proxy setting. 16 | 17 | 18 | 19 | 20 | 21 | 22 | Parameters 23 | ---------- 24 | 25 | version (False, str, None) 26 | Gaia API version for example 1.6. 27 | 28 | 29 | virtual_system_id (False, int, None) 30 | Virtual System ID. 31 | 32 | 33 | state (False, str, present) 34 | Ansible state which can be :literal:`present` or :literal:`absent`. 35 | 36 | 37 | address (False, str, None) 38 | IPv4/IPv6 address. 39 | 40 | 41 | port (False, int, None) 42 | Proxy server port. 43 | 44 | 45 | 46 | 47 | 48 | Notes 49 | ----- 50 | 51 | .. note:: 52 | - Supports :literal:`check\_mode`. 53 | 54 | 55 | 56 | 57 | Examples 58 | -------- 59 | 60 | .. code-block:: yaml+jinja 61 | 62 | 63 | - name: Set new static route 64 | check_point.gaia.cp_gaia_proxy: 65 | state: present 66 | address: 1.2.125.0 67 | port: 89 68 | 69 | 70 | 71 | Return Values 72 | ------------- 73 | 74 | proxy (always., dict, ) 75 | The checkpoint object updated. 76 | 77 | 78 | 79 | 80 | 81 | Status 82 | ------ 83 | 84 | 85 | 86 | 87 | 88 | Authors 89 | ~~~~~~~ 90 | 91 | - Ameer Asli (@chkp-ameera) 92 | 93 | -------------------------------------------------------------------------------- /docs/cp_gaia_proxy_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_proxy_facts_module: 2 | 3 | 4 | cp_gaia_proxy_facts -- Show proxy setting. 5 | ========================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Show proxy setting. 16 | 17 | 18 | 19 | 20 | 21 | 22 | Parameters 23 | ---------- 24 | 25 | version (False, str, None) 26 | Gaia API version for example 1.6. 27 | 28 | 29 | virtual_system_id (False, int, None) 30 | Virtual System ID. 31 | 32 | 33 | 34 | 35 | 36 | Notes 37 | ----- 38 | 39 | .. note:: 40 | - Supports :literal:`check\_mode`. 41 | 42 | 43 | 44 | 45 | Examples 46 | -------- 47 | 48 | .. code-block:: yaml+jinja 49 | 50 | 51 | - name: Show proxy setting 52 | check_point.gaia.cp_gaia_proxy_facts: 53 | 54 | 55 | 56 | Return Values 57 | ------------- 58 | 59 | ansible_facts (always., dict, ) 60 | The checkpoint object facts. 61 | 62 | 63 | address (always, str, ) 64 | Ipv4-address or Ipv6-address. 65 | 66 | 67 | port (always, int, ) 68 | Proxy port. 69 | 70 | 71 | 72 | 73 | 74 | 75 | Status 76 | ------ 77 | 78 | 79 | 80 | 81 | 82 | Authors 83 | ~~~~~~~ 84 | 85 | - Ameer Asli (@chkp-ameera) 86 | 87 | -------------------------------------------------------------------------------- /docs/cp_gaia_put_file.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_put_file_module: 2 | 3 | 4 | cp_gaia_put_file -- Add a new file to a Check Point machine. 5 | ============================================================ 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Add a new file to a Check Point machine. 16 | 17 | 18 | 19 | 20 | 21 | 22 | Parameters 23 | ---------- 24 | 25 | version (False, str, None) 26 | Gaia API version for example 1.6. 27 | 28 | 29 | virtual_system_id (False, int, None) 30 | Virtual System ID. 31 | 32 | 33 | file_name (True, str, None) 34 | Filename include the desired path. The file will be created in the user home directory if the full path wasn't provided. 35 | 36 | 37 | text_content (True, str, None) 38 | Content to add to the new file. 39 | 40 | 41 | override (False, bool, False) 42 | If the file already exists, indicates whether to overwrite it. Recommended value is true. Note When the value is false, if the file already exists in the system from an previous execution, it will fail. 43 | 44 | 45 | 46 | 47 | 48 | Notes 49 | ----- 50 | 51 | .. note:: 52 | - Supports :literal:`check\_mode`. 53 | 54 | 55 | 56 | 57 | Examples 58 | -------- 59 | 60 | .. code-block:: yaml+jinja 61 | 62 | 63 | - name: Add a file 64 | check_point.gaia.cp_gaia_put_file: 65 | file_name: "ansible_file.txt" 66 | text_content: "It's an ansible file." 67 | override: true 68 | 69 | 70 | 71 | Return Values 72 | ------------- 73 | 74 | put_file (always., dict, ) 75 | The checkpoint object updated. 76 | 77 | 78 | 79 | 80 | 81 | Status 82 | ------ 83 | 84 | 85 | 86 | 87 | 88 | Authors 89 | ~~~~~~~ 90 | 91 | - Yuval Feiger (@chkp-yuvalfe) 92 | 93 | -------------------------------------------------------------------------------- /docs/cp_gaia_radius_server.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_radius_server_module: 2 | 3 | 4 | cp_gaia_radius_server -- Set radius servers settings. 5 | ===================================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Set radius servers settings. 16 | 17 | 18 | 19 | 20 | 21 | 22 | Parameters 23 | ---------- 24 | 25 | version (False, str, None) 26 | Gaia API version for example 1.6. 27 | 28 | 29 | virtual_system_id (False, int, None) 30 | Virtual System ID. 31 | 32 | 33 | super_user_uid (False, str, None) 34 | The UID that will be given to a super user. 35 | 36 | 37 | default_shell (False, str, None) 38 | Default shell when login. 39 | 40 | 41 | nas_ip (False, str, None) 42 | The NAS IP for the radius client. 43 | 44 | 45 | servers (False, list, None) 46 | Radius servers list. 47 | 48 | 49 | priority (False, int, None) 50 | Search priority (lower values comes first). Valid values are -999 - 999. 51 | 52 | 53 | secret (False, str, None) 54 | Secret string. 55 | 56 | 57 | port (False, int, None) 58 | UDP port to contact on the RADIUS server. 59 | 60 | 61 | timeout (False, int, None) 62 | Valid values are 1-50. 63 | 64 | 65 | address (False, str, None) 66 | Server address. 67 | 68 | 69 | 70 | 71 | 72 | 73 | Notes 74 | ----- 75 | 76 | .. note:: 77 | - Supports :literal:`check\_mode`. 78 | 79 | 80 | 81 | 82 | Examples 83 | -------- 84 | 85 | .. code-block:: yaml+jinja 86 | 87 | 88 | - name: Change Radius server settings 89 | check_point.gaia.cp_gaia_radius_server: 90 | default_shell: cli 91 | servers: [{"priority": 3, "address": "1.2.1.2", "port": 56, "timeout": 1, "secret": "12345"}] 92 | 93 | 94 | 95 | Return Values 96 | ------------- 97 | 98 | radius (always., dict, ) 99 | The checkpoint object updated. 100 | 101 | 102 | 103 | 104 | 105 | Status 106 | ------ 107 | 108 | 109 | 110 | 111 | 112 | Authors 113 | ~~~~~~~ 114 | 115 | - Ameer Asli (@chkp-ameera) 116 | 117 | -------------------------------------------------------------------------------- /docs/cp_gaia_radius_server_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_radius_server_facts_module: 2 | 3 | 4 | cp_gaia_radius_server_facts -- Show radius servers settings. 5 | ============================================================ 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Show radius servers settings. 16 | 17 | 18 | 19 | 20 | 21 | 22 | Parameters 23 | ---------- 24 | 25 | version (False, str, None) 26 | Gaia API version for example 1.6. 27 | 28 | 29 | virtual_system_id (False, int, None) 30 | Virtual System ID. 31 | 32 | 33 | 34 | 35 | 36 | Notes 37 | ----- 38 | 39 | .. note:: 40 | - Supports :literal:`check\_mode`. 41 | 42 | 43 | 44 | 45 | Examples 46 | -------- 47 | 48 | .. code-block:: yaml+jinja 49 | 50 | 51 | - name: Show radius servers settings. 52 | check_point.gaia.cp_gaia_radius_server_facts: 53 | 54 | 55 | 56 | Return Values 57 | ------------- 58 | 59 | ansible_facts (always., dict, ) 60 | The checkpoint object facts. 61 | 62 | 63 | super_user_uid (always, str, ) 64 | The UID that will be given to a super user. 65 | 66 | 67 | default_shell (always, str, ) 68 | Default shell when login. 69 | 70 | 71 | nas_ip (always, str, ) 72 | The NAS IP for the radius client. 73 | 74 | 75 | servers (always, list, ) 76 | Radius servers list. 77 | 78 | 79 | priority (always, int, ) 80 | Search priority (lower values comes first). Valid values are -999 - 999. 81 | 82 | 83 | secret (always, str, ) 84 | Secret string. 85 | 86 | 87 | port (always, int, ) 88 | UDP port to contact on the RADIUS server. 89 | 90 | 91 | timeout (always, int, ) 92 | Valid values are 1-50. 93 | 94 | 95 | address (always, str, ) 96 | Server address. 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | Status 105 | ------ 106 | 107 | 108 | 109 | 110 | 111 | Authors 112 | ~~~~~~~ 113 | 114 | - Ameer Asli (@chkp-ameera) 115 | 116 | -------------------------------------------------------------------------------- /docs/cp_gaia_remote_syslog.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_remote_syslog_module: 2 | 3 | 4 | cp_gaia_remote_syslog -- Modify remote system log server configuration. 5 | ======================================================================= 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Modify remote system log server configuration. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.6 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.6. 32 | 33 | 34 | virtual_system_id (False, int, None) 35 | Virtual System ID. 36 | 37 | 38 | server_ip (True, str, None) 39 | No Documentation available. 40 | 41 | 42 | state (False, str, present) 43 | Ansible state which can be :literal:`present` or :literal:`absent`. 44 | 45 | 46 | protocol (False, str, None) 47 | Log protocol, Supported starting from R81.20 . 48 | 49 | 50 | port (False, str, None) 51 | Log port, Supported starting from R81.20 . 52 | 53 | 54 | level (False, str, None) 55 | No Documentation available. 56 | 57 | 58 | 59 | 60 | 61 | Notes 62 | ----- 63 | 64 | .. note:: 65 | - Supports :literal:`check\_mode`. 66 | 67 | 68 | 69 | 70 | Examples 71 | -------- 72 | 73 | .. code-block:: yaml+jinja 74 | 75 | 76 | - name: Modifying remote syslog messaging level 77 | check_point.gaia.cp_gaia_remote_syslog: 78 | server_ip: "10.11.2.130" 79 | level: "debug" 80 | 81 | 82 | 83 | Return Values 84 | ------------- 85 | 86 | remote_syslog (always., dict, ) 87 | The checkpoint object updated. 88 | 89 | 90 | 91 | 92 | 93 | Status 94 | ------ 95 | 96 | 97 | 98 | 99 | 100 | Authors 101 | ~~~~~~~ 102 | 103 | - Majd Sharkia (@chkp-majds) 104 | 105 | -------------------------------------------------------------------------------- /docs/cp_gaia_remote_syslog_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_remote_syslog_facts_module: 2 | 3 | 4 | cp_gaia_remote_syslog_facts -- Show remote system log server configuration. 5 | =========================================================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Show remote system log server configuration. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.6 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.6. 32 | 33 | 34 | virtual_system_id (False, int, None) 35 | Virtual System ID. 36 | 37 | 38 | server_ip (False, str, None) 39 | No Documentation available. 40 | 41 | 42 | 43 | 44 | 45 | Notes 46 | ----- 47 | 48 | .. note:: 49 | - Supports :literal:`check\_mode`. 50 | 51 | 52 | 53 | 54 | Examples 55 | -------- 56 | 57 | .. code-block:: yaml+jinja 58 | 59 | 60 | - name: Show remote syslog log server by specifying it IP 61 | check_point.gaia.cp_gaia_remote_syslog_facts: 62 | server_ip: "10.11.2.130" 63 | 64 | 65 | 66 | Return Values 67 | ------------- 68 | 69 | ansible_facts (always., dict, ) 70 | The checkpoint object facts. 71 | 72 | 73 | server_ip (always, str, ) 74 | No Documentation available. 75 | 76 | 77 | state (always, str, ) 78 | Ansible state which can be :literal:`present` or :literal:`absent`. 79 | 80 | 81 | protocol (always, str, ) 82 | Log protocol, Supported starting from R81.20 . 83 | 84 | 85 | port (always, str, ) 86 | Log port, Supported starting from R81.20 . 87 | 88 | 89 | level (always, str, ) 90 | No Documentation available. 91 | 92 | 93 | 94 | 95 | 96 | 97 | Status 98 | ------ 99 | 100 | 101 | 102 | 103 | 104 | Authors 105 | ~~~~~~~ 106 | 107 | - Majd Sharkia (@chkp-majds) 108 | 109 | -------------------------------------------------------------------------------- /docs/cp_gaia_role.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_role_module: 2 | 3 | 4 | cp_gaia_role -- Modify role. 5 | ============================ 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Modify role. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.7 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.6. 32 | 33 | 34 | virtual_system_id (False, int, None) 35 | Virtual System ID. 36 | 37 | 38 | state (False, str, present) 39 | Ansible state which can be :literal:`present` or :literal:`absent`. 40 | 41 | 42 | name (True, str, None) 43 | Role name. 44 | 45 | 46 | features (False, list, None) 47 | Specifies which features will be assigned to the role. 48 | 49 | 50 | name (False, str, None) 51 | Feature name. Valid values are feature name as shown in cp\_gaia\_features\_facts or :literal:`all` to specify all features. 52 | 53 | 54 | permission (False, str, None) 55 | Feature permission. Valid values are :literal:`read-write` :literal:`read-only`. 56 | 57 | 58 | 59 | extended_commands (False, list, None) 60 | Specifies which extended commands will be assigned to the role. Valid values are extended commands as shown in cp\_gaia\_extended\_commands\_facts API output. 61 | 62 | 63 | 64 | 65 | 66 | Notes 67 | ----- 68 | 69 | .. note:: 70 | - Supports :literal:`check\_mode`. 71 | 72 | 73 | 74 | 75 | Examples 76 | -------- 77 | 78 | .. code-block:: yaml+jinja 79 | 80 | 81 | - name: Add new role 82 | check_point.gaia.cp_gaia_role: 83 | name: myrole 84 | extended_commands: ['LSMenabler'] 85 | features: [{"name": "dhcp", "permission": "read-write"}, 86 | {"name": "ntp", "permission": "read-write"}, 87 | {"name": "syslog", "permission": "read-write"}, 88 | {"name": "backup", "permission": "read-only"}] 89 | 90 | 91 | 92 | Return Values 93 | ------------- 94 | 95 | role (always., dict, ) 96 | The updated role details. 97 | 98 | 99 | 100 | 101 | 102 | Status 103 | ------ 104 | 105 | 106 | 107 | 108 | 109 | Authors 110 | ~~~~~~~ 111 | 112 | - Ameer Asli (@chkp-ameera) 113 | 114 | -------------------------------------------------------------------------------- /docs/cp_gaia_role_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_role_facts_module: 2 | 3 | 4 | cp_gaia_role_facts -- Show role/s information. 5 | ============================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Show role information. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.7 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.6. 32 | 33 | 34 | virtual_system_id (False, int, None) 35 | Virtual System ID. 36 | 37 | 38 | name (False, str, None) 39 | Role name to show. If not specified, all roles information is returned. 40 | 41 | 42 | 43 | 44 | 45 | Notes 46 | ----- 47 | 48 | .. note:: 49 | - Supports :literal:`check\_mode`. 50 | 51 | 52 | 53 | 54 | Examples 55 | -------- 56 | 57 | .. code-block:: yaml+jinja 58 | 59 | 60 | - name: Show roles 61 | check_point.gaia.cp_gaia_role_facts: 62 | 63 | - name: Show role by specifying it's name 64 | check_point.gaia.cp_gaia_role_facts: 65 | name: test_role 66 | 67 | 68 | 69 | Return Values 70 | ------------- 71 | 72 | ansible_facts (always., dict, ) 73 | The checkpoint object facts. 74 | 75 | 76 | state (always, str, ) 77 | Ansible state which can be :literal:`present` or :literal:`absent`. 78 | 79 | 80 | name (always, str, ) 81 | Role name. 82 | 83 | 84 | features (always, list, ) 85 | Specifies which features will be assigned to the role. 86 | 87 | 88 | name (always, str, ) 89 | Feature name. Valid values are feature name as shown in cp\_gaia\_features\_facts or :literal:`all` to specify all features. 90 | 91 | 92 | permission (always, str, ) 93 | Feature permission. Valid values are :literal:`read-write` :literal:`read-only`. 94 | 95 | 96 | 97 | extended_commands (always, list, ) 98 | Specifies which extended commands will be assigned to the role. Valid values are extended commands as shown in cp\_gaia\_extended\_commands\_facts API output. 99 | 100 | 101 | 102 | 103 | 104 | 105 | Status 106 | ------ 107 | 108 | 109 | 110 | 111 | 112 | Authors 113 | ~~~~~~~ 114 | 115 | - Ameer Asli (@chkp-ameera) 116 | 117 | -------------------------------------------------------------------------------- /docs/cp_gaia_routes_aggregate_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_routes_aggregate_facts_module: 2 | 3 | 4 | cp_gaia_routes_aggregate_facts -- Show active Aggregate routes. 5 | =============================================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Show active Aggregate routes. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.6 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.6. 32 | 33 | 34 | virtual_system_id (False, int, None) 35 | Virtual System ID. 36 | 37 | 38 | limit (False, int, 50) 39 | The maximum number of returned results. 40 | 41 | 42 | offset (False, int, 0) 43 | The number of results to initially skip. 44 | 45 | 46 | order (False, str, ASC) 47 | Sorts the routes by either ascending or descending order. Valid values are :literal:`ASC` :literal:`DESC`. 48 | 49 | 50 | 51 | 52 | 53 | Notes 54 | ----- 55 | 56 | .. note:: 57 | - Supports :literal:`check\_mode`. 58 | 59 | 60 | 61 | 62 | Examples 63 | -------- 64 | 65 | .. code-block:: yaml+jinja 66 | 67 | 68 | - name: Show active Aggregate routes 69 | check_point.gaia.cp_gaia_routes_aggregate_facts: 70 | 71 | 72 | 73 | Return Values 74 | ------------- 75 | 76 | ansible_facts (always., dict, ) 77 | The checkpoint object facts. 78 | 79 | 80 | total (always, int, ) 81 | Total number of routes. 82 | 83 | 84 | from (always, int, ) 85 | From which route the query was done. 86 | 87 | 88 | to (always, int, ) 89 | To which route the query was done. 90 | 91 | 92 | objects (always, list, ) 93 | List of all aggregate routes. 94 | 95 | 96 | 97 | 98 | 99 | 100 | Status 101 | ------ 102 | 103 | 104 | 105 | 106 | 107 | Authors 108 | ~~~~~~~ 109 | 110 | - Ameer Asli (@chkp-ameera) 111 | 112 | -------------------------------------------------------------------------------- /docs/cp_gaia_routes_bgp_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_routes_bgp_facts_module: 2 | 3 | 4 | cp_gaia_routes_bgp_facts -- Show active BGP routes. 5 | =================================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Show active BGP routes. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.6 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.6. 32 | 33 | 34 | virtual_system_id (False, int, None) 35 | Virtual System ID. 36 | 37 | 38 | limit (False, int, 50) 39 | The maximum number of returned results. 40 | 41 | 42 | offset (False, int, 0) 43 | The number of results to initially skip. 44 | 45 | 46 | order (False, str, ASC) 47 | Sorts the routes by either ascending or descending order. Valid values are :literal:`ASC` :literal:`DESC`. 48 | 49 | 50 | 51 | 52 | 53 | Notes 54 | ----- 55 | 56 | .. note:: 57 | - Supports :literal:`check\_mode`. 58 | 59 | 60 | 61 | 62 | Examples 63 | -------- 64 | 65 | .. code-block:: yaml+jinja 66 | 67 | 68 | - name: Show active BGP routes 69 | check_point.gaia.cp_gaia_routes_bgp_facts: 70 | 71 | 72 | 73 | Return Values 74 | ------------- 75 | 76 | ansible_facts (always., dict, ) 77 | The checkpoint object facts. 78 | 79 | 80 | total (always, int, ) 81 | Total number of routes. 82 | 83 | 84 | from (always, int, ) 85 | From which route the query was done. 86 | 87 | 88 | to (always, int, ) 89 | To which route the query was done. 90 | 91 | 92 | objects (always, list, ) 93 | List of all aggregate routes. 94 | 95 | 96 | 97 | 98 | 99 | 100 | Status 101 | ------ 102 | 103 | 104 | 105 | 106 | 107 | Authors 108 | ~~~~~~~ 109 | 110 | - Ameer Asli (@chkp-ameera) 111 | 112 | -------------------------------------------------------------------------------- /docs/cp_gaia_routes_direct_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_routes_direct_facts_module: 2 | 3 | 4 | cp_gaia_routes_direct_facts -- Show active Interface routes. 5 | ============================================================= 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Show active Interface routes. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.6 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.6. 32 | 33 | 34 | virtual_system_id (False, int, None) 35 | Virtual System ID. 36 | 37 | 38 | limit (False, int, 50) 39 | The maximum number of returned results. 40 | 41 | 42 | offset (False, int, 0) 43 | The number of results to initially skip. 44 | 45 | 46 | order (False, str, ASC) 47 | Sorts the routes by either ascending or descending order. Valid values are :literal:`ASC` :literal:`DESC`. 48 | 49 | 50 | 51 | 52 | 53 | Notes 54 | ----- 55 | 56 | .. note:: 57 | - Supports :literal:`check\_mode`. 58 | 59 | 60 | 61 | 62 | Examples 63 | -------- 64 | 65 | .. code-block:: yaml+jinja 66 | 67 | 68 | - name: Show active Interface routes 69 | check_point.gaia.cp_gaia_routes_direct_facts: 70 | 71 | 72 | 73 | Return Values 74 | ------------- 75 | 76 | ansible_facts (always., dict, ) 77 | The checkpoint object facts. 78 | 79 | 80 | total (always, int, ) 81 | Total number of routes. 82 | 83 | 84 | from (always, int, ) 85 | From which route the query was done. 86 | 87 | 88 | to (always, int, ) 89 | To which route the query was done. 90 | 91 | 92 | objects (always, list, ) 93 | List of all aggregate routes. 94 | 95 | 96 | 97 | 98 | 99 | 100 | Status 101 | ------ 102 | 103 | 104 | 105 | 106 | 107 | Authors 108 | ~~~~~~~ 109 | 110 | - Ameer Asli (@chkp-ameera) 111 | 112 | -------------------------------------------------------------------------------- /docs/cp_gaia_routes_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_routes_facts_module: 2 | 3 | 4 | cp_gaia_routes_facts -- Show active routes. 5 | =========================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Show active routes. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.6 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.6. 32 | 33 | 34 | virtual_system_id (False, int, None) 35 | Virtual System ID. 36 | 37 | 38 | limit (False, int, 50) 39 | The maximum number of returned results. 40 | 41 | 42 | offset (False, int, 0) 43 | The number of results to initially skip. 44 | 45 | 46 | order (False, str, ASC) 47 | Sorts the routes by either ascending or descending order. Valid values are :literal:`ASC` :literal:`DESC`. 48 | 49 | 50 | 51 | 52 | 53 | Notes 54 | ----- 55 | 56 | .. note:: 57 | - Supports :literal:`check\_mode`. 58 | 59 | 60 | 61 | 62 | Examples 63 | -------- 64 | 65 | .. code-block:: yaml+jinja 66 | 67 | 68 | - name: Show active routes 69 | check_point.gaia.cp_gaia_routes_facts: 70 | 71 | 72 | 73 | Return Values 74 | ------------- 75 | 76 | ansible_facts (always., dict, ) 77 | The checkpoint object facts. 78 | 79 | 80 | total (always, int, ) 81 | Total number of routes. 82 | 83 | 84 | from (always, int, ) 85 | From which route the query was done. 86 | 87 | 88 | to (always, int, ) 89 | To which route the query was done. 90 | 91 | 92 | objects (always, list, ) 93 | List of all aggregate routes. 94 | 95 | 96 | virtual_system_id (always, int, ) 97 | Virtual System ID. 98 | 99 | 100 | 101 | 102 | 103 | 104 | Status 105 | ------ 106 | 107 | 108 | 109 | 110 | 111 | Authors 112 | ~~~~~~~ 113 | 114 | - Ameer Asli (@chkp-ameera) 115 | 116 | -------------------------------------------------------------------------------- /docs/cp_gaia_routes_kernel_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_routes_kernel_facts_module: 2 | 3 | 4 | cp_gaia_routes_kernel_facts -- Show active kernel routes. 5 | ========================================================= 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Show active kernel routes. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.6 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.6. 32 | 33 | 34 | virtual_system_id (False, int, None) 35 | Virtual System ID. 36 | 37 | 38 | limit (False, int, 50) 39 | The maximum number of returned results. 40 | 41 | 42 | offset (False, int, 0) 43 | The number of results to initially skip. 44 | 45 | 46 | order (False, str, ASC) 47 | Sorts the routes by either ascending or descending order. Valid values are :literal:`ASC` :literal:`DESC`. 48 | 49 | 50 | 51 | 52 | 53 | Notes 54 | ----- 55 | 56 | .. note:: 57 | - Supports :literal:`check\_mode`. 58 | 59 | 60 | 61 | 62 | Examples 63 | -------- 64 | 65 | .. code-block:: yaml+jinja 66 | 67 | 68 | - name: Show active kernel routes 69 | check_point.gaia.cp_gaia_routes_kernel_facts: 70 | 71 | 72 | 73 | Return Values 74 | ------------- 75 | 76 | ansible_facts (always., dict, ) 77 | The checkpoint object facts. 78 | 79 | 80 | 81 | 82 | 83 | Status 84 | ------ 85 | 86 | 87 | 88 | 89 | 90 | Authors 91 | ~~~~~~~ 92 | 93 | - Ameer Asli (@chkp-ameera) 94 | 95 | -------------------------------------------------------------------------------- /docs/cp_gaia_routes_ospf_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_routes_ospf_facts_module: 2 | 3 | 4 | cp_gaia_routes_ospf_facts -- Show active OSPF routes. 5 | ===================================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Show active OSPF routes. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.6 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.6. 32 | 33 | 34 | virtual_system_id (False, int, None) 35 | Virtual System ID. 36 | 37 | 38 | limit (False, int, 50) 39 | The maximum number of returned results. 40 | 41 | 42 | offset (False, int, 0) 43 | The number of results to initially skip. 44 | 45 | 46 | order (False, str, ASC) 47 | Sorts the routes by either ascending or descending order. Valid values are :literal:`ASC` :literal:`DESC`. 48 | 49 | 50 | 51 | 52 | 53 | Notes 54 | ----- 55 | 56 | .. note:: 57 | - Supports :literal:`check\_mode`. 58 | 59 | 60 | 61 | 62 | Examples 63 | -------- 64 | 65 | .. code-block:: yaml+jinja 66 | 67 | 68 | - name: Show active OSPF routes 69 | check_point.gaia.cp_gaia_routes_ospf_facts: 70 | 71 | 72 | 73 | Return Values 74 | ------------- 75 | 76 | ansible_facts (always., dict, ) 77 | The checkpoint object facts. 78 | 79 | 80 | total (always, int, ) 81 | Total number of routes. 82 | 83 | 84 | from (always, int, ) 85 | From which route the query was done. 86 | 87 | 88 | to (always, int, ) 89 | To which route the query was done. 90 | 91 | 92 | objects (always, list, ) 93 | List of all aggregate routes. 94 | 95 | 96 | virtual_systems_id (always, int, ) 97 | Virtual System ID. 98 | 99 | 100 | 101 | 102 | 103 | 104 | Status 105 | ------ 106 | 107 | 108 | 109 | 110 | 111 | Authors 112 | ~~~~~~~ 113 | 114 | - Ameer Asli (@chkp-ameera) 115 | 116 | -------------------------------------------------------------------------------- /docs/cp_gaia_routes_rip_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_routes_rip_facts_module: 2 | 3 | 4 | cp_gaia_routes_rip_facts -- Show active RIP routes. 5 | =================================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Show active RIP routes. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.6 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.6. 32 | 33 | 34 | virtual_system_id (False, int, None) 35 | Virtual System ID. 36 | 37 | 38 | limit (False, int, 50) 39 | The maximum number of returned results. 40 | 41 | 42 | offset (False, int, 0) 43 | The number of results to initially skip. 44 | 45 | 46 | order (False, str, ASC) 47 | Sorts the routes by either ascending or descending order. Valid values are :literal:`ASC` :literal:`DESC`. 48 | 49 | 50 | 51 | 52 | 53 | Notes 54 | ----- 55 | 56 | .. note:: 57 | - Supports :literal:`check\_mode`. 58 | 59 | 60 | 61 | 62 | Examples 63 | -------- 64 | 65 | .. code-block:: yaml+jinja 66 | 67 | 68 | - name: Show active RIP routes 69 | check_point.gaia.cp_gaia_routes_rip_facts: 70 | 71 | 72 | 73 | Return Values 74 | ------------- 75 | 76 | ansible_facts (always., dict, ) 77 | The checkpoint object facts. 78 | 79 | 80 | total (always, int, ) 81 | Total number of routes. 82 | 83 | 84 | from (always, int, ) 85 | From which route the query was done. 86 | 87 | 88 | to (always, int, ) 89 | To which route the query was done. 90 | 91 | 92 | objects (always, list, ) 93 | List of all aggregate routes. 94 | 95 | 96 | virtual_systems_id (always, int, ) 97 | Virtual System ID. 98 | 99 | 100 | 101 | 102 | 103 | 104 | Status 105 | ------ 106 | 107 | 108 | 109 | 110 | 111 | Authors 112 | ~~~~~~~ 113 | 114 | - Ameer Asli (@chkp-ameera) 115 | 116 | -------------------------------------------------------------------------------- /docs/cp_gaia_routes_static_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_routes_static_facts_module: 2 | 3 | 4 | cp_gaia_routes_static_facts -- Show active Static routes. 5 | ========================================================= 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Show active Static routes. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.6 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.6. 32 | 33 | 34 | virtual_system_id (False, int, None) 35 | Virtual System ID. 36 | 37 | 38 | limit (False, int, 50) 39 | The maximum number of returned results. 40 | 41 | 42 | offset (False, int, 0) 43 | The number of results to initially skip. 44 | 45 | 46 | order (False, str, ASC) 47 | Sorts the routes by either ascending or descending order. Valid values are :literal:`ASC` :literal:`DESC`. 48 | 49 | 50 | 51 | 52 | 53 | Notes 54 | ----- 55 | 56 | .. note:: 57 | - Supports :literal:`check\_mode`. 58 | 59 | 60 | 61 | 62 | Examples 63 | -------- 64 | 65 | .. code-block:: yaml+jinja 66 | 67 | 68 | - name: Show active Static routes 69 | check_point.gaia.cp_gaia_routes_static_facts: 70 | 71 | 72 | 73 | Return Values 74 | ------------- 75 | 76 | ansible_facts (always., dict, ) 77 | The checkpoint object facts. 78 | 79 | 80 | total (always, int, ) 81 | Total number of routes. 82 | 83 | 84 | from (always, int, ) 85 | From which route the query was done. 86 | 87 | 88 | to (always, int, ) 89 | To which route the query was done. 90 | 91 | 92 | objects (always, list, ) 93 | List of all aggregate routes. 94 | 95 | 96 | 97 | 98 | 99 | 100 | Status 101 | ------ 102 | 103 | 104 | 105 | 106 | 107 | Authors 108 | ~~~~~~~ 109 | 110 | - Ameer Asli (@chkp-ameera) 111 | 112 | -------------------------------------------------------------------------------- /docs/cp_gaia_run_reboot.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_run_reboot_module: 2 | 3 | 4 | cp_gaia_run_reboot -- Run reboot on Check Point machine. 5 | ======================================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Reboot Check Point machine operation. 16 | 17 | 18 | 19 | 20 | 21 | 22 | Parameters 23 | ---------- 24 | 25 | version (False, str, None) 26 | Gaia API version for example 1.6. 27 | 28 | 29 | virtual_system_id (False, int, None) 30 | Virtual System ID. 31 | 32 | 33 | wait_for_task (False, bool, True) 34 | Wait for task or return immediately. 35 | 36 | 37 | 38 | 39 | 40 | Notes 41 | ----- 42 | 43 | .. note:: 44 | - Supports :literal:`check\_mode`. 45 | 46 | 47 | 48 | 49 | Examples 50 | -------- 51 | 52 | .. code-block:: yaml+jinja 53 | 54 | 55 | - name: Run reboot 56 | check_point.gaia.cp_gaia_run_reboot: 57 | 58 | 59 | 60 | Return Values 61 | ------------- 62 | 63 | run_reboot (always., dict, ) 64 | The checkpoint object updated. 65 | 66 | 67 | 68 | 69 | 70 | Status 71 | ------ 72 | 73 | 74 | 75 | 76 | 77 | Authors 78 | ~~~~~~~ 79 | 80 | - Ameer Asli (@chkp-ameera) 81 | 82 | -------------------------------------------------------------------------------- /docs/cp_gaia_run_script.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_run_script_module: 2 | 3 | 4 | cp_gaia_run_script -- Run script Check Point machine. 5 | ===================================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Run script on Check Point machine. 16 | 17 | 18 | 19 | 20 | 21 | 22 | Parameters 23 | ---------- 24 | 25 | version (False, str, None) 26 | Gaia API version for example 1.6. 27 | 28 | 29 | virtual_system_id (False, int, None) 30 | Virtual System ID. 31 | 32 | 33 | script (True, str, None) 34 | Script body. Limited by 1300000 characters. 35 | 36 | 37 | description (False, str, None) 38 | Script description. 39 | 40 | 41 | args (False, str, None) 42 | Script arguments, separated by space character. Note don't send sensitive data on this parameter. 43 | 44 | 45 | environment_variables (False, list, None) 46 | Define environment variables to be used in the script, it's better to send sensitive data on environment variables since it's not stored. 47 | 48 | 49 | name (False, str, None) 50 | Variable's name. 51 | 52 | 53 | value (False, str, None) 54 | Variable's value. 55 | 56 | 57 | 58 | wait_for_task (False, bool, True) 59 | Wait for task or return immediately. 60 | 61 | 62 | 63 | 64 | 65 | Notes 66 | ----- 67 | 68 | .. note:: 69 | - Supports :literal:`check\_mode`. 70 | 71 | 72 | 73 | 74 | Examples 75 | -------- 76 | 77 | .. code-block:: yaml+jinja 78 | 79 | 80 | - name: Run script 81 | check_point.gaia.cp_gaia_run_script: 82 | script: "ls -la" 83 | environment_variables: [{"name": "VAR_NAME", "value": "VAR_VALUE"}] 84 | 85 | 86 | 87 | Return Values 88 | ------------- 89 | 90 | run_script (always., dict, ) 91 | The checkpoint object updated. 92 | 93 | 94 | 95 | 96 | 97 | Status 98 | ------ 99 | 100 | 101 | 102 | 103 | 104 | Authors 105 | ~~~~~~~ 106 | 107 | - Ameer Asli (@chkp-ameera) 108 | 109 | -------------------------------------------------------------------------------- /docs/cp_gaia_scheduled_job_mail.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_scheduled_job_mail_module: 2 | 3 | 4 | cp_gaia_scheduled_job_mail -- Modify scheduled job mail. 5 | ======================================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Set which e-mail address the job scheduler sends reports to. Pass empty string to delete the current e-mail address. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.7 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.6. 32 | 33 | 34 | virtual_system_id (False, int, None) 35 | Virtual System ID. 36 | 37 | 38 | email_address (True, str, None) 39 | E-mail address to send reports to. 40 | 41 | 42 | 43 | 44 | 45 | Notes 46 | ----- 47 | 48 | .. note:: 49 | - Supports :literal:`check\_mode`. 50 | 51 | 52 | 53 | 54 | Examples 55 | -------- 56 | 57 | .. code-block:: yaml+jinja 58 | 59 | 60 | - name: Set scheduled job mail 61 | check_point.gaia.cp_gaia_scheduled_job_mail: 62 | email_address: "sysadmins@company.com" 63 | 64 | 65 | 66 | Return Values 67 | ------------- 68 | 69 | scheduled_job_mail (always., dict, ) 70 | The updated scheduled job mail. 71 | 72 | 73 | 74 | 75 | 76 | Status 77 | ------ 78 | 79 | 80 | 81 | 82 | 83 | Authors 84 | ~~~~~~~ 85 | 86 | - Ameer Asli (@chkp-ameera) 87 | 88 | -------------------------------------------------------------------------------- /docs/cp_gaia_scheduled_job_mail_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_scheduled_job_mail_facts_module: 2 | 3 | 4 | cp_gaia_scheduled_job_mail_facts -- Show scheduled job mail information. 5 | ======================================================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Show scheduled job mail information. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.7 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.6. 32 | 33 | 34 | virtual_system_id (False, int, None) 35 | Virtual System ID. 36 | 37 | 38 | 39 | 40 | 41 | Notes 42 | ----- 43 | 44 | .. note:: 45 | - Supports :literal:`check\_mode`. 46 | 47 | 48 | 49 | 50 | Examples 51 | -------- 52 | 53 | .. code-block:: yaml+jinja 54 | 55 | 56 | - name: Show scheduled job mail 57 | check_point.gaia.cp_gaia_scheduled_job_mail_facts: 58 | 59 | 60 | 61 | Return Values 62 | ------------- 63 | 64 | ansible_facts (always., dict, ) 65 | The checkpoint object facts. 66 | 67 | 68 | email_address (always., str, ) 69 | E-mail address to send reports to. 70 | 71 | 72 | 73 | 74 | 75 | 76 | Status 77 | ------ 78 | 79 | 80 | 81 | 82 | 83 | Authors 84 | ~~~~~~~ 85 | 86 | - Ameer Asli (@chkp-ameera) 87 | 88 | -------------------------------------------------------------------------------- /docs/cp_gaia_snmp_custom_trap.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_snmp_custom_trap_module: 2 | 3 | 4 | cp_gaia_snmp_custom_trap -- Change the SNMP custom\_trap configuration. 5 | ======================================================================= 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Change the SNMP custom\_trap configuration. 16 | 17 | 18 | 19 | 20 | 21 | 22 | Parameters 23 | ---------- 24 | 25 | version (False, str, None) 26 | Gaia API version for example 1.6. 27 | 28 | 29 | virtual_system_id (False, int, None) 30 | Virtual System ID. 31 | 32 | 33 | state (False, str, present) 34 | Ansible state which can be :literal:`present` or :literal:`absent`. 35 | 36 | 37 | name (True, str, None) 38 | Custom trap name. 39 | 40 | 41 | oid (optional, str, None) 42 | OID (object identifier). 43 | 44 | 45 | operator (optional, str, None) 46 | Comparison operator. 47 | 48 | 49 | threshold (optional, raw, None) 50 | The value you want to compare to. 51 | 52 | 53 | frequency (optional, int, None) 54 | Polling interval in seconds. 55 | 56 | 57 | msg (optional, str, None) 58 | Custom trap message. 59 | 60 | 61 | 62 | 63 | 64 | Notes 65 | ----- 66 | 67 | .. note:: 68 | - Supports :literal:`check\_mode`. 69 | 70 | 71 | 72 | 73 | Examples 74 | -------- 75 | 76 | .. code-block:: yaml+jinja 77 | 78 | 79 | - name: Set threshold for custom trap 80 | check_point.gaia.cp_gaia_snmp_custom_trap: 81 | threshold: 12 82 | name: custom_trap_name 83 | 84 | 85 | 86 | Return Values 87 | ------------- 88 | 89 | snmp_custom_trap (always., dict, ) 90 | The updated custom trap details. 91 | 92 | 93 | 94 | 95 | 96 | Status 97 | ------ 98 | 99 | 100 | 101 | 102 | 103 | Authors 104 | ~~~~~~~ 105 | 106 | - Ameer Asli (@chkp-ameera) 107 | 108 | -------------------------------------------------------------------------------- /docs/cp_gaia_snmp_custom_trap_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_snmp_custom_trap_facts_module: 2 | 3 | 4 | cp_gaia_snmp_custom_trap_facts -- Show SNMP custom traps. 5 | ========================================================= 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Show the SNMP custom trap currently configured. 16 | 17 | 18 | 19 | 20 | 21 | 22 | Parameters 23 | ---------- 24 | 25 | version (False, str, None) 26 | Gaia API version for example 1.6. 27 | 28 | 29 | virtual_system_id (False, int, None) 30 | Virtual System ID. 31 | 32 | 33 | name (False, str, None) 34 | Custom trap name. 35 | 36 | 37 | 38 | 39 | 40 | Notes 41 | ----- 42 | 43 | .. note:: 44 | - Supports :literal:`check\_mode`. 45 | 46 | 47 | 48 | 49 | Examples 50 | -------- 51 | 52 | .. code-block:: yaml+jinja 53 | 54 | 55 | - name: Show SNMP custom trap 56 | check_point.gaia.cp_gaia_snmp_custom_trap_facts: 57 | 58 | - name: Show SNMP custom trap by specifying it's name 59 | check_point.gaia.cp_gaia_snmp_custom_trap_facts: 60 | name: custom_trap_name 61 | 62 | 63 | 64 | Return Values 65 | ------------- 66 | 67 | ansible_facts (always., dict, ) 68 | The checkpoint object facts. 69 | 70 | 71 | 72 | 73 | 74 | Status 75 | ------ 76 | 77 | 78 | 79 | 80 | 81 | Authors 82 | ~~~~~~~ 83 | 84 | - Ameer Asli (@chkp-ameera) 85 | 86 | -------------------------------------------------------------------------------- /docs/cp_gaia_snmp_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_snmp_facts_module: 2 | 3 | 4 | cp_gaia_snmp_facts -- Show snmp agent configuration. 5 | ==================================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Show snmp agent configuration. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.6 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.6. 32 | 33 | 34 | virtual_system_id (False, int, None) 35 | Virtual System ID. 36 | 37 | 38 | 39 | 40 | 41 | Notes 42 | ----- 43 | 44 | .. note:: 45 | - Supports :literal:`check\_mode`. 46 | 47 | 48 | 49 | 50 | Examples 51 | -------- 52 | 53 | .. code-block:: yaml+jinja 54 | 55 | 56 | - name: Show SNMP status 57 | check_point.gaia.cp_gaia_snmp_facts: 58 | 59 | 60 | 61 | Return Values 62 | ------------- 63 | 64 | ansible_facts (always., dict, ) 65 | The checkpoint object facts. 66 | 67 | 68 | 69 | 70 | 71 | Status 72 | ------ 73 | 74 | 75 | 76 | 77 | 78 | Authors 79 | ~~~~~~~ 80 | 81 | - Ameer Asli (@chkp-ameera) 82 | 83 | -------------------------------------------------------------------------------- /docs/cp_gaia_snmp_pre_defined_traps_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_snmp_pre_defined_traps_facts_module: 2 | 3 | 4 | cp_gaia_snmp_pre_defined_traps_facts -- Show pre-defined traps. 5 | =============================================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Show pre-defined traps. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.6 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.6. 32 | 33 | 34 | virtual_system_id (False, int, None) 35 | Virtual System ID. 36 | 37 | 38 | 39 | 40 | 41 | Notes 42 | ----- 43 | 44 | .. note:: 45 | - Supports :literal:`check\_mode`. 46 | 47 | 48 | 49 | 50 | Examples 51 | -------- 52 | 53 | .. code-block:: yaml+jinja 54 | 55 | 56 | - name: Show SNMP pre-defined traps status 57 | check_point.gaia.cp_gaia_snmp_pre_defined_traps_facts: 58 | 59 | 60 | 61 | Return Values 62 | ------------- 63 | 64 | ansible_facts (always., dict, ) 65 | The checkpoint object facts. 66 | 67 | 68 | 69 | 70 | 71 | Status 72 | ------ 73 | 74 | 75 | 76 | 77 | 78 | Authors 79 | ~~~~~~~ 80 | 81 | - Ameer Asli (@chkp-ameera) 82 | 83 | -------------------------------------------------------------------------------- /docs/cp_gaia_snmp_trap_receiver.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_snmp_trap_receiver_module: 2 | 3 | 4 | cp_gaia_snmp_trap_receiver -- Change the SNMP trap receiver configuration. 5 | ========================================================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Change the SNMP trap receiver configuration. 16 | 17 | 18 | 19 | 20 | 21 | 22 | Parameters 23 | ---------- 24 | 25 | version (False, str, None) 26 | Gaia API version for example 1.6. 27 | 28 | 29 | virtual_system_id (False, int, None) 30 | Virtual System ID. 31 | 32 | 33 | state (False, str, present) 34 | Ansible state which can be :literal:`present` or :literal:`absent`. 35 | 36 | 37 | address (True, str, None) 38 | Receiver address. 39 | 40 | 41 | ver (optional, str, None) 42 | Receiver version. 43 | 44 | 45 | community_string (optional, str, None) 46 | Receiver community - Required only in case of v1/v2 versions 47 | 48 | Trap Community String used by the trap receiver to determine which traps are accepted from a device. 49 | 50 | 51 | 52 | 53 | 54 | Notes 55 | ----- 56 | 57 | .. note:: 58 | - Supports :literal:`check\_mode`. 59 | 60 | 61 | 62 | 63 | Examples 64 | -------- 65 | 66 | .. code-block:: yaml+jinja 67 | 68 | 69 | - name: Set community string for SNMP trap receiver 70 | check_point.gaia.cp_gaia_snmp_trap_receiver: 71 | community_string: some_string 72 | address: trap_receiver_address 73 | 74 | 75 | 76 | Return Values 77 | ------------- 78 | 79 | snmp_trap_receiver (always., dict, ) 80 | The updated trap receiver details. 81 | 82 | 83 | 84 | 85 | 86 | Status 87 | ------ 88 | 89 | 90 | 91 | 92 | 93 | Authors 94 | ~~~~~~~ 95 | 96 | - Ameer Asli (@chkp-ameera) 97 | 98 | -------------------------------------------------------------------------------- /docs/cp_gaia_snmp_trap_receiver_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_snmp_trap_receiver_facts_module: 2 | 3 | 4 | cp_gaia_snmp_trap_receiver_facts -- Show snmp trap receivers. 5 | ============================================================= 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Show snmp trap receivers. 16 | 17 | 18 | 19 | 20 | 21 | 22 | Parameters 23 | ---------- 24 | 25 | version (False, str, None) 26 | Gaia API version for example 1.6. 27 | 28 | 29 | virtual_system_id (False, int, None) 30 | Virtual System ID. 31 | 32 | 33 | address (False, str, None) 34 | Receiver address. 35 | 36 | 37 | 38 | 39 | 40 | Notes 41 | ----- 42 | 43 | .. note:: 44 | - Supports :literal:`check\_mode`. 45 | 46 | 47 | 48 | 49 | Examples 50 | -------- 51 | 52 | .. code-block:: yaml+jinja 53 | 54 | 55 | - name: Show all SNMP trap receivers 56 | check_point.gaia.cp_gaia_snmp_trap_receiver_facts: 57 | 58 | - name: Show SNMP trap receiver by specifying it's address 59 | check_point.gaia.cp_gaia_snmp_trap_receiver_facts: 60 | address: receiver_address 61 | 62 | 63 | 64 | Return Values 65 | ------------- 66 | 67 | ansible_facts (always., dict, ) 68 | The checkpoint object facts. 69 | 70 | 71 | 72 | 73 | 74 | Status 75 | ------ 76 | 77 | 78 | 79 | 80 | 81 | Authors 82 | ~~~~~~~ 83 | 84 | - Ameer Asli (@chkp-ameera) 85 | 86 | -------------------------------------------------------------------------------- /docs/cp_gaia_snmp_user_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_snmp_user_facts_module: 2 | 3 | 4 | cp_gaia_snmp_user_facts -- Show SNMPv3 USM user/s. 5 | ================================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Show the SNMPv3 USM users currently configured. 16 | 17 | 18 | 19 | 20 | 21 | 22 | Parameters 23 | ---------- 24 | 25 | version (False, str, None) 26 | Gaia API version for example 1.6. 27 | 28 | 29 | virtual_system_id (False, int, None) 30 | Virtual System ID. 31 | 32 | 33 | name (False, str, None) 34 | SNMPv3 USM user name to show. If not specified, all users information is returned. 35 | 36 | 37 | 38 | 39 | 40 | Notes 41 | ----- 42 | 43 | .. note:: 44 | - Supports :literal:`check\_mode`. 45 | 46 | 47 | 48 | 49 | Examples 50 | -------- 51 | 52 | .. code-block:: yaml+jinja 53 | 54 | 55 | - name: Show SNMP users 56 | check_point.gaia.cp_gaia_snmp_user_facts: 57 | 58 | - name: Show SNMPv3 USM user by specifying it's name 59 | check_point.gaia.cp_gaia_snmp_user_facts: 60 | name: snmpuser 61 | 62 | 63 | 64 | Return Values 65 | ------------- 66 | 67 | ansible_facts (always., dict, ) 68 | The SNMPv3 USM user/s facts. 69 | 70 | 71 | objects (always, list, ) 72 | List of SNMP users. 73 | 74 | 75 | name (always, str, ) 76 | SNMPv3 USM User name. 77 | 78 | 79 | permission (always, str, ) 80 | User permission. 81 | 82 | 83 | allowed_virtual_systems (always, str, ) 84 | Configured Virtual Devices allowed for the USM user - vsid range 0-512. 85 | 86 | 87 | authentication (always, dict, ) 88 | Authentication details. 89 | 90 | 91 | protocol (always, str, ) 92 | Authentication protocol, MD5 and SHA1 are not supported starting from R81. 93 | 94 | 95 | 96 | privacy (always, dict, ) 97 | Privacy details. 98 | 99 | 100 | protocol (always, str, ) 101 | Privacy protocol. 102 | 103 | 104 | 105 | data_privacy (always, bool, ) 106 | Related to AutoPriv/AutnNoPriv in SecurityLevel in the RFC. True- AutoPriv ,False- AuthNoPriv. 107 | 108 | 109 | 110 | 111 | 112 | 113 | 114 | Status 115 | ------ 116 | 117 | 118 | 119 | 120 | 121 | Authors 122 | ~~~~~~~ 123 | 124 | - Ameer Asli (@chkp-ameera) 125 | 126 | -------------------------------------------------------------------------------- /docs/cp_gaia_ssh_server_settings_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_ssh_server_settings_facts_module: 2 | 3 | 4 | cp_gaia_ssh_server_settings_facts -- Show SSH server settings. 5 | ============================================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Show SSH server settings, request only supported on GAIA versions R81.20+. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.7 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.6. 32 | 33 | 34 | virtual_system_id (False, int, None) 35 | Virtual System ID. 36 | 37 | 38 | include_disabled_values (False, bool, False) 39 | Include disabled algorithms. 40 | 41 | 42 | 43 | 44 | 45 | Notes 46 | ----- 47 | 48 | .. note:: 49 | - Supports :literal:`check\_mode`. 50 | 51 | 52 | 53 | 54 | Examples 55 | -------- 56 | 57 | .. code-block:: yaml+jinja 58 | 59 | 60 | - name: Show SSH server settings 61 | check_point.gaia.cp_gaia_ssh_server_settings_facts: 62 | 63 | 64 | 65 | Return Values 66 | ------------- 67 | 68 | ansible_facts (always., dict, ) 69 | The checkpoint object facts. 70 | 71 | 72 | enabled_ciphers (always., list, ) 73 | Enabled ssh ciphers. 74 | 75 | 76 | enabled_mac_algorithms (always., list, ) 77 | Enabled ssh mac algorithms. 78 | 79 | 80 | enabled_kex_algorithms (always., list, ) 81 | Enabled ssh kex algorithms. 82 | 83 | 84 | 85 | 86 | 87 | 88 | Status 89 | ------ 90 | 91 | 92 | 93 | 94 | 95 | Authors 96 | ~~~~~~~ 97 | 98 | - Ameer Asli (@chkp-ameera) 99 | 100 | -------------------------------------------------------------------------------- /docs/cp_gaia_static_route_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_static_route_facts_module: 2 | 3 | 4 | cp_gaia_static_route_facts -- Show the configuration of static route. 5 | ===================================================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Show the configuration of static route. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.6 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.6. 32 | 33 | 34 | virtual_system_id (False, int, None) 35 | Virtual System ID. 36 | 37 | 38 | limit (False, int, 50) 39 | The maximum number of returned results. relevant in case facts for all routes. 40 | 41 | 42 | offset (False, int, 0) 43 | The number of results to initially skip. relevant in case facts for all routes. 44 | 45 | 46 | order (False, str, ASC) 47 | Sorts the routes by either ascending or descending order. Valid values are :literal:`ASC` :literal:`DESC`. relevant in case facts for all routes. 48 | 49 | 50 | address (False, str, None) 51 | Existing IPv4 address, required in case fact for single route. 52 | 53 | 54 | mask_length (False, int, None) 55 | Existing mask length address.Valid values are 0-32, required in case fact for single route. 56 | 57 | 58 | 59 | 60 | 61 | Notes 62 | ----- 63 | 64 | .. note:: 65 | - Supports :literal:`check\_mode`. 66 | 67 | 68 | 69 | 70 | Examples 71 | -------- 72 | 73 | .. code-block:: yaml+jinja 74 | 75 | 76 | - name: Show active static routes 77 | check_point.gaia.cp_gaia_static_route_facts: 78 | 79 | 80 | 81 | Return Values 82 | ------------- 83 | 84 | ansible_facts (always., dict, ) 85 | The checkpoint object facts. 86 | 87 | 88 | total (always, int, ) 89 | Total number of routes. 90 | 91 | 92 | from (always, int, ) 93 | From which route the query was done. 94 | 95 | 96 | to (always, int, ) 97 | To which route the query was done. 98 | 99 | 100 | objects (always, list, ) 101 | List of all aggregate routes. 102 | 103 | 104 | 105 | 106 | 107 | 108 | Status 109 | ------ 110 | 111 | 112 | 113 | 114 | 115 | Authors 116 | ~~~~~~~ 117 | 118 | - Ameer Asli (@chkp-ameera) 119 | 120 | -------------------------------------------------------------------------------- /docs/cp_gaia_syslog.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_syslog_module: 2 | 3 | 4 | cp_gaia_syslog -- Setting system logging configuration. 5 | ======================================================= 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Setting system logging configuration. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.6 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.6. 32 | 33 | 34 | virtual_system_id (False, int, None) 35 | Virtual System ID. 36 | 37 | 38 | send_to_mgmt (False, bool, None) 39 | Sending logs to Management server. 40 | 41 | 42 | cp_logs (False, bool, None) 43 | Syslog auditlog permanent. 44 | 45 | 46 | audit_log (False, bool, None) 47 | Syslog auditlog permanent. 48 | 49 | 50 | filename (False, str, None) 51 | Syslog output filename. 52 | 53 | 54 | 55 | 56 | 57 | Notes 58 | ----- 59 | 60 | .. note:: 61 | - Supports :literal:`check\_mode`. 62 | 63 | 64 | 65 | 66 | Examples 67 | -------- 68 | 69 | .. code-block:: yaml+jinja 70 | 71 | 72 | - name: Modify system logging configuration 73 | check_point.gaia.cp_gaia_syslog: 74 | send_to_mgmt: false 75 | filename: "/var/log/messages" 76 | cp_logs: false 77 | audit_log: true 78 | 79 | 80 | 81 | Return Values 82 | ------------- 83 | 84 | syslog (always., dict, ) 85 | The checkpoint object updated. 86 | 87 | 88 | 89 | 90 | 91 | Status 92 | ------ 93 | 94 | 95 | 96 | 97 | 98 | Authors 99 | ~~~~~~~ 100 | 101 | - Majd Sharkia (@chkp-majds) 102 | 103 | -------------------------------------------------------------------------------- /docs/cp_gaia_syslog_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_syslog_facts_module: 2 | 3 | 4 | cp_gaia_syslog_facts -- Show system log configuration. 5 | ====================================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Show system log configuration. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.6 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.6. 32 | 33 | 34 | virtual_system_id (False, int, None) 35 | Virtual System ID. 36 | 37 | 38 | 39 | 40 | 41 | Notes 42 | ----- 43 | 44 | .. note:: 45 | - Supports :literal:`check\_mode`. 46 | 47 | 48 | 49 | 50 | Examples 51 | -------- 52 | 53 | .. code-block:: yaml+jinja 54 | 55 | 56 | - name: Show system logging configuration 57 | check_point.gaia.cp_gaia_syslog_facts: 58 | 59 | 60 | 61 | Return Values 62 | ------------- 63 | 64 | ansible_facts (always., dict, ) 65 | The checkpoint object facts. 66 | 67 | 68 | send_to_mgmt (always., bool, ) 69 | Sending logs to Management server. 70 | 71 | 72 | cp_logs (always., bool, ) 73 | Syslog auditlog permanent. 74 | 75 | 76 | audit_log (always., bool, ) 77 | Syslog auditlog permanent. 78 | 79 | 80 | filename (always., str, ) 81 | Syslog output filename. 82 | 83 | 84 | 85 | 86 | 87 | 88 | Status 89 | ------ 90 | 91 | 92 | 93 | 94 | 95 | Authors 96 | ~~~~~~~ 97 | 98 | - Majd Sharkia (@chkp-majds) 99 | 100 | -------------------------------------------------------------------------------- /docs/cp_gaia_system_group.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_system_group_module: 2 | 3 | 4 | cp_gaia_system_group -- Change system group configuration. 5 | ========================================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Change system group configuration. 16 | 17 | 18 | 19 | 20 | 21 | 22 | Parameters 23 | ---------- 24 | 25 | version (False, str, None) 26 | Gaia API version for example 1.6. 27 | 28 | 29 | virtual_system_id (False, int, None) 30 | Virtual System ID. 31 | 32 | 33 | state (False, str, present) 34 | Ansible state which can be :literal:`present` or :literal:`absent`. 35 | 36 | 37 | name (True, str, None) 38 | System group name. 39 | 40 | 41 | gid (False, int, None) 42 | Specifies a numeric group ID used to identify the group, duplicate GIDs are not allowed. 43 | 44 | 45 | users (False, list, None) 46 | List of users in the group. 47 | 48 | 49 | 50 | 51 | 52 | Notes 53 | ----- 54 | 55 | .. note:: 56 | - Supports :literal:`check\_mode`. 57 | 58 | 59 | 60 | 61 | Examples 62 | -------- 63 | 64 | .. code-block:: yaml+jinja 65 | 66 | 67 | - name: Add new system group 68 | check_point.gaia.cp_gaia_system_group: 69 | name: new_group 70 | members: 71 | - admin 72 | 73 | 74 | 75 | Return Values 76 | ------------- 77 | 78 | group (always., dict, ) 79 | The updated group details. 80 | 81 | 82 | 83 | 84 | 85 | Status 86 | ------ 87 | 88 | 89 | 90 | 91 | 92 | Authors 93 | ~~~~~~~ 94 | 95 | - Duane Toler (@duanetoler) 96 | 97 | -------------------------------------------------------------------------------- /docs/cp_gaia_system_group_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_system_group_facts_module: 2 | 3 | 4 | cp_gaia_system_group_facts -- Show system group/s. 5 | ================================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Show the system groups currently configured. 16 | 17 | 18 | 19 | 20 | 21 | 22 | Parameters 23 | ---------- 24 | 25 | version (False, str, None) 26 | Gaia API version for example 1.6. 27 | 28 | 29 | virtual_system_id (False, int, None) 30 | Virtual System ID. 31 | 32 | 33 | name (False, str, None) 34 | System group name to show. If not specified, all system groups information is returned. 35 | 36 | 37 | 38 | 39 | 40 | Notes 41 | ----- 42 | 43 | .. note:: 44 | - Supports :literal:`check\_mode`. 45 | 46 | 47 | 48 | 49 | Examples 50 | -------- 51 | 52 | .. code-block:: yaml+jinja 53 | 54 | 55 | - name: Show system groups 56 | check_point.gaia.cp_gaia_system_group_facts: 57 | - name: Show system group by specifying it's name 58 | check_point.gaia.cp_gaia_system_group_facts: 59 | name: users 60 | 61 | 62 | 63 | Return Values 64 | ------------- 65 | 66 | ansible_facts (always., dict, ) 67 | The system group/s facts. 68 | 69 | 70 | objects (always, list, ) 71 | List of system groups. 72 | 73 | 74 | name (always, str, ) 75 | System group name. 76 | 77 | 78 | gid (always, int, ) 79 | System group GID. 80 | 81 | 82 | users (always, list, ) 83 | List of group members. 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | Status 92 | ------ 93 | 94 | 95 | 96 | 97 | 98 | Authors 99 | ~~~~~~~ 100 | 101 | - Duane Toler (@duanetoler) 102 | 103 | -------------------------------------------------------------------------------- /docs/cp_gaia_tacacs_server.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_tacacs_server_module: 2 | 3 | 4 | cp_gaia_tacacs_server -- Set TACACS servers settings. 5 | ===================================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Set TACACS servers settings. 16 | 17 | 18 | 19 | 20 | 21 | 22 | Parameters 23 | ---------- 24 | 25 | version (False, str, None) 26 | Gaia API version for example 1.6. 27 | 28 | 29 | virtual_system_id (False, int, None) 30 | Virtual System ID. 31 | 32 | 33 | super_user_uid (False, str, None) 34 | The UID that will be given to a TACACS+ user. 35 | 36 | 37 | enabled (False, bool, None) 38 | TACACS-authentication on or off. 39 | 40 | 41 | servers (False, list, None) 42 | TACACS servers list. 43 | 44 | 45 | priority (False, int, None) 46 | Search priority (lower values comes first). Valid values are -999 - 999. 47 | 48 | 49 | secret (False, str, None) 50 | Secret string. 51 | 52 | 53 | timeout (False, int, None) 54 | Valid values are 1-50. 55 | 56 | 57 | address (False, str, None) 58 | Server address. 59 | 60 | 61 | 62 | 63 | 64 | 65 | Notes 66 | ----- 67 | 68 | .. note:: 69 | - Supports :literal:`check\_mode`. 70 | 71 | 72 | 73 | 74 | Examples 75 | -------- 76 | 77 | .. code-block:: yaml+jinja 78 | 79 | 80 | - name: Change TACACS server settings 81 | check_point.gaia.cp_gaia_tacacs_server: 82 | enabled: false 83 | servers: [{"priority": 3, "address": "1.2.1.2", "port": 56, "timeout": 1, "secret": "12345"}] 84 | 85 | 86 | 87 | Return Values 88 | ------------- 89 | 90 | tacacs (always., dict, ) 91 | The checkpoint object updated. 92 | 93 | 94 | 95 | 96 | 97 | Status 98 | ------ 99 | 100 | 101 | 102 | 103 | 104 | Authors 105 | ~~~~~~~ 106 | 107 | - Ameer Asli (@chkp-ameera) 108 | 109 | -------------------------------------------------------------------------------- /docs/cp_gaia_tacacs_server_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_tacacs_server_facts_module: 2 | 3 | 4 | cp_gaia_tacacs_server_facts -- Show tacacs servers settings. 5 | ============================================================ 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Show tacacs servers settings. 16 | 17 | 18 | 19 | 20 | 21 | 22 | Parameters 23 | ---------- 24 | 25 | version (False, str, None) 26 | Gaia API version for example 1.6. 27 | 28 | 29 | virtual_system_id (False, int, None) 30 | Virtual System ID. 31 | 32 | 33 | 34 | 35 | 36 | Notes 37 | ----- 38 | 39 | .. note:: 40 | - Supports :literal:`check\_mode`. 41 | 42 | 43 | 44 | 45 | Examples 46 | -------- 47 | 48 | .. code-block:: yaml+jinja 49 | 50 | 51 | - name: Show tacacs servers settings. 52 | check_point.gaia.cp_gaia_tacacs_server_facts: 53 | 54 | 55 | 56 | Return Values 57 | ------------- 58 | 59 | ansible_facts (always., dict, ) 60 | The checkpoint object facts. 61 | 62 | 63 | super_user_uid (always, str, ) 64 | The UID that will be given to a TACACS+ user. 65 | 66 | 67 | enabled (always, bool, ) 68 | TACACS-authentication on or off. 69 | 70 | 71 | servers (always, list, ) 72 | TACACS servers list. 73 | 74 | 75 | priority (always, int, ) 76 | Search priority (lower values comes first). Valid values are -999 - 999. 77 | 78 | 79 | secret (always, str, ) 80 | Secret string. 81 | 82 | 83 | timeout (always, int, ) 84 | Valid values are 1-50. 85 | 86 | 87 | address (always, str, ) 88 | Server address. 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | Status 97 | ------ 98 | 99 | 100 | 101 | 102 | 103 | Authors 104 | ~~~~~~~ 105 | 106 | - Ameer Asli (@chkp-ameera) 107 | 108 | -------------------------------------------------------------------------------- /docs/cp_gaia_time_and_date.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_time_and_date_module: 2 | 3 | 4 | cp_gaia_time_and_date -- Show the time and date configuration. 5 | ============================================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Show the time and date configuration. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.6 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.7. 32 | 33 | 34 | virtual_system_id (False, int, None) 35 | Virtual System ID. 36 | 37 | 38 | time (False, str, None) 39 | Time to set, in HH:MM[:SS] format. 40 | 41 | 42 | date (False, str, None) 43 | Date to set, in YYYY-MM-DD format. 44 | 45 | 46 | timezone (False, str, None) 47 | Timezone in Area / Region format. See timezone list via cp\_gaia\_timezones\_facts. 48 | 49 | 50 | wait_for_task (False, bool, True) 51 | Wait for task or return immediately. 52 | 53 | 54 | 55 | 56 | 57 | Notes 58 | ----- 59 | 60 | .. note:: 61 | - Supports :literal:`check\_mode`. 62 | 63 | 64 | 65 | 66 | Examples 67 | -------- 68 | 69 | .. code-block:: yaml+jinja 70 | 71 | 72 | - name: Setting new time and date 73 | check_point.gaia.cp_gaia_time_and_date: 74 | time: newpass 75 | date: newpass 76 | timezone: newpass 77 | 78 | 79 | 80 | Return Values 81 | ------------- 82 | 83 | set_time_and_date (always., dict, ) 84 | The checkpoint object updated. 85 | 86 | 87 | 88 | 89 | 90 | Status 91 | ------ 92 | 93 | 94 | 95 | 96 | 97 | Authors 98 | ~~~~~~~ 99 | 100 | - Ameer Asli (@chkp-ameera) 101 | 102 | -------------------------------------------------------------------------------- /docs/cp_gaia_time_and_date_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_time_and_date_facts_module: 2 | 3 | 4 | cp_gaia_time_and_date_facts -- Show the time and date configuration. 5 | ==================================================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Show the time and date configuration. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.6 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.7. 32 | 33 | 34 | virtual_system_id (False, int, None) 35 | Virtual System ID. 36 | 37 | 38 | 39 | 40 | 41 | Notes 42 | ----- 43 | 44 | .. note:: 45 | - Supports :literal:`check\_mode`. 46 | 47 | 48 | 49 | 50 | Examples 51 | -------- 52 | 53 | .. code-block:: yaml+jinja 54 | 55 | 56 | - name: Show time and date configuration 57 | check_point.gaia.cp_gaia_time_and_date_facts: 58 | 59 | 60 | 61 | Return Values 62 | ------------- 63 | 64 | ansible_facts (always., dict, ) 65 | The checkpoint object facts. 66 | 67 | 68 | time (always, str, ) 69 | Time in HH:MM:SS format. 70 | 71 | 72 | date (always, str, ) 73 | Date in DD-MM-YYYY format. 74 | 75 | 76 | timezone (always, str, ) 77 | Timezone in Area/Region format. 78 | 79 | 80 | iso8601 (always, str, ) 81 | Time information in iso 8601 format. 82 | 83 | 84 | posix (always, int, ) 85 | Time information in posix format. 86 | 87 | 88 | 89 | 90 | 91 | 92 | Status 93 | ------ 94 | 95 | 96 | 97 | 98 | 99 | Authors 100 | ~~~~~~~ 101 | 102 | - Ameer Asli (@chkp-ameera) 103 | 104 | -------------------------------------------------------------------------------- /docs/cp_gaia_timezones_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_timezones_facts_module: 2 | 3 | 4 | cp_gaia_timezones_facts -- Shows available areas and regions for timezone. 5 | ========================================================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Shows available areas and regions for timezone. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.6 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.6. 32 | 33 | 34 | virtual_system_id (False, int, None) 35 | Virtual System ID. 36 | 37 | 38 | 39 | 40 | 41 | Notes 42 | ----- 43 | 44 | .. note:: 45 | - Supports :literal:`check\_mode`. 46 | 47 | 48 | 49 | 50 | Examples 51 | -------- 52 | 53 | .. code-block:: yaml+jinja 54 | 55 | 56 | - name: Show timezones 57 | check_point.gaia.cp_gaia_timezones_facts: 58 | 59 | 60 | 61 | Return Values 62 | ------------- 63 | 64 | ansible_facts (always., dict, ) 65 | The checkpoint object facts. 66 | 67 | 68 | timezones (always, list, ) 69 | List of timezones in Area / Region format. 70 | 71 | 72 | 73 | 74 | 75 | 76 | Status 77 | ------ 78 | 79 | 80 | 81 | 82 | 83 | Authors 84 | ~~~~~~~ 85 | 86 | - Ameer Asli (@chkp-ameera) 87 | 88 | -------------------------------------------------------------------------------- /docs/cp_gaia_user_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_user_facts_module: 2 | 3 | 4 | cp_gaia_user_facts -- Show user/s. 5 | ================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Show the users currently configured. 16 | 17 | 18 | 19 | 20 | 21 | 22 | Parameters 23 | ---------- 24 | 25 | version (False, str, None) 26 | Gaia API version for example 1.6. 27 | 28 | 29 | virtual_system_id (False, int, None) 30 | Virtual System ID. 31 | 32 | 33 | name (False, str, None) 34 | User name to show. If not specified, all users information is returned. 35 | 36 | 37 | 38 | 39 | 40 | Notes 41 | ----- 42 | 43 | .. note:: 44 | - Supports :literal:`check\_mode`. 45 | 46 | 47 | 48 | 49 | Examples 50 | -------- 51 | 52 | .. code-block:: yaml+jinja 53 | 54 | 55 | - name: Show users 56 | check_point.gaia.cp_gaia_user_facts: 57 | 58 | - name: Show user by specifying it's name 59 | check_point.gaia.cp_gaia_user_facts: 60 | name: admin 61 | 62 | 63 | 64 | Return Values 65 | ------------- 66 | 67 | ansible_facts (always., dict, ) 68 | The user/s facts. 69 | 70 | 71 | objects (always, list, ) 72 | List of users. 73 | 74 | 75 | name (always, str, ) 76 | User name. 77 | 78 | 79 | uid (always, int, ) 80 | User UID. 81 | 82 | 83 | homedir (always, str, ) 84 | User home directory. 85 | 86 | 87 | primary_system_group_id (always, int, ) 88 | User primary system group id. 89 | 90 | 91 | secondary_system_groups (always, list, ) 92 | User secondary system groups. 93 | 94 | 95 | real_name (always, str, ) 96 | User real name. 97 | 98 | 99 | shell (always, str, ) 100 | User shell. 101 | 102 | 103 | allow_access_using (always, list, ) 104 | The access-mechanisms available for a user. Valid values CLI, Web-UI, Gaia-API (supported from R81.10). Default [CLI, Web-UI]. 105 | 106 | 107 | must_change_password (always, bool, ) 108 | Must\_change\_password. 109 | 110 | 111 | roles (always, list, ) 112 | User roles. 113 | 114 | 115 | locked (always, bool, ) 116 | If the user has been locked out. 117 | 118 | 119 | 120 | 121 | 122 | 123 | 124 | Status 125 | ------ 126 | 127 | 128 | 129 | 130 | 131 | Authors 132 | ~~~~~~~ 133 | 134 | - Ameer Asli (@chkp-ameera) 135 | 136 | -------------------------------------------------------------------------------- /docs/cp_gaia_version_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_version_facts_module: 2 | 3 | 4 | cp_gaia_version_facts -- Show gaia version. 5 | =========================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Show gaia version. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.6 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.6. 32 | 33 | 34 | virtual_system_id (False, int, None) 35 | Virtual System ID. 36 | 37 | 38 | 39 | 40 | 41 | Notes 42 | ----- 43 | 44 | .. note:: 45 | - Supports :literal:`check\_mode`. 46 | 47 | 48 | 49 | 50 | Examples 51 | -------- 52 | 53 | .. code-block:: yaml+jinja 54 | 55 | 56 | - name: Show version 57 | check_point.gaia.cp_gaia_version_facts: 58 | 59 | 60 | 61 | Return Values 62 | ------------- 63 | 64 | ansible_facts (always., dict, ) 65 | The version facts. 66 | 67 | 68 | product_version (always, str, ) 69 | Gaia version. 70 | 71 | 72 | os_build (always, str, ) 73 | Build number. 74 | 75 | 76 | os_kernel_version (always, str, ) 77 | Gaia kernel version. 78 | 79 | 80 | os_edition (always, str, ) 81 | Gaia edition. 82 | 83 | 84 | 85 | 86 | 87 | 88 | Status 89 | ------ 90 | 91 | 92 | 93 | 94 | 95 | Authors 96 | ~~~~~~~ 97 | 98 | - Ameer Asli (@chkp-ameera) 99 | 100 | -------------------------------------------------------------------------------- /docs/cp_gaia_virtual_gateway_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_virtual_gateway_facts_module: 2 | 3 | 4 | cp_gaia_virtual_gateway_facts -- Get virtual-system objects facts on Check Point over Web Services API 5 | ====================================================================================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Get virtual-system objects facts on Check Point devices. 16 | 17 | All operations are performed over Web Services API. 18 | 19 | This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'id' to specify the virtual system id. 20 | 21 | 22 | 23 | 24 | 25 | 26 | Parameters 27 | ---------- 28 | 29 | id (optional, int, None) 30 | Virtual system ID. This parameter is relevant only for getting a specific Virtual system object. 31 | 32 | 33 | member_id (False, int, None) 34 | Member ID. 35 | 36 | 37 | version (False, str, None) 38 | Gaia API version for example 1.6. 39 | 40 | 41 | virtual_system_id (False, int, None) 42 | Virtual System ID. 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | Examples 53 | -------- 54 | 55 | .. code-block:: yaml+jinja 56 | 57 | 58 | - name: show-virtual-system 59 | cp_gaia_virtual_gateway_facts: 60 | id: 1 61 | - name: show-virtual-systems 62 | cp_gaia_virtual_gateway_facts: 63 | 64 | 65 | 66 | Return Values 67 | ------------- 68 | 69 | ansible_facts (always., dict, ) 70 | The checkpoint object facts. 71 | 72 | 73 | 74 | 75 | 76 | Status 77 | ------ 78 | 79 | 80 | 81 | 82 | 83 | Authors 84 | ~~~~~~~ 85 | 86 | - Omer Hadad (@chkp-omerhad) 87 | 88 | -------------------------------------------------------------------------------- /docs/cp_gaia_virtual_switch.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_virtual_switch_module: 2 | 3 | 4 | cp_gaia_virtual_switch -- Manages virtual switch on Check Point Gateway over Web Services API 5 | ============================================================================================= 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Manages virtual switches on Check Point gateways, including creating, updating, and removing virtual switches. 16 | 17 | All operations are performed over the Web Services API. 18 | 19 | 20 | 21 | 22 | 23 | 24 | Parameters 25 | ---------- 26 | 27 | state (False, str, present) 28 | Ansible state which can be :literal:`present` or :literal:`absent`. 29 | 30 | 31 | version (False, str, None) 32 | Gaia API version for example 1.8. 33 | 34 | 35 | wait_for_task (False, bool, True) 36 | Wait for task or return immediately. 37 | 38 | 39 | virtual_system_id (False, int, None) 40 | Virtual System ID. 41 | 42 | 43 | id (optional, str, None) 44 | Virtual Switch ID. 45 | 46 | This parameter is used to change an existing virtual switch or create a new one if it does not exist. 47 | 48 | 49 | name (optional, str, None) 50 | Name of the virtual switch. 51 | 52 | This parameter is used to change an existing virtual switch or create a new one if it does not exist. 53 | 54 | 55 | interfaces (optional, list, None) 56 | Collection of interfaces to be set, identified by their names. Replaces existing interfaces. 57 | 58 | 59 | name (optional, str, None) 60 | Interface name. 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | Examples 72 | -------- 73 | 74 | .. code-block:: yaml+jinja 75 | 76 | 77 | - name: set virtual switch 78 | check_point.gaia.cp_gaia_virtual_switch: 79 | id: 10 80 | name: AnsibleSwitch 81 | interfaces: 82 | - name: eth1-01 83 | - name: eth2.300 84 | - name: bond1.20 85 | 86 | 87 | 88 | Return Values 89 | ------------- 90 | 91 | cp_gaia_virtual_switch (always., dict, ) 92 | virtual switch creation output. 93 | 94 | 95 | 96 | 97 | 98 | Status 99 | ------ 100 | 101 | 102 | 103 | 104 | 105 | Authors 106 | ~~~~~~~ 107 | 108 | - Omer Hadad (@chkp-omerhad) 109 | 110 | -------------------------------------------------------------------------------- /docs/cp_gaia_virtual_switch_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_virtual_switch_facts_module: 2 | 3 | 4 | cp_gaia_virtual_switch_facts -- Get virtual-switch objects facts on Check Point over Web Services API 5 | ===================================================================================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Get virtual-switch objects facts on Check Point devices. 16 | 17 | All operations are performed over Web Services API. 18 | 19 | This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'id' to specify the virtual switch id. 20 | 21 | 22 | 23 | 24 | 25 | 26 | Parameters 27 | ---------- 28 | 29 | version (False, str, None) 30 | Gaia API version for example 1.8. 31 | 32 | 33 | virtual_system_id (False, int, None) 34 | Virtual System ID. 35 | 36 | 37 | id (optional, int, None) 38 | Virtual Switch ID. This parameter is relevant only for getting a specific Virtual Switch object. 39 | 40 | 41 | member_id (optional, int, None) 42 | The member on which the command is executed. 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | Examples 53 | -------- 54 | 55 | .. code-block:: yaml+jinja 56 | 57 | 58 | - name: show-virtual-switch 59 | cp_gaia_virtual_switch_facts: 60 | id: 1 61 | - name: show-virtual-switches 62 | cp_gaia_virtual_switch_facts: 63 | 64 | 65 | 66 | Return Values 67 | ------------- 68 | 69 | ansible_facts (always., dict, ) 70 | The checkpoint object facts. 71 | 72 | 73 | 74 | 75 | 76 | Status 77 | ------ 78 | 79 | 80 | 81 | 82 | 83 | Authors 84 | ~~~~~~~ 85 | 86 | - Omer Hadad (@chkp-omerhad) 87 | 88 | -------------------------------------------------------------------------------- /docs/cp_gaia_virtual_systems_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_virtual_systems_facts_module: 2 | 3 | 4 | cp_gaia_virtual_systems_facts -- Show Virtual Systems. 5 | ====================================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Show Virtual Systems. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.8 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.8. 32 | 33 | 34 | virtual_system_id (False, int, None) 35 | Virtual System ID. 36 | 37 | 38 | 39 | 40 | 41 | Notes 42 | ----- 43 | 44 | .. note:: 45 | - Supports :literal:`check\_mode`. 46 | 47 | 48 | 49 | 50 | Examples 51 | -------- 52 | 53 | .. code-block:: yaml+jinja 54 | 55 | 56 | - name: Show Virtual Systems 57 | check_point.gaia.cp_gaia_virtual_systems_facts: 58 | 59 | 60 | 61 | Return Values 62 | ------------- 63 | 64 | ansible_facts (always., dict, ) 65 | The VSNext state facts. 66 | 67 | 68 | enabled (always, bool, ) 69 | The VSNext state. 70 | 71 | 72 | session-virtual-system-id (always, int, ) 73 | The Virtual System ID of the current Gaia API session. 74 | 75 | 76 | member-id (On Scalable and Elastic XL platforms only., int, ) 77 | The member on which the command was executed. 78 | 79 | 80 | 81 | 82 | 83 | 84 | Status 85 | ------ 86 | 87 | 88 | 89 | 90 | 91 | Authors 92 | ~~~~~~~ 93 | 94 | - Omer Hadad (@chkp-omerhad) 95 | 96 | -------------------------------------------------------------------------------- /docs/cp_gaia_vsnext_state_facts.rst: -------------------------------------------------------------------------------- 1 | .. _cp_gaia_vsnext_state_facts_module: 2 | 3 | 4 | cp_gaia_vsnext_state_facts -- Show the VSNext state. 5 | ==================================================== 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | 12 | Synopsis 13 | -------- 14 | 15 | Show the VSNext state. 16 | 17 | 18 | 19 | Requirements 20 | ------------ 21 | The below requirements are needed on the host that executes this module. 22 | 23 | - supported starting from gaia\_api \>= 1.8 24 | 25 | 26 | 27 | Parameters 28 | ---------- 29 | 30 | version (False, str, None) 31 | Gaia API version for example 1.8. 32 | 33 | 34 | virtual_system_id (False, int, None) 35 | Virtual System ID. 36 | 37 | 38 | 39 | 40 | 41 | Notes 42 | ----- 43 | 44 | .. note:: 45 | - Supports :literal:`check\_mode`. 46 | 47 | 48 | 49 | 50 | Examples 51 | -------- 52 | 53 | .. code-block:: yaml+jinja 54 | 55 | 56 | - name: Show VSNext state 57 | check_point.gaia.cp_gaia_vsnext_state_facts: 58 | 59 | 60 | 61 | Return Values 62 | ------------- 63 | 64 | ansible_facts (always., dict, ) 65 | The VSNext state facts. 66 | 67 | 68 | enabled (always, bool, ) 69 | The VSNext state. 70 | 71 | 72 | session-virtual-system-id (always, int, ) 73 | The Virtual System ID of the current Gaia API session. 74 | 75 | 76 | member-id (On Scalable and Elastic XL platforms only., int, ) 77 | The member on which the command was executed. 78 | 79 | 80 | 81 | 82 | 83 | 84 | Status 85 | ------ 86 | 87 | 88 | 89 | 90 | 91 | Authors 92 | ~~~~~~~ 93 | 94 | - Omer Hadad (@chkp-omerhad) 95 | 96 | -------------------------------------------------------------------------------- /meta/runtime.yml: -------------------------------------------------------------------------------- 1 | requires_ansible: '>=2.15.0' 2 | -------------------------------------------------------------------------------- /plugins/modules/cp_gaia_diagnostics_topics_facts.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | # -*- coding: utf-8 -*- 3 | # 4 | # Ansible module to manage CheckPoint Firewall (c) 2019 5 | # 6 | # Ansible is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # Ansible is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with Ansible. If not, see . 18 | # 19 | 20 | from __future__ import (absolute_import, division, print_function) 21 | 22 | __metaclass__ = type 23 | 24 | DOCUMENTATION = """ 25 | module: cp_gaia_diagnostics_topics_facts 26 | author: Ameer Asli (@chkp-ameera) 27 | description: 28 | - Show diagnostics topics. 29 | options: 30 | version: 31 | description: Gaia API version for example 1.6. 32 | required: False 33 | type: str 34 | virtual_system_id: 35 | description: Virtual System ID. 36 | required: False 37 | type: int 38 | short_description: Show diagnostics topics. 39 | version_added: '3.0.0' 40 | notes: 41 | - Supports C(check_mode). 42 | requirements: 43 | - supported starting from gaia_api >= 1.6 44 | """ 45 | 46 | EXAMPLES = """ 47 | - name: Show diagnostics_topics 48 | check_point.gaia.cp_gaia_diagnostics_topics_facts: 49 | """ 50 | 51 | RETURN = """ 52 | ansible_facts: 53 | description: The diagnostics topics facts. 54 | returned: always. 55 | type: dict 56 | contains: 57 | os: 58 | description: The topics which are valid for show-diagnostics. 59 | returned: always 60 | type: list 61 | elements: str 62 | """ 63 | 64 | from ansible.module_utils.basic import AnsibleModule 65 | from ansible_collections.check_point.gaia.plugins.module_utils.checkpoint import chkp_facts_api_call, checkpoint_argument_spec_for_all 66 | 67 | 68 | def main(): 69 | # arguments for the module: 70 | fields = dict() 71 | fields.update(checkpoint_argument_spec_for_all) 72 | module = AnsibleModule(argument_spec=fields, supports_check_mode=True) 73 | api_call_object = 'diagnostics-topics' 74 | 75 | res = chkp_facts_api_call(module, api_call_object, False) 76 | module.exit_json(ansible_facts=res["ansible_facts"]) 77 | 78 | 79 | if __name__ == "__main__": 80 | main() 81 | -------------------------------------------------------------------------------- /plugins/modules/cp_gaia_grub_password_facts.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | # -*- coding: utf-8 -*- 3 | # 4 | # Ansible module to manage CheckPoint Firewall (c) 2019 5 | # 6 | # Ansible is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # Ansible is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with Ansible. If not, see . 18 | # 19 | 20 | from __future__ import (absolute_import, division, print_function) 21 | 22 | __metaclass__ = type 23 | 24 | 25 | DOCUMENTATION = """ 26 | author: Ameer Asli (@chkp-ameera) 27 | description: 28 | - Show the GRUB hash password. 29 | module: cp_gaia_grub_password_facts 30 | options: 31 | version: 32 | description: Gaia API version for example 1.7. 33 | required: False 34 | type: str 35 | virtual_system_id: 36 | description: Virtual System ID. 37 | required: False 38 | type: int 39 | short_description: Show GRUB hash password. 40 | version_added: '6.0.0' 41 | notes: 42 | - Supports C(check_mode). 43 | requirements: 44 | - supported starting from gaia_api >= 1.7 45 | 46 | 47 | """ 48 | 49 | 50 | EXAMPLES = """ 51 | - name: Show GRUB hash password 52 | check_point.gaia.cp_gaia_grub_password_facts: 53 | """ 54 | 55 | 56 | RETURN = """ 57 | ansible_facts: 58 | description: The checkpoint object facts. 59 | returned: always. 60 | type: dict 61 | contains: 62 | password_hash: 63 | description: An encrypted representation of the password. 64 | returned: always 65 | type: str 66 | """ 67 | 68 | 69 | from ansible.module_utils.basic import AnsibleModule 70 | from ansible_collections.check_point.gaia.plugins.module_utils.checkpoint import chkp_facts_api_call, checkpoint_argument_spec_for_all 71 | 72 | 73 | def main(): 74 | # arguments for the module: 75 | fields = dict() 76 | fields.update(checkpoint_argument_spec_for_all) 77 | module = AnsibleModule(argument_spec=fields, supports_check_mode=True) 78 | api_call_object = 'grub-password' 79 | 80 | res = chkp_facts_api_call(module, api_call_object, False) 81 | module.exit_json(ansible_facts=res["ansible_facts"]) 82 | 83 | 84 | if __name__ == "__main__": 85 | main() 86 | -------------------------------------------------------------------------------- /plugins/modules/cp_gaia_hostname.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | # -*- coding: utf-8 -*- 3 | # 4 | # Ansible module to manage CheckPoint Firewall (c) 2019 5 | # 6 | # Ansible is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # Ansible is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with Ansible. If not, see . 18 | # 19 | 20 | from __future__ import (absolute_import, division, print_function) 21 | 22 | __metaclass__ = type 23 | 24 | DOCUMENTATION = """ 25 | author: Yuval Feiger (@chkp-yuvalfe) 26 | description: 27 | - Setting the hostname of a machine. 28 | module: cp_gaia_hostname 29 | options: 30 | version: 31 | description: Gaia API version for example 1.6. 32 | required: False 33 | type: str 34 | virtual_system_id: 35 | description: Virtual System ID. 36 | required: False 37 | type: int 38 | name: 39 | description: New hostname to change. Hostname can be a combination of letters and numbers, it cannot 40 | be in IP format or start/end with characters such as ''.'' And ''-''. 41 | required: true 42 | type: str 43 | short_description: Setting the hostname of a machine. 44 | version_added: '1.0.0' 45 | notes: 46 | - Supports C(check_mode). 47 | 48 | """ 49 | 50 | EXAMPLES = """ 51 | - name: Changing a hostname 52 | check_point.gaia.cp_gaia_hostname: 53 | name: new-hostname 54 | """ 55 | 56 | RETURN = """ 57 | hostname: 58 | description: The checkpoint object updated. 59 | returned: always. 60 | type: dict 61 | """ 62 | 63 | from ansible.module_utils.basic import AnsibleModule 64 | from ansible_collections.check_point.gaia.plugins.module_utils.checkpoint import chkp_api_call, checkpoint_argument_spec_for_all 65 | 66 | 67 | def main(): 68 | # arguments for the module: 69 | fields = dict( 70 | name=dict(type='str', required=True) 71 | ) 72 | fields.update(checkpoint_argument_spec_for_all) 73 | module = AnsibleModule(argument_spec=fields, supports_check_mode=True) 74 | api_call_object = 'hostname' 75 | 76 | res = chkp_api_call(module, api_call_object, False) 77 | module.exit_json(**res) 78 | 79 | 80 | if __name__ == "__main__": 81 | main() 82 | -------------------------------------------------------------------------------- /plugins/modules/cp_gaia_hostname_facts.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | # -*- coding: utf-8 -*- 3 | # 4 | # Ansible module to manage CheckPoint Firewall (c) 2019 5 | # 6 | # Ansible is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # Ansible is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with Ansible. If not, see . 18 | # 19 | 20 | from __future__ import (absolute_import, division, print_function) 21 | 22 | __metaclass__ = type 23 | 24 | DOCUMENTATION = """ 25 | author: Yuval Feiger (@chkp-yuvalfe) 26 | description: 27 | - Show hostname settings. 28 | module: cp_gaia_hostname_facts 29 | options: 30 | version: 31 | description: Gaia API version for example 1.6. 32 | required: False 33 | type: str 34 | virtual_system_id: 35 | description: Virtual System ID. 36 | required: False 37 | type: int 38 | short_description: Show hostname settings. 39 | version_added: '1.0.0' 40 | notes: 41 | - Supports C(check_mode). 42 | 43 | """ 44 | 45 | EXAMPLES = """ 46 | - name: Show current hostname 47 | check_point.gaia.cp_gaia_hostname_facts: 48 | """ 49 | 50 | RETURN = """ 51 | ansible_facts: 52 | description: The checkpoint object facts. 53 | returned: always. 54 | type: dict 55 | contains: 56 | name: 57 | description: Hostname. 58 | returned: always 59 | type: str 60 | """ 61 | 62 | from ansible.module_utils.basic import AnsibleModule 63 | from ansible_collections.check_point.gaia.plugins.module_utils.checkpoint import chkp_facts_api_call, checkpoint_argument_spec_for_all 64 | 65 | 66 | def main(): 67 | # arguments for the module: 68 | fields = dict() 69 | fields.update(checkpoint_argument_spec_for_all) 70 | module = AnsibleModule(argument_spec=fields, supports_check_mode=True) 71 | api_call_object = "hostname" 72 | 73 | res = chkp_facts_api_call(module, api_call_object, False) 74 | module.exit_json(ansible_facts=res["ansible_facts"]) 75 | 76 | 77 | if __name__ == "__main__": 78 | main() 79 | -------------------------------------------------------------------------------- /plugins/modules/cp_gaia_ipv6.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | # -*- coding: utf-8 -*- 3 | # 4 | # Ansible module to manage CheckPoint Firewall (c) 2019 5 | # 6 | # Ansible is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # Ansible is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with Ansible. If not, see . 18 | # 19 | 20 | from __future__ import (absolute_import, division, print_function) 21 | 22 | __metaclass__ = type 23 | 24 | 25 | DOCUMENTATION = """ 26 | author: Majd Sharkia (@chkp-majds) 27 | description: 28 | - Enables/Disables IPv6 support in the machine's operating system. 29 | module: cp_gaia_ipv6 30 | short_description: Enables/Disables IPv6 support in the machine's operating system. 31 | version_added: '2.0.0' 32 | notes: 33 | - Supports C(check_mode). 34 | requirements: 35 | - supported starting from gaia_api >= 1.6 36 | options: 37 | version: 38 | description: Gaia API version for example 1.6. 39 | required: False 40 | type: str 41 | virtual_system_id: 42 | description: Virtual System ID. 43 | required: False 44 | type: int 45 | enabled: 46 | description: No Documentation available. 47 | required: False 48 | type: bool 49 | 50 | """ 51 | 52 | 53 | EXAMPLES = """ 54 | - name: Set IPv6 status 55 | check_point.gaia.cp_gaia_ipv6: 56 | enabled: true 57 | """ 58 | 59 | 60 | RETURN = """ 61 | ipv6: 62 | description: The checkpoint object updated. 63 | returned: always. 64 | type: dict 65 | """ 66 | 67 | 68 | from ansible.module_utils.basic import AnsibleModule 69 | from ansible_collections.check_point.gaia.plugins.module_utils.checkpoint import chkp_api_call, checkpoint_argument_spec_for_all 70 | 71 | 72 | def main(): 73 | # arguments for the module: 74 | fields = dict( 75 | enabled=dict(type="bool") 76 | ) 77 | fields.update(checkpoint_argument_spec_for_all) 78 | module = AnsibleModule(argument_spec=fields, supports_check_mode=True) 79 | api_call_object = 'ipv6' 80 | 81 | res = chkp_api_call(module, api_call_object, False) 82 | module.exit_json(**res) 83 | 84 | 85 | if __name__ == "__main__": 86 | main() 87 | -------------------------------------------------------------------------------- /plugins/modules/cp_gaia_proxy_facts.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | # -*- coding: utf-8 -*- 3 | # 4 | # Ansible module to manage CheckPoint Firewall (c) 2019 5 | # 6 | # Ansible is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # Ansible is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with Ansible. If not, see . 18 | # 19 | 20 | from __future__ import (absolute_import, division, print_function) 21 | 22 | __metaclass__ = type 23 | 24 | 25 | DOCUMENTATION = """ 26 | author: Ameer Asli (@chkp-ameera) 27 | description: 28 | - Show proxy setting. 29 | module: cp_gaia_proxy_facts 30 | options: 31 | version: 32 | description: Gaia API version for example 1.6. 33 | required: False 34 | type: str 35 | virtual_system_id: 36 | description: Virtual System ID. 37 | required: False 38 | type: int 39 | short_description: Show proxy setting. 40 | version_added: '3.0.0' 41 | notes: 42 | - Supports C(check_mode). 43 | """ 44 | 45 | 46 | EXAMPLES = """ 47 | - name: Show proxy setting 48 | check_point.gaia.cp_gaia_proxy_facts: 49 | """ 50 | 51 | 52 | RETURN = """ 53 | ansible_facts: 54 | description: The checkpoint object facts. 55 | returned: always. 56 | type: dict 57 | contains: 58 | address: 59 | description: Ipv4-address or Ipv6-address. 60 | returned: always 61 | type: str 62 | port: 63 | description: Proxy port. 64 | returned: always 65 | type: int 66 | """ 67 | 68 | 69 | from ansible.module_utils.basic import AnsibleModule 70 | from ansible_collections.check_point.gaia.plugins.module_utils.checkpoint import chkp_facts_api_call, checkpoint_argument_spec_for_all 71 | 72 | 73 | def main(): 74 | # arguments for the module: 75 | fields = dict() 76 | fields.update(checkpoint_argument_spec_for_all) 77 | module = AnsibleModule(argument_spec=fields, supports_check_mode=True) 78 | 79 | api_call_object = 'proxy' 80 | 81 | res = chkp_facts_api_call(module, api_call_object, False) 82 | module.exit_json(ansible_facts=res["ansible_facts"]) 83 | 84 | 85 | if __name__ == "__main__": 86 | main() 87 | -------------------------------------------------------------------------------- /plugins/modules/cp_gaia_scheduled_job_mail_facts.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | # -*- coding: utf-8 -*- 3 | # 4 | # Ansible module to manage CheckPoint Firewall (c) 2019 5 | # 6 | # Ansible is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # Ansible is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with Ansible. If not, see . 18 | # 19 | 20 | from __future__ import (absolute_import, division, print_function) 21 | 22 | __metaclass__ = type 23 | 24 | DOCUMENTATION = """ 25 | module: cp_gaia_scheduled_job_mail_facts 26 | author: Ameer Asli (@chkp-ameera) 27 | description: 28 | - Show scheduled job mail information. 29 | options: 30 | version: 31 | description: Gaia API version for example 1.6. 32 | required: False 33 | type: str 34 | virtual_system_id: 35 | description: Virtual System ID. 36 | required: False 37 | type: int 38 | short_description: Show scheduled job mail information. 39 | version_added: '3.0.0' 40 | notes: 41 | - Supports C(check_mode). 42 | requirements: 43 | - supported starting from gaia_api >= 1.7 44 | """ 45 | 46 | EXAMPLES = """ 47 | - name: Show scheduled job mail 48 | check_point.gaia.cp_gaia_scheduled_job_mail_facts: 49 | """ 50 | 51 | RETURN = """ 52 | ansible_facts: 53 | description: The checkpoint object facts. 54 | returned: always. 55 | type: dict 56 | contains: 57 | email_address: 58 | description: E-mail address to send reports to. 59 | returned: always. 60 | type: str 61 | """ 62 | 63 | from ansible.module_utils.basic import AnsibleModule 64 | from ansible_collections.check_point.gaia.plugins.module_utils.checkpoint import chkp_facts_api_call, checkpoint_argument_spec_for_all 65 | 66 | 67 | def main(): 68 | # arguments for the module: 69 | fields = dict() 70 | fields.update(checkpoint_argument_spec_for_all) 71 | module = AnsibleModule(argument_spec=fields, supports_check_mode=True) 72 | api_call_object = 'scheduled-job-mail' 73 | 74 | res = chkp_facts_api_call(module, api_call_object, False) 75 | module.exit_json(ansible_facts=res["ansible_facts"]) 76 | 77 | 78 | if __name__ == "__main__": 79 | main() 80 | -------------------------------------------------------------------------------- /plugins/modules/cp_gaia_snmp_facts.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | # -*- coding: utf-8 -*- 3 | # 4 | # Ansible module to manage CheckPoint Firewall (c) 2019 5 | # 6 | # Ansible is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # Ansible is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with Ansible. If not, see . 18 | # 19 | 20 | from __future__ import (absolute_import, division, print_function) 21 | 22 | __metaclass__ = type 23 | 24 | 25 | DOCUMENTATION = """ 26 | author: Ameer Asli (@chkp-ameera) 27 | description: 28 | - Show snmp agent configuration. 29 | module: cp_gaia_snmp_facts 30 | short_description: Show snmp agent configuration. 31 | version_added: '6.0.0' 32 | notes: 33 | - Supports C(check_mode). 34 | requirements: 35 | - supported starting from gaia_api >= 1.6 36 | options: 37 | version: 38 | description: Gaia API version for example 1.6. 39 | required: False 40 | type: str 41 | virtual_system_id: 42 | description: Virtual System ID. 43 | required: False 44 | type: int 45 | """ 46 | 47 | 48 | EXAMPLES = """ 49 | - name: Show SNMP status 50 | check_point.gaia.cp_gaia_snmp_facts: 51 | """ 52 | 53 | 54 | RETURN = """ 55 | ansible_facts: 56 | description: The checkpoint object facts. 57 | returned: always. 58 | type: dict 59 | """ 60 | 61 | 62 | from ansible.module_utils.basic import AnsibleModule 63 | from ansible_collections.check_point.gaia.plugins.module_utils.checkpoint import chkp_facts_api_call, checkpoint_argument_spec_for_all 64 | 65 | 66 | def main(): 67 | # arguments for the module: 68 | fields = dict() 69 | fields.update(checkpoint_argument_spec_for_all) 70 | module = AnsibleModule(argument_spec=fields, supports_check_mode=True) 71 | api_call_object = 'snmp' 72 | 73 | res = chkp_facts_api_call(module, api_call_object, False) 74 | module.exit_json(ansible_facts=res["ansible_facts"]) 75 | 76 | 77 | if __name__ == "__main__": 78 | main() 79 | -------------------------------------------------------------------------------- /plugins/modules/cp_gaia_snmp_pre_defined_traps_facts.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | # -*- coding: utf-8 -*- 3 | # 4 | # Ansible module to manage CheckPoint Firewall (c) 2019 5 | # 6 | # Ansible is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # Ansible is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with Ansible. If not, see . 18 | # 19 | 20 | from __future__ import (absolute_import, division, print_function) 21 | 22 | __metaclass__ = type 23 | 24 | 25 | DOCUMENTATION = """ 26 | author: Ameer Asli (@chkp-ameera) 27 | description: 28 | - Show pre-defined traps. 29 | module: cp_gaia_snmp_pre_defined_traps_facts 30 | short_description: Show pre-defined traps. 31 | version_added: '6.0.0' 32 | notes: 33 | - Supports C(check_mode). 34 | requirements: 35 | - supported starting from gaia_api >= 1.6 36 | options: 37 | version: 38 | description: Gaia API version for example 1.6. 39 | required: False 40 | type: str 41 | virtual_system_id: 42 | description: Virtual System ID. 43 | required: False 44 | type: int 45 | """ 46 | 47 | 48 | EXAMPLES = """ 49 | - name: Show SNMP pre-defined traps status 50 | check_point.gaia.cp_gaia_snmp_pre_defined_traps_facts: 51 | """ 52 | 53 | 54 | RETURN = """ 55 | ansible_facts: 56 | description: The checkpoint object facts. 57 | returned: always. 58 | type: dict 59 | """ 60 | 61 | 62 | from ansible.module_utils.basic import AnsibleModule 63 | from ansible_collections.check_point.gaia.plugins.module_utils.checkpoint import chkp_facts_api_call, checkpoint_argument_spec_for_all 64 | 65 | 66 | def main(): 67 | # arguments for the module: 68 | fields = dict() 69 | fields.update(checkpoint_argument_spec_for_all) 70 | module = AnsibleModule(argument_spec=fields, supports_check_mode=True) 71 | api_call_object = 'snmp-pre-defined-traps' 72 | 73 | res = chkp_facts_api_call(module, api_call_object, False) 74 | module.exit_json(ansible_facts=res["ansible_facts"]) 75 | 76 | 77 | if __name__ == "__main__": 78 | main() 79 | -------------------------------------------------------------------------------- /tests/unit/modules/test_cp_gaia_banner_facts.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # Ansible module to manage CheckPoint Firewall (c) 2019 3 | # 4 | # Ansible is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # Ansible is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU General Public License 15 | # along with Ansible. If not, see . 16 | # 17 | 18 | from __future__ import absolute_import, division, print_function 19 | __metaclass__ = type 20 | import pytest 21 | from units.modules.utils import set_module_args, exit_json, fail_json, AnsibleExitJson 22 | from ansible.module_utils import basic 23 | from ansible_collections.check_point.gaia.plugins.modules import cp_gaia_banner_facts 24 | 25 | EXPECTED_RESULT = { 26 | 'enabled': True, 27 | 'message': 'This system is for authorized use only.' 28 | } 29 | 30 | PAYLOAD = {} 31 | 32 | function_path = 'ansible_collections.check_point.gaia.plugins.modules.cp_gaia_banner_facts.chkp_facts_api_call' 33 | api_call_object = 'banner' 34 | 35 | 36 | class TestCheckpointBannerFacts(object): 37 | module = cp_gaia_banner_facts 38 | 39 | @pytest.fixture(autouse=True) 40 | def module_mock(self, mocker): 41 | return mocker.patch.multiple(basic.AnsibleModule, exit_json=exit_json, fail_json=fail_json) 42 | 43 | @pytest.fixture 44 | def connection_mock(self, mocker): 45 | connection_class_mock = mocker.patch('ansible.module_utils.network.checkpoint.checkpoint.Connection') 46 | return connection_class_mock.return_value 47 | 48 | def test_facts(self, mocker, connection_mock): 49 | mock_function = mocker.patch(function_path) 50 | mock_function.side_effect = [{ 51 | "changed": False, 52 | api_call_object: EXPECTED_RESULT 53 | } 54 | ] 55 | result = self._run_module(PAYLOAD) 56 | assert not result['changed'] 57 | assert EXPECTED_RESULT.items() == result['ansible_facts'].items() 58 | 59 | def _run_module(self, module_args): 60 | set_module_args(module_args) 61 | with pytest.raises(AnsibleExitJson) as ex: 62 | self.module.main() 63 | return ex.value.args[0] 64 | -------------------------------------------------------------------------------- /tests/unit/modules/test_cp_gaia_bond_interface_facts.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # Ansible module to manage CheckPoint Firewall (c) 2019 3 | # 4 | # Ansible is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # Ansible is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU General Public License 15 | # along with Ansible. If not, see . 16 | # 17 | 18 | from __future__ import absolute_import, division, print_function 19 | __metaclass__ = type 20 | import pytest 21 | from units.modules.utils import set_module_args, exit_json, fail_json, AnsibleExitJson 22 | from ansible.module_utils import basic 23 | from ansible_collections.check_point.gaia.plugins.modules import cp_gaia_bond_interface_facts 24 | 25 | EXPECTED_RESULT = { 26 | 'objects': [] 27 | } 28 | 29 | PAYLOAD = {} 30 | 31 | function_path = 'ansible_collections.check_point.gaia.plugins.modules.cp_gaia_bond_interface_facts.chkp_facts_api_call' 32 | api_call_object = 'bond-interface' 33 | 34 | 35 | class TestCheckpointBondInterfaceFacts(object): 36 | module = cp_gaia_bond_interface_facts 37 | 38 | @pytest.fixture(autouse=True) 39 | def module_mock(self, mocker): 40 | return mocker.patch.multiple(basic.AnsibleModule, exit_json=exit_json, fail_json=fail_json) 41 | 42 | @pytest.fixture 43 | def connection_mock(self, mocker): 44 | connection_class_mock = mocker.patch('ansible.module_utils.network.checkpoint.checkpoint.Connection') 45 | return connection_class_mock.return_value 46 | 47 | def test_facts(self, mocker, connection_mock): 48 | mock_function = mocker.patch(function_path) 49 | mock_function.side_effect = [{ 50 | "changed": False, 51 | api_call_object: EXPECTED_RESULT 52 | } 53 | ] 54 | result = self._run_module(PAYLOAD) 55 | assert not result['changed'] 56 | assert EXPECTED_RESULT.items() == result['ansible_facts'].items() 57 | 58 | def _run_module(self, module_args): 59 | set_module_args(module_args) 60 | with pytest.raises(AnsibleExitJson) as ex: 61 | self.module.main() 62 | return ex.value.args[0] 63 | -------------------------------------------------------------------------------- /tests/unit/modules/test_cp_gaia_bridge_interface_facts.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # Ansible module to manage CheckPoint Firewall (c) 2019 3 | # 4 | # Ansible is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # Ansible is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU General Public License 15 | # along with Ansible. If not, see . 16 | # 17 | 18 | from __future__ import absolute_import, division, print_function 19 | __metaclass__ = type 20 | import pytest 21 | from units.modules.utils import set_module_args, exit_json, fail_json, AnsibleExitJson 22 | from ansible.module_utils import basic 23 | from ansible_collections.check_point.gaia.plugins.modules import cp_gaia_bridge_interface_facts 24 | 25 | EXPECTED_RESULT = { 26 | 'objects': [] 27 | } 28 | 29 | PAYLOAD = {} 30 | 31 | function_path = 'ansible_collections.check_point.gaia.plugins.modules.cp_gaia_bridge_interface_facts.chkp_facts_api_call' 32 | api_call_object = 'bridge-interface' 33 | 34 | 35 | class TestCheckpointBridgeInterfaceFacts(object): 36 | module = cp_gaia_bridge_interface_facts 37 | 38 | @pytest.fixture(autouse=True) 39 | def module_mock(self, mocker): 40 | return mocker.patch.multiple(basic.AnsibleModule, exit_json=exit_json, fail_json=fail_json) 41 | 42 | @pytest.fixture 43 | def connection_mock(self, mocker): 44 | connection_class_mock = mocker.patch('ansible.module_utils.network.checkpoint.checkpoint.Connection') 45 | return connection_class_mock.return_value 46 | 47 | def test_facts(self, mocker, connection_mock): 48 | mock_function = mocker.patch(function_path) 49 | mock_function.side_effect = [{ 50 | "changed": False, 51 | api_call_object: EXPECTED_RESULT 52 | } 53 | ] 54 | result = self._run_module(PAYLOAD) 55 | assert not result['changed'] 56 | assert EXPECTED_RESULT.items() == result['ansible_facts'].items() 57 | 58 | def _run_module(self, module_args): 59 | set_module_args(module_args) 60 | with pytest.raises(AnsibleExitJson) as ex: 61 | self.module.main() 62 | return ex.value.args[0] 63 | -------------------------------------------------------------------------------- /tests/unit/modules/test_cp_gaia_dhcp_server_facts.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # Ansible module to manage CheckPoint Firewall (c) 2019 3 | # 4 | # Ansible is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # Ansible is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU General Public License 15 | # along with Ansible. If not, see . 16 | # 17 | 18 | from __future__ import absolute_import, division, print_function 19 | __metaclass__ = type 20 | import pytest 21 | from units.modules.utils import set_module_args, exit_json, fail_json, AnsibleExitJson 22 | from ansible.module_utils import basic 23 | from ansible_collections.check_point.gaia.plugins.modules import cp_gaia_dhcp_server_facts 24 | 25 | EXPECTED_RESULT = { 26 | 'enabled': False, 27 | 'subnets': [], 28 | 'failed': False, 29 | 'changed': False 30 | } 31 | 32 | PAYLOAD = {} 33 | 34 | function_path = 'ansible_collections.check_point.gaia.plugins.modules.cp_gaia_dhcp_server_facts.chkp_facts_api_call' 35 | api_call_object = 'dhcp-server' 36 | 37 | 38 | class TestCheckpointDhcpServerFacts(object): 39 | module = cp_gaia_dhcp_server_facts 40 | 41 | @pytest.fixture(autouse=True) 42 | def module_mock(self, mocker): 43 | return mocker.patch.multiple(basic.AnsibleModule, exit_json=exit_json, fail_json=fail_json) 44 | 45 | @pytest.fixture 46 | def connection_mock(self, mocker): 47 | connection_class_mock = mocker.patch('ansible.module_utils.network.checkpoint.checkpoint.Connection') 48 | return connection_class_mock.return_value 49 | 50 | def test_facts(self, mocker, connection_mock): 51 | mock_function = mocker.patch(function_path) 52 | mock_function.side_effect = [{ 53 | "changed": False, 54 | api_call_object: EXPECTED_RESULT 55 | } 56 | ] 57 | result = self._run_module(PAYLOAD) 58 | assert not result['changed'] 59 | assert EXPECTED_RESULT.items() == result['ansible_facts'].items() 60 | 61 | def _run_module(self, module_args): 62 | set_module_args(module_args) 63 | with pytest.raises(AnsibleExitJson) as ex: 64 | self.module.main() 65 | return ex.value.args[0] 66 | -------------------------------------------------------------------------------- /tests/unit/modules/test_cp_gaia_diagnostics_topics_facts.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # Ansible module to manage CheckPoint Firewall (c) 2019 3 | # 4 | # Ansible is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # Ansible is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU General Public License 15 | # along with Ansible. If not, see . 16 | # 17 | 18 | from __future__ import absolute_import, division, print_function 19 | __metaclass__ = type 20 | import pytest 21 | from units.modules.utils import set_module_args, exit_json, fail_json, AnsibleExitJson 22 | from ansible.module_utils import basic 23 | from ansible_collections.check_point.gaia.plugins.modules import cp_gaia_diagnostics_topics_facts 24 | 25 | EXPECTED_RESULT = { 26 | 'os': ['cpu', 'memory', 'disk'] 27 | } 28 | 29 | PAYLOAD = {} 30 | 31 | function_path = 'ansible_collections.check_point.gaia.plugins.modules.cp_gaia_diagnostics_topics_facts.chkp_facts_api_call' 32 | api_call_object = 'diagnostics-topics' 33 | 34 | 35 | class TestCheckpointDiagnosticsTopicsFacts(object): 36 | module = cp_gaia_diagnostics_topics_facts 37 | 38 | @pytest.fixture(autouse=True) 39 | def module_mock(self, mocker): 40 | return mocker.patch.multiple(basic.AnsibleModule, exit_json=exit_json, fail_json=fail_json) 41 | 42 | @pytest.fixture 43 | def connection_mock(self, mocker): 44 | connection_class_mock = mocker.patch('ansible.module_utils.network.checkpoint.checkpoint.Connection') 45 | return connection_class_mock.return_value 46 | 47 | def test_facts(self, mocker, connection_mock): 48 | mock_function = mocker.patch(function_path) 49 | mock_function.side_effect = [{ 50 | "changed": False, 51 | api_call_object: EXPECTED_RESULT 52 | } 53 | ] 54 | result = self._run_module(PAYLOAD) 55 | assert not result['changed'] 56 | assert EXPECTED_RESULT.items() == result['ansible_facts'].items() 57 | 58 | def _run_module(self, module_args): 59 | set_module_args(module_args) 60 | with pytest.raises(AnsibleExitJson) as ex: 61 | self.module.main() 62 | return ex.value.args[0] 63 | -------------------------------------------------------------------------------- /tests/unit/modules/test_cp_gaia_dns_facts.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # Ansible module to manage CheckPoint Firewall (c) 2019 3 | # 4 | # Ansible is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # Ansible is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU General Public License 15 | # along with Ansible. If not, see . 16 | # 17 | 18 | from __future__ import absolute_import, division, print_function 19 | __metaclass__ = type 20 | import pytest 21 | from units.modules.utils import set_module_args, exit_json, fail_json, AnsibleExitJson 22 | from ansible.module_utils import basic 23 | from ansible_collections.check_point.gaia.plugins.modules import cp_gaia_dns_facts 24 | 25 | EXPECTED_RESULT = { 26 | "suffix": "checkpoint.com", 27 | "primary": "1.2.3.4", 28 | "tertiary": "3.4.5.6", 29 | "secondary": "2.3.4.5" 30 | } 31 | 32 | PAYLOAD = {} 33 | 34 | function_path = 'ansible_collections.check_point.gaia.plugins.modules.cp_gaia_dns_facts.chkp_facts_api_call' 35 | api_call_object = 'dns' 36 | 37 | 38 | class TestCheckpointDnsFacts(object): 39 | module = cp_gaia_dns_facts 40 | 41 | @pytest.fixture(autouse=True) 42 | def module_mock(self, mocker): 43 | return mocker.patch.multiple(basic.AnsibleModule, exit_json=exit_json, fail_json=fail_json) 44 | 45 | @pytest.fixture 46 | def connection_mock(self, mocker): 47 | connection_class_mock = mocker.patch('ansible.module_utils.network.checkpoint.checkpoint.Connection') 48 | return connection_class_mock.return_value 49 | 50 | def test_facts(self, mocker, connection_mock): 51 | mock_function = mocker.patch(function_path) 52 | mock_function.side_effect = [{ 53 | "changed": False, 54 | api_call_object: EXPECTED_RESULT 55 | } 56 | ] 57 | result = self._run_module(PAYLOAD) 58 | assert not result['changed'] 59 | assert EXPECTED_RESULT.items() == result['ansible_facts'].items() 60 | 61 | def _run_module(self, module_args): 62 | set_module_args(module_args) 63 | with pytest.raises(AnsibleExitJson) as ex: 64 | self.module.main() 65 | return ex.value.args[0] 66 | -------------------------------------------------------------------------------- /tests/unit/modules/test_cp_gaia_hostname_facts.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # Ansible module to manage CheckPoint Firewall (c) 2019 3 | # 4 | # Ansible is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # Ansible is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU General Public License 15 | # along with Ansible. If not, see . 16 | # 17 | 18 | from __future__ import absolute_import, division, print_function 19 | 20 | __metaclass__ = type 21 | 22 | import pytest 23 | from units.modules.utils import set_module_args, exit_json, fail_json, AnsibleExitJson 24 | 25 | from ansible.module_utils import basic 26 | from ansible_collections.check_point.gaia.plugins.modules import cp_gaia_hostname_facts 27 | 28 | EXPECTED_RESULT = { 29 | "name": "host1" 30 | } 31 | 32 | PAYLOAD = {} 33 | 34 | 35 | function_path = 'ansible_collections.check_point.gaia.plugins.modules.cp_gaia_hostname_facts.chkp_facts_api_call' 36 | 37 | 38 | class TestCheckpointHostnameFacts(object): 39 | module = cp_gaia_hostname_facts 40 | 41 | @pytest.fixture(autouse=True) 42 | def module_mock(self, mocker): 43 | return mocker.patch.multiple(basic.AnsibleModule, exit_json=exit_json, fail_json=fail_json) 44 | 45 | @pytest.fixture 46 | def connection_mock(self, mocker): 47 | connection_class_mock = mocker.patch('ansible.module_utils.network.checkpoint.checkpoint.Connection') 48 | return connection_class_mock.return_value 49 | 50 | def test_show_hostname(self, mocker, connection_mock): 51 | mock_function = mocker.patch(function_path) 52 | mock_function.side_effect = [{"name": "host1"}] 53 | result = self._run_module(PAYLOAD) 54 | assert not result['changed'] 55 | assert EXPECTED_RESULT.items() == result['ansible_facts'].items() 56 | 57 | def _run_module(self, module_args): 58 | set_module_args(module_args) 59 | with pytest.raises(AnsibleExitJson) as ex: 60 | self.module.main() 61 | return ex.value.args[0] 62 | -------------------------------------------------------------------------------- /tests/unit/modules/test_cp_gaia_hostname_on_login_page_facts.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # Ansible module to manage CheckPoint Firewall (c) 2019 3 | # 4 | # Ansible is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # Ansible is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU General Public License 15 | # along with Ansible. If not, see . 16 | # 17 | 18 | from __future__ import absolute_import, division, print_function 19 | __metaclass__ = type 20 | import pytest 21 | from units.modules.utils import set_module_args, exit_json, fail_json, AnsibleExitJson 22 | from ansible.module_utils import basic 23 | from ansible_collections.check_point.gaia.plugins.modules import cp_gaia_hostname_on_login_page_facts 24 | 25 | EXPECTED_RESULT = { 26 | 'enabled': False 27 | } 28 | 29 | PAYLOAD = {} 30 | 31 | function_path = 'ansible_collections.check_point.gaia.plugins.modules.cp_gaia_hostname_on_login_page_facts.chkp_facts_api_call' 32 | api_call_object = 'hostname-on-login-page' 33 | 34 | 35 | class TestCheckpointHostnameOnLoginPageFacts(object): 36 | module = cp_gaia_hostname_on_login_page_facts 37 | 38 | @pytest.fixture(autouse=True) 39 | def module_mock(self, mocker): 40 | return mocker.patch.multiple(basic.AnsibleModule, exit_json=exit_json, fail_json=fail_json) 41 | 42 | @pytest.fixture 43 | def connection_mock(self, mocker): 44 | connection_class_mock = mocker.patch('ansible.module_utils.network.checkpoint.checkpoint.Connection') 45 | return connection_class_mock.return_value 46 | 47 | def test_facts(self, mocker, connection_mock): 48 | mock_function = mocker.patch(function_path) 49 | mock_function.side_effect = [{ 50 | "changed": False, 51 | api_call_object: EXPECTED_RESULT 52 | } 53 | ] 54 | result = self._run_module(PAYLOAD) 55 | assert not result['changed'] 56 | assert EXPECTED_RESULT.items() == result['ansible_facts'].items() 57 | 58 | def _run_module(self, module_args): 59 | set_module_args(module_args) 60 | with pytest.raises(AnsibleExitJson) as ex: 61 | self.module.main() 62 | return ex.value.args[0] 63 | -------------------------------------------------------------------------------- /tests/unit/modules/test_cp_gaia_ipv6_facts.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # Ansible module to manage CheckPoint Firewall (c) 2019 3 | # 4 | # Ansible is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # Ansible is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU General Public License 15 | # along with Ansible. If not, see . 16 | # 17 | 18 | from __future__ import absolute_import, division, print_function 19 | __metaclass__ = type 20 | import pytest 21 | from units.modules.utils import set_module_args, exit_json, fail_json, AnsibleExitJson 22 | from ansible.module_utils import basic 23 | from ansible_collections.check_point.gaia.plugins.modules import cp_gaia_ipv6_facts 24 | 25 | EXPECTED_RESULT = { 26 | "reboot-required": False, 27 | "enabled": True 28 | } 29 | 30 | PAYLOAD = {} 31 | 32 | function_path = 'ansible_collections.check_point.gaia.plugins.modules.cp_gaia_ipv6_facts.chkp_facts_api_call' 33 | api_call_object = 'ipv6' 34 | 35 | 36 | class TestCheckpointIpv6Facts(object): 37 | module = cp_gaia_ipv6_facts 38 | 39 | @pytest.fixture(autouse=True) 40 | def module_mock(self, mocker): 41 | return mocker.patch.multiple(basic.AnsibleModule, exit_json=exit_json, fail_json=fail_json) 42 | 43 | @pytest.fixture 44 | def connection_mock(self, mocker): 45 | connection_class_mock = mocker.patch('ansible.module_utils.network.checkpoint.checkpoint.Connection') 46 | return connection_class_mock.return_value 47 | 48 | def test_facts(self, mocker, connection_mock): 49 | mock_function = mocker.patch(function_path) 50 | mock_function.side_effect = [{ 51 | "changed": False, 52 | api_call_object: EXPECTED_RESULT 53 | } 54 | ] 55 | result = self._run_module(PAYLOAD) 56 | assert not result['changed'] 57 | assert EXPECTED_RESULT.items() == result['ansible_facts'].items() 58 | 59 | def _run_module(self, module_args): 60 | set_module_args(module_args) 61 | with pytest.raises(AnsibleExitJson) as ex: 62 | self.module.main() 63 | return ex.value.args[0] 64 | -------------------------------------------------------------------------------- /tests/unit/modules/test_cp_gaia_proxy_facts.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # Ansible module to manage CheckPoint Firewall (c) 2019 3 | # 4 | # Ansible is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # Ansible is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU General Public License 15 | # along with Ansible. If not, see . 16 | # 17 | 18 | from __future__ import absolute_import, division, print_function 19 | __metaclass__ = type 20 | import pytest 21 | from units.modules.utils import set_module_args, exit_json, fail_json, AnsibleExitJson 22 | from ansible.module_utils import basic 23 | from ansible_collections.check_point.gaia.plugins.modules import cp_gaia_proxy_facts 24 | 25 | EXPECTED_RESULT = { 26 | 'address': '', 27 | 'port': '' 28 | } 29 | 30 | PAYLOAD = {} 31 | 32 | function_path = 'ansible_collections.check_point.gaia.plugins.modules.cp_gaia_proxy_facts.chkp_facts_api_call' 33 | api_call_object = 'proxy' 34 | 35 | 36 | class TestCheckpointProxyFacts(object): 37 | module = cp_gaia_proxy_facts 38 | 39 | @pytest.fixture(autouse=True) 40 | def module_mock(self, mocker): 41 | return mocker.patch.multiple(basic.AnsibleModule, exit_json=exit_json, fail_json=fail_json) 42 | 43 | @pytest.fixture 44 | def connection_mock(self, mocker): 45 | connection_class_mock = mocker.patch('ansible.module_utils.network.checkpoint.checkpoint.Connection') 46 | return connection_class_mock.return_value 47 | 48 | def test_facts(self, mocker, connection_mock): 49 | mock_function = mocker.patch(function_path) 50 | mock_function.side_effect = [{ 51 | "changed": False, 52 | api_call_object: EXPECTED_RESULT 53 | } 54 | ] 55 | result = self._run_module(PAYLOAD) 56 | assert not result['changed'] 57 | assert EXPECTED_RESULT.items() == result['ansible_facts'].items() 58 | 59 | def _run_module(self, module_args): 60 | set_module_args(module_args) 61 | with pytest.raises(AnsibleExitJson) as ex: 62 | self.module.main() 63 | return ex.value.args[0] 64 | -------------------------------------------------------------------------------- /tests/unit/modules/test_cp_gaia_put_file.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # Ansible module to manage CheckPoint Firewall (c) 2019 3 | # 4 | # Ansible is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # Ansible is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU General Public License 15 | # along with Ansible. If not, see . 16 | # 17 | 18 | from __future__ import absolute_import, division, print_function 19 | 20 | __metaclass__ = type 21 | 22 | import pytest 23 | from units.modules.utils import set_module_args, exit_json, fail_json, AnsibleExitJson 24 | 25 | from ansible.module_utils import basic 26 | from ansible_collections.check_point.gaia.plugins.modules import cp_gaia_put_file 27 | 28 | EXPECTED_RESULT = {} 29 | 30 | CHANGED_PAYLOAD = { 31 | "file_name": "ansible_file.txt", 32 | "text_content": "It's an ansible file.", 33 | "override": True 34 | } 35 | 36 | function_path = 'ansible_collections.check_point.gaia.plugins.modules.cp_gaia_put_file.chkp_api_operation' 37 | api_call_object = 'put-file' 38 | 39 | 40 | class TestCheckpointPutFile(object): 41 | module = cp_gaia_put_file 42 | 43 | @pytest.fixture(autouse=True) 44 | def module_mock(self, mocker): 45 | return mocker.patch.multiple(basic.AnsibleModule, exit_json=exit_json, fail_json=fail_json) 46 | 47 | @pytest.fixture 48 | def connection_mock(self, mocker): 49 | connection_class_mock = mocker.patch('ansible.module_utils.network.checkpoint.checkpoint.Connection') 50 | return connection_class_mock.return_value 51 | 52 | def test_changed(self, mocker, connection_mock): 53 | mock_function = mocker.patch(function_path) 54 | mock_function.side_effect = [{}] 55 | result = self._run_module(CHANGED_PAYLOAD) 56 | assert result['changed'] 57 | assert EXPECTED_RESULT.items() == result['put_file'].items() 58 | 59 | def _run_module(self, module_args): 60 | set_module_args(module_args) 61 | with pytest.raises(AnsibleExitJson) as ex: 62 | self.module.main() 63 | return ex.value.args[0] 64 | -------------------------------------------------------------------------------- /tests/unit/modules/test_cp_gaia_routes_aggregate_facts.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # Ansible module to manage CheckPoint Firewall (c) 2019 3 | # 4 | # Ansible is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # Ansible is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU General Public License 15 | # along with Ansible. If not, see . 16 | # 17 | 18 | from __future__ import absolute_import, division, print_function 19 | __metaclass__ = type 20 | import pytest 21 | from units.modules.utils import set_module_args, exit_json, fail_json, AnsibleExitJson 22 | from ansible.module_utils import basic 23 | from ansible_collections.check_point.gaia.plugins.modules import cp_gaia_routes_aggregate_facts 24 | 25 | EXPECTED_RESULT = { 26 | 'from': 0, 27 | 'objects': [], 28 | 'to': 0, 29 | 'total': 0 30 | } 31 | 32 | PAYLOAD = {} 33 | 34 | function_path = 'ansible_collections.check_point.gaia.plugins.modules.cp_gaia_routes_aggregate_facts.chkp_facts_api_call' 35 | api_call_object = 'routes-aggregate' 36 | 37 | 38 | class TestCheckpointRoutesAggregateFacts(object): 39 | module = cp_gaia_routes_aggregate_facts 40 | 41 | @pytest.fixture(autouse=True) 42 | def module_mock(self, mocker): 43 | return mocker.patch.multiple(basic.AnsibleModule, exit_json=exit_json, fail_json=fail_json) 44 | 45 | @pytest.fixture 46 | def connection_mock(self, mocker): 47 | connection_class_mock = mocker.patch('ansible.module_utils.network.checkpoint.checkpoint.Connection') 48 | return connection_class_mock.return_value 49 | 50 | def test_facts(self, mocker, connection_mock): 51 | mock_function = mocker.patch(function_path) 52 | mock_function.side_effect = [{ 53 | "changed": False, 54 | api_call_object: EXPECTED_RESULT 55 | } 56 | ] 57 | result = self._run_module(PAYLOAD) 58 | assert not result['changed'] 59 | assert EXPECTED_RESULT.items() == result['ansible_facts'].items() 60 | 61 | def _run_module(self, module_args): 62 | set_module_args(module_args) 63 | with pytest.raises(AnsibleExitJson) as ex: 64 | self.module.main() 65 | return ex.value.args[0] 66 | -------------------------------------------------------------------------------- /tests/unit/modules/test_cp_gaia_routes_bgp_facts.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # Ansible module to manage CheckPoint Firewall (c) 2019 3 | # 4 | # Ansible is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # Ansible is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU General Public License 15 | # along with Ansible. If not, see . 16 | # 17 | 18 | from __future__ import absolute_import, division, print_function 19 | __metaclass__ = type 20 | import pytest 21 | from units.modules.utils import set_module_args, exit_json, fail_json, AnsibleExitJson 22 | from ansible.module_utils import basic 23 | from ansible_collections.check_point.gaia.plugins.modules import cp_gaia_routes_bgp_facts 24 | 25 | EXPECTED_RESULT = { 26 | 'from': 0, 27 | 'objects': [], 28 | 'to': 0, 29 | 'total': 0 30 | } 31 | 32 | PAYLOAD = {} 33 | 34 | function_path = 'ansible_collections.check_point.gaia.plugins.modules.cp_gaia_routes_bgp_facts.chkp_facts_api_call' 35 | api_call_object = 'routes-bgp' 36 | 37 | 38 | class TestCheckpointRoutesBgpFacts(object): 39 | module = cp_gaia_routes_bgp_facts 40 | 41 | @pytest.fixture(autouse=True) 42 | def module_mock(self, mocker): 43 | return mocker.patch.multiple(basic.AnsibleModule, exit_json=exit_json, fail_json=fail_json) 44 | 45 | @pytest.fixture 46 | def connection_mock(self, mocker): 47 | connection_class_mock = mocker.patch('ansible.module_utils.network.checkpoint.checkpoint.Connection') 48 | return connection_class_mock.return_value 49 | 50 | def test_facts(self, mocker, connection_mock): 51 | mock_function = mocker.patch(function_path) 52 | mock_function.side_effect = [{ 53 | "changed": False, 54 | api_call_object: EXPECTED_RESULT 55 | } 56 | ] 57 | result = self._run_module(PAYLOAD) 58 | assert not result['changed'] 59 | assert EXPECTED_RESULT.items() == result['ansible_facts'].items() 60 | 61 | def _run_module(self, module_args): 62 | set_module_args(module_args) 63 | with pytest.raises(AnsibleExitJson) as ex: 64 | self.module.main() 65 | return ex.value.args[0] 66 | -------------------------------------------------------------------------------- /tests/unit/modules/test_cp_gaia_routes_kernel_facts.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # Ansible module to manage CheckPoint Firewall (c) 2019 3 | # 4 | # Ansible is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # Ansible is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU General Public License 15 | # along with Ansible. If not, see . 16 | # 17 | 18 | from __future__ import absolute_import, division, print_function 19 | __metaclass__ = type 20 | import pytest 21 | from units.modules.utils import set_module_args, exit_json, fail_json, AnsibleExitJson 22 | from ansible.module_utils import basic 23 | from ansible_collections.check_point.gaia.plugins.modules import cp_gaia_routes_kernel_facts 24 | 25 | EXPECTED_RESULT = { 26 | 'from': 0, 27 | 'objects': [], 28 | 'to': 0, 29 | 'total': 0 30 | } 31 | 32 | PAYLOAD = {} 33 | 34 | function_path = 'ansible_collections.check_point.gaia.plugins.modules.cp_gaia_routes_kernel_facts.chkp_facts_api_call' 35 | api_call_object = 'routes-kernel' 36 | 37 | 38 | class TestCheckpointRoutesKernelFacts(object): 39 | module = cp_gaia_routes_kernel_facts 40 | 41 | @pytest.fixture(autouse=True) 42 | def module_mock(self, mocker): 43 | return mocker.patch.multiple(basic.AnsibleModule, exit_json=exit_json, fail_json=fail_json) 44 | 45 | @pytest.fixture 46 | def connection_mock(self, mocker): 47 | connection_class_mock = mocker.patch('ansible.module_utils.network.checkpoint.checkpoint.Connection') 48 | return connection_class_mock.return_value 49 | 50 | def test_facts(self, mocker, connection_mock): 51 | mock_function = mocker.patch(function_path) 52 | mock_function.side_effect = [{ 53 | "changed": False, 54 | api_call_object: EXPECTED_RESULT 55 | } 56 | ] 57 | result = self._run_module(PAYLOAD) 58 | assert not result['changed'] 59 | assert EXPECTED_RESULT.items() == result['ansible_facts'].items() 60 | 61 | def _run_module(self, module_args): 62 | set_module_args(module_args) 63 | with pytest.raises(AnsibleExitJson) as ex: 64 | self.module.main() 65 | return ex.value.args[0] 66 | -------------------------------------------------------------------------------- /tests/unit/modules/test_cp_gaia_routes_ospf_facts.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # Ansible module to manage CheckPoint Firewall (c) 2019 3 | # 4 | # Ansible is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # Ansible is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU General Public License 15 | # along with Ansible. If not, see . 16 | # 17 | 18 | from __future__ import absolute_import, division, print_function 19 | __metaclass__ = type 20 | import pytest 21 | from units.modules.utils import set_module_args, exit_json, fail_json, AnsibleExitJson 22 | from ansible.module_utils import basic 23 | from ansible_collections.check_point.gaia.plugins.modules import cp_gaia_routes_ospf_facts 24 | 25 | EXPECTED_RESULT = { 26 | 'from': 0, 27 | 'objects': [], 28 | 'to': 0, 29 | 'total': 0 30 | } 31 | 32 | PAYLOAD = {} 33 | 34 | function_path = 'ansible_collections.check_point.gaia.plugins.modules.cp_gaia_routes_ospf_facts.chkp_facts_api_call' 35 | api_call_object = 'routes-ospf' 36 | 37 | 38 | class TestCheckpointRoutesOspfFacts(object): 39 | module = cp_gaia_routes_ospf_facts 40 | 41 | @pytest.fixture(autouse=True) 42 | def module_mock(self, mocker): 43 | return mocker.patch.multiple(basic.AnsibleModule, exit_json=exit_json, fail_json=fail_json) 44 | 45 | @pytest.fixture 46 | def connection_mock(self, mocker): 47 | connection_class_mock = mocker.patch('ansible.module_utils.network.checkpoint.checkpoint.Connection') 48 | return connection_class_mock.return_value 49 | 50 | def test_facts(self, mocker, connection_mock): 51 | mock_function = mocker.patch(function_path) 52 | mock_function.side_effect = [{ 53 | "changed": False, 54 | api_call_object: EXPECTED_RESULT 55 | } 56 | ] 57 | result = self._run_module(PAYLOAD) 58 | assert not result['changed'] 59 | assert EXPECTED_RESULT.items() == result['ansible_facts'].items() 60 | 61 | def _run_module(self, module_args): 62 | set_module_args(module_args) 63 | with pytest.raises(AnsibleExitJson) as ex: 64 | self.module.main() 65 | return ex.value.args[0] 66 | -------------------------------------------------------------------------------- /tests/unit/modules/test_cp_gaia_routes_rip_facts.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # Ansible module to manage CheckPoint Firewall (c) 2019 3 | # 4 | # Ansible is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # Ansible is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU General Public License 15 | # along with Ansible. If not, see . 16 | # 17 | 18 | from __future__ import absolute_import, division, print_function 19 | __metaclass__ = type 20 | import pytest 21 | from units.modules.utils import set_module_args, exit_json, fail_json, AnsibleExitJson 22 | from ansible.module_utils import basic 23 | from ansible_collections.check_point.gaia.plugins.modules import cp_gaia_routes_rip_facts 24 | 25 | EXPECTED_RESULT = { 26 | 'from': 0, 27 | 'objects': [], 28 | 'to': 0, 29 | 'total': 0 30 | } 31 | 32 | PAYLOAD = {} 33 | 34 | function_path = 'ansible_collections.check_point.gaia.plugins.modules.cp_gaia_routes_rip_facts.chkp_facts_api_call' 35 | api_call_object = 'routes-rip' 36 | 37 | 38 | class TestCheckpointRoutesRipFacts(object): 39 | module = cp_gaia_routes_rip_facts 40 | 41 | @pytest.fixture(autouse=True) 42 | def module_mock(self, mocker): 43 | return mocker.patch.multiple(basic.AnsibleModule, exit_json=exit_json, fail_json=fail_json) 44 | 45 | @pytest.fixture 46 | def connection_mock(self, mocker): 47 | connection_class_mock = mocker.patch('ansible.module_utils.network.checkpoint.checkpoint.Connection') 48 | return connection_class_mock.return_value 49 | 50 | def test_facts(self, mocker, connection_mock): 51 | mock_function = mocker.patch(function_path) 52 | mock_function.side_effect = [{ 53 | "changed": False, 54 | api_call_object: EXPECTED_RESULT 55 | } 56 | ] 57 | result = self._run_module(PAYLOAD) 58 | assert not result['changed'] 59 | assert EXPECTED_RESULT.items() == result['ansible_facts'].items() 60 | 61 | def _run_module(self, module_args): 62 | set_module_args(module_args) 63 | with pytest.raises(AnsibleExitJson) as ex: 64 | self.module.main() 65 | return ex.value.args[0] 66 | -------------------------------------------------------------------------------- /tests/unit/modules/test_cp_gaia_scheduled_job_facts.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # Ansible module to manage CheckPoint Firewall (c) 2019 3 | # 4 | # Ansible is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # Ansible is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU General Public License 15 | # along with Ansible. If not, see . 16 | # 17 | 18 | from __future__ import absolute_import, division, print_function 19 | __metaclass__ = type 20 | import pytest 21 | from units.modules.utils import set_module_args, exit_json, fail_json, AnsibleExitJson 22 | from ansible.module_utils import basic 23 | from ansible_collections.check_point.gaia.plugins.modules import cp_gaia_scheduled_job_facts 24 | 25 | EXPECTED_RESULT = { 26 | 'jobs': [] 27 | } 28 | 29 | PAYLOAD = {} 30 | 31 | function_path = 'ansible_collections.check_point.gaia.plugins.modules.cp_gaia_scheduled_job_facts.chkp_facts_api_call' 32 | api_call_object = 'scheduled-job' 33 | 34 | 35 | class TestCheckpointScheduledJobFacts(object): 36 | module = cp_gaia_scheduled_job_facts 37 | 38 | @pytest.fixture(autouse=True) 39 | def module_mock(self, mocker): 40 | return mocker.patch.multiple(basic.AnsibleModule, exit_json=exit_json, fail_json=fail_json) 41 | 42 | @pytest.fixture 43 | def connection_mock(self, mocker): 44 | connection_class_mock = mocker.patch('ansible.module_utils.network.checkpoint.checkpoint.Connection') 45 | return connection_class_mock.return_value 46 | 47 | def test_facts(self, mocker, connection_mock): 48 | mock_function = mocker.patch(function_path) 49 | mock_function.side_effect = [{ 50 | "changed": False, 51 | api_call_object: EXPECTED_RESULT 52 | } 53 | ] 54 | result = self._run_module(PAYLOAD) 55 | assert not result['changed'] 56 | assert EXPECTED_RESULT.items() == result['ansible_facts'].items() 57 | 58 | def _run_module(self, module_args): 59 | set_module_args(module_args) 60 | with pytest.raises(AnsibleExitJson) as ex: 61 | self.module.main() 62 | return ex.value.args[0] 63 | -------------------------------------------------------------------------------- /tests/unit/modules/test_cp_gaia_scheduled_job_mail_facts.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # Ansible module to manage CheckPoint Firewall (c) 2019 3 | # 4 | # Ansible is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # Ansible is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU General Public License 15 | # along with Ansible. If not, see . 16 | # 17 | 18 | from __future__ import absolute_import, division, print_function 19 | __metaclass__ = type 20 | import pytest 21 | from units.modules.utils import set_module_args, exit_json, fail_json, AnsibleExitJson 22 | from ansible.module_utils import basic 23 | from ansible_collections.check_point.gaia.plugins.modules import cp_gaia_scheduled_job_mail_facts 24 | 25 | EXPECTED_RESULT = { 26 | 'email_address': '' 27 | } 28 | 29 | PAYLOAD = {} 30 | 31 | function_path = 'ansible_collections.check_point.gaia.plugins.modules.cp_gaia_scheduled_job_mail_facts.chkp_facts_api_call' 32 | api_call_object = 'scheduled-job-mail' 33 | 34 | 35 | class TestCheckpointScheduledJobMailFacts(object): 36 | module = cp_gaia_scheduled_job_mail_facts 37 | 38 | @pytest.fixture(autouse=True) 39 | def module_mock(self, mocker): 40 | return mocker.patch.multiple(basic.AnsibleModule, exit_json=exit_json, fail_json=fail_json) 41 | 42 | @pytest.fixture 43 | def connection_mock(self, mocker): 44 | connection_class_mock = mocker.patch('ansible.module_utils.network.checkpoint.checkpoint.Connection') 45 | return connection_class_mock.return_value 46 | 47 | def test_facts(self, mocker, connection_mock): 48 | mock_function = mocker.patch(function_path) 49 | mock_function.side_effect = [{ 50 | "changed": False, 51 | api_call_object: EXPECTED_RESULT 52 | } 53 | ] 54 | result = self._run_module(PAYLOAD) 55 | assert not result['changed'] 56 | assert EXPECTED_RESULT.items() == result['ansible_facts'].items() 57 | 58 | def _run_module(self, module_args): 59 | set_module_args(module_args) 60 | with pytest.raises(AnsibleExitJson) as ex: 61 | self.module.main() 62 | return ex.value.args[0] 63 | -------------------------------------------------------------------------------- /tests/unit/modules/test_cp_gaia_syslog_facts.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # Ansible module to manage CheckPoint Firewall (c) 2019 3 | # 4 | # Ansible is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # Ansible is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU General Public License 15 | # along with Ansible. If not, see . 16 | # 17 | 18 | from __future__ import absolute_import, division, print_function 19 | __metaclass__ = type 20 | import pytest 21 | from units.modules.utils import set_module_args, exit_json, fail_json, AnsibleExitJson 22 | from ansible.module_utils import basic 23 | from ansible_collections.check_point.gaia.plugins.modules import cp_gaia_syslog_facts 24 | 25 | EXPECTED_RESULT = { 26 | "send-to-mgmt": True, 27 | "cp-logs": False, 28 | "audit-log": True, 29 | "filename": "/var/log/messages" 30 | } 31 | 32 | PAYLOAD = {} 33 | 34 | function_path = 'ansible_collections.check_point.gaia.plugins.modules.cp_gaia_syslog_facts.chkp_facts_api_call' 35 | api_call_object = 'syslog' 36 | 37 | 38 | class TestCheckpointSyslogFacts(object): 39 | module = cp_gaia_syslog_facts 40 | 41 | @pytest.fixture(autouse=True) 42 | def module_mock(self, mocker): 43 | return mocker.patch.multiple(basic.AnsibleModule, exit_json=exit_json, fail_json=fail_json) 44 | 45 | @pytest.fixture 46 | def connection_mock(self, mocker): 47 | connection_class_mock = mocker.patch('ansible.module_utils.network.checkpoint.checkpoint.Connection') 48 | return connection_class_mock.return_value 49 | 50 | def test_facts(self, mocker, connection_mock): 51 | mock_function = mocker.patch(function_path) 52 | mock_function.side_effect = [{ 53 | "changed": False, 54 | api_call_object: EXPECTED_RESULT 55 | } 56 | ] 57 | result = self._run_module(PAYLOAD) 58 | assert not result['changed'] 59 | assert EXPECTED_RESULT.items() == result['ansible_facts'].items() 60 | 61 | def _run_module(self, module_args): 62 | set_module_args(module_args) 63 | with pytest.raises(AnsibleExitJson) as ex: 64 | self.module.main() 65 | return ex.value.args[0] 66 | -------------------------------------------------------------------------------- /tests/unit/modules/test_cp_gaia_tacacs_server_facts.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # Ansible module to manage CheckPoint Firewall (c) 2019 3 | # 4 | # Ansible is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # Ansible is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU General Public License 15 | # along with Ansible. If not, see . 16 | # 17 | 18 | from __future__ import absolute_import, division, print_function 19 | __metaclass__ = type 20 | import pytest 21 | from units.modules.utils import set_module_args, exit_json, fail_json, AnsibleExitJson 22 | from ansible.module_utils import basic 23 | from ansible_collections.check_point.gaia.plugins.modules import cp_gaia_tacacs_server_facts 24 | 25 | EXPECTED_RESULT = { 26 | 'enabled': False, 27 | 'servers': [], 28 | 'super_user_uid': '96' 29 | } 30 | 31 | PAYLOAD = {} 32 | 33 | function_path = 'ansible_collections.check_point.gaia.plugins.modules.cp_gaia_tacacs_server_facts.chkp_facts_api_call' 34 | api_call_object = 'tacacs' 35 | 36 | 37 | class TestCheckpointTacacsServerFacts(object): 38 | module = cp_gaia_tacacs_server_facts 39 | 40 | @pytest.fixture(autouse=True) 41 | def module_mock(self, mocker): 42 | return mocker.patch.multiple(basic.AnsibleModule, exit_json=exit_json, fail_json=fail_json) 43 | 44 | @pytest.fixture 45 | def connection_mock(self, mocker): 46 | connection_class_mock = mocker.patch('ansible.module_utils.network.checkpoint.checkpoint.Connection') 47 | return connection_class_mock.return_value 48 | 49 | def test_facts(self, mocker, connection_mock): 50 | mock_function = mocker.patch(function_path) 51 | mock_function.side_effect = [{ 52 | "changed": False, 53 | api_call_object: EXPECTED_RESULT 54 | } 55 | ] 56 | result = self._run_module(PAYLOAD) 57 | assert not result['changed'] 58 | assert EXPECTED_RESULT.items() == result['ansible_facts'].items() 59 | 60 | def _run_module(self, module_args): 61 | set_module_args(module_args) 62 | with pytest.raises(AnsibleExitJson) as ex: 63 | self.module.main() 64 | return ex.value.args[0] 65 | -------------------------------------------------------------------------------- /tests/unit/modules/test_cp_gaia_vlan_interface_facts.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # Ansible module to manage CheckPoint Firewall (c) 2019 3 | # 4 | # Ansible is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # Ansible is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU General Public License 15 | # along with Ansible. If not, see . 16 | # 17 | 18 | from __future__ import absolute_import, division, print_function 19 | __metaclass__ = type 20 | import pytest 21 | from units.modules.utils import set_module_args, exit_json, fail_json, AnsibleExitJson 22 | from ansible.module_utils import basic 23 | from ansible_collections.check_point.gaia.plugins.modules import cp_gaia_vlan_interface_facts 24 | 25 | EXPECTED_RESULT = { 26 | 'objects': [] 27 | } 28 | 29 | PAYLOAD = {} 30 | 31 | function_path = 'ansible_collections.check_point.gaia.plugins.modules.cp_gaia_vlan_interface_facts.chkp_facts_api_call' 32 | api_call_object = 'vlan-interface' 33 | 34 | 35 | class TestCheckpointVlanInterfaceFacts(object): 36 | module = cp_gaia_vlan_interface_facts 37 | 38 | @pytest.fixture(autouse=True) 39 | def module_mock(self, mocker): 40 | return mocker.patch.multiple(basic.AnsibleModule, exit_json=exit_json, fail_json=fail_json) 41 | 42 | @pytest.fixture 43 | def connection_mock(self, mocker): 44 | connection_class_mock = mocker.patch('ansible.module_utils.network.checkpoint.checkpoint.Connection') 45 | return connection_class_mock.return_value 46 | 47 | def test_facts(self, mocker, connection_mock): 48 | mock_function = mocker.patch(function_path) 49 | mock_function.side_effect = [{ 50 | "changed": False, 51 | api_call_object: EXPECTED_RESULT 52 | } 53 | ] 54 | result = self._run_module(PAYLOAD) 55 | assert not result['changed'] 56 | assert EXPECTED_RESULT.items() == result['ansible_facts'].items() 57 | 58 | def _run_module(self, module_args): 59 | set_module_args(module_args) 60 | with pytest.raises(AnsibleExitJson) as ex: 61 | self.module.main() 62 | return ex.value.args[0] 63 | --------------------------------------------------------------------------------