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).
Basic Management

Basic Management

smproxy.xml

Function

smproxy.xml is used to configure the connection between the eSight and short message service (SMS) server. Based on the SMS server protocol configured on the eSight client, the parameters configured in the configuration file are matched to enable the function of sending an alarm by SMS.

Path

eSight installation directory/AppBase/etc/oms.core

Description
Table 9-13 Short message configuration parameters of the CMPP2_x protocol

Parameter

Description

Setting

Effective Method

CMPP20SubmitMessage > msg_Src

Indicates the source of the message content, namely, enterprise code of service provider (SP). On the network, the SP address, user identity, address translation, charging, and settlement are based on the enterprise code.

Data type: string

Value range: 9XY000–9XY999

NOTE:

XY is the code of each mobile company.

Default value: 919000

Restart

CMPP20SubmitMessage > service_Id

Indicates the service type of a short message.

Data type: string

Value range: unrestricted

Default value: oms

Restart

CMPP20SubmitMessage > fee_UserType

Indicates the fee user type.

Data type: integer

Value range:

  • 0: charge the destination terminal phone number
  • 1: charge the source terminal phone number
  • 2: charge the SP
  • 3: invalid field

Default value: 1

Restart

CMPP20SubmitMessage > fee_Terminal_Id

Indicates the phone number of the charged user.

NOTE:

The value is valid when Fee_UserType is 3. The value is invalid when Fee_UserType is 0, 1, or 2.

Data type: string

Value range: less than 21 characters

Default value: no default value

Restart

CMPP20SubmitMessage > fee_Type

Indicates the fee type.

Data type: string

Value range:

  • 01: Do not charge Fee User Number.
  • 02: Charge Fee User Number for each short message.
  • 03: Charge the Fee User Number by month.
  • 04: Set the upper limit to the consumption amount of the Fee User Number.
  • 05: The Fee User Number is charged by the SP.

Default value: 02

Restart

CMPP20SubmitMessage > fee_Code

Indicates the fee code.

Data type: string

Value range: unrestricted

Default value: 0010

Restart

CMPP20SubmitMessage > src_Terminal_Id

Indicates the source terminal phone number.

Data type: string

Value range: unrestricted

Default value: no default value

Restart

CMPP20SubmitMessage > msg_Level

Indicates the message type.

Data type: integer

Value range: 0 to 9

Default value: 1

Restart

CMPP20SubmitMessage > tp_Pid

Indicates the GSM protocol type.

Data type: integer

Value range: unrestricted

Default value: 0

Restart

CMPP20SubmitMessage > valid_Time

Indicates the validity time.

Data type: integer

Value range: unrestricted

Default value: 2880

Unit: minute

Restart

CMPP20SubmitMessage > at_Time

Indicates the timing sending time.

Data type: integer

Value range: unrestricted

Default value: no default value

Unit: minute

Restart

CMPPConnect > debug

Specifies whether to be in debugging status.

Data type: boolean

Value range: true/false

Default value: false

Restart

CMPPConnect > heartbeat-interval

Indicates the interval for sending heartbeat information.

Data type: integer

Value range: integer

Default value: 5

Unit: second

Restart

CMPPConnect > heartbeat-noresponseout

Indicates the number of consecutive hearbeats that are not responded when reconnection is necessary.

Data type: integer

Value range: integer

Default value: 3

Restart

CMPPConnect > read-timeout

Indicates the expiry time of physical link to read. 0 means no expiry.

Data type: integer

Value range: integer

Default value: 10

Unit: second

Restart

CMPPConnect > reconnect-interval

Indicates the interval for reconnection after a disconnection fault.

Data type: integer

Value range: integer

Default value: 30

Unit: second

Restart

CMPPConnect > transaction-timeout

Indicates the time-out interval for an operation.

Data type: integer

Value range: integer

Default value: 10

Unit: second

Restart

CMPPConnect > version

Indicates the version number negotiated by both parties.

Data type: integer

Value range: integer

Default value: 48

Restart

Table 9-14 Short message configuration parameters of the CMPP3_x protocol

Parameter

Description

Setting

Effective Method

CMPP30SubmitMessage > msg_Src

Indicates the source of the message content, namely, enterprise code of service provider (SP). On the network, the SP address, user identity, address translation, charging, and settlement are based on the enterprise code.

Data type: string

Value range: 9XY000–9XY999

NOTE:

XY is the code of each mobile company.

Default value: 919000

Restart

CMPP30SubmitMessage > service_Id

Indicates the service type of a short message.

Data type: string

Value range: unrestricted

Default value: oms

Restart

CMPP30SubmitMessage > fee_UserType

Indicates the fee user type.

Data type: integer

Value range:

  • 0: charge the destination terminal phone number
  • 1: charge the source terminal phone number
  • 2: charge the SP
  • 3: invalid field

Default value: 1

Restart

CMPP30SubmitMessage > fee_Terminal_Id

Indicates the phone number of the charged user.

NOTE:

The value is valid when Fee_UserType is 3. The value is invalid when Fee_UserType is 0, 1, or 2.

Data type: string

Value range: string with length less than 21

Default value: no default value

Restart

CMPP30SubmitMessage > fee_Terminal_Type

Indicates the type of the Fee User Number.

Data type: integer

Value range:

  • 0: Real code
  • 1: Pseudo code

Default value: 1

Restart

CMPP30SubmitMessage > fee_Type

Indicates the fee type.

Data type: integer

Value range:

  • 01: Do not charge Fee User Number.
  • 02: Charge Fee User Number for each short message.
  • 03: Charge the Fee User Number by month.

Default value: 02

Restart

CMPP30SubmitMessage > fee_Code

Indicates the fee code.

Data type: string

Value range: unrestricted

Default value: 0010

Restart

CMPP30SubmitMessage > src_Terminal_Id

Indicates the source terminal phone number.

Data type: string

Value range: unrestricted

Default value: no default value

Restart

CMPP30SubmitMessage > msg_Level

Indicates the message type.

Data type: integer

Value range: 0–9

Default value: 1

Restart

CMPP30SubmitMessage > tp_Pid

Indicates the GSM protocol type.

Data type: integer

Value range: unrestricted

Default value: 0

Restart

CMPP30SubmitMessage > valid_Time

Indicates the validity time.

Data type: integer

Value range: unrestricted

Default value: 2880

Unit: minute

Restart

CMPP30SubmitMessage > at_Time

Indicates the timing sending time.

Data type: integer

Value range: unrestricted

Default value: unrestricted

Unit: minute

Restart

CMPP30SubmitMessage > LinkID

Indicates the linkID for on-demand services.

Data type: string

Value range: unrestricted

Default value: 0123456789012

Restart

CMPPConnect > debug

Specifies whether to be in debugging status.

Data type: boolean

Value range: true/false

Default value: false

Restart

CMPPConnect > heartbeat-interval

Indicates the interval for sending heartbeat information.

Data type: integer

Value range: integer

Default value: 5

Unit: second

Restart

CMPPConnect > heartbeat-noresponseout

Indicates the number of consecutive hearbeats that are not responded when reconnection is necessary.

Data type: integer

Value range: integer

Default value: 3

Restart

CMPPConnect > read-timeout

Indicates the expiry time of physical link to read. 0 means no expiry.

Data type: integer

Value range: integer

Default value: 10

Unit: second

Restart

CMPPConnect > reconnect-interval

Indicates the interval for reconnection after a disconnection fault.

Data type: integer

Value range: integer

Default value: 30

Unit: second

Restart

CMPPConnect > transaction-timeout

Indicates the time-out interval for an operation.

Data type: integer

Value range: integer

Default value: 10

Unit: second

Restart

CMPPConnect > version

Indicates the version number negotiated by both parties.

Data type: integer

Value range: integer

Default value: 48

Restart

Table 9-15 Short message configuration parameters of the SMPP3_3 protocol

Parameter

Description

Setting

Effective Method

SMPP33SubmitMessage > priorityFlag

Indicates the Priority.

Data type: integer

Values:

  • 0: Default level
  • 1: Priority level

Default value: 0

Restart

SMPP33SubmitMessage > serviceType

Indicates the type of a service.

Data type: string

Values: unrestricted

Default value: no default value

Restart

SMPP33SubmitMessage > protocolId

Indicates the GSM protocol type.

Data type: integer

Values: integer

Default value: 0

Restart

SMPP33SubmitMessage > scheduleDeliveryTime

Indicates the timing sending time.

Data type: integer

Values: integer

Default value: 0

Unit: minute

Restart

SMPP33SubmitMessage > validityPeriod

Indicates the validity time of the short message waiting to be sent.

Data type: integer

Values: integer

Default value: 2880

Unit: minute

Restart

SMPP33SubmitMessage > replaceIfPresentFlag

Indicates the replacement identifier.

Data type: integer

Values: integer

Default value: 0

Restart

SMPP33SubmitMessage > smDefaultMsgId

Indicates the code of the default short message.

Data type: integer

Values: integer

Default value: 0

Restart

SMPPConnect > system-type

Indicates the SP type.

Data type: string

Value range: unrestricted

Default value: oms

Restart

SMPPConnect > addr-ton

Indicates the encoding type of a short message entity address.

Data type: integer

Value range: unrestricted

Default value: 2

Restart

SMPPConnect > heartbeat-interval

Indicates the interval for sending heartbeat information.

Data type: integer

Value range: integer

Default value: 30

Unit: second

Restart

SMPPConnect > reconnect-interval

Indicates the interval for reconnection after a disconnection fault.

Data type: integer

Value range: integer

Default value: 30

Unit: second

Restart

SMPPConnect > heartbeat-noresponseout

Indicates the number of consecutive hearbeats that are not responded when reconnection is necessary.

Data type: integer

Value range: integer

Default value: 3

Restart

SMPPConnect > transaction-timeout

Indicates the time-out interval for an operation.

Data type: integer

Value range: integer

Default value: 10

Unit: second

Restart

SMPPConnect > read-timeout

Indicates the expiry time of physical link to read. 0 means no expiry.

Data type: integer

Value range: integer

Default value: 10

Unit: second

Restart

SMPPConnect > interface-version

Indicates the version number negotiated by both parties.

Data type: integer

Value range: integer

Default value: 52

Restart

SMPPConnect > bind-type

Indicates the connection bonding method.

Data type: integer

Value range:

  • 0: Transmitter
  • 1: Receiver
  • 2: Transceiver

Default value: 0

Restart

SMPPConnect > sme-address

Indicates the destination address shown in submit_multi_short message is the destFlag value of the SME address.

Data type: integer

Value range: integer

Default value: 1

Restart

SMPPConnect > distribution-list-name

Indicates the destination address shown in submit_multi_short message is the destFlag value of the dispatch table name.

Data type: integer

Value range: integer

Default value: 2

Restart

SMPPConnect > addr-npi

Indicates the coding solution of the short message entity.

Data type: integer

Value range: integer

Default value: 1

Restart

SMPPConnect > address-range

Indicates the range of short message entity addresses.

Data type: string

Value range: unrestricted

Default value: no default value

Restart

SMPPConnect > debug

Specifies whether to be in debugging status.

Data type: boolean

Value range: true/false

Default value: false

Restart

Table 9-16 Short message configuration parameters of the SMPP3_4 protocol

Parameter

Description

Setting

Effective Method

SMPP34SubmitMessage > priorityFlag

Indicates the Priority.

Data type: integer

Values:

  • 0: Default level
  • 1: Priority level

Default value: 0

Restart

SMPP34SubmitMessage > serviceType

Indicates the type of a service.

Data type: string

Value range: unrestricted

Default value: no default value

Restart

SMPP34SubmitMessage > protocolId

Indicates the GSM protocol type.

Data type: integer

Value range: integer

Default value: 0

Restart

SMPP34SubmitMessage > scheduleDeliveryTime

Indicates the delay sending time. The scheduled sending time of SMS is determined by the NMS time and the configured value. When it is null, the SMS may send immediately.

Data type: integer

Value range: integer

Default value: 0

Unit: minute

Restart

SMPP34SubmitMessage > validityPeriod

Indicates the validity time of the short message waiting to be sent.

Data type: integer

Value range: integer

Default value: 2880

Unit: minute

Restart

SMPP34SubmitMessage > replaceIfPresentFlag

Indicates the replacement identifier.

Data type: integer

Value range: integer

Default value: 0

Restart

SMPP34SubmitMessage > smDefaultMsgId

Indicates the code of the default short message.

Data type: integer

Value range: integer

Default value: 0

Restart

SMPPConnect > system-type

Indicates the SP type.

Data type: string

Value range: unrestricted

Default value: oms

Restart

SMPPConnect > addr-ton

Indicates the encoding type of a short message entity address.

Data type: integer

Value range: unrestricted

Default value: 2

Restart

