F5 rSeries(F5OS-A)QKView 诊断文件生成与上传
如果对系统运行有疑问,可以使用 QKView 工具生成系统报告,收集系统的配置和诊断信息。
QKView 文件包含机器可读(JSON)的诊断数据,并打包为一个 tar.gz 压缩文件。可以将 QKView 文件上传到 F5 iHealth(ihealth.f5.com),由 F5 技术支持协助确认系统运行是否正常、分析和排查问题,并确保系统处于最佳运行状态。
在 CLI 中处理 QKView 文件
可以在 CLI 中处理 QKView 文件。
在 CLI 中配置 iHealth Web 代理
iHealth 上传功能默认将 QKView 报告直接上传到 F5 iHealth(ihealth.f5.com)。可以在 CLI 中配置 iHealth 凭据;如果主机无法访问互联网上的 f5.com,可以配置系统通过 Web 代理上传 QKView 文件到 iHealth。
- 通过 SSH 连接管理 IP 地址。
使用具有 admin 权限的账号登录系统命令行界面(CLI)。
登录后处于用户(operational)模式。
切换到配置模式。
configCLI 提示符变为包含
(config)。配置代理服务器。
system diagnostics proxy config proxy-server <*ip-address:port*>本例使用 IP 地址 192.0.2.20、端口 3128 配置代理服务器:
appliance-1-active(config)# system diagnostics proxy config proxy-server http://192.0.2.20:3128 appliance-1-active(config)# commit如有需要,配置代理服务器凭据。
system diagnostics proxy config proxy-username <*username*> proxy-password <*password*>代理用户名和密码配置项保存代理服务器的凭据;如果代理服务器不需要认证,这些值会被忽略。
本例配置用户名 “myname” 和密码:
appliance-1-active(config)# system diagnostics proxy config proxy-username myname appliance-1-active(config)# system diagnostics proxy config proxy-password (<AES encrypted string>): ******提交配置更改。
commit
现在即可生成 QKView 文件,上传到 F5 iHealth 或在本地管理。
在 CLI 中生成 QKView 文件
可以在 CLI 中生成 QKView 文件,报告包含配置数据、日志文件和平台信息等诊断信息。
- 通过 SSH 连接管理 IP 地址。
使用具有 admin 权限的账号登录系统命令行界面(CLI)。
登录后处于用户(operational)模式。
切换到配置模式。
configCLI 提示符变为包含
(config)。生成 QKView 文件。
system diagnostics qkview capture exclude-cores [ false | true ] filename <*filename*> maxcoresize <*size*> maxfilesize <*size*> timeout <*time*>可用选项如下:
| 选项 | 说明 |
|---|---|
| exclude-cores | 是否在 QKView 文件中排除 core 文件,默认包含 core 文件。 |
| filename | 指定写入 QKView 数据的文件名,默认文件名为 <*system-name*>.tar。 |
| maxcoresize | 排除大于该大小(MB)的 core 文件,范围 2 MB 到 1000 MB,默认 25 MB。 |
| maxfilesize | 排除大于指定大小(MB)的所有文件,范围 2 MB 到 1000 MB,默认 500 MB。 |
| timeout | 指定停止收集 QKView 数据的超时时间(秒),默认值 0 表示不超时。 |
In this example, you generate a QKView file named `client-qkview.tar` that excludes core files, sets the maximum core size to 500 MB, sets the maximum file size to 500 MB, and sets a timeout value of 0 \(zero\), which indicates no timeout:
```
appliance-1-active(config)# system diagnostics qkview capture filename client-qkview
exclude-cores true maxcoresize 500 maxfilesize 500 timeout 0
result Qkview file client-qkview is being collected
return code 200
```
查看 QKView 文件生成进度。
system diagnostics qkview status本例表示 QKView 文件已生成完成:
appliance-1-active(config)# system diagnostics qkview status result {"Busy":false,"Percent":100,"Status":"complete","Message":"Completed collection.","Filename":"qkview.tar"} resultint 0
接下来将 QKView 文件上传到 iHealth 服务器。
在 CLI 中将 QKView 文件上传到 F5 iHealth
上传 QKView 文件到 F5 iHealth 之前,必须已在系统中配置 iHealth 凭据。
可以在 CLI 中上传 QKView 文件,报告包含配置数据、日志文件和平台信息等诊断信息。
- 通过 SSH 连接管理 IP 地址。
使用具有 admin 权限的账号登录系统命令行界面(CLI)。
登录后处于用户(operational)模式。
切换到配置模式。
configCLI 提示符变为包含
(config)。将 QKView 文件上传到 iHealth。
system diagnostics ihealth upload qkview-file <*filename*> description <*qkview-file-description*> service-request-number <*sr-number*>本例使用已配置的 iHealth 凭据,将名为
client-qkview.tar的 QKView 文件上传到 iHealth:appliance-1-active(config)# system diagnostics ihealth upload qkview-file diags/shared/qkview/client-qkview.tar description testing service-request-number C523232 message HTTP/1.1 202 Accepted Location: /support/ihealth/status/iuw53AYW Date: Mon, 11 Jul 2022 12:09:08 GMT Content-Length: 00
最后在 F5 iHealth(ihealth.f5.com)查看已上传的报告。
在 CLI 中本地管理 QKView 文件
如需在本地管理 QKView 文件,可以在 CLI 中查看或导出文件。
- 通过 SSH 连接管理 IP 地址。
使用具有 admin 权限的账号登录系统命令行界面(CLI)。
登录后处于用户(operational)模式。
切换到配置模式。
configCLI 提示符变为包含
(config)。查看系统中的 QKView 文件列表。
file list path diags/shared/qkview/显示类似下例的摘要:
appliance-1-active# file list path diags/shared/qkview/ entries { name client-2.qkview date Tue Jun 28 05:20:33 UTC 2022 size 909MB } entries { name client-qkview.tar date Wed Jul 13 17:46:50 UTC 2022 size 781MB }将 QKView 文件导出到外部服务器。
file export insecure local-file <*local-file-path*> protocol [ https | scp | sftp ] remote-file <*remote-file-path*> remote-host <*ip-address-or-fqdn*> remote-port <*port-number*> ] remote-url <*ip-address-or-fqdn*> username <*user*> web-token <*remote-system-token*>本例将名为 client-qkview.tar 的文件导出到指定服务器:
appliance-1-active# file export local-file diags/shared/qkview/client-qkview.tar remote-host files.company.com remote-file home/jdoe/client-qkview.tar username jdoe Value for 'password' (<string>): ********* result File transfer is initiated.(diags/shared/qkview/client-qkview.tar)查看文件传输状态。
file transfer-status本例显示最近所有文件传输的状态:
appliance-1-active# file transfer-status file transfer-status result S.No.|Operation |Protocol|Local File Path |Remote Host |Remote File Path |Status |Time 1 |Export file|HTTPS |diags/shared/qkview/qkview.tar |files.company.com |/home/jdoe | Completed |Wed Jul 11 11:02:24 2022
在 webUI 中处理 QKView 文件
可以在 webUI 中处理 QKView 文件。
在 webUI 中配置 iHealth 凭据和 Web 代理
iHealth 上传功能默认将 QKView 报告直接上传到 F5 iHealth(ihealth.f5.com)。可以在 webUI 中配置 iHealth 凭据;如果主机无法访问互联网上的 f5.com,可以配置系统通过 Web 代理服务器上传 QKView 文件到 iHealth。
- 使用具有 admin 权限的账号登录 webUI。
在左侧单击 DIAGNOSTICS > iHealth Configuration。
显示 iHealth Configuration 页面。
- 在 Credentials 区域的 Username 中输入用户名。
- 在 Password 中输入该用户名对应的密码。
如有需要,配置代理服务器。
注意:不使用 Web 代理服务器时,这些字段留空。
- 在 Proxy Server 下的 Server URL 中输入 Web 代理服务器地址(含端口号)。
如果 Web 代理服务器需要认证,在 Username 和 Password 中输入用户名和密码。
注意:Web 代理服务器不需要认证时,这些字段留空。
- 单击 Save & Close。
- 弹出 Update iHealth Configuration 提示时单击 OK。
现在即可生成 QKView 文件并上传到 F5 iHealth。
在 webUI 中生成并上传 QKView 文件
如需将 QKView 文件上传到 F5 iHealth 服务器,rSeries 系统必须已配置 iHealth 凭据和 DNS,并能通过 HTTPS/443 远程服务端口访问以下服务:
- api.f5.com
- ihealth-api.f5.com
注意:通过 Web 代理上传报告的方法,见“在 webUI 中配置 iHealth 凭据和 Web 代理”。
可以在 webUI 中生成 QKView 文件,报告包含配置数据、日志文件、时序统计和平台信息等诊断信息。
- 使用具有 admin 权限的账号登录 webUI。
在左侧单击 DIAGNOSTICS > System Reports。
显示 System Reports 页面,列出此前生成的 QKView 文件及已上传到 iHealth 的报告。
单击页面右上角的 Generate QKView 生成系统报告。
Generate QKView 对话框提供以下附加选项:
| 选项 | 说明 |
|---|---|
| Filename | 指定写入 QKView 数据的文件名,默认文件名为 <system-name>.tar。 |
| Timeout Value | 指定停止收集 QKView 数据的超时时间(秒),默认值 0 表示不超时。 |
| Max File Size | 排除大于指定大小(MB)的所有文件,范围 2 MB 到 1000 MB,默认 500 MB。 |
| Max Core Size | 排除大于该大小(MB)的 core 文件,范围 2 MB 到 1000 MB,默认 25 MB。 |
| Exclude Cores | 是否在 QKView 文件中排除 core 文件,默认包含 core 文件。 |
**Note:** The system runs many commands to collect the diagnostic information, so generating the report might affect its performance.
It takes a few minutes for the system to finish creating the report and list it on the screen. The QKView Status changes to `File generated successfully` when it is done.
如需将报告上传到 F5 iHealth 服务器,勾选 QKView 名称旁的复选框,然后单击 Upload to iHealth。
注意:通过 Web 代理上传报告的方法,见“在 webUI 中配置 iHealth 凭据和 Web 代理”。
QKView 文件即上传到 F5 iHealth,可借助 iHealth 诊断系统的健康和运行状况。报告可在 ihealth.f5.com 查看。
在 webUI 中本地管理 QKView 文件
如需在本地管理 QKView 文件,可以在 webUI 中导出或下载文件。
- 使用具有 admin 权限的账号登录 webUI。
- 在左侧单击 SYSTEM SETTINGS > File Utilities。
- 在 Base Directory 列表中选择 diags/shared/。
- 在 diags/shared 下选择 qkview。
导出 QKView 文件到外部服务器:
- 选择 QKView 文件,单击 Export。
- 在弹出窗口中输入导出目标的 Server URL。
- 仅在远端主机要求时填写 Username 和 Password。
- 如需跳过导入文件时的证书警告,勾选 Ignore Certificate Warnings。
- 单击 Export File 开始导出。
下载 QKView 文件到本地工作站:
选择 QKView 文件,单击 Download。
所选文件即开始下载。
在 File Transfer Status 区域可查看文件传输的进度和结果;操作失败时,将鼠标悬停在警告图标上可查看错误信息。
注意:执行无效操作时,File Transfer Status 区域会显示运行时错误。