pyfgt 0.5.1

概要

表示Fortinet Fortigate Rest接口的基本组件。此代码基于Fortinet开发人员网络（FNDN）上提供的ftntlib包中提供的Fortigate代码，最初由多人编写，包括Ashton Turpin。此后，Fortinet内部的其他几家公司对其进行了修改。现在已经对其进行了优化和修改，以利用标准的**Kwargs功能，并进行了广泛的修改，以提高可伸缩性，并提供上下文管理和其他方面，包括处理与最新版本的Forti一起添加的API密钥功能。操作系统代码。< /P>

代码示例

采用Fortigate Rest的标准格式。

重要的是此包对Fortigate实例使用上下文行为，因此可以使用带的关键字。这将确保fortigate实例在实例化时登录，并在with语句的作用域完成后注销。例如，要实例化IP地址为10.1.1.1、用户名为admin、密码为<；blank>；的Fortigate实例，用户只需键入：

with FortiGate("10.1.1.1", "admin", "") as fgt_instance:

显然不必使用上下文管理器。但是，如果未使用，则不会为调用方处理登录和注销功能。如果未使用上下文管理器，则将调用这些方法。注*，API密钥功能副密码将在本文档后面讨论。不使用上下文管理器的一个例子是：

fgt_instance = FortiGate("10.1.1.1", "admin", "")
fgt_instance.login()
*something of importance accomplished here*
fgt_instance.logout()

继续，当一个Fortigate实例被实例化时，以下属性被配置（或者可以由用户配置）。提供的列表列出了默认值。

- passwd (default None)
- apikeyused (default False)
- debug (default False),
- use_ssl (default True),
- verify_ssl (default False),
- timeout (default 300)

例如，要实例化一个IP地址为10.1.1.1、用户名为admin、密码为<；blank>；、使用http而不是https的Fortigate实例，该实例处于调试模式，并在每次请求验证SSL证书后发出警告，超时时间为100。SER只需键入：

with FortiGate("10.1.1.1", "admin", "", debug=True, use_ssl=False, debug=True, disable_request_warnings=False, timeout=100) as fgt_instance:

稍后将讨论api密钥的使用，但这里必须理解，要使用api密钥而不是密码，唯一需要发生的事情是必须在实例化中明确调用属性。尽管用户名不需要使用api密钥，但它在这个库中是必需的，因为它保持了一致性。除了使用api密钥管理功能外，上述调用的示例如下：

with FortiGate("10.1.1.1", "admin", apikey="12345678910", debug=True, use_ssl=False, debug=True, disable_request_warnings=False, timeout=100) as fgt_instance:

显然，如果没有使用上下文管理器，这些相同的参数将在标准调用中使用，因此：

fgt_instance = FortiGate("10.1.1.1", "admin", "", debug=True, use_ssl=False, debug=True, disable_request_warnings=False, timeout=100)

或

fgt_instance = FortiGate("10.1.1.1", "admin", apikey="12345678910", debug=True, use_ssl=False, debug=True, disable_request_warnings=False, timeout=100)

虽然这个模块应该与另一个调用方编写的抽象一起使用，但是没有理由这个模块不能被自己用来进行详细的、多参数的调用。为此，提供了一种功能，使关键字/值参数能够传递到任何get、delete、post或put助手方法中。由于Fortigate正文中有许多关键字需要破折号（并且由于破折号字符不允许作为由**Kwargs指针处理的关键字参数），因此添加了一个功能，以便自动添加带有双下划线的关键字当关键字/值对放入调用主体时，转换为破折号。下面是一个示例（请注意关键字项中的双下划线，当调用时，它们将转换为破折号）：

fgt.post("/cmdb/vpn.ipsec/phase1-interface", p1name1", "port1", "1.1.1.1", 2, "2.2.2.2", "topsecret", "vdom=root", dpd="on-demand", proposal="aes128-sha1", keylife=28800, authmethod="psk", dpd__retryinterval=10, peertype="any")

此功能很有帮助，但下面的测试部分显示了一种更明显的方法，可以更清楚地进行此类调用，其中有效地使用了标准字典。在这种情况下，双下划线翻译为不需要破折号，破折号可以正常工作（见下文）。

另一个功能已经到位，允许在进行fgt调用时应用querystring。如果用户想确保某个vdom被寻址，那么这个调用会有什么结果呢？vdom=vdomname，位于以基本查询字符串格式调用的URL终结点的末尾。然而，fgt api也可以利用过滤器和格式函数，这些函数可以有效地使用，甚至是querystring选项的进一步要求。在这个库中，使用*args指针，并使用列表中提供的每个字符串追加到调用的url。一个例子是执行get函数，在vdomroot中查找名为test_object的地址对象。呼叫方式如下：

fgt.get("/cmdb/firewall/address", "vdom=root", "format=name", "filter=name==test_object")

因为这些参数没有命名，也不是键值格式，所以它们被发送到*args指针上，并用作查询字符串。输出如预期：

with FortiGate("10.1.1.1", "admin", "") as fgt_instance:

with FortiGate("10.1.1.1", "admin", "") as fgt_instance:

with FortiGate("10.1.1.1", "admin", "") as fgt_instance:

with FortiGate("10.1.1.1", "admin", "") as fgt_instance:

with FortiGate("10.1.1.1", "admin", "") as fgt_instance:

with FortiGate("10.1.1.1", "admin", "") as fgt_instance: