Configuring the Third-Party Server Page 1 of 12

Configuring the Third-Party Server

Configuring an Email Server

Configuring an SMS Server

Configuring Syslog NBI Interconnection Information

This section describes how to configure Syslog protocol parameters and services
when Syslog is used to report service data.

Parent Topic: MSP Administrator O&M

Copyright © Huawei Technologies Co., Ltd.
< Previous topic Next topic >

Configuring an Email Server

• Context
• Procedure
• Parameter Description

Context

If iMaster NCE-WAN needs to send emails to users, you need to configure an email server first.

iMaster NCE-WAN needs to send emails in the following scenarios:

• The MSP administrator or tenant administrator forgets the password: iMaster NCE-WAN
sends a reset password to the administrator through an email.
• The tenant administrator performs alarm settings on iMaster NCE-WAN: iMaster NCE-
WAN sends emails to notify users of reported alarms.
• The tenant administrator wants to use the email-based deployment function: iMaster NCE-
WAN needs to send deployment emails to related personnel.
• Tenants want to register accounts by themselves: iMaster NCE-WAN sends an email
containing an activation link to the tenants.
• The MSP administrator inspects tenant devices: iMaster NCE-WAN sends the inspection
report to the administrator's mailbox, if needed.
• The MSP administrator deletes ESNs or devices: iMaster NCE-WAN sends a notification
email to the tenant administrator, if needed.
• A tenant license is about to expire: iMaster NCE-WAN sends a notification email to a
tenant.
• When portal authentication is configured for guest access, you need to set the approver
notification mode or guest notification mode to email notification.

The system administrator has configured an email server for sending emails. If the MSP
administrator wants to use another email server, the MSP administrator needs to configure an
email server separately.

file:///C:/Users/Roberto/AppData/Local/Temp/~hh1D.htm 21/02/2023
Configuring the Third-Party Server Page 2 of 12

If both the system administrator and MSP administrator have configured an email server, the
email server configured by the MSP administrator is used preferentially. If the email server
configured by the MSP administrator is not found, the email server configured by the system
administrator is used.

Procedure

1. Upload an email server certificate.

a. Contact the SMS server provider to obtain a certificate file.

b. Choose Administration > Certificate Management > Certificate Management
from the main menu.
c. Choose Service Certificate Management from the navigation pane. On the Services
page, click CampusBaseServiceServerConfigMoudle.
d. Click the Trust Certificate tab and click Import. On the displayed page, enter the
certificate information, select the desired email server certificate, and click Submit to
upload the certificate to iMaster NCE-WAN.

2. Choose Administration > Third Party Service > Email Server from the main menu.
3. Set parameters for connecting to the email server.

If the email server uses a third-party CA certificate, you are advised to disable Validate
server certificate.

4. Click Test to verify the email sending function.

◦ If the message "The test succeeds" is displayed and the mailbox receives the test
email, the configuration is successful. Click Save.
◦ If the message "The test succeeds" is displayed but the mailbox does not receive the
test email, check whether the email function of the SMTP server is normal.
◦ If the message "Failed to connect to the email server" is displayed, check whether
the above parameters are correctly configured.

◾ Affected by the network quality and performance of the SMTP server, the time
of receiving emails will be delayed within two minutes.
◾ Some SMTP providers set the right control for third-party application access. If
the test fails, check whether the function of controlling third-party application
access is enabled on the SMTP server and set password to the authentication
password of the SMTP server.
◾ Limited by security policies of email service providers, administrators may fail
to receive emails in some scenarios. If no email is received, log in to the email
service website or contact the email service provider to check whether the email
is returned or other exceptions occur. Alternatively, replace the email server
and try again.

file:///C:/Users/Roberto/AppData/Local/Temp/~hh1D.htm 21/02/2023
Configuring the Third-Party Server Page 3 of 12

◾ When configuring a new email server, the firewall must allow the IP address of
the email server. Otherwise, the email server may fail to be connected.

Parameter Description

Table 1 Parameters on the Email Server tab page

Parameter Description Data

Plan in
Advance

SMTP address SMTP address of the mailbox from which emails are sent. The Y
address must be an IP address or in the smtp.mail.com format.

NOTE:

SMTP is short for Simple Mail Transfer Protocol. SMTP is mainly

used to transfer system emails and provide email notifications.

Port Port number of the SMTP service provided by the email server. You Y
can obtain the port number from the email service provider. By
default, the port number is 25.

Enable Weather STARTTLS is enabled. When selected, secure connection is -

STARTTLS automatically enabled.

Secure Whether secure connection is enabled. -

connection

Encryption Protocol for establishing an encrypted communication link between -

