A Python wrapper for the FortiManager JSON RPC API.
*** Video Tutorial to use the package is available on YouTube ***
Use the package manager pip to install pyFortiManagerAPI.
pip install pyFortiManagerAPI- Creating Instance of the Module
import pyFortiManagerAPI
fortimngr = pyFortiManagerAPI.FortiManager(host="",
username="",
password="")Required settings:
- host: Management Ip address of your FortiManager
- username/password: Specify your credentials to log into the device.
Optional settings:
- adom: Default is adom=root.
- protocol: Default is protocol=https. If set to protocol=http, then verify=False is set automatically.
- verify: Default is verify=True. If your Fortimanager has a self-signed certificate, set verify=False.
- proxies: Default is an empty dictionary (which means: use the environement variables). If you dont' want to use proxies, even if they are defined in your environment variables, then set 'proxies' to false. If you want to use other proxies than defined in your environment then you go like this:
proxies = { 'http': 'http://10.10.1.10:3128', 'https': 'http://10.10.1.10:1080' }
>>> fortimngr.get_adoms()>>> fortimngr.get_adoms(name="root")- name: Can get specific adom using name as a filter.
>>> fortimngr.set_adom("adom_name")- name of the admon you want to switch to.
>>> fortimngr.lock_adom()>>> fortimngr.lock_adom(name="root")- name: Can lock specific adom using name as a filter.
>>> fortimngr.unlock_adom()>>> fortimngr.unlock_adom(name="root")- name: Can lock specific adom using name as a filter.
>>> fortimngr.get_policy_packages()>>> fortimngr.get_policy_packages(name="default")- name: Can get specific package using name as a filter.
>>> fortimngr.add_policy_package(name="TestPackage")- name: Specify the Package Name.
>>> fortimngr.get_firewall_address_objects()>>> fortimngr.get_firewall_address_v6_objects()>>> fortimngr.get_firewall_address_objects(name="YourObjectName")
>>> fortimngr.get_firewall_address_v6_objects(name="YourObjectName")- name: Specify object name that you want to see.
>>> fortimngr.add_firewall_address_object(name="TestObject",
associated_interface="any",
subnet=["1.1.1.1", "255.255.255.255"]
)- name: Specify object name that is to be created
- associated_interface: Provide interface to which this object belongs if any. {Default is kept any}
- subnet: Specify the subnet in a list format eg.["1.1.1.1", "255.255.255.255"]
>>> fortimngr.add_firewall_address_v6_object(name="TestObject",
subnet6="2001:0001:0001::2/128"]
)- name: Specify object name that is to be created
- associated_interface: Provide interface to which this object belongs if any. {Default is kept any}
- subnet: Specify the subnet in a list format eg.["1.1.1.1", "255.255.255.255"]
- subnet6 : Specify the subnet IPv6 in a string format eg. "2001:0001::1/128"
>>> fortimngr.update_firewall_address_object(name="TestObject",
associate_interface="port1",
comment="Updated using API",
subnet=["2.2.2.2","255.255.255.255"]
)
>>> fortimngr.update_firewall_address_v6_object(name="TestObject",
comment="Updated using API",
subnet6="2001:0001::1/128"
)- name: Enter the name of the object that needs to be updated
- data: You can get the **kwargs parameters with "show_params_for_object_update()" method or "
>>> fortimngr.delete_firewall_address_object(object_name="TestObject")- object_name: Specify the Object name you want to delete.
>>> fortimngr.get_address_groups()
>>> fortimngr.get_address_v6_groups()>>> fortimngr.get_address_groups(name="TestGroup")
>>> fortimngr.get_address_v6_groups(name="TestGroup")- name: Specify the name the address group.
>>> fortimngr.add_address_group(name="Test_Group",
members=["TestObject1"])
>>> fortimngr.add_address_v6_group(name="Test_Group",
members=["TestObject1"])- name: Enter the name of the address group. eg."Test_Group"
- members: pass your object names as members in a list eg. ["TestObject1", "TestObject2"]
Note: An address group should consist atleast 1 member.
>>> fortimngr.update_address_group(name="Test_Group",
object_name="TestObject3",
do="add")
>>> fortimngr.update_address_v6_group(name="Test_Group",
object_name="TestObject3",
do="add")- name: Specify the name of the Address group you want to update
- object_name: Specify name of the object you wish to update(add/remove) in Members List
- do: Specify if you want to add or remove the object from the members list do="add" will add the object in the address group do="remove" will remove the object from address group
>>> fortimngr.delete_address_group(name="Test_group")
>>> fortimngr.delete_address_v6_group(name="Test_group")- name: Specify the name of the address group you wish to delete
>>> fortimngr.get_firewall_vip_objects()Add an existing device:
>>> fortimngr.add_device(ip_address="192.168.0.100",
username="admin",
password="",
name="FortiGateVM64",
description=False)or model a device that is to be deployed:
>>> fortimngr.add_model_device(serial_no="FGTxxxxxxxx",
name="FortiGateVM64")
username="admin",
password="", Required arguments:
- serial_no
- name
Optional arguments:
- username (default=admin)
- password (default="")
- os_type (default="fos")
- os_ver (default=6)
- mr (default=4)
- platform_str (default "", "FortiGate-VM64" for virtual Fortigate)
>>> fortimngr.get_devices()>>> fortimngr.get_meta_data()>>> fortimngr.add_meta_data(name="Meta_Data_1",
status=1)- :param name: name of the meta tag
- :param status: status of meta tag whether it should be active(1) or disabled(0)
>>> fortimngr.assign_meta_to_device(device="FortiGateVM64",
meta_name="Meta_Data_1",
meta_value="192.168.0.1/24")- :param device: name of the device
- :param meta_name: name of the meta tag
- :param meta_value: value of the meta tag
>>> fortimngr.assign_meta_to_device_vdom(device="FortiGateVM64",
vdom="vdom",
meta_name="Meta_Data_1",
meta_value="192.168.0.1/24")- :param device: name of the device
- :param vdom: Specify the Vdom
- :param meta_name: name of the meta tag
- :param meta_value: value of the meta tag
>>> fortimngr.get_firewall_policies(policy_package_name="YourPolicyPackageName")- policy_package_name: Enter the policy package name.
>>> fortimngr.get_firewall_policies(policy_package_name="YourPolicyPackageName", policyid=3)- policy_package_name: Enter the policy package name.
- policyid: Can filter and get the policy you want using policyID
fortimngr.get_global_header_policies
fortimngr.get_firewall_header_policies
fortimngr.get_global_footer_policies
fortimngr.get_firewall_footer_policies
>>> fortimngr.add_firewall_policy(policy_package_name="YourPolicyPackageName",
name="YourPolicyName",
source_interface="port1",
source_address="all",
destination_interface="port2",
destination_address="all",
service="ALL_TCP",
logtraffic=2
)
>>> fortimngr.add_firewall_policy_with_v6(policy_package_name="YourPolicyPackageName",
name="YourPolicyName",
source_interface="port1",
source_address="all",
source_address6="all",
destination_interface="port2",
destination_address="all",
destination_address6="all",
service="ALL_TCP",
logtraffic=2
)- policy_package_name: Enter the name of the policy package eg. "default"
- name: Enter the policy name in a string format eg. "Test Policy"
- source_interface: Enter the source interface in a string format eg. "port1"
- source_address: Enter the src. address object name in string format or list
- source_address6: Enter the src. address v6 object name in string format or list
- destination_interface: Enter the source interface in a string format eg. "port2"
- destination_address: Enter the dst. address object name eg. "WAN_100.25.1.63_32"
- destination_address6: Enter the dst. address v6 object name in string format or list
- service: Enter the service you want to permit or deny in string eg. "ALL_UDP"
- schedule: Schedule time is kept 'always' as default.
- action: Permit(1) or Deny(0) the traffic. Default is set to Permit.
- logtraffic: Specify if you need to log all traffic or specific in int format.
-
logtraffic=0 Means No Log logtraffic=1 Means Log Security Events logtraffic=2 Means Log All Sessions
>>> fortimngr.update_firewall_policy(policy_package_name="YourPolicyPackageName",
policyid=10,
source_interface="port2",
action=1,
)- policy_package_name: Enter the policy package name in which you policy belongs.
- policyid: Enter the Policy ID you want to edit
- data: You can get the **kwargs parameters with "show_params_for_policy_update()" method
>>> fortimngr.delete_firewall_policy(policy_package_name="YourPolicyPackageName",
policyid=10)- policy_package_name: Enter the policy package name in which you policy belongs
- policyid: Enter the policy ID of the policy you want to delete
>>> fortimngr.move_firewall_policy(policy_package_name="LocalLab",
move_policyid=10,
option="after",
policyid=2)- policy_package_name: Enter the policy package name in which you policy belongs.
- move_policyid: Enter the policy ID of the policy you want to move.
- option: Specify if you want to move the policy above("before") the target policy or below("after") {default: before}.
- policyid: Specify the target policy.
>>> fortimngr.install_policy_package(package_name="Your Policy Package name")>>> fortimngr.add_install_target(device_name="FortiGateVM64",
pkg_name="Test_Policy_Pakage",
vdom="root")- :param device_name: name of the device
- :param pkg_name: name of the policy package
- :param vdom: name of the vdom (default=root)
>>> fortimngr.show_params_for_object_update() Parameters to create/update address object:
PARAMETERS FIREWALL OBJECT SETTINGS
allow_routing(int) : Static Route Configuration
associated_interface(str) : Interface
comment(str) : Comments
object_name(str) : Address Name
subnet[list] : IP/Netmask
object_type(int) : Type
>>> fortimngr.show_params_for_policy_update() Parameters to create/update Policy:
PARAMETERS FIREWALL POLICY SETTINGS
name(str) : Name
source_interface(str) : Incoming Interface
source_address(str) : Source Address
destination_interface(str) : Destination Interface
destination_address(str) : Destination Address
service(str) : Service
schedule(str) : Schedule
action(int) : Action
logtraffic(int) : Log Traffic
comment(str) : Comments
>>> fortimngr.create_script(name="Test Script Template",
script_content="config system interface \n edit port 1 \n set ip 1.1.1.1/24",
target=0)- :param name: Specify a name for the script
- :param script_content: write the cli commands
- :param target: Set the target
If Target = 0 than script runs on Device database
If Target = 1 than script runs on Remote FortiGate CLI
If Target = 2 than script runs on Policy package or Adom Database
Default value is set to 0
>>> fortimngr.get_all_scripts()>>> fortimngr.delete_script(name="Test Script Template")- :param name: Specify a name for the script tha need to be deleted.
>>> fortimngr.run_script_on_single_device(script_name="test_script",
device_name="FortiGate-VM64",
vdom="root")- :param device_name: Specify device name.
- :param vdom: Specify the Vdom
- :param script_name: Specify the script name that should be executed on the specified devices
>>> fortimngr.run_script_on_multiple_devices(script_name="test_script",
devices=[{"name":"FortiGate-VM64", "vdom": "root"},
{"name":"Test-FortiGate-VM64", "vdom": "global"},
{"name":"Test-2-FortiGate-VM64", "vdom": "Test"}])- :param devices: Specify devices in a list of dictionaries.
eg. devices=[{"name": "FortiGateVM64-1", "vdom": "root"},
{"name": "FortiGateVM64-2", "vdom": "test"}
{"name": "FortiGateVM64-3", "vdom": "root"}]
- :param script_name: Specify the script name that should be executed on the specified devices
>>> fortimngr.backup_config_of_fortiGate_to_tftp(tftp_ip="1.1.1.1",
path="/FortiGate_backups",
filename="FortiGate.conf",
device_name="FortiGate-VM64", vdom="root")####A small function to back up configuration on FortiGates from FortiManager and store it in TFTP Server. This function leverages create_script() and run_script_on_single_device() methods from this package to backup the config.
- :param tftp_ip: Specify TFTP Server IP
- :param path: Specify the path to store the config
- :param filename: Specify the name of the backup file
- :param device_name: Specify the name of the device
- :param vdom: Specify the Vdom
- Being new to Python and this being my first publish, to get this module fully working for all of us, the Pull requests are welcome.