Fortinet FortiOSAPI下载 - Fortinet FortiOSAPI源码下载

Fortinet FortiOSAPI

其他类别

v6.4.5

下载

Fortinet Fortigate 配置 API (FortiOS)

该库是自动生成的，如果您需要支持较新的版本，请提出问题。

用于与 Fortigate 防火墙 (FortiOS) API（CMDB（配置）、日志和监控）交互的 PHP 库。该库可以检索、创建、更新和删除防火墙上的配置。

您可以在 Fortinet 的开发者网站上找到所有支持的方法，您需要一个帐户才能浏览信息。

入门

获取作曲家。
使用 Composer composer require benclerc/fortinet-fortiosapi安装库。
将以下内容添加到应用程序的主 PHP 文件require 'vendor/autoload.php'; 。
使用防火墙的主机名、用户名和密码实例化 Config 类$configConnection = new FortinetFortiOSAPIConfig('123.123.123.123', 'admin', 'password'); 。
使用之前创建的 Config 对象实例化 FortiOSAPI 对象$firewallConf = new FortinetFortiOSAPIConfiguration($configConnection); 。
开始使用库$staticRoutes = $firewallConf->getAllRouterStatic(); 。

文档

您可以在此处找到完整的文档。

配置类

用法

该 Config 类用于准备强制配置信息以实例化和使用 FortiOSAPI... 类。在构造函数中，您必须传递：

防火墙的主机名 (FQDN) 或 IP 地址
有效用户的用户名
有效的用户密码

可选参数：

超时：5000 毫秒。使用setTimeout()来改变。
SSL 验证对等选项：TRUE。使用setSSLVerifyPeer()进行更改。
SSL 验证主机选项： 2. 使用setSSLVerifyHost()进行更改。
API 版本： 2. 使用setAPIVersion()进行更改。

示例

 // Basic configuration
$ configConnection = new  Fortinet  FortiOSAPI  Config ( ' 123.123.123.123 ' , ' admin ' , ' password ' );

// Configuration for very slow firewalls/long requests
$ configConnection = new  Fortinet  FortiOSAPI  Config ( ' 123.123.123.123 ' , ' admin ' , ' password ' );
$ configConnection -> setTimeout ( 20000 );

// Unsecure configuration
$ configConnection = new  Fortinet  FortiOSAPI  Config ( ' 123.123.123.123 ' , ' admin ' , ' password ' );
$ configConnection -> setSSLVerifyPeer ( FALSE )-> setSSLVerifyHost ( FALSE );

// Special API version
$ configConnection = new  Fortinet  FortiOSAPI  Config ( ' 123.123.123.123 ' , ' admin ' , ' password ' );
$ configConnection -> setAPIVersion ( 1 );

// The class logins to the firewall when being instanciated hence the try/catch statement.
// Here I use the class Configuration for the example but it the same for Log and Monitor classes.
try {
	$ firewallConf = new  Fortinet  FortiOSAPI  Configuration ( $ configConnection );
} catch ( Exception $ e ) {
	echo ( ' Handle error : ' . $ e -> getMessage ());
}

配置、日志和监控类

用法

这些类使用 Exception 来处理错误，对于名义执行，您应该在 try/catch 语句中实例化和请求方法。

示例

 // Get one particular static route
try {
	$ res = $ firewallConf -> getRouterStatic ( 1 );
	echo ( ' Gateway is : ' . $ res -> results [ 0 ]-> gateway );
} catch ( Exception $ e ) {
	echo ( ' Handle error : ' . $ e -> getMessage ());
}

// Get routes using filters
try {
	// Will return fields dst and status of default gateways
	$ res = $ firewallConf -> getAllRouterStatic ( NULL , NULL , NULL , NULL , NULL , NULL , [ ' dst ' , ' status ' ], [ ' dst==0.0.0.0 0.0.0.0 ' ]);
	// For obvious reasons, it would be a charm to use the new PHP 8.0 syntax to call the method :
	// $firewallConf->getAllRouterStatic(format: ['dst', 'status'], filter: ['dst==0.0.0.0 0.0.0.0'])
} catch ( Exception $ e ) {
	echo ( ' Handle error : ' . $ e -> getMessage ());
}


// Set a static route
// Define the route
$ staticRoute = new stdClass ;
$ staticRoute -> status = ' enable ' ;
$ staticRoute -> dst = ' 1.1.1.1 255.255.255.255 ' ;
$ staticRoute -> src = ' 198.168.1.0 255.255.255.0 ' ;
$ staticRoute -> gateway = ' 198.168.1.254 ' ;
$ staticRoute -> device = ' lan ' ;
$ staticRoute -> distance = 20 ;

// Send the request to the firewall
try {
	$ res = $ firewallConf -> addRouterStatic ( $ staticRoute );

	if ( $ res -> status == ' success ' ) {
		echo ( ' Route added ' );
	} else {
		echo ( ' Route adding failed ' );
	}
} catch ( Exception $ e ) {
	echo ( ' Handle error : ' . $ e -> getMessage ());
}

交易

该库还支持事务：启动事务、创建、更新、删除，并根据结果提交或中止更改。

 // Start transaction
$ firewallConf -> startTransaction ();

// Create many IP objects
$ error = FALSE ;
for ( $ i = 1 ; $ i < 50 ; $ i ++) {
	// Create body object
	$ ip = new stdClass ;
	$ ip -> name = ' IP ' . $ i ;
	$ ip -> type = ' subnet ' ;
	$ ip -> subnet = ' 10.1. ' . $ i . ' .0/24 ' ;

	// Create object on the firewall
	try {
		$ firewallConf -> addFirewallAddress ( $ ip );
		echo ( " [SUCCESS] Created IP " . $ ip -> name . " . n" );
	} catch ( Exception $ e ) {
		echo ( " [ERROR] Unable to create IP : " . $ ip -> name . " . Details : " . $ e -> getMessage (). "n" );
		$ error = TRUE ;
	}
}

// Check error
if ( $ error === FALSE ) {
	// No errors, commit
	$ firewallConf -> commitTransaction ();
} else {
	// Errors, abort and rollback
	$ firewallConf -> abortTransaction ();
}