the gatepy module reference

class gatepy.FortinetFortiGateMonitor

This class will be used to provide easy access to monitor endpoints of FortiOS API.

get_monitor_firewall_policy_lookup(srcintf=None, sourceip=None, protocol=None, dest=None, destport=None)

Performs a policy lookup by creating a dummy packet and asking the kernel which policy would be hit.

Parameters:
  • ipv6 (bool, optional) – Perform an IPv6 lookup
  • srcintf (str) – Source Interface
  • sourceport (int, optional) – Source Port
  • sourceip (str) – Source IP
  • protocol (str) – Protocol
  • dest (str) – Destination IP/FQDN
  • destport (int) – Destination Port
  • icmptype (int, optional) – ICMP Type
  • icmpcode (int, optional) – ICMP Code
Returns:

Policy ID of matched policy lookup
get_monitor_firewall_policy(policyid=None)

List traffic statistics for IPv4 policies.

Parameters:policyid (int, optional) – Filter by Policy ID
Returns:Traffic statistics for IPv4 policies.
get_monitor_log_device_state()

Retrieve information on state of log devices.

Returns:Retrieve information on state of log devices.
get_monitor_router_ipv4()

List all active IPv4 routing table entries

Returns:NA
get_monitor_system_available_interfaces(view_type=None)

Retrieve a list of all interfaces along with some meta information regarding their availability.

Parameters:view_type (str, optional) –

Include additional information for interfaces, valid options are:

  • ’poe’: Includes PoE information for supported ports.
  • ’ha’: Includes extra meta information useful when dealing with interfaces related to HA configuration. Interfaces that are used by an HA cluster as management interfaces are also included in this view.
  • ’zone’: Includes extra meta information for determining zone membership eligibility.
  • ’vwp’: Includes extra meta information for determining virtual wire pair eligibility.
Returns:Retrieve a list of all interfaces along with some meta information regarding their availability.
get_monitor_system_config_backup(scope='global', vdom=None)

List all active IPv4 routing table entries

Parameters:
  • scope (str) – global or vdom
  • vdom (str, optional) – vdom name
Returns:

None