Rate This Document
Findability
Accuracy
Completeness
Readability

Subcommands and Parameters

The tool can collect and display all information or the information specific to a single module, and can also identify and recommend the memory insertion method. The tool provides symptom description and diagnosis suggestions for possible problems in a report. If multiple reports are available, the tool can compare and analyze them.

You can run kspect and a subcommand (except cpu) to view all information about the subcommand module.

Table 1 Subcommands

Subcommand

Description

system

Displays all system information, including the server, vendor, and mainboard information.

os

Displays OS information, including the OS name, system version, kernel version, and boot parameters.

bios

Displays BIOS information, including the boot type, cache mode, and PCIe rate. This feature requires the permission to run ipmitool. Alternatively, configure the BMC information (user name and password) to obtain the complete system information.

software

Displays software information, including the BIOS, OS, and software versions.

cpu

Displays CPU information, including the CPU model and list.

numa

Displays NUMA information, including CPU, memory, PCIe, network, and NVMe information.

memory

Displays memory information, including common memory information and DIMM information.

network

Displays network information, including the network driver and interrupt information.

storage

Displays storage information, including drive and partition information.

pcie

Displays PCIe information, including the PCIe driver and IRQ information.

ascend

Displays Ascend NPU information, including npu-smi and ascend-dmi.

bmc

Displays information obtained using the BMC.

This feature requires the permission to run ipmitool. Alternatively, configure the BMC information (BMC IP address, user name, and password) to obtain the information. If you do not enter the BMC information, SEL logs will not be collected.

config

Checks and displays the dependency between modules.

all

Displays all system information, including all hardware and software information. (Some information can be collected only when using the BMC.)

report

Displays historical reports or analyzes report differences.

Table 2 Parameters of the kspect command

Parameter

Option

Description

-h/-H/--help

-

Obtains help information.

-L

0/1/2/3/4

Log level, which defaults to 4.
  • 0: DEBUG
  • 1: INFO
  • 2: WARNING
  • 3: ERROR
  • 4: NOTSET

-l/--language

0/1

Report language, which defaults to 1. If the environment does not support Chinese, the 0 option (English) is used.

  • 0: English
  • 1: Chinese

--remote

-

Indicates whether to collect remote node information.

The tool will be transferred to the /tmp directory on the remote node. After the collection is complete, the tool is deleted. To enable this option, obtain the SSH login information of the remote node, including the IP address and port (IP_address:port, port defaulting to 22), user name, and password.

-s/--skip-bmc

-

Skips the step of configuring BMC information. By default, ipmitool is used to collect information.

-c/--bmc-command

-

Runs the user-defined BMC information collection command.

Table 3 Parameters of the system subcommand

Parameter

Option

Description

-h/--help/-H

-

Obtains help information.

-o/--host

-

Displays the host name, server time, OS, mainboard, and chassis information.

-p/--product

-

Displays the product name, version, serial number, and UUID.

-b/--baseboard

-

Displays the mainboard manufacturer, product name, version, and serial number.

Table 4 Parameters of the software subcommand

Parameter

Option

Description

-h/--help/-H

-

Obtains help information.

-s/--software_version

-

Displays the software version.

-k/--kvm

-

Displays KVM information.

-d/--docker

-

Displays Docker information.

Table 5 Parameters of the cpu subcommand

Parameter

Option

Description

-h/--help/-H

-

Obtains help information.

-G/--general

-

Displays all CPU information.

-c/--cpu

  • n
  • n,m
  • n-m
  • all

Displays detailed information about a specified CPU core. The number of CPU cores is dynamically displayed based on the actual environment. The following provides an example of parameters:

  • To collect information about CPU core 1, enter -c 1.
  • To collect information about CPU cores 0 and 2, enter -c 0,2.
  • To collect information about CPU cores 0 to 3, enter -c 0-3.
  • To collect information about all CPU cores, enter -c all.
Table 6 Parameters of the memory subcommand

Parameter

Option

Description

-h/--help/-H

-

Obtains help information.

-G/--general

-

Displays all memory information.

-D/--DIMM

-

Displays the memory information of all sockets (SOCKET, CHANNEL, and DIMM), including the memory socket topology and the recommended insertion mode.

Table 7 Parameters of the network subcommand

Parameter

Option

Description

-h/--help/-H

-

Obtains help information.

-n/--nic

-

Displays NIC information.

-i/--irq

-

Displays network IRQ mapping information.

-T/--tuner

-

Displays NIC tuning information.

-r/--route

-

Displays routing information.

-a/--arp

-

Displays ARP information.

Table 8 Parameters of the storage subcommand

Parameter

Option

Description

-h/--help/-H

-

Obtains help information.

-d/--disk

-

Displays drive information.

-f/--filesystem

-

Displays file system information.

-b/--bmc

-

Displays the drive information in the BMC.

Table 9 Parameters of the ascend subcommand

Parameter

Option

Description

-h/--help/-H

-

Obtains help information.

-n/--npu

-

Displays NPU topology information.

-d/--dmi

-

Displays basic ascend-dmi information.

-b/--band

-

Displays ascend-dmi bandwidth information.

Table 10 Parameters of the report subcommand

Parameter

Option

Description

-h/--help/-H

-

Obtains help information and displays historical reports.

-r/--report

Report No.

Select historical reports or enter report paths (tool collection reports or reported generating using diff/diff_x86 are supported). Only the latest 10 reports are displayed.

-d/--diff

  • 0
  • N
  • N,M
  • <INPUT_PATH>
  • <INPUT_PATH_A>,<INPUT_PATH_B>

Select the two reports that you want to compare.

  • 0: generates a report and compares it with the previous report.
  • N: generates a new report and compares it with historical report <N>.
  • N,M: compares historical report <N> with historical report <M>.
  • <INPUT_PATH>: generates a new report and compares it with the specified report.
  • <INPUT_PATH_A>,<INPUT_PATH_B>: compares reports <A> and <B>.

--diff_x86

  • <X86_PATH>
  • N,<X86_PATH>
  • <INPUT_PATH>,<X86_PATH>

Select the report to be compared with the x86 report. x86 reports generated using perfspect report --all are supported (the PerfSpect tool is available at https://github.com/intel/PerfSpect). The format is as follows:

  • <X86_PATH>: generates a report and compares it with the input x86 report.
  • N,<X86_PATH>: compares historical report <N> with the x86 report.
  • <INPUT_PATH>,<X86_PATH>: compares the input collection report with the input x86 report.

-t/--threshold

Non-negative number

Indicates the difference between the values of the same parameter in two reports. You can customize the value. The default value is 20%. You do not need to add the percent sign (%) when entering a value. Only --diff/--diff_x86 is supported.