System Administrator O&M
- Logging in to and Configuring the License Mode
- Viewing Homepage Information
- Managing Licenses
- Managing User Accounts
- Tenant Device Management
- System Setting
- Alarm Management
- Log Management
- Certificate Management
- Configuring a Third-Party Server
- Configuring an Email Server
- Configuring an SMS Server
- Configuring an AD Domain
- Configuring a Map URL
- Configuring the Registration Center
- Configuring Interconnection with a Syslog Server
- Configuring the Signature Server
- Configuring the File Server
- Managing Notification Users
- Configuring Interconnection with AD FS
- Configuring Interconnection with NetIQ
- Configuring RESTful
- Configuring Interconnection with iMaster NCE-CampusInsight
- File Management
- Upgrading the Signature Database on iMaster NCE-Campus
- Fault Collection Settings
- Customizing MSP Information
- Northbound API Management
- Configuration item Management
- Appendix
Logging in to and Configuring the License Mode
Context
After iMaster NCE-Campus is installed, an administrator can use a web browser to log in to the iMaster NCE-Campus web UI to perform system management and maintenance operations. The following web browsers are supported:
- Google Chrome 57 or later
Procedure
- Open a browser.
- Enter https://iMaster NCE-Campus server IP address:port number in the address box, and press Enter.
- The IP address of the iMaster NCE-Campus server is Northbound management IP specified when you install iMaster NCE-Campus.
- The port number is 18008. The port number used for the login must be the same as that specified during the installation.
- The method for logging in to an authentication component is the same as that for logging in to iMaster NCE-Campus.
- Ignore the security certificate warning and access the login page.
When you log in to iMaster NCE-Campus using a browser, the browser performs unidirectional authentication on iMaster NCE-Campus based on the ER certificate. The Huawei ER certificate has been pre-configured during iMaster NCE-Campus installation. This certificate is used only for temporary communication and is not for commercial use. You can apply for a new ER certificate to update the preconfigured ER certificate to improve iMaster NCE-Campus communication security. You are advised to periodically update the certificate to prevent system security risks caused by certificate expiration. After the ER certificate is updated, the message indicating a security certificate error will not be displayed.
- Google Chrome: Choose Advanced > Proceed to ... (unsafe).
- Google Chrome: Choose Advanced > Proceed to ... (unsafe).
- Enter the default administrator name admin, and click Login.
The default username and password are available in iMaster NCE-Campus Default Usernames and Passwords (Enterprise Network or Carrier). If you have not obtained the access permission of the document, see Help on the website to find out how to obtain it.
- (Optional) Upon the first login, change the password as prompted. Skip this step if it is not your first login.
For security purposes, do not save your password in the browser.
- (Optional) Select the license management policy upon first login. Skip this step if it is not your first login.
Exercise caution when selecting a license management policy, because they cannot be modified after being selected. To modify the license mode, you need to reinstall iMaster NCE-Campus.
Table 4-15 License modeLicense Mode
License Redistribution
Application Scenario
Role
Operation
Global permanent
Not supported
On-premises scenario
System administrator
Import license files of iMaster NCE-Campus and iMaster NCE-CampusInsight.
MSP administrator
View the license information.
Tenant administrator
View the license information.
Global subscription
Disabled
MSP-owned cloud scenario (MSP administrators do not need to centrally manage licenses.)
System administrator
- Select Global Subscription License and set License Redistribution to No upon the first login to iMaster NCE-Campus.
- Import license files of iMaster NCE-Campus and iMaster NCE-CampusInsight.
MSP administrator
N/A
Tenant administrator
N/A
Enabled
MSP-owned cloud scenario (MSP administrators need to centrally manage licenses.)
System administrator
- Select Global Subscription License and set License Redistribution to Yes upon the first login to iMaster NCE-Campus.
- Import license files of iMaster NCE-Campus and iMaster NCE-CampusInsight.
- Configure license packages of iMaster NCE-Campus and iMaster NCE-CampusInsight, and allocate them to MSP administrators.
MSP administrator
Distribute licenses to tenant administrators.
Tenant administrator
View the license information.
Tenant subscription
Disabled
Huawei public cloud Scenario (MSP administrators do not need to centrally manage tenant licenses.)
System administrator
Disable the license split function when creating an MSP administrator.
MSP administrator
Apply for license activation codes from the Electronic Software Delivery Platform (ESDP).
Tenant administrator
Purchase license activation codes from MSPs, and import the codes to iMaster NCE-Campus and iMaster NCE-CampusInsight.
Enabled
Huawei public cloud Scenario (MSP administrators need to centrally manage tenant licenses.)
System administrator
Enable the license split function when creating an MSP administrator.
MSP administrator
Apply for license activation codes from the ESDP, and import the codes to iMaster NCE-Campus and iMaster NCE-CampusInsight.
Tenant administrator
View the license information.
Select the license mode based on the type of the license purchased according to service requirements. If you select Global Permanent Mode or Tenant Subscription Mode, click OK. If you select Global Subscription Mode, configure whether to allow a global subscription license to be redistributed again.
- Yes: The system administrator imports the license used by all tenants, assigns the license to an MSP. The MSP then allocates license resources to tenants in package mode.
- No: The system administrator imports the license used by all tenants, and the license cannot be redistributed.
Viewing Homepage Information
After logging in to iMaster NCE-Campus, system administrators can directly access the dashboard page to check the basic running status of the network.
Procedure
- Log in to iMaster NCE-Campus using a system administrator account.
- On the home page, you can view the number of online users (wireless access), number of connected devices, device statistics, number of MSPs, and number of tenants.
Device statistics displayed on the homepage is refreshed in real time. However, the number of connected devices is updated every hour.
Managing Licenses
Generally, a license file is encrypted using the equipment serial number (ESN) as the key. You can apply for a new license from the license management server through the Huawei technical support system.
License Mode |
License Redistribution |
Application Scenario |
Role |
Operation |
---|---|---|---|---|
Global permanent |
Not supported |
On-premises scenario |
System administrator |
Import license files of iMaster NCE-Campus and iMaster NCE-CampusInsight. |
MSP administrator |
View the license information. |
|||
Tenant administrator |
View the license information. |
|||
Global subscription |
Disabled |
MSP-owned cloud scenario (MSP administrators do not need to centrally manage licenses.) |
System administrator |
|
MSP administrator |
N/A |
|||
Tenant administrator |
N/A |
|||
Enabled |
MSP-owned cloud scenario (MSP administrators need to centrally manage licenses.) |
System administrator |
|
|
MSP administrator |
Distribute licenses to tenant administrators. |
|||
Tenant administrator |
View the license information. |
|||
Tenant subscription |
Disabled |
Huawei public cloud Scenario (MSP administrators do not need to centrally manage tenant licenses.) |
System administrator |
Disable the license split function when creating an MSP administrator. |
MSP administrator |
Apply for license activation codes from the Electronic Software Delivery Platform (ESDP). |
|||
Tenant administrator |
Purchase license activation codes from MSPs, and import the codes to iMaster NCE-Campus and iMaster NCE-CampusInsight. |
|||
Enabled |
Huawei public cloud Scenario (MSP administrators need to centrally manage tenant licenses.) |
System administrator |
Enable the license split function when creating an MSP administrator. |
|
MSP administrator |
Apply for license activation codes from the ESDP, and import the codes to iMaster NCE-Campus and iMaster NCE-CampusInsight. |
|||
Tenant administrator |
View the license information. |
Obtaining License Files
Context
For commercial deployment with a contract, license files are generated based on the order. Onsite engineers obtain the licenses that are bound to ESNs, download the licenses, and load them on the system.
For a remote disaster recovery system. You only need to apply a license for the active iMaster NCE-WAN cluster. After the DR configuration is complete, the system automatically synchronizes the license to the standby iMaster NCE-WAN cluster.
Prerequisites
- You have obtained the authorization ID (LAC code), activation code, or project contract number.
- You have obtained the ESDP permission.
ESDP defines five roles: guest, carrier GTS, enterprise GTS, TAC, and channel. The following table describes the permissions and license application methods of the five roles:
Role
Permission
License Application Method
Guest
Can only download and activate commercial licenses by using authorization passwords.
- An end user can obtain the guest permission on the license website after applying for a Uniportal account on Huawei website.
- A Huawei employee can obtain the guest permission when accessing the license website through a W3 account.
Carrier GTS
Can perform the following operations on all commercial licenses and temporary licenses: activation and downloading, ESN change, and maintenance.
A Huawei employee can submit a carrier GTS application form on the license website.
Enterprise GTS
A Huawei employee can submit an enterprise GTS application form on the license website.
TAC
A Huawei employee can submit a TAC application form on the license website.
Channel
Can download, activate, and maintain all commercial licenses in the contracts and apply for temporary licenses.
The administrator of a certified channel needs to log in to the user management system of Huawei enterprise BG to apply for enhanced permission of license website for the employees of the channel.
Procedure
- Choose on the home page.
- Click Obtain ESN to obtain the ESN.
- Log in to the Huawei ESDP (https://app.huawei.com/sdp/portal.html) and choose License Activation > Entitlement Activation to access the License Activation page.
- On the page, search activation IDs based on the entitlement ID and select the desired ID.
- Click Next and enter the ESN of the desired server.
- Click Next and then Activate License.
- Click Download to download the license file.
Managing Licenses (Global Perpetual Mode)
Context
A permanent license defines the number of devices that can be added in a resource item. For example, if the resource item of AR100 series devices is 100, iMaster NCE-Campus allows to add a maximum of 100 AR100 series devices. If there are more than 100 devices, the excess AR100 series devices cannot be added to iMaster NCE-Campus.
In enterprise-built private cloud scenarios, the system administrator directly imports global permanent license files when constructing the cloud management platform. Tenants do not need to purchase the license activation code from the MSP.
- Coding mode: 8803 or 8806
- Within the validity period, Huawei provides the maintenance service. After the validity period ends, the services of iMaster NCE-Campus are still available, but Huawei no longer offers the maintenance service.
Example: SnS is a maintenance service, which is irrelevant to whether the license can be used. For example, after you purchase a computer, you can use it for life, while the warranty period of the computer's main board is only one year. The computer is equivalent to a permanent license, while the warranty period of the main board is equivalent to the SnS.
The system administrator can manage global permanent licenses only when the system administrator logs in to iMaster NCE-Campus for the first time and sets the license mode to Global Permanent Mode.
Prerequisites
The iMaster NCE-CampusInsight license file has been imported to iMaster NCE-Campus. Before interconnecting iMaster NCE-Campus to iMaster NCE-CampusInsight, you need to synchronize the iMaster NCE-CampusInsight license to iMaster NCE-Campus. For details, see Configuring Interconnection with iMaster NCE-CampusInsight.
Procedure
- Choose on the home page.
- To load a license file, click Upload License.
In the Select License File dialog box, select the obtained license file. License files of iMaster NCE-Campus and iMaster NCE-CampusInsight can be uploaded. If iMaster NCE-Campus is interconnected with iMaster NCE-CampusInsight, you can upload the iMaster NCE-CampusInsight license through iMaster NCE-Campus.
If the license fails to be loaded, the possible reasons are as follows:
- The license file signature is incorrect.
- The license file is tampered with.
- The license file type is incorrect.
- The license file size exceeds 50 KB.
- The license is invalid or has expired.
If the preceding errors occur, contact technical support engineers.
- Click OK. The license file is loaded successfully. Click
to view the detailed information about the loaded license file.
- After a license is loaded successfully, you can view the software ID for SnS charging and authentication.
- License expiration time recorded in the license file: indicates the expiration time of the license on iMaster NCE-Campus. After the license expires, it will become unavailable, for example, devices can no longer be managed by iMaster NCE-Campus.
- License SnS expiration time recorded in the license file: indicates the expiration time of SnS (maintenance service and remote technical support). After SnS expires, Huawei stops providing maintenance services and remote technical support.
- Click the License Information tab to view the license information.
- Select NCE-Campus from the Product name drop-down list to view the detailed information about controller licenses.
- Select CampusInsight from the Product name drop-down list to view the detailed information about iMaster NCE-CampusInsight licenses.
- Select NCE-Campus from the Product name drop-down list to view the detailed information about controller licenses.
Follow-up Procedure
- Revoking a license
When replacing the iMaster NCE-Campus server, you can revoke the license to ensure that the license can still be used on the new server.
Click Revoke License to revoke the commercial license on the old iMaster NCE-Campus server. A revocation code is generated. You can use the revocation code and the ESN of the new iMaster NCE-Campus server to apply for a new commercial license on ESDP. Then, all resources in the revoked license are available for use.
After you click
in the Operation column for the desired license file, the commercial license enters the grace period which lasts two months. If you do not load a new license before the grace period ends, the license is automatically disabled and all devices are forced offline.
- Removing a license
After you click
in the Operation column for the desired license file, iMaster NCE-Campus enters a license-unloaded state.
Only when no tenant under the system administrator has devices, you can remove the license.
Managing Licenses (Global Subscription Mode + License Redistribution Disabled)
Context
- Coding mode: 8806
- License consumption by time: After a license expires, iMaster NCE-Campus stops the license services.
- License form: Number of devices x Number of available days
- Example: The concept of subscription is similar to that of a monthly package. A customer purchases a 10 device-day license for the 8-port S5700-LI series switch. If there is one such switch, 10 days can be used; if there are two such switches, 5 days can be used, and so on. The total number of device-days of the license must be 10.
- Deduction time: The system deducts and settles license resources at 02:00 every day.
- Application scenario: MSP-built public cloud
For licenses that cannot be redistributed: The system administrator directly imports license files, and tenants do not need to purchase the license activation code from the MSP.
The system administrator can manage and redistribute global subscription licenses only after logging in to iMaster NCE-Campus for the first time and setting the license mode to Global Subscription Mode. If Global Subscription Mode is selected, set License Redistribution to No.
Procedure
- Choose on the home page.
- Click Upload License and load the license. If iMaster NCE-Campus interconnects with iMaster NCE-CampusInsight, you need to import the license files of both iMaster NCE-Campus and iMaster NCE-CampusInsight.
In the Select License File dialog box, select the obtained license and click OK.
If the license fails to be loaded, the possible causes are as follows:
- The license file signature is incorrect.
- The license file is tampered with.
- The license file type is incorrect.
- The license file size exceeds 50 KB.
- The license is invalid or has expired.
If the preceding errors occur, contact technical support personnel.
- Query license information.
- Check the license resources.
Statistics on the total license consumption can be collected by resource item.
- Check the daily consumption of license resources.
The daily consumption of license resources can be queried by date.
- View the license import record. Click
to view the detailed information about a license file.
After a license is loaded successfully, you can view the software ID for SnS charging and authentication.
- Check the license resources.
Follow-up Procedure
- Recalculate the expiration time.
Click Recalculate Expiration Time to set resource items with different expiration time to the same expiration time for easy management. This operation is irreversible.
The function of recalculating the expiration time can be used to integrate resources. For example, there are three types of license resource items, including AR100 series: 10 device-days with 5 yuan per device-day; AR1200 series: 20 device-days with 10 yuan per device-day; and indoor AP series: 20 device-days with 20 yuan per device-day. Assume that iMaster NCE-Campus manages 5 AR100 series devices and 10 AR1200 series devices. You can click Recalculate Expiration Time to integrate license resources. The formulas are as follows: 10 x 5 + 20 x 10 + 20 x 20 = 650, 5 x 5 + 10 x 10 = 125 (consumption of all devices in a day), 650/125 = 5 R 25 (remainder 25). Then the license resources of the AR100 and AR1200 series devices will expire in five days. The remaining 25 yuan will be added to the new license resource pool to be integrated in the next calculation.
This function enables resource allocation to be more flexible. Expired resources can be integrated so that they can be used normally.
- Click Expiration Notification, enable Receive expiration notification, and configure the email addresses of recipients. Notification emails will be sent to the specified email addresses when a license is about to expire.
- The system administrator must configure an email server before enabling Receive expiration notification. Otherwise, Receive expiration notification cannot be enabled. For details, see Configuring an Email Server.
- A maximum of five email addresses can be configured. Email addresses need to be separated with line breaks.
- If a license resource item is about to expire in less than 30 days, the system will send notification emails at 02:25 every day.
- If license expiration notification is configured, the license expiration email is sent only to the email addresses specified in Notified object. In this case, you are advised to specify the email address of the tenant administrator in Notified object.
- Export or send a license usage report.
- Export the license usage report. Click Export, and select CSV or HTML. The license usage report is exported into a CSV or HTML file.
- Configure the system to send the license usage report immediately. Click Send Email, and select Immediately. On the Send Immediately page that is displayed, click Add, configure the email address to which the report needs to be sent, select the report format (CSV or HTML), and click
. Set the fiscal year and date, and click OK. The license usage report is converted into an HTML or a CSV file and sent to the specified email address.
The sent report records the license usage data of last calendar month. For example, if you configure the system to send the license usage report in July, the report recording the license usage data of June is sent.
Before enabling Receive expiration notification, configure an email server. For details, see Configuring an Email Server.
- Configure the system to send the license usage report periodically. Click Send Email and select Periodically. On the Send Periodically page that is displayed, set Export enabling to
, specify the report name as well as the fiscal year and date, and click Add. Configure the email address to which the report needs to be sent, select the report format (CSV or HTML), and click
. Select the report sending time, and click OK. The license usage report is converted into an HTML or a CSV file and sent to the specified email address.
- Export the license usage report. Click Export, and select CSV or HTML. The license usage report is exported into a CSV or HTML file.
Managing Licenses (Global Subscription Mode+License Redistribution Enabled)
Context
- Coding mode: 8806
- License consumption by time: After a license expires, iMaster NCE-Campus stops the license services.
- License form: Number of devices x Number of available days
- Example: The concept of subscription is similar to that of a monthly package. A customer purchases a 10 device-day license for the 8-port S5700-LI series switch. If there is one such switch, 10 days can be used; if there are two such switches, 5 days can be used, and so on. The total number of device-days of the license must be 10.
- Deduction time: The system deducts and settles license resources at 02:00 every day.
- Application scenario: MSP-built public cloud
For licenses that can be redistributed: The system administrator can redistribute a license to an MSP administrator in package mode, and then the MSP administrator allocates license resources to tenants for refined license management.
The system administrator can manage and redistribute global subscription licenses only after logging in to iMaster NCE-Campus for the first time and setting the license mode to Global Subscription Mode. If Global Subscription Mode is selected, set License Redistribution to Yes.
By default, the system grants a one-year license resource for iMaster NCE-Campus and a 30,000 device-day subscription license resource. You need to purchase new license resources before the license expires to prevent service interruption.
Procedure
- Import the license file.
- Choose on the home page.
- Click Upload License and load the license. If iMaster NCE-Campus interconnects with iMaster NCE-CampusInsight, you need to import the license files of both iMaster NCE-Campus and iMaster NCE-CampusInsight.
In the Select License File dialog box, select the obtained license and click OK.
If the license fails to be loaded, the possible causes are as follows:
- The license file signature is incorrect.
- The license file is tampered with.
- The license file type is incorrect.
- The license file size exceeds 50 KB.
- The license is invalid or has expired.
If the preceding errors occur, contact technical support personnel.
- Query license information.
- Check the license resource control.
Statistics on the total license consumption can be collected by resource item.
- Check the daily consumption of license resources.
The daily consumption of license resources can be queried by date.
- View the license import record. Click
to view the detailed information about a license file.
After a license is loaded successfully, you can view the software ID for SnS charging and authentication.
- Check the license resource control.
- Configure a license package.
Click the License Package tab, click Create, select the device series contained in the license package, and click Apply.
If iMaster NCE-Campus interconnects with iMaster NCE-CampusInsight, you need to configure license packages of both iMaster NCE-Campus and iMaster NCE-CampusInsight.
- Allocate the package to the MSP.
- Click the MSP License tab. Click
on the left of the MSP administrator to view the license status and resource consumption of the MSP.
- Click Create, click
in the Package Name column to select a license package, and click OK.
- Configure the number of license resources (unit: device x day) and then click
. The license package is allocated to the MSP.
- (Optional) Click
to freeze the license package. The frozen license package cannot be redistributed or used. Click
to change the number of resources in the license package. Click
to delete an allocated package.
Freezing or deleting a license package will cause the related devices to go offline. Therefore, exercise caution when performing these operations.
- (Optional) Click Disable Strategy and set Unified deactivation time and Longest Arrears (days) of the license package.
The license will be deactivated either at the deactivation time set in Disable Strategy or the actual expiration time of the license, whichever is earlier.
- Click the MSP License tab. Click
- Log in to iMaster NCE-Campus as an MSP and allocate license resources to tenants. For details, see Activating and Allocating Licenses (Global Subscription Mode + Enable License Redistribution).
Follow-up Procedure
Click Recalculate Expiration Time to set resource items with different expiration time to the same expiration time for easy management. This operation is irreversible.
The function of recalculating the expiration time can be used to integrate resources. For example, there are three types of license resource items, including AR100 series: 10 device-days with 5 yuan per device-day; AR1200 series: 20 device-days with 10 yuan per device-day; and indoor AP series: 20 device-days with 20 yuan per device-day. Assume that iMaster NCE-Campus manages 5 AR100 series devices and 10 AR1200 series devices. You can click Recalculate Expiration Time to integrate license resources. The formulas are as follows: 10 x 5 + 20 x 10 + 20 x 20 = 650, 5 x 5 + 10 x 10 = 125 (consumption of all devices in a day), 650/125 = 5 R 25 (remainder 25). Then the license resources of the AR100 and AR1200 series devices will expire in five days. The remaining 25 yuan will be added to the new license resource pool to be integrated in the next calculation.
This function enables resource allocation to be more flexible. Expired resources can be integrated so that they can be used normally.
Managing User Accounts
Managing System Administrator Accounts
Context
By default, the admin user has all rights.
To ensure system security, the admin user can create multiple sub-accounts and assign different rights to each sub-account based on the account role.
Prerequisites
- Configure global account policies.
You can configure account policies to define the user name length and login rules to improve account security of iMaster NCE-Campus. Account policies have been configured on iMaster NCE-Campus by default and can be modified as required.
Choose
from the main menu. Click Account Policy to configure global account policies. - Configure global password policies.
A simple administrator password can be easily cracked. To prevent this problem, configure password policies that define the complexity requirements of iMaster NCE-Campus administrator passwords, the password change interval, and the character limitation. Password policies have been configured on iMaster NCE-Campus by default and can be modified as required.
Choose
from the main menu. Click Password Policy to set the global password policy.For security purposes, configure all password policies provided by iMaster NCE-Campus.
If PCI authentication is required, modify account and password policies as follows:- Enable Disable unused accounts, and set Maximum number of consecutive idles days of account to 90. An account is disabled if the account has not logged in to the system at all for more than 90 days.
- Set Invalid password monitoring period (min) to 30 in the Account Lockout Trigger Conditions area. In this case, if an account fails to log in to the system for five consecutive times within 30 minutes, the account is locked for 30 minutes.
- Set Number of historical passwords that cannot be reused to 4.
- Roles have been created.
If functional rights of existing roles in the system do not meet requirements, you can create new roles before creating accounts or workgroup.
Choose Role tab. Click Create, and select functional rights to create a role.
from the main menu, and click theBy default, a system administrator has following roles. These roles cannot be deleted or modified.
- System administrator: The system administrator has the right to manage the iMaster NCE-Campus servers. This includes monitoring clusters and configuring the mail server, SMS server, and GIS map.
- Operator: The operator manages system service running.
- Open API operator: The open API operator owns the privilege of open API services and configurations.
Procedure
- Choose from the main menu.
By default, the admin account is preset on iMaster NCE-Campus.
admin: System administrator. When the admin user adjusts the account policy, password policy, and idle timeout policy, the account policy of the admin user is changed accordingly. The admin account cannot be modified or deleted. After logging in to iMaster NCE-Campus as the system administrator for the first time, change the initial password as prompted.
The default username and password are available in iMaster NCE-Campus Default Usernames and Passwords (Enterprise Network or Carrier). If you have not obtained the access permission of the document, see Help on the website to find out how to obtain it.
- Click Create, and set parameters on the Create User page.
For security purposes, keep the password secure and change it periodically.
- Manually configure a password when creating a user account.
Set Password create mode to Manual and then set a password for the account. If Modify password first login is set to Yes, the user will be prompted to change the password when using this account to log in to iMaster NCE-Campus for the first time, and can successfully log in after changing the password.
- Configure a password via email.
Set Password create mode to Email. After the account is created, the system sends a URL to your email box. You can click the URL to configure a password for the user account.
- If you choose to configure a password via email, configure an email server before creating an account. Otherwise, the system fails to send a URL to the specified email address. For details, see Configuring an Email Server
- If the password for a user account is configured via email, the user does not need to change the password upon the first login to iMaster NCE-Campus.
Parameter
Description
Account
Login account of a newly created administrator.
User type
- LOCAL: Local users can log in to iMaster NCE-Campus only from the web UI.
- THIRD-PARTY SYSTEM ACCESS: A third-party system access user calls the northbound API /controller/v2/tokens to log in to iMaster NCE-Campus.NOTE:
- If the user type is Third-party system access, the user can log in to iMaster NCE-Campus only by API call.
- If the user type is Local, the user can log in to iMaster NCE-Campus only from the web portal.
- In an upgrade scenario, the user type is changed from Local or Third-party system access to Both. When the user type is Both, the user can log in to iMaster NCE-Campus either by API call or from the web portal.
Password create mode
Mode in which a password is created. The options are Manual and Email.
Password
Initial login password of the newly created administrator.
NOTE:- This parameter is displayed only when User Type is Local.
- If the password creation mode is set to Email, you must enter a valid email address. After the account is created, the system sends a link to the mailbox. You need to click the link to configure the account and password.
- In this mode, you do not need to change the password when you log in to iMaster NCE-Campus for the first time.
Confirm password
Modify password first login
Whether to change the password upon first time login.
Mobile number
Phone number of an administrator, which is provided for easy and prompt contact by MSPs under the administrator.
The email address can be used for password retrieval, receiving messages sent from the controller, and other purposes. Ensure that the mobile number is correct.
Email address
Email address of an administrator, which is provided for easy and prompt contact by MSPs under the administrator.
The email address can be used for password retrieval, receiving messages sent from the controller, and other purposes. Ensure that the email address is correct.
Role
Selected the role from the drop-down list.
- Manually configure a password when creating a user account.
- Click Next.
- On the Managed Object page that is displayed, select the accounts to be managed by the system administrator, and click Next. By default, Select All Resources is disabled.
The Select all resources parameter is configurable only the admin user creates a sub-administrator account.
The created sub-account can create workgroups only when Select all resources is enabled.
- On the Access Control page that is displayed, click Create, set the allowed IP address range, and click OK.
After the IP address range is added, the account can use only an IP address within this range to log in to iMaster NCE-Campus. If no IP address range is added, the account can use any IP address to log in to iMaster NCE-Campus.
After logging in to iMaster NCE-Campus using this account, choose from the menu. Configure the IP address range on the Access Control page.
- Click OK.
Follow-up Procedure
- Modify the account information, reset the password, and disable/enable/ an account.
- Choose from the main menu.
- In the Operation column, click
to modify account information, click
to reset the password, and click
to disable the account. If the account has been disabled, click
to enable the account.
- Delete an account.
- Choose from the main menu.
- Select an account, and click Delete.
- Transfer workgroup administrator rights.
If the administrator of a workgroup is changed, an upper-level administrator can transfer the corresponding rights to another administrator.
Workgroup administrators can transfer their rights to the administrators created by themselves. Before transferring rights of a work administrator, ensure that the workgroup administrator has created an administrator account.
- This operation can only be performed on level-1 sub-workgroups of the workgroup to which the current user belongs and cannot be performed on the workgroups of level 2 or higher.
- If workgroup administrators remain online after their rights are transferred, they will be forced offline and has no rights.
- Choose User tab. from the main menu. Click the
- Click Select, select the desired workgroup, and click OK.
Select a desired account and click Hand Over to enable this account to become the new workgroup administrator.
The new account must be an administrator account created by the old workgroup administrator account.
If the
icon is moved to the right of the new administrator account, the rights are transferred successfully.
- Create a user group.
To create a user group, choose User Group tab, and click Create to create a user group.
from the main menu. Click theUser groups are used to interconnect iMaster NCE-Campus with third-party services, such as the Active Directory Federation Services (ADFS), NetIQ, LDAP server, AD server, and RADIUS server.
Click Next to select objects to be managed by user groups.
Only a user with administrator rights can configure user groups.
- Configure personal settings.
Personal settings improve iMaster NCE-Campus access security. This function applies only to the current user.
- Set the maximum number of concurrent online users.
- Choose from the menu.
- On the Basic Information page, click
and set Max. concurrent users. Click Apply. The value 0 indicates there is no limit on the maximum number of concurrent online users.
- Change the password.
- Choose from the menu.
- On the Basic Information page, click
next to the password. In the dialog box that is displayed, set a new password.
- Modify the login IP address range of the current account.
Click Access Control tab. On the Access Control page, set the IP address range and click Create. If no IP address range is set, there is no limit on the login IP address range of the current account.
- Set the maximum number of concurrent online users.
- Configure the idle timeout period.
To prevent unauthorized users from using the administrator account while the administrator is away, set the idle timeout time. If an administrator does not perform any operation within the specified period, the account will be automatically logged out. To perform further operations after the account is logged out, the administrator must log in to iMaster NCE-Campus again.
Choose Idle timeout setting, set the idle time, and click OK.
from the main menu, click - Check online user management information.
Choose Online user tab.
from the main menu, click - Check whether you have signed a privacy statement.
- Choose from the menu.
- On the Basic Information page, check whether you have signed the privacy statement.
- If Sign privacy statement is Not signed, you have not signed the privacy statement.
- If Sign privacy statement is Signed, you have signed the privacy statement.
- Withdraw a privacy statement.To withdraw your consent to this privacy statement, click Cancel next to Sign privacy statement and click OK in the Warning dialog box that is displayed.
You will be logged out if you withdraw the consent to the privacy statement. In addition, your mobile number and email address will be deleted from the controller. This may affect your login or password retrieval. Exercise caution when performing this operation.
Configuring System Administrator Account Authentication Mode
When a system administrator logs in to iMaster NCE-Campus, iMaster NCE-Campus will authenticate the administrator in the following modes:
- Local authentication: By default, iMaster NCE-Campus authenticates a system administrator in local authentication mode.
- If LDAP server authentication is required, iMaster NCE-Campus must be connected to an LADP server. For details, see Interconnection with an LDAP Authentication Server.
Choose from the main menu to configure the authentication mode.
Accounts on the LDAP server must be different from local accounts.
Interconnection with an LDAP Authentication Server
Members of an LDAP user group can log in to iMaster NCE-Campus through the LDAP authentication server.
General LDAP Mode
Obtaining an LDAP Certificate
To enable users on the LDAP server to log in to iMaster NCE-Campus you need to configure parameters for interconnection between iMaster NCE-Campus and the LDAP server.
Prerequisites
- The LDAP server must communicate with iMaster NCE-Campus.
If the LDAP server is connected to iMaster NCE-Campus through IPv6, you need to manually configure an IPv6 address that is on the same network segment as the IP address of iMaster NCE-Campus Service plane on the LDAP server.
- The LDAP server has been installed. The domain name has been configured, and a user and user group have been created.
A new user name cannot be the same as the iMaster NCE-Campus system account and cannot contain spaces or the following special characters: #%&'+|/();<=>?\. Otherwise, the new user cannot be identified by iMaster NCE-Campus and cannot log in to iMaster NCE-Campus.
Procedure
- Access the <LDAP server installation directory>\OpenLDAP\secure\certs directory.
- Edit the server.pem file and delete the RSA PRIVATE KEY content, that is, delete all content from -----BEGIN RSA PRIVATE KEY----- to -----END RSA PRIVATE KEY-----.
- Save the server.pem file to obtain the LDAP certificate server.pem.
Configuring iMaster NCE-Campus
Configuring iMaster NCE-Campus involves configuring the SSL connection certificate, LDAP interconnection parameters, and creating user groups and mapping rules.
Context
To use an LDAP account to log in to iMaster NCE-Campus, you need to connect iMaster NCE-Campus to the LDAP authentication server.
Prerequisites
An SSL certificate has been obtained.
Data Plan
The certificates imported using the iMaster NCE-Campus certificate management tool must meet the following requirements:
- The certificate name (including the file name extension) contains a maximum of 65 characters.
- Certificates in Base64-encoded X.509 v3 format are supported. Do not use certificates in DER-encoded binary format.
- The certificates must use the signature hash algorithm with higher security than SHA256.
- The certificates must use a signature algorithm with an RSA key longer than 2048 bits.
- The certificate validity period cannot be longer than 50 years or shorter than 90 days.
- The certificate effective date must be earlier than the current system date. Otherwise, an error message is displayed indicating that the certificate does not take effect.
- The certificate expiration date must be later than the current system date. Otherwise, an error message is displayed indicating that the certificate has expired.
- The file size must be greater than 0 KB and less than 50 KB.
- A maximum of 128 certificates can be uploaded.
Parameter |
Data (Example) |
Description |
|
---|---|---|---|
Authentication server configuration |
Server IP address type |
IPv4 |
IP address type of the LDAP server, IPv4 or IPv6. |
Server IP |
10.186.145.199 |
IP address of the LDAP server, which can be an IPv6 address. |
|
Server Port |
636 |
SSL is enabled for port 636 on the LDAP server. |
|
DN prefix |
uid= |
Characters prior to the user name in the DN of a login user. |
|
DN suffix |
ou=ab, ou=aaa_group, dc=AAA, dc=com |
Characters following the user name in the DN of a login user. |
|
User Name |
ldap_user |
Account created on the LDAP server. |
|
Password |
- |
Password of the account created on the LDAP server. Set the password as required. |
|
Creating a user group |
Name |
LDAPGroup1 |
Mapping user group on the LDAP server. |
Role |
Operator and auditor |
Multiple permissions can be selected for a user group. |
|
Creating a group mapping rule |
Rule Name |
rule1 |
Name of a user group mapping rule. |
Value |
GLDAPTest |
User group name created on the LDAP server. |
|
User group |
LDAPGroup1 |
Permissions to manage accounts on iMaster NCE-Campus. |
Procedure
- Import an LDAP server certificate.
- Choose from the main menu.
- Choose Service Certificate Management from the navigation pane. On the Services page, click AuthService-LDAP.
- Click the Trust Certificate tab and click Import. On the displayed page, enter the certificate information, select the desired LDAP server certificate, and click Submit to upload the certificate to iMaster NCE-Campus.
- Create a user group to be associated with the user group of the LDAP server.
- Choose . from the main menu
- Click the User Group tab, and click Create.
- Set user group information. For example, set the user group name to LDAPGroup1 and the role to System Administrator.
- Click Next. On the Managed Object page, authorize the tenant object. Select one or more MSP administrators from the Total list and click
to add the selected tenants to the Selected list.
- Click OK.
- Choose from the main menu.
- Set Authentication mode to LDAP. Then, set Mode to General LDAP in the Server Settings area, and set parameters for interconnection between iMaster NCE-Campus and the LDAP server.
You can select SSL encryption or no encryption for LDAP server authentication. For security purposes, use SSL encryption.
To enable SSL encryption, toggle on Enable SSL and select a certificate management policy.
- Create a user group mapping rule. Map the users on the LDAP server to the corresponding user group on iMaster NCE-Campus.
- Expand Advanced Settings, toggle on User-defined user group mapping rule, and click Create.
- Configure a user group mapping rule. All users in the user group GLDAPTest on the LDAP server are mapped to LDAPGroup1 on iMaster NCE-Campus. The users have the same permissions as the user group LDAPGroup1.
- Click OK.
- Click Test, set User Name and Password, and click Test.
- If the test is successful, close the Test window.
- If the test fails, rectify the fault accordingly.
- Click Apply to make the configuration take effect. A message is displayed indicating that the configuration is saved successfully.
After LDAP authentication is enabled, administrator users are authenticated locally whereas third-party system access users and remote users are authenticated on the LDAP server.
Local users cannot log in to iMaster NCE-Campus.
Configuration Verification
Log out the current tenant administrator account and log in to iMaster NCE-Campus using a member user account of the GLDAPTest user group on the LDAP server. If the login succeeds, the interconnection is successful.
To view a member user account in the GLDAPTest user group on the LDAP server, use the LDAP Admin account to connect to the LDAP server, right-click GLDAPTest, and right-click Properties.
Parameter Description
Parameter |
Description |
---|---|
Authentication Mode |
Select LDAP. |
Server IP address type |
IP address type of the LDAP server:
|
Server IP address |
IP address of the LDAP server. |
Server port |
By default, the SSL protocol is enabled on port 636 and disabled on port 389. |
Report server exception alarm |
Whether to report an alarm when the LDAP server is abnormal.
|
Enable SSL |
Whether to enable the SSL protocol when iMaster NCE-Campus connects to the LDAP server. By default, the SSL protocol is enabled. NOTE:
|
Mode |
Select General LDAP. |
DN prefix |
Example: cn= |
DN suffix |
Example: dc=example or dc=com. |
Base DN |
Base DN used by a user. |
Object class name |
Name of a user class in the corresponding LDAP server schema. |
Unique identifier |
Unique identifier, which identifies a user name. |
User country code attribute |
Attribute name used to identify the country code of a mobile number. |
User mobile number attribute |
Attribute name used to identify a mobile number. |
User mobile number format |
Attribute name used to identify a mobile number format. The default value is a mobile number without a country code. |
User group identifier |
User group identifier, which identifies the group to which a user belongs. |
Base DN |
Base DN used by a user group. |
Object class name |
Name of a user group class in the corresponding LDAP server schema. |
Unique identifier |
Attribute used to identify a user name. |
Member identifier |
Attribute name of a user group member. |
Delimiter |
Separator of user groups in the corresponding LDAP server schema. |
Authentication bypass |
After authentication bypass is enabled, the account and password of an LDAP user are saved on the local server. If the LDAP server is faulty, the LDAP user can log in to iMaster NCE-Campus by performing a local authentication. |
Parameter |
Description |
---|---|
User-defined user group mapping rule |
Rule to map an LDAP user group to one or more user groups on iMaster NCE-Campus. |
Rule name |
Name of a user group mapping rule. |
Description |
Description of the mapping rule. |
User group |
Mapping user group on the LDAP server. |
Value |
Name of the user group on the LDAP server. |
Windows AD Mode
Configuring iMaster NCE-Campus
Configuring iMaster NCE-Campus involves configuring the SSL connection certificate, AD interconnection parameters, and creating user groups and mapping rules.
Context
To use an AD account to log in to iMaster NCE-Campus, you need to connect iMaster NCE-Campus to the AD authentication server.
Prerequisites
An SSL certificate has been created or obtained.
Data Plan
The certificates imported using the iMaster NCE-Campus certificate management tool must meet the following requirements:
- The certificate name (including the file name extension) contains a maximum of 65 characters.
- Certificates in Base64-encoded X.509 v3 format are supported. Do not use certificates in DER-encoded binary format.
- The certificates must use the signature hash algorithm with higher security than SHA256.
- The certificates must use a signature algorithm with an RSA key longer than 2048 bits.
- The certificate validity period cannot be longer than 50 years or shorter than 90 days.
- The certificate effective date must be earlier than the current system date. Otherwise, an error message is displayed indicating that the certificate does not take effect.
- The certificate expiration date must be later than the current system date. Otherwise, an error message is displayed indicating that the certificate has expired.
- The file size must be greater than 0 KB and less than 50 KB.
- A maximum of 128 certificates can be uploaded.
Parameter |
Data (Example) |
Description |
|
---|---|---|---|
Authentication server configuration |
Server IP address type |
IPv4 |
IP address type of the AD server, IPv4 or IPv6. |
Server IP |
192.168.4.107 |
IP address of the AD server, which can be an IPv6 address. |
|
Server Port |
636 |
SSL is enabled for port 636 on the AD server. |
|
AD Domain Name |
Huawei.com |
Domain name for configuring the AD server. |
|
Base DN |
dc=Huawei,dc=com |
Base DN to be synchronized to CloudCampus@AC-Campus on the AD server. |
|
User Name |
ad_user |
Account created on the AD server. |
|
Password |
- |
Password of the account created on the AD server. Set the password as required. |
|
Creating a user group |
Name |
ADGroup1 |
Mapping user group on the AD server. |
Role |
Operator and auditor |
Multiple permissions can be selected for a user group. |
|
Creating a group mapping rule |
Rule Name |
rule1 |
Name of a user group mapping rule. |
Value |
GADTest |
User group name created on the AD server. |
|
User group |
ADGroup1 |
Permissions to manage accounts on CloudCampus@AC-Campus. |
Procedure
- Import the AD-LADP server certificate.
- Choose from the main menu.
- Choose Service Certificate Management from the navigation pane. On the Services page, click AuthService-LDAP.
- Click the Trust Certificate tab and click Import. On the displayed page, enter the certificate information, select the desired AD/LDAP server certificate, and click Submit to upload the certificate to iMaster NCE-Campus.
- Create a user group to be associated with the user group of the AD server.
- Choose . from the main menu
- Click the User Group tab, and click Create.
- Set user group information. For example, set the user group name to ADGroup1 and the role to System Administrator.
- Click Next. On the Managed Object page, authorize the tenant object. Select one or more MSP administrators from the Total list and click
to add the selected tenants to the Selected list.
- Click OK.
- Choose from the main menu.
- Set Authentication mode to LDAP. Then, set Mode to Windows AD in the Server Settings area, and configure parameters for interconnection between iMaster NCE-Campus and the AD server.
You can select SSL encryption or no encryption for AD server authentication. For security purposes, use SSL encryption.
To enable SSL encryption, toggle on Enable SSL and select a certificate management policy.
- Create a user group mapping rule. Map the user group on the AD server to the corresponding user group on iMaster NCE-Campus.
- Expand Advanced Settings, toggle on User-defined user group mapping rule, and click Create.
- Configure a user group mapping rule. All users in the user group GADTest on the AD server are mapped to ADGroup1 on iMaster NCE-Campus. The users have the same permissions as the user group ADGroup1.
- Click OK.
- Click Test, set User Name and Password, and click Test.
- If the test is successful, close the Test window.
- If the test fails, rectify the fault accordingly.
- Click Apply to make the configuration take effect. A message indicating that the configuration is saved is displayed.
Verification
Log out the current tenant administrator and log in to iMaster NCE-Campus using a member user account of the GADTest user group on the AD server. If the login succeeds, the interconnection is successful.
To view member user accounts in the GADTest user group on the AD server, use the LDAP Admin account to connect to the AD server, choose
on the AD server. Right-click GADTest and click Properties and Members in sequence.Parameter Description
Parameter |
Description |
---|---|
Authentication Mode |
Select LDAP. |
Server IP address type |
IP address type of the AD server:
|
Server IP address |
IP address of the AD server. |
Server port |
By default, the SSL protocol is enabled for port 636 and disabled for port 389. |
Report server exception alarm |
Whether to report an alarm when the AD server is abnormal.
|
Enable SSL |
Whether to enable the SSL protocol when iMaster NCE-Campus connects to the AD server. By default, the SSL protocol is enabled. NOTE:
|
Mode |
Select Windows AD. |
AD domain name |
Domain name for configuring the AD server. |
Base DN |
Base DN used by the user. |
Object class name |
Name of a user class in the corresponding LDAP server schema. |
Unique identifier |
Attribute used to identify a user name. |
User country code attribute |
Attribute name used to identify the country code of a mobile number. |
User mobile number attribute |
Attribute name used to identify a mobile number. |
User mobile number format |
Attribute name used to identify a mobile number format. The default value is a mobile number without a country code. |
User group identifier |
Attribute name of the group to which a user belongs. |
Base DN |
Base DN used by a user group. |
Object class name |
Name of a user group class in the corresponding LDAP server schema. |
Unique identifier |
Attribute used to identify a user group name. |
Member identifier |
Attribute name of a user group member. |
Delimiter |
Separator of user groups in the corresponding LDAP server schema. |
Authentication bypass |
After authentication bypass is enabled, the account and password of an LDAP user are saved on the local server. If the LDAP server is faulty, the LDAP user can log in to iMaster NCE-Campus by performing a local authentication. |
Parameter |
Description |
---|---|
User-defined user group mapping rule |
Rule to map an AD user group to one or more user groups in iMaster NCE-Campus. |
Rule name |
Name of a user group mapping rule. |
Description |
Description of the mapping rule. |
User group |
Mapping user group on the AD server. |
Value |
Name of the user group on the AD server. |
Configuring a Workgroup
Context
The sub-accounts and user roles created by the administrator are not isolated. Horizontal unauthorized operations may be performed, which brings security risks.
For example, the default root administrator account, who has the highest rights, creates account A and account B, and assigns the accounts to subordinate departments or partners, respectively. If both account A and account B have the account management and role management rights, account A and account B can modify and delete accounts and roles of each other.
To prevent horizontal unauthorized operations, you can configure a workgroup to isolate accounts and user roles created by administrators. Workgroups are configured a hierarchical tree structure, that is, upper-level workgroups grant rights to lower-level workgroups. Users in a workgroup can maintain accounts and roles in their own workgroup along with lower-level workgroups. Among workgroups at the same level, account permissions are isolated and data is invisible to each other.
To prevent horizontal unauthorized operations, the default root administrator can assign workgroup administrator accounts, instead of sub-accounts, to subordinate departments or branches.
- A maximum of five levels of workgroups can be created.
- Only the administrator of father workgroup can create sub-workgroups.
- The current user can configure an account policy and a password policy and set idle timeout settings only for the workgroup to which the user belongs but not for the sub-workgroups of the workgroup.
Procedure
- Log in to iMaster NCE-Campus as the system administrator, choose , click Create, set workgroup parameters, and click Next.Table 4-23 Basic information about a workgroup
Parameter
Description
Workgroup name
Name of a workgroup, which identifies the purpose of the workgroup.
Number of users
Number of administrator accounts in a workgroup, including administrator accounts in the sub-workgroups of the workgroup.
Number of workgroups
Number of sub-workgroups that can be created in a workgroup.
Description
Workgroup description.
Role
User roles of a workgroup administrator.
- By default, workgroup supports the following roles: System administrator, Operator, and Open API operator.
The operation rights of these roles are:
- System administrator: The system administrator has the right to manage the iMaster NCE-Campus servers. This includes monitoring clusters and configuring the mail server, SMS Server, and GIS map.
- Operator: The operator manages system service running.
- Open API operator: The open API operator owns the privilege of open API services and configurations.
- When creating a workgroup, you need to use the administrator account to create role. Otherwise, Role cannot be selected when a sub workgroup is created for the workgroup.
- By default, workgroup supports the following roles: System administrator, Operator, and Open API operator.
- Configure the workgroup administrator and click Next.
For security purposes, keep the password secure and change it periodically.
- Manually set a password when creating a user account.
Set Password create mode to Manual. Then you can directly set a password when creating the account.
- Create a password via email.
Set Password create mode to Email. After the account is created, the system sends a URL to your email box. You can click the URL to configure a password for the account.
- If you choose to create a password via email, configure an email server before creating an account. Otherwise, the system fails to send a URL to the specified email address. For details, see Configuring an Email Server
- If a password is created via email, you do not need to change the password upon the first login to iMaster NCE-Campus.
- Manually set a password when creating a user account.
- Select managed objects, that is, the MSP administrators that can be managed by the workgroup, and then click OK.
- Log in to iMaster NCE-Campus as the workgroup administrator.
Follow-up Procedure
- Modify a workgroup.
- Log in to iMaster NCE-Campus using the system administrator and choose from the main menu.
- Click
in the Operation column in the row of the target workgroup to modify the workgroup.
You can modify only the level-1 sub-workgroups of the current user and cannot modify the workgroup to which the current user belongs or the workgroups of level 2 or higher.
- Delete a workgroup.
- Log in to iMaster NCE-Campus as the system administrator and choose from the main menu.
- Select the target workgroup and click Delete.
- Only sub-workgroups can be deleted, and the workgroup to which the current user belongs cannot be deleted.
- Deleting a workgroup will delete information about sub-workgroups at all levels, as well as users, roles, and user groups of the workgroup.
- Deleting a workgroup is a risky operation. Exercise caution when performing this operation.
- Transfer workgroup administrator rights.
If the administrator of a workgroup is changed, an upper-level administrator can transfer the corresponding rights to another administrator.
Workgroup administrators can transfer their rights to the administrators created by themselves. Before transferring rights of a work administrator, ensure that the workgroup administrator has created an administrator account.
- This operation can only be performed on level-1 sub-workgroups of the workgroup to which the current user belongs and cannot be performed on the workgroups of level 2 or higher.
- If workgroup administrators remain online after their rights are transferred, they will be forced offline and has no rights.
- Choose User tab. from the main menu. Click the
- Click Select, select the desired workgroup, and click OK.
Select a desired account and click Hand Over to enable this account to become the new workgroup administrator.
The new account must be an administrator account created by the old workgroup administrator account.
If the
icon is moved to the right of the new administrator account, the rights are transferred successfully.
Managing Privacy Statements
Context
When the system administrator creates an MSP administrator, the system collects information such as the email address and mobile number of the user, notifies the user that the information has been obtained, and asks for the user's authorization.
You can manage privacy statements online. For example, you can create, delete, modify, and query a privacy statement, query the privacy statement list, or publish a privacy statement as required.
By default, the privacy statement function is enabled on iMaster NCE-Campus. If this function is not required, you can disable it on the management plane. Privacy statements will become unavailable after this function is disabled. To disable the privacy statement function, perform the following steps:
- Log in to the management plane.
- Choose from the main menu, choose , set
supportSignPrivacystatement(supportSignPrivacystatement, use 'ON', or 'OFF to OFF), and click OK
.
- Click
to check whether the configuration is successful.
Prerequisites
The administrator has the permission to create, release, modify, and delete a privacy statement.
Procedure
- Choose . from the main menu
- Click Create. On the Create Privacy Statement page, set the name, version, and content of the privacy statement.
A privacy statement can be in the draft or released state. A privacy statement in the released state cannot be released again.
- Click OK. The privacy statement is created.
- Click
in the Operation column of the desired privacy statement. In the Warning dialog box that is displayed, click OK to release the latest privacy statement.
If a privacy statement with the same name has been published, set the version number to a value greater than that of the published one.
Related Operations
Operation |
Operation Procedure |
---|---|
Viewing a privacy statement |
Click |
Modifying a privacy statement |
Click NOTE:
A privacy statement can be in the draft or released state. A privacy statement in the released state cannot be modified. To update a released privacy statement, you need to create a privacy statement with the same name of a later version. |
Deleting a privacy statement |
|
Follow-up Procedure
When creating an MSP administrator, the system administrator configures that the MSP administrator has to sign the privacy statement.
- MSPs for which a privacy statement has been configured must sign the privacy statement as prompted when they log in to iMaster NCE-Campus. Otherwise, the login will fail.
- After a privacy statement is in released state, the privacy statement version of the MSP who is using the privacy statement with the same name will change to the latest version. When the MSP logs in to the system, the MSP needs to sign the latest privacy statement.
Creating an MSP and the MSP Administrator
Context
A system administrator does not directly provide services to tenants. Instead, an MSP provides services to tenants. Therefore, you need to create an MSP and the MSP administrator first. The MSP is responsible for providing cloud managed devices and cloud network services to tenants. After a tenant applies for managed services from an MSP, the MSP can use iMaster NCE-Campus to query the device status and maintain devices on the tenant network.
Prerequisite
- You can set the authentication mode to Username/Password or Username/Password + SMS verification code when you log in to iMaster NCE-Campus as an MSP administrator. If SMS two-factor authentication is required, configure an SMS server in advance according to Configuring an SMS Server.
- A privacy statement has been created. For details, see Managing Privacy Statements. MSP administrators for which a privacy statement has been configured must sign the privacy statement as prompted when they log in to iMaster NCE-CampusiMaster NCE-WAN. Otherwise, the login will fail.
Procedure
- Log in to iMaster NCE-Campus as the system administrator.
- Access the MSP Management menu.
Choose
. - Click Create.
- On the MSP Information tab page, configure MSP information. If the authentication mode is set to Username/Password + SMS verification code, set the mobile number for receiving SMS messages. You need to create a privacy statement in advance. For details, see Managing Privacy Statements. MSP administrators for which a privacy statement has been configured must sign the privacy statement as prompted when they log in to iMaster NCE-Campus. Otherwise, the login will fail.
If Username/Password + SMS verification code is configured, the SMS verification code must meet the following requirements:
- The validity period of a verification code is 5 minutes. If the validity period exceeds 5 minutes, you need to obtain a new verification code.
- You cannot obtain a verification code multiple times within 1 minute. After 1 minute, you can click the verification code button again to resend a verification code SMS message. The previous verification code automatically becomes invalid.
- The function of obtaining verification codes is locked for 10 minutes after five consecutive attempts.
- If you enter an incorrect verification code for three consecutive times, the verification code becomes invalid and you need to obtain a new one.
When the system administrator logs in to iMaster NCE-Campus for the first time, the Split licenses function takes effect only after the license mode is set to Tenant Subscription Mode.
To allow the MSP administrator to uniformly manage and allocate tenant license resources, enable Split licenses. The MSP administrator then can activate a license and allocates license resources to tenants after logging in to iMaster NCE-Campus. The tenants do not need to activate licenses by themselves.
To allow tenants to activate licenses by themselves, disable Split licenses. After logging in to iMaster NCE-Campus, tenants can activate their own licenses.
- Click Next.
- On the Administrator Information page, configure administrator information.
For security purposes, keep the password secure and change it periodically.
- Manually set a password when creating a user account.
Set Password create mode to Manual. Then you can directly set a password when creating the account. You will be prompted to change the password when logging in to iMaster NCE-Campus for the first time. You can log in only after the password is changed successfully.
- Create a password via email.
Set Password create mode to Email. After the account is created, the system sends a URL to your email box. You can click the URL to configure a password for the account.
- If you choose to create a password via email, configure an email server before creating an account. Otherwise, the system fails to send a URL to the specified email address. For details, see Configuring an Email Server
- If a password is created via email, you do not need to change the password upon the first login to iMaster NCE-Campus.
- Manually set a password when creating a user account.
- Click OK.
Follow-up Procedure
Operation |
Procedure |
---|---|
Modifying information about an MSP administrator |
Click |
Deleting an MSP administrator |
Click NOTE:
If the MSP administrator has created one or more tenants, the MSP administrator account cannot be deleted. To delete an MSP administrator account, delete the tenants created by this account first. |
Viewing the privacy statement signed by an MSP administrator |
If an MSP administrator has signed the privacy statement, click |
Parameter Description
Parameter |
Description |
|
---|---|---|
MSP Information |
MSP name |
MSP name. |
Number of administrator accounts |
Maximum number of administrator accounts of the MSP. |
|
Number of workgroups |
Maximum number of workgroups of the MSP. |
|
Postal code |
Postal code of an MSP administrator, which is provided for easy contact by tenants under the MSP. |
|
Address |
Postal address of an MSP administrator, which is provided for easy contact by tenants under the MSP. |
|
Service mailbox |
Email address of an MSP administrator, which is provided for easy and prompt contact by tenants under the MSP. The email address must be valid. |
|
Service phone number |
Phone number of an MSP administrator, which is provided for easy and prompt contact by tenants under the MSP. The phone number must be valid. |
|
Login authentication mode |
Authentication mode for MSP administrator login. Username/Password: You only need to enter the account and password upon login. After the account and password are verified, the login succeeds. Username/Password + SMS verification code: After you enter the account and password upon login, the SMS verification page is displayed. The login succeeds only after you pass the SMS verification. |
|
Privacy statement |
Privacy statement configured for an MSP administrator. When the system administrator creates an MSP administrator, the system administrator needs to enter user information such as the email address and mobile number, and creates a privacy statement for the user to sign. The privacy statement notifies the user that the information has been obtained and asks for the user's authorization. For details, see Managing Privacy Statements. |
|
Administrator Information |
Account |
Account used by an MSP administrator to log in to iMaster NCE-Campus. The account must be in the format of an email address, for example, xxx@xxx.com. You are advised to ask for an account from the MSP or apply for a valid email address and assign this email address to the MSP administrator. |
Password create mode |
Mode in which a password is created. The options are Manual and Email. |
|
Password |
Initial password used by an MSP administrator to log in to iMaster NCE-Campus for the first time. The initial password must be changed upon the first login. By default, a password can contain 10 to 128 uppercase and lowercase letters, digits, and special characters, but cannot contain the account name or its reverse. At most two consecutive repeats are allowed for a character in the password. |
|
Confirm password |
Confirm password, which must be identical to that of Password. |
|
Email address used for password retrieval, message pushing, and other purposes. The email address must be valid. |
||
Mobile number |
Used for two-factor authentication. NOTE:
This parameter is configurable only when the authentication mode is set to Username/Password + SMS verification code. |
|
Area |
Country or area to which an MSP administrator belongs. |
Migrating Tenants
Context
Based on service requirements, the tenants and tenant services under an MSP administrator can be transferred to other MSP administrators for management.
Tenant migration involves tenant network security and must be confirmed and approved by tenants.
Tenants created by an MSP administrator enabled with the license split function cannot be transferred to another MSP administrator.
Procedure
- Choose from the main menu.
- Select the current MSP, the tenant administrator account to be transferred, and the new MSP administrator, and click Apply.
- In the High Risk dialog box that is displayed, select Confirmed, and click OK.
- Check whether the account is successfully migrated.
Log in to iMaster NCE-Campus as the new MSP administrator. The new account information is displayed on the page.
Modifying User Account Information
Modifying the User Password and Access Control Settings
On iMaster NCE-Campus, you can change the user passwords and access control settings. After first login to iMaster NCE-Campus, you need to change the default password to ensure security of iMaster NCE-Campus. Regularly changing the password can prevent malicious password theft and protect the system against unauthorized intrusion.
Remaining a password unchanged for a long period of time increases the risk of being stolen or cracked. Regularly changing the password effectively resolves this problem and is therefore strongly recommended.
Prerequisites
You have logged in to iMaster NCE-Campus.
Procedure
- Change the default password.
You will be redirected to the password change page when you log in to iMaster NCE-Campus for the first time.
- On the Change Password page, enter the old password and a new password, and confirm the new password.
- Click Apply.
- Change the old password.
- Choose from the main menu.
- On the Basic Information page, click
next to the password. In the dialog box that is displayed, set a new password.
- Click OK.
- Modify the login IP address range of the current account.
- Choose from the main menu.
- Click Access Control tab. On the Access Control page, set the IP address range. If no IP address range is set, there is no limit on the login IP address range of the current account.
- Click OK.
Setting and Verifying the Email Address
Prerequisites
The administrator has correctly configured the email server. For details, see Configuring an Email Server.
Procedure
- Choose from the main menu.
- Configure and verify an email address.
- If no email address is configured during account creation, you can specify an email address for the account. Click
next to Email address. In the dialog box that is displayed, configure an email address, and then click Obtain Verification Code.
- If an email address has been set during account creation, you must verify the email address. Click Verify next to Email address. In the dialog box that is displayed, enter the configured email address, and then click Obtain Verification Code.
- A verification code will be valid for 10 minutes. If you do not enter the verification code within 10 minutes, you need to obtain a new one.
- For security purposes, do not disclose the verification code.
- If no email address is configured during account creation, you can specify an email address for the account. Click
- Log in to the mailbox to obtain the verification code. Enter the code in Email verification code, and then click OK.
Configuring Two-Factor Authentication (via User Name+Password and SMS)
Two-factor authentication (2FA) is a security check process. It strengthens security by requiring two identity credentials to verify user identity before granting access to the system. 2FA secures user logins from attackers exploiting weak or stolen passwords. In addition, login notifications can also warn users of unauthorized access to their accounts.
Context
- Configure a mobile number. After logging in to iMaster NCE-Campus, you need to bind a mobile number to your account. After you enter a mobile number, iMaster NCE-Campus checks whether the format of the mobile number meets the requirements (1 to 20 digits) and verify that the mobile number is not bound to another account. If the mobile number meets the preceding requirements, you can apply for a verification code. The mobile number can be changed after being configured.
- Enable SMS verification upon login. After configuring a mobile number, you need to enable SMS verification upon login to implement 2FA. Before enabling SMS verification upon login, ensure that a mobile number has been configured.
When you attempt to obtain an SMS verification code, you may not receive any SMS message due to poor network signals or mobile phone issues. If this occurs, you can obtain a new verification code 1 minute later. A verification code will be valid for 5 minutes. If you obtain a new verification code before the current verification code expires for more than five consecutive times and the verification fails each time, your account will be locked for 10 minutes.
Prerequisites
An SMS server has been configured. For details, see Configuring an SMS Server.
Procedure
- Choose from the main menu.
- Click
next to Mobile number. In the dialog box that is displayed, complete the verification as prompted. Then the specified mobile number is bound to the current account.
- Click Modify next to SMS verification upon login. In the window that is displayed, enable SMS verification upon login and complete the verification using an SMS verification code.
Configuring a Date Format and a Time Zone for Administrator Clients
Context
By default, the time on a client is displayed according to the time zone of the server.
To display the time in the time zone where the client resides, you can change the time zone and date format on the client.
Prerequisites
You have logged in to iMaster NCE-Campus.
Procedure
- Choose Date and Time Zone Settings tab. from the main menu, and click the
- Set Date format and Client time zone, and click Apply.
- After the settings take effect, the date in the system is displayed in the configured format. The time on the client is displayed based on the configured time zone.
- The settings take effect only for the current user.
- (Optional) Click Default Settings to restore the date format and client time zone to the default values.
Configuring a Time Format for Administrator Clients
Prerequisites
You have logged in to iMaster NCE-Campus.
Procedure
- Choose Time Format Settings tab. from the main menu, and click the
- Set Date format, and click Apply.
- HH or hh indicates the hour, mm indicates the minute, ss indicates the second, and tt indicates the morning or afternoon.
- hh:mm:ss tt indicates the 12-hour format, and HH:mm:ss indicates the 24-hour format.
- The settings take effect only for the current user.
- (Optional) Click Default Settings to restore the time format to the default value.
Tenant Device Management
Managing the Device Whitelist
Context
Using the device whitelist function, you can control devices that can register with iMaster NCE-Campus based on the device ESNs.
After this function is enabled, devices whose ESNs are not in the whitelist are regarded as unauthorized devices.
- A tenant administrator can only add devices whose ESNs are in the whitelist to iMaster NCE-Campus.
- Unauthorized devices that have been added to iMaster NCE-Campus before the device whitelist function is enabled cannot go online after they go offline.
Procedure
- Choose from the main menu.
- Switch on Enable device whitelist.
- Add device ESNs to the device whitelist.
- Batch import device ESNs
Click Import. In the dialog box that is displayed, download the Excel template, enter device ESNs in the template, and import the template as prompted.
- Add device ESNs one by one
Click Create. In the dialog box that is displayed, click Add and add device ESNs one by one.
- Batch import device ESNs
You can click Export to export information about all unauthorized devices currently deployed on the network to a CSV file.
Viewing and Import device information
Context
A system administrator can check and maintain information about devices of all tenants.
Procedure
- Access the tenant device management page. Choose from the main menu.
- Set filter criteria, and view basic device information in a list. You can also delete and export tenant device information on demand.
- Click
in the Operation column to set the content to be displayed on the page.
- Export device information and download it to the local host.
- Select specified devices and click Export to export information about the selected devices.
- If you do not select any device and click Export, information about all devices will be exported.
- Select specified devices and click Export to export information about the selected devices.
Clearing a Device ESN and Deleting a Device
Context
If a tenant administrator finds that the device to be added has been used and the device cannot be either deleted or added, contact the system administrator to clear the ESN of the device. After the ESN of the device is cleared, the device can be added.
Prerequisites
When the system administrator clears the ESN of a device or deletes a device, the system will notify the tenant administrator who is using the device through an email.
To ensure that the email can be sent successfully, perform the following configurations.
- The MSP administrator has correctly configured the email server. For details, see Configuring an Email Server.
- When creating a tenant administrator, you must specify an email address. By default, the notification email is sent to the tenant administrator.
Procedure
- Access the tenant device management page. Choose from the main menu.
- Select a device, and click Clear ESN.
In the dialog box that is displayed, click Confirmed, and then click OK.
After the ESN of the device is cleared, the cloud AP and non-stacked switch are restored to factory settings and are disconnected from the iMaster NCE-Campus. For other devices, disconnect the device from the iMaster NCE-Campus. The system then notifies the tenant administrator who is using the device through an email.
- Select a device, and click Delete Device.
If the device has been added to the fabric, the device then cannot be deleted.
In the dialog box that is displayed, click Confirmed, and then click OK.
After the device is deleted, the device cannot be viewed on the system UI. The system then notifies the tenant administrator who is using the device through an email.
Configuring a BootROM Password Policy
Context
To ensure device security, you can disable tenants from changing device BootROM passwords.
Procedure
- Choose from the main menu.
- Disable The device BootROM password can be configured, view the warning information that is displayed, click OK, and click Apply.
After this function is disabled, tenants cannot set or change device BootROM passwords, and the BootROM passwords of all devices under tenants will be restored to their factory settings. Exercise caution when disabling this function.
System Setting
Viewing System Information
Context
System information can be viewed or configured through the web UI.
On the iMaster NCE-Campus web UI, you can quickly understand the iMaster NCE-Campus basic configuration, entity information, system information, and operating system information about the server where iMaster NCE-Campus is located.
Procedure
- View or modify iMaster NCE-Campus basic configuration.
- Choose from the main menu.
- View iMaster NCE-Campus basic configuration in the Basic Configuration area.
- Click
in the upper right corner to modify iMaster NCE-Campus basic configuration.
- Click Apply.
- View iMaster NCE-Campus entity information.
- Choose from the main menu.
- View iMaster NCE-Campus entity information in the Entity Information area.
- View iMaster NCE-Campus system information.
- Choose from the main menu.
- View iMaster NCE-Campus system information in the System Information area.
- View the operating system information about the server where iMaster NCE-Campus is located.
- Choose from the main menu.
- View the operating system information of the server where iMaster NCE-Campus is located in the OS Information area.
Parameter Description
Parameter |
Description |
---|---|
Hostname |
Host name of iMaster NCE-Campus. |
User Name |
User name of iMaster NCE-Campus. |
Location |
Location of iMaster NCE-Campus. |
Contact |
Vendor information about iMaster NCE-Campus. |
Parameter |
Description |
---|---|
Product Name |
Product name of iMaster NCE-Campus. |
Product Version |
Product version of iMaster NCE-Campus. |
Parameter |
Description |
---|---|
System Object ID |
System object ID of iMaster NCE-Campus. |
System Up Time |
Duration after iMaster NCE-Campus is started. |
System Description |
Version and property rights of iMaster NCE-Campus. |
Vendor Name |
Vendor name of iMaster NCE-Campus. |
Parameter |
Description |
---|---|
OS Version |
Version of the operating system. |
Kernel Release Number |
Kernel release number of the operating system. |
Kernel Version |
Kernel version of the operating system. |
Chip Type |
Type of the chip on the server where iMaster NCE-Campus is located. |
Setting the System Bulletin
Prerequisites
- iMaster NCE-Campus is working properly.
- The email server is working properly, if email notifications need to be sent.
Context
Users can configure upgrade and maintenance bulletins, which are available on the pages displayed before or after user login or are sent to all administrators including the system administrator, MSP administrator, and tenant administrator through emails.
- System administrators can release bulletins repeatedly. If an existing bulletin is modified, the old bulletin will be replaced by the new one.
- After email notification is enabled, the system will send only one email for each bulletin release.
Procedure
- Choose from the main menu.
- Set the bulletin lifetime, bulletin content, and email notification parameters.
- Click Apply.
After the bulletins are configured and take effect, refresh the page or log in to iMaster NCE-Campus again. Click
on the right of the page to view the bulletins.
Alternatively, you can log out of the system and view the bulletins on the login page.
Configuring Update Logs
Context
Information about iMaster NCE-Campus update logs in each version is pushed to users, which allows users to understand the new features in time and determine whether to deploy them.
Procedure
- Choose from the main menu.
- Click Create, set the version number and feature description, and click OK.
View the new features of each version, and modify or delete the new features.
- Log in to iMaster NCE-Campus as an MSP administrator or tenant administrator, click
on the right of the page, and choose Cloud Platform Update Log to view logs recording function updates on iMaster NCE-Campus.
Pushing New Feature Information
Context
Information about new features in each version is pushed to users, which allows users to understand the new features and determine whether to deploy them.
Procedure
- Choose from the main menu.
- Click the New Function Push tab, click Create, and set Title, Push image, Function Introduce, Start Time, and End time.
You can view the pushed information on the login page at the specified pushing time.
Configuring SSO
Context
Single sign-on (SSO) is a property of access control over multiple systems. With this property, a user logs in once and gains access to all systems without being prompted to log in again to each of them.
iMaster NCE-Campus integrates the authentication function of the SSO system and can function as the SSO server of the SSO system. In this case, users can log in to iMaster NCE-Campus through the Active Directory Federation Services (AD FS) or NetIQ.
In addition, users can log in to a third-party system through iMaster NCE-Campus. To enable this function, the trusted address of the access party (which is the desired third-party system) needs to be configured on iMaster NCE-Campus. After the trusted address passes the verification, users can log in to the third-party system through iMaster NCE-Campus.
Procedure
- Choose from the main menu.
- On the SSO Configuration page, click Create and configure the Security Assertion Markup Language (SAML) protocol and metadata.
Interconnect iMaster NCE-Campus with the AD FS or NetIQ to implement the SSO function using the AD FS or NetIQ as the SSO authentication server. After the configuration, users can log in to iMaster NCE-Campus using through the AD FS or NetIQ. For details, see Configuring Interconnection with AD FS and Configuring Interconnection with NetIQ.
- Click the SSO Server Configuration tab, click Create, and configure the trusted address of an access party.
This allows users to log in to the third-party system through iMaster NCE-Campus after its address is verified. A maximum of 256 trusted addresses can be configured. Currently, you can log in to iMaster NCE-CampusInsight through iMaster NCE-Campus. For details, see Configuring Interconnection with iMaster NCE-CampusInsight.
- On the SSO Configuration page, click Create and configure the Security Assertion Markup Language (SAML) protocol and metadata.
Alarm Management
Configuring Alarms or Events
You can set alarm or event rules to customize alarm or event monitoring policies, improving troubleshooting efficiency.
Configuring Severity and Type Redefinition Rules
You can redefine severities and types of alarms or events. For example, if an alarm or event is considered important, it can be set as a higher-severity alarm or event so that O&M personnel will give priority to it.
Prerequisites
You have the following operation permissions: Set Redefinition Rules.
Context
- A rule is valid only to the alarms or events reported after the rule is enabled.
- Severity and type changes of an alarm or event are not delivered to the NE. As a result, only the severity and type of the alarm or event displayed on the alarm or event interfaces can be modified, and those on the NE cannot be changed.
- After the severity or type of an alarm or event is redefined, the redefined severity and type are displayed in the alarm or event list. However, the original severity and type are still displayed during rule configuration.
- If multiple rules have been configured to redefine the severity and type of an alarm or event, the latest configured rule takes effect.
- A maximum of 1000 severity and type redefinition rules can be created.
- The procedure for creating an event severity and type redefinition rule is similar to that for creating an alarm severity and type redefinition rule. The following describes how to create an alarm severity and type redefinition rule. If you want to create an event severity and type redefinition rule, click Create and select Event Severity and Type Redefinition Rules on the Severity and Type page.
- By default, the rules are sorted by the enabled and disabled states, and the rules in the same state are sorted by update time in descending order.
Procedure
- On the service plane, choose from the main menu.
- In the navigation pane, choose Redefinition Rules > Severity and Type.
- On the Severity and Type page, click Create and select Alarm Severity and Type Redefinition Rules.
- In the Basic Information area, set the rule name, description, and whether to enable the rule.
- In the Alarms area, set the name, ID, and group name of the target alarm.
- In the Action area, set the alarm severity and type after redefinition.
- In the Alarm Sources area, select all alarm sources or custom alarm sources.
All alarm sources is available only for the users whose managed objects are All Objects.
- In the Filter area, set alarm parameters to filter the alarms to be redefined.
For example, if you want to filter alarms by location information, select Location Info and contains and enter alarm location information in the text box.
- In the Time Filter area, set the time and period for the rule to take effect as required.
By default, all options of Time Filter are deselected, that is, the rule takes effect at any time.
- Click OK.
Related Tasks
- Deleting a rule: You can select a redundant rule from the rule list and click Delete to reduce the rule maintenance workload.
- Enabling/disabling a rule: You can select a rule that is not used temporarily from the rule list and click Disable. To use a disabled rule, select the rule and click Enable.
- Migrating a rule: In the migration scenario, you can export rules from the source system and import them to the target system to complete rule migration.
- Collecting rule statistics and reviewing rules: You can export all rules to check whether the rules are configured properly. You can also collect statistics on rules based on the configurations.
The first row is not displayed in the exported .xls files. Do not modify the text in the first row. Otherwise, the import will fail.
Parameter Description
Item |
Parameter |
Description |
---|---|---|
Alarms |
Alarm name |
Name of an alarm. |
Alarm ID |
ID of an alarm. |
|
Group name |
Alarm group name, which is provided by NEs or devices that report alarms. |
|
Action |
New alarm severity |
The new severity after redefinition is displayed for the alarms that meet the rule. |
New alarm type |
The new type after redefinition is displayed for the alarms that meet the rule. |
|
Alarm Sources |
All alarm sources |
This rule takes effect for the alarms generated by all alarm sources. |
Custom alarm sources |
This rule takes effect only for the alarms generated by specified alarm sources. |
|
Filter |
Location Info, Alarm Source Type, and other parameters |
You can set restriction conditions for each parameter. |
Time Filter |
By period |
Time range within which the rule will take effect. By default, Server time is selected. If the time zones of the server, client, and NE are different, you can select Server time, Client time, or NE time to set the time range for the rule to take effect. |
By day |
Days on which the rule takes effect in a week. |
|
By time |
Period for the rule to take effect in a day. |
Configuring Name Redefinition Rules
If some alarm or event names are technical and difficult to understand, you can redefine alarm or event names as required by configuring name or event redefinition rules.
Prerequisites
You have the following operation permissions: Set Redefinition Rules
Context
- A rule is valid only to the alarms or events reported after the rule is enabled.
- Name modifications are not issued to the peer NE so that the name of the alarm or event on the peer NE cannot be modified.
- After the alarm or event name is redefined, the alarm or event name after redefinition is displayed when you select the alarm or event for configuring other rules. However, the original alarm or event name is still displayed when you configure the name redefinition rule.
- If multiple rules have been configured to redefine the name of an alarm, the latest configured rule takes effect.
- A maximum of 1000 name redefinition rules can be created.
- The procedure for creating an event name redefinition rule is similar to that for creating an alarm name redefinition rule. The following describes how to create an alarm name redefinition rule. If you want to create an event name redefinition rule, click Create and select Event Name Redefinition Rules on the Name page.
- By default, the rules are sorted by the enabled and disabled states, and the rules in the same state are sorted by update time in descending order.
Procedure
- On the service plane, choose from the main menu.
- In the navigation pane, choose Redefinition Rules > Name.
- On the Name page, click Create and select Alarm Name Redefinition Rules.
- In the Basic Information area, set the rule name, description, and whether to enable the rule.
- In the Alarms area, set the name, ID, and group name of the target alarm.
- In the Action area, enter the redefined name.
- Click OK.
Related Tasks
- Deleting a rule: You can select a redundant rule from the rule list and click Delete to reduce the rule maintenance workload.
- Enabling/disabling a rule: You can select a rule that is not used temporarily from the rule list and click Disable. To use a disabled rule, select the rule and click Enable.
- Migrating a rule: In the migration scenario, you can export rules from the source system and import them to the target system to complete rule migration.
- Collecting rule statistics and reviewing rules: You can export all rules to check whether the rules are configured properly. You can also collect statistics on rules based on the configurations.
The first row is not displayed in the exported .xls files. Do not modify the text in the first row. Otherwise, the import will fail.
Synchronizing Alarms
After a peer system is disconnected from iMaster NCE-Campus, alarms of the peer system cannot be reported to iMaster NCE-Campus. After the connection is restored, the alarms need to be synchronized with iMaster NCE-Campus.
Prerequisites
You have the following operation permissions: Synchronize Alarms
Context
In normal cases, Alarm Management automatically synchronizes alarm data from the peer system.
Procedure
- Choose from the main menu.
- In the navigation pane, choose Alarm Synchronization.
- On the Alarm Synchronization page, select alarm sources. For details about parameters of the synchronized object, see Table 4-31.
- Click Synchronize.
Configuring Correlation Rules
If an alarm causes other alarms, you can use the correlation rule to define the correlation between alarms. When O&M maintenance personnel monitor or view alarms, they can set a correlation rule to filter out correlative alarms and focus only on root alarms.
Prerequisites
You have the following operation permissions: Set Correlation Rules.
Context
- A rule is valid only to the alarms reported after the rule is enabled.
- A maximum of 1000 custom correlation rules can be created.
- The default correlation rules can be enabled or disabled, but cannot be modified or deleted.
- If the interval between the time when an alarm is generated and the time when the alarm arrives at the NMS is longer than 5 minutes, the alarm does not match the correlation rule even if the alarm meets the conditions.
- By default, the rules are sorted by the enabled and disabled states, and the rules in the same state are sorted by update time in descending order.
Procedure
- On the service plane, choose from the main menu.
- In the navigation pane, choose Correlation Rules.
- On the Correlation Rules page, click Default. On the tab page that is displayed, check whether a rule meeting requirements exists.
- Enable or disable default correlation rules.
On the Default tab page, enable or disable rules as required.
- Create a custom correlation rule.
- On the Correlation Rules page, click Custom and then click Create.
- In the Basic Information area, set the rule name, description, and whether to enable the rule.
- In the Alarms area, select root alarms and correlative alarms and set actions.
- Root alarms: Alarm that causes multiple correlative alarms.
- Correlative alarms: Alarm that is generated due to the root alarm.
- In the Conditions area, click Create to create a correlation rule between the root alarm and the correlative alarms.
- In the Other area, set the generation interval between the root alarms and their correlative alarms and the priority of the rule.
A correlation is true only if the generation interval between the root alarm and the correlative alarm is shorter than or equal to the specified period.
- Click OK.
Related Tasks
- Deleting a rule: You can select a redundant rule from the rule list and click Delete to reduce the rule maintenance workload.
- Enabling/disabling a rule: You can select a rule that is not used temporarily from the rule list and click Disable. To use a disabled rule, select the rule and click Enable.
- Migrating a rule: In the migration scenario, you can export rules from the source system and import them to the target system to complete rule migration.
- Collecting rule statistics and reviewing rules: You can export all rules to check whether the rules are configured properly. You can also collect statistics on rules based on the configurations.
The first row is not displayed in the exported .xls files. Do not modify the text in the first row. Otherwise, the import will fail.
Task Example
Scenario
When the connection of an NE is faulty, the NE reports alarm M periodically. At the same time, a large number of connection interruption alarms N are generated by this NE or other NEs because of the connection interruption. The type of alarm N is the same as that of alarm M. In this case, you only need to handle alarm M instead of alarm N. By setting a correlation rule, you can set the alarm N generated later than the alarm M to a correlative alarm.
Procedure
- On the Correlation Rules page, click Custom and then click Create.
- In the Basic Information area, enter the rule name.
- In the Alarms area, set Root alarms to alarm M and Correlative alarms to alarm N.
- In the Conditions area, click Create. Set the following condition: The occurrence time of alarm N is later than the occurrence time of alarm M.
- Click OK.
Result
When the occurrence time of alarm N is later than that of alarm M, alarm M is the root alarm of alarm N. In this case, choose Current Alarms from the main menu and open the Filter tab page. In the Advanced settings area, click Associated Alarm ID, and then set Operator to is in and Value to Normal alarms and Root alarms. After the query is started, the correlative alarm N is not displayed in the current alarm list. You only need to handle the root alarm M.
Parameter Description
Item |
Parameter |
Description |
---|---|---|
Alarms |
Root alarms |
Alarm that causes multiple correlative alarms. The following actions can be selected for the root alarms, which are the operations performed on the root alarms when the alarms that meet the conditions are reported.
|
Correlative alarms |
Alarms caused by the root alarm. The following actions can be selected for correlative alarms, which are the operations performed on correlative alarms when the alarms that meet the conditions are reported.
|
|
Conditions |
Including Location Info and Alarm Source Type |
You can set conditions for each parameter. |
Selection Mode |
Select a comparison mode.
|
|
Other |
Period |
Generation interval between the root alarm and its correlative alarms. A correlation is true only if the generation interval between the root alarm and the correlative alarm is shorter than or equal to the specified period. |
Priority |
Priority for a rule to take effect. |
Configuring Intermittent/Toggling Rules
After the intermittent/toggling rule is set, the alarms that last for a short period of time or are frequently reported can be discarded or displayed on the Masked Alarms page to reduce interference caused by repetitive alarms.
Prerequisites
You have the following operation permissions: Set Intermittent/Toggling Rules.
Context
- A rule is valid only to the alarms reported after the rule is enabled.
- Before setting rules, you need to understand the following concepts:
- Original alarm: The alarms that meet the conditions in the intermittent/toggling rules are original alarms.
- Intermittent policy: When the interval between alarm generation and alarm clearance is less than a specific period, the alarm is considered as an intermittent alarm. The period is called intermittent period.
- Toggling policy: When the number of times that an alarm (with the same alarm ID) is reported by the same alarm source in a specified period reaches the trigger condition, the toggling handling is started. You can set the action to generate a toggling alarm or avalanche alarm, or redefine the original alarm severity. When the number of times that the alarm is reported by the same alarm source in the specified period reaches the termination condition, the toggling handling is terminated.
- The system calculates and processes the alarms every 10 seconds based on the rule for handling intermittent alarms. If more than 1000 alarms are reported within 10 seconds, only the latest 1000 alarms are processed based on the rule for handling intermittent alarms. Other alarms are reported directly.
- If the interval between the time when an alarm is generated and the time when the alarm arrives at the NMS is longer than 10 minutes, the alarm does not match the intermittent/toggling rule even if the alarm meets the conditions.
- A maximum of 1000 intermittent/toggling rules can be created.
- By default, the rules are sorted by the enabled and disabled states, and the rules in the same state are sorted by update time in descending order.
Procedure
- Choose from the main menu.
- In the navigation pane, choose Intermittent/Toggling Rules.
- On the Intermittent/Toggling Rules page, click Create.
- In the Basic Information area, set the rule name, description, and whether to enable the rule.
- In the Conditions area, set the alarm severities, alarms, and alarm sources for the rule to take effect. Set advanced conditions to filter the alarms for the rule to take effect based on alarm parameters.
All alarm sources is available only when the user can manage all resources.
- In the Time Filter area, set the time and period for the rule to take effect as required.
By default, all options of Time Filter are deselected, that is, the rule takes effect at any time.
- In the Intermittent Policy and Toggling Policy areas, configure the policies.
- Intermittent Policy: Sets an intermittent period and action. For example, if the intermittent period is set to 30 and the policy action is set to Discard, the alarm is discarded when the interval between the generation and clearance of the alarm is less than 30 seconds.
- Period: If the interval between the alarm generation time and alarm clearance time is less than the set period, the alarm meets the intermittent policy.
- Action: The action for handling the alarm that meets the intermittent policy can be set to Discard or Show in Masked Alarms.
- Toggling Policy: Sets the toggling trigger condition, termination condition, and action.
- Trigger condition: If the time difference interval between the clearance and the next generation of an alarm is less than or equal to the threshold you set, a toggling is triggered.
- Termination condition: If the time difference interval between the clearance and the next generation of an alarm is greater than the threshold you set, the toggling is terminated.
- Handling policy: The action for handling the alarms that are generated during the toggling period can be set to Discard or Show in Masked Alarms.
- Intermittent Policy: Sets an intermittent period and action. For example, if the intermittent period is set to 30 and the policy action is set to Discard, the alarm is discarded when the interval between the generation and clearance of the alarm is less than 30 seconds.
- In the Other area, set the priority for the rule.
- Click OK.
Related Tasks
- Deleting a rule: You can select a redundant rule from the rule list and click Delete to reduce the rule maintenance workload.
- Enabling/disabling a rule: You can select a rule that is not used temporarily from the rule list and click Disable. To use a disabled rule, select the rule and click Enable.
- Migrating a rule: In the migration scenario, you can export rules from the source system and import them to the target system to complete rule migration.
- Collecting rule statistics and reviewing rules: You can export all rules to check whether the rules are configured properly. You can also collect statistics on rules based on the configurations.
The first row is not displayed in the exported .xls files. Do not modify the text in the first row. Otherwise, the import will fail.
Task Example
Scenario
A minor alarm M lasts for a short period of time or is reported frequently. The cause may be that an NE or service switches between the normal state and the abnormal state repeatedly. To reduce the interference of such alarms, you can set an intermittent/toggling rule to handle the alarms using the following policies:
- Intermittent policy: If alarm M is reported and cleared within 30 seconds, this alarm is discarded.
- Toggling policy: If the number of times that alarm M is generated within 60 seconds is greater than 2, the toggling handling is triggered. If the number of times that alarm M is generated within 60 seconds is less than or equal to 0, the toggling handling is terminated.
Procedure
- On the Intermittent/Toggling Rules page, click Create.
- In the Basic Information area, enter the rule name.
- In the Conditions area, select Designated alarms. Click Add Alarm and select M, which indicates that the intermittent/toggling rule is performed on alarm M.
- In the Analysis Type area, select Intermittent analysis and Toggling analysis.
- In the Intermittent Policy and Toggling Policy areas, configure the policies.
- Intermittent Policy: Set Period (s)(T) to 30 and Action to Discard.
- Togging Policy: Set Period (s) to 60 and Generated alarms to 2 for Trigger condition, Period (s) to 60 and Generated alarms to 0 for Termination condition, and Handling policy to Generate a toggling alarm and discard original alarms generated after toggling.
- Click OK.
Result
If alarm M is cleared within 30 seconds after being reported, it is discarded. If the M alarm is reported frequently, the original alarms generated after the toggling policy is triggered are discarded and a new toggling alarm is generated.
Configuring Auto Acknowledgement Rules
When the number of current alarms reaches the threshold, the system processes the full current alarm cache and moves current alarms to the historical alarm list. To prevent the important alarms in the full current alarm list from being processed, the system automatically acknowledges the current alarms in the cleared status based on an acknowledgement rule specified by users and converts them to historical alarms.
Prerequisites
You have the following operation permissions: Set Auto Acknowledgement Rules.
Context
- Auto acknowledgment rules take effect only for unacknowledged and cleared alarms. Alarms cleared before immediate acknowledgment is enabled are not affected.
- A maximum of 1000 auto acknowledgement rules are supported in the system. Four preset rules exist in the system and a maximum of 996 rules can be created.
- If an alarm complies with auto acknowledgement rules in both the delayed and immediate modes, the system acknowledges the alarm in immediate mode.
- By default, the rules are sorted by the enabled and disabled states, and the rules in the same state are sorted by update time in descending order.
Procedure
- On the O&M plane, choose from the main menu.
- In the navigation pane, choose Auto Acknowledgement Rules.
- In the auto acknowledgement rule list, the first four rules are preset for automatically acknowledging alarms by severity. Check whether the rules already meet the requirements.
- Enable an auto acknowledgment rule by alarm severity. For example, when the auto acknowledgement rule for major alarms is enabled, the cleared but unacknowledged major alarms will be acknowledged automatically.In the auto acknowledgment rule list, the first four rules are preset. Only users who can manage all resources can enable or disable these rules.
- Select the auto acknowledgment rule required based on the severity and click Enable.
- In the Mode column, view the acknowledgement mode of the rule.
- Immediate: Indicates that alarms will be automatically acknowledged immediately after being cleared.
- Delayed: Indicates that alarms will be automatically acknowledged based on the settings in the Change Delay area after being cleared.
- Create a custom auto acknowledgment rule.
- On the Auto Acknowledgement Rules page, click Create.
- In the Basic Information area, set the rule name, description, and whether to enable the rule.
- In the Conditions area, set the alarm severities, alarms, and alarm sources for the rule to take effect. Set advanced conditions to filter the alarms for the rule to take effect based on alarm parameters.
- By default, Designated alarms is deselected, that is, the rule takes effect for all alarms.
- All alarm sources is available only for the users who can manage all resources.
- In the Other area, set the acknowledgment mode for the rule.
- Click OK.
- Set parameters about the acknowledgment delay. If the acknowledgement mode is set to Delay, the system automatically acknowledges alarms based on the configuration in the Change Delay area.
- Click Change Delay and set Execute at and Duration.
Table 4-33 Change Delay parameters
Parameter
Description
Execute at
Time when an automatic alarm acknowledgment rule is executed on a daily basis.
Duration (days)
A cleared alarm can be automatically acknowledged only when it has not been acknowledged for a period longer than the duration you set.
- Click OK.
- Click Change Delay and set Execute at and Duration.
Setting Alarm or Event Name Groups
You can add multiple alarm or event names to a name group to perform operations on them at a time.
Context
- An alarm name group is a set of some alarm names. An event name group is a set of some event names.
- When you select alarm or event names, multiple alarms or events are selected when you select a name group.
- The procedure for creating an event name is similar to that for creating an alarm name group. The following describes how to create an alarm name group. If you want to create an event name group, click Create and select Event Name Group on the Alarm/Event Name Group page.
Procedure
- Choose from the main menu.
- In the navigation pane, choose Alarm/Event Name Group.
- On the Alarm/Event Name Group page, click Create and select Alarm Name Group.
- Set the name of the group.
- In the Members area, click Add Alarm and select the alarms to be added to the group.
- Click OK.
Personalized Monitoring
Alarm management provides multiple display modes or sound prompt rules for alarms and events. You can modify the rules of display mode and sound prompt as required to obtain the latest alarm or event information in different ways.
Setting Colors for Alarms or Events
You can set colors for alarms and events at different severities to easily browse the concerned alarms or events.
Context
- By default, the system provides four types of colors for alarms and events: Critical:
Major:
Minor:
Warning:
- The settings take effect immediately, and remain valid on other clients after the current user logs in to them. However, the settings are invalid for other users.
- After the colors for alarms or events at different severities are set, the alarm indicator colors and the colors in the Severity column of the alarm list or event list are displayed in the configured colors.
Procedure
- On the service plane, choose from the main menu.
- In the navigation pane, choose Personalization > Color Settings.
- On the Color Settings page, set the colors for alarm and events at different severities.
- Click OK.
Setting Alarm Display Modes
When you need to identify alarms in different states more conveniently, you can set the alarm display mode as required to quickly identify concerned alarms.
Context
- The settings take effect immediately, and remain valid on other clients after the current user logs in to them. However, the settings are invalid for other users.
- After the alarm display mode is set, the parameter in the Severity column in the alarm list or event list is displayed in the specified style. Alarms in different states are displayed in the specified background colors.
- The default background colors of the unacknowledged and uncleared alarms and acknowledged and uncleared alarms are white, and the default background colors of the unacknowledged and cleared alarms and acknowledged and cleared alarms are green.
Procedure
- On the service plane, choose from the main menu.
- In the navigation pane, choose Personalization > Alarm Display Mode.
- On the Alarm Display Mode page, set the mode and background colors for alarms and events in different states.
- Icon: Severity icon and parameter in the Severity column in the alarm list or event list. The colors of the severity icon are displayed by severity. The alarm background colors are displayed by state.
- Column background: In the alarm list or event list, the background colors of the parameters in the Severity column are displayed by severity. The alarm background colors are displayed by state.
- Row background: The background colors of the unacknowledged and uncleared alarms are displayed by severity, whereas the background colors of the alarms in other states are displayed by state. The alarm background colors are displayed by severity.
- Click OK.
Setting Alarm Sounds
You can set different alarm sounds for alarm at different severities or specify alarm sound for different alarm names to facilitate alarm monitoring. When an alarm is generated, the sound box on your PC produces a corresponding sound.
Context
- The settings take effect immediately, and remain valid on other clients after the current user logs in to them. However, the settings are invalid for other users.
- By default, four alarm sounds are provided: Critical/Sound by alarm name: Critical.mp3; Major: Major.mp3; Minor: Minor.mp3; Warning: Warning.mp3.
Procedure
- On the service plane, choose from the main menu.
- In the navigation pane, choose Personalization > Alarm Sounds.
- On the Alarm Sounds page, set different sounds for alarms at different severities.
- Click
to listen to the selected sound file.
- Click
. In the Custom Alarm Sound dialog box that is displayed, upload, view, or delete a custom alarm sound file.
- Click
and select the alarms for Sound by alarm name. A maximum of 20 alarms can be selected.
- Click
- Set Alarm Status for alarms at different severities for which the system will play sounds.When an alarm whose status is the specified one at the specified severity is reported or the status of an alarm changes to the specified status, the system plays the corresponding alarm sound.
The system can play sounds based on the alarm status only when the number of current alarms is greater than 50,000.
- Set the duration for playing the alarm sound. When an alarm is reported, the alarm sound is automatically stopped after the specified duration. When all the alarms at a severity with an alarm sound being played are cleared, the alarm sound is automatically stopped.
- Select whether to enable the sound setting. If the sound setting is disabled, the sound is not played when an alarm at the corresponding severity is reported.
- Click OK.
When an alarm meets both the Sound by alarm name rule and the severity (Critical, Major, Minor, or Warning) rule, and both the rules are enabled, the alarm sound set in the sound by alarm name rule is played for the alarm.
Setting Alarm Font Colors
You can set font colors for read and unread alarms to distinguish alarms.
Context
- The settings take effect immediately, and remain valid on other clients after the current user logs in to them. However, the settings are invalid for other users.
- The default font colors for read and unread alarms are black.
- The newly reported alarms are all unread alarms.
Procedure
- On the service plane, choose from the main menu.
- In the navigation pane, choose Personalization > Font Colors.
- Sets the font colors for read and unread alarms.
- Click OK.
Highlighting Alarms
If alarms at a severity are not handled within the specified period of time, that is, the alarm status remains unchanged, the alarms are highlighted in the alarm list according to the highlight settings.
Context
- By default, the function of highlighting alarms is disabled.
- The settings take effect immediately, and remain valid on other clients after the current user logs in to them. However, the settings are invalid for other users.
- The highlight function takes effect only for current alarms.
- In the alarm list, the font color of the alarms that meet the highlight conditions is
.
Procedure
- On the service plane, choose from the main menu.
- In the navigation pane, choose Personalization > Highlight.
- On the Highlight page, set Effective Time (min) and Alarm Status. After an alarm at the severity is generated, the alarm is highlighted if the duration of the alarm in the specified status is greater than or equal to the specified effective time.
- Select whether to enable the function of highlighting alarms at the corresponding severity.
- Click OK.
Monitoring and Viewing Alarms or Events
O&M personnel can monitor alarms and view alarm or event information in alarm management in real time.
Monitoring and Viewing Current Alarms
On the Current Alarms page, O&M personnel can view current alarms that are updated in real time to better understand the latest alarm information.
Context
- A maximum number of 50,000 alarms can be displayed on the Current Alarms page. A maximum of 50,000 alarms can be displayed on the Current Alarms page. When the number of alarms exceeds 50,000, the earliest 10% alarms become historical alarms.
- When you go to the Current Alarms page for the first time, alarms in the alarm list are sorted in descending order of Latest by default.
- The newly reported alarms are displayed in bold on the page.
- The background color of cleared alarms is green.
- You can only monitor and view alarms of authorized managed objects.
Procedure
- Monitoring alarms
- Choose from the main menu.
- Manage alarms based on the alarm monitoring methods listed in the following table.
Table 4-34 Alarm monitoring methods
Task
Task Description
Monitoring alarms through the alarm indicator in the upper right corner
In the upper right corner of the iMaster NCE-Campus homepage, the alarm indicators show the numbers of critical, major, minor, and warning alarms. You can click an alarm indicator to access the Current Alarms page and view alarm details.
Monitoring alarms using the alarm list
O&M personnel can monitor alarms reported by all NEs and systems on the Current Alarms page in real time. The page displays a maximum of 100,000 alarms.
Monitoring alarms using alarm indicators
The alarm indicators in the upper right corner of the Current Alarms page show the numbers of critical, major, minor, and warning alarms. You can click an alarm indicator to view alarm details.
Monitoring alarms using the statistics panel
Click
on the upper right corner of the Current Alarms page to view the alarm statistics charts. The statistical result is obtained based on the filtered alarms. By default, the Top 10 Alarms, Duration, Top 10 Alarm Sources, and Severity statistical charts are displayed on the statistics panel. If you want to view the Status statistical chart or adjust the display sequence of the charts, click
on the upper right corner of the statistics panel. In the upper right corner of each chart, select the chart to be displayed from the drop-down list menu. On the statistics panel, you can click any statistical result to quickly filter the alarms that meet the condition. If you close the statistics panel, the filter criteria selected on the panel are automatically deselected.
- Querying alarms
- Choose from the main menu.
- On the upper left corner of the Current Alarms page, click Filter, set filter criteria, and click OK to search for the alarms to be concerned about and handled.
- Click Save or Save As to save the current filter criteria as a filter template.
You can click Template Management on the upper left of the page to view all filter templates on the current page and select a filter template from the Quick Filter panel. Users with the system administrator role can manage templates saved by all users.
The following types of templates are provided:- Favorite: You can add the templates that you often use to your favorites.
- Custom: Filter templates customized by the current user, which can be shared to other users.
- Shared: Available filter templates shared by other users.
- Default: Default filter template.
- Other: Filter templates that are not shared by other users. These templates are visible only to users with the system administrator role.
The filter templates on the Current Alarms, Historical Alarms, Masked Alarms, and Events pages are independent from each other and cannot be shared.
- Export current alarms. Alarms can be exported to a .xlsx or .csv file. When the number of alarms to be exported exceeds 100,000, the file is compressed to a .zip package and then exported.
- Export some alarms: Select the alarms to be exported, click Export, and choose Selected.
- Export all alarms: Click Export and choose All.
Only the information about the alarm columns displayed on the page can be exported. You can click
in the upper right corner of the alarm list to set the alarm columns to be displayed.
Parameter Description
Alarm Filtering Bar
Parameter |
Description |
---|---|
Alarm name |
Selects the alarms to be queried. |
Alarm source |
Specifies the device or NE that generates an alarm. You can import or export the selected alarm sources when setting Specified alarm sources. If multiple alarm source conditions are set, the filtering result is the union of all the conditions. That is, all the alarms that meet any of the conditions are displayed on the page. |
Severity |
Indicates the alarm severities, including critical, major, minor, and warning. By default, all severities are selected. Select at least one alarm severity. |
Alarm status |
Indicates the alarm status, including the acknowledged and cleared status. This parameter is not displayed on the Masked Alarms page. |
First occurred/Last occurred |
Indicates the first occurrence time and the last occurrence time of an alarm. This parameter is displayed as Occurred in Masked Alarms and Historical Alarms, indicating the last occurrence time of an alarm. |
Advanced settings |
Indicates advanced settings of alarm filtering. You can set filter criteria to view the desired alarms. If multiple advanced setting conditions are set, the filtering result is the intersection of all the conditions. That is, the alarms that meet all the advanced setting conditions are displayed on the page. Operators (case-sensitive) are as follows:
To improve maintenance efficiency, you are advised to retain the default settings of Associated alarm ID, that is, Root alarms and Normal alarms are selected. This parameter is not displayed on the Masked Alarms and Historical Alarms pages. Meanings of the options:
|
Alarm Operation Bar
Table 4-36 describes the buttons on the alarm operation bar.
Button |
Description |
---|---|
Auto Refresh |
|
Combo Sorting |
Sorts alarms by multiple alarm fields. A maximum of four alarm fields can be set. |
Clear |
When the fault that triggers an alarm is rectified but the alarm is not cleared automatically, click Clear to manually clear the alarm. After the alarm is cleared, its status changes to Cleared. |
Acknowledge/Unacknowledge |
When an alarm is acknowledged, the alarm will be or has been handled. The alarm status then changes from unacknowledged to acknowledged. If engineer B wants to handle an alarm acknowledged by engineer A, engineer A can unacknowledge the alarm. When the alarm is unacknowledged, the alarm status changes from acknowledged to unacknowledged. |
Comment |
Comments of an alarm can be edited. |
Export |
Alarms can be exported to a .xlsx or .csv report. When the number of alarms to be exported exceeds 100,000, the report is compressed to a .zip package and then exported. |
Alarm List
Name |
Description |
---|---|
Alarm Serial Number |
Alarm SN. When an alarm is generated, it may be modified multiple times. For example, its severity may change or it may be cleared. The SN uniquely identifies an alarm. |
Occurrences |
Number of occurrences or merged times for an alarm triggered by a fault. This parameter helps users identify and handle alarms. This parameter is not displayed on the Masked Alarms and Historical Alarms pages. |
Alarm Source |
Name of the device or NE where the alarm is generated. |
Name |
Name of an alarm. An alarm name tells what faults occur on an alarm source. For example, the high CPU usage alarm can be known by its name that the alarm is sent from the CPU. |
Alarm ID |
Alarm ID. Each alarm is uniquely identified by an alarm ID. |
Severity |
Severity of an alarm. The options are Critical, Major, Minor, and Warning. |
Acknowledgement Status |
Acknowledgement status of an alarm. The options are as follows:
This parameter is not displayed on the Masked Alarms page. |
Clearance Status |
Clearance status of an alarm. The options are as follows:
This parameter is not displayed on the Masked Alarms page. |
Acknowledged On |
Time when an alarm is acknowledged. This parameter is not displayed on the Masked Alarms page. |
Cleared On |
Time when an alarm is cleared. This parameter is not displayed on the Masked Alarms page. |
Type |
Type of an alarm. |
Operation |
Operations that users can perform on an alarm.
|
Location Info |
Alarm OID, ESN, and MAC address of the device that generates an alarm. The information assists you to determine the alarm type and locate the device that generates the alarm. |
First Occurred |
If the alarm is a merged alarm, the time when it first occurred is displayed. If the alarm is not a merged alarm, its occurrence time is displayed. This parameter is not displayed on the Masked Alarms and Historical Alarms pages. |
Arrived On |
Time when an alarm reaches the alarm management system. |
Last Occurred |
If the alarm is a merged alarm, its last occurrence time is displayed. If the alarm is not a merged alarm, its occurrence time is displayed. On the Masked Alarms and Historical Alarms pages, this parameter is displayed as Occurred. |
Acknowledged By |
User who acknowledges the alarm. If the alarm is unacknowledged, the user currently displayed in the Acknowledged By column will be deleted. This parameter is not displayed on the Masked Alarms page. |
Cleared By |
User who clears the alarm. This parameter is not displayed on the Masked Alarms page. |
Auto Clear |
Whether an alarm can be automatically cleared.
This parameter is not displayed on the Masked Alarms page. |
Other Information |
Detailed alarm information that assist in fault cause locating. |
Clearance Type |
Alarm clearance type:
This parameter is not displayed on the Masked Alarms page. |
Alarm Information
Tab Page |
Description |
Operation Method |
---|---|---|
Details |
On the Details tab page, you can view the description of alarm parameters. NOTE:
If the alarm reference is available to an alarm, you can click the link in Possible cause and solution details and go to the alarm reference. |
To set the parameters to be displayed on the Details tab page, click Select Fields in the upper right corner of the Details tab page. |
Comments |
On the Comments tab page, you can add comments for the alarm. |
Click Modify in the upper right corner of the tab page, enter comments, and then click Save. |
Processing Records in Last 2 Months |
You can view all manual operations performed on the alarm in the last two months, facilitating alarm handling. |
- |
Correlative Alarms |
|
- |
Viewing Historical Alarms and Masked Alarms
By analyzing historical alarms and masked alarms, users can understand device running statuses and determine whether rules are properly configured.
Context
- By default, 20,000 historical alarms and masked alarms can be displayed. When the number of alarms exceeds the upper limit, the first 20,000 alarms are displayed based on the filter criteria and sorting. If you want to query other alarms, you can modify the filter criteria and sort the alarms.
- You can create an alarm masking rule to mask alarms that you are not concerned about. The masked alarms will be displayed on the Masked Alarms page or discarded.
- Masked alarms are not deleted from the masked alarm list when the corresponding masking rules are disabled or deleted.
- You can only monitor and view alarms of authorized MOs.
- A total number of 30 Historical Alarms and Alarm Logs pages can be opened concurrently by online users.
Procedure
- View historical alarms and masked alarms.
- Viewing historical alarms
- Choose from the main menu.
- On the Historical Alarms page, click Filter to expand the panel and set filter criteria to find desired historical alarms.
- Viewing masked alarms
- Choose from the main menu.
- On the Masked Alarms page, click Filter to expand the panel and set filter criteria to find desired masked alarms.
- Viewing historical alarms
- Click Save or Save As to save the current filter criteria as a filter template.
You can click Template Management in the upper left corner of the page to view all filter templates and select a filter template from the Quick Filter panel. Users with the Administrators role can manage templates saved by all users.
The following types of templates are provided:- Favorite: You can add the templates that you often use to your favorites.
- Custom: Filter templates customized by the current user, which can be shared to other users.
- Shared: Available filter templates shared by other users.
- Other: Filter templates that are not shared by other users. These templates are visible only to users with the Administrators role.
The filter templates on the Current Alarms, Alarm Logs, Historical Alarms, Masked Alarms, and Event pages are independent from each other and cannot be shared.
- Export historical alarms or masked alarms. Alarms can be exported to an .xlsx or .csv file. When the number of alarms to be exported exceeds 100,000, the file is compressed to a .zip package and then exported.
- Export some alarms: Select the alarms to be exported, click Export, and choose Selected.
- Export all alarms: Click Export and choose All.
Only the information about the alarm columns displayed on the page can be exported. You can click
in the upper right corner of the alarm list to set the alarm columns to be displayed.
Parameter Description
For details, see the parameter description in "Monitoring and Viewing Current Alarms".
Viewing Events
By querying events, you can view the event messages sent by devices. You can monitor events in real time on the Event Logs page.
Context
- By default, 20,000 events can be displayed. When the number of events exceeds the limit, only the latest events are displayed. To view earlier events, you can set filter criteria or export them.
- You can only monitor and view events of MOs.
- By default, Auto Refresh is disabled. This function can be enabled on a maximum of two pages at a time.
- After Auto Refresh is enabled, the newly reported events are displayed on the top of the page. If the event list is sorted, the newly reported event is also displayed on the top of the page.
Procedure
- On the O&M plane, choose from the main menu.
- On the Events page, set filter criteria to find the events that you are concerned about.
- Click Save or Save As to save the current filter criteria as a filter template.
You can click Template Management on the upper left of the page to view all filter templates on the current page and select a filter template from the Quick Filter panel. Users with the system administrator role can manage templates saved by all users.
The following types of templates are provided:- Favorite: You can add the templates that you often use to your favorites.
- Custom: Filter templates customized by the current user, which can be shared to other users.
- Shared: Available filter templates shared by other users.
- Other: Filter templates that are not shared by other users. These templates are visible only to users with the system administrator role.
The filter templates on the Current Alarms, Historical Alarms, Masked Alarms, and Events pages are independent from each other and cannot be shared.
- Export events. Events can be exported to a .xlsx or .csv file. When the number of events to be exported exceeds 100,000, the file is compressed to a .zip package and then exported.
- Export some events: Select the events to be exported, click Export, and choose Selected.
- Export all events: Click Export and choose All.
Only information about the event columns displayed on the page can be exported. You can click
in the upper right of the event list to set the event columns to be displayed.
Parameter Description
Name |
Description |
---|---|
Event Serial Number |
Event SN. When an event is generated, it may be modified multiple times. The SN uniquely identifies an event. |
Event Source |
Name of the device or NE where the event is generated. |
Name |
Event name. An event name tells what changes occur on a source. |
ID |
Event ID, which corresponds to the event name. |
Severity |
Alarm severity. The options are critical, major, minor, and warning. |
Possible Causes |
Possible causes of an event, which provide guidance for event handling. |
Type |
Event type. |
Location Info |
Information that assists in locating. Based on the information, you can quickly locate the location where the event is generated. |
Occurred |
Time when an event occurs. |
Arrived On |
Time when an event reaches Alarm Management. |
Other Information |
Information not for locating an event, but for helping users understand an event. |
Comments |
Event comments entered by users. The comments cannot exceed 512 characters. Setting method: You can select an event and click Comment to enter the event comments. |
Handling Alarms
In Alarm Management, O&M personnel can perform operations on alarms, such as specifying a handler, acknowledging alarms, and clearing alarms, to facilitate troubleshooting.
Prerequisites
You have the following operation rights: Alarm Operation, Clear Alarm, Change Severity, and Synchronize NE Alarms.
Context
Parameter |
Function |
Description |
---|---|---|
Acknowledge |
Identify the user who handles an alarm to avoid one alarm being handled by multiple users. |
Acknowledging an alarm means that the alarm will be or has been handled. When the alarm is acknowledged, the alarm status changes from unacknowledged to acknowledged. If you want another engineer to handle the alarm, you can unacknowledge the alarm. When the alarm is unacknowledged, the alarm status is changed from acknowledged to unacknowledged. |
Clear |
Identify whether the fault that causes an alarm is rectified. |
When a fault occurs on the interconnected NE or in the system, an alarm is generated. When the fault is rectified, a clear alarm is generated and the alarm is cleared. If the system fails to receive the clear alarm or the alarm cannot be automatically cleared due to a network fault, you need to manually clear the alarm. When you manually clear the alarm, an alarm clearance command is sent from Alarm Management, and then the corresponding NE or system clears the corresponding alarm. |
Based on the alarm acknowledgment and clearance status, alarms are classified into:
- Current alarms: include uncleared and unacknowledged alarms, acknowledged but uncleared alarms, and unacknowledged but cleared alarms. O&M personnel can monitor and handle alarms that they are concerned about on the Current Alarms page.
- Historical alarms: include alarms that have been cleared and acknowledged. Historical alarms are a data source for network performance optimization. O&M personnel can query and collect statistics on alarms.
Procedure
- Choose from the main menu.
- On the Current Alarms page, you can perform the following operations:
Operation
Scenario
Operation
Viewing alarm details
Obtain key alarm information, including alarm names and location information, to facilitate fault diagnosis and troubleshooting.
In the alarm list, click the arrow on the left of the row that contains a desired alarm to view the alarm details.
Manually acknowledging an alarm
An acknowledged alarm indicates that the alarm is being handled by the user whose name is displayed in the Acknowledged By column. When the alarm is acknowledged, the alarm status changes from unacknowledged to acknowledged.
You can select one or more alarms and click Acknowledge above the alarm list. You can also click
in the Operation column of the row that contains a desired alarm.
After you have acknowledged an alarm, the Acknowledged By column shows the user name.
Manually clearing alarms
Some alarms cannot be automatically cleared. Therefore, you need to clear the alarms manually after rectifying the faults.
You can select one or more alarms and click Clear above the alarm list. You can also click
in the Operation column of the row that contains a desired alarm.
- If the alarm has been acknowledged after being cleared, the alarm will be moved to the Historical Alarms page.
- If the alarm has not been acknowledged after being cleared, it is retained on the Current Alarms page, with a green background.
NOTE:The cleared alarm cannot be restored. Exercise caution when performing the operation.
Quick entries for setting alarm rules
O&M personnel can quickly set rules related to an alarm from the quick entries. Only authorized users can perform related operations. For details about the rules, see Table 4-41.
In the Operation column that contains a desired alarm, click
to select a rule to be set.
Table 4-41 Introduction to quick entries for rulesRule
Description
Set Masking Rule
You can set an alarm masking rule to mask alarms that you are not concerned about. The masked alarms will not be displayed on the Current Alarms page.
Acknowledging
Identify the user who handles an alarm to avoid one alarm being handled by multiple users.
Clear
When a fault occurs on the interconnected NE or in the system, an alarm is generated. When the fault is rectified, a clear alarm is generated and the alarm is cleared. If the system fails to receive the clear alarm or the alarm cannot be automatically cleared due to a network fault, you need to manually clear the alarm.
When you manually clear the alarm, an alarm clearance command is sent from Alarm Management, and then the corresponding NE or system clears the corresponding alarm.
Set Intermittent/Toggling Rule
After a rule is set, intermittent or toggling alarms can be discarded or displayed on the Masked Alarms page to reduce interference caused by repetitive alarms.
Parameter Description
Button |
Description |
---|---|
Auto Refresh |
|
Combo Sorting |
Sorts alarms by multiple alarm fields. A maximum of four alarm fields can be set. |
Clear |
When the fault that triggers an alarm is rectified but the alarm is not cleared automatically, click Clear to manually clear the alarm. After the alarm is cleared, its status changes to Cleared. |
Acknowledge/Unacknowledge |
After an alarm is acknowledged, the alarm will be or has been handled. When the alarm is acknowledged, the alarm status changes from unacknowledged to acknowledged. If engineer B wants to handle an alarm acknowledged by engineer A, engineer A can unacknowledge the alarm. When the alarm is unacknowledged, the alarm status changes from acknowledged to unacknowledged. |
Comment |
Comments of an alarm can be edited. |
Export |
Alarms can be exported to a .xlsx or .csv report. When the number of alarms to be exported exceeds 100,000, the report is compressed to a .zip package and then exported. |
Configuring an Alarm Dump Policy
Usage Scenario
Controller alarms and forwarder alarms are saved in the database. To prevent excess historical data from affecting database performance, the earliest 20% alarms are saved to a local file and the data in the database is deleted, after the size of historical alarms in the database reaches 30 GB. A dump file is automatically deleted when its size reaches 1 GB or its storage period reaches 180 days. If the file size or the retention duration exceeds the threshold, the dump file will be automatically deleted.
You can configure an alarm dump policy to dump historical alarms to the remote SFTP server. In this case, you can view historical alarms to locate faults. iMaster NCE-Campus performs dumping detection every 4 hours. When dumping conditions are met, iMaster NCE-Campus automatically dumps alarms to the remote SFTP server. You can view the dumped alarms on the SFTP server.
Example dump file formats are as follows:
- Historical alarm dump file: history_alarm_dump_2018-12-20_02.20.06.37.zip
- Event dump file: event_dump_2018-12-20_02.20.00.141.zip
If some alarms fail to be dumped, iMaster NCE-Campus reports an alarm. Troubleshoot the fault based on the alarm information.
Configuring Alarm Dumping
- Choose . from the main menu
- To make it easy for users to view all alarm files, you are advised to enable the data overflow dump function. Set SFTP server parameters for alarm dumping.
- Set the alarm dump parameters. iMaster NCE-Campus performs alarm dump detection every 4 hours. When alarm dump conditions are met, iMaster NCE-Campus automatically dumps alarms to the remote SFTP server. You can view the dumped alarms on the SFTP server.
If the alarm data of a tenant needs to be dumped through SFTP, enable Dump data of tenants.
If the alarm data of the tenant does not need to be dumped through SFTP, disable Dump data of tenants.
- Click Apply.
- (Optional) Delete or refresh the SSH public key. If an SSH public key has been updated, delete the expired key and update the SSH public keys displayed on the page. An SSH public key ensures the security of data transmission between iMaster NCE-Campus and the file server.
Parameter Description
Parameter |
Description |
---|---|
Dumping limit time (days) |
Threshold of the number of days for locally saving alarms or events. If this threshold is exceeded, the system triggers a dump and automatically deletes the local data after the dump. The value is an integer in the range from 30 to 120. |
Parameter |
Description |
---|---|
SFTP server IP address |
IP address and port number of the remote SFTP server. |
SFTP server port |
|
SFTP storage path |
Storage path of dumped files on the remote SFTP server. NOTE:
Set this parameter as needed.
|
SFTP user name |
User name and password used to dump files to the remote SFTP server. |
SFTP password |
Configuring the Email Notification Function for Alarms
Prerequisites
The administrator has correctly configured the email server. For details, see Configuring an Email Server.
Procedure
- Choose from the main menu.
- Set Mail notification to
, set email notification parameters based on the site requirements, and click Apply. The following figure shows an example. Set the parameters.
- After the email notification function is configured successfully, all email addresses set in Recipient E-mail will receive the same alarm email.
Alarm notification emails (excluding the detailed alarm description) sent to users are displayed in the same language as that of the iMaster NCE-Campus web UI. If a language switchover is performed on iMaster NCE-Campus, you need to reconfigure the alarm notification function for the language switchover in the emails to take effect.
However, the language in which the detailed alarm description is displayed in alarm notification emails must be consistent with the language of the management plane web UI. For example, if the language of the management plane web UI is English, the detailed alarm description is displayed in English.
Parameter Description
Parameter |
Description |
---|---|
Mail notification |
Whether to send a notification email after an alarm is reported. If Mail notification is set to |
Language |
Language for email sending. |
Recipient E-mail |
Recipient of an email notification. If Mail notification is set to Recipients can receive alarm emails at their mailboxes specified here. Separate multiple email addresses by line breaks. The value supports a maximum of 1024 characters and cannot end with semicolons (;) |
Notification interval |
Notification interval. This parameter is valid only when Mail notification is set to The options are as follows:
|
Alarm severity |
Alarm severity. Only alarms of selected severities are sent to the specified email addresses. |
Notification message |
Subject and content of an alarm notification email. The subject can contain information about Customer Name, Alarm Quantity, and Time Range. The email content can include the following information: Site, Device IP, ESN, Alarm Name, Alarm severity, Occurrence Time, Alarm Cause, Suggestion, Notification Type, and Addition information. |
Log Management
Log Management
During system running, iMaster NCE-Campus records system management operations and its own run logs, which are used for auditing and fault locating.
Log Types and Operation Entrances
Table 4-46 lists the log types and operation entrances on iMaster NCE-Campus.
Log Type |
Log Scope and Purpose |
Operation Entrance |
---|---|---|
Operation log |
Record all add, delete, and modify operations triggered by users or the cloud platform for auditing. |
Choose Operation Logs tab. from the main menu, and click the |
Security log |
Record the operations related to user accounts for auditing. The operations include logging in to or logging out of iMaster NCE-Campus, as well as changing user passwords. |
Choose Security Logs tab. from the main menu, and click the |
Run log |
Record various status information during the running of iMaster NCE-Campus and execution of tasks. If a fault occurs on iMaster NCE-Campus, engineers and administrators can check logs to locate the fault. |
Choose Run Logs tab. from the main menu, and click the |
Registration log of unmanaged devices |
Record the registration logs of the devices that are not managed by iMaster NCE-Campus, including the first registration time, last registration time, and registration times. |
Choose from the main menu, and click theUnmanaged Device Registration Log tab. |
Configuring a Log Dumping Policy
Usage Scenario
All logs are saved in the database. To prevent excessive historical data from affecting database performance, iMaster NCE-Campus checks the number of historical logs every 4 hours. When the dumping conditions are met, iMaster NCE-Campus automatically dumps logs to the remote SFTP server and delete the dumped logs from the iMaster NCE-Campus database. You can view the log files on the SFTP server.
Example dump file formats are as follows:
- Security log: 192.168.3.5_SecurityLog_Store_2016_06_06_09_00_14.zip
- Operation log: 192.168.3.5_OperationLog_Store_2016_06_06_09_00_00.zip
- Run log: 192.168.3.5_SystemLog_Store_2016_06_06_14_00_57.zip
- In the file name, 10.170.209.91 indicates the IP address of the cluster node where the log is dumped, and 2019_06_08_01_07 indicates the time when the log file is dumped.
- If an exception occurs during the dump, iMaster NCE-Campus generates an alarm. Rectify the fault based on handling suggestions in the alarm information.
Procedure
- Choose Log Overflow Dump tab. from the main menu and click the
- To make it easy for users to view all log files, you are advised to enable the data overflow dumping function. Set SFTP server parameters for log dumping.
Then, click Test Connectivity to check whether the parameter settings are correct.
For log dumping, iMaster NCE-Campus functions as a client and supports only the HMAC-SHA2-256 and HMAC-SHA2-512 encryption algorithms. Therefore, the peer SFTP server must support at least one of the encryption algorithms. Otherwise, iMaster NCE-Campus will fail to communicate with the SFTP server.
- Configure the log dumping criteria and local dumping policy.
The data dumping conditions take effect separately for security logs, operation logs, and run logs. Logs of the same type can be dumped only after such logs exceed the configured dumping condition values. Otherwise, the logs of a specific type will not be dumped to the SFTP server.
- Click Apply.
- (Optional) Delete or refresh SSH public keys. If an SSH public key has been updated, delete the expired key on the page and update SSH public keys displayed on the page. An SSH public key ensures the security of data transmission between iMaster NCE-Campus and the file server.
Parameter Description
Parameter |
Description |
|
---|---|---|
Remote SFTP Parameters |
Enable dumping |
Whether to enable data overflow dumping. If this parameter is set to |
IP address type |
IP address type of the SFTP server. The value can be IPv4 or IPv6. |
|
SFTP server IP address |
IP address and port number of the remote SFTP server. |
|
SFTP server port |
||
SFTP storage path |
Storage path of dump files on the remote SFTP server. |
|
SFTP user name |
User name and password for dumping files to the remote SFTP server. |
|
SFTP password |
||
Dumping data of tenants |
When Dumping data of tenants is set to |
|
Data Dumping Parameters |
Dumping limit number |
Maximum number of log records permitted before log dumping. If the number of logs in the database exceeds the threshold, logs are dumped to the remote SFTP server. The system deletes the dumped historical logs from the database to ensure that the number of log records in the database is less than the threshold. |
Data retention period (days) |
Maximum number of log retention days allowed before log dumping. If the number of retention days of some logs in the database exceeds the threshold, logs are dumped to the remote SFTP server. The system dumps these logs and then deletes the dumped logs from the database. |
Certificate Management
Certificate Management
Pre-configured certificates have security risks. Apply for commercial certificates and replace pre-configured certificates in a timely manner.
Prerequisites
A security certificate has been applied from a CA.
Procedure
- Choose from the main menu.
- Choose Service Certificate Management from the navigation pane.
- Choose Service Certificate Management from the navigation pane.
- On the Services page, select the service for which you want to import a certificate, and click the corresponding tab based on the certificate type to configure a certificate.Table 4-48 Services to be restarted
Service
Procedure
APIMLBService
- Use PuTTY to log in to the active node where the apimlb process of MinApiMgr resides, as the sopuser user in SSH mode.
- Run the following command to switch to the ossadm user:
su - ossadm
Password: password of the ossadm user
- Run the following commands to restart APIMLBService:NOTE:
APIMLBService is a single-instance service. After the configuration is complete, restart it on the active node. You do not need to restart it on the standby node.
cd /opt/oss/manager/bin
. engr_profile.sh
ipmc_adm -cmd restartapp -app APIMLBService