Modifying the Configuration File

Prerequisites

• The kbox is running properly in the EulerOS.
• The dump medium is working properly.

Precautions

After modifying the configuration file, restart the kbox to validate the settings.

Configuration Procedure

In the shell command line environment, log in as a user with the root rights.

1. Open the configuration file. In any path, run the following command:

   vi  /etc/kbox/config

   The content in the configuration file is as follows:

   #This file is the configuration file of the kbox. 
   #Configure the file based on the specific product information. 
   #*Caution*: Correctly configure the parameters based on the prompt information. The parameter must be quoted using English quotation marks and no space exists inside or outside the quotation marks. 
     
   #############  Basic information of the hardware platform  ############## 
   #Product name, for example, "euler" "pangea" "dopra" "cgp" 
   product="euler" 
     
   #Product version No., for example, V100R001C00B251 
   version="V002R200C10" 
     
   #Frame No., for example, frame=1~9 (generally for cascading) 
   frame="" 
     
   #Slot No. of the board, for example, slot=0~12 
   slot="" 
     
   #Board location, for example, front board or rear board (0~1) 
   locate="" 
     
   #Hardware information of the board, for example, pangea-v2 
   hard_version="pangea-v2" 
     
   ############ Scenarios for capturing exception information. If the value is null or illegal, the system considers that the value is set to no  ############## 
   #panic event: panic triggered by the action of explicitly calling the panic function of the kernel or an exception,
   panic_event="yes" 
     
   #Normal reboot event: The reboot, shutdown, halt, and init triggered by commands in user mode 
   reboot_event="no"
     
   #Abnormal reboot event: The machine restart triggered by exceptions in kernel mode 
   emerge_event="no"
     
   #Die event (optional)
   die_event="yes" 
     
   #Actions performed after the die event
   die_call_panic="no" 
     
   #OOM event
   oom_event="yes" 
   #Whether to call panic after the OOM event occurs 
   oom_call_panic="no"
     
   #D deadlock event
   dlock_event="no" 
     
   #R deadlock event
   rlock_event="no" 
     
   #Acpi event, to-be-defined
   acpi_event="no" 
     
   #Mce event, to-be-defined, mainly the intel CPU-related exception
   mce_event="no" 
     
   #BMC pre-interrupt event, mainly for the MCCP products
   bmc_event="no" 
     
   #User-defined event, adding or deleting ip
   ipaddr_event="no" 
     
   #Network events, mainly the up/down event of the network interface
   net_event="no" 
     
   #User-defined events: adding or deleting a route, adding or deleting a rule, modification time (whether to separate the modification time is to be determined)
   route_event="no"
   rule_event="no"
   time_event="no" 
     
   #Security events: mainly the security hardening-related events
   security_event="no" 
     
   #Watchdog events: mainly the watchdog expiration reset event
   wtdog_event="no" 
     
     
   ##############  Exception storage medium  ################
   #bmc device bmc="off" 
     
   #BIOS device
   bios="off" 
     
   #PCIE device
   pcie="off" 
     
   #Highmem device
   hmem="on" 
     
   #Logic device
   logic="off" 
     
   ###############  Module insertion parameters  ############### 
   #Note: The start_pddr must be a physical address, aligned by 4 KB, in hexadecimal format 
   #      mem_size is in hexadecimal format, a minimum of 8 KB 
   #      Parameters are separated by spaces #bmc drive parameter
   bmc_param="" 
     
   #BIOS drive parameter
   bios_param="" 
     
   #PCIE drive parameter
   pcie_param="pci_bus_id=00 pci_device_id=00"
     
   #Highmem drive
   hmem_param="sym_start_paddr_name=reserve_kbox_mem_start sym_mem_size_name=reserve_kbox_mem_len" 
     
   #Logic drive parameter
   logic_param="" 
     
   #############  Internal test devices  ############# 
   #net device (for internal use) 
   net="off" 
     
   ###############  IP address of the TFTP server (for internal use)  ################ 
   #When the net device is set to the on state, the messages in the region can be sent to the TFTP server. By default, messages of the TFTP server with IP address 127.0.0.1 are not sent
   TGT_IP="127.0.0.1" 
   TGT_MAC="" 
     
   ############  Crash report interface  ############# 
   die_notify_func=""

