No relevant resource is found in the selected language.

This site uses cookies. By continuing to browse the site you are agreeing to our use of cookies. Read our privacy policy>Search

Reminder

To have a better experience, please upgrade your IE browser.

upgrade

eSight V300R010C00 Maintenance Guide 07

Rate and give feedback :
Huawei uses machine translation combined with human proofreading to translate this document to different languages in order to help you better understand the content of this document. Note: Even the most advanced machine translation cannot match the quality of professional translators. Huawei shall not bear any responsibility for translation accuracy and it is recommended that you refer to the English document (a link for which has been provided).
Network Management

Network Management

This section describes configuration files related to network management.

WLAN

This section describes WLAN configuration files.

wlan_collision_para.properties
Function

The configuration file controls whether the collision domain is displayed and adjusts the radio signal aperture when the coverage range of radio signals is drawn on the WLAN Region Monitor page.

Path

eSight installation directory\AppBase\var\iemp\storage\enterprise.app.wlanmgr

Description
Table 9-89 Configuration items in wlan_collision_para.properties

Parameter

Description

Setting

Effective Mode

isCollisionDisplay

Indicates whether to display the collision domain.

true: The collision domain is displayed.

false: The collision domain is not displayed.

Default value: true

The modification takes effect after the generated radio signal coverage image is deleted and the Region Monitor page is re-accessed.

CollisionScaleMultiple

Indicates the scale legend. The parameter is used to adjust the scale when the aperture is too large.

Data type: integer

Value range: > 0

Default value: 1

The modification takes effect after the generated radio signal coverage image is deleted and the Region Monitor page is re-accessed.

Precautions

1. Do not modify the configuration file unless necessary. Modify the configuration file to control the display of the collision domain and shrink the coverage range of radio signals only when the browser runs slowly or stops responding because too many APs exist in the area or the coverage range of radio signals is too large.

2. The modification takes effect after the generated radio signal coverage image is deleted and the Region Monitor page is re-accessed. You do not need to restart eSight.

Configuration Example

isCollisionDisplay=true

CollisionScaleMultiple=1

arrange.properties
Function

The configuration file specifies parameters related to WLAN data cleaning and timeline display.

Path

eSight installation directory\AppBase\var\iemp\storage\enterprise.app.wlanmgr

Description
Table 9-90 Configuration items in arrange.properties

Parameter

Description

Setting

Effective Mode

arrangeAdjustTime

Indicates the timestamp at which data cleaning is performed, in milliseconds.

Integer larger than 0

Default value: 0

Immediately

regionTopoDelayMils

Indicates the delay for display in the region monitor timeline, in milliseconds.

Integer larger than 0

Default value: 600000

Restart

arrangeDelayFlag

Indicates whether to delay data cleaning for one collection period.

The options are 1 (yes) and 0 (no).

Value range:

  • 0: no
  • 1: yes

Default value: 0

Immediately

Precautions

1. Do not modify the configuration file unless necessary. The default values are recommended.

2. After modifying the configuration file, restart eSight to make the modification take effect.

Configuration Example

arrangeAdjustTime=0

regionTopoDelayMils=600000

arrangeDelayFlag=0

syslog_clean_config.properties
Function

The configuration file sets parameters for clearing WLAN access historical logs.

Path

eSight installation directory\AppBase\var\iemp\storage\enterprise.app.wlanmgr

Description
Table 9-91 Configuration items in syslog_clean_config.properties

Parameter

Description

Setting

Effective Mode

period

Specifies the clearing period, in hours.

12 or 24

Default value: 24

Restart

errorId

Specifies the type of logs to be cleared.

Log ID

Default value: [IWAP_CLIENT_INFO_ROAM_INFO]

Restart

threshold

Specifies the threshold for log clearing, in million pieces.

Integer larger than 0

Default value: 150

Restart

Precautions

1. Do not modify the configuration file unless necessary. The default values are recommended.

2. After modifying the configuration file, restart eSight to make the modification take effect.

Configuration Example

period=24

errorId=[IWAP_CLIENT_INFO_ROAM_INFO]

threshold=150

wlan_config.properties
Function

This configuration file is used to set WLAN service parameters.

Path

eSight installation directory\AppBase\var\iemp\storage\enterprise.app.wlanmgr

Description
Table 9-92 Parameters in wlan_config.properties

Parameter

Description

Setting

Effective Mode

RegionMaxApNum

Indicates the maximum number of APs in the area.

Integer larger than 0

Default value: 200

Restart

ConfigurationGuideShow

Indicates whether to add the configuration wizard.

Integer larger than 0

Default value: 0

Restart

TerminalShowType

Indicates the terminal display type.

Integer larger than 0

Default value: 1

Restart

TerminalRefreshTime

Indicates the terminal update time.

Integer larger than 0

Default value: 15000

Restart

tbl_sta_login_info

#max:24,default:-1

Set this parameter to an integer greater than or equal to -1.

Default value: -1

Restart

StaAccessHistoryTimeRange

Indicates the access history time range.

Integer larger than 0

Default value: 2

Restart

CampusAcReqTimeOut

Indicates the timeout interval of the Agile Controller-Campus web service request.

Integer larger than 0

Default value: 3000

Restart

CampusAcConnTimeOut

Indicates the timeout interval of the Agile Controller-Campus web service connection.

Integer larger than 0

Default value: 5000

Restart

CampusAcAuthWord

Indicates the authentication word of the Agile Controller-Campus web service.

Set this parameter to a customized value.

Default value: none

Restart

RadiusOnlineUserWs

Indicates the online user management interface of the Agile Controller-Campus RADIUS.

http://IP address (of the Agile Controller-Campus):8088/OPMUI/service/RadiusOnlineUserMgrServices?wsdl

Default value: none

Restart

AdminApgroupConsistency

Indicates whether to associate the Admin role with ApGroup.

0: no

1: yes

Default value: 0

Re-login

Precautions

1. Do not modify the configuration file unless necessary. The default values are recommended.

2. After modifying the configuration file, restart eSight to make the modification take effect.

3. The CampusAcReqTimeOut, CampusAcConnTimeOut, CampusAcAuthWord, and RadiusOnlineUserWs parameters require that the controller has been deployed and configured.

4. If AdminApgroupConsistency is set to 0, the system follows the original processing. If AdminApgroupConsistency is set to 1, users with the Admin role have permissions to add, modify, and delete AP groups, and to add and delete APs. Users with other roles can only view information about AP groups named after their user names and information about APs in the groups. However, they do not have the permissions to add or delete AP groups or APs.

Configuration Example

period=24

errorId=[IWAP_CLIENT_INFO_ROAM_INFO]

threshold=150

spectrum_ip_whitelist.properties
Function

This file is used to configure the source IP address whitelist for the spectrum analysis packets. The use scenario is as follows: On the specific network, the source IP address in the spectrum analysis packet is inconsistent with the IP address for adding devices in eSight. You need to add the source IP address in the packet to the whitelist to prevent eSight from discarding the packet.

Path

eSight installation directory\AppBase\var\iemp\storage\enterprise.app.wlanmgr

Description

IP addresses to be added to the whitelist are directly configured in the file.