connection iMaster NCE-WAN and the SMTP server. This parameter is available
type only when Secure connection is selected. The options are TLSv1.0,
TLSv1.1, TLSv1.2, and TLSv1.3. The default option is TLSv1.2.

NOTE:

For data security during communication, you are advised to use

TLSv1.2 or later. TLSv1.0 and TLSv1.1 are insecure protocols;
therefore, exercise caution when using them.

Validate For security purposes, select Secure connection and Validate server -
server certificate. Select certificate.
certificate

file:///C:/Users/Roberto/AppData/Local/Temp/~hh1D.htm 21/02/2023
Configuring the Third-Party Server Page 4 of 12

Parameter Description Data

Plan in
Advance

Certificate Certificate file of the email server. This certificate ensures -

File communication security between iMaster NCE-WAN and the email
server.

Authentication Whether to enable the email account and password authentication. -

Account The two parameters are valid only when Authentication is selected. -

User name and password for logging in to the SMTP server.

Password -

Sender Email Sender email address, which must have been registered on the email Y
server. During the email test, this address is used as a recipient email
address. After the connectivity test is successfully performed and the
configurations are saved, this address is used as the sender email
address.

Customized Email subject. An administrator can customize the prefix and suffix of -
email subject the email subject. When an email is sent, the prefix and suffix are
automatically added before and after the email subject.

Customized Email signature. An administrator can customize the email signature, -

email and the signature is automatically attached to emails.
signature

Parent Topic: Configuring the Third-Party Server

Copyright © Huawei Technologies Co., Ltd.
Next topic >

Configuring an SMS Server

• Context

Context

You need to configure the SMS service if SMS authentication is required.

Before configuring the SMS service, you need to configure an SMS platform to specify the SMS
gateway and configure account information based on the SMS platform to send SMS messages.

file:///C:/Users/Roberto/AppData/Local/Temp/~hh1D.htm 21/02/2023
Configuring the Third-Party Server Page 5 of 12

• SMS platform: You need to set parameters about a third-party SMS platform on iMaster
NCE-WAN according to the information provided by the SMS platform. For details, see the
interface document of the third-party SMS platform.
• SMS server: You need to set parameters for interworking between iMaster NCE-WAN and
a third-party SMS platform. After the interconnection is successful, iMaster NCE-WAN can
send SMS messages.

By default, the system is pre-configured with the following SMS server connection
parameters:

◦ fungo: http://qxt.fungo.cn/Recv_center. This is the SMS platform of fungo.cn

(Beijing, China).
◦ twilio: https://api.twilio.com:8443/2010-04-01/Accounts/
{USERNAME}/Messages.json. To use this SMS server, access www.twilio.com and
apply for an account.
◦ HUAWEI CLOUD: https://rtcsms.cn-north-1.myhuaweicloud.com. For details, see
HUAWEI CLOUD SMS Gateway Guide.
◦ NetEase Yunxin: https://doc.yunxin.163.com/en/docs/jcyOTA0ODM/zY0MjQ5NjE?
platformId=50002. For details, see the NetEase Yunxin SMS user manual.

• If the system administrator has configured an SMS server and enabled, MSP administrators
can use the SMS server configured by the system administrator. Otherwise, they cannot use
the SMS server configured by the system administrator and need to configure an SMS
server on their own.

If a MSP administrator wants to configure an SMS server, the tenant administrator needs to
contact the system administrator to configure the SMS platform information. Only the
system administrator can configure the SMS platform information. For detail, see
Configuring an SMS Server.

If you do not want to use the SMS server configured by the system administrator, you can
configure an SMS server as needed.

• Prerequisites
• Procedure
• Parameter Description

Prerequisites

The system administrator has created an SMS server template.

Procedure

1. Import an SMS server certificate.

a. Contact the SMS server provider to obtain a certificate file.

b. Choose Administration > Certificate Management > Certificate Management
from the main menu.
c. Choose Service Certificate Management from the navigation pane. On the Services
page, click CampusBaseServiceServerConfigMoudle.

file:///C:/Users/Roberto/AppData/Local/Temp/~hh1D.htm 21/02/2023
Configuring the Third-Party Server Page 6 of 12

d. Click the Trust Certificate tab and click Import. On the displayed page, enter the
certificate information, select the desired SMS server certificate, and click Submit to
upload the certificate to iMaster NCE-WAN.

2. Choose Administration > Third Party Service > SMS Server from the main menu.
3. Select an SMS Platform, and configure the related data.

HTTPS is recommended because it is more secure than HTTP.

◦ Set SMS service type to HTTP SMS service and select fungo from the SMS
platform drop-down list box.