2. Modify the configuration file.

   Configure basic information, exception events to be captured, and storage devices based on the current hardware environment of the system. The configuration mainly includes the product information, exception event, and storage device.

   1. The parameters must be configured in strict accordance with the requirements. The parameters must be quoted in English quotation marks without any spaces inside or outside the quotation marks. The space between characters must be replaced by "_". The capitalization of configuration items set to yes/no, YES/NO, on/off, or ON/OFF must be consistent. No space is allowed. Otherwise, the value is considered as no.
   2. At least one configuration item is configured for the exception event. Otherwise, the kbox cannot load the configuration file. The storage device must be configured. Otherwise, the exception information cannot be dumped. After the kbox is restarted, the information is lost.
   3. After modifying the configuration file, restart the kbox to validate the settings.

   Table 9-3, Table 9-4, and Table 9-5 describe the parameters and configuration requirements.

   Table 9-3 Product information

   SN	Parameter Name	Description	Parameter Value	Mandatory or Not
   1	product	Current device name (or product name)	User-defined character string	No
   2	version	Version number of the current system	User-defined character string	No
   3	frame	Current rack number	An integer larger than 0	No
   4	slot	Slot number of the current board	An integer larger than 0	No
   5	locate	Board location	0 or 1	No
   6	hard_version	Hardware version	User-defined character string	No

   Table 9-4 Exception events

   SN	Parameter Name	Description	Parameter Value	Support or Not	Mandatory or Not
   1	panic_event	Panic event	yes/no	Yes	Yes. At least one type of exception events shall be configured.
   2	reboot_event	Security reboot event	yes/no	No
   3	emerge_event	Abnormal reboot event	yes/no	No
   4	die_event	Die event	yes/no	Yes
   5	dlock_event	D deadlock event	yes/no	No
   6	rlock_event	R deadlock event	yes/no	No
   7	acpi_event	Power-on/off event	yes/no	No
   8	mce_event	Hardware error event	yes/no	No
   9	bmc_event	BMC pre-interrupt event	yes/no	No
   10	ipaddr_event	IP address modification event	yes/no	No
   11	net_event	Status change event of the Net device interface	yes/no	No
   12	route_event	Route modification event	yes/no	No
   13	rule_event	Change event of user-defined ACL rules	yes/no	No
   14	time_event	Time zone or time change event	yes/no	No
   15	security_event	User-defined security event	yes/no	No
   16	wtdog_event	Watchdog event	yes/no	No
   17	oom_event	OOM event	yes/no	Yes
   18	oom_call_panic	Whether to call the panic function after the OOM event occurs	yes/no	Yes	No

   The oom_call_panic configuration item takes effect only when the oom_event configuration item is set to yes.

   Table 9-5 Storage device configurations

   SN	Parameter Name	Description	Parameter Value	Mandatory or Not
   1	bmc	BMC storage	on/off	Yes. At least one storage mode must be configured.
   2	bios	BIOS NVRAM storage	on/off
   3	pcie	PCIE storage	on/off
   4	hmem	High-end memory storage	on/off
   5	logic	Logic storage	on/off

   1. Table 9-5 and Table 9-6 must work together.
   2. For EulerOS, hmem is set to on by default.
   3. For general servers, hmem is used by default.
   Table 9-6 Storage configuration parameters

   SN	Parameter Name	Description	Parameter Value	Mandatory or Not
   1	bmc_param	BMC storage drive parameter	Not supported temporarily	No
   2	bios_param	BIOS NVRAM drive parameter	Default parameter of the drive	No
   3	pcie_param	PCIE drive parameter	pci_bus_id=00 pci_device_id=00	Yes
   4	hmem_param	Reserved memory drive parameter	This parameter supports two value configuration modes: sym_start_paddr_name=reserve_kbox_mem_start sym_mem_size_name=reserve_kbox_mem_len start_paddr=0xxxxxx mem_size=0xxxxx. The values of start_paddr and mem_size are integers in hexadecimal format. The start_paddr specifies the start physical address, and mem_size specifies the size of the memory. By default, the first value configuration mode is adopted. The CloudEdge user is not suggested to modify the value.	Yes
   5	logic_param	Logic drive parameter	Not supported temporarily	No

   If there is no non-volatile storage device, the memory may be reserved by using a startup parameter, and the non-volatile storage medium is replaced by a common memory. Then, use kdump to save the memory as a memory image. The memory image can be read using the export_kbox_img_to_txt command.