我要评分
获取效率
正确性
完整性
易理解

cluster

Command Function

Remotely collects cluster data and sends back reports.

  • If the number of servers whose data is to be collected is too large, bandwidth usage may increase.
  • Both the server where the tool is located and the server whose data is to be collected support SSH connections.

Syntax

1
./kspect cluster [-h] -i INPUT [--diff_base DIFF_BASE]

Parameter Description

Table 1 Parameters of the cluster command

Parameter

Description

-h/--help

Obtains help information.

-i/--input

(Mandatory) Path to the server configuration Excel file. The path can be either absolute or relative.

NOTICE:
  • The password in the server configuration file is stored in plaintext in the Excel file, posing a risk of information disclosure.
  • You are advised to clear the file content or store the file properly after use.
  • You are advised to set file access permissions to protect sensitive information after using the Excel configuration file.

--diff_base

(Optional) Path to the baseline template file, which is an absolute path or a relative path. Compare the collected cluster data with the baseline template. For details about the usage example, see Remote Cluster Collection Information Baseline Comparison and Diagnosis.

Example

  1. Extract the package and go to the tool directory.
    1
    2
    tar -zxvf /home/devkit-kspect-x.x.x-Linux-aarch64.tar.gz
    cd /home/devkit-kspect-x.x.x-Linux-aarch64
    
    • Replace the example tool path /home/devkit-kspect-x.x.x-Linux-aarch64 with the actual path.
    • To ensure a stable SSH connection, you are advised to verify that the SSH client configuration on the local host (the host on which the Kunpeng Health Inspector is running) is compatible before collecting data. If your system is a newer Linux distribution (such as RHEL/CentOS 8/9 or Ubuntu 22.04 or later), configuration conflicts may cause data collection to fail. For details, see "'Match all' with No Other Mixed Conditions" Error During Data Collection.
  2. Use Excel to edit the server_config.xlsx template file in the /home/devkit-kspect-x.x.x-Linux-aarch64/documents directory.
    Table 2 Parameters in the server configuration file

    Parameter

    Description

    Server Alias

    (Optional) Alias of the server whose data is to be collected.

    IP Address

    (Mandatory) IP address of the server whose data is to be collected.

    Port

    (Optional) Port number of the server whose data is to be collected. The default value is 22.

    User Name

    (Mandatory) OS user name of the server whose data is to be collected.

    Authentication Mode

    (Mandatory) Server login mode. The options are as follows:

    • password: Set the Password parameter.
    • private_key: Set Private Key Path and (optional) Private Key Password.

    Password

    (Optional) User password. This parameter is required only when the authentication mode is set to password.

    Private Key Path

    (Optional) This parameter is required only when the authentication mode is set to private_key.

    Private Key Password

    (Optional) This parameter is required only when the authentication mode is private_key and the private key file has a password.

    BMC Collection Method

    (Optional) BMC collection mode.

    • password: Use the BMC user name and password for login. You need to enter the BMC IP address, BMC user name, and BMC password.
    • In-band: The remote node must support in-band collection. Otherwise, the collection will be skipped automatically.
    • Default: BMC data is not collected.

    BMC IP

    (Optional) BMC IP address. This parameter is required only when the BMC collection mode is set to password.

    BMC User Name

    (Optional) BMC user name. This parameter is required only when the BMC collection mode is set to password.

    BMC Password

    (Optional) BMC password. This parameter is required only when the BMC collection mode is set to password.

  3. Collect server cluster information.
    1
    ./kspect cluster -i /home/server_config.xlsx
    

    Command output:

    Do you want to clear the password information from the server configuration file after the collection is complete? (Y/N) [default: N]: n
    Data collection started for the following server: xxx.xxx.xxx.xxx:22(server_3)
    
    Data collection completed successfully for xxx.xxx.xxx.xxx:22(server_3).
    The archive file /home/devkit-kspect-x.x.x-Linux-aarch64/output/kspect-report-xxxxxxxx-xxxxxx-xxx.xxx.xxx.xxx-22.tar.gz has been generated.
    
    Collection completed: 1/1 succeeded.
    [WARNING] The server configuration file /home/devkit-kspect-x.x.x-Linux-aarch64/documents/server_config.xlsx contains plaintext passwords. Keep the passwords secure or delete them after use.