SMPPConnect > heartbeat-interval

Indicates the interval for sending heartbeat information.

Data type: integer

Value range: integer

Default value: 30

Unit: second

Restart

SMPPConnect > reconnect-interval

Indicates the interval for reconnection after a disconnection fault.

Data type: integer

Value range: integer

Default value: 30

Unit: second

Restart

SMPPConnect > heartbeat-noresponseout

Indicates the number of consecutive hearbeats that are not responded when reconnection is necessary.

Data type: integer

Value range: integer

Default value: 3

Restart

SMPPConnect > transaction-timeout

Indicates the time-out interval for an operation.

Data type: integer

Value range: integer

Default value: 10

Unit: second

Restart

SMPPConnect > read-timeout

Indicates the expiry time of physical link to read. 0 means no expiry.

Data type: integer

Value range: integer

Default value: 10

Unit: second

Restart

SMPPConnect > interface-version

Indicates the version number negotiated by both parties.

Data type: integer

Value range: integer

Default value: 52

Restart

SMPPConnect > bind-type

Indicates the connection bonding method.

Data type: integer

Value range:

  • 0: Transmitter
  • 1: Receiver
  • 2: Transceiver

Default value: 0

Restart

SMPPConnect > sme-address

Indicates the destination address shown in submit_multi_short message is the destFlag value of the SME address.

Data type: integer

Value range: integer

Default value: 1

Restart

SMPPConnect > distribution-list-name

Indicates the destination address shown in submit_multi_short message is the destFlag value of the dispatch table name.

Data type: integer

Value range: integer

Default value: 2

Restart

SMPPConnect > addr-npi

Indicates the coding solution of the short message entity.

Data type: integer

Value range: integer

Default value: 1

Restart

SMPPConnect > address-range

Indicates the range of short message entity addresses.

Data type: string

Value range: unrestricted

Default value: no default value

Restart

SMPPConnect > debug

Specifies whether to be in debugging status.

Data type: boolean

Value range: true/false

Default value: false

Restart

Table 9-17 Short message configuration parameters of the SGIP protocol

Parameter

Description

Setting

Effective Method

SGIPConnect > source-addr

Indicates the SP node code.

Data type: string

Value range: 3AAAAQQQQQ

NOTE:

AAAA is a four-digit toll area code. (If the toll area number has less than four digits, add 0 to the end.) QQQQQ is a five digit corporation code.

Default value: 3075598764

Restart

SGIPSubmitMessage > SPNumber

Indicates the SP access number.

Data type: string

Value range: 0 to 21 strings consisting of digits, symbols, and letters.

Default value: no default value

Restart

SGIPSubmitMessage > CorpId

Indicates the SP corporation identity (ID).

Data type: string

Value range: 0 to 99999

Default value: 98764

Restart

SGIPConnect > transaction-timeout

Indicates the time-out interval for an operation.

Data type: integer

Value range: integer

Default value: 10

Unit: second

Restart

SGIPConnect > read-timeout

Indicates the expiry time of physical link to read. 0 means no expiry.

Data type: integer

Value range: integer

Default value: 30

Unit: second

Restart

SGIPConnect > version

Indicates the version number negotiated by both parties.

Data type: integer

Value range: integer

Default value: 1

Restart

SGIPConnect > debug

Specifies whether to be in debugging status.

Data type: boolean

Value range: true/false

Default value: false

Restart

SGIPSubmitMessage > ChargeNumber

Indicates the payment number.

Data type: string

Value range: unrestricted

Default value: 8613012345678

Restart

SGIPSubmitMessage > ServiceType

Indicates the type of a service.

Data type: string

Value range: unrestricted

Default value: st

Restart

SGIPSubmitMessage > FeeType

Indicates the fee type.

Data type: integer

Value range: integer

Default value: 2

Restart

SGIPSubmitMessage > FeeValue

Indicates the value of the short message fee.

Data type: integer

Value range: integer

Default value: 0

Restart

SGIPSubmitMessage > AgentFlag

Indicates the agent charge identifier.

Data type: integer

Value range:

  • 0: Payable
  • 1: Receivable

Default value: 0

Restart

SGIPSubmitMessage > MorelatetoMTFlag

Indicates the cause of the MT short message.

Data type: integer

Value range:

  • 0: The first MT short message caused by the MO demand
  • 1: A second or later MT short message caused by the MO demand
  • 2: The MT short message caused by non-MO demand
  • 3: The MT short message caused by the system feedback

Default value: 2

Restart

SGIPSubmitMessage > GivenValue

Indicates the value of the present call fee.

Data type: integer

Value range: integer

Default value: 0

Restart

SGIPSubmitMessage > Priority

Indicates the priority is in ascending order.

Data type: integer

Value range: 0–9

Default value: 0

Restart

SGIPSubmitMessage > ExpireTime

Indicates the expiry time of a short message.

Data type: integer

Value range: unrestricted

Default value: 2880

Unit: minute

Restart

SGIPSubmitMessage > ScheduleTime

Indicates the timing sending time.

Data type: integer

Value range: unrestricted

Default value: 2880

Unit: minute

Restart

SGIPSubmitMessage > ReportFlag

Indicates the status report identifier.

Data type: integer

Value range:

  • 0: This short message requires a status report only when an error occurs.
  • 1: This short message requires a status report whether sending is successful or not.
  • 2: This short message does not require a status report.
  • 3: This short message only contains the monthly rental information and is not sent to subscribers. It requires a status report.

Default value: 2

Restart

SGIPSubmitMessage > TP_pid

Indicates the GSM protocol type.

Data type: integer

Value range: unrestricted

Default value: 0

Restart

SGIPSubmitMessage > MessageType

Indicates the message type.

Data type: integer

Value range:

  • 0: Short short message
  • other values: waiting fordefinition

Default value: 0

Restart

Configuration Example
<config> 
    <CMPPConnect> 
       <heartbeat-interval>5</heartbeat-interval> 
     <reconnect-interval>30</reconnect-interval> 
       <heartbeat-noresponseout>3</heartbeat-noresponseout> 
       <read-timeout>10</read-timeout> 
       <transaction-timeout>10</transaction-timeout> 
       <version>48</version> 
       <debug>false</debug> 
    </CMPPConnect> 

    <CMPP20SubmitMessage> 
       <service_Id>oms</service_Id> 
       <fee_UserType>1</fee_UserType> 
       <fee_Terminal_Id/> 
       <msg_Src>919000</msg_Src> 
       <fee_Type>02</fee_Type> 
       <fee_Code>0010</fee_Code> 
       <src_Terminal_Id></src_Terminal_Id> 
       <msg_Level>1</msg_Level> 
       <tp_Pid>0</tp_Pid> 
       <valid_Time>2880</valid_Time> 
       <at_Time/> 
    </CMPP20SubmitMessage> 

    <CMPP30SubmitMessage> 
       <service_Id>oms</service_Id> 
       <fee_UserType>1</fee_UserType> 
       <fee_Terminal_Id/> 
       <fee_Terminal_Type>1</fee_Terminal_Type> 
       <msg_Src>919000</msg_Src> 
       <fee_Type>02</fee_Type> 
       <fee_Code>0010</fee_Code> 
       <src_Terminal_Id></src_Terminal_Id> 
       <msg_Level>1</msg_Level> 
       <tp_Pid>0</tp_Pid> 
       <valid_Time>2880</valid_Time> 
       <at_Time/> 
       <LinkID>0123456789012</LinkID> 
    </CMPP30SubmitMessage> 

    <SMPPConnect> 
       <system-type>oms</system-type> 
       <addr-ton>2</addr-ton> 
       <heartbeat-interval>30</heartbeat-interval> 
       <reconnect-interval>30</reconnect-interval> 
       <heartbeat-noresponseout>3</heartbeat-noresponseout> 
       <transaction-timeout>10</transaction-timeout> 
       <read-timeout>10</read-timeout> 
       <interface-version>52</interface-version> 
       <bind-type>0</bind-type> 
       <sme-address>1</sme-address> 
       <distribution-list-name>2</distribution-list-name> 
       <addr-npi>1</addr-npi> 
       <address-range></address-range> 
       <debug>false</debug> 
    </SMPPConnect> 

    <SMPP33SubmitMessage> 
       <priorityFlag>0</priorityFlag> 
       <serviceType/> 
       <protocolId>0</protocolId> 
       <scheduleDeliveryTime/ 
       <validityPeriod>2880</validityPeriod> 
       <replaceIfPresentFlag>0</replaceIfPresentFlag> 
       <smDefaultMsgId>0</smDefaultMsgId> 
    </SMPP33SubmitMessage> 

    <SMPP34SubmitMessage> 
       <priorityFlag>0</priorityFlag> 
       <serviceType/> 
       <protocolId>0</protocolId> 
       <scheduleDeliveryTime>0</scheduleDeliveryTime> 
       <validityPeriod>2880</validityPeriod> 
       <replaceIfPresentFlag>0</replaceIfPresentFlag> 
       <smDefaultMsgId>0</smDefaultMsgId> 
    </SMPP34SubmitMessage> 

    <SGIPConnect> 
       <transaction-timeout>10</transaction-timeout> 
       <read-timeout>30</read-timeout> 
       <source-addr>3075598764</source-addr> 
       <version>1</version> 
       <debug>false</debug> 
    </SGIPConnect> 

    <SGIPSubmitMessage> 
       <SPNumber></SPNumber> 
       <ChargeNumber>8613012345678</ChargeNumber> 
       <CorpId>98764</CorpId> 
       <ServiceType>st</ServiceType> 
       <FeeType>2</FeeType> 
       <FeeValue>0</FeeValue> 
       <AgentFlag>0</AgentFlag> 
       <MorelatetoMTFlag>2</MorelatetoMTFlag> 
       <GivenValue>0</GivenValue> 
       <Priority>0</Priority> 
       <ExpireTime>2880</ExpireTime> 
       <ScheduleTime/> 
       <ReportFlag>0</ReportFlag> 
       <TP_pid>0</TP_pid> 
     <MessageType>0</MessageType> 
    </SGIPSubmitMessage> 
</config>

smgp.xml

Function

smgp.xml is used to configure the connection between the eSight and short message service (SMS) server. Based on the SMGP protocol configured on the eSight client, the parameters configured in the configuration file are matched to enable the function of sending an alarm by SMS.

Path

eSight installation directory/AppBase/etc/oms.core

Description
Table 9-18 Short message configuration parameters of the SMGP protocol

Parameter

Description

Setting

Effective Method

SMGPConnect > heartbeat-interval

Indicates the interval for sending heartbeat information.

Data type: integer

Value range: integer

Default value: 30

Unit: second

Restart

SMGPConnect > reconnect-interval

Indicates the interval for reconnection after a disconnection fault.

Data type: integer

Value range: integer

Default value: 30

Unit: second

Restart

SMGPConnect > heartbeat-noresponseout

Indicates the number of consecutive heartbeats that are not responded when reconnection is necessary.

Data type: integer

Value range: integer

Default value: 5

Restart

SMGPConnect > transaction-timeout

Indicates the expiry time of a process.

Data type: integer

Value range: integer

Default value: 10

Unit: second

Restart

SMGPConnect > version

Indicates the version number negotiated by both parties.

Data type: integer

Value range: integer

Default value: 20

Restart

SMGPConnect > debug

Specifies whether to be in debugging status.

Data type: boolean

Value range: true/false

Default value: false

Restart

SMGPSubmitMessage > msgType

Indicates the message type.

Data type: integer

Value range:

  • 1: unsubscribe
  • 2: subscribe request
  • 3: on-demand
  • 4: subscribe
  • 5: interaction operation
  • 6: query
  • Other: reserved

Default value: 1

Restart

SMGPSubmitMessage > needReport

Specifies whether a status report needs to be returned.

Data type: integer

Value range:

  • 0: no
  • 1: yes

Default value: 1

Restart

SMGPSubmitMessage > priority

Indicates the priority for sending messages.

Data type: integer

Value range: from 0 to 9

Default value: 1

Restart

SMGPSubmitMessage > serviceId

Indicates the service type.

Data type: String

Value range: 10-byte octet string

Default value: 1

Restart

SMGPSubmitMessage > feeType

Indicates the fee type.

Data type: String

Value range:

  • 00: Do not charge Fee User Number.
  • 01: Charge Fee User Number for each short message.
  • 02: Charge the Fee User Number by month.
  • 03: Set the upper limit to the consumption amount of the Fee User Number.
  • Other: Reserved

Default value: 01

Restart

SMGPSubmitMessage > feeCode

Indicates the fee code.

Data type: String

Value range: 6-byte octet string

Default value: 1

Unit: fen

Restart

SMGPSubmitMessage > fixedFee

Indicates the monthly fee or maximum fee.

Data type: String

