def get_scanner(hass: HomeAssistant,
config: ConfigType) -> DeviceScanner | None:
"""Validate the configuration and return a FortiOSDeviceScanner."""
host = config[DOMAIN][CONF_HOST]
verify_ssl = config[DOMAIN][CONF_VERIFY_SSL]
token = config[DOMAIN][CONF_TOKEN]
fgt = FortiOSAPI()
try:
fgt.tokenlogin(host, token, verify_ssl)
except ConnectionError as ex:
_LOGGER.error("ConnectionError to FortiOS API: %s", ex)
return None
except Exception as ex: # pylint: disable=broad-except
_LOGGER.error("Failed to login to FortiOS API: %s", ex)
return None
status_json = fgt.monitor("system/status", "")
current_version = AwesomeVersion(status_json["version"])
minimum_version = AwesomeVersion("6.4.3")
if current_version < minimum_version:
_LOGGER.error(
"Unsupported FortiOS version: %s. Version %s and newer are supported",
current_version,
minimum_version,
)
return None
return FortiOSDeviceScanner(fgt)
def get_scanner(hass, config):
"""Validate the configuration and return a FortiOSDeviceScanner."""
host = config[DOMAIN][CONF_HOST]
verify_ssl = config[DOMAIN][CONF_VERIFY_SSL]
token = config[DOMAIN][CONF_TOKEN]
fgt = FortiOSAPI()
try:
fgt.tokenlogin(host, token, verify_ssl)
except ConnectionError as ex:
_LOGGER.error("ConnectionError to FortiOS API: %s", ex)
return None
except Exception as ex: # pylint: disable=broad-except
_LOGGER.error("Failed to login to FortiOS API: %s", ex)
return None
status_json = fgt.monitor("system/status", "")
fos_major_version = int(status_json["version"][1])
if fos_major_version < 6 or fos_major_version > 7:
_LOGGER.error(
"Unsupported FortiOS version, fos_major_version = %s",
fos_major_version,
)
return None
api_url = "user/device/query"
if fos_major_version == 6:
api_url = "user/device/select"
return FortiOSDeviceScanner(fgt, fos_major_version, api_url)
def get_scanner(hass, config):
"""Validate the configuration and return a FortiOSDeviceScanner."""
host = config[DOMAIN][CONF_HOST]
verify_ssl = config[DOMAIN][CONF_VERIFY_SSL]
token = config[DOMAIN][CONF_TOKEN]
fgt = FortiOSAPI()
try:
fgt.tokenlogin(host, token, verify_ssl)
except ConnectionError as ex:
_LOGGER.error("ConnectionError to FortiOS API: %s", ex)
return None
except Exception as ex: # pylint: disable=broad-except
_LOGGER.error("Failed to login to FortiOS API: %s", ex)
return None
return FortiOSDeviceScanner(fgt)
def get_scanner(hass, config):
"""Validate the configuration and return a FortiOSDeviceScanner."""
from fortiosapi import FortiOSAPI
host = str(config.get(CONF_HOST))
verify_ssl = config.get(CONF_VERIFY_SSL)
token = str(config.get(CONF_TOKEN))
_LOGGER.debug('fortios, get_scanner')
fgt = FortiOSAPI()
try:
fgt.tokenlogin(host, token)
except Exception as e:
_LOGGER.error("Unable login to fgt Exception : %s" + str(e))
try:
scanner = FortiOSDeviceScanner(fgt)
except Exception as e:
_LOGGER.error("FortiOS get_scanner Initialize failed %s" + str(e))
return False
return scanner
args.verify,
'verify',
arg_default=verify)
verbose = args.verbose
# create upload certificate FortiOSAPI object
uploadcert = FortiOSAPI()
uploadcert._session.verify = verify
if verbose:
uploadcert.debug('on')
# login to object via api token or username and password
if apitoken:
print('login via api')
uploadcert.tokenlogin(host, apitoken)
elif username:
# if password is an empty string, ask for the password
while password == '':
password = getpass()
if password != '':
print('login via provided password')
uploadcert.login(host, username, password)
else:
print("Please provide credentials")
if cafile:
caimport(uploadcert,
import_method=import_method,
cafile=cafile,
scope=scope,
class FortigateDevice:
"""
Class for a Fortigate Device. Used to more easily store and reference data pulled from FortiOS API calls
looking at using the 'fortiosapi' python library for the API call functionality. This class will store
and parse the results to something hopefully more useful, or perhaps expose more simplified methods
like get_rt_table() that then leverages the fortios library
TODO: Add some simple type hints where makes sense
TODO: methods to abstract data gathering activities and parse into more usable / normalized format.
"""
def __init__(
self,
host: Optional[str],
username: Optional[str] = None,
password: Optional[str] = None,
apitoken: Optional[str] = None,
verify: bool = True,
debug: Optional[str] = "off",
):
"""
must specify hostname / IP address of device
verify set to true as a proper secure default, however expect often to be set to False for practicality
some parameters such as timeout, cert, url_prefix exposed so they can be passed through to FortiOSAPI library
if required.
vdom_login used for login operations if logging into global (Default) or particular vdom as a device
vdom is used to pass through to FortiOSAPI library for API calls that can take a VDOM parameter.
"""
# hide the URLLIB3 SSL warnings if verify set to False
if not verify:
urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
self.host = host
self.username = username
self.password = password
self.apitoken = apitoken
self.verify = verify
self.timeout = 120
self.cert = None
self.url_prefix = None
self.vdom_login = "******"
self.vdom = None
# devapi stores the context for the FortiOSAPI class for a given device.
self.devapi = FortiOSAPI()
# set debug mode -- for now defaults to "on":
if debug == "on":
self.devapi.debug(debug)
self.facts = {}
self.route_table = None
self.route_table_size = {}
self.active_ipsec_vpns = None
self.detected_devices = None
self.interfaces = None
self.arp_table = None
self.fw_policy_ipv4 = None
self.fw_policy_ipv6 = None
self.managed_aps = None
self.wlan_connected_clients = None
self.wlan_rogue_aps = None
self.dhcp_client_leases = None
self.fw_services = None
self.fw_service_groups = None
self.fw_address_objects = None
self.fw_v6_address_objects = None
self.fw_address_groups = None
self.fw_v6_address_groups = None
self.fw_ip_pool = None
self.fw_v6_ip_pool = None
self.fw_vips = None
self.fw_v6_vips = None
self.fw_vip_groups = None
self.fw_v6_vip_groups = None
def rest_monitor_check_resp(self, resp) -> bool:
"""
helper method to check Monitor API Call responses
returns True if response is success, False otherwise
"""
if resp.get("status") != "success":
# TODO: Clean up this error and message handling
status = resp.get("status", "ERROR NO STATUS MESSAGE")
http_status = resp.get("http_status", "ERROR NO HTTP STATUS CODE!")
FORTIGATEREPR_LOGGER.error(
f"Error retrieving data: status: {status}. http_status: {http_status}"
)
FORTIGATEREPR_LOGGER.error(f"response was: {resp}")
return False
return True
def rest_check_session(self):
"""
helper wrapper for the FortiOSAPI.check_session() method
"""
try:
self.devapi.check_session()
except NotLogged:
if self.apitoken:
FORTIGATEREPR_LOGGER.info(
"Not currently logged in but apitoken set -- attempting rest api login"
)
return self.restapilogin()
except InvalidLicense:
FORTIGATEREPR_LOGGER.warning(
"License is invalid - raising exception")
raise InvalidLicense()
def clilogin(self, timeout: int = 12):
"""
MIGHT NOT BE NEEDED AS I THINK IS JUST DIFF AUTH METHOD TO WEB API!
wrapper method for the fortiosapi login method -- uses similar defaults, exposes other options such as vdom specification
"""
FORTIGATEREPR_LOGGER.debug(f"UN: {self.username}")
FORTIGATEREPR_LOGGER.debug(f"PW: {self.password}")
if not self.username or self.password is None:
FORTIGATEREPR_LOGGER.error("ERROR: Username or Password not set!")
return False
try:
r = self.devapi.login(
host=self.host,
username=self.username,
password=self.password,
verify=self.verify,
cert=self.cert,
timeout=timeout,
vdom=self.vdom_login,
)
return r
except Exception as e:
FORTIGATEREPR_LOGGER.error(f"UNKNOWN EXCEPTION: {str(e)}")
return False
def restapilogin(self, timeout: int = 12):
"""
wrapper method for the fortiosapi tokenlogin method -- uses similar defaults, exposes other options
such as vdom specification
"""
# if API token is specified, then initiate tokenlogin, otherwise for now just print message and pass
if not self.apitoken:
FORTIGATEREPR_LOGGER.warning(
"API Token not set, not performing token login.")
return False
else:
try:
self.devapi.tokenlogin(
self.host,
self.apitoken,
verify=self.verify,
cert=self.cert,
timeout=timeout,
vdom=self.vdom_login,
)
FORTIGATEREPR_LOGGER.info("API session creation success.")
return True
except TypeError:
# error handling of fortiosapi library not the best in some cases. when API token is wrong it seems to encounter TypeError
# because it can't find the 'version' key in the response, since obviously the expected response was not returned.
FORTIGATEREPR_LOGGER.warning(
"Error logging into device with API.")
return False
def ssh(self, commands, vdom=None):
"""
wrapper method for fortiosapi ssh method. Returns False if an error occurred.
"""
# if VDOM is specified, prepending the config vdom / edit vdom commands so user does not have to
if vdom is None:
vdom = self.vdom
if self.vdom is not None:
command = f"""
config vdom
edit {vdom}
{commands}
"""
else:
command = commands
try:
r = self.devapi.ssh(command, self.host, self.username,
self.password)
return r
except Exception as e:
FORTIGATEREPR_LOGGER.error(f"UNKNOWN EXCEPTION: {str(e)}")
return False
def create_admin_profile(self,
profile_type: str = "RO",
profile_name: str = None,
vdom: str = None):
"""
helper method that will create a basic Read Only (RO) or Read-Write (RW) Admin Profile to then be
assigned to an API user that needs to be created. This is meant to help enable a device for API access.
This operation is NOT idempotent. It will recreate / overwrite the profile if it already exists.
Does not currently allow specifying name of the profile
* for RO it will be "API_RO_PROFILE"
* for RW it will be "API_RW_PROFILE"
profile_name is optional. if not specified, will default to these values:
* for RO it will be "API_RO_PROFILE"
* for RW it will be "API_RW_PROFILE"
"""
# check vdom -- if vdom is None and self.vdom is None, set vdom="root", otherwise if vdom is None,
# use the object's vdom value
if vdom is None and self.vdom is None:
vdom = "root"
elif vdom is None:
vdom = self.vdom
if profile_type.upper() == "RO":
if profile_name is not None:
PROF_NAME = profile_name
else:
PROF_NAME = "API_RO_PROFILE"
cmds = RO_PROFILE_COMMANDS.format(PROF_NAME)
elif profile_type.upper() == "RW":
if profile_name is not None:
PROF_NAME = profile_name
else:
PROF_NAME = "API_RW_PROFILE"
cmds = RW_PROFILE_COMMANDS.format(PROF_NAME)
else:
raise ValueError(
f"invalid profile_type specified. must be 'RO' or 'RW'")
# create Admin Profile -- if success, returns the profile name
if self.ssh(cmds, vdom=vdom):
return PROF_NAME
def create_api_user(
self,
api_username: str,
accprofile: str,
trusted_hosts_ipv4: list,
vdom: str = None,
comment: str = None,
trusted_hosts_ipv6=None,
) -> str:
"""
Helper method to create an API account, using the ssh method under the covers. Username and password
must be specified for ssh to work. for now only supports ipv4 trusted hosts. ipv6 trusted hosts in future and optional
api_username == string (required)
accprofile == string (required) -- assumed to be valid and exist on the box already
trusted_hosts_ipv4 == list of IP / subnets in CIDR notation -- i.e. ["192.168.1.0/24", "192.168.1.1/32"]
trusted_hosts_ipv6 == None. not yet implemented to allow ipv6 trusted sources.
vdom == string. defaults to self.vdom if not specified, which if THAT is None, then will be "root"
comment == string (optional)
returns the API key of the created API user. Could set self.apitoken to this value but may not be desired
"""
# input validation:
if not isinstance(api_username, str):
raise ValueError("api_username must be a string")
elif not isinstance(accprofile, str):
raise ValueError("accprofile must be a string")
if comment is not None:
if not isinstance(comment, str):
raise ValueError(
"if comment specified, must be a string or None type")
else:
# comment is None, so set to default value
comment = "API User Account"
if not isinstance(trusted_hosts_ipv4, list):
raise ValueError(
"trusted_hosts_ipv4 must be a list of valid IP Networks in CIDR format"
)
else:
# verify address and construct string for trusthosts
str_trusted_hosts_v4 = "config trusthost\n"
for idx, addr in enumerate(trusted_hosts_ipv4, start=1):
try:
ip = ipaddress.IPv4Network(addr)
str_trusted_hosts_v4 += f"edit {idx}\nset ipv4-trusthost {ip.network_address} {ip.netmask}\nnext\n"
except (ipaddress.NetmaskValueError,
ipaddress.AddressValueError):
raise ValueError(f"{addr} is not a valid IP network.")
# check vdom -- if vdom is None and self.vdom is None, set vdom="root", otherwise if vdom is None,
# use the object's vdom value
if vdom is None and self.vdom is None:
vdom = "root"
elif vdom is None:
vdom = self.vdom
cmds = f"""config system api-user
edit "{api_username}"
set comments "{comment}"
set accprofile "{accprofile}"
set vdom "{vdom}"
{str_trusted_hosts_v4}
end
next
end
"""
# create API User
self.ssh(cmds, vdom=vdom)
# create API Key for user
gen_api_cmd = f"execute api-user generate-key {api_username}"
api_key_output = self.ssh(gen_api_cmd, vdom=vdom)
# begin TextFSM parse to get API Key from command response
template = textfsm.TextFSM(API_KEY_TEXT_FSM)
# either Paramiko or the fortiosapi ssh command escapes the new line characters, so we have to replace them back
# in order for TextFSM to parse correctly
api_key_str = api_key_output[0].replace("\\n", "\n")
parsed_data = template.ParseText(api_key_str)
# not exactly sure why, but the TextFSM-parsed value comes back as a list of lists like [['api_key_here']]
api_key = parsed_data[0][0]
return api_key
def get_facts(self, exclude_columns=None, vdom=None, as_dict=False):
"""
get device facts
TODO: Review what facts return from NAPALM and try to get all of these same things.
NAPALM get_facts() method returns dictionary of the following:
* uptime -- no REST API call??
* vendor -- set to Fortinet
* model -- no REST API call??
* hostname -- no REST API call??
* fqdn -- no REST API call??
* os_version -- can be retrieved as part of api login
* serial_number -- can be retrieved as part of api login
* interface_list -- retrieved via /system/available-interfaces/select -- can populate device interface table at same time
method sets the various self.facts dictionary keys, but by default returns a DataFrame representation
"""
# TODO: Set each self.facts[VARIABLE]
# NOTE: Some facts can get set during the API login
if vdom is None:
vdom = self.vdom
self.facts["vendor"] = "Fortinet"
self.facts["model"] = "Fortigate Model TBD"
self.facts["uptime"] = None
self.facts["hostname"] = None
self.facts["fqdn"] = None
self.facts["os_version"] = None
self.facts["serial_number"] = None
# if interface_list has not been populated, set to None.
if not self.facts.get("interface_list"):
self.facts["interface_list"] = None
self.rest_check_session()
if self.interfaces is None:
self.get_interfaces(vdom=self.vdom)
self.facts["interface_list"] = self.interfaces["name"].tolist()
basic_facts = self.devapi.monitor("system/status", "select", vdom=vdom)
if not self.rest_monitor_check_resp(basic_facts):
FORTIGATEREPR_LOGGER.warning(
"Response encountered error, returning None.")
return None
self.facts["serial_number"] = basic_facts.get("serial")
self.facts[
"os_version"] = f"{basic_facts.get('version')} build {basic_facts.get('build')}"
# as of now facts are a dict, to normalize to a simple DataFrame...
self.facts_df = pd.DataFrame.from_dict(self.facts, orient="index")
if as_dict is True:
return self.facts
return self.facts_df
def get_arp_table(self, exclude_columns=None, vdom=None):
"""
gets ARP table from device -- currently only available via SSH command, then parses it using TextFSM
"""
if vdom is None:
vdom = self.vdom
base_arp_command = "get system arp"
if self.vdom is not None:
command = f"""
config vdom
edit {vdom}
{base_arp_command}
"""
else:
command = base_arp_command
# get arp table via SSH:
# command = "get system arp"
arp_table = self.devapi.ssh(command, self.host, self.username,
self.password)
# successful response is a tuple where 0 position is the result, and 1 position is stderr response from paramiko
# 0 position success is a list of strings, first line is prompt + header of cmd output, next lines are output itself,
# then usually a blank line, followed by prompt
# TestFSM is able to parse it properly if we convert it properly
template = None
# this needs error handling if file not found??
template = textfsm.TextFSM(ARP_TEXT_FSM)
COLUMNS = ["Address", "Age(min)", "MAC Address", "Interface"]
# either Paramiko or the fortiosapi ssh command escapes the new line characters, so we have to replace them back
# in order for TextFSM to parse correctly
arp_table = arp_table[0].replace("\\n", "\n")
parsed_data = template.ParseText(arp_table)
data = FortigateArpTable(columns=COLUMNS, data=parsed_data)
# data.clean_data()
self.arp_table = data
return self.arp_table
def get_active_ipsec_vpns(self, exclude_columns=None, vdom=None):
if vdom is None:
vdom = self.vdom
self.rest_check_session()
vpn_info = self.devapi.monitor("vpn/ipsec", "select", vdom=vdom)
if not self.rest_monitor_check_resp(vpn_info):
FORTIGATEREPR_LOGGER.error(
"Response encountered error, returning None.")
return None
data = FortigateActiveIpsecVpns(vpn_info.get("results"))
data.clean_data()
# data = data.get(exclude_columns=exclude_columns)
self.active_ipsec_vpns = data
return self.active_ipsec_vpns
def get_route_table(self, exclude_columns=None, vdom=None):
"""
queries API and sets device object's route_table parameter and returns the value
"""
if vdom is None:
vdom = self.vdom
self.rest_check_session()
route_table_info = self.devapi.monitor("router/ipv4",
"select",
vdom=vdom)
if not self.rest_monitor_check_resp(route_table_info):
FORTIGATEREPR_LOGGER.error(
"Response encountered error, returning None.")
return None
data = FortigateRouteTable(route_table_info.get("results"))
# data.clean_data()
# data = data.get(exclude_columns=exclude_columns)
self.route_table = data
# get route table size info and store in Object (not returned):
route_table_size = self.devapi.monitor("router/statistics",
"select",
vdom=vdom)
if not self.rest_monitor_check_resp(route_table_size):
FORTIGATEREPR_LOGGER.error(
"Response encountered error, returning None.")
return None
data = route_table_size.get("results")
self.route_table_size["total_routes"] = data.get("total_lines")
self.route_table_size["ipv4_routes"] = data.get("total_lines_ipv4")
self.route_table_size["ipv6_routes"] = data.get("total_lines_ipv6")
return self.route_table
def get_detected_devices(self, exclude_columns=None, vdom=None):
if vdom is None:
vdom = self.vdom
self.rest_check_session()
result = self.devapi.monitor("user/detected-device",
"select",
vdom=vdom)
if not self.rest_monitor_check_resp(result):
FORTIGATEREPR_LOGGER.error(
"Response encountered error, returning None.")
return None
data = ForitgateDetectedDevices(result.get("results"))
# data.clean_data()
self.detected_devices = data
return self.detected_devices
def get_interfaces(self, exclude_columns=None, vdom=None):
if vdom is None:
vdom = self.vdom
self.rest_check_session()
# if interfaces not already populated from get_facts, then get the interface data:
if self.interfaces is None:
result = self.devapi.monitor("system/available-interfaces",
"select",
vdom=vdom)
if not self.rest_monitor_check_resp(result):
FORTIGATEREPR_LOGGER.error(
"Response encountered error, returning None.")
return None
data = FortigateInterfaceDetails(result.get("results"))
data.clean_data()
self.interfaces = data
return self.interfaces
def get_fw_policy_ipv4(self, vdom=None):
"""
get Firewall's configured ipv4 security policy
"""
if vdom is None:
vdom = self.vdom
self.rest_check_session()
if self.fw_policy_ipv4 is None:
result = self.devapi.get("firewall", "policy", vdom=vdom)
if not self.rest_monitor_check_resp(result):
FORTIGATEREPR_LOGGER.error(
"Response encountered error, returning None.")
return None
data = FortigateFirewallPolicy(result.get("results"))
data.clean_data()
self.fw_policy_ipv4 = data
return self.fw_policy_ipv4
def get_fw_policy_ipv6(self, vdom=None):
"""
get Firewall's configured ipv6 security policy
"""
if vdom is None:
vdom = self.vdom
self.rest_check_session()
if self.fw_policy_ipv6 is None:
result = self.devapi.get("firewall6", "policy", vdom=vdom)
if not self.rest_monitor_check_resp(result):
FORTIGATEREPR_LOGGER.error(
"Response encountered error, returning None.")
return None
data = FortigateFirewallPolicy(result.get("results"))
data.clean_data()
self.fw_policy_ipv6 = data
return self.fw_policy_ipv6
def get_managed_aps(self, vdom=None):
"""
get Firewall's managed AP Details
"""
if vdom is None:
vdom = self.vdom
self.rest_check_session()
if self.managed_aps is None:
result = self.devapi.monitor("wifi/managed_ap",
"select",
vdom=vdom)
if not self.rest_monitor_check_resp(result):
FORTIGATEREPR_LOGGER.error(
"Response encountered error, returning None.")
return None
data = FortigateManagedAps(result.get("results"))
data.clean_data()
self.managed_aps = data
return self.managed_aps
def get_wlan_connected_clients(self, vdom=None):
"""
get Firewall's managed AP Details
"""
if vdom is None:
vdom = self.vdom
self.rest_check_session()
if self.wlan_connected_clients is None:
result = self.devapi.monitor("wifi/client", "select", vdom=vdom)
if not self.rest_monitor_check_resp(result):
FORTIGATEREPR_LOGGER.error(
"Response encountered error, returning None.")
return None
data = FortigateWlanConnectedClients(result.get("results"))
data.clean_data()
self.wlan_connected_clients = data
return self.wlan_connected_clients
def get_wlan_rogue_aps(self, vdom=None):
"""
get Firewall's managed AP Details
"""
if vdom is None:
vdom = self.vdom
self.rest_check_session()
if self.wlan_rogue_aps is None:
result = self.devapi.monitor("wifi/rogue_ap", "select", vdom=vdom)
if not self.rest_monitor_check_resp(result):
FORTIGATEREPR_LOGGER.error(
"Response encountered error, returning None.")
return None
data = FortigateWlanRogueAps(result.get("results"))
data.clean_data()
self.wlan_rogue_aps = data
return self.wlan_rogue_aps
def get_dhcp_client_leases(self, vdom=None) -> pd.DataFrame:
"""
get Firewall's managed AP Details
"""
if vdom is None:
vdom = self.vdom
self.rest_check_session()
if self.dhcp_client_leases is None:
result = self.devapi.monitor("system/dhcp", "select", vdom=vdom)
if not self.rest_monitor_check_resp(result):
FORTIGATEREPR_LOGGER.error(
"Response encountered error, returning None.")
return None
data = FortigateDhcpClientLeases(result.get("results"))
data.clean_data()
self.dhcp_client_leases = data
return self.dhcp_client_leases
def get_fw_services(self, vdom=None) -> pd.DataFrame:
"""
get Firewall's Service Definitions
"""
if vdom is None:
vdom = self.vdom
self.rest_check_session()
if self.fw_services is None:
result = self.devapi.get("firewall.service", "custom", vdom=vdom)
if not self.rest_monitor_check_resp(result):
FORTIGATEREPR_LOGGER.error(
"Response encountered error, returning None.")
return None
data = FortigateServices(result.get("results"))
data.clean_data()
self.fw_services = data
return self.fw_services
def get_fw_service_groups(self, vdom=None) -> pd.DataFrame:
"""
get Firewall's Service Group Definitions
"""
if vdom is None:
vdom = self.vdom
self.rest_check_session()
if self.fw_service_groups is None:
result = self.devapi.get("firewall.service", "group", vdom=vdom)
if not self.rest_monitor_check_resp(result):
FORTIGATEREPR_LOGGER.error(
"Response encountered error, returning None.")
return None
data = FortigateServiceGroups(result.get("results"))
data.clean_data()
self.fw_service_groups = data
return self.fw_service_groups
def get_fw_address_objects(self,
vdom=None,
ip_version: int = 4) -> pd.DataFrame:
"""
get Firewall's Address Object Definitions
specify ip_version = 4 or ip_version = 6 to get IPv4 (the default) or IPv6 objects
"""
if vdom is None:
vdom = self.vdom
self.rest_check_session()
if ip_version == 4:
if self.fw_address_objects is None:
result = self.devapi.get("firewall", "address", vdom=vdom)
if not self.rest_monitor_check_resp(result):
FORTIGATEREPR_LOGGER.error(
"Response encountered error, returning None.")
return None
data = FortigateAddressObjects(result.get("results"))
data.clean_data()
self.fw_address_objects = data
return self.fw_address_objects
elif ip_version == 6:
if self.fw_v6_address_objects is None:
result = self.devapi.get("firewall", "address6", vdom=vdom)
if not self.rest_monitor_check_resp(result):
FORTIGATEREPR_LOGGER.error(
"Response encountered error, returning None.")
return None
data = FortigateAddressObjects(result.get("results"))
data.clean_data()
self.fw_v6_address_objects = data
return self.fw_v6_address_objects
def get_fw_address_groups(self,
vdom=None,
ip_version: int = 4) -> pd.DataFrame:
"""
get Firewall's Address Group Definitions
specify ip_version = 4 or ip_version = 6 to get IPv4 (the default) or IPv6 Groups
"""
if vdom is None:
vdom = self.vdom
self.rest_check_session()
if ip_version == 4:
if self.fw_address_groups is None:
result = self.devapi.get("firewall", "addrgrp", vdom=vdom)
if not self.rest_monitor_check_resp(result):
FORTIGATEREPR_LOGGER.error(
"Response encountered error, returning None.")
return None
data = FortigateAddressGroups(result.get("results"))
data.clean_data()
self.fw_address_groups = data
return self.fw_address_groups
elif ip_version == 6:
if self.fw_v6_address_groups is None:
result = self.devapi.get("firewall", "addrgrp6", vdom=vdom)
if not self.rest_monitor_check_resp(result):
FORTIGATEREPR_LOGGER.error(
"Response encountered error, returning None.")
return None
data = FortigateAddressGroups(result.get("results"))
data.clean_data()
self.fw_v6_address_groups = data
return self.fw_v6_address_groups
def get_fw_ip_pool(self, vdom=None, ip_version: int = 4) -> pd.DataFrame:
"""
get Firewall's IP Pool Definitions
specify ip_version = 4 or ip_version = 6 to get IPv4 (the default) or IPv6 IP Pools
"""
if vdom is None:
vdom = self.vdom
self.rest_check_session()
if ip_version == 4:
if self.fw_ip_pool is None:
result = self.devapi.get("firewall", "ippool", vdom=vdom)
if not self.rest_monitor_check_resp(result):
FORTIGATEREPR_LOGGER.error(
"Response encountered error, returning None.")
return None
data = FortigateIpPool(result.get("results"))
data.clean_data()
self.fw_ip_pool = data
return self.fw_ip_pool
elif ip_version == 6:
if self.fw_v6_ip_pool is None:
result = self.devapi.get("firewall", "ippool6", vdom=vdom)
if not self.rest_monitor_check_resp(result):
FORTIGATEREPR_LOGGER.error(
"Response encountered error, returning None.")
return None
data = FortigateIpPool(result.get("results"))
data.clean_data()
self.fw_v6_ip_pool = data
return self.fw_v6_ip_pool
def get_fw_vips(self, vdom=None, ip_version: int = 4) -> pd.DataFrame:
"""
get Firewall's IP Pool Definitions
specify ip_version = 4 or ip_version = 6 to get IPv4 (the default) or IPv6 IP Pools
"""
if vdom is None:
vdom = self.vdom
self.rest_check_session()
if ip_version == 4:
if self.fw_vips is None:
result = self.devapi.get("firewall", "vip", vdom=vdom)
if not self.rest_monitor_check_resp(result):
FORTIGATEREPR_LOGGER.error(
"Response encountered error, returning None.")
return None
data = FortigateVips(result.get("results"))
data.clean_data()
self.fw_vips = data
return self.fw_vips
elif ip_version == 6:
if self.fw_v6_vips is None:
result = self.devapi.get("firewall", "vip6", vdom=vdom)
if not self.rest_monitor_check_resp(result):
FORTIGATEREPR_LOGGER.error(
"Response encountered error, returning None.")
return None
data = FortigateVips(result.get("results"))
data.clean_data()
self.fw_v6_vips = data
return self.fw_v6_vips
def get_fw_vip_groups(self,
vdom=None,
ip_version: int = 4) -> pd.DataFrame:
"""
get Firewall's IP Pool Definitions
specify ip_version = 4 or ip_version = 6 to get IPv4 (the default) or IPv6 IP Pools
"""
if vdom is None:
vdom = self.vdom
self.rest_check_session()
if ip_version == 4:
if self.fw_vip_groups is None:
result = self.devapi.get("firewall", "vipgrp", vdom=vdom)
if not self.rest_monitor_check_resp(result):
FORTIGATEREPR_LOGGER.error(
"Response encountered error, returning None.")
return None
data = FortigateVipGroups(result.get("results"))
data.clean_data()
self.fw_vip_groups = data
return self.fw_vip_groups
elif ip_version == 6:
if self.fw_v6_vip_groups is None:
result = self.devapi.get("firewall", "vipgrp6", vdom=vdom)
if not self.rest_monitor_check_resp(result):
FORTIGATEREPR_LOGGER.error(
"Response encountered error, returning None.")
return None
data = FortigateVipGroups(result.get("results"))
data.clean_data()
self.fw_v6_vip_groups = data
return self.fw_v6_vip_groups