Service GTP#

This class is used to manage Service GTP

class ServiceGTP#
add(name, version='V2', access_point_name=None, allow_usage_of_static_ip=True, apply_access_policy_on_user_traffic=None, cs_fallback_and_srvcc=True, imsi_prefix=None, interface_profile=None, ldap_group=None, ms_isdn=None, radio_access_technology=None, restoration_and_recovery=True, reverse_service=False, selection_mode=None, trace_management=True, tags=None, **kw)#

Create new object.

Parameters

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

  • version (str, optional) – GTP version

  • access_point_name (dict, optional) – Match by Access Point Name.

  • allow_usage_of_static_ip (bool, optional) – Allow usage of static IP addresses.

  • apply_access_policy_on_user_traffic (dict, optional) – Apply Access Policy on user traffic.

  • cs_fallback_and_srvcc (bool, optional) – CS Fallback and SRVCC (Relevant for V2 only). Defaults to True.

  • imsi_prefix (dict, optional) – Match by IMSI prefix.

  • interface_profile (dict, optional) – Match only message types relevant to the given GTP interface.

  • V2. (Relevant only for GTP V1 or) –

  • ldap_group (dict, optional) – Match by an LDAP Group.

  • ms_isdn (dict, optional) – Match by an MS-ISDN.

  • restoration_and_recovery (bool, optional) – Restoration and Recovery (Relevant for V2 only).

  • reverse_service (bool, optional) – Accept PDUs from the GGSN/PGW to the SGSN/SGW on a previously established PDP context, even if different ports are used.

  • selection_mode (dict, optional) – Match by a selection mode.

  • radio_access_technology (dict, optional) – Match by Radio Access Technology.

  • trace_management (bool, optional) – Trace Management (Relevant for V2 only).

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

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_gtp.add(
... name="New_gtp_Service_1",
... version="v2",
... access_point_name={"enable": False},
... allow_usage_of_static_ip=True,
... apply_access_policy_on_user_traffic={
...     "enable": False,
...     "add-imsi-field-to-log": False,
... },
... cs_fallback_and_srvcc=False,
... imsi_prefix={"enable": True, "prefix": "313460000000001"},
... interface_profile={
...     "profile": {
...         "uid": "b458696d-8967-469c-91cc-c6162c14cb27",
...         "name": "Any",
...         "type": "GTPInterfaceProfile",
...         "domain": {
...             "uid": "a0bbbc99-adef-4ef8-bb6d-defdefdefdef",
...             "name": "Check Point Data",
...             "domain-type": "data domain",
...         },
...     }
... },
... ldap_group={"enable": False, "according-to": "MS-ISDN"},
... ms_isdn={"enable": False, "ms-isdn": "1"},
... radio_access_technology={
...     "utran": False,
...     "geran": False,
...     "wlan": False,
...     "gan": False,
...     "hspa-evolution": False,
...     "eutran": False,
...     "virtual": False,
...     "nb-iot": False,
...     "other-types-range": {"enable": False, "types": ""},
... },
... restoration_and_recovery=False,
... reverse_service=False,
... selection_mode={"enable": True, "mode": 2},
... trace_management=True,
... tags=["t1"],)
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_gtp.delete(uid="ed997ff8-6709-4d71-a713-99bf01711cd5")
set(uid=None, name=None, new_name=None, version='V2', access_point_name=None, allow_usage_of_static_ip=True, apply_access_policy_on_user_traffic=None, cs_fallback_and_srvcc=True, imsi_prefix=None, interface_profile=None, ldap_group=None, ms_isdn=None, radio_access_technology=None, restoration_and_recovery=True, reverse_service=False, selection_mode=None, trace_management=True, tags=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.

  • version (str, optional) – GTP version

  • access_point_name (dict, optional) – Match by Access Point Name.

  • allow_usage_of_static_ip (bool, optional) – Allow usage of static IP addresses.

  • apply_access_policy_on_user_traffic (dict, optional) – Apply Access Policy on user traffic.

  • cs_fallback_and_srvcc (bool, optional) – CS Fallback and SRVCC (Relevant for V2 only). Defaults to True.

  • imsi_prefix (dict, optional) – Match by IMSI prefix.

  • interface_profile (dict, optional) – Match only message types relevant to the given GTP interface.

  • V2. (Relevant only for GTP V1 or) –

  • ldap_group (dict, optional) – Match by an LDAP Group.

  • ms_isdn (dict, optional) – Match by an MS-ISDN.

  • restoration_and_recovery (bool, optional) – Restoration and Recovery (Relevant for V2 only).

  • reverse_service (bool, optional) – Accept PDUs from the GGSN/PGW to the SGSN/SGW on a previously established PDP context, even if different ports are used.

  • selection_mode (dict, optional) – Match by a selection mode.

  • radio_access_technology (dict, optional) – Match by Radio Access Technology.

  • trace_management (bool, optional) – Trace Management (Relevant for V2 only).

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

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_gtp.set(
... uid="70e390d7-b070-4d6e-b8d7-53b7f6cc7fe6",
... new_name="New_gtp_Service_1",
... version="v2",
... access_point_name={"enable": False},
... allow_usage_of_static_ip=True,
... apply_access_policy_on_user_traffic={
...     "enable": False,
...     "add-imsi-field-to-log": False,
... },
... cs_fallback_and_srvcc=False,
... imsi_prefix={"enable": True, "prefix": "313460000000001"},
... interface_profile={
...     "profile": {
...         "uid": "b458696d-8967-469c-91cc-c6162c14cb27",
...         "name": "Any",
...         "type": "GTPInterfaceProfile",
...         "domain": {
...             "uid": "a0bbbc99-adef-4ef8-bb6d-defdefdefdef",
...             "name": "Check Point Data",
...             "domain-type": "data domain",
...         },
...     }
... },
... ldap_group={"enable": False, "according-to": "MS-ISDN"},
... ms_isdn={"enable": False, "ms-isdn": "1"},
... radio_access_technology={
...     "utran": False,
...     "geran": False,
...     "wlan": False,
...     "gan": False,
...     "hspa-evolution": False,
...     "eutran": False,
...     "virtual": False,
...     "nb-iot": False,
...     "other-types-range": {"enable": False, "types": ""},
... },
... restoration_and_recovery=False,
... reverse_service=False,
... selection_mode={"enable": True, "mode": 2},
... trace_management=True,
... tags=["t1"])
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_gtp.show(uid="ed997ff8-6709-4d71-a713-99bf01711cd5")
show_services_gtp(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.

Returns

The response from the server

Return type

Box

Examples

>>> FirewallManagement.service_applications.service_gtp.show_services_gtp()