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 V300R010C00SPC200, 300, and 500 Self-Service Integration Guide 10

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).
Reference Information for nbi.xml

Reference Information for nbi.xml

Function

The nbi.xml file is used to configure parameters required by the NBI to query the device list.

Path

"eSight installation directory/AppBase/etc/oms.nbi/nbi.xml"

Description

Modifications on the following configuration items take effect only after the eSight is restarted. Periodically modify the configuration items that involve passwords. Changing passwords periodically prevents theft of the passwords and unauthorized access.

Configuration Item

Configuration Description

Reference Configuration

NBIFileStoragePath

Indicates the path that stores the device list file.

Data type: string

Value range: a string complying with the file path rules

Default value: data/nbi

NmsinfoName

Indicates the IP address of the third-party system.

Data type: string

Value range: Valid IP address.

NOTE:

When you configure multiple third-party systems, it is required to set different names.

Default value: no default value

IsPush

Indicates the method used to obtain the device list.

Data type: integer

Values:

  • 0: Pull
  • 1: Push

Default value: 0

FTPServerIp

Indicates the FTP server IP address of the third-party system.

Data type: dotted decimal notation

Value range: unrestricted

Default value: 127.0.0.1

Port

ndicates the FTP port. SFTP is recommended to ensure transmission security.

server port of the third-party system.

Data type: integer

Value range: 0-65535

Default value: no default value

AuthMode

Indicates the authentication mode of the FTP server on the third-party system.

This parameter is valid only when the push mode is used and the SFTP is used to transfer files.

Data type: integer

Values:

  • 0: Password
  • 1: Public Key

Default value: 0

FileTransMode

Indicates the transmission mode of the FTP server on the third-party system.

Data type: integer

Values:

  • 0: FTP
  • 1: SFTP
NOTE:

SFTP is recommended to ensure transmission security.

Default value: 1

isPassive

Specifies the file transfer method in push mode based on the FTP.

Data type: integer

Value range:

  • 0: active
  • 1: passive

Default value: 0

UpLoadRate

When the bandwidth is limited, set the parameter to control the file upload speed of the FTP user, which can allocate the upload speed of other users as required. This parameter works only when IsPush is set to 0.

NOTE:

This parameter is valid only for the FTP and does not support the SFTP.

Data type: integer

Value range: 0–52428800 (50 MB)

Default value: 0

NOTE:

If this parameter is set to 0, the speed is not limited.

Unit: byte/s

DownLoadRate

When the bandwidth is limited, set the parameter to control the file download speed of the FTP user, which can allocate the download speed of other users as required. This parameter works only when IsPush is set to 0.

NOTE:

This parameter is valid only for the FTP and does not support the SFTP.

Data type: integer

Value range: 0–52428800 (50 MB)

Default value: 0

NOTE:

If this parameter is set to 0, the speed is not limited.

Unit: byte/s

Username

  • If IsPush is set to 1, FileTransMode is set to 0, this parameter indicates the user name used by theeSight to log in to the FTP server of the third-party system.
  • If IsPush is set to 1, FileTransMode is set to 1, and AuthMode is set to 0, this parameter indicates the user name used by the eSight to log in to the FTP server of the third-party system.
  • If IsPush is set to 0, this parameter indicates the requested user name to be created on the FTP server of the eSight.

Data type: string

Value range: The configuration item contains 6 to 32 characters but cannot contain spaces or these special characters: " \ # % / & ' ; < + = > ? © ®

NOTE:

When you configure different third-party systems, it is required to set different user name.

Default value: no default value

AuthInfo

  • If IsPush is set to 1, the meaning of this parameter may be one of the following:

    Indicates the password used by the eSight to log in to the FTP server of the third-party system when FileTransMode is set to 0.

    Indicates the password used by the eSight to log in to the SFTP server of the third-party system when FileTransMode is set to 1.

    Indicates the absolute path to the file that contains private keys used by the eSight to log in to the third-party system when FileTransMode and AuthMode are set to 1.

  • If IsPush is set to 0, this parameter indicates password for the requested user name to be created on the FTP server of the eSight.

Data type: string

Value range: password in ciphertext (encrypted by using Huawei encryption tool).

NOTE:

Passwords before encryption cannot be the same as or reverse of the user name. Otherwise, the account will not take effect, and you cannot use the account to log in to the FTP server.

Default value: no default value

ValuePhrase

Indicates that the content is the ciphertext after encryption.

NOTE:
  • If the OMS connects to the third-party system through SFTP and AuthMode is 1 (public key-based authentication), this parameter indicates the password for the private key file.
  • By default, this configuration item is not provided. It is configurable to be compatible with earlier versions.

Data type: string

Values: Password for the private key file. The password is obtained using Huawei encryption tool.

