Module Documentaion¶
Interfaces Module¶
Firewall Module¶
This module handles all the routing and firewall related tasks
-
robophisher.common.firewall.
clear_rules
()[source]¶ Clear(reset) all the firewall rules back to default state and return a tuple containing completion status followed by the first error that occurred or None
Returns: A tuple containing completion status followed by an error or None
Return type: namedtuple(status=bool, error_message=None or str)
Example: >>> clear_rules() Result(status=True, error_message=None)
>>> clear_rules() Result(status=False, error_message="SOME ERROR HAPPENED")
-
robophisher.common.firewall.
redirect_to_localhost
()[source]¶ Configure firewall such that all request are redirected to local host
Returns: A namedtuple containing completion status followed by an error or None
Return type: Result(status=bool, error_message=None or str)
Example: >>> redirect_to_localhost() Result(status=True, error_message=None)
>>> redirect_to_localhost() Result(status=False, error_message="SOME ERROR HAPPNED")