Skip to content

Commit c6f5d03

Browse files
authored
Merge pull request #5 from AgentFlocks/docs-sangfor-sip-integration
docs: add Sangfor SIP integration guide
2 parents 8fb9e34 + 51bc775 commit c6f5d03

8 files changed

Lines changed: 72 additions & 15 deletions

File tree

806 KB
Loading
265 KB
Loading
622 KB
Loading

docs/md/modules/devices.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,9 @@
8888
- [自定义设备接入](/md/modules/devices/custom-device-integration):接入未预置的设备、私有 API 或 Web 控制台。
8989
- [TDP 接入](/md/modules/devices/tdp-integration):配置微步 TDP 的 `API Key``Secret``Base URL`
9090
- [OneSEC 接入](/md/modules/devices/onesec-integration):开启 OneSEC 开放 API 并复制 `api_key``secret`
91+
- [NGTIP 接入](/md/modules/devices/ngtip-integration):配置微步 HVV 情报平台的情报查询和平台功能 API Key。
9192
- [天眼接入](/md/modules/devices/skyeye-integration):配置奇安信天眼,注意 `Base URL` 必须带 `/skyeye` 后缀。
92-
- [ngtip 接入](/md/modules/devices/ngtip-integration)配置微步 HVV 情报平台的情报查询和平台功能 API Key
93+
- [深信服 SIP 接入](/md/modules/devices/sangfor-sip-integration)配置 SIP 第三方平台和 Flocks 侧连接参数
9394

9495
## 5. 使用建议
9596

docs/md/modules/devices/ngtip-integration.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# 4.8.5 ngtip 接入
1+
# 4.8.4 NGTIP 接入
22

3-
ngtip 接入用于把微步 HVV 情报平台的情报查询和平台功能 API 接入 Flocks 设备管理。接入前需要在 ngtip 控制台创建 API Key,并按功能类型分别配置到 Flocks。
3+
NGTIP 接入用于把微步 HVV 情报平台的情报查询和平台功能 API 接入 Flocks 设备管理。接入前需要在 NGTIP 控制台创建 API Key,并按功能类型分别配置到 Flocks。
44

55
## 进入 API Key 管理
66

7-
登录 ngtip 控制台后,进入 **配置管理 > 业务场景配置**
7+
登录 NGTIP 控制台后,进入 **配置管理 > 业务场景配置**
88

9-
![进入 ngtip 业务场景配置](../../../img/modules/devices/ngtip/ngtip-menu-business-scene.png)
9+
![进入 NGTIP 业务场景配置](../../../img/modules/devices/ngtip/ngtip-menu-business-scene.png)
1010

1111
在业务场景配置页面中,切换到 **平台 APIKEY 管理**,然后点击 **新增**
1212

@@ -16,7 +16,7 @@ ngtip 接入用于把微步 HVV 情报平台的情报查询和平台功能 API
1616

1717
**新增ApiKey** 页面填写基础信息和功能选择。Flocks 通常需要至少准备情报查询类 API Key;如果还要调用平台功能接口,再准备平台功能类 API Key。
1818

19-
![新增 ngtip API Key](../../../img/modules/devices/ngtip/ngtip-add-apikey.png)
19+
![新增 NGTIP API Key](../../../img/modules/devices/ngtip/ngtip-add-apikey.png)
2020

2121
建议填写:
2222

@@ -31,16 +31,16 @@ ngtip 接入用于把微步 HVV 情报平台的情报查询和平台功能 API
3131

3232
## 在 Flocks 中填写配置
3333

34-
进入 **设备接入**,选择微步 ngtip 模板后填写实例配置。
34+
进入 **设备接入**,选择微步 NGTIP 模板后填写实例配置。
3535

36-
![在 Flocks 中填写 ngtip 配置](../../../img/modules/devices/ngtip/ngtip-flocks-config.png)
36+
![在 Flocks 中填写 NGTIP 配置](../../../img/modules/devices/ngtip/ngtip-flocks-config.png)
3737

3838
关键字段:
3939

40-
- **设备名称**:当前 ngtip 实例名称。
40+
- **设备名称**:当前 NGTIP 实例名称。
4141
- **所属机房**:设备归属的机房或区域。
42-
- **情报查询 APIKEY**:填写 ngtip 中适用功能为 **情报查询类** 的 API Key。
43-
- **平台功能 APIKEY**:填写 ngtip 中适用功能为 **平台功能类 API** 的 API Key;如果当前只接入情报查询能力,可以先留空。
42+
- **情报查询 APIKEY**:填写 NGTIP 中适用功能为 **情报查询类** 的 API Key。
43+
- **平台功能 APIKEY**:填写 NGTIP 中适用功能为 **平台功能类 API** 的 API Key;如果当前只接入情报查询能力,可以先留空。
4444
- **平台功能 Base URL**:填写平台功能接口地址,通常为 `http://YOUR_NGTIP_IP`
4545
- **情报查询 Base URL**:填写情报查询接口地址,通常为 `http://YOUR_NGTIP_IP:8090`
4646

