Simple Cluster#

This class is used to manage Simple Cluster

class SimpleCluster#
add(name, ip_address=None, ipv4_address=None, ipv6_address=None, anti_bot=None, anti_virus=None, application_control=None, cluster_mode=None, content_awareness=None, data_awareness=None, firewall=None, firewall_settings=None, hardware=None, interfaces=None, ips=None, members=None, os_name=None, platform_portal_settings=None, send_alerts_to_server=None, send_logs_to_backup_server=None, send_logs_to_server=None, tags=None, threat_emulation=None, threat_extraction=None, threat_prevention_mode=None, url_filtering=None, usercheck_portal_settings=None, version=None, vpn=None, vpn_settings=None, **kw)#

Create new object.

Parameters

  • name (str) – Object name. Must be unique in the domain.

  • ip_address (str, optional) – IPv4 or IPv6 address. If both addresses are required use ipv4-address

  • set (and ipv6-address fields explicitly. Mandatory if "ipv4_address" or "ipv6_address" is not) –

  • ipv4_address (str, optional) – IPv4 address. Mandatory if “ipv_address” or “ipv6_address” is not set

  • ipv6_address (str, optional) – IPv6 address. Mandatory if “ipv_address” or “ipv4_address” is not set

  • anti_bot (bool, optional) – Anti-Bot blade enabled.

  • anti_virus (bool, optional) – Anti-Virus blade enabled.

  • application_control (bool, optional) – Application Control blade enabled.

  • cluster_mode (str, optional) – Cluster mode.

  • content_awareness (bool, optional) – Content Awareness blade enabled.

  • data_awareness (bool, optional) – Data Awareness blade enabled.

  • firewall (bool, optional) – Firewall blade enabled.

  • firewall_settings (dict, optional) – N/A

  • hardware (str, optional) – Cluster platform hardware.

  • interfaces (List[dict], optional) – Network interfaces.

  • ips (bool, optional) – Intrusion Prevention System blade enabled.

  • members (List[dict], optional) – Cluster members list. Only new cluster member can be added.

  • supported. (Adding existing gateway is not) –

  • os_name (str, optional) – Gateway platform operating system.

  • platform_portal_settings (dict, optional) – Platform portal settings.

  • send_alerts_to_server (Union[str, List[str]], optional) – Server(s) to send alerts to.

  • send_logs_to_backup_server (Union[str, List[str]], optional) – Backup server(s) to send logs to.

  • send_logs_to_server (Union[str, List[str]], optional) – Server(s) to send logs to.

  • tags (Union(str,List[str]), optional) – Collection of tag identifiers.

  • threat_emulation (bool, optional) – Threat Emulation blade enabled.

  • threat_extraction (bool, optional) – Threat Extraction blade enabled.

  • threat_prevention_mode (str, optional) – The mode of Threat Prevention to use. When using Autonomous Threat Prevention, disabling the Threat Prevention blades is not allowed.

  • url_filtering (bool, optional) – URL Filtering blade enabled.

  • usercheck_portal_settings (dict, optional) – UserCheck portal settings.

  • version (str, optional) – Gateway platform version.

  • vpn (bool, optional) – VPN blade enabled.

  • vpn_settings (dict, optional) – Gateway VPN settings.

Keyword Arguments

  • **show-portals-certificate (bool, optional) – Indicates whether to show the portals certificate value in the reply.

  • **color (Color, optional) – Color of the object. Should be one of existing colors.

  • **comments (str, optional) – Comments string.

  • **details-level (str, optional) – The level of detail for some of the fields in the response can vary from showing only the UID value of the object to a fully detailed representation of the object.

  • **groups (Union(str,List[str]), optional) – Collection of group identifiers.

  • **ignore-warnings (bool, optional) – Apply changes ignoring warnings. Defaults to False

  • **ignore-errors (bool, optional) – Apply changes ignoring errors. You won’t be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored. Defaults to False

Returns

The response from the server

Return type

Box

Examples

>>> firewall.network_objects.simple_cluster.add(
... name="cluster1",
... ip_address="17.23.5.1")
delete(uid=None, name=None, **kw)#

Delete existing object using object name or uid.

Parameters

  • uid (str) – Object unique identifier.

  • name (str) – Object name.

Keyword Arguments

  • **details-level (str, optional) – The level of detail for some of the fields in the response can vary from showing only the UID value of the object to a fully detailed representation of the object.

  • **ignore-warnings (bool, optional) – Apply changes ignoring warnings. Defaults to False

  • **ignore-errors (bool, optional) – Apply changes ignoring errors. You won’t be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored. Defaults to False

Returns

The response from the server

Return type

Box

Examples

>>> firewall.network_objects.simple_cluster.delete(uid="9423d36f-2d66-4754-b9e2-e7f4493756d4")
set(uid=None, name=None, ip_address=None, ipv4_address=None, ipv6_address=None, anti_bot=None, anti_virus=None, application_control=None, cluster_mode=None, content_awareness=None, data_awareness=None, firewall=None, firewall_settings=None, hardware=None, interfaces=None, ips=None, members=None, new_name=None, os_name=None, platform_portal_settings=None, send_alerts_to_server=None, send_logs_to_backup_server=None, send_logs_to_server=None, tags=None, threat_emulation=None, threat_extraction=None, threat_prevention_mode=None, url_filtering=None, usercheck_portal_settings=None, version=None, vpn=None, vpn_settings=None, **kw)#

Edit existing object using object name or uid.

Parameters

  • uid (str) – Object unique identifier.

  • name (str) – Object name.

  • new_name (str) – New name of the object.

  • ip_address (str, optional) – IPv4 or IPv6 address. If both addresses are required use ipv4-address

  • set (and ipv6-address fields explicitly. Mandatory if "ipv4_address" or "ipv6_address" is not) –

  • ipv4_address (str, optional) – IPv4 address. Mandatory if “ipv_address” or “ipv6_address” is not set

  • ipv6_address (str, optional) – IPv6 address. Mandatory if “ipv_address” or “ipv4_address” is not set

  • anti_bot (bool, optional) – Anti-Bot blade enabled.

  • anti_virus (bool, optional) – Anti-Virus blade enabled.

  • application_control (bool, optional) – Application Control blade enabled.

  • cluster_mode (str, optional) – Cluster mode.

  • content_awareness (bool, optional) – Content Awareness blade enabled.

  • data_awareness (bool, optional) – Data Awareness blade enabled.

  • firewall (bool, optional) – Firewall blade enabled.

  • firewall_settings (dict, optional) – N/A

  • hardware (str, optional) – Cluster platform hardware.

  • interfaces (List[dict], optional) – Network interfaces.

  • ips (bool, optional) – Intrusion Prevention System blade enabled.

  • members (List[dict], optional) – Cluster members list. Only new cluster member can be added.

  • supported. (Adding existing gateway is not) –

  • os_name (str, optional) – Gateway platform operating system.

  • platform_portal_settings (dict, optional) – Platform portal settings.

  • send_alerts_to_server (Union[str, List[str]], optional) – Server(s) to send alerts to.

  • send_logs_to_backup_server (Union[str, List[str]], optional) – Backup server(s) to send logs to.

  • send_logs_to_server (Union[str, List[str]], optional) – Server(s) to send logs to.

  • tags (Union(str,List[str]), optional) – Collection of tag identifiers.

  • threat_emulation (bool, optional) – Threat Emulation blade enabled.

  • threat_extraction (bool, optional) – Threat Extraction blade enabled.

  • threat_prevention_mode (str, optional) – The mode of Threat Prevention to use. When using Autonomous Threat

  • Prevention –

  • allowed. (disabling the Threat Prevention blades is not) –

  • url_filtering (bool, optional) – URL Filtering blade enabled.

  • usercheck_portal_settings (dict, optional) – UserCheck portal settings.

  • version (str, optional) – Gateway platform version.

  • vpn (bool, optional) – VPN blade enabled.

  • vpn_settings (dict, optional) – Gateway VPN settings.

Keyword Arguments

  • **color (Color, optional) – Color of the object. Should be one of existing colors.

  • **comments (str, optional) – Comments string.

  • **details-level (str, optional) – The level of detail for some of the fields in the response can vary from showing only the UID value of the object to a fully detailed representation of the object.

  • **groups (Union(str,List[str]), optional) – Collection of group identifiers.

  • **ignore-warnings (bool, optional) – Apply changes ignoring warnings. Defaults to False

  • **ignore-errors (bool, optional) – Apply changes ignoring errors. You won’t be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored. Defaults to False

Returns

The response from the server

Return type

Box

Examples

>>> firewall.network_objects.simple_cluster.set(
... uid="4a5d882a-5568-2c3b-aa78-751ab23d6c11",
... ip_address="17.23.5.1")
show(uid=None, name=None, **kw)#

Retrieve existing object using object name or uid.

Parameters

  • uid (str, optional) – Object unique identifier.

  • name (str, optional) – Object name.

Keyword Arguments

**details-level (str, optional) – The level of detail for some of the fields in the response can vary from showing only the UID value of the object to a fully detailed representation of the object.

Returns

The response from the server

Return type

Box

Examples

>>> firewall.network_objects.simple_cluster.show(
... uid="9423d36f-2d66-4754-b9e2-e7f4493756d4")
show_simple_clusters(filter_results=None, limit=50, offset=0, order=None, **kw)#

Retrieve all objects.

Parameters

  • filter_results (str, optional) – Search expression to filter objects by. The provided text should be exactly the same as it would be given in SmartConsole Object Explorer. The logical operators in the expression (‘AND’, ‘OR’) should be provided in capital letters. he search involves both a IP search and a textual search in name, comment, tags etc.

  • limit (int, optional) – The maximal number of returned results. Defaults to 50 (between 1 and 500)

  • offset (int, optional) – Number of the results to initially skip. Defaults to 0

  • order (List[dict], optional) – Sorts results by the given field. By default the results are sorted in the descending order by the session publish time.

Returns

The response from the server

Return type

Box

Examples

>>> firewall.network_objects.simple_cluster.show_simple_clusters()