Precautions
  • You need to obtain the source IP address of the spectrum analysis packet from the device that supports the WLAN management feature.
    1. The WLAN V200R008C10B015 and later versions support the spectrum-analysis source command. If output information is generated for the following command, obtain the IP address from the output information. Otherwise, go to 2.
      <AC6605>display current-configuration | include spectrum-analysis source
       spectrum-analysis source ip-address 10.136.251.1         //10.136.251.1 is the source IP address of the spectrum analysis packet.
    2. In versions earlier than WLAN V200R008C10B015 version or in the scenario where no output information is displayed in 1, perform the following operation to obtain IP addresses of all reachable interfaces between devices and eSight.
      <AC6605>display ip routing-table 10.120.23.119           //10.120.23.119 is the IP address of eSight. 
      Route Flags: R - relay, D - download to fib
      ------------------------------------------------------------------------------
      Routing Table : Public
      Summary Count : 1
      Destination/Mask    Proto   Pre  Cost      Flags NextHop         Interface
      
              0.0.0.0/0   Static  60   0          RD   10.137.58.1     MEth0/0/1

      Query the specified IP address based on the interface in the command output. If multiple interfaces exist, you need to perform the operation multiple times.

      <AC6605>display interface Meth0/0/1          //Interface in the output of the display ip routing-table command. 
      ...
      Route Port,The Maximum Transmit Unit is 1500
      Internet Address is 10.137.58.11/23           //10.137.58.11 is the source IP address of the spectrum analysis packet. 
      ...
  • After modifying the configuration file, restart eSight for the modification to take effect.
  • Only IPv4 addresses are supported.
  • Only one valid IP address can be added in a line. Multiple IP addresses are separated by periods (.). Extra space character or other characters cannot exist before and after the IP address.
  • Multiple IP addresses are added in multiple lines.
  • A maximum of 10000 IP addresses can be configured in the file.
Configuration Example

10.137.66.66

10.137.66.67

10.137.66.68

apconfig.properties
Function

The configuration file configures AP service configuration to display pages in old and new versions.

Path

eSight installation directorye\AppBase\etc\wlanconfig

Description
Table 9-93 Parameters in apconfig.properties

Parameter

Description

Setting

Effective Mode

synMode

0: Display pages in old version; 1: Display pages in new version.

The options are 1 (yes) and 0 (no).

Default value: 1

After the modification, update the AP service configuration page for the modification to take effect.

Precautions

1. Do not modify the configuration file unless necessary. The default values are recommended.

2. The configuration file takes effect immediately after modification.

Configuration Example

synMode = 1

ac_white_list.properties
Function

This configuration file is used to configure the MAC address whitelist of the ACs for which WLAN inventory, AP information, and access user information are polled. If the configuration file is empty, the polling is performed for all ACs. If the configuration file is not empty, the polling is performed only for ACs in the whitelist. This configuration applies to the scenario where only specified devices need to be polled.

Path

eSight installation directory\AppBase\var\iemp\storage\enterprise.app.clientsandusers

Description

Add MAC addresses of specific ACs to the whitelist and restart eSight for the settings to take effect.

Precautions

1. Only one valid MAC address can be added in a line. Multiple MAC addresses are separated by hyphens (-). Extra space character or other characters cannot exist before and after the MAC address.

2. Multiple MAC addresses are added in multiple lines.

3. A maximum of 10000 MAC addresses can be configured.

Configuration Example

C9-01-31-01-11-15

E4-68-A3-F6-BB-20

NTA

This section describes NTA configuration files.

nta.properties
Function

The configuration file enables or disables traffic analysis based on EIPs, rate limiting groups, customers, and ISPs in the cloud data center.

The configuration file specifies whether to enable the generation of NTA northbound files.

The configuration file configures the time period for saving the traffic evidence collection original flow file.

Path

eSight installation directory\AppBase\etc\nas\nta.properties

Description
Table 9-94 Configuration items in nta.properties

Parameter

Description

Setting

Effective Mode

DC_ENABLE

Indicates whether to enable traffic analysis for a cloud data center.

true: enables traffic analysis based on EIPs, rate limiting groups, customers, and ISPs.

false: disables traffic analysis based on EIPs, rate limiting groups, customers, and ISPs.

Default value: false

Restart

DUMP_ENABLE

Specifies whether to enable the generation of NTA northbound files.

true: Enable the generation of NTA northbound files.

false: Disable the generation of NTA northbound files.

Default value: false

Restart

RAW_FILE_SAVE_HOURS

Indicates the duration for storing the traffic evidence collection original flow file, in hours.

The value is an integer ranging from 24 to 168.

Default value: 24

Restart

Precautions

1. Do not modify the configuration file unless the cloud data center or the network traffic northbound file generation function is enabled, or the duration for storing the traffic evidence collection original flow file needs to be modified.

2. After modifying the configuration file, restart eSight for the modification to take effect. If the NTC is deployed on a distributed server, restart eSight and then the NTC. If DC_ENABLE is enabled, client, rate limiting group, EIP, and carrier menus are added on the network traffic analysis page. You can click each menu to view details. If DUMP_ENABLE is enabled, eSight will save original flow files to the nas folder in the FTP northbound directory.

Configuration Example

DC_ENABLE=false

DUMP_ENABLE=false

RAW_FILE_SAVE_HOURS=24

dcsource.properties
Function

The configuration file configures eSight in the cloud data center to interconnect with other systems to obtain information about EIPs, rate limiting groups, and customers.

Path

eSight installation directory\AppBase\etc\nas\dcsource.properties

Description
Table 9-95 Configuration items in dcsource.properties

Parameter

Description

Setting

Effective Mode

IAM_SERVERIP

Indicates the IAM server IP address.

Data type: character string

Value range: valid IPv4 address or domain name

Default value: 127.0.0.1

Take effect after 3 minutes.

IAM_SERVERPORT

Indicates the IAM server port.

Data type: integer

Value range: 0-65535

Default value: 31943

Take effect after 3 minutes.

IAM_RESTUSER

Indicates the IAM user name.

Data type: character string

Value range: not limited

Default value: eSight

Take effect after 3 minutes.

IAM_RESTPD

Indicates the IAM user password.

Data type: character string

Value range: encrypted password that cannot be configured directly

Default value: @0102000000005043dd585146ffe852277e6657553fbef8ba9f155a593374c472495ca7ece22e

Modification method: For details, see Changing the Password Using the BME Tool.

Take effect after 3 minutes.

IAM_DOMAIN_NAME

Indicates the IAM domain name.

Data type: character string

Value range: not limited

Default value: op_service

Take effect after 3 minutes.

IAM_PROJECT_NAME

Indicates the IAM project name.

Data type: character string

Value range: not limited

Default value: MOS

Take effect after 3 minutes.

IAM_PDNAME

Indicates password digest in an IAM authentication request.

Data type: character string

Value range: encrypted character string for Password00 and cannot be changed: @0102000000002512ae5eb615616e35d85945f11d46c13d26ebc1c0d3b52d56c6974d27377ec9

Default value: @0102000000002512ae5eb615616e35d85945f11d46c13d26ebc1c0d3b52d56c6974d27377ec9

Take effect after 3 minutes.

IAM_URNAME

Indicates user name digest in an IAM authentication request.

Data type: character string

Value range: encrypted character string for User00 and cannot be changed: @01020000000070c6ce5be32277e000e6b5be1e0cd4c35aca57713f96d894e90d865fa5ed9fe7

Default value: @01020000000070c6ce5be32277e000e6b5be1e0cd4c35aca57713f96d894e90d865fa5ed9fe7

Take effect after 3 minutes.

VPC_SERVERIP

Indicates the VPC server IP address.

Data type: character string

Value range: valid IPv4 address or domain name

Default value: 127.0.0.1

Take effect after 3 minutes.

VPC_SERVERPORT

Indicates the VPC server port.

Data type: integer

Value range: 0-65535

Default value: 8443

Take effect after 3 minutes.

RMS_SERVERIP

Indicates the RMS server IP address.

Data type: dotted decimal IP address

Value range: RMS server IP address

Default value: 127.0.0.1

Take effect after 3 minutes.

RMS_SERVERPORT

Indicates the RMS server port.

Data type: integer

Value range: 0-65535

Default value: 8443

Take effect after 3 minutes.

RMS_DIGESTPD

Indicates RMS digest.

Data type: character string

Value range: encrypted character string in the authentication digest information provided by the RMS, default value: HWSAdmin123

Default value: @01020000000070c6ce5be32277e000e6b5be1e0cd4c35aca57713f96d894e90d865fa5ed9fe7

Modification method: For details, see Changing the Password Using the BME Tool.

Take effect after 3 minutes.

CONNECT_TIMEOUT

Indicates the HTTPS connection timeout period.

Data type: integer

Value range: positive integer

Default value: 60,000

Take effect after 3 minutes.

SOCKET_TIMEOUT

Indicates the timeout period for HTTPS to read data from Socket.

Data type: integer

Value range: positive integer

Default value: 60,000

Take effect after 3 minutes.

CONNECTION_REQUEST_TIMEOUT

Indicates the HTTPS request timeout period.

Data type: integer

Value range: positive integer

Default value: 60,000

Take effect after 3 minutes.

Precautions

1. Modify this configuration file only in a cloud data center scenario.

2. This configuration file takes effect only when DC_ENABLE in nta.properties is set to true. When the file is modified, wait three minutes for the modification to take effect. You do not need to restart eSight.

Configuration Example

IAM_SERVERIP=127.0.0.1

IAM_SERVERPORT=31943

IAM_RESTUSER=eSight

IAM_RESTPD=@0102000000005043dd585146ffe852277e6657553fbef8ba9f155a593374c472495ca7ece22e

IAM_DOMAIN_NAME=op_service

IAM_PROJECT_NAME=MOS

IAM_PDNAME=@0102000000002512ae5eb615616e35d85945f11d46c13d26ebc1c0d3b52d56c6974d27377ec9

IAM_URNAME=@01020000000070c6ce5be32277e000e6b5be1e0cd4c35aca57713f96d894e90d865fa5ed9fe7

VPC_SERVERIP=127.0.0.1

VPC_SERVERPORT=8443

RMS_SERVERIP=127.0.0.1

RMS_SERVERPORT=8443

RMS_DIGESTPD=@010200000000a3ec6a4a0d96e93af36fe3c56fa6eaf014c602ce50c66fb12e68e7a0c5297f33

CONNECT_TIMEOUT=60000

SOCKET_TIMEOUT=60000

CONNECTION_REQUEST_TIMEOUT=60000

Configuration

This section describes configuration files related to configuration.

switchTraffic.xml
Function

The configuration file configures foolproof verification and traffic switching during software upgrade. This configuration file is customized for Alibaba.

Path

eSight installation directory/AppBase/etc/upgrademgr/switchTraffic.xml

Description
Table 9-96 Configuration items in switchTraffic.xml

Parameter

Description

Setting

Effective Mode

switch

Specifies whether foolproof verification and traffic switching are enabled.

Data type: boolean

Value range:

  • true: Foolproof verification and traffic switching are enabled.
  • false: Foolproof verification and traffic switching are disabled.

Default value: false

Restart

wait-interval

Specifies the polling interval, in seconds.

Data type: int

Value range: 30-180

Default value: 30

Restart

Precautions

None.

Configuration Example
<?xml version="1.0" encoding="UTF-8"?>
<!--Traffic switching configuration file, customized for Alibaba-->
<config name="switchTraffic">
 <!--Whether traffic switching is enabled (Traffic switching is disabled by default.) -->
 <param name="switch">false</param>
 <!-- Traffic switching waiting time (s) -->
 <param name="wait-interval">30</param>
</config>
tor.xml
Function

The tor.xml file is used to configure the authentication information about packets exchanged between the CE and eSight during zero-touch deployment.

Path

eSight installation directory/AppBase/etc/ent.pnpmgr/restful/tor.xml

Description
Table 9-97 Parameters in tor.xml

Parameter

Description

Setting

Effective Mode

username

User name.

Data type: string

Value range: unrestricted

Default value: torztp

Immediately

password

Password.

Data type: string

Value range: unrestricted

Default value: encrypted initial password

Immediately

sault

Salt key.

Data type: string

Value range: unrestricted

Default value: salt key used for encrypting the initial password

Immediately

Precautions

None

Configuration Example
<?xml version="1.0" encoding="UTF-8"?>
<config name="tor">
    <param name="username">torztp</param>
    <param name="password">QX4Uo9+PAtqlIjBRziq8YBHx3h59UgRGxo2nl5MgEPA=</param>	
    <param name="sault">B0dFz3aoLQf63CAiVul0SyvDBIYjWVZUdfJAdcBDY9k=</param>	
</config>
conf.properties
Function

The conf.properties file is used to:

  • Configure the restart detection timeout interval during software upgrade.
  • Specify whether version upgrade is supported for the firewall with the license and Paf files.
  • Specify whether the firewall license can be managed.
  • Configure the number of concurrent threads of device software upgrade tasks.
  • Configure the number of concurrent threads for restarting and activating the device software upgrade task.
Path

eSight installation directory/AppBase/etc/upgrademgr/conf.properties

Description
Table 9-98 Parameters in conf.properties

Parameter

Description

Setting

Effective Mode

rebootchecktimeout

Detection timeout interval (in minutes).

Data type: int

Value range: 30-180

Default value: 30

Immediately

supportLicense4FireWallUpgrade

Indicates whether to enable the version upgrade function for the firewall with the license and Paf files.

Data type: boolean

Values: true or false

Default value: false

Immediately

supportLicenseManager

Indicates whether to enable the firewall license management function.

Data type: boolean

Values: true or false

Default value: false

Immediately

upgradetasknum

Indicates the number of concurrent threads for the device software upgrade task.

Data type: int

Value range: 10-20

Default value: 10

Restart

activetasknum

Indicates the number of concurrent threads for restarting and activating the device software upgrade task.

Data type: int

Value range: 200 to 500

Default value: 200

Restart

Precautions

None

Configuration Example
#Function:Configure the reboot detection timeout period.
#default value:30
rebootchecktimeout = 30
#Function:Configure license support.
#default value:false
supportLicense4FireWallUpgrade = false
supportLicenseManager = false
#Function:Configure the number of upgrade task threads.
#default value:10, value range:10-20.
upgradetasknum = 10
#Function:Configure the number of active and reboot task threads.
#default value:200, value range:200-500.
activetasknum = 200
sysconf.properties
Function

This configuration file is used to configure the following:

  • Send an alarm when the device configuration file is changed.
  • Trigger configuration file backup when the device reports configuration change alarms.
  • Completely roll back the CE device. After rollback, the device configuration is the same as that in the selected configuration file.
  • Send alarms when the periodical backup task fails to be executed.
  • Save the backup configuration to the specified file during backup.
  • Save the current running configuration on the device during backup.
  • Specify the number of concurrent threads for the configuration file backup task.
  • Configure the configuration file backup policy.
  • Expand options of the backup task period.
  • Set the encoding format for parsing the device configuration file.
  • Configure whether to enable faulty device replacement function. If the function is enabled, the faulty device replacement node is displayed in the navigation tree on the left of the configuration file management page.
Path

eSight installation directory/AppBase/etc/conffile/sysconf.properties

Description
Table 9-99 Parameters in sysconf.properties

Parameter

Description

Setting

Effective Mode

Remarks

push.alarm.enable

Sends an alarm when the device configuration file changes.

Data type: character string

Values: enable or disable

Default value: enable

Immediately

The function can be configured on the GUI. You are advised not to modify the configuration file.

listen.alarm.enable

Triggers configuration file backup when the device reports configuration change alarms.

Data type: character string

Values: enable or disable

Default value: enable

Immediately

The function can be configured on the GUI. You are advised not to modify the configuration file.

ce.rollback.enable

Specifies whether to roll back CE switches to a specified version.

Data type: character string

Values: true or false

Default value: false

Immediately

backup.fail.alarm.enable

Sends alarms when the periodic backup task fails to be executed.

Data type: character string

Values: enable or disable

Default value: disable

Immediately

save.fixed.file.enable

Specifies whether to save the backup of the latest configuration to a fixed file.

Data type: character string

Values: enable or disable

Default value: disable

Immediately

backup.save2startup.enable

Saves the current running configuration on the device during backup.

Data type: character string

Values: enable or disable

Default value: disable

Immediately

The function can be configured on the GUI. You are advised not to modify the configuration file.

encoding.format

Sets the encoding format for parsing the device configuration file.

Data type: character string

Value range: 1: UTF-8 encoding; 0: GBK encoding

Default value: 0

Immediately

backuptaskthreadnum

Specifies the number of concurrent threads for the configuration file backup task.

Data type: int

Value range: 10-20

Default value: 10

Restart

backupStrategy

Configure the configuration file backup policy.

Data type: character string

Value range:

0: Back up the running configuration. 1: Back up the startup configuration. 2: Back up the running and startup configuration.

Default value: 2

Immediately

The function can be configured on the GUI. You are advised not to modify the configuration file. This parameter affects only the backup operations on the configuration file management page. Backup operations in the device upgrade and intelligent configuration tools are not affected.

task.extends.cycle.enable

Expand options of the backup task period.

Data type: character string

Values: true or false

Default value: false

Restart

Do not disable this function after it is enabled. Otherwise, the task created using this option will be abnormal. Exercise caution when performing this operation.

upload.ezop.file.enable

Specifies whether to replace faulty devices.

Data type: character string

Values: enable or disable

Default value: disable

Immediately

This parameter is customized for Chalco in Peru. Consult technical support engineers before use. Before enabling this function, ensure that save.fixed.file.enable has been enabled.

Precautions

Do not modify the configuration file unless necessary.

Configuration Example
push.alarm.enable=enable
listen.alarm.enable=enable
ce.rollback.enable=false
backup.fail.alarm.enable=disable
save.fixed.file.enable=disable
backup.save2startup.enable=disable
encoding.format=0
backuptaskthreadnum=10
backupStrategy=2
task.extends.cycle.enable=false
tftpconfig.xml
Function

The configuration file configures TFTP server parameters.

Path

eSight installation directory/AppBase/etc/conffile/tftpconfig.xm

Description
Table 9-100 Configuration items in tftpconfig.xml

Parameter

Description

Setting

Effective Mode

enable

Indicates whether to enable the TFTP service.

Data type: character string

Value range:

  • false: disabled
  • true: enabled

Default value: false

Restart

listenerPort

Indicates the listening port of the TFTP server. The default listening port on the Windows operating system is 69. The Linux operating system cannot listen on port 69 directly due to restriction on eSight's running permission. The Linux operating system maps port 69 to 32182 for eSight, but the listening port is still 69 for users. Do not change the value of this configuration item.

Data type: integer

Value range:

  • Windows: 69
  • Linux: 32182

Default Value:

  • Windows: 69
  • Linux: 32182

Restart

passivePorts

Indicates the range of ports that the TFTP server uses to transfer files.

Data type: character string

Value range:

  • Default port range: 32160-32169
  • All ports: 32160, 32161, 32162, 32163, 32164, 32165, 32166, 32167, 32168, 32169

Default Value: 32160-32169

Restart

isFilterDevice

Indicates whether the TFTP server processes only the TFTP requests from devices managed by eSight.

Data type: character string

Value range:

  • true: processes only the TFTP requests from devices managed by eSight.
  • false: also processes TFTP requests from devices managed by other network management systems.

Default value: true

Restart

Precautions

Do not modify the configuration file unless necessary.

Configuration Example
<?xml version="1.0" encoding="UTF-8"?>
<config name="tftpServer">
    <param name="enable">true</param>
    <param name="listenerPort">69</param>
    <param name="passivePorts">32160-32169</param>
    <param name="isFilterDevice">true</param>
</config>

BlackCmdList.xml
Function

The configuration file configures the verification blacklist for the intelligent configuration tool and compliance check command.

Path

eSight installation directory/AppBase/etc/sct/BlackCmdList.xml

Description
Table 9-101 Configuration items in BlackCmdList.xml

Parameter

Description

Setting

Effective Mode

cmd

Command verification blacklist.

Configure the blacklist based on the site requirements.

Immediate

Precautions

Ensure that the XML file format is correct.

Configuration Example
<?xml version="1.0" encoding="UTF-8"?>
<blackcmd>
    <function name="blackcmdlist">
        <cmd>reboot</cmd>
	<cmd>shutdown</cmd>
    </function>
</blackcmd>

Agile Report

This topic describes the configuration files related to agile reports.

analyzer.properties
Function

The configuration file configures UniBI services and report file formats.

Path

UniBI service installation directory\unibi-solutions\system\analyzer\analyzer.properties

Description
Table 9-102 Parameters in analyzer.properties

Parameter

Description

Setting

Effective Mode

renderer.excel.export.mergeregion

Specifies whether to combine cells in a generated Excel report.

true: combine cells

false: not combine cells

Default value: true

Immediately

report.render.chart.support.forecast

Specifies whether line chart about trend prediction is supported.

true: Line chart about trend prediction is supported.

false: Line chart about trend prediction is not supported.

Default value: false

Immediately

attach.daylight.sign

Specifies whether to display the DST flag when the time normalization function is used during DST.

true: yes

false: no

Default value: false

Immediately

Precautions

1. Do not modify the configuration file unless necessary.

2. If you modify configuration items, the modifications take effect immediately without the need to restart the UniBI service.

Configuration Example

renderer.excel.export.mergeregio=true

report.render.chart.support.forecast=false

attach.daylight.sign=false

system.properties
Function

The configuration file configures Agile Reporter system parameters and core information including server ports, clusters, keys, and alarms.

Path

UniBI_Server\unibi-solutions\system\conf\system.properties

Description
Table 9-103 Configuration items in system.properties

Parameter

Description

Setting

Effective Mode

alarm.diskspace.interval

Indicates the interval for periodically monitoring the available disk space.

The value ranges from 30 seconds to 1 hour.

Default value: 10 minutes

Restart the agile report service.

alarm.diskspace.threshold

Configures the threshold for the available disk space. If the disk space usage exceeds the threshold, an alarm is generated.

You can configure the threshold in two formats:

1. Percentage. The value ranges from 5% to 95%.

2. Gigabyte. The minimum value is 2. Set this parameter within a proper range.

Default value: 80%

Restart the agile report service.

dynamic.loadcube.mode

Displays or hides the data source management page.

Data type: boolean

Values: true or false

Default value: The value is true in an environment with memory smaller than 14 GB. The value is false in other environments.

Modification method: Modify the value directly.

Restart eSight.

keystoreFile

Indicates the key store file.

NOTE:

The certificate file name must be a string of no more than 20 characters containing letters, digits, and underscores (_). The file name extension must be jks.

Data type: string

Value range: unrestricted

Default value: UniBI.jks

Restart the agile report service.

keystorePass

Indicates the encrypted password in the key store file.

Data type: string

Value range: unrestricted

Default value: encrypted initial password

Restart the agile report service.

Precautions

1. Do not modify configuration file except the items described in the preceding table unless necessary.

2. If you modify the configuration items, restart the agile report service to make the modifications take effect.

3. After you modify the configuration items and restart related services, the earlier alarm is cleared and the threshold is updated.

Configuration Example

alarm.diskspace.interval=600

alarm.diskspace.threshold=80%

backendFilter.properties
Function

The configuration file configures parameters for invoking M2M interfaces of Agile Reporter.

Path

UniBI_Server\unibi-solutions\system\conf\backendFilter.properties

Description
Table 9-104 Configuration items in backendFilter.properties

Parameter

Description

Setting

Effective Mode

APIKey

Indicates the server authentication key of the Agile Reporter M2M interface.

Data type: string

Value range: unrestricted

Default value: ffb14457a032dab9630dfdbc6507cf8f0d8f7492e7304974f8bff10853f07eef1c8d72cb17f9fa90d2abb1e40b0298d40626376a070a9142734e78d9130fc3d12049459fe356fddce33a7011ad06f8729518558aa0f5c8aa5671b43dff7fa9494fbddaa261b237aa692b66086da5329f (cipher-text); eSight@123 (plain-text)

Modification method: Run the UniBI_Server\tools>encryptirreversible.bat command and enter the new plain-text user name and password as prompted. Enter the cipher-text password in the command output here.

NOTE:

The server authentication user name and password must be the same the client authentication user name and password (unibi.auth.user and unibi.auth.pwd parameters) in the report_unibi.properties file. The server and client parameters need to be modified simultaneously.

Restart eSight.

APICaller

Indicates the server authentication user name of the Agile Reporter M2M interface.

Data type: string

Value range: unrestricted

Default value: admin

Modification method: Modify the value directly. This value is used to encrypt the authentication key, so the system needs to re-generate APIKey if this value is modified. For details on key generation, see the modification method for APIKey.

NOTE:

The server authentication user name and password must be the same the client authentication user name and password (unibi.auth.user and unibi.auth.pwd parameters) in the report_unibi.properties file. The server and client parameters need to be modified simultaneously.

Restart eSight.

unibi.auth.user

Indicates the client authentication user name of the Agile Reporter M2M interface.

Data type: string

Value range: unrestricted

Default value: admin

Modification method: Modify the value directly.

NOTE:

The client authentication user name and password must be the same the server authentication user name and password (APIKey and APICaller parameters) in the report_unibi.properties file. The server and client parameters need to be modified simultaneously.

Restart eSight.

unibi.auth.pwd

Indicates the client authentication password of the Agile Reporter M2M interface.

Data type: string

Value range: unrestricted

Default value: @0102000000007b6151e994a35ec9e8650e4c23f8a4a712b7ab6730efa2175c133ced6e118eb1 (cipher-text); eSight@123 (plain-text)

Modification method: Run the AppBase\tools\bmetool\encrypt>encrypt.bat 0 command and enter the new password. Enter the value in the command output here.

NOTE:

The client authentication user name and password must be the same the server authentication user name and password (APIKey and APICaller parameters) in the report_unibi.properties file. The server and client parameters need to be modified simultaneously.

Restart eSight.

report_unibi.properties
Function

The configuration file configures parameters for invoking M2M interfaces of Agile Reporter.

Path

AppBase\etc\report\report_unibi.properties

Description
Table 9-105 Configuration items in report_unibi.properties

Parameter

Description

Setting

Effective Mode

APIKey

Indicates the server authentication key of the Agile Reporter M2M interface.

Data type: string

Value range: unrestricted

Default value: PPBvC65ZJuEhyNe8fBiej4JhBdNM7ceFJMa1iAlg1Dc= (cipher-text); eSight@123 (plain-text)

Modification method: Run the AppBase\tools\bmetool\encrypt>encrypt.bat 2 command and enter the new password. In the command output, the first line indicates the encrypted value and the second line indicates the salt. Enter the value in the first line here.

NOTE:

1. After you modify this parameter value, you also need to modify the value of APISalt using the new salt.

2. The server authentication user name and password must be the same the client authentication user name and password (unibi.auth.user and unibi.auth.pwd parameters) in the backendFilter.properties file. The server and client parameters need to be modified simultaneously.

Restart eSight.

APICaller

Indicates the server authentication user name of the Agile Reporter M2M interface.

Data type: string

Value range: unrestricted

Default value: admin

Modification method: Modify the value directly.

NOTE:

The server authentication user name and password must be the same the client authentication user name and password (unibi.auth.user and unibi.auth.pwd parameters) in the backendFilter.properties file. The server and client parameters need to be modified simultaneously.

Restart eSight.

APISalt

Indicates the server authentication salt of the Agile Reporter M2M interface.

Data type: string

Value range: unrestricted

Default value: admin

Modification method: Run the AppBase\tools\bmetool\encrypt>encrypt.bat 2 command and enter the new password. In the command output, the first line indicates the encrypted value and the second line indicates the salt. Enter the value in the second line here.

NOTE:

The server authentication user name and password must be the same the client authentication user name and password (unibi.auth.user and unibi.auth.pwd parameters) in the backendFilter.properties file. The server and client parameters need to be modified simultaneously.

Restart eSight.

unibi.auth.user

Indicates the client authentication user name of the Agile Reporter M2M interface.

Data type: string

Value range: unrestricted

Default value: admin

Modification method: Modify the value directly.

NOTE:

The client authentication user name and password must be the same the server authentication user name and password (APIKey and APICaller parameters) in the backendFilter.properties file. The server and client parameters need to be modified simultaneously.

Restart eSight.

unibi.auth.pwd

Indicates the client authentication password of the Agile Reporter M2M interface.

Data type: string

Value range: unrestricted

Default value: @0102000000007b6151e994a35ec9e8650e4c23f8a4a712b7ab6730efa2175c133ced6e118eb1 (cipher-text); eSight@123 (plain-text)

Modification method: Run the AppBase\tools\bmetool\encrypt>encrypt.bat 0 command and enter the new password. Enter the value in the command output here.

NOTE:

The client authentication user name and password must be the same the server authentication user name and password (APIKey and APICaller parameters) in the backendFilter.properties file. The server and client parameters need to be modified simultaneously.

Restart eSight.

schedule.properties
Function

The configuration file configures periodic UniBI tasks.

Path

UniBI_Server\unibi-solutions\system\conf\schedule.properties

Description

Table 1 Configuration items in schedule.properties

Parameter

Description

Setting

Effective Mode

max.schedule.per.user

Indicates the maximum number of periodic tasks that can be created by a single user.

Data type: integer

Value range: 1-500

Default value: 100

Modification method: Modify the value directly.

Restart eSight.

total.no.schedules

Indicates the maximum number of periodic tasks that can be created by all users.

Data type: integer

Value range: 1-500

Default value: 500

Modification method: Modify the value directly.

Restart eSight.

max.history.per.schedule

Indicates the number of historical reports that can be saved in a single periodic task.

Data type: integer

Value range: 1-20

Default value: 20

Modification method: Modify the value directly.

Restart eSight.

enable.schedule=true

Indicates whether periodic task is enabled.

Data type: boolean

Values: true or false

Default value: true

Modification method: Modify the value directly.

Restart eSight.

email.attachment.need.compress

Indicates whether to compress attachments of periodic task mails.

Data type: string

Value range: yes/no/auto

Default value: yes

Modification method: Modify the value directly.

Restart eSight.

email.attachment.compress.beyond.size

If the email.attachment.need.compress parameter is set to auto and the attachment size exceeds this threshold, the attachment is compressed. If the email.attachment.need.compress parameter is set to auto and the attachment size does not exceed this threshold, the attachment is not compressed. The unit of this parameter is MB.

Data type: float

Value range: 0–20

Default value: 20

Modification method: Modify the value directly.

Restart eSight.

total.upload.no.schedules

Indicates the maximum number of historical reports that can be uploaded in all periodic tasks.

Data type: integer

Value range: 0–20000

Default value: 16800

Modification method: Modify the value directly.

Restart eSight.

schedule.upload.history.cleanup.days

Indicates the maximum duration for storing uploaded historical reports.

Data type: integer

Value range: 1–90

Default value: 30

Modification method: Modify the value directly.

Restart eSight.

schedule.upload.reportfiles.need.compress

Indicates whether to compress historical report files uploaded by a periodic task.

Data type: string

Value range: yes/no

Default value: yes

Modification method: Modify the value directly.

Restart eSight.

ssoConfig.properties
Function

The configuration file configures background interfaces of Agile Reporter.

Path

AppBase\UniBI_Server\etc\sso.sm\ssoConfig.properties

Description
Table 9-106 Configuration items in ssoConfig.properties

Parameter

Description

Setting

Effective Mode

sm.auth.name

Indicates the client authentication user name used by Agile Reporter to invoke the /rest/iemp/sso/session interface.

Data type: string

Default value: JsonName

Modification method: Modify the value directly.

NOTE:

You can modify this parameter value only after the server authentication password is changed. For details on how to change the server authentication password, see description in the AppBase\etc\oms.sm\sm.xml file.

Restart eSight.

sm.auth.pwd

Indicates the client authentication password used by Agile Reporter to invoke the /rest/iemp/sso/session interface.

Data type: string

Default value: da9098f4c71497ce22e8949f67ead5c67ca0c640c12e82b523155fcf93f25127 (cipher-text); Changeme_123 (plain-text)

Modification method: Run the UniBI_Server\tools>encryptreversible.bat -i command and enter the new password and key file path ../unibi-solutions/security/conf for encryption as prompted.

NOTE:

You can modify this parameter value only after the server authentication password is changed. For details on how to change the server authentication password, see description in the AppBase\etc\oms.sm\sm.xml file.

Restart eSight.

analyzer_internal.properties
Function

The configuration file configures UniBI services and report file formats.

Path

UniBI service installation directory\unibi-solutions\system\analyzer\analyzer_internal.properties

Description
Table 9-107 Configuration items in analyzer_internal.properties

Parameter

Description

Setting

Effective Mode

renderer.csv.export.separator

CSV file separator.

Data type: string

Value range: 32 characters

Default value: comma (,)

Modification method: Modify the value directly.

NOTE:

The CSV separator cannot be set to Enter.

Restart the agile report service.

Precautions

1. Do not modify the configuration file unless necessary.

2. After modifying the configuration file, restart the UniBi service for the modification to take effect.

Configuration Example

renderer.csv.export.separator=,

Performance Management

This section describes configuration files related to performance management.

AR500_Common_MonitoringTemplate.xml
Function

The configuration file sets 3G performance indicators for AR500 routers.

Path

eSight installation directory\AppBase\momgr\enterprise.nemgr.AR500\repository\extension\com.huawei.enterprise.nemgr.AR500-1.0\META-INF\oms\model\mo_feature\pm\AR500

Description
Table 9-108 Configuration items in AR500_Common_MonitoringTemplate.xml

Parameter

Description

Setting

Effective Mode

optionalPeriod

Sets the collection period.

Second

Startup after initial installation or restart after database cleanup

resourceType

Indicates the resource type.

Resource type name

Startup after initial installation or restart after database cleanup

measUnit

Specifies the indicator group information.

Indicator group name

Startup after initial installation or restart after database cleanup

measType

Sets indicators to be collected.

Indicator name

Startup after initial installation or restart after database cleanup

Precautions

Do not modify the configuration file unless necessary.

Configuration Example

<!--Cellular interface traffic statistics-->

<measUnit key="ifCellTrafficStat" optionalPeriod="300,900,1800,3600,86400" resourceType="ifCellTraffic"

defaultPeriod="60" measObject="true" featureID="interface" >

<!-- Number of received bytes on cellular interfaces -->

<measType key="hwCellBytesSent" defaultPeriod="900" dataType="FLOAT"

autoCollect="Nonsupport" />

<!-- Number of sent bytes on cellular interfaces -->

<measType key="hwCellBytesReceived" defaultPeriod="900" dataType="FLOAT"

autoCollect="Nonsupport" />

</measUnit>

Common_CollectInfo.xml
Function

The configuration file sets collection nodes for 3G performance indicators of AR500 routers.

Path

eSight installation directory\AppBase\momgr\enterprise.nemgr.AR500\repository\extension\com.huawei.enterprise.nemgr.AR500-1.0\META-INF\oms\model\mo_feature\pm\Common

Description
Table 9-109 Configuration items in Common_CollectInfo.xml

Parameter

Description

Setting

Effective Mode

measUnit

Specifies the indicator group information.

Indicator group name

Startup after initial installation or restart after database cleanup

measType

Sets indicators to be collected.

Indicator name

Startup after initial installation or restart after database cleanup

Precautions

Do not modify the configuration file unless necessary.

Configuration Example

<!--3G interface traffic-->

<measUnit key="ifCellTrafficStat" probeType="zsnmpByIndex" scope="{*">

<measObject getter="INTERFACE" formatter="ENTERPRISE" format="">

<measIndex key="ifIndex" index="true" measObjectType="interface" />

</measObject>

<!--Number of bytes sent by 3G interfaces -->

<measType key="hwCellBytesSent" column="1.3.6.1.4.1.2011.5.25.241.1.2.1.1.26" dataType="LONG" calculationType="SUM" />

<!--Number of bytes received by 3G interfaces -->

<measType key="hwCellBytesReceived" column="1.3.6.1.4.1.2011.5.25.241.1.2.1.1.27" dataType="LONG" calculationType="SUM" />

</measUnit>

Common_pm_en_US.properties
Function

The configuration file (English) configures resources for 3G interfaces.

Path

eSight installation directory\AppBase\momgr\enterprise.nemgr.common\i18n

Description
Table 9-110 Configuration items in Common_pm_en_US.properties

Parameter

Description

Setting

Effective Mode

ifCellTraffic.resType

Specifies the 3G interface name.

Name

Restart

Precautions

Do not modify the configuration file unless necessary.

Configuration Example

ifCellTraffic.resType = Cellular Interface

Common_pm_zh_CN.properties
Function

The configuration file (Chinese) configures resources for 3G interfaces.

Path

eSight installation directory\AppBase\momgr\enterprise.nemgr.common\i18n

Description
Table 9-111 Configuration items in Common_pm_zh_CN.properties

Parameter

Description

Setting

Effective Mode

ifCellTraffic.resType

Specifies the 3G interface name.

Name

Restart

Precautions

Do not modify the configuration file unless necessary.

Configuration Example

ifCellTraffic.resType = Cellular interface

pom.xml
Function

The configuration file defines a dependency engineering for the performance module.

Path

eSight installation directory/opt/eSight/AppBase/app/enterprise.app.pm/repository/ext/com.huawei.enterprise.app.pm.ext.interface-1.0.jar/META-INF/maven/com.huawei.oms/com.huawei.enterprise.app.pm.ext.interface

Description
Table 9-112 Configuration items in pom.xml

Parameter

Description

Setting

Effective Mode

dependency

Specifies a dependency engineering.

Released information about the dependency resource

Restart

artifactId

Specifies the dependency engineering ID.

Released information about the dependency resource

Restart

groupId

Specifies group information.

Released information about the dependency resource

Restart

version

Specifies the version.

Released information about the dependency resource

Restart

type

Specifies the dependency type.

Released information about the dependency resource

Restart

Precautions

Do not modify the configuration file unless necessary.

Configuration Example

<dependency>

<groupId>com.huawei.oms</groupId>