Value range: 6-byte octet string

Default value: 1

Unit: fen

Restart

SMGPSubmitMessage > srcTermId

Indicates the user number for sending messages.

Data type: String

Value range: 21-byte octet string

Default value: 1

Restart

SMGPSubmitMessage > chargeTermId

Indicates the phone number of the charged user.

Data type: String

Value range: 21-byte octet string

Default value: 1

Restart

SMGPSubmitMessage > valid_Time

Indicates the validity time.

Data type: integer

Value range: unrestricted

Default value: 2880

Unit: minute

Restart

SMGPSubmitMessage > at_Time

Indicates the timing sending time.

Data type: integer

Value range: unrestricted

Default value: no default value

Unit: minute

Restart

Configuration Example
<config> 
    <SMGPConnect> 
        <heartbeat-interval>30</heartbeat-interval> 
        <reconnect-interval>30</reconnect-interval> 
        <heartbeat-noresponseout>5</heartbeat-noresponseout> 
        <transaction-timeout>10</transaction-timeout> 
        <version>20</version> 
        <debug>false</debug> 
    </SMGPConnect> 
    <SMGPSubmitMessage> 
        <msgType>1</msgType> 
        <needReport>1</needReport> 
        <priority>1</priority> 
        <serviceId>1</serviceId> 
        <feeType>1</feeType> 
        <feeCode>1</feeCode> 
        <fixedFee>1</fixedFee> 
        <srcTermId>1</srcTermId> 
        <chargeTermId>1</chargeTermId> 
        <valid_Time>2880</valid_Time> 
        <at_Time/> 
    </SMGPSubmitMessage> 
</config>

med_node_1_svc.xml

Function

The med_node_1_svc.xml file is used to configure Med Node parameters for the interconnection with the Med Center and configuration of the protocol adapter.

NOTE:

The FTP protocol has security risks. Using SFTP or FTPS is recommended.

Path

eSight installation directory/AppBase/sysagent/etc/sysconf/svcbase

Description
Table 9-19 Parameters in med_node_1_svc.xml

Parameter

Description

Setting

Effective Method

sac.services. MedNodeService. svcagent

Indicates the process name.

Data type: string

Value range: controlled by the sysmonitor

Default value: eSightAgent

Restart

oms.med.Queue.maxQueueFiles

Indicates the maximum number of Med Node that can be temporarily stored.

Data type: integer

Value range: 0-10

Default value: 10

Restart

oms.med.timedTask.MaxThread

Indicates the maximum number of cyclical tasks that Med can process concurrently.

Data type: integer

Value range: 0-10

Default value: 10

Restart

sac.services. MedNodeService. appdir

Indicates the name of the application directory.

Data type: string

Value range: actual name of the application directory

Default value: com.huawei.oms.app.mednode

Restart

sac.services. MedNodeService. startupmode

Indicates the startup mode.

Data type: string

Value range: controlled by the sysmonitor

Default value: auto

Restart

sac.services. MedNodeService. startorder

Indicates the startup sequence.

Data type: integer

Value range: controlled by the sysmonitor

Default value: 22

Restart

oms.med.svcagent.agentName

Indicates the process name.

Data type: string

Value range: controlled by the sysmonitor

Default value: eSightAgent

Restart

oms.med.node.nodeId

Indicates the Med Node ID.

Data type: string

Value range: unrestricted

NOTE:

The Med Node ID is unique.

Default value: medNode_1

Restart

oms.med.node.centerIP

Indicates the IP address of the Med Center.

Data type: dotted decimal notation

Value range: IP address

Default value: eSight server IP address

Restart

oms.med.node.nodeIP

Indicates the IP address of the Med Node.

NOTE:

Multiple IP addresses can be configured. Use commas (,) to separate multiple IP addresses.

Data type: dotted decimal notation

Value range: IP address

Default value: eSight server IP address

Restart

oms.med.node.MedUniqueIP

Indicates the unique Med Node IP address, which can be configured separately. This configuration item takes precedence over oms.med.node.nodeIP.

NOTE:

Multiple IP addresses can be configured. Use commas (,) to separate multiple IP addresses.

Data type: dotted decimal notation

Value range: IP address

Default value: none

Restart

oms.med.node.nodeIPV6

Indicates the IPv6 address of the Med Node.

NOTE:

Multiple IP addresses can be configured. Use commas (,) to separate multiple IP addresses.

Data type: string

Value range: IPv6 address

Default value: eSight server IP address

Restart

oms.med.node.MedUniqueIPV6

Indicates the unique Med Node IPv6 address, which can be configured separately. This configuration item takes precedence over oms.med.node.nodeIPV6.

NOTE:

Multiple IP addresses can be configured. Use commas (,) to separate multiple IP addresses.

Data type: string

Value range: IPv6 address

Default value: none

Restart

oms.med.node.centerPort

Indicates the destination port of a Med Node, that is, the listening port of the Med Center.

Data type: integer

Value range: 0–65535

Default value: 31917

Restart

oms.med.node.localPort

Indicates the source port of a Med Node.

Data type: integer

Value range: 0–65535

Default value: 31916

Restart

oms.med.node.enableSSL

Indicates whether to enable the SSL channel.

NOTE:

Data is transmitted in plaintext between the Med Node and Med Center, which poses security risks. You are advised to enable the SSL channel.

Data type: boolean

Value range:

  • false
  • true

Default value: true

Restart

oms.med.node.keyStoreFile

Indicates the SSL 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: /etc/certificate/clientKeyStore

Restart

oms.med.node.keyStorePassword

Indicates the password of the encrypted SSL KEY STORE file.

Data type: string

Value range: unrestricted

Default value: encrypted initial password

Restart

oms.med.node.trustStoreFile

Indicates the SSL trustStore 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: etc/certificate/serverTrustStore

Restart

oms.med.node.trustStorePassword

Indicates the password of the encrypted SSL trustStore file.

Data type: string

Value range: unrestricted

Default value: encrypted initial password

Restart

oms.med.node.escapeAble

Indicates whether to enable the emergency port.

NOTE:

The emergency port is not in SSL mode, which poses security risks. You are advised not to enable it.

Data type: boolean

Value range:

  • false
  • true

Default value: false

Restart

oms.med.node.escapePort

Indicates the emergency port number. This port is used by the Med Node to connect to the active or standby Med Center node.

Data type: integer

Value range: 0–65535

Default value: 31967

Restart

oms.med.node.backupCenterIP

Indicates the Med Center IP address of the standby node.

Data type: dotted decimal notation

Value range: IP address

Default value: none

Restart

oms.med.node.backupcenterPort

Indicates the destination port (listening port of the Med Center) for the standby Med Node.

Data type: integer

Value range: 0–65535

Default value: none

Restart

oms.med.node.SwitchTimeout

Indicates the timeout period of the active/standby switchover.

Data type: integer

Value range: 30-1200

Default value: none

Unit: second

Restart

oms.med.node.SwitchRetryTimes

Indicates the number of active/standby switchover attempts.

Data type: integer

Value range: 1-30

Default value: 10

Restart

oms.med.node.medUser

Indicates the user password for connecting a Med Node to the Med Center.

Data type: string

Value range: unrestricted

Default value: admin

Restart

oms.med.node.medUserPassword

Indicates the user password for connecting a Med Node to the Med Center.

Data type: string

Value range: unrestricted

Default value: encrypted initial password

Restart

oms.med.stdmml.decode

Indicates the standard MML code.

NOTE:

The MML protocol has security risks. Exercise caution when using this protocol.

Data type: string

Value range: unrestricted

Default value: GBK

Restart

oms.med.snmp.sendPort

Indicates the port that sends SNMP requests.

Data type: integer

Value range: 0–65535

Default value: 10162

Restart

oms.med.snmp.listenPort

Indicates the listening port for reporting traps.

Data type: integer

Value range: 0–65535

Default value: 162, 10162

Restart

oms.med.snmp.printSnmp4jLog

Indicates whether to display debug logs of the third-party Snmp4j component.

Data type: boolean

Value range:

  • false
  • true

Default value: false

Restart

oms.med.snmp.asyncRequestCount

Indicates the maximum number of requests that are consecutively sent to an NE. When the number of requests reaches this value, OMS cannot send another request to the NE until the NE responds to the previous requests or the requests time out.

Data type: integer

Value range: 1- 0x7fffffff

Default value: 5

Restart

oms.med.snmp.asyncQueueSize

Indicates the maximum size of the queue of the requests to be sent.

Data type: integer

Value range: 1- 0x7fffffff

Default value: 500

Restart

oms.med.snmp.perSecReqNum

Indicates the number of SNMP requests sent per second. If the value is less than or equal to 0, the number of requests sent per second is not limited.

Data type: integer

Value range: 0x80000000- 0x7fffffff

Default value: 10000

Restart

oms.med.snmp.processSnmpV1Info

Indicates whether SNMPv1 NEs can be connected. By default, SNMPv1 NEs can be connected.

Data type: boolean

Value range:

  • false
  • true

Default value: true

Restart

oms.med.snmp.processSnmpV2Info

Indicates whether SNMPv2 NEs can be connected. By default, SNMPv2 NEs can be connected.

Data type: boolean

Value range:

  • false
  • true

Default value: true

Restart

oms.med.snmp.isAttackDetection

Indicates whether to enable attack detection.

NOTE:
  • This feature has no impact on the eSight system performance.
  • During the locking period, normal packets are also discarded.
  • A large number of NEs report traps in the locking period and do not receive responses from eSight. The NEs will re-send traps, which will result in trap storms.

Data type: boolean

Value range:

  • false
  • true

Default value: false

Restart

oms.med.snmp.AttackThreshold

Indicates the critical number (threshold) of attacks.

NOTE:
  • This configuration item takes effect after attack detection is enabled.
  • A smaller threshold is likely to trigger locking, which has greater impact on eSight.

Data type: integer

Value range: 1-500

Default value: 100

Restart

oms.med.snmp.LockTime

Indicates the locking period when the attack threshold is reached after attack detection is enabled, in seconds.

NOTE:
  • This configuration item takes effect after attack detection is enabled.
  • A longer locking period has greater impact on eSight performance.

Data type: integer

Value range: 1-300

Default value: 15

Restart

oms.ftpServer.lock.lockTime

Indicates the time for locking a user that fails to log in to the FTP server for the specified consecutive times.

This parameter is used to lock users on a channel. For example, if a user fails to log in to the server over FTPS for the specified consecutive times, the user is locked for a duration specified by this parameter and cannot log in over FTPS. However, the user can still log in over FTP or SFTP.

Data type: integer

Value range: 1-65535

Default value: 5

Restart

oms.ftpServer.lock.failCount

Indicates the maximum number of consecutive FTP login failures. A user will be locked when the number is reached.

This parameter is used to lock users on a channel. For example, if a user fails to log in to the server over FTPS for the consecutive times specified by this parameter, the user is locked and cannot log in over FTPS. However, the user can still log in over FTP or SFTP.

After the number of specified login failures is reached: If the admin user logs in to the local server, the admin user is not locked.

If the admin user logs in to a remote server, the IP address of the remote server is locked. If a non-admin user logs in to the server, the non-admin user is locked.

Data type: integer

Value range: 1-65535

Default value: 5

Restart

oms.ftpServer.lock.lockIP

Indicates whether to lock the IP address for a common user.

Data type: boolean

Value range:

  • false
  • true

Default value: false

Restart

oms.ftpServer.lock.administrator

Indicates the account of the FTP administrator. By default, this configuration item is unavailable. The default FTP administrator is admin.

Data type: string

Value range: unrestricted

Default value: none

Restart

oms.ftpServer.spaceLimit.maxSpace

Indicates allowed maximum space of the file directory on the FTP/FTPS/SFTP server, in GB.

NOTE:
  • The configuration item covers only the files in eSight installation directory/AppBase/var/iemp/data/ftp.
  • FTP servers are scanned every 5 minutes.
  • If the configuration item value is 0, indicating that the size of the preceding directory is not monitored.
  • If the configuration item value is greater than 0 and if the actual occupied size of the preceding directory is greater than the preset configuration item value, stop all enabled FTP services (all FTP services cannot be enabled). If the actual occupied size is not greater than the preset value, enable the FTP services that have been disabled.

Data type: integer

Value range: 0x7fffffff

Default value: 50

Restart

oms.ftpServer.spaceLimit.rootPath

Indicates the relative path to user files on the FTP/FTPS/SFTP server. The path must exist.

NOTE:
  • By default, the configuration item is left blank, indicating that the path is eSight installation directory/AppBase/var/iemp/data/ftp.
  • The configuration item value is relative to eSight installation directory/AppBase. If the configuration item is set to var/iemp/data/ftp, the actual path is eSight installation directory/AppBase/var/iemp/data/ftp.
  • The absolute path of the relative path must be in the eSight directory.

