Network#

This class is used to manage Network

class Network#
add(name, subnet=None, subnet4=None, subnet6=None, mask_length=None, mask_length4=None, mask_length6=None, subnet_mask=None, nat_settings=None, tags=None, broadcast=None, **kw)#

Create new object.

Parameters

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

  • subnet (str, optional) – IPv4 or IPv6 network address. If both addresses are required use subnet4 and subnet6 fields explicitly. Mandatory if “subnet4” or “subnet6” is not set

  • subnet4 (str, optional) – IPv4 network address. Mandatory if “subnet” or “subnet6” is not set

  • subnet6 (str, optional) – IPv6 network address. Mandatory if “subnet” or “subnet4” is not set

  • mask_length (int, optional) – IPv4 or IPv6 network mask length. If both masks are required use mask-length4 and mask-length6 fields explicitly. Instead of IPv4 mask length it is possible to specify IPv4 mask itself in subnet-mask field. Mandatory if “mask_length4” or “mask_length6” or “subnet_mask” is not set

  • mask_length4 (int, optional) – IPv4 network mask length. Mandatory if “mask_length” or “mask_length4” or “subnet_mask” is not set

  • mask_length6 (int, optional) – IPv6 network mask length. Mandatory if “mask_length” or “mask_length6” or “subnet_mask” is not set

  • subnet_mask (str, optional) – IPv4 network mask. Mandatory if “mask_length” or “mask_length4” or “mask_length6” is not set

  • nat_settings (dict, optional) – NAT settings.

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

  • broadcast (str, optional) – Allow broadcast address inclusion.

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

>>> firewall.network_objects.network.add(name="My object")
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

>>> firewall.network_objects.network.delete(uid="d5e8d56f-2d77-4824-a5d2-c4s7885dd4z7")
set(uid=None, name=None, subnet=None, subnet4=None, subnet6=None, mask_length=None, mask_length4=None, mask_length6=None, subnet_mask=None, new_name=None, nat_settings=None, tags=None, broadcast=None, **kw)#

Create new object.

Parameters

  • uid (str) – Object unique identifier.

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

  • subnet (str) – IPv4 or IPv6 network address. If both addresses are required use subnet4 and subnet6 fields explicitly. Mandatory if “subnet4” or “subnet6” is not set

  • subnet4 (str) – IPv4 network address. Mandatory if “subnet” or “subnet6” is not set

  • subnet6 (str) – IPv6 network address. Mandatory if “subnet” or “subnet4” is not set

  • mask_length (int) – IPv4 or IPv6 network mask length. If both masks are required use mask-length4 and mask-length6 fields explicitly. Instead of IPv4 mask length it is possible to specify IPv4 mask itself in subnet-mask field. Mandatory if “mask_length4” or “mask_length6” or “subnet_mask” is not set

  • mask_length4 (int) – IPv4 network mask length. Mandatory if “mask_length” or “mask_length4” or “subnet_mask” is not set

  • mask_length6 (int) – IPv6 network mask length. Mandatory if “mask_length” or “mask_length6” or “subnet_mask” is not set

  • subnet_mask (str) – IPv4 network mask. Mandatory if “mask_length” or “mask_length4” or “mask_length6” is not set

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

  • nat_settings (dict) – NAT settings.

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

  • broadcast (str) – Allow broadcast address inclusion.

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.network.set(uid="d5e8d56f-2d77-4824-a5d2-c4s7885dd4z7",subnet="192.0.2.0",
    subnet_mask="255.255.255.0")
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.network.show(uid="d5e8d56f-2d77-4824-a5d2-c4s7885dd4z7")
show_networks(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.network.shows_networks()