<artifactId>com.huawei.enterprise.app.arcellularmgr.gapi</artifactId>

<version>1.0</version>

<type>jar</type>

<scope>compile</scope>

</dependency>

extension.xml
Function

The configuration file configures the 3G interface extension points for the performance module.

Path

eSight installation directory/opt/eSight/AppBase/app/enterprise.app.pm/repository/ext/com.huawei.enterprise.app.pm.ext.interface-1.0.jar/META-INF/oms

Description
Table 9-113 Configuration items in extension.xml

Parameter

Description

Setting

Effective Mode

extension

Specifies an extension point.

Extension point engineering

Restart

extframe

Specifies the resource type at the extension point.

Resource type of the added extension point

Restart

selectobj

Specifies the resource configuration of the extension point.

Implementation class

Restart

Precautions

Do not modify the configuration file unless necessary.

Configuration Example

<extension point="enterprise.app.pm.extframe">

<extframe resourceType="ifCellTraffic">

<selectobj resName="enterprise.app.pm.ext.ifs.interface.name" >

pm.properties
Function

The configuration file provides add-ins for performance management when eSight is started.

Path

eSight installation directory/AppBase/etc/oms.pm/pm.properties

Description
Table 9-114 Configuration items in pm.properties

Parameter

Description

Setting

Effective Mode

maxCollectIndexNum

Configures the maximum number of collection indexes supported by the system that can be displayed on the interface.

Data type: character string

Value range:

  • -1: The maximum number of collection indexes is not displayed on the interface.
  • Integer greater than 0: The maximum number of collection indexes is displayed on the interface.

Default value: 160,000. The system will automatically adjust the value according to server configurations.

Scheduled dynamic update

maxTaskNum

Configures the maximum number of collection tasks supported by the system that can be displayed on the interface.

Data type: character string

Value range:

  • -1: The maximum number of collection indexes is not displayed on the interface.
  • Integer greater than 0: The maximum number of collection tasks is displayed on the interface.

Default value: 60,000. The system will automatically adjust the value according to server configurations.

Scheduled dynamic update

optionalPeriod

Sets the collection period for performance collection tasks.

Data type: character string

Value range:

  • Default value (minutes): 5, 15, 30, 60, and 1440
  • Device collection period: 1, 5, 15, 30, 60, and 1440
  • Port collection period: 0.5, 1, 5, 15, 30, 60, and 1440

Default value: true

Scheduled dynamic update

supportHidePoints

Sets whether to hide the performance collection point.

Data type: character string

Value range: true or false

Default value: true

Scheduled dynamic update

supportDumpTask

Sets whether to trigger the dump file writing task.

Data type: character string

Value range: true or false

Default value: true

Scheduled dynamic update

clearWeekTime

Sets the period for clearing the weekly table.

Data type: character string

Value range: 1 to 24

Default value: 2

Restart

autoStopOvertask

Indicates whether to automatically stop the last modified task when the number of collection units exceeds the maximum.

Data type: character string

Value range: true or false

Default value: true

Scheduled dynamic update

maxSelectMeasObjSize

Sets the maximum number of resources that can be selected during performance task creation.

Data type: character string

Value range: 30-1500

Default value: 1000

Scheduled dynamic update

dataStoreIntoMonthTbl

Indicates whether to save the performance data to the monthly table.

Data type: boolean

Value range: true or false

Default value: true

Scheduled dynamic update

weekSaveDays

Indicates the number of days for storing data in a weekly table.

Data type: character string

Value range: 1-7

Default value: 7

Scheduled dynamic update

Precautions

Do not modify the configuration file unless necessary.

If you manually modify the configuration items, restart eSight to make the modifications take effect. Check the supported performance specifications before modifying parameters.

Configuration Example

optionalPeriod=5,15,30,60,1440;device<=>1,5,15,30,60,1440;interface<=>0.5,1,5,15,30,60,1440

maxCollectIndexNum=160000

maxTaskNum=60000

autoStopOvertask=true

pm.nbi.properties
Function

The configuration file records the transfer modes of northbound performance files. If the SFTP mode is used to transfer northbound performance files, the northbound performance interface can obtain the SFTP user name, SFTP password, and whitelist of SFTP clients from this file, and upload the generated northbound performance file.

Path

eSight installation directory/AppBase/etc/oms.pm

Description
Table 9-115 Configuration items in pm.nbi.properties

Parameter

Description

Mandatory/Optional

Setting

Effective Mode

nbiSFtpUser

Indicates the user name used to transfer northbound performance files to eSight northbound interfaces using SFTP.

Optional

Data type: string

Value range: unrestricted

Default value: null

NOTICE:

This parameter needs to be configured only in distributed scenarios.

Restart

nbiSFtpUserValue

Indicates the user password used to transfer northbound performance files to eSight northbound interfaces using SFTP, and the password is encrypted using AES.

Optional

Data type: string

Value range: AES encryption value

Default value: null

NOTICE:

This parameter needs to be configured only in distributed scenarios and encrypted using the encryption tool by running the ./encrypt.sh 0 password command.

Restart

nbiSFtpWhiteIp

Indicates the whitelist of SFTP clients that transfer northbound performance files to eSight northbound interfaces.

Optional

Data type: string

Value range: a collection of client IP addresses in distributed scenarios

Default value: null

NOTICE:

This parameter needs to be configured only in distributed scenarios. The IP addresses are separated by commas (,).

Restart

nbiIsSFtp

Specifies whether to use SFTP to transfer northbound performance files.

Mandatory

Data type: boolean

Value range:

  • true
  • false

Default value: false

NOTE:

This parameter is set to false in the single-node system, and true in distributed scenarios. In distributed scenarios, the nbiSFtpUser, nbiSFtpUserValue, and nbiSFtpWhiteIp parameters need to be configured.

Restart

nbiOptimizationVersion

Indicates whether to change the mode.

Mandatory

Data type: int

Value range:

  • 1
  • 2
    Default value: 1
    NOTE:

    The value is 1 in upgraded and newly installed versions, indicating that mode 1 is used. In mode 2, nbiIsUTC and nbiIsFormatted need to be configured.

Dynamic update by timer

nbiIsUTC

Specifies whether to change the UTC time in the file name to the local time.

Used in mode 2

Data type: boolean

Value range:

  • true
  • false

Default value: false

NOTE:

The value false indicates that the local time is used. The value true indicates that the UTC time is used.

Dynamic update by timer

nbiIsFormatted

Specifies whether to change the collection time in the file from the UTC time to the local time.

Used in mode 2

Data type: boolean

Value range:

  • true
  • false

Default value: true

NOTE:

The value true indicates that the local time is used. The value false indicates that the UTC time is used.

Dynamic update by timer

Precaution

The configuration file can be modified based on actual situations.

Configuration Example

Single-node system

#Function: customize internal sftp user for performance north.
#Description: customize internal sftp user for performance north at distributed system.
#Default value: null
nbiSFtpUser=

#Function: customize internal sftp user password for performance north.
#Description: customize internal sftp user password for performance north at distributed system.
#Default value: null
nbiSFtpUserValue=

#Function: customize ip of sftp client.
#Description: customize ip of sftp client at distributed system.
#Default value: null
nbiSFtpWhiteIp=

#Function: customize the way of transfer indicator file to north.
#Description: set false at single model, set true at distributed system, and need to customize nbiSFtpUser, nbiSFtpUserValue, nbiSFtpWhiteIp.
#If it is set to false (case insensitive), copy the file to ftp directory directly. 
#If it is set to true (case insensitive), transfer the file by sftp.
#Default value: false
nbiIsSFtp=false

#Function: customize whether or not optimizing the nbi file.
#If it is set to 1 (case insensitive), do not optimize the nbi file. 
#If it is set to 2 (case insensitive), optimize the nbi file.
#Default value: 1
nbiIsOptimization=1