◦ Set SMS service type to HTTP SMS service and select twilio from the SMS
platform drop-down list box.

◦ Set SMS service type to HTTP SMS service and select HuaweiCloud from the
SMS platform drop-down list box.

◦ Set SMS service type to HTTP SMS service and select Netease from the SMS
platform drop-down list box.

◦ Set SMS service type to SMPP service and select the created SMS template from the
SMS platform drop-down list box.

4. Click Test to verify validity of the SMS message sending function.

◦ If the test succeeds, the message "The test succeeds" is displayed, and you can receive
the test SMS from iMaster NCE-WAN.
◦ If the test fails, the message "Failed to test the SMS serve" is displayed. Perform
operations according to the scenarios:
◾ If an error code is displayed in the dialog box, check the product documentation
of the SMS service provider for the cause of the error, and obtain the
troubleshooting method.
◾ If no error code is displayed in the dialog box, contact the system administrator
to check whether the SMS server template is correctly configured.

file:///C:/Users/Roberto/AppData/Local/Temp/~hh1D.htm 21/02/2023
Configuring the Third-Party Server Page 7 of 12

5. After the test is successful, click Save.

Parameter Description

Table 1 HTTP SMS Server

Parameter Description

SMS platform SMS template. Administrators can configure an SMS server template to
specify an SMS gateway.

By default, the following SMS server connection parameters are pre-

configured in the system:

• fungo: http://qxt.fungo.cn/Recv_center. This is the SMS platform of

fungo.cn (Beijing, China).
• twilio: https://api.twilio.com:8443/2010-04-01/Accounts/
{USERNAME}/Messages.json. To use this SMS server, access
www.twilio.com and apply for an account.
• HUAWEI CLOUD: https://rtcsms.cn-north-1.myhuaweicloud.com.
For details, see HUAWEI CLOUD SMS Gateway Guide.
• NetEase Yunxin:
https://doc.yunxin.163.com/en/docs/jcyOTA0ODM/zY0MjQ5NjE?
platformId=50002. For details, see the NetEase Yunxin SMS user
manual.

To use the SMS service provided by another carrier, you can create an SMS
template.

Account Account obtained during SMS service application.

Token Password obtained during SMS service application.

NOTE:

For system and user security purposes, it is recommended that the password
provided by a third party meet the complexity requirements.

Template ID Configured during SMS service application. This parameter is available

only in HUAWEI CLOUD and NetEase Cloud templates.

SMS message Signature of SMS messages.

signature

Send number Number obtained from the SMS service provider, used to check whether the
SMS message sending number is correct. This parameter is available only in

file:///C:/Users/Roberto/AppData/Local/Temp/~hh1D.htm 21/02/2023
Configuring the Third-Party Server Page 8 of 12

Parameter Description

the twilio template. Number obtained from the SMS service provider, which
is used to check whether the SMS message sending number is correct.

Inheritance If neither the MSP administrator nor the tenant administrator configures an
SMS server, the SMS server configured by the system administrator is used
when Tenant heritable is enabled. If this function is disabled, MSPs and
tenants cannot use the SMS server configured by the system administrator.

Test number Number for sending a test SMS message. The value can be any available
mobile number.

Test SMS message Content in a test SMS message.

Table 2 SMPP SMS server

Parameter Description

SMS platform SMS template. Administrators can configure an SMS server template to
specify an SMS gateway.

Server ID SMS server ID obtained during SMS service application.

Password Password obtained during SMS service application.

Source number Number obtained from the SMS service provider, used to check whether the
SMS message sending number is correct.

Inheritance If neither the MSP administrator nor the tenant administrator configures an
SMS server, the SMS server configured by the system administrator is used
when Inheritance is enabled. If this function is disabled, MSPs and tenants
cannot use the SMS server configured by the system administrator.

Test number Number for sending a test SMS message. The value can be any available
mobile number.

Test SMS Content in a test SMS message.

message

file:///C:/Users/Roberto/AppData/Local/Temp/~hh1D.htm 21/02/2023
Configuring the Third-Party Server Page 9 of 12

Parameter Description

Parent Topic: Configuring the Third-Party Server

Copyright © Huawei Technologies Co., Ltd.
< Previous topic Next topic >

Configuring Syslog NBI Interconnection

Information
This section describes how to configure Syslog protocol parameters and services when Syslog is
used to report service data.

Prerequisites