Data type: string

Value range: valid file path

Default value: none

Restart

oms.ftpServer.ftp.enable

Indicates whether to start the FTP server.

NOTE:

The FTP protocol is insecure. SFTP and FTPS are recommended.

Data type: boolean

Value range:

  • false
  • true

Default value: false

Restart

oms.ftpServer.ftp.listenerPort

Indicates the listening port number on the FTP server.

Data type: integer

Value range: 1-65535

Default value: In Windows, the value is 21. In SUSE Linux, the value is 31921.

Restart

oms.ftpServer.ftp.maxLinkLimit

Indicates the maximum number of FTP connections.

NOTE:

To ensure that user can upload or download files normally, set this parameter to an even number which is greater than 0.

Data type: integer

Value range: 1-65535

Default value: 1024

Restart

oms.ftpServer.ftp.idleTime

Indicates the idle time of the FTP service, in seconds.

Data type: integer

Value range: an integer greater than or equal to 0

Default value: 300

Restart

oms.ftpServer.ftp.passivePorts

Indicates the listening port number on the passive data link of the FTP server.

Ports can be defined as single ports, closed or open ranges. Multiple definitions can be separated by commas.

An example is as follows:

  • 2300: Only port 2300 can take effect.
  • 2300-2399: Ports ranging from 2300 to 2399 can take effect.
  • 2300-: Ports greater than 2300 can take effect.
  • 2300,2305,2400-: Ports 2300 and 2305, and ports greater than 2400 can take effect.

Data type: integer

Value range: 1-65535

Default value: 32150–32159

Restart

oms.ftpServer.ftp.permitFileSize

Indicates the size of each file that can be uploaded to and downloaded from the FTP server, in bytes. If the parameter is set to 0, the file size is not limited.

Data type: long

Value range: 0–0x7fffffffffffffffL

Default value: 10737418240

Restart

oms.ftpServer.ftp.permitFileType

Indicates the file name extensions of the files that can be uploaded to and downloaded from the FTP server. The value must be a regular expression supported by Java. If this item is blank, the value type is not restricted, which poses security risks.

Data type: string

Value range: unrestricted

Default value: none

Restart

oms.ftpServer.sftp.enable

Indicates whether to start the SFTP server (FTP server with the SSH encryption mechanism).

Data type: boolean

Value range:

  • true
  • false

Default value: true

Restart

oms.ftpServer.sftp.listenerPort

Indicates the listening port number on the SFTP server.

Data type: integer

Value range: 1-65535

Default value: 31922

Restart

oms.ftpServer.sftp.maxLinkLimit

Indicates the maximum number of SFTP connections.

NOTE:

To ensure that user can upload or download files normally, set this parameter to an even number which is greater than 0.

Data type: integer

Value range: 1-65535

Default value: 1024

Restart

oms.ftpServer.sftp.idleTime

Indicates the idle time of the SFTP service, in seconds.

Data type: integer

Value range: an integer greater than or equal to 0

Default value: 300

Restart

oms.ftpServer.sftp.CAKeystoreFileName

Indicates the CA key store name of the SFTP server.

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. A key store can have only one certificate.

Data type: string

Value range: unrestricted

Default value: etc/certificate/application/med/sftp/ca/sftpCATrustStore.jks

Restart

oms.ftpServer.sftp.CAPass

Indicates the CA key store password of the SFTP server.

Data type: string

Value range: unrestricted

Default value: character string of the encrypted password Changeme_123

Restart

oms.ftpServer.sftp.keystoreFileName

Indicates the key store name of the SFTP server.

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. A key store can have only one certificate.

Data type: string

Value range: unrestricted

Default value: etc/certificate/application/med/sftp/keys/sftpKeyStore.jks

Restart

oms.ftpServer.sftp.sslPassword

Indicates the key store password of the SFTP server.

NOTE:

If the key store password is left blank, security risks will exist. Setting the password is recommended.

Data type: string

Value range: unrestricted

Default value: character string of the encrypted password Changeme_123

Restart

oms.ftpServer.sftp.permitFileSize

Indicates the size of each file that can be uploaded to and downloaded from the SFTP server, in bytes. If the parameter is set to 0, the file size is not limited.

Data type: long

Value range: 0–0x7fffffffffffffffL

Default value: 10737418240

Restart

oms.ftpServer.sftp.permitFileType

Indicates the file name extensions of the files that can be uploaded to and downloaded from the SFTP server. The value must be a regular expression supported by Java. If this item is blank, the value type is not restricted, which poses security risks.

Data type: string

Value range: unrestricted

Default value: none

Restart

oms.ftpServer.sftp.sftpMAC

Indicates the MAC algorithm allowed for the SFTP server. The values can be hmac-sha2-256,hmac-sha2-512,hmac-md5,hmac-sha1,hmac-md5-96,hmac-sha1-96, which are separated by commas (,).

NOTE:

You are advised to retain only hmac-sha2-256 to ensure security.

Data type: string

Value range: hmac-sha2-256,hmac-sha2-512,hmac-md5,hmac-sha1,hmac-md5-96,hmac-sha1-96

Default value: hmac-sha2-256

Restart

oms.ftpServer.sftp.sftpCipher

Indicates the encryption algorithm allowed for the SFTP server. The values can be aes128-ctr,aes256-ctr,arcfour128,arcfour256,aes128-cbc,3des-cbc,blowfish-cbc,aes192-cbc,aes256-cbc, which are separated by commas (,).

NOTE:

You are advised to retain only aes128-ctr and aes256-ctr to ensure security.

Data type: string

Value range: aes128-ctr,aes256-ctr,arcfour128,arcfour256,aes128-cbc,3des-cbc,blowfish-cbc,aes192-cbc,aes256-cbc

Default value: aes128-ctr,aes256-ctr,aes128-cbc,3des-cbc,aes192-cbc,aes256-cbc

Restart

oms.ftpServer.ftps.enable

Indicates whether to start the FTPS server (FTP server with the SSL encryption mechanism).

Data type: boolean

Value range:

  • true
  • false

Default value: true

Restart

oms.ftpServer.ftps.listenerPort

Indicates the listening port number on the FTPS server.

Data type: integer

Value range: 1-65535

Default value: 31923

Restart

oms.ftpServer.ftps.passivePorts

Indicates the listening port on the passive data link of the FTPS server.

Ports can be defined as single ports, closed or open ranges. Multiple definitions can be separated by commas.

An example is as follows:

  • 2300: Only port 2300 can take effect.
  • 2300-2399: Ports ranging from 2300 to 2399 can take effect.
  • 2300-: Ports greater than 2300 can take effect.
  • 2300,2305,2400-: Ports 2300 and 2305, and ports greater than 2400 can take effect.

Data type: integer

Value range: 1-65535

Default value: 31932,32145-32154

Restart

oms.ftpServer.ftps.keystoreFileName

Indicates the key store name of the FTPS server.

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. A key store can have only one certificate.

Data type: string

Value range: unrestricted

Default value: etc/certificate/application/med/ftps/keys/ftpsKeyStore.jks

Restart

oms.ftpServer.ftps.sslPassword

Indicates the key store password of the FTPS server.

NOTE:

If the key store password is left blank, security risks will exist. Setting the password is recommended.

Data type: string

Value range: unrestricted

Default value: character string of the encrypted password Changeme_123

Restart

oms.ftpServer.ftps.ssl.protocol

Indicates the SSL protocol version to be enabled for the FTPS. Multiple version names are separated by commas (,).

Data type: string

Value range: TLSv1.1, TLSv1.2.

Default value: TLSv1.1, TLSv1.2

Restart

oms.ftpServer.ftps.implicitSsl

Indicates whether to enable the FTPS implicit mode.

NOTE:

To be compatible with devices that do not support the implicit mode, eSight uses the explicit mode by default, which may lead to security risks. If managed devices (eLTE, IAD, IP PBX, and IP phone) support the implicit mode, use the implicit mode.

Data type: boolean

Value range:

  • true: implicit mode
  • false: explicit mode

Default value: false

Restart

oms.ftpServer.ftps.checkSslExpiryDate

Indicates whether to verify the validity period of SSL certificates.

NOTE:
  • The FTPS service verifies the validity period of the SSL certificate only when the parameter is set to true.
  • If the SSL certificate is invalid, the FTPS service is unavailable.
  • Security risks exist if the SSL certificate validity period is not verified. It is recommended that the validity period verification function be enabled.

Data type: boolean

Value range:

  • true
  • false

Default value: true

Restart

oms.ftpServer.ftps.supportRenegotiate

Indicates whether the SSL used by the FTPS service supports renegotiation.

NOTE:
  • The SSL used by the FTPS service does not support renegotiation only when the parameter is set to false.
  • If the SSL does not support renegotiation, the renegotiation handshake fails between the client and server. The client cannot connect to the FTPS server.
  • Security risks exist if the SSL supports renegotiation. It is recommended that the SSL renegotiation function be disabled.

Data type: boolean

Value range:

  • true
  • false

Default value: false

Restart

oms.ftpServer.ftps.includeCipherSuites

Indicates names of all cipher suites to be enabled for FTPS. Separate names by commas (,).

Data type: string

Value range: unrestricted

Default value: TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA,TLS_RSA_WITH_AES_128_CBC_SHA

Restart

oms.ftpServer.ftps.CAKeystoreFileName

Indicates the CA key store name of the FTPS server.

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. A key store can have only one certificate.

Data type: string

Value range: unrestricted

Default value: etc/certificate/application/med/ftps/ca/ftpsCATrustStore.jks

Restart

oms.ftpServer.ftps.CAPass

Indicates the CA key store password of the FTPS server.

Data type: string

Value range: unrestricted

Default value: character string of the encrypted password Changeme_123

Restart

oms.ftpServer.ftps.maxLinkLimit

Indicates the maximum number of FTPS connections.

NOTE:

To ensure that user can upload or download files normally, set this parameter to an even number which is greater than 0.

Data type: integer

Value range: 1-65535

Default value: 1024

Restart

oms.ftpServer.ftps.idleTime

Indicates the FTPS service idle time, in seconds.

Data type: integer

Value range: an integer greater than or equal to 0

Default value: 300

Restart

oms.ftpServer.ftps.permitFileSize

Indicates the size of each file that can be uploaded to and downloaded from the FTPS server, in bytes. If the parameter is set to 0, the file size is not limited.

Data type: long

Value range: 0–0x7fffffffffffffffL

Default value: 10737418240

Restart

oms.ftpServer.ftps.permitFileType

Indicates the type suffix of the file that can be uploaded to or downloaded from the FTPS server. The value must be a regular expression supported by Java. If this item is blank, the value type is not restricted, which poses security risks.

Data type: string

Value range: unrestricted

Default value: none

Restart

Precautions
  • Do not modify the configuration file unless necessary.
  • Configure your own keys to enhance network security.
Configuration Example
<?xml version="1.0" encoding="UTF-8" standalone="no"?> 
<med name="med"> 
<sac name="sac"> 
<services name="services"> 
<service name="MedNodeService"> 
<param name="svcagent">eSightAgent</param> 
<param name="appdir">com.huawei.oms.app.mednode</param> 
<param name="startupmode">auto</param> 
<param name="startorder">22</param> 
</service> 
</services> 
</sac> 
<config name="oms"> 
<!-- Med node protocol adapter configuration --> 
<config name="med"> 
<config name="svcagent"> 
<param name="agentName">eSightAgent</param> 
</config> 
<config name="Queue"> 
<param name="maxQueueFiles">10</param> 
</config> 
<config name="timedTask"> 
<param name="MaxThread">15</param> 
</config> 
<config name="node"> 
<param name="nodeId">medNode_1</param> 
<param name="centerIP">10.137.62.80</param> 
<param name="nodeIP">10.137.62.80</param> 
<param name="MedUniqueIP"/> 
<param name="nodeIPV6">10.137.62.80</param> 
<param name="MedUniqueIPV6"/> 
<param name="centerPort">31917</param> 
<param name="localPort">31916</param> 