#Function: customize the format of the file name.
#If it is set to false (case insensitive), the collection time is expressed in local time. 
#If it is set to true (case insensitive), the collection time is expressed in UTC.
#Default value: false
nbiIsUTC=false

#Function: customize the format of the file content.
#If it is set to false (case insensitive), the collection time is expressed in default timestamp. 
#If it is set to true (case insensitive), the collection time is expressed in local time.
#Default value: true
nbiIsFormatted=true

Distributed scenario

#Function: customize internal sftp user for performance north.
#Description: customize internal sftp user for performance north at distributed system.
#Default value: null
nbiSFtpUser=pmuser

#Function: customize internal sftp user password for performance north.
#Description: customize internal sftp user password for performance north at distributed system.
#Default value: null
nbiSFtpUserValue=817752fc7ebb5f9cd6c9187519dde5c89e90f0791e749f5ce85df650617781ef

#Function: customize ip of sftp client.
#Description: customize ip of sftp client at distributed system.
#Default value: null
nbiSFtpWhiteIp=10.67.166.29,10.67.164.166,10.67.164.167

#Function: customize the way of transfer indicator file to north.
#Description: set false at single model, set true at distributed system, and need to customize nbiSFtpUser, nbiSFtpUserValue, nbiSFtpWhiteIp.
#If it is set to false (case insensitive), copy the file to ftp directory directly. 
#If it is set to true (case insensitive), transfer the file by sftp.
#Default value: false
nbiIsSFtp=true

#Function: customize whether or not optimizing the nbi file.
#If it is set to 1 (case insensitive), do not optimize the nbi file. 
#If it is set to 2 (case insensitive), optimize the nbi file.
#Default value: 1
nbiIsOptimization=1

#Function: customize the format of the file name.
#If it is set to false (case insensitive), the collection time is expressed in local time. 
#If it is set to true (case insensitive), the collection time is expressed in UTC.
#Default value: false
nbiIsUTC=false

#Function: customize the format of the file content.
#If it is set to false (case insensitive), the collection time is expressed in default timestamp. 
#If it is set to true (case insensitive), the collection time is expressed in local time.
#Default value: true
nbiIsFormatted=true

roa.inst.pm.xml
Function

The configuration file configures the ROA instance information for the performance process.

Path

eSight installation directory/AppBase/etc/iemp.framework

Description
Table 9-116 Configuration items in roa.inst.pm.xml

Parameter

Description

Mandatory/Optional

Setting

Effective Mode

defaul.threadpool.thread.max

Specifies the maximum number of threads in the thread pool.

Mandatory

Data type: integer

Default value: 100

Restart

defaul.threadpool.queue.max

Specifies the maximum number of queues in the thread pool.

Mandatory

Data type: integer

Default value: 2000

Restart

pmAgentHttpsPort.ip

Specifies the HTTP IP address.

Optional

Data type: string

Default value: IP address of the performance process server

Restart

pmAgentHttpsPort.port

Specifies the HTTP port number.

Mandatory

Data type: string

Default value: 32,022

Restart

pmAgentHttpsPort.needregister

Specifies whether the PM Agent is registered.

Mandatory

Data type: boolean

Default value: true

Restart

pmAgentHttpsPort.ssl.keystore.path

Specifies the password path of the HTTPS SSL certificate for the PM Agent.

Mandatory

Data type: string

Default value: etc/certificate/serverKeyStore

Restart

pmAgentHttpsPort.ssl.keystore.password

Specifies the password of the HTTPS SSL certificate for the PM Agent.

Mandatory

Data type: string

Default value: 9b71ad3cc9600686c7d7e4c8beeb61a89d30d75527152e04370f203da3642cc5

Restart

Precautions

Do not modify the configuration file unless necessary.

Configuration Example
<?xml version="1.0" encoding="utf-8"?>
<webservers>
    <webserver name="default">
        <property name="threadpool.thread.max" value="100" />
        <property name="threadpool.queue.max" value="2000" />
        <connectors>
            <connector name="pmAgentHttpsPort" type="https">
                <property name="ip" value="10.67.166.29" />
                <property name="port" value="32022" />
                <property name="needregister" value="true" />
                <property name="ssl.keystore.path" value="etc/certificate/serverKeyStore" />
                <property name="ssl.keystore.password" value="9b71ad3cc9600686c7d7e4c8beeb61a89d30d75527152e04370f203da3642cc5" />
            </connector>
        </connectors>
    </webserver>
</webservers>

SLA

This section describes SLA configuration files.

ent_sla.xml
Function
  • This file is used to configure whether the SLA supports northbound file export.
  • This file is used to configure whether the SLA task period can be one minute.
Path

eSight installation directory\AppBase\etc\sla\config\ent_sla.xml

Description
Table 9-117 Parameters in ent_sla.xml

Parameter

Description

Setting

Effective Mode

ENABLE_EXPORT

Indicates whether the SLA supports northbound file export.

0: no

1: yes

Default value: 0

Restart

MIN_ONE

Indicates whether the SLA task period can be one minute.

0: no

1: yes

Default value: 0

Restart

Precautions

1. Do not modify the configuration file unless necessary.

2. After the value of MIN_ONE is changed to 1, one-minute periodical tasks can be created. However, the number of tasks should be fewer. Otherwise, the performance may be affected.

Configuration Example

<param name="ENABLE_EXPORT">1</param>

<param name="MIN_ONE">1</param>

iPCA

This section describes iPCA configuration files.

ent_ipca_nbi.xml
Function

This file is used to configure whether the iPCA supports northbound file export.

Path

eSight\AppBase\etc\sla\ipca\ent_ipca_nbi.xml

Description
Table 9-118 Parameters in ent_ipca_nbi.xml

Parameter

Description

Setting

Effective Mode

ENABLE_EXPORT

Indicates whether the iPCA supports northbound file export.

0: no

1: yes

Default value: 0

Restart

Precautions

None

Configuration Example

<param name="ENABLE_EXPORT">1</param>

User Access Management

This section describes configuration files related to user access management.

large_capacity_config.properties
Function

This configuration file is used to support large-capacity and ultra-large-capacity user management. In the large-capacity user management scenario, a maximum of 200,000 online users can be managed. In the ultra-large-capacity user management scenario, a maximum of 400,000 online users can be managed.

Path

eSight installation directory\AppBase\var\iemp\storage\enterprise.app.clientsandusers\large_capacity_config.properties

Description
Table 9-119 Configuration items in large_capacity_config.properties

Parameter

Description

Setting

Effective Mode

large_capacity

Indicates whether to support large-capacity user management.

2: support ultra-large-capacity user management

1: support large-capacity user management

0: do not support large-capacity and ultra-large-capacity user management

Restart eSight.

Precautions

1. After eSight is installed, this file is not generated. You need to manually create the configuration file, set configuration items, and restart eSight for the configurations to take effect. Configurations modified in the configuration file after eSight is restarted do not take effect.

2. To support large-capacity or ultra-large-capacity user management, you need to create a configuration file after eSight is installed.

3. When the large-capacity user management function is enabled, the user polling time options are changed to 30 minutes, 60 minutes, and 180 minutes. The default polling time is 60 minutes. When the ultra-large capacity user management function is enabled, the user polling time options are changed to 30 minutes, 60 minutes, and 180 minutes. The default polling time is 30 minutes.

Configuration Example

large_capacity=1

Translation
Download
Updated: 2019-06-30

Document ID: EDOC1100044373

Views: 24785

Downloads: 74

Average rating:
This Document Applies to these Products
Related Documents
Related Version
Share
Previous Next