• You have the Query Northbound Syslog Interface Configuration Items and Modify
Northbound Syslog Interface Configuration Items permissions.
• You have obtained the IP address or domain name, port number, communication protocol,
Syslog protocol, encoding format, and services to be enabled and corresponding service
information of the Syslog server to be interconnected from the MSP administrator.
• If TLS is used as the communication protocol, you need to obtain the trust certificate of the
Syslog server from the MSP administrator.
• You have obtained the identity certificate for Syslog communication from the MSP
administrator.

Procedure

1. If TLS is used as the communication protocol, import the trust certificate of the Syslog
server to iMaster NCE-WAN.

a. Choose Administration > Certificate Management > Certificate Management

from the main menu.
b. In the navigation pane, choose Service Certificate Management.
c. Click the NBIFrmNotifyService-Syslog card.
d. On the Trust Certificate tab page, import the trust certificate of the Syslog server as
prompted.
e. On the Identity Certificate tab page, check whether any identity certificate exists. If
no identity certificate exists, import the identity certificate as prompted.

2. Choose Administration > Third Party Service > Syslog Configuration from the main
menu.
3. Click Add and configure the Syslog server.

4. Configure the data reporting function and select the types of logs to be reported.

a. Click Enable to enable the data reporting function.

b. Select the types of logs to be reported.

file:///C:/Users/Roberto/AppData/Local/Temp/~hh1D.htm 21/02/2023
Configuring the Third-Party Server Page 10 of 12

5. Configure the alarm reporting function. Select alarms based on the alarm severity, alarm ID,
and group and add the selected alarms to the Subscribed Alarm List area.

a. Click Enable to enable the alarm reporting function.

b. Enable the alarm reporting function.

c. Select the alarms to be reported.

◾ Select alarms by severity.

◾ Select alarms by alarm ID.

◾ Select alarms by group name.

6. If you need to check the connectivity between the iMaster NCE-WAN northbound system
and the Syslog server, click the Check Connectivity icon. After the check is complete,
click Save. If you do not need to check the connectivity, click Save directly.

Related Tasks

• Modifying Syslog protocol parameters or service parameters

To modify configured Syslog protocol parameters and service parameters, on the Syslog
Configuration page, click the Edit icon in the Operation column of the row that contains
the Syslog configuration to be modified.

The data reporting function using the Syslog protocol may be abnormal if you modify
Syslog protocol parameters or service parameters. Exercise caution when performing this
operation.

• Deleting Syslog protocol parameters or service parameters

To delete configured Syslog protocol parameters and service parameters, on the Syslog
Configuration page, click the Delete icon in the Operation column of the row that
contains the Syslog configuration to be deleted. Alternatively, select one or more Syslog
configurations to be deleted, and click Delete in the upper right corner of the Syslog settings
list.

file:///C:/Users/Roberto/AppData/Local/Temp/~hh1D.htm 21/02/2023
Configuring the Third-Party Server Page 11 of 12

The data reporting function using the Syslog protocol may be abnormal if you delete Syslog
protocol parameters or service parameters. Exercise caution when performing this operation.

• Checking connectivity

To check the connectivity between the iMaster NCE-WAN NBI and a configured Syslog
server, in the third-party server list, click the Check Connectivity icon in the Operation
column of the row that contains the desired Syslog server configuration.

Parameter Description

Table 1 Parameters on the Syslog Configuration tab page

Parameter Description

Channel ID Unique identifier of the server.

IP address IP address type or domain name of the syslog server.

type/Domain name

IP address/Domain IP address or domain name of the syslog server, which can be obtained
name from the primary syslog server.

Port number Port number of the syslog server, which is the same as the port number
in udp(ip()port()) or tcp(ip()port()) in the Source field in the
Syslog.conf file of the primary syslog server.

Enable reporting Whether to report the syslog service configuration. The IP address or
domain name and port number of the syslog server can be configured
only when this parameter is selected.

Communication If TLS is configured on the syslog server, enable this parameter. If UDP
protocol is configured on the syslog server, disable this parameter.

Before enabling this parameter, ensure that the syslog server supports
TLS.

Syslog protocol Protocol for reporting syslog messages. The options are RFC 5424 and
RFC 3164.

Encoding format UTF-8 or GBK.

file:///C:/Users/Roberto/AppData/Local/Temp/~hh1D.htm 21/02/2023
Configuring the Third-Party Server Page 12 of 12

Parameter Description

Select the type of Select the type of logs to be reported.

audit logs to be
reported

Alarm report Whether to report alarms to the syslog server. You can select the alarms
to be reported or the type of the alarms to be reported.

Parent Topic: Configuring the Third-Party Server

Copyright © Huawei Technologies Co., Ltd.
< Previous topic

file:///C:/Users/Roberto/AppData/Local/Temp/~hh1D.htm 21/02/2023