<!--if open SSL connection between node and center --> 
<param name="enableSSL">true</param> 
<!--the SSL keyStore file name --> 
<param name="keyStoreFile">/etc/certificate/clientKeyStore</param> 
<!--the SSL keystore password which is encrypted --> 
<param name="keyStorePassword">1085620d5680b812932f1c6ed38a4cdd6de1f7f444bad9b1dd6985b60305f25e</param> 
<!--the SSL trustStroe file name --> 
<param name="trustStoreFile">/etc/certificate/serverTrustStore</param> 
<!--the SSL trustStore password which is encrypted --> 
<param name="trustStorePassword">1085620d5680b812932f1c6ed38a4cdd6de1f7f444bad9b1dd6985b60305f25e</param> 
<!--Names of all the cipher suites to enable,more than one component  
separated by commas --> 
<param name="includeCipherSuites">TLS_RSA_WITH_AES_128_CBC_SHA</param> 
<!--if node will use escape port connect center --> 
<param name="escapeAble">false</param> 
<!--the escape port of center --> 
<param name="escapePort">31967</param> 
<param name="backupCenterIP"/> 
<param name="backupcenterPort"/> 
<param name="SwitchTimeOut"/> 
<param name="SwitchRetryTimes"/> 
<param name="medUser">admin</param> 
<param name="medUserPassword">9d7961bc8af54d05ce509e03b13ffce3abc7587373e7719b62555fd5aff9908d</param> 
</config> 
<config name="stdmml"> 
<param name="decode">GBK</param> 
</config> 
<config name="snmp"> 
<param name="sendPort">10162</param> 
<param name="listenPort">162,10162</param> 
<param name="printSnmp4jLog">false</param> 
<param name="asyncRequestCount">5</param> 
<param name="asyncQueueSize">3700</param> 
<param name="perSecReqNum">1000</param> 
<param name="processSnmpV1Info">true</param> 
<param name="processSnmpV2Info">true</param> 
<param name="isAttackDetection">false</param> 
<param name="AttackThreshold">100</param> 
<param name="LockTime">15</param> 
</config> 
</config> 
<config name="ftpServer"> 
<config name="lock"> 
<param name="lockTime">5</param> 
<param name="failCount">5</param> 
</config> 
<config name="spaceLimit"> 
<param name="maxSpace">50</param> 
</config> 
<config name="ftp"> 
<param name="enable">true</param> 
<param name="listenerPort">31921</param> 
<param name="passivePorts">32150-32159</param> 
<param name="permitFileSize">10737418240</param> 
<param name="permitFileType"/> 
<param name="maxLinkLimit">100</param> 
<param name="idleTime">86400</param> 
</config> 
<config name="sftp"> 
<param name="enable">true</param> 
<param name="listenerPort">31922</param> 
<param name="keystoreFileName">esight.keystore.sftp</param> 
<param name="sslPassword">1085620d5680b812932f1c6ed38a4cdd6de1f7f444bad9b1dd6985b60305f25e</param> 
<param name="permitFileSize">10737418240</param> 
<param name="permitFileType"/> 
<param name="sftpMAC">hmac-sha1,hmac-sha2-256,hmac-md5,hmac-md5-96,hmac-sha1-96</param> 
<param name="sftpCipher">aes128-ctr,aes256-ctr,arcfour128,arfour256,aes128-cbc,3des-cbc,blowfish-cbc,aes192-cbc,aes256-cbc</param> 
<param name="maxLinkLimit">100</param> 
<param name="idleTime">86400</param> 
</config> 
<config name="ftps"> 
<param name="enable">true</param> 
<param name="listenerPort">31923</param> 
<param name="passivePorts">31932,32145-32154</param> 
<param name="implicitSsl">false</param> 
<param name="includeCipherSuites">TLS_DHE_RSA_WITH_AES_128_CBC_SHA256,TLS_DHE_DSS_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_128_CBC_SHA256,TLS_DHE_RSA_WITH_AES_128_CBC_SHA,TLS_DHE_DSS_WITH_AES_128_CBC_SHA,TLS_RSA_WITH_AES_128_CBC_SHA</param> 
<param name="keystoreFileName">esight.keystore.ftps</param> 
<param name="sslPassword">1b8b5016cb88b02b787fd1e37ed307d6b0a4e4765c8e46a3f515c26d334a29bf</param> 
<param name="ssl.protocol">TLSv1.1,TLSv1.2</param> 
<param name="permitFileSize">10737418240</param> 
<param name="permitFileType"/> 
<param name="maxLinkLimit">100</param> 
<param name="idleTime">86400</param> 
</config> 
</config> 
</config> 
</med>     

radiusAuth.cfg

Function

Authentication module uses the configuration parameters in radiusAuth.cfg to communicate with RADIUS server for user authentication function.

Path

eSight installation directory/AppBase/etc/oms.sm

Description
Table 9-20 radiusAuth.cfg configuration description

Parameter

Description

Setting

Effective Method

RadiusServer IP

Internet Protocol (IP) address of the RADIUS server.

Data type: string

Value range: IPv4

Default value: no default value

Restart eSight

NASIP

IP address of the RADIUS client.

Data type: string

Values: IPv4

Default value: no default value

Restart eSight

AuthType

Authentication type.

Data type: string

Values:

  • 0: PAP
  • 1: CHAP

Default value: 1

NOTE:

Because RADIUS authentication is vulnerable to man-in-the-middle attacks (authentication bypass), RADIUS authentication is not recommended and LDAP authentication is recommended.

Restart eSight

SharedSecret

Shared key.

NOTE:

Share secret key in encrypted form. The configuration is as follows:

  • On Windows, the tool eSight installation directory/AppBase/tools/bmetool/encrypt/encrypt.bat algorithm must be used to encrypt the shared secret.
  • On Linux, the tool eSight installation directory/AppBase/tools/bmetool/encrypt/encrypt.sh (for Linux) must be used to encrypt the shared secret.

Data type: string

Values: Unrestricted

Default value: no default value

Restart eSight

RadiusServerAuthPort

Port number of the RADIUS server.

Data type: string

Values: Unrestricted

Default value: 1812

Restart eSight

NASPort

Port number of the RADIUS client.

Data type: string

Values: Unrestricted

Default value: 31840

Restart eSight

NASIdentifier

Local identifier, it is used for authentication.

Data type: string

Values: Unrestricted

Default value: no default value

Restart eSight

Response Timeout

Response timeout time for RADIUS server.

Data type: string

Values: Unrestricted

Default value: 5

Unit: second

Restart eSight

RetransmitTimes

Number of attempts to authenticate with RADIUS server if there is any communication issues.

Data type: string

Values: Unrestricted

Default value: 3

Restart eSight

ValueSeparator

The value used for splitting the group names (more than one group names) configured in the RADIUS server.

NOTE:

Avoid using the character \ for ValueSeparator. Avoid using the char \ as delimiter for group names, this requires the knowledge of escape sequences support by different programming languages.

Data type: string

Values: Unrestricted

Default value: ;

Restart eSight

group.key

Sequence number of the group field in a response packet.

Data type: int

Values: Unrestricted

Default value: 18

Restart eSight

request

User-defined request packet.

NOTE:

According to the JSON character strings defined in RFC 2865 [page 23], SubAttrbutes must contain four parameters: VendorType, VendorValueDataFormat, VendorValueLength, and VendorValue. Vendor-Specific, request={"Vendor-Specific": {"type" : 26,"valueDataFormat": "String","value" : {"VendorId": 2011,"SubAttrbutes": [{"VendorType": 1,"VendorValueDataFormat": "String","VendorValueLength":6,"VendorValue": "huawei"}]}}}

Data type: string

Values: Unrestricted

Default value: no default value

Restart eSight

RadiusBakServerIP

IP address of the RADIUS backup server.

Data type: string

Values: IPv4

Default value: no default value

Restart eSight

RadiusBAKServerPort

Port number of the RADIUS backup server.

Data type: string

Values: Unrestricted

Default value: no default value

Restart eSight

ClientIPAndPort.use

Specifies whether to select the client IP address and port.

Data type: string

Values:

  • 0: yes
  • 1: no

Default value: 1

Restart eSight

Custom.attributes.use

Specifies whether to issue user-defined attributes.

Data type: string

Values:

  • 0: yes
  • 1: no

Default value: 1

Restart eSight

Custom.attributes

Indicates the user-defined attribute, which corresponds to the 26th Vendor-Specific field in the standard protocol.

Data type: JSON character string

Values: Unrestricted

Default value: no default value

Restart eSight

RadiusGetRoleType

Indicates the method for obtaining roles.

Data type: string

Values:

  • 0: Obtain roles from the local eSight
  • 1: Obtain default attributes from the server.
  • 2: Obtain user-defined attributes from the server.

Default value: 1

Restart eSight

Precautions
  • Do not change the configuration file randomly.
  • If you modify the configuration items using the GUI tool, the modifications take effect immediately. If you manually modify the configuration items, you must restart the eSight for the modifications to take effect.
  • To enhance network security, configure your own key.
Configuration Example
RadiusServerIP =  
ValueSeparator=; 
ResponseTimeout=5 
ClientIPAndPort.use=1 
AuthType=1 
group.key=18 
NASIP=127.0.0.1 
RadiusServerAuthPort=1812 
RadiusGetRoleType=0 
RadiusBakServerIP= 
NASIdentifier=2012 
Custom.attributes={"Vendor-Specific":{"type":26,"valueDataFormat":"String","value": {"VendorId":2012,"SubAttrbutes":[{"VendorType":"4","VendorValueLength":"4","VendorValueDataFormat":"String","VendorValue":"fdf"}]}}} 
NASPort=31840 
Custom.attributes.use=0 
RetransmitTimes=3 
SharedSecret=2oZdA3mJGZiS1IZPolU0Rw==

ldapAuth.cfg

Function

Authentication module uses the configuration parameters in ldapAuth.cfg to communicate with Lightweight Directory Access Protocol (LDAP) server for user authentication function.

Path

eSight installation directory/AppBase/etc/oms.sm

Description
Table 9-21 ldapAuth.cfg configuration description

Parameter

Description

Setting

Effective Method

LDAPServerIP

Internet Protocol (IP) address of the LDAP server.

NOTE:

When a certificate is used during the authentication, the IP address of the server must be consistent with that in the common name of the certificate.

Data type: string

Value range: Unrestricted

Default value: no default value

Restart

LDAPPort

Port number of the LDAP server.

Data type: string

Value range: Unrestricted

Default value: 389

Restart

LoginUserDN

LDAP login user DN. This attribute is used to bind the authentication to LDAP server for the particular user.

NOTE:
  • When MultiPathLogin is false, use the normal format, for example, CN=%s, DC=huawei, DC=com. When MultiPathLogin is true, use the email format, for example, %s@huawei.com.
  • The user name in the bound login user DN must be replaced by %s.

Data type: string

Value range: Unrestricted

Default value: CN=%s,DC=huawei,DC=com

Restart

LDAPBindType

Binding types.

NOTE:

For secured transactions with LDAP server, its recommended to use SSL mode.

Data type: string

Values:

  • 0: normal mode (User+Pwd)
  • 1: Secure Sockets Layer (SSL) mode

Default value: 1

Restart

CACertFile

CA certificate file used to communicate with LDAP server.

NOTE:

This parameter is required to configure if LDAPBindType is 1(SSL authentication mode). The file path must be relative to the path eSight installation directory/AppBase/etc/certificate.

Data type: string

Value range: Unrestricted

Default value: no default value

Restart

CertFile

Certificate key file, used for communication with the LDAP server. A certificate key file is in the pfx(p12) format.

NOTE:

This parameter is required to configure if LDAPBindType is 1(SSL authentication mode). The file path must be relative to the path eSight installation directory/AppBase/etc/certificate.

Data type: string

Value range: Unrestricted

Default value: no default value

Restart

StoreSecret

Encrypted password of the CA certificate file.

NOTE:

This parameter is required to configure if LDAPBindType is 1(SSL authentication mode). The configuration is as follows:

  • On Windows, the tool eSight installation directory/AppBase/tools/bmetool/encrypt/encrypt.bat must be used to encrypt the store password.
  • On Linux, the tool eSight installation directory/AppBase/tools/bmetool/encrypt/encrypt.sh (for Linux) must be used to encrypt the store password.

Data type: string

Value range: Unrestricted

Default value: no default value

Restart

KeySecret

Encrypted password of the certificate key file.

NOTE:

This parameter is required to configure if LDAPBindType is 1(SSL authentication mode). The configuration is as follows:

  • On Windows, the tool eSight installation directory/AppBase/tools/bmetool/encrypt/encrypt.bat must be used to encrypt the store password.
  • On Linux, the tool eSight installation directory/AppBase/tools/bmetool/encrypt/encrypt.sh (for Linux) must be used to encrypt the store password.

Data type: string

Value range: Unrestricted

Default value: no default value

Restart

ReConnectTimes

The number of reconnect attempts permitted if there is any communication error while connecting to the LDAP server.

Data type: int

Value range: Unrestricted

Default value: 3

Restart

ReConnectInterval

Time interval between retry attempts to connect to LDAP server. The value is in seconds.

Data type: int

Value range: Unrestricted

Default value: 5

Restart

AuthTimeout

The timeout value for authentication operation with LDAP server. The value is in seconds.

Data type: string

Value range: Unrestricted

Default value: 20

Restart

LDAPNetTimeout

The timeout value to connect to LDAP server. The value is in seconds.

Data type: string

Value range: Unrestricted

Default value: 10

Restart

LDAPBaseDN

Used to configure user's "Base DN".

Data type: string

Value range: Unrestricted

Default value: DC=huawei,DC=com

Restart

SSLVersion

SSL Version supported by server.

NOTE:
  • This parameter is used if LDAPBindType=1.
  • SSLv3 and TLSv1 have security risks. TLSv1.1 or TLSv1.2 is recommended. The platform uses SSL version of the highest level as default.

    Starting from January 12, 2018, the eSight does not support TLSv1.

Data type: string

Value range:

  • TLSv1
  • TLSv1.1
  • TLSv1.2
  • SSLv3

Default value: SSLv3

Restart

LDAPBindDN

Used to configure root dn.

NOTE:
  • If the DN of a specified user is bound, the user must be available on the LDAP server.
  • This parameter must be configured when LDAPAuthTypeis set to 0.

Data type: String

Value range: unrestricted

Default value: no default value

Restart

LDAPBindSecret

The password of the root dn in encrypted form.

NOTE:

This parameter must be configured when LDAPAuthTypeis set to 0.

Data type: String

Value range: unrestricted

Default value: no default value

Restart

ValueSeparator

The value used for splitting the group names (more than one group names) configured in the LDAP server.

NOTE:

Avoid using the character \ for ValueSeparator. Avoid using the char \ as delimiter for group names, this requires the knowledge of escape sequences support by different programming languages.

Data type: string

Value range: Unrestricted

Default value: ;

Restart

SearchUserAttr.userGroup

The key for user group name in LDAP server.

NOTE:

The values vary depending on LDAP servers. The product side needs to customize the configuration item value based on the type of the interconnected LDAP server.

Data type: string

Value range: Unrestricted

Default value: groupName

Restart

userClassName

The key for user information on the LDAP server.

NOTE:
  • This value is used when fixed user is used to bind to LDAP server.
  • The values vary depending on LDAP servers. For example, the value for OracleLDAPmust be configured to SMPersonand the value for OpenLDAPmust be configured to EmsPerson. The product side needs to customize the configuration item value based on the type of the interconnected LDAP serve

Data type: string

Value range: Unrestricted

Default value: EmsPerson

Restart

MultiPathLogin

Whether to support user login from multiple paths.

NOTE:

This parameter can be set to true only when the LDAP server is Windows AD.

Data type: string

Value range: true/false

Default value: false

Restart

GroupBaseDN

BaseDN of the LDAP server group.

NOTE:

This parameter is effective only when MultiPathLogin is true.

Data type: string

Value range: unrestricted

Default value: DC=huawei,DC=com

Restart

Group.list

Group path used to search for users on the LDAP server.

NOTE:

This parameter is effective only when MultiPathLogin is true. Multiple paths are separated by semicolons (;).

Data type: string

Value range: unrestricted

Default value: eSight_Admins;eSight_Users

Restart

Group.attribute

User attribute name in the LDAP server group.

NOTE:

This parameter is effective only when MultiPathLogin is true.

Data type: string

Value range: unrestricted

Default value: member

Restart

LDAPGetRoleType

Indicates the method for obtaining roles.

Data type: string

Value range:

  • 0: Obtain roles from the server.
  • 1: Obtain the role from the local eSight.

Default value: 0

Restart

LDAPLoginUserDirectory

Indicates the user directory location or the email address suffix.

NOTE:

User directory locations are in the format of key=value and locations are separated with commas (,). The email address suffix is @XX.XX.

Data type: String

Value range: unrestricted

Default value: DC=huawei,DC=com

Restart

SSLVersionList

Indicates the SSL versions separated by commas (,). Users can set the version list.

NOTE:

TLSv1 has ecurity risks. TLSv1.1 and TLSv1.2 are recommended. Starting from January 12, 2018, the eSight does not support TLSv1.

Data type: String

Value range: TLSv1,TLSv1.1,TLSv1.2

Default value: TLSv1.1,TLSv1.2

Restart

LDAPAuthType

Indicates the authentication mode.

Data type: string

Value range:

  • 0: Authenticate administrators after they log in to the LADP server and after DNs are queried.
  • 1: Directly authentication eSight users.

Default value: 1

Restart

LDAPServerVersion

Indicates the server version.

Data type: string

Value range:

  • 0: LDAPv2.
  • 1: LDAPv3.

Default value: 1

Restart

LDAPServerType

Indicates the server type.

Data type: string

Value range:

  • 0: openldap.
  • 1: active directory.

Default value: 0

Restart

CheckCertCN

Specifies whether to verify the Common Name field in the LDAP server certificate.

NOTE:
  • If the Commom Name field in s certificate is not verified, the certificate has security risks. Setting the configuration item to 1is recommended.
  • When the item is set to 1, the CN field of certificate in LDAP server used must be the IP of LDAP server, otherwise the verification may not pass.

Data type: string

Value range:

  • 0: Do not verify the Common Name field in the LDAP server certificate.
  • 1: Verify the Common Name field in the LDAP server certificate.

Default value: 0

Restart

CheckCertValidity

Specifies whether to verify the validity of the certificate sent from the LDAP server.

Data type: string

Value range:

  • 0: Do not verify the validity of the certificate sent from the LDAP server.
  • 1: Verify the validity of the certificate sent from the LDAP server.

Default value: 1

Restart

policySearchDN

Indicates the DN used for querying the LDAP server account policy. The DN, lockDuration, maxFailure, and isLockout parameters are used to obtain the accounting locking policy of the LDAP server.

NOTE:

For the Oracle LDAP server, set the item as follows: cn=Password Policy, cn=config.

Data type: string

Value range: DN used for querying the LDAP server account policy

Default value: no default value

Restart

isLockout

Specifies whether to enable the function of locking an account after a specified amount of consecutive unsuccessful password attempts in the LDAP server account policy.

NOTE:

For the Oracle LDAP server, set pwdLockout, which corresponds to the configuration item pwd-lockout-enabled of the LDAP server.

Data type: string

Value range: Parameter for querying the maximum number of password attempts in the LDAP server account policy

Default value: no default value

Restart

maxFailure

Indicates the maximum number of password attempts in the LDAP server account policy.

NOTE:

For the Oracle LDAP server, set pwdMaxFailure, which corresponds to the configuration item pwd-max-failure-count of the LDAP server.

Data type: string

Value range: Parameter for querying the maximum number of password attempts in the LDAP server account policy

Default value: no default value

Restart

lockDuration

Indicates the password locking period in the LDAP server account policy.

NOTE:

For the Oracle LDAP server, set pwdLockoutDuration, which corresponds to the configuration item pwd-lockout-duration of the Oracle LDAP server. The parameter value 0 is not recommended. The value 0indicates that the account is locked permanently. Only the Oracle LDAP administrator can reset the password and log in.

Data type: string

Value range: Parameter for querying the password locking period in the LDAP server account policy

Default value: no default value

Restart

Precautions
  • Do not change the configuration file randomly.
  • If you modify the configuration items using the GUI tool, the modifications take effect immediately. If you manually modify the configuration items, you must restart the eSight for the modifications to take effect.
  • To enhance network security, configure your own certificate and key.
Configuration Example
SSLVersion=SSLv3 
DAPNetTimeout=10 
CertFile=dsd 
SearchUserAttr.userGroup=groupName 
LDAPServerType=0 
SSLVersionList=TLSv1.1,TLSv1.2,SSLv3 
LDAPBindSecret=7NN7ZdTsexdqoFvKQpicGg== 
KeySecret=jj6akI86x0Nsg3zlgDfXkw== 
LDAPGetRoleType=0 
LDAPLoginUserDirectory=dc=huawei,dc=com 
LDAPBaseDN=dc=huawei,dc=com 
ReConnectInterval=5 
LDAPAuthType=0 
CheckCertCN=0 
AuthTimeout=20 
ReConnectTimes=3 
LDAPBindType=1 
StoreSecret=ysGYMGa+3F4kWBE7wY9UZw== 
MultiPathLogin=false 
LDAPServerIP=10.137.63.96 
LDAPServerVersion=0 
SearchUserAttr.userid=uid 
userClassName=EmsPerson 
CACertFile=ds 
LDAPPort=389 
ValueSeparator=; 
LDAPBindDN=cn=manager,dc=huawei,dc=com 
CheckCertValidity = 1

databackup.xml

Function

databackup.xml is used to set the default path for storing database dump files and the maximum value of the MySQL database tablespace.

Path

eSight installation directory/AppBase/etc/oms.core

Description
NOTE:

The configuration items OMSPM, OMSFM, and OMSSM apply only to the MySQL database. Because the MySQL database does not support tablespace size settings during the eSight installation, you need to use the configuration items to set the size of the performance data, fault, and security tablespaces.

Table 9-22 databackup.xml configuration item description

Parameter

Description

Setting

Effective Method

defaultBackupDataBaseDir

Indicates the default path for storing dump files.

Data type: string

Value range: string

Default value: No default value

Restart

isSavetoFile

Specifies whether to export to dump files.

Data type: boolean

Value range:

  • false
  • true

Default value: true

Restart

OMSPM

Indicates the maximum size of the performance tablespaces of the MySQL database.

Data type: Numeral type

Value range: Numeral type

Default value: 2048

Unit: MB

Restart

OMSFM

Indicates the maximum size of the fault tablespaces of the MySQL database.

Data type: Numeral type

Value range: Numeral type

Default value: 300

Unit: MB

Restart

OMSSM

Indicates the maximum size of the security tablespaces of the MySQL database.

Data type: Numeral type

Value range: Numeral type

Default value: 200

Unit: MB

Restart

TAM

Indicates the maximum size of the terminal resource tablespaces of the MySQL database.

Data type: Numeral type

Value range: Numeral type

Default value: 8192

Unit: MB

Restart

SLA

Indicates the maximum size of the SLA tablespaces of the MySQL database.

Data type: Numeral type

Value range: Numeral type

Default value: 20480

Unit: MB

Restart

DC

Indicates the maximum size of the DC nCenter tablespaces of the MySQL database.

Data type: Numeral type

Value range: Numeral type

Default value: 4096

Unit: MB

Restart

NASMGR

Indicates the maximum size of the network traffic tablespaces of the MySQL database.

Data type: Numeral type

Value range: Numeral type

Default value: 20480

Unit: MB

Restart

CONFFILE

Indicates the maximum size of the configuration file tablespaces of the MySQL database.

Data type: Numeral type

Value range: Numeral type

Default value: 2048

Unit: MB

Restart

GCLI

Indicates the maximum size of the smart configuration tool tablespaces of the MySQL database.

Data type: Numeral type

Value range: Numeral type

Default value: 1024

Unit: MB

Restart

Configuration Example
<?xml version="1.0" encoding="UTF-8" standalone="no"?> 
<config name="oms"> 
    <!-- backup database configuration --> 
    <config name="dataBackup"> 
        <!-- default  backup database dir configuration --> 
        <param name="defaultBackupDataBaseDir"/> 
    </config> 
    <!-- mySql and gauss database default tablespace configuration, record the maximum 
    value (in MB)--> 
    <config name="mySqlDBTableMaxSize"> 
        <param name="OMSPM">8192</param> 
        <param name="OMSFM">8192</param> 
        <param name="OMSSM">2048</param> 
    <param name="TAM">8192</param> 
<param name="SLA">20480</param> 
<param name="DC">4096</param> 
<param name="NASMGR">20480</param> 
<param name="CONFFILE">2048</param> 
<param name="GCLI">1024</param> 
</config> 
</config>

nbi.xml

Function

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

NOTE:

FTP is an insecure protocol. SFTP and FTPS are recommended because they are secure.

Path

eSight installation directory/AppBase/etc/oms.nbi

Description
Table 9-23 nbi.xml configuration description

Parameter

Description

Setting

Effective Method

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

Restart

NmsinfoName

Indicates the third-party systems to be configured. Set the parameter to the IP address of the third-party systems.

Data type: string

Value range: Valid IP address.

NOTE:

When configures multiple third-party systems, it is required to set different IP.

Default value: empty

Restart

IsPush

Indicates the method used to obtain the device list.

Data type: integer

Values:

  • 0: Pull
  • 1: Push

Default value: 0

Restart

FTPServerIp

Indicates the File Transfer Protocol (FTP) server IP address of the third-party systems.

Data type: dotted decimal notation

Value range: unrestricted

Default value: 127.0.0.1

Restart

Port

Indicates the FTP server port of the third-party systemsS.

Data type: integer

Value range: 0-65535

Default value: empty

Restart

AuthMode

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

Data type: integer

Values:

  • 0: Password
  • 1: Public Key

Default value: 0

Restart

ValuePhrase

  • If the eSight connects to the third-party systems 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