@@ -52,7 +52,7 @@ ngtip 接入用于把微步 HVV 情报平台的情报查询和平台功能 API
5252
| --- | --- |
5353
| 情报查询失败 | 确认 **情报查询 APIKEY** 的适用功能选择了 **情报查询类**,并检查情报查询 Base URL 是否包含正确端口。 |
5454
| 平台功能接口失败 | 确认 **平台功能 APIKEY** 的适用功能选择了 **平台功能类 API**,并检查平台功能 Base URL。 |
55-
| 连通测试超时 | 确认 Flocks 所在环境能访问 ngtip 的平台端口和情报查询端口。 |
55+
| 连通测试超时 | 确认 Flocks 所在环境能访问 NGTIP 的平台端口和情报查询端口。 |
5656

5757
## 相关文档
5858

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# 4.8.6 深信服 SIP 接入
2+
3+
深信服 SIP 接入用于把 SIP 的资产、告警或安全事件能力接入 Flocks 设备管理。接入前需要先在 SIP 控制台配置第三方平台,再回到 Flocks 填写 SIP 连接参数。
4+
5+
## 在 SIP 中配置第三方平台
6+
7+
登录深信服 SIP 控制台后,进入 **系统设置 > 开放共享 > 第三方平台**。如果列表中已有 Flocks 平台配置,可以直接编辑;如果没有,点击 **新增** 创建一条平台配置。
8+
9+
![进入深信服 SIP 第三方平台配置](../../../img/modules/devices/sangfor-sip/sip-third-party-platform.png)
10+
11+
编辑或新增平台时,填写平台名称、平台 IP、上报资产范围和认证账号密码。
12+
13+
![填写深信服 SIP 第三方平台配置](../../../img/modules/devices/sangfor-sip/sip-platform-config.png)
14+
15+
关键字段:
16+
17+
- **平台名称**:建议填写 `flocks`,便于在 SIP 控制台中识别。
18+
- **平台 IP**:填写 **Flocks 服务所在机器的 IP**,不是 SIP 的 IP。
19+
- **上报资产**:按实际需求选择,通常可以先选择全部。
20+
- **传输协议**:选择 `Restful API`
21+
- **认证账号 / 认证密码**:用于 Flocks 侧连接 SIP 时填写。
22+
23+
保存后,确认平台配置在列表中处于可用状态。
24+
25+
## 在 Flocks 中填写配置
26+
27+
进入 **设备接入**,选择深信服 SIP 模板后填写实例配置。
28+
29+
![在 Flocks 中填写深信服 SIP 配置](../../../img/modules/devices/sangfor-sip/sip-flocks-config.png)
30+
31+
关键字段:
32+
33+
- **设备名称**:当前 SIP 实例名称,例如 `深信服SIP`
34+
- **所属机房**:设备归属的机房或区域。
35+
- **SIP Host / IP**:填写 **深信服 SIP 的 IP 地址**
36+
- **Platform Name**:填写在 SIP 第三方平台中配置的平台名称,通常为 `flocks`
37+
- **Username**:填写 SIP 第三方平台配置中的认证账号。
38+
- **Password**:填写 SIP 第三方平台配置中的认证密码。
39+
- **Port**:可以默认不填。只有当 SIP 使用非默认端口或页面明确要求端口时再填写。
40+
41+
保存后执行连通测试,确认 Flocks 所在机器可以访问 SIP Host / IP,并且 SIP 控制台中配置的平台 IP 指向 Flocks 服务所在机器。
42+
43+
## 常见问题
44+
45+
| 问题 | 处理方式 |
46+
| --- | --- |
47+
| SIP 侧平台配置无法回连 | 检查 SIP 中的 **平台 IP** 是否填写为 Flocks 服务所在机器的 IP。 |
48+
| Flocks 连通测试失败 | 检查 **SIP Host / IP** 是否填写为深信服 SIP 的 IP 地址,而不是 Flocks 的 IP。 |
49+
| 认证失败 | 确认 Flocks 中的 `Username``Password` 与 SIP 第三方平台配置中的认证账号、认证密码一致。 |
50+
| 端口不确定 | 先保持 **Port** 为空;只有非默认端口场景再填写。 |
51+
52+
## 相关文档
53+
54+
- [设备管理](/md/modules/devices)
55+
- [自定义设备接入](/md/modules/devices/custom-device-integration)

docs/md/modules/devices/skyeye-integration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 4.8.4 天眼接入
1+
# 4.8.5 天眼接入
22

33
天眼接入用于把奇安信天眼的告警、资产或事件查询能力接入 Flocks 设备管理。接入前需要在天眼控制台准备免密登录密钥,并在 Flocks 中填写 `API Key``Base URL``Username`
44

src/.vitepress/config.mts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,9 @@ export default defineConfig({
9191
{ text: '4.8.1 自定义设备接入', link: '/md/modules/devices/custom-device-integration' },
9292
{ text: '4.8.2 TDP 接入', link: '/md/modules/devices/tdp-integration' },
9393
{ text: '4.8.3 OneSEC 接入', link: '/md/modules/devices/onesec-integration' },
94-
{ text: '4.8.4 天眼接入', link: '/md/modules/devices/skyeye-integration' },
95-
{ text: '4.8.5 ngtip 接入', link: '/md/modules/devices/ngtip-integration' },
94+
{ text: '4.8.4 NGTIP 接入', link: '/md/modules/devices/ngtip-integration' },
95+
{ text: '4.8.5 天眼接入', link: '/md/modules/devices/skyeye-integration' },
96+
{ text: '4.8.6 深信服 SIP 接入', link: '/md/modules/devices/sangfor-sip-integration' },
9697
],
9798
},
9899
{ text: '4.9 工具清单', link: '/md/modules/tools' },

0 commit comments

Comments
 (0)