Default value: empty

NMSTopologyFilePath

Indicates where a northbound file is saved on the FTP server. This parameter works only when IsPush is set to 1.

Data type: string

Values:
  • In the Windows operating system, set this parameter to a relative path. The relative path is the root directory of the FTP server. The relative path starts with a slash (\). For example, if this parameter is set to \relativePath, the file is uploaded to Root directory of FTP server\relativePath.
  • In the Linux operating system, set this parameter to a relative path. The relative path starts with a slash (\). The relative path is the root directory of the FTP server. For example, if this parameter is set to /relativePath, the file is uploaded to Root directory of FTP server/relativePath.

Default value: /home/nbi/NMSTopologyFiles

TopologyFileExtensionPoint

Indicates the attribute by which the format of a topology file can be user-defined.

Data type: string

Values: Java class name of the extension point, which must comply with the naming rules of a Java class name.

Default value: empty

RetryPollInterval

Indicates the polling interval.

Data type: integer

Value range: 1-30

Default value: 5

Unit: hour

FTPRetryTimes

Indicates the maximum number of attempts allowed to send a file to the third-party system over FTP.

Data type: integer

Value range: unrestricted

Default value: 3

Unit: time

FileRetentionDays

Indicates the minimum number of days within which the eSight server saves the files generated by the eSight.

Data type: integer

Value range: 1-365

Default value: 7

Unit: day

FileRetentionPollInterval

Indicates the interval at which the eSight NBI checks for duplicate files in the specified directory. If any duplicate files are found, they will be deleted.

Data type: integer

Value range: 1-8760

Default value: 12

Unit: hour

TopologyDelimiter

Indicates the delimiter used to separate different features in topology information.

Data type: string

Values: _ : ; ` @ # ! ~ '

Default value: ;

baseDN

Indicates the marker for the root object of the managed-object tree in a topology file.

Data type: string

Values: /

Default value: /

isPeriodic

Indicates the topology data collection manner.

Data type: boolean

Values:

  • false: collects topology data at a certain time point (specified by StartTime below) every day
  • true: collects topology data at intervals (specified by Period below)

Default value: false

StartTime

If isPeriodic is set to false, this parameter indicates the time point at which topology data is collected every day. If isPeriodic is set to true, this parameter indicates the time point from which topology data is collected at intervals.

Data type: string

Values: format: hh:mm:ss

Default value: 00:00:00

Period

Indicates the interval at which topology data is collected. The unit is minute. This parameter works only when isPeriodic is set to true.

Data type: integer

Value range: unrestricted

Default value: 1440

Unit: minute

delta

Indicates how long a topology file can wait to be sent over FTP after being created. The unit is minute.

Data type: integer

Value range: ≤ 60

Default value: 60

Unit: minute

topoBaseDN

Indicates the default marker used by the eSight to locate the root object when obtaining a managed-object tree. This parameter can be modified on the third-party system through the SNMP NBI.

Data type: string

Values: /

Default value: /

topoScope

Indicates the scope of managed objects that the eSight NBI obtains from a managed-object tree. This parameter can be modified on the third-party system through the SNMP NBI.

Data type: integer

Values:

1: Only the root object is obtained.

2: Managed objects at level N are obtained, where N is the value of topoLevel.

3: Managed objects at the first N levels are obtained, where N is the value of topoLevel.

4: All objects in the managed-object tree are obtained.

Default value: 4

topoLevel

Indicates the levels of managed objects that the eSight NBI obtains from a managed-object tree. This parameter can be modified by changing MIB nodes.

Data type: integer

Value range: 1-10

Default value: 10

RefreshInterval

Indicates the interval at which the eSight NBI refreshes the managed-object list. The unit is second.

Data type: integer

Value range: unrestricted

Default value: 86400 (1 day)

Unit: second

PMThread.PMThreadSleepTime

Indicates the flow control time when the performance NBI pushes files.

Data type: integer

Value range: unrestricted

Default value: 10

Unit: ms

isSnmpEAM

Indicates whether to receive northbound resource events.

Data type: boolean

Value range:

  • true: Receives northbound resource events.
  • false: Do not receive northbound resource events.

Default value: true

isPassive

Indicates the FTP transfer mode in push mode.

Data type:

Default value:

  • 0: Active mode.
  • 1: Passive mode.

Default value: 0

Configuration Example

Push mode:

<?xml version="1.0" encoding="UTF-8"?> 
<NBIConfig> 
    <GeneralConfig > 
        <NBIFileStoragePath>data/nbi</NBIFileStoragePath>   
    </GeneralConfig> 
    <UserInfo> 
        <NmsinfoName>10.10.10.1</NmsinfoName> 
        <UserFtpInfo> 
            <CommonFTPInfo> 
                <IsPush>1</IsPush>     //Configure as the push mode
                <FTPServerIp>10.10.10.1</FTPServerIp> //IP address of the third-party system
                <Port>31921</Port>                      //Port of the third-party system
                <Username>admin1</Username> //FTP user name of the third-party system
                <AuthMode>0</AuthMode> 
                <AuthInfo>9d7961bc8af54d05ce509e03b13ffce3abc7587373e7719b62555fd5aff9908d</AuthInfo> 
                <FileTransMode>0</FileTransMode> 
                <isPassive>0</isPassive>
            </CommonFTPInfo> 
  
            <TopologyFTPInfo> 
                <NMSTopologyFilePath>/home/nbi/NMSTopologyFiles</NMSTopologyFilePath > 
            </TopologyFTPInfo> 
       </UserFtpInfo> 
        <CustomFileFormat> 
            <TopologyFileExtensionPoint></TopologyFileExtensionPoint> 
        </CustomFileFormat> 
    </UserInfo> 
    <PMThread>
         <PMThreadSleepTime>10</PMThreadSleepTime>
    </PMThread> 

    <FTPRetryDetails> 
        <RetryPollInterval>5</RetryPollInterval> 
        <FTPRetryTimes>3</FTPRetryTimes> 
    </FTPRetryDetails> 
    <FileRetention> 
        <FileRetentionDays>7</FileRetentionDays> 
        <FileRetentionPollInterval>12</FileRetentionPollInterval> 
    </FileRetention> 
    <CMDetails> 
        <TopologyDelimiter>;</TopologyDelimiter> 
        <TopologyTimerParameters> 
            <baseDN>/</baseDN> 
            <isPeriodic>true</isPeriodic> 
            <startTime>11:53:00</startTime> 
            <period>1</period> 
            <delta>60</delta> 
        </TopologyTimerParameters> 
       <TopologyRefreshTimerParameters> 
            <topoBaseDN>/</topoBaseDN> 
            <topoScope>4</topoScope> 
            <topoLevel>10</topoLevel> 
            <RefreshInterval>86400</RefreshInterval> 
        </TopologyRefreshTimerParameters> 
    </CMDetails>    
</NBIConfig>

Pull mode:

<?xml version="1.0" encoding="UTF-8"?> 
<NBIConfig> 
    <GeneralConfig > 
        <NBIFileStoragePath>var/iemp/data/nbi/data/nbi</NBIFileStoragePath>   
    </GeneralConfig> 
    <UserInfo> 
        <NmsinfoName>10.10.10.1</NmsinfoName> 
        <UserFtpInfo> 
            <CommonFTPInfo> 
                <IsPush>0</IsPush>     
                <Username>admin1</Username>   //FTP user name for logging into the eSight
                <AuthMode>0</AuthMode> 
                <AuthInfo>9d7961bc8af54d05ce509e03b13ffce3abc7587373e7719b62555fd5aff9908d</AuthInfo> 
                <FileTransMode>0</FileTransMode>  
            </CommonFTPInfo> 
  
            <TopologyFTPInfo> 
                <NMSTopologyFilePath>/home/nbi/NMSTopologyFiles</NMSTopologyFilePath > 
            </TopologyFTPInfo> 
       </UserFtpInfo> 
        <CustomFileFormat> 
            <TopologyFileExtensionPoint></TopologyFileExtensionPoint> 
        </CustomFileFormat> 
    </UserInfo>
    <PMThread>
         <PMThreadSleepTime>10</PMThreadSleepTime>
    </PMThread> 

    <FTPRetryDetails> 
        <RetryPollInterval>5</RetryPollInterval> 
        <FTPRetryTimes>3</FTPRetryTimes> 
    </FTPRetryDetails> 
    <FileRetention> 
        <FileRetentionDays>7</FileRetentionDays> 
        <FileRetentionPollInterval>12</FileRetentionPollInterval> 
    </FileRetention> 
    <CMDetails> 
        <TopologyDelimiter>;</TopologyDelimiter> 
        <TopologyTimerParameters> 
            <baseDN>/</baseDN> 
            <isPeriodic>true</isPeriodic> 
            <startTime>11:53:00</startTime> 
            <period>1</period> 
            <delta>60</delta> 
        </TopologyTimerParameters> 
       <TopologyRefreshTimerParameters> 
            <topoBaseDN>/</topoBaseDN> 
            <topoScope>4</topoScope> 
            <topoLevel>10</topoLevel> 
            <RefreshInterval>86400</RefreshInterval> 
        </TopologyRefreshTimerParameters> 
    </CMDetails>    
</NBIConfig>
Translation
Download
Updated: 2019-10-30

Document ID: EDOC1100044386

Views: 15320

Downloads: 83

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