Restart

FileTransMode

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

Data type: integer

Values:

  • 0: FTP
  • 1: Secure File Transfer Protocol (SFTP)
NOTE:

FTP is an insecure protocol. SFTP and FTPS are recommended because they are secure.

Default value: 1

Restart

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.

Data type: integer

Value range: 0-52428800 (50M)

Default value: 0

NOTE:

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

Unit: byte/s

Restart

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.

Data type: integer

Value range: 0-52428800 (50M)

Default value: 0

NOTE:

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

Unit: byte/s

Restart

Username

  • If IsPush is set to 1 and FileTransMode 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 systems.
  • 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 SFTP server of the third-party systems.
  • 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: contains 6 to 32 characters and cannot contain spaces or these special characters: " \ # % / & ' ; < + = > ? © ®

Default value: empty

Restart

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 systems when FileTransMode is set to 0.
    • Indicates the password used by the eSight to log in to the SFTP server of the third-party systems when FileTransMode is set to 1 and AuthMode is set to 0.
    • Indicates the absolute path to the file that contains private keys used by the eSight to log in to the third-party systems 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 can not 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/File Transfer Protocol over SSL (FTPS)/SFTP server.

Default value: empty

Restart

NMSTopologyFilePath

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

Data type: string

Values:

  • On Windows, the value of this parameter is an absolute path.
  • On Linux or Solaris, the value of this parameter is an absolute path or a relative path under the FTP root directory.

Default value: /home/nbi/NMSTopologyFiles

Restart

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

Restart

RetryPollInterval

Indicates the polling interval.

Data type: integer

Value range: 1-30

Default value: 5

Unit: hour

Restart

FTPRetryTimes

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

Data type: integer

Value range: unrestricted

Default value: 3

Unit: time

Restart

FileRetentionDays

Indicates the maximum 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

Restart

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

Restart

TopologyDelimiter

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

Data type: string

Values: _ : ; ` @ # ! ~ '

Default value: ;

Restart

baseDN

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

Data type: string

Values: /

Default value: /

Restart

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

Restart

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

Restart

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

Restart

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

Restart

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 systems through the Simple Network Management Protocol (SNMP) NBI.

Data type: string

Values: /

Default value: /

Restart

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 systems through the SNMP NBI.

Data type: integer

Value range:

  • 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

Restart

topoLevel

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

Data type: integer

Value range: 1-10

Default value: 10

Restart

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

Restart

PMThread.PMThreadSleepTime

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

Data type: integer

Value range: unrestricted

Default value: 500

Unit: ms

Restart

Precautions

To enhance network security, configure your own public key and private key.

Configuration Example
  • Push mode:
    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 systems  
                    <Port>31921</Port>                      //Port of the third-party systems  
                    <Username>admin</Username> //FTP user name of the third-party systems  
                    <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>      
  • 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>admin</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>     

snmpagent.xml

Function

The snmpagent.xml file is used to configure parameters required by the Simple Network Management Protocol (SNMP) northbound interface (NBI) to perform alarm functions.

Path

eSight installation directory/AppBase/etc/nbi/snmp

Description
Table 9-24 Common configuration items in snmpagent.xml

Parameter

Description

Setting

Effective Method

Agent_IP

Indicates the Internet Protocol (IP) address that runs SNMP servers.

Data type: dotted decimal notation

Value range: unrestricted

Default value: 127.0.0.1

Restart

Agent_Port

Indicates the port that runs SNMP services. This parameter does not need to be changed.

Data type: integer

Value range: 0-65535

Default value: 4700

Restart

TrapSendIP

Indicates the source IP address used to send traps and informs. If value is invalid, the system IP address will be used.

Data type: dotted decimal notation

Value range: unrestricted

Default value: 127.0.0.1

Restart

TrapSendPort

Indicates the source port used to send traps and informs. If the value is invalid, a random port will be used.

Data type: integer

Value range: 0-65535

Default value: 31920

Restart

SupportedMIB

Specifies whether the management information base (MIB) file to be loaded is the message MIB file or the distributed MIB file.

NOTE:

MIB2 is recommended.

Data type: string

Values:

  • MIB1
  • MIB2

Default value: MIB2

Restart

TrapSendInterval

Indicates the interval at which traps are sent to the third-party systems. This parameter is invalid for informs.

Data type: integer

Value range: 1-1000

Default value: 0

Unit: ms

Restart

TimeFormat

Indicates the format of the alarm time VB field.

Data type: integer

Values:

  • 0: Coordinated Universal Time (UTC) (%Y/%m/%d - %H:%M:%SZ)
  • 1: local time without the time zone (%Y/%m/%d - %H:%M:%S)
  • 2: local time with the time zone (%Y/%m/%d - %H:%M:%S,%TZ[DST])
  • 3: UTC time (%Y-%m-%d %H:%M:%S)
  • 4: local time (%Y-%m-%d %H:%M:%S %TZ TZ %DST DST)

Default value: 3

Restart

TimeType

Indicates the type of the alarm reporting time.

Data type: integer

Values:

  • 0: UTC time
  • 1: element management system (EMS) time
  • 2: network element (NE) time

Default value: 0

Restart

StringSize

Indicates the maximum characters that be fixed in a VB field.

Data type: integer

Value range: 255-4096

Default value: 4096

Restart

ActiveAlarm

Specifies whether current alarms or active alarms are queried.

Data type: integer

Values:

  • 0: current alarms are queried.
  • Non-0: active alarms are queried.

Default value: 1

Restart

TrapCoding

Indicates the coding format of traps to be reported.

Data type: string

Values:

  • UTF-8
  • ISO-8859-1
  • GBK

Default value: UTF-8

Restart

SupportRootAlarm

Specifies whether root alarms are supported.

Data type: integer

Values:

  • 0: all alarms are reported or queried.
  • 1: only root alarms are reported or queried.

Default value: 0

Restart

PDUTrace

Specifies whether PDU logs are recorded.

Data type: integer

Values:

  • 0: PDU logs are not recorded.
  • 1: PDU logs are recorded.

Default value: 0

Restart

Table 9-25 Configuration items for SNMPv3 in snmpagent.xml

Parameter

Description

Setting

Effective Method

Level

Indicates the security level of SNMPv3.

Data type: integer

Values:

  • 1: without authentication but with encryption
  • 2: with authentication but without encryption
  • 3: with authentication and encryption

Default value: 3

Restart

AuthProtocol

Indicates the authentication protocol used for SNMPv3.

Data type: integer

Values:

  • 1: message digest algorithm 5 (MD5)
  • 2: SHA

Default value: 2

NOTE:

The MD5 encryption algorithm is insecure. SHA is recommended because it is secure.

Restart

PrivProtocol

Indicates the encryption protocol used for SNMPv3.

Data type: integer

Values:

  • 1: Data Encryption Standard (DES)
  • 2: Advanced Encryption Standard (AES)

Default value: 2

NOTE:

Using AES is recommended because of its higher security than DES.

Restart

Table 9-26 Configuration items for inform in snmpagent.xml

Parameter

Description

Setting

Effective Method

Enable

Specifies whether alarms are reported in inform mode.

Data type: integer

Values:

  • 0: alarms are not reported in inform mode.
  • 1: alarms are reported in inform mode.

Default value: 0

Restart

Timeout

Indicates the timeout period for transmitting an inform.

Data type: integer

Value range: a positive integer (excluding 0)

Default value: 5

Restart

Retries

Indicates the maximum times for retransmitting an inform.

Data type: integer

Value range: a positive integer and 0

Default value: 3

Restart

CacheSize

Indicates the cache size for real-time alarms.

Data type: integer

Value range: 0-50000

Default value: 10000

Restart

Table 9-27 Configuration items for heartbeat in snmpagent.xml

Parameter

Description

Setting

Effective Method

Enable

Specifies whether heartbeat notification is enabled or disabled.

Data type: integer

Values:

  • 0: heartbeat notification is disabled.
  • 1: heartbeat notification is enabled.

Default value: 1

Restart

Interval

Indicates the interval at which a heartbeat trap is sent.

Data type: integer

Value range: 3-3600

Default value: 60

Unit: second

Restart

Lable

Indicates the identity of a heartbeat trap.

Data type: string

Value range: unrestricted

Default value: SNMP Agent

Restart

Table 9-28 Configuration items for MIB in snmpagent.xml

Parameter

Description

Setting

Effective Method

VB1-VB23

Indicates the fields reported by MIB1.

Data type: string

Value range: unrestricted

Default value: NEName NEType ObjectInstance EventType EventTime ProbableCause Severity EventDetail AdditionalInfo FaultFlag FaultFunction DeviceIP SerialNo ProbableRepair ResourceIDs EventName ReasonID FaultID DeviceType TrailName RootAlarm GroupID MaintainAlmStatus

Restart

SupportX733Alarm

Specifies whether X733 is supported.

Data type: integer

Values:

  • 0: X733 is not supported.
  • 1: X733 is supported.

Default value: 0

Restart

NotifyOID

Specifies whether alarm trap OID is supported.

Data type: integer

Values:

  • 0: alarm trap OID is not supported.
  • 1: alarm trap OID is supported.

Default value: 0

Restart

Critical

Indicates the alarm severity redefined for a critical alarm.

Data type: string

Value range: unrestricted

Default value: Critical

Restart

Major

Indicates the alarm severity redefined for a major alarm.

Data type: string

Value range: unrestricted

Default value: Major

Restart

Minor

Indicates the alarm severity redefined for a minor alarm.

Data type: string

Value range: unrestricted

Default value: Minor

Restart

Warning

Indicates the alarm severity redefined for a warning alarm.

Data type: string

Value range: unrestricted

Default value: Warning

Restart

Unreport

Indicates the alarm severity redefined for an Unreport alarm.

Data type: string

Value range: unrestricted

Default value: Unknown_Severity

Restart

Indeterminate

Indicates the alarm severity redefined for an Indeterminate alarm.

Data type: string

Value range: unrestricted

Default value: Indeterminate

Restart

VB1-VB27

Indicates the fields reported by MIB2.

Data type: string

Value range: unrestricted

Default value: Csn Category OccurTime MOName ProductID NEType NEDevID DevCsn ID Type Level Restore Confirm AckTime RestoreTime Operator ExtendInfo Probablecause Proposedrepairactions SpecificProblems ClearOperator ObjectInstanceType ClearCategory ClearType ServiceAffectFlag AdditionalInfo GroupID

Restart

VB28-V51

Indicates the customized fields reported by MIB2.

Data type: string

Value range: unrestricted

Default value: Paras2 Paras3 Paras4 Paras5 Paras6 Paras7 Paras8 Paras9 Paras10 ExtendProductItem1 ExtendProductItem2 ExtendProductItem3 ArrivedEMSTime ExtendProductItem5 ExtendProductItem6 ExtendProductItem7 ExtendProductItem8 ExtendProductItem9 ExtendProductItem10 ExtendProductItem11 ExtendProductItem12 ExtendProductItem13 ExtendProductItem14 ExtendProductItem15

Restart

CsnType

Indicates the type of reported alarm serial numbers (CSN).

Data type: integer

Values:

  • 0: character string
  • 1: integer

Default value: 0

Restart

isInternational

Indicates the standard used to report alarm severities.

Data type: integer

Values:

  • 0: Huawei standard
  • 1: international standard

Default value: 0

Restart

Table 9-29 Configuration items for the third-party systems in snmpagent.xml

Parameter

Description

Setting

Effective Method

IPAddress

Indicates the IP address or host name of the third-party systems used to receive traps.

Data type: dotted decimal notation

Value range: unrestricted

Default value: no default value

Restart

Port

Indicates the port of the third-party systems used to receive traps.

Data type: integer

Value range: 0-65535

Default value: no default value

Restart

Version

Indicates the SNMP version.

Suggest using SNMPv3.

Data type: integer

Values:

  • 1: SNMPv1
  • 2: SNMPv2
  • 3: SNMPv3

Default value: no default value

NOTE:

SNMPv3 is preferred because it has the highest security level.

Restart

Read

Indicates the get community name.

Data type: string

Value range: string in ciphertext

Default value: no default value

Restart

Write

Indicates the set community name.

NOTE:

Suggest configuring different as get community.

Data type: string

Value range: string in ciphertext

Default value: no default value

Restart

V3User

Indicates the security user name of SNMPv3.

Data type: string

Value range: unrestricted

Default value: no default value

NOTE:

An SNMP V3's user name cannot be the same as Authentication password and Encryption password.

Restart

AuthPassword

Indicates the authentication password of the third-party systems user.

Data type: string

Value range: string in ciphertext

Default value: no default value

Restart

PrivPassword

Indicates the encryption password of the third-party systems user.

NOTE:

Suggest configuring different as authentication password.

Data type: string

Value range: string in ciphertext

Default value: no default value

Restart

Critical

Specifies whether critical alarms are reported.

Data type: integer

Values:

  • 0: critical alarms are not reported.
  • 1 or empty: critial alarms are reported.

Default value: no default value

Restart

Major

Specifies whether major alarms are reported.

Data type: integer

Values:

  • 0: major alarms are not reported.
  • 1 or empty: major alarms are reported.

Default value: no default value

Restart

Minor

Specifies whether minor alarms are reported.

Data type: integer

Values:

  • 0: minor alarms are not reported.
  • 1 or empty: minor alarms are reported.

Default value: no default value

Restart

Warning

Specifies whether warning alarms are reported.

Data type: integer

Values:

  • 0: warning alarms are not reported.
  • 1 or empty: warning alarms are reported.

Default value: no default value

Restart

Event

Specifies whether events are reported.

Data type: integer

Values:

  • 0: events are not reported.
  • 1 or empty: events are reported.

Default value: no default value

Restart

Fault

Specifies whether fault alarms are reported.

Data type: integer

Values:

  • 0: fault alarms are not reported.
  • 1 or empty: fault alarms are reported.

Default value: empty

Restart

Recover

Specifies whether clear alarms are reported.

Data type: integer

Values:

  • 0: clear alarms are not reported.
  • 1 or empty: clear alarms are reported.

Default value: no default value

Restart

Acknowledge

Specifies whether acknowledged alarms are reported.

Data type: integer

Values:

  • 0: acknowledged alarms are not reported.
  • 1 or empty: acknowledged alarms are reported.

Default value: no default value

Restart

Unacknowledge

Specifies whether unacknowledged alarms are reported.

Data type: integer

Values:

  • 0: unacknowledged alarms are not reported.
  • 1 or empty: unacknowledged alarms are reported.

Default value: no default value

Restart

Change

Specifies whether change alarms are reported.

Data type: integer

Values:

  • 0: change alarms are not reported.
  • 1 or empty: change alarms are reported.

Default value: no default value

Restart

NeTypeFilter

Indicates the NE type for which alarms are reported.

Data type: string

Value range: numbers separted by commas (,)

Default value: no default value

Restart

MaintenanceAlarmFilter

Specifies whether engineering alarms are reported.

Data type: integer

Values:

  • 0: engineering alarms are not reported.
  • 1 or empty: engineering alarms are reported.

Default value: no default value

Restart

Configuration Example
<snmpagent name="snmpagent"> 
    <common name="common"> 
        <param name="Agent_IP">127.0.0.1</param> 
        <param name="Agent_Port">4700</param> 

        <param name="TrapSendIP">127.0.0.1</param> 
        <param name="TrapSendPort">31920</param> 

        <param name="SupportedMIB">MIB2</param> 
        <param name="TrapSendInterval">0</param> 

        <param name="TimeType">0</param> 
        <param name="TimeFormat">3</param> 
        <param name="StringSize">4096</param> 
        <param name="ActiveAlarm">1</param>  

        <param name="TrapCoding">UTF-8</param> 
        <param name="PDUTrace">0</param> 
        <param name="SupportRootAlarm">0</param> 
    </common> 

    <inform name="inform"> 
        <param name="Enable">0</param> 
        <param name="Timeout">5</param> 
        <param name="Retries">3</param> 
        <param name="CacheSize">10000</param> 
    </inform> 

    <v3trap name="v3trap"> 
        <param name="Level">3</param> 
        <param name="AuthProtocol">2</param> 
        <param name="PrivProtocol">2</param> 
    </v3trap> 

    <heartbeat name="heartbeat"> 
        <param name="Enable">1</param> 
        <param name="Interval">60</param> 
        <param name="Lable">SNMP Agent</param>             
    </heartbeat> 

    <MIB1 name="MIB1"> 
     <Mib name="Mib"> 
            <param name="VB1">NEName</param> 
            <param name="VB2">NEType</param> 
            <param name="VB3">ObjectInstance</param> 
            <param name="VB4">EventType</param> 
            <param name="VB5">EventTime</param> 
            <param name="VB6">ProbableCause</param> 
            <param name="VB7">Severity</param> 
            <param name="VB8">EventDetail</param> 
            <param name="VB9">AdditionalInfo</param> 
            <param name="VB10">FaultFlag</param> 
            <param name="VB11">FaultFunction</param> 
            <param name="VB12">DeviceIP</param> 
            <param name="VB13">SerialNo</param> 
            <param name="VB14">ProbableRepair</param> 
            <param name="VB15">ResourceIDs</param> 
            <param name="VB16">EventName</param> 
            <param name="VB17">ReasonID</param> 
            <param name="VB18">FaultID</param> 
            <param name="VB19">DeviceType</param> 
            <param name="VB20">TrailName</param> 
            <param name="VB21">RootAlarm</param> 
            <param name="VB22">GroupID</param> 
            <param name="VB23">MaintainAlmStatus</param> 
        </Mib> 
        <param name="SupportX733Alarm">0</param> 
        <param name="NotifyOID">0</param> 
        <severity name="severity"> 
          <param name="Critical">Critical</param> 
          <param name="Major">Major</param> 
          <param name="Minor">Minor</param> 
          <param name="Warning">Warning</param> 
          <param name="Unreport">Unknown_Severity</param> 
          <param name="Indeterminate">Indeterminate</param> 
        </severity>          
     </MIB1> 
     <MIB2 name="MIB2"> 
        <Mib name="Mib"> 
            <param name="VB1">Csn</param> 
            <param name="VB2">Category</param> 
            <param name="VB3">OccurTime</param> 
            <param name="VB4">MOName</param> 
            <param name="VB5">ProductID</param> 
            <param name="VB6">NEType</param> 
            <param name="VB7">NEDevID</param> 
            <param name="VB8">DevCsn</param> 
            <param name="VB9">ID</param> 
            <param name="VB10">Type</param> 
            <param name="VB11">Level</param> 
            <param name="VB12">Restore</param> 
            <param name="VB13">Confirm</param> 
            <param name="VB14">AckTime</param> 
            <param name="VB15">RestoreTime</param> 
            <param name="VB16">Operator</param> 
            <param name="VB17">ExtendInfo</param> 
            <param name="VB18">Probablecause</param> 
            <param name="VB19">Proposedrepairactions</param> 
            <param name="VB20">SpecificProblems</param> 
            <param name="VB21">ClearOperator</param> 
            <param name="VB22">ObjectInstanceType</param> 
            <param name="VB23">ClearCategory</param> 
            <param name="VB24">ClearType</param> 
            <param name="VB25">ServiceAffectFlag</param> 
            <param name="VB26">AdditionalInfo</param> 
            <param name="VB27">GroupID</param> 
         </Mib> 
         <param name="CsnType">0</param> 
         <param name="isInternational">0</param> 
     </MIB2> 
     <template name="template"> 
        <param name="IPAddress"/> 
        <param name="Port"/> 

        <param name="Version"/> 

        <community name="community1"> 
            <param name="Read"/> 
            <param name="Write"/> 
        </community> 

        <param name="V3User"/> 

        <param name="AuthPassword"/> 

        <param name="PrivPassword"/> 

        <alarmlevel name="alarmlevel">  
        <param name="Critical"/> 
        <param name="Major"/> 
        <param name="Minor"/> 
        <param name="Warning"/> 
    </alarmlevel> 

    <category name="category">  
        <param name="Event"/> 
        <param name="Fault"/> 
        <param name="Recover"/> 
        <param name="Acknowledge"/> 
        <param name="Unacknowledge"/> 
        <param name="Change"/> 
    </category> 

        <param name="NETypeFilter"/>  
        <param name="MaintenanceAlarmFilter"/>      
      </template>  
</snmpagent>

authenticateConfig.xml

Function

The authenticateConfig.xml file specifies the authentication mode and type for the eSight.

Path

eSight installation directory/AppBase/etc/oms.sm

Description
Table 9-30 Configuration items in authenticateConfig.xml

Parameter

Description

Setting

Effective Method

oms/security/AuthMode

Specifies the authentication mode for the eSight.

Data type: string

Value range:

  • Local: Authentication to be done by the local eSight.
  • Central: Authentication to be done by the central LDAP or by private implementation.

Default value: Local

Restart

oms/security/AuthType

Specifies the authentication type for the eSight.

Data type: string

Value range:

  • LDAP: Authentication to be done by the central LDAP server.
  • RADIUS: Authentication to be done by the central RADIUS server.
NOTE:

Because RADIUS authentication is vulnerable to man-in-the-middle attacks (authentication bypass), RADIUS authentication is not recommended and LDAP authentication is recommended.

  • PRIVATE: Authentication to be done by a private method, using an extension mechanism.

Default value: LDAP

Restart

oms/security/KeepLocalAdmin

When authentication to be done by the central server, Whether to keep local admin user for the eSight.

Data type: boolean

Value range:

  • true: keep local admin user.
  • false: not keep local admin user.

Default value: true

Restart

Precautions
  • Do not modify the configuration file.
  • If you modify the configuration items using the GUI tool, the modifications take effect immediately. If you manually modify the configuration items, you must restart the eSight for the modifications to take effect.
Configuration Example
<xml version="1.0" encoding="UTF-8"?> 
<onfig name="oms"> 
    <onfig name="security"> 
        <param name="AuthMode">Local</param> 
        <param name="AuthType">LDAP</param> 
        <param name="KeepLocalAdmin">true</param> 
    <config> 
<config>

ftpusers.properties

Function

The ftpusers.properties file is used to configure an FTP user for the eSight.

NOTE:

FTP is an insecure protocol. SFTP and FTPS are recommended because they are secure.

Path

eSight installation directory/AppBase/etc

Description
Table 9-31 Configuration items in ftpusers.properties

Parameter

Description

Setting

Effective Method

admin.home

Indicates the directory of user admin.

Data type: string

Value range: unrestricted

Default value: ftp

Restart

admin.password

Indicates the password for user admin.

Data type: string

Value range: unrestricted

Default value: character string of the encrypted password, see Changing the FTP/SFTP/FTPS User Password.

Restart

admin.slatValue

Indicates the salt of the password for the admin user.

Data type: string

Value range: unrestricted

Default value: Salt character string that takes effect when the initial password is encrypted, see Changing the FTP/SFTP/FTPS User Password.

Restart

admin.writable

Specifies whether user admin has the write permission.

Data type: boolean

Value range:

  • true
  • false

Default value: true

Restart

Precautions
  • Do not modify the configuration file.
  • Adding an FTP user: Copy the preceding four configuration items and change their values. Then replace admin with the new user name. For details, see the following example.
Configuration Example
# ftp users 
# \var\runtime*\data 
admin.home=ftp 
admin.password=Nu+/ve+/vSnvv73vv71l77+9Gu+/ve+/ve+/ve+/vSVR77+9CBsN77+9Pl3vv71x77+977+9Je+/vUjvv70g77+9 
admin.slatValue=hyGs3Az23ka9WaUe6pxxiDCyhzCiU1KXNUvEq5Qxje4\= 
admin.writable=true 

#add an FTP user 
newuser.home=ftp 
newuser.password=77+977+9U++/ve+/ve+/ve+/vUPvv73Ij++/ve+/vXhPBe+/ve+/vUTvv70q77+9We+/ve+/vWxHJHrvv73vv70\= 
newuser.slatValue=HqcMgNy9WWTXbzotiJI2fGpSRJcMgINzlRgtLlYO8Eo\= 
newuser.writable=true

rosinternal.xml

Function

The rosinternal.xml file is used to set open-interface-related configurations.

Path

eSight installation directory/AppBase/etc/oms.ros

Description
Table 9-32 Configuration items in rosinternal.xml

Parameter

Description

Setting

Effective Method

ip

Indicates the IP address of the server when the eSight and ROS are deployed separately.

Data type: string

Value range: Character strings that consist of digits

Default value: no default value

Restart

port

Indicates the port number of the server when the eSight and ROS are deployed separately.

Data type: string

Value range: Character strings that consist of digits

Default value: no default value

Restart

openapiServicePort

Indicates the port number of the server when the OpenAPI are deployed separately.

Data type: string

Value range: Character strings that consist of digits.

Default value: 32102

Restart

tokenTimeout

Indicates the time (unit: s) that the token is invalid.

Data type: String

Value range: Character strings that consist of digits, from 1800 to 14400

Default value: 1800

Unit: second

Restart

resptype

Specifies the message format returned by calling open APIs based on digest-based authentication.

NOTE:
  • The item is not configured or is configured as "JSON". It is not valid when configured for other values.
  • In the hierarchical network management scenarios, the item of the configuration file in lower network management can not be set to "json", because the current code in graduation network managements is used in the original format.

Data type:

String