Service TCP#

This class is used to manage Service TCP

class ServiceTCP#
add(name, aggressive_aging=None, keep_connections_open_after_policy_installation=None, match_by_protocol_signature=False, match_for_any=None, override_default_settings=None, port=None, protocol=None, session_timeout=None, source_port=None, sync_connections_on_cluster=None, tags=None, use_default_session_timeout=None, **kw)#

Create new object.

Parameters

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

  • aggressive_aging (dict, optional) – Sets short (aggressive) timeouts for idle connections.

  • keep_connections_open_after_policy_installation (bool, optional) – Keep connections open after policy has been installed even if they are not allowed under the new policy. This overrides the settings in the Connection Persistence page. If you change this property, the change will not affect open connections, but only future connections.

  • match_by_protocol_signature (bool, optional) – A value of true enables matching by the selected protocol’s signature - the signature identifies the protocol as genuine. Select this option to limit the port to the specified protocol.If the selected protocol does not support matching by signature, this field cannot be set to true.

  • match_for_any (bool, optional) – Indicates whether this service is used when ‘Any’ is set as the rule’s service and there are several service objects with the same source port and protocol.

  • override_default_settings (bool, optional) – Indicates whether this service is a Data Domain service which has been overridden

  • port (str, optional) – The number of the port used to provide this service. To specify a port range, place a hyphen between the lowest and highest port numbers, for example 44-55.

  • protocol (str, optional) – Select the protocol type associated with the service, and by implication, the management server (if any) that enforces Content Security and Authentication for the service. Selecting a Protocol Type invokes the specific protocol handlers for each protocol type, thus enabling higher level of security by parsing the protocol, and higher level of connectivity by tracking dynamic actions (such as opening of ports).

  • session_timeout (int, optional) – Time (in seconds) before the session times out.

  • source_port (str, optional) – Port number for the client side service. If specified, only those Source port Numbers will be Accepted, Dropped, or Rejected during packet inspection. Otherwise, the source port is not inspected.

  • sync_connections_on_cluster (bool, optional) – Enables state-synchronized High Availability or Load Sharing on a ClusterXL or OPSEC-certified cluster.

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

  • use_default_session_timeout (bool, optional) – Use default virtual session timeout.

Keyword Arguments

  • **set-if-exists (bool, optional) – If another object with the same identifier already exists, it will be updated. The command behaviour will be the same as if originally a set command was called. Pay attention that original object’s fields will be overwritten by the fields provided in the request payload!

  • **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

>>> firewallManagement.service_applications.service_tcp.add(
... name="New_TCP_Service_1",
... port=5669,
... keep_connections_open_after_policy_installation=False,
... session_timeout=0,
... match_for_any=True,
... sync_connections_on_cluster=True,
... aggressive_aging={"enable": True, "timeout": 360, "use-default-timeout": False})
delete(uid=None, name=None, **kw)#

Delete 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.

  • **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

>>> FirewallManagement.service_applications.service_tcp.delete(uid="ed997ff8-6709-4d71-a713-99bf01711cd5")
set(uid=None, name=None, new_name=None, aggressive_aging=None, keep_connections_open_after_policy_installation=None, match_by_protocol_signature=False, match_for_any=None, override_default_settings=None, port=None, protocol=None, session_timeout=None, source_port=None, sync_connections_on_cluster=None, tags=None, use_default_session_timeout=None, **kw)#

Edit existing object using object name or uid.

Parameters

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

  • name (str, optional) – Object name.

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

  • aggressive_aging (dict, optional) – Sets short (aggressive) timeouts for idle connections.

  • keep_connections_open_after_policy_installation (bool, optional) – Keep connections open after policy has been installed even if they are not allowed under the new policy. This overrides the settings in the Connection Persistence page. If you change this property, the change will not affect open connections, but only future connections.

  • match_by_protocol_signature (bool, optional) – A value of true enables matching by the selected protocol’s signature - the signature identifies the protocol as genuine. Select this option to limit the port to the specified protocol.If the selected protocol does not support matching by signature, this field cannot be set to true.

  • match_for_any (bool, optional) – Indicates whether this service is used when ‘Any’ is set as the rule’s service and there are several service objects with the same source port and protocol.

  • override_default_settings (bool, optional) – Indicates whether this service is a Data Domain service which has been overridden

  • port (str, optional) – The number of the port used to provide this service. To specify a port range, place a hyphen between the lowest and highest port numbers, for example 44-55.

  • protocol (str, optional) – Select the protocol type associated with the service, and by implication, the management server (if any) that enforces Content Security and Authentication for the service. Selecting a Protocol Type invokes the specific protocol handlers for each protocol type, thus enabling higher level of security by parsing the protocol, and higher level of connectivity by tracking dynamic actions (such as opening of ports).

  • session_timeout (int, optional) – Time (in seconds) before the session times out.

  • source_port (str, optional) – Port number for the client side service. If specified, only those Source port Numbers will be Accepted, Dropped, or Rejected during packet inspection. Otherwise, the source port is not inspected.

  • sync_connections_on_cluster (bool, optional) – Enables state-synchronized High Availability or Load Sharing on a ClusterXL or OPSEC-certified cluster.

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

  • use_default_session_timeout (bool, optional) – Use default virtual session timeout.

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

>>> firewallManagement.service_applications.service_tcp.set(uid="ed997ff8-6709-4d71-a713-99bf01711cd5",
new_name="New Service TCP")
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

>>> FirewallManagement.service_applications.service_tcp.show(uid="ed997ff8-6709-4d71-a713-99bf01711cd5")
show_services_tcp(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.

  • show_as_ranges (bool, optional) – When true, the group’s matched content is displayed as ranges of IP addresses rather than network objects. Objects that are not represented using IP addresses are presented as objects. The ‘members’ parameter is omitted from the response and instead the ‘ranges’ parameter is displayed. Defaults to False.

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.

  • **domains-to-process (List[str], optional) – Indicates which domains to process the commands on. It cannot be used with the details-level full, must be run from the System Domain only and with ignore-warnings true. Valid values are: CURRENT_DOMAIN, ALL_DOMAINS_ON_THIS_SERVER.

  • **show-membership (bool, optional) – Indicates whether to calculate and show “groups” field for every object in reply.

Returns

The response from the server

Return type

Box

Examples

>>> FirewallManagement.service_applications.service_tcp.shows_services_tcp()