MSP Administrator O&M
- Logging In to iMaster NCE-Campus as an MSP Administrator
- Homepage Management
- License Management
- Managing User Accounts
- Tenant Device Management
- Certificate Management
- Configuring the Third-Party Server
- Alarm Management
- Log Management
- File Management
- Report
Logging In to iMaster NCE-Campus as an MSP Administrator
Context
An MSP 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 MSP name and password, and click Login.
If LDAP is used to authenticate the MSP administrator, the user name for logging in to iMaster NCE-Campus is in the format of MSP administrator name/<LDAP USER NAME>, for example, the MSP account created on iMaster NCE-Campus is msp1@huawei.com, and the user name format is msp1@huawei.com/<LDAP USER NAME>.
- (Optional) Upon the first login, change the password and bind the email address as prompted. Skip this step if it is not your first login.
- For security purposes, do not save your password in the browser.
- If the system administrator has configured an email server and does not set an email address when creating an MSP administrator, an email address needs to be bound to the MSP administrator account upon MSP's first login.
- If the system administrator has not configured an email server, no email address needs to be bound to an MSP administrator account upon MSP's first login.
- When a sub-administrator account created by an MSP administrator logs in to iMaster NCE-Campus for the first time, no email address needs to be bound to the sub-administrator account.
- (Optional) Perform two-factor authentication. If a mobile number has been set, click Obtain Verification Code and enter the received verification code. You can log in to iMaster NCE-Campus after the verification succeeds. This step is not required if username and password authentication is selected when the system administrator creates the MSP administrator.
- (Optional) Sign the privacy statement.
After the root MSP administrator has signed the privacy statement, the sub-MSP administrators created by this root MSP administrator need to sign the privacy statement as well when logging in to iMaster NCE-Campus for the first time.
The login will fail if they do not sign the privacy statement.
Homepage Management
Viewing Homepage Information
After logging in to iMaster NCE-Campus, MSP administrators can directly access the Overview page to view tenant information or create or delete tenants.
Procedure
- Log in to iMaster NCE-Campus using an MSP administrator account.
- View the tenant list information on the Dashboard. You can create tenants.
Authorizing Tenant Administrators to Enable or Disable Local CLI-based Device Configuration
MSP administrators can authorize tenant administrators to enable or disable local CLI-based configuration for devices.
Context
If a user logs in to the local CLI of an online device and configures or modifies device services using commands, the configurations may conflict with those delivered byiMaster NCE-Campus, resulting in service exceptions..
To prevent such problems, an MSP administrator can authorize tenant administrators to enable or disable the local CLI-based configuration function for devices.
This function is applicable to switches only.
Procedure
- Log in to iMaster NCE-Campus.
- Click
next to the target tenant, click Disable authorization, and click OK. After the authorization is disabled, the tenant cannot enable the local CLI-based configuration function for switches, and users cannot configure switches through the CLI.
Follow-up Procedure
A tenant administrator can enable or disable the local CLI-based configuration function for devices. For details, see Enabling or Disabling Local CLI-based Device Configuration.
License Management
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. |
Checking License Information (Global Perpetual License)
Context
If the system administrator has imported licenses, the MSP administrator can view the license information.
Prerequisites
The system administrator has imported licenses.
Procedure
- Choose
to view the detailed information about the loaded license file. from the main menu. Click
- 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.
Allocating Licenses (Global Subscription Mode + License Redistribution Enabled)
Context
If the system administrator has allocated license packages to an MSP administrator, the MSP administrator can allocate license resources to tenants for refined management.
The MSP administrator can assign license resources to tenants only after the system administrator logs in to iMaster NCE-Campus for the first time and sets the license mode to Global Subscription Mode and License Redistribution to Yes.
Prerequisites
The system administrator has allocated a license package to the MSP administrator. For details, see Managing Licenses (Global Subscription Mode + License Redistribution Enabled).
Procedure
- Choose from the main menu. The license management page is displayed. View information about the license package allocated by the system administrator to the MSP administrator and the license consumption information.
Click the package name to view details about the package.
- 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.
- Click the Tenant License tab and allocate license resources to tenants.
- Click
on the left of a tenant to view the license status and resource consumption of the tenant.
- 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 click
. The license package is allocated to the tenant.
- (Optional) Click
to freeze the license package. A 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
Follow-up Procedure
Log in to iMaster NCE-Campus as a tenant administrator and view the license resource status and consumption information. For details, see Viewing License Information (Global Subscription Mode + License Redistribution Enabled).
Activating and Allocating a License (Tenant Subscription Mode + License Redistribution Enabled)
Context
If the system administrator has enabled the Split licenses function when creating an MSP administrator, the MSP administrator can centrally import the activation code to activate the license and allocates license resources to each tenant based on the tenant's service requirements. In this case, tenants cannot import license resources by themselves.
- The system administrator logs in to iMaster NCE-Campus for the first time and sets the license mode to Tenant Subscription Mode.
- This task applies only to Huawei Public Cloud Scenario, in which the MSP obtains license activation codes from the Electronic Software Delivery Platform (ESDP) and allocates them to tenants.
- Coding mode: 8806
- License consumption by time: After license expiration, iMaster NCE-Campus stops providing services.
- License form: Number of devices x Number of available days
- Example: A subscription license is similar to that of a monthly package. If a customer purchases a "10 device x day" license for S5700-LI series devices with 8 ports, one device of this model can be used for 10 days, two devices of this model can be used for 5 days, and so on. The total number of license units must be 10.
- Deduction time: The system deducts and settles license resources at 02:00 every day.
Prerequisites
- A tenant account has been registered.
- The system administrator has enabled the Split licenses function.
- The MSP administrator has applied for a license activation code.
- If you need to import the activation code of the CampusInsight license to iMaster NCE-Campus, ensure that the CampusInsight license has been synchronized to iMaster NCE-Campus before iMaster NCE-Campus and CampusInsight are interconnected. For details, see Configuring Interconnection with iMaster NCE-CampusInsight.
Procedure
- Choose from the main menu.
- Import activation codes or authorization IDs to activate licenses. Either activation codes or authorization IDs need to be imported.
- Click Import Activation Code.
- Multiple activation codes need to be separated by line breaks.
- The number of activation codes cannot exceed 10.
- After iMaster NCE-Campus interconnects with CampusInsight, you can import the activation code of the CampusInsight license to iMaster NCE-Campus.
- Click Import Auth ID.
- Multiple authorization IDs need to be separated by line breaks.
- The number of authorization IDs cannot exceed 10.
Since the first-time registration of a device, the device starts to consume license resources. License consumption continues no matter whether the device is online or offline, or reports alarms. License deduction starts at 02:00 every day, and each device consumes one unit of license every day.
In tenant subscription (splittable) mode, iMaster NCE-Campus does not provide 90-day common series resources for users by default.
- Click Import Activation Code.
- View the license status.
- (Optional) Click Recalculate Expiration Time and set a unified expiration time of license resources.
The function of recalculating the license expiration time is not applicable to common series resources.
Under a tenant, the expiration time of device licenses with the same device type is automatically recalculated when settlement is performed on a daily basis.
Under a tenant, the expiration time of device licenses with different device types is not automatically recalculated. To recalculate the expiration time of such licenses, perform this step.
This function allows you to configure a unified expiration time for resource items with different expiration time for easy management and resource integration. This operation cannot be rolled back.
For example, there are three types of license resource items, including AR100 series: 10 device-days with 5 RMB per device-day; AR1200 series: 20 device-days with 10 RMB per device-day; and indoor AP series: 20 device-days with 20 RMB per device-day. Assume that iMaster NCE-Campus manages five 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). According to the calculation result, the license resources for AR100 and AR1200 series devices will expire in five days. The remaining 25 RMB 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. Resources that are in arrears 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.
- Check the daily consumption of license resources.
- Click
to view the detailed information about license activation codes or entitlement IDs.
After a license is loaded successfully, you can view the software ID for SnS charging and authentication.
- Click the Tenant License tab and allocate license resources to tenants.
- Click
on the left of a tenant. The license items for 54 types of products are displayed under each tenant, and the number of resources is 0.
- Click
in the Operation column and configure the number of license resources required by the tenant (unit: device x day). Then click
.
- (Optional) Click
to freeze the license. A frozen license cannot be redistributed or used. Click
to change the number of license resources.
If you freeze the license, related devices will go offline. Therefore, exercise caution when performing this operation.
- (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
Follow-up Procedure
Log in to iMaster NCE-Campus as a tenant administrator and choose from the main menu to view the license resource status and consumption information.
Managing User Accounts
Managing MSP Administrator Accounts
Context
If an MSP administrator created by the system administrator has all the rights of the MSP, this MSP administrator is called the root MSP administrator.
To ensure system security, the root MSP administrator can create multiple sub-MSPs and assign different rights to each sub-MSP by role.
Prerequisites
- View MSP administrator account policies.
Account policies have been configured on iMaster NCE-Campus by default. An MSP administrator can view account policies, for example, account length policy and account login policy.
Choose Account Policy to view MSP administrator account policies.
from the main menu, and click - View MSP administrator password policies.
Password policies have been configured on iMaster NCE-Campus by default. An MSP administrator can view password policies, for example, password complexity policy, password change interval policy, and character limitation policy.
Choose Password Policy, to view MSP administrator password policies.
from the main menu, and clickFor 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.
- MSP Administrator: The MSP administrator performs manager services and configurations.
- 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.
- Click Create, and set parameters on the Create User page.
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 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.
- 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 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.
Table 4-84 Description of parameters on the Create Account pageParameter
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
Email address of an MSP, which is provided for easy and prompt contact by Tenants under the MSP.
Email address
Phone number of an MSP, which is provided for easy and prompt contact by Tenants under the MSP.
Role
Selected the role from the drop-down list.
- Manually set a password when creating a user account.
- On the Managed Object page that is displayed, select the accounts to be managed by the MSP administrator, and click Next. By default, Select All Resources is enabled. In this case, the MSP administrator can manage all tenants. If you disable Select All Resources, you can select the tenants to be managed by the MSP administrator. In addition, select a role that is authorized by the tenant administrator to the MSP administrator. When the MSP administrator accesses the tenant Portal to maintain tenant services, the MSP administrator has the rights of the role authorized by the tenant administrator.
- 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 main menu. On the Access Control page that is displayed, maintain the IP address range.
- Click OK. The account is created successfully.
Follow-up Procedure
- Modify the account information, reset the password, and disable or enable an account.
- Choose from the main menu.
- In the Operation column, click
to modify the account information, click
to reset the password, click
to disable an account, and click
to enable an account that has been disabled.
- 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.
- Set a user group.
User 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.
Choose User Group tab, and click Create to create a user group.
from the main menu, click theClick Next to select the managed objects of the user group.
Only users with the MSP administrator rights can configure user groups.
- Configure personal settings.
Personnel settings improve the access security of iMaster NCE-Campus. This function takes effect only for the current user.
- Set the number of concurrently online users.
- Choose from the main menu.
- On the Basic Information page, set Max. concurrent users and click
. The value 0 indicates there is no limit on the maximum number of concurrent online users.
- Modify the password.
- Choose from the main menu.
- On the Basic Information page, click
behind the password. In the dialog box that is displayed, set a new password.
- Adjust the range of IP addresses that can be used by the current account to log in to iMaster NCE-Campus.
Click Access Control tab. On the Access Control page, set the IP address range and click OK. If no IP address range is set, there is no limit on the login IP address range of the current account.
- Set the idle timeout interval.
To prevent other personnel from performing unauthorized operations when the administrator leaves, iMaster NCE-Campus provides the function of setting the idle timeout interval of the administrator. If an administrator does not perform any operation within the specified interval, 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
from the main menu, click, set the idle time, and click OK.
- Check online users.
Choose Online User tab.
from the main menu and click the
- Set the number of concurrently online users.
- Check whether you have signed a privacy statement.
- Choose from the main 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 the Authentication Mode for MSP Administrator Accounts
When a system administrator logs in to iMaster NCE-Campus, iMaster NCE-Campus will authentication 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 MSP Administrator.
- Click Next. On the Managed Object page, authorize the tenant object. Select one or more tenants from the Total list and click
to add the selected tenants to the Selected list. Select a role from the Authorization drop-down list for tenant authorization.
- 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.
Verification
Deregister the MSP account. Log in to iMaster NCE-Campus using the GLDAPTest member account and password of the LDAP server. If the login succeeds, the interconnection is successful.
If LDAP is used to authenticate the MSP administrator, the user name for logging in to iMaster NCE-Campus is in the format of MSP administrator name/<LDAP USER NAME>, for example, the MSP account created on iMaster NCE-Campus is msp1@huawei.com, and the user name format is msp1@huawei.com/<LDAP USER NAME>.
The method to view the GLDAPTest member accounts of the LDAP server is: Use LDAP Admin to connect to the server where LDAP is installed. Right-click GLDAPTest and 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
Creating and Exporting the AD Certificate
To enable users on an AD server to log in to iMaster NCE-Campus, you need to configure interconnection between iMaster NCE-Campus and the AD server.
Prerequisites
- The AD server is able to communicate with iMaster NCE-Campus.
If the AD 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 AD server.
- The AD 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.
- If you do not create a certificate for the first time, uninstall the AD server root certificate and domain certificate. For details, see How Do I Uninstall the Root AD Certificate and Domain Certificate?.
Procedure
The following example uses the Windows Server 2008 R2 Standard operating system.
- Install the Active Directory certificate service.
- Click
to open the server manager.
- Right-click Roles and click Add Roles.
- Choose Server Roles, and ensure that Active Directory Domain Services and DNS Server are displayed as Installed.
- Select Active Directory Certificate Services and click Next.
- Choose AD CS > Role Service, select Certification Authority Web Enrollment, and click Next.
- Choose AD CS > Setup Type, retain the default setting, and click Next.
- Choose AD CS > CA Type, retain the default setting, and click Next.
- Choose AD CS > Private Key, retain the default setting, and click Next.
- Choose Private Key > Cryptography. Set Select the hash algorithm for signing certificates issued by this CA to SHA256.
- Choose Private Key > CA Name, and configure the CA name. You can modify common name for the CA (for example, Huawei-WIN-GRC97HN6VCE-CA) and distinguished name suffix (for example, DC=Huawei,DC=com).
- Choose Private Key > Validity Period, change the validity period of the root certificate, and click Next.
- Choose AD CS > Certificate Database, specify the certificate path and retain the default setting, and click Next.
- Confirm the installation configuration and click Install.
- Click Close.
- Click
- Check the CA configuration and ensure that the domain certificate has been enrolled successfully.
- On the Run page, enter inetmgr in the Open text box to open the IIS process.
- Check that the CA web enrollment service generates an application Certsrv in the IIS default site.
- In the navigation tree, choose CertSrv. In the Browse Application area on the right, click Browse *:80 (http) to view the web registration page of the CA.
- Export the certificate issued by the CA to the AD server.
- On the Run page, enter mmc in the Open text box to open the root node of the console.
- Choose .
- Select Certificates and click Add.
- Select Computer account.
- Retain the default settings and click Finish.
- Click OK.
- Choose to view the certificate.
- Request domain certificates.
- Right-click in the blank space and choose from the shortcut menu.
- Click Next.
- Choose Active Directory Enrollment Policy and click Next.
- Select Domain Controller and Domain Controller Authentication. Click Enroll.
- Click Finish when the enrollment is successful.
- Requesting domain certificates is successful.
- Right-click the certificate and choose .
- On the Certificate Export Wizard page, retain the default setting, and click Next.
- Select Base-64 encoded X.509(.CER), and click Next.
- Specify the certificate file name and storage path, and click Next.
- Confirm the configuration and click Finish. If a message is displayed indicating that the certificate is successfully exported, click OK.
- View the exported certificate in the storage path specified in 3.l.
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 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 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 LDAPGroup1 and the role to MSP Administrator.
- Click Next. On the Managed Object page, authorize the tenant object. Select one or more tenants from the Total list and click
to add the selected tenants to the Selected list. Select a role from the Authorization drop-down list for tenant authorization.
- 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
Deregister the admin account. Log in to iMaster NCE-Campus using the GADTest member account and password of the AD server. If the login succeeds, the interconnection is successful.
Method to view the GADTest member accounts of 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 Workgroups
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.
Pre-configuration Tasks
- A tenant administrator creates a workgroup and workgroup administrator account.
- The tenant administrator authorizes the workgroup rights to the MSP administrator.
Procedure
- Log in to iMaster NCE-Campus using the MSP administrator account, and choose . Click Create, enter workgroup information, and click Next.Table 4-91 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.
- By default, workgroup supports the following roles: MSP administrator, Operator, and Open API operator.
The operation rights of these roles are:
- MSP Administrator: The MSP administrator performs manager services and configurations.
- 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: MSP administrator, Operator, and Open API operator.
- Configure workgroup administrator information and click Next.
- Manually set a password when creating a user account.
For security purposes, keep the password secure and change it periodically.
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, select the tenants that can be managed by the workgroup. Then, select the workgroup created by the tenant administrator and click OK. In addition, select a role that is authorized by the tenant administrator to the MSP administrator.
If the tenant administrator has granted the permission of managing tenant workgroups to the MSP administrator, the MSP administrator can log in to iMaster NCE-Campus and maintain services of the tenants in the specified tenant workgroups.
Follow-up Procedure
- Modify workgroup information.
- Log in to using the MSP account and choose from the main menu.
- Click
in the Operation column to modify the workgroup information.
- Delete a workgroup.
- Log in to using the MSP account and choose from the main menu.
- Select an account 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 an MSP administrator creates a tenant 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
- Tenants 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 tenant who is using the privacy statement with the same name will change to the latest version. When the tenant or MSP logs in to the system, the tenant needs to sign the latest privacy statement.
Creating a Root Tenant
Context
A Root tenant is responsible for configuring and maintaining services on a tenant network.
Prerequisites
- The tenant administrator created by the MSP can select the Username/Password or Username/Password + SMS verification code authentication mode. If Username/Password + SMS verification code is configured, you need to configure an SMS server in advance. For details, see Configuring an SMS Server.
- 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.
Procedure
- Log in to iMaster NCE-Campus as an MSP administrator.
- Choose .
- Click Create to configure tenant information. The tenant name must be different from existing accounts. Set Authorize MSP as required.
After Authorize MSP is enabled, the Tenant Administrator role is attached to the MSP. In this manner, when the MSP administrator accesses the tenant portal to maintain tenant services, the MSP administrator has the rights of the Tenant Administrator role authorized by the tenant administrator.
If Username/Password + SMS verification code is selected, enter the service phone number for receiving SMS messages.
You need to create a privacy statement in advance. For details, see Managing Privacy Statements. Tenant 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.
- Click Next to configure tenant 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 a tenant administrator |
Click |
Deleting a tenant administrator |
Click NOTE:
After you delete a tenant, all existing data about this tenant including the tenant name, tenant administrator account, site, and tenant devices will be automatically deleted from iMaster NCE-Campus. |
Viewing the privacy statement signed by a tenant administrator |
If a tenant administrator has signed the privacy statement, click |
Parameter Description
Parameter |
Description |
|
---|---|---|
Tenant Information |
Tenant name |
Tenant name. The tenant's company name is recommended. |
Number of administrator accounts |
Maximum number of administrator accounts of the tenant. |
|
Workgroup quantity |
Maximum number of workgroup quantity of the tenant. |
|
Address |
Postal address of a tenant administrator, which is provided for easy contact by the system administrator. |
|
Service mailbox |
Email address of a tenant administrator, which provides easy contact with the tenant administrator. The email address must be correct. |
|
Service phone number |
Phone number of a tenant administrator, which provides easy contact with the tenant administrator. The phone number must be correct. |
|
Login authentication mode |
Select the authentication mode upon the login of the tenant administrator: Username/Password: A tenant administrator only needs to enter the username and password to log in to the system. After the username and password are verified, the login is successful. Username/Password + SMS verification code: When a tenant administrator logs in to the system and enters the username and password, the SMS verification page is displayed after the username and password are verified. The login is successful only after the SMS verification is successful. |
|
Administrator Information |
Account |
Account used by a tenant 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 tenant or apply for a valid email address and assign this email address to the tenant administrator. |
Password create mode |
Mode in which a password is created. The options are Manual and Email. |
|
Password |
Initial password used by a tenant administrator to log in to iMaster NCE-Campus for the first time. The initial password must be changed upon the first login. |
|
Confirm password |
Confirm password, which must be identical to that of Password. |
|
Email address used for password retrieval, message pushing, and other purposes. If this parameter is left empty, the account is used as the default email address. 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 a tenant administrator belongs. |
Modifying MSP Information
Administrators can modify personalized MSP information, such as the enterprise name and logo, on iMaster NCE-Campus.
Procedure
- Access the MSP Information page.
Choose
from the main menu. - Modify the MSP name, address, mailbox, phone number and description. You can also click Upload to replace the enterprise logo. Then, click Save.
Personalized information customized by an administrator will be displayed on the pages available to that administrator. For example, after an administrator replaces the enterprise logo and refreshes the page, the new logo is displayed in the upper left corner of the page.
When customizing an enterprise logo, you are advised to use an image with the pixel size 150 x 30 to achieve the optimal display effect. The image can be in the JPG, PNG, or BMP format, with a size no more than 100 KB.
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. When logging in to iMaster NCE-Campus for the first time, 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 the web UI of iMaster NCE-Campus.
Procedure
- Change the default password.
You will be redirected to the password change page when you log in to the iMaster NCE-Campus web UI 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 password.
- Choose from the main menu.
- Under Change Password, click
next to Password. On the password change page that is displayed, set Old Password, New Password, and Confirm Password.
- Click OK.
- Configure access control settings.
- Choose from the main menu.
- Under Access Control, click Create and configure the IP address segment from which users are allowed to log in to iMaster NCE-Campus. User access is not allowed if their IP addresses are out of the specified range.
- Click OK.
Setting and Verifying the Email Address
Prerequisites
You have logged in to iMaster NCE-Campus.
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.
Setting Two-Factor Authentication (via Mobile Number 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.
iMaster NCE-Campus supports two-factor authentication based on user name and password authentication and SMS authentication.
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.
Setting the Date Format and Time Zone of Administrator Clients
Context
By default, the time on a client is displayed according to the time zone of the server.
To display the time of 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.
Setting the Time Format of 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.
(Optional) Accessing the View for Managing Services for a Tenant
An MSP provides tenants with cloud managed devices and cloud network services. After a tenant applies to the MSP for the managed services, the MSP can maintain the tenant's network on iMaster NCE-Campus. If a tenant does not need the managed services from the MSP, skip this step.
Prerequisites
The tenant administrator has authorized the MSP to manage the services.
Procedure
- Log in to iMaster NCE-Campus as the MSP administrator.
- Under Tenants List, click the tenant name. The view for managing services for the tenant is displayed.
Tenant Device Management
Viewing and Importing Device Information
Context
An MSP administrator can view and manage devices of managed tenants.
Procedure
- Choose .
- Select a tenant, filter devices by search criteria, and view basic device information in the list.
- Click
to set dimensions for display of additional device information.
- 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
- Choose .
- Select a device, and click Clear ESN.
In the dialog box that is displayed, click Confirmed, and then click OK.
After the ESN is cleared, the tenant administrator can still view the device on the system UI, but the device is unavailable. 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.
Tenant Device PMI
Context
An MSP administrator can check tenant networks periodically, detect network, device, and service exceptions, handle the exceptions, and send reports to specified email boxes after preventive maintenance inspections (PMIs).
The MSP administrator can perform preventive maintenance inspection (PMI) on tenant devices managed by the controller using NETCONF to detect potential risks in a timely manner.
Prerequisites
The admin or MSP administrator has correctly configured the email server.
Procedure
- Choose from the main menu.
- Execute a PMI task.
- Add devices to be inspected to sites before starting the PMI. Otherwise, the PMI will fail.
- WACs, Fit APs, and distributed APs do not support PMI.
- Click the PMI List tab.
- Inspect tenant devices.
- Inspect all devices of a tenant. Find the tenant to be inspected in the list and click Start PMI to inspect all devices of the tenant.
- To perform PMI for multiple devices under a tenant: Click the tenant icon, select the devices for which PMI needs to be performed, and click Start PMI to inspect all devices of the tenant. PMI starts on the selected devices in batches.
- Inspect a single device of a tenant. Click the tenant icon, select a device, and click
in the Operation column to inspect the tenant device.
For devices that fail in the PMI, you can view the failure cause in the Device Status column. The possible causes are as follows:
- The device is not online.
- The device does not belong to any site.
- The device or version is not supported.
- iMaster NCE-Campus restarted during the PMI.
- A user logs in to the device in the CLI.
- Failed to create a session or connection: An SSH channel fails to be established between iMaster NCE-Campus and the device.
- PMI timeout: PMI times out if it takes more than 16 minutes to inspect a single device.
- Authentication failure: The device is configured with the HWTACACS authentication and escape functions on iMaster NCE-Campus, but the HWTACACS server is faulty or the network is disconnected. Alternatively, iMaster NCE-Campus fails to configure the password of the admin user for the device.
- Existing session or connection: The CLI of the device has been opened.
- Inspect all devices of a tenant. Find the tenant to be inspected in the list and click Start PMI to inspect all devices of the tenant.
- After the PMI is complete, click Export and view the PMI report.
The exported PMI report is in .pdf format.
- View the inspection list.
- Click the PMI Record tab.
- Find required historical PMI records from the list. You can export PMI packet, export PMI report, delete, and resend them through emails.
- iMaster NCE-Campus can save historical PMI records for three years at most.
- An inspection task can be in one of the following status:
- All Success: All devices are inspected successfully.
- Partial Success: Some devices are inspected successfully.
- Abnormal: The inspection task is not complete due to an exception, for example, the inspection task is manually stopped.
- Configure a notification email sending policy.
- click the PMI Settings tab
- Set Email notification to
, click Add, add email addresses of recipients, and click OK.
- Set the email title, and click Save.
If the email address of the MSP administrator has been verified, by default, the system automatically adds the email address of the MSP administrator to the recipient email address list when the email sending function is enabled and this email address cannot be deleted or changed.
If Notification title uses the default value, iMaster NCE-Campus automatically updates the date in the title to the actual date on which the email is sent. The automatic date updating function does not take effect for a customized title.
Certificate Management
Pre-configured certificates have security risks. Apply for commercial certificates and replace pre-configured certificates in a timely manner.
The service plane provides a temporary certificate. If this certificate cannot meet your security requirements, apply for a new certificate from a certificate authority (CA) and import the new certificate to the service plane.
Service |
Certificate Type |
Certificate and Relevant Files |
Certificate Usage |
---|---|---|---|
AuthService-LDAP |
Identity certificate |
Identity certificate in .pem format, public key file, and its public key, private key, private key password, and certificate chain |
The certificate verifies whether the AD/LDAP server interconnected with iMaster NCE-Campus is trusted, and ensure communication security between them. |
Trust certificate |
Trust certificate in .pem or .cer format |
||
CRL |
Not supported |
The CRL is not supported currently. |
|
NorthboundCommunicationService-Syslog |
Identity certificate |
Identity certificate in .jks format |
Certificate used by iMaster NCE-Campus to verify the identity of the third-party Syslog server to ensure communication security between them. |
Trust certificate |
Trust certificate in .jks format |
||
CRL |
Not supported |
The CRL is not supported currently. |
Prerequisites
A security certificate has been applied from a CA.
Procedure
- Choose from the main menu.
- 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.
Configuring the Third-Party Server
Before configuring interconnection between iMaster NCE-Campus and the email server, and SMS server, ensure that there are reachable routes between iMaster NCE-Campus nodes and the preceding servers.
Configuring an Email Server
Context
If iMaster NCE-Campus needs to send emails to users, you need to configure an email server first.
iMaster NCE-Campus needs to send emails in the following scenarios:
- The MSP administrator or tenant administrator forgets the password: iMaster NCE-Campus sends a reset password to the administrator through an email.
- The tenant administrator performs alarm settings on iMaster NCE-Campus: iMaster NCE-Campus sends emails to notify users of reported alarms.
- The tenant administrator wants to use the email-based deployment function: iMaster NCE-Campus needs to send deployment emails to related personnel.
- Tenants want to register accounts by themselves: iMaster NCE-Campus sends an email containing an activation link to the tenants.
- The MSP administrator inspects tenant devices: iMaster NCE-Campus sends the inspection report to the administrator's mailbox, if needed.
- The MSP administrator deletes ESNs or devices: iMaster NCE-Campus sends a notification email to the tenant administrator, if needed.
- A tenant license is about to expire: iMaster NCE-Campus sends a notification email to a tenant.
- When portal authentication is configured for guest access, you need to set the approver notification mode or guest notification mode to email notification.
The system administrator has configured an email server for sending emails. If the MSP administrator wants to use another email server, the MSP administrator needs to configure an email server separately.
If both the system administrator and MSP administrator have configured an email server, the email server configured by the MSP administrator is used preferentially. If the email server configured by the MSP administrator is not found, the email server configured by the system administrator is used.
Procedure
- Upload an email server certificate.
- Contact the SMS server provider to obtain a certificate file.
- Choose from the main menu.
- Choose Service Certificate Management from the navigation pane. On the Services page, click CampusBaseServiceServerConfigMoudle.
- Click the Trust Certificate tab and click Import. On the displayed page, enter the certificate information, select the desired email server certificate, and click Submit to upload the certificate to iMaster NCE-Campus.
- Choose from the main menu.
- Set parameters for connecting to the email server.
If the email server uses a third-party CA certificate, you are advised to disable Validate server certificate.
- Click Test to verify the email sending function.
- If the message "The test succeeds" is displayed and the mailbox receives the test email, the configuration is successful. Click Save.
- If the message "The test succeeds" is displayed but the mailbox does not receive the test email, check whether the email function of the SMTP server is normal.
- If the message "Failed to connect to the email server" is displayed, check whether the above parameters are correctly configured.
- Affected by the network quality and performance of the SMTP server, the time of receiving emails will be delayed within two minutes.
- Some SMTP providers set the right control for third-party application access. If the test fails, check whether the function of controlling third-party application access is enabled on the SMTP server and set password to the authentication password of the SMTP server.
- Limited by security policies of email service providers, administrators may fail to receive emails in some scenarios. If no email is received, log in to the email service website or contact the email service provider to check whether the email is returned or other exceptions occur. Alternatively, replace the email server and try again.
Parameter Description
Parameter |
Description |
---|---|
SMTP address |
SMTP address of the mailbox from which emails are sent. The address must be an IP address or in the smtp.mail.com format. NOTE:
SMTP is short for Simple Mail Transfer Protocol. SMTP is mainly used to transfer system emails and provide email notifications. |
Port |
Port number of the SMTP service provided by the email server. You can obtain the port number from the email service provider. By default, the port number is 25. |
Secure connection |
Whether secure connection is enabled. |
Encryption connection type |
Protocol for establishing an encrypted communication link between iMaster NCE-Campus and the SMTP server. This parameter is available only when Secure connection is selected. NOTE:
Secure protocol TLSv1.2 is recommended. TLSv1.0 and TLSv1.1 are insecure protocols; therefore, exercise caution when using them. |
Validate server certificate |
For security purposes, select Secure connection and Validate server certificate. Select certificate. |
Certificate File |
Certificate file of the email server. This certificate ensures communication security between iMaster NCE-Campus and the email server. |
Authentication |
Whether to enable the email account and password authentication. |
Account |
The two parameters are valid only when Authentication is selected. User name and password for logging in to the SMTP server. |
Password |
|
Sender Email |
Sender email address, which must have been registered on the email server. During the email test, this address is used as a recipient email address. After the connectivity test is successfully performed and the configurations are saved, this address is used as the sender email address. |
Customized email subject |
Email subject. An administrator can customize the prefix and suffix of the email subject. When an email is sent, the prefix and suffix are automatically added before and after the email subject. |
Customized email signature |
Email signature. An administrator can customize the email signature, and the signature is automatically attached to emails. |
Configuring an SMS Server
Context
You need to configure the SMS service if SMS authentication is required.
Before configuring the SMS service, you need to configure an SMS platform to specify the SMS gateway and configure account information based on the SMS platform to send SMS messages.
- SMS platform: You need to set parameters about a third-party SMS platform on iMaster NCE-Campus according to the information provided by the SMS platform. For details, see the interface document of the third-party SMS platform.
- SMS server: You need to set parameters for interworking between iMaster NCE-Campus and a third-party SMS platform. After the interconnection is successful, iMaster NCE-Campus can send SMS messages.
By default, the system is pre-configured with the following SMS server connection parameters:
- fungo: http://qxt.fungo.cn/Recv_center. This is the SMS platform of fungo.cn (Beijing, China).
- twilio: https://api.twilio.com:8443/2010-04-01/Accounts/{USERNAME}/Messages.json. To use this SMS server, access www.twilio.com and apply for an account.
- If the system administrator has configured an SMS server and enabled, MSP administrators can use the SMS server configured by the system administrator. Otherwise, they cannot use the SMS server configured by the system administrator and need to configure an SMS server on their own.
If a MSP administrator wants to configure an SMS server, the tenant administrator needs to contact the system administrator to configure the SMS platform information. Only the system administrator can configure the SMS platform information. For detail, see Configuring an SMS Server.
If you do not want to use the SMS server configured by the system administrator, you can configure an SMS server as needed.
Prerequisites
The system administrator has created an SMS server template.
Procedure
- Import an SMS server certificate.
- Contact the SMS server provider to obtain a certificate file.
- Log in to iMaster NCE-Campus as a system administrator and choose from the main menu.
- Choose Service Certificate Management from the navigation pane. On the Services page, click CampusBaseServiceServerConfigMoudle.
- Click the Trust Certificate tab and click Import. On the displayed page, enter the certificate information, select the desired SMS server certificate, and click Submit to upload the certificate to iMaster NCE-Campus.
- Choose SMS Server tab. and click the
- Select an SMS Platform, and configure the related data.
HTTPS is recommended because it is more secure than HTTP.
- Set SMS Service type to HTTP SMS Service and select fungo from the SMS platform drop-down list box.
- Set SMS Service type to HTTP SMS Service and select twilio from the SMS platform drop-down list box.
- Set SMS Service type to SMPP SMS Service and select the created SMS template from the SMS platform drop-down list box.
- Set SMS Service type to HTTP SMS Service and select fungo from the SMS platform drop-down list box.
- Click Test to verify validity of the SMS message sending function.
- If the test succeeds, the message "The test succeeds" is displayed, and you can receive the test SMS message from iMaster NCE-Campus.
- If the test fails, the message "Failed to test the SMS serve" is displayed. Perform operations according to the scenarios:
- If an error code is displayed in the dialog box, check the product documentation of the SMS service provider for the cause of the error, and obtain the troubleshooting method.
- If no error code is displayed in the dialog box, contact the system administrator to check the URL specified in the SMS server template to see whether the SMS server is reachable.
- After the test is successful, click Save.
Parameter Description
Parameter |
Description |
---|---|
SMS platform |
SMS template. Administrators can configure an SMS server template to specify an SMS gateway. By default, the following SMS server connection parameters are pre-configured on iMaster NCE-Campus:
To use the SMS service provided by another carrier, you can create an SMS platform template as needed. |
Account |
Account obtained during SMS service application. |
Token |
Password obtained during SMS service application. NOTE:
For system and user security purposes, it is recommended that the password provided by a third party meet the complexity requirements. |
SMS message signature |
Signature of SMS messages. |
Send number |
Number obtained from the SMS service provider, used to check whether the number for sending SMS messages is correct. This parameter is configurable only when the twilio template is selected. |
Inheritance |
When this function is enabled and neither the MSP administrator nor the tenant administrator configures an SMS server, the SMS server configured by the system administrator is used. When this function is disabled, MSPs and tenants cannot use the SMS server configured by the system administrator. |
Test number |
Number for sending a test SMS message. The value can be any available mobile number. |
Test SMS message |
Content in a test SMS message. |
Parameter |
Description |
---|---|
SMS platform |
SMS platform template. Administrators can configure an SMS platform template to specify an SMS gateway. |
System id |
SMS server ID obtained during SMS service application. |
Password |
Password obtained during SMS service application. |
Source number |
Number obtained from the SMS service provider, used to check whether the number for sending SMS messages is correct. |
Inheritance |
When this function is enabled and neither the MSP administrator nor the tenant administrator configures an SMS server, the SMS server configured by the system administrator is used. When this function is disabled, MSPs and tenants cannot use the SMS server configured by the system administrator. |
Test number |
Number for sending a test SMS message. The value can be any available mobile number. |
Test SMS message |
Content in a test SMS message. |
Configuring a Map URL
If site locations are identified on a map, iMaster NCE-Campus can display monitoring data of each site on this map. Currently, iMaster NCE-Campus supports Amap and Google Maps. To implement the map function, you need to purchase a license, obtain the API address, and configure the map URL.
If the MSP administrator purchases the map service, the map URL can be configured independently.
The map URLs configured by the tenant administrator, MSP administrator, and system administrator take effect in descending order of priority. For example, if the system, MSP, and tenant administrators each have configured a map URL, the URL configured by the tenant administrator is used preferentially.
Prerequisites
You have purchased related services from a map service provider and obtained the API address (URL) and key value of the map. For details about how to apply for a key value, see Google Maps Key Application Procedure.
Procedure
- Choose Map URL Settings tab. , and click the
- Click Edit corresponding to the map, enter values of API address and Key, and select Instructions for Use.
- Click OK.
Google Maps Key Application Procedure
- Access the Google Maps official website at https://developers.google.com/maps/documentation/javascript/get-api-key.
- Register a Google account and log in.
- Create a Google Maps project.
- Choose Set up in Cloud Console from the navigation pane. Under Creating a project, click Create new project.
- Enter project information and click CREATE to create a project.
- Choose Set up in Cloud Console from the navigation pane. Under Creating a project, click Create new project.
- Apply for an API key.
- Choose Set up in Cloud Console from the navigation pane. Under Enabling APIs, click Enable the Maps JavaScript API.
- Select the created project and click ENABLE to enable the Maps JavaScript API function.
- On the Credentials tab page, click CREATE CREDENTIALS and click API key.
- Obtain the API key.
- Choose Set up in Cloud Console from the navigation pane. Under Enabling APIs, click Enable the Maps JavaScript API.
- (Optional) Remove the Google Maps watermark.
There is a watermark on Google Maps by default. You need to pay fees if you want to remove the watermark from the map.
- Choose Set up in Cloud Console from the navigation pane. Under Creating budgets and setting alerts, click Go to the Billing page.
- Click ADD BILLING ACCOUNT.
- Enter personal information.
- Click START MY FREE TRIAL.
- Choose Set up in Cloud Console from the navigation pane. Under Creating budgets and setting alerts, click Go to the Billing page.
Parameter Description
Parameter |
Description |
---|---|
API address |
Map URL.
|
Key |
Key applied for from the map service provider. |
Connecting to the Syslog Server
Importing the Syslog Server Trust Certificate
Context
This certificate is used for Syslog server authentication when iMaster NCE-Campus functions as the client to securely communicate with the Syslog server.
Procedure
- Choose from the main menu.
- Choose Service Certificate Management from the navigation pane. On the Services page, click NorthboundCommunicationService-Syslog.
- Click the Trust Certificate tab and click Import. On the displayed page, enter the certificate information, select the desired syslog server certificate, and click Submit to upload the certificate to iMaster NCE-Campus.
For security purposes and to prevent certificate expiration, you are advised to update certificates periodically (for example, every three months).
Configuring the Syslog Server
Context
To use the syslog server or the syslog service module of the NMS to receive and manage logs and alarms, you need to configure the syslog server and iMaster NCE-Campus.
Logs and alarms can be displayed and queried on or exported from iMaster NCE-Campus. iMaster NCE-Campus can also report logs and alarms to the syslog server or the syslog service module of the NMS using syslog messages. The syslog server manages logs and alarms. iMaster NCE-Campus reports logs and alarms to the syslog server using UDP (less secure) or TLS (secure).
Logs that can be reported to a syslog server include run logs, operation logs, and security logs, and alarms that can be reported to a syslog server include cluster alarms and device disconnection alarms. You can customize alarm information reported to a syslog server using syslog messages.
Prerequisites
- The Syslog server trust certificate has been imported.
- (Optional) If the Syslog server requires client authentication, you also need to import the following certificate files of any iMaster NCE-Campus node to the trusted domain of the Syslog server.
Certificate File
Path
client.keystore
/etc/puppet/modules/opendaylight/files/ssl/syslog/client
clientTrust.keystore
Procedure
- Choose Map URL Settings tab. , and click the
- On the Syslog Configuration page, click Create, and set interconnection parameters as planned.
- Click Test on the bottom of the page.
A test is required only when TLS is enabled. If TLS is disabled, the Test button is unavailable. Skip this step and click Apply.
- If the message "Test successfully" is displayed, the Syslog configuration succeeds. Click Apply.
- If the message "Test failed" is displayed, the parameters or certificates are incorrect. In this case, check the parameter values configured on and certificates imported to the northbound application and iMaster NCE-Campus. If the parameters and certificates are incorrect, modify them, and then click Test again.
Parameter Description
Parameter |
Description |
---|---|
IP address |
IP address of the syslog server, which can be obtained from the primary syslog server. |
Port |
Port number of the syslog server, which is the same as the port number in udp(ip()port()) or tcp(ip()port()) in the Source field in the Syslog.conf file on the primary syslog server. |
Enable reporting |
Whether to report the syslog service. The IP address or domain name and port number of the syslog server can be configured only when this parameter is enabled. |
Enable TLS |
If TLS is configured on the syslog server, enable this parameter. If UDP is configured on the syslog server, disable this parameter. Before enabling this parameter, ensure that the syslog server supports TLS. |
Syslog protocol |
Protocol for reporting syslog messages. The options are RFC 5424 and RFC 3164. |
Encoding format |
UTF-8 or GBK. |
Select the type of logs to be reported |
Type of logs to be reported. |
Logs Reported by Devices
Parameter |
Description |
---|---|
operatorTime |
Time when the log is reported. |
account |
Account which reports the log. |
clientIP |
IP address of the device that reports the log. |
tenant |
Name of the tenant to which the device that reports the log belongs. |
tenantID |
ID of the tenant to which the device that reports the log belongs. |
operation |
Operation that generates the log. |
operatorObj |
Operation object. |
operatorResult |
Operation result. |
level |
Log level. |
detail |
Log details. |
type |
Log type. |
Configuring a File Server
Context
System software packages or patches on a third-party file server can be used for device upgrade or patch installation. To support this, you need to store system software packages and patches on the third-party file server, and configure interconnection between iMaster NCE-Campus and the file server.
Prerequisites
You have set up and configured an SFTP or HTTPS file server.
Procedure
- Choose File Server Manage tab. The page for configuring the file server is displayed. from the main menu, and click the
- Click Add, and configure a third-party file server. You can select SFTP or HTTPS to transfer files.
- If SFTP is selected, configure the username, password, IP address, and port number of the file server.
- If HTTPS is selected, configure the authentication mode, IP address, and port number of the file server.
- If SFTP is selected, configure the username, password, IP address, and port number of the file server.
- Click OK.
Follow-up Procedure
- To upload the system software packages or patches required for device upgrade to iMaster NCE-Campus through a third-party file server and to upgrade devices, perform the following steps:
- Choose Create files in File Management. from the main menu. On the file list page, configure the information about system software packages and patches. For details, see
- Log in to iMaster NCE-Campus as a tenant administrator. Choose from the main menu, and select SFTP or HTTPS when upgrading devices. For details, see Upgrading/Downgrading NETCONF-Managed Devices.
Managing Notification Users
Context
When O&M personnel need to send notifications to related personnel.
O&M personnel set remote notification parameters, specify the notification content to be sent or use the preset notification template, and manually trigger the sending of emails to related personnel.
Before sending notifications, O&M personnel need to create notified users or notified user groups.
Prerequisite
An administrator has been created.
Procedure
- Choose from the main menu.
- Click the Notified User Management tab and configure the users and user groups to be notified.
- Click the Notified Users tab, click Create, and configure the user information. Enter the user name, set at least one of the mobile number and email address, and click OK.
The user name is case sensitive.
- Click the Notified User Groups tab, click Create, and configure the user group information. Enter the user group information, select users, add the users to the user group, and click OK.
By creating user groups, O&M personnel can send notifications to users by group.
- The mobile number and email address of a user cannot be empty at the same time. Otherwise, the user cannot be added to the user group.
- On the Notified Users tab page, you can click Create to add notified users. By default, newly created users are added to the user group.
- A maximum of 200 users can be added to a notified user group.
- When adding users to a user group, you can search for users by User Name, Mobile Number, or Email on the Notified Users and O&M Users tab pages.
- If the mobile number and email address of a user are both empty, the user cannot be added to a user group.
- The user group name is case sensitive.
- Click the Notified Users tab, click Create, and configure the user information. Enter the user name, set at least one of the mobile number and email address, and click OK.
Follow-up Procedure
- Modifying, querying, deleting, and exporting notified user information
- Modifying notified user information
To modify the information about a user to be notified, click
next to the user in the Operation column in the Notified Users list.
- Querying notified user information
To query information about one or more users to be notified, select User Name, Mobile Number, or Email from the drop-down list box at the upper right corner of the Notified Users tab page, enter the corresponding information in the search box, and click
. The Notified Users list displays the users who meet the search criteria.
- Deleting a notified user
To delete a user to be notified, click
next to the user in the Operation column in the Notified Users list.
- Export notified user information
To export notified user information, click Export All on the Notified Users tab page. In the Warning dialog box that is displayed, click OK. In the Set File Format and Password dialog box, set the file format, password, and confirm password to export notified user information to the local PC.
- Modifying notified user information
- Modifying, copying, querying, and deleting notified user group information
- Modifying notified user group information
To modify the information about a notified user group, click
next to the user group in the Operation column in the Notified User Groups list.
- Copying a notified user group
To create a notified user group that has similar information with an existing notified user group, click
in the Operation column in the Notified User Groups list to copy the notified user group information, modify the information as required, and create a notified user group.
- Searching for a notified user group
To query information about one or more notified user groups, enter the user group name in the search box at the upper right corner of the Notified User Groups tab page and click
. The Notified User Groups list displays the user groups that meet the search criteria.
- Deleting a notified user group
To delete a notified user group, click
next to the user group in the Operation column in the Notified User Groups list.
- Modifying notified user group information
Alarm Management
Configuring Alarms
You can set alarm or event rules to customize alarm or event monitoring policies as required, improving troubleshooting efficiency.
Configuring Masking Rules
You can set an alarm masking rule to mask alarms or events that you are not concerned about. New masked alarms or events meeting the masking rule will not be displayed on the Current Alarms and Events pages.
Prerequisites
You have the following operation permissions: Set Masking Rules.
Context
- After a rule is created successfully, if Alarm sources of the rule is set to All alarm sources, only the users whose managed objects are All Objects can modify or delete the rule. Other users can modify or delete a rule only when Alarm sources of the rule is set to Custom alarm sources.
- A rule is valid only to the alarms or events reported after the rule is enabled. Alarms meeting the conditions reported before the rule takes effect will not be masked, and alarms meeting the conditions reported after the rule takes effect will be masked or discarded.
- When an alarm matches multiple masking rules that are enabled and valid, and the action in a rule is set to Discard, the alarm is discarded regardless of the priority of the rule.
- The masking rules are used to mask alarms based on the redefined alarm name attributes. If both name redefinition rule and masking rule are set for an alarm, the name redefinition rule will take effect before the masking rule takes effect.
- A maximum of 1000 masking rules can be created.
- If all of the following conditions are met, the masking rule will mask all alarms or events, and alarms or events cannot be reported.
- The masking rule is enabled.
- All alarm or event sources are selected in the masking rule.
- All alarm or event severities are selected in the masking rule.
- Designated alarms or Designated events is not selected, and advanced conditions are not set in the masking rule.
- The time filter condition is not set in the masking rule.
- The procedure for creating an event masking rule is similar to that for creating an alarm masking rule. The following describes how to create an alarm masking rule. If you want to create an event masking rule, click Create and select Event Masking Rules on the Masking Rules 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
- Choose from the main menu.
- In the navigation pane, choose Masking Rules.
- On the Masking Rules page, click Create and select Alarm Masking Rules.
- 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 when the user can manage all resources.
- In the Alarm sources area, you can select All alarm sources to mask the alarms that meet the conditions and are generated by the system and all MOs. Therefore, exercise caution when you set the alarm source.
- In the Time Filter area, set when the rule is effective. You can set the effective time and effective cycle.
If all options of Time Filter are deselected, the rule is effective at any time.
- In the Action area, set Masked alarms to Discard or Show in Masked Alarms.
- When an event masking rule is being created, masked events can only be discarded.
- If Discard is selected, the alarm will not be displayed. Therefore, exercise caution when performing this operation.
- Set the priority of this rule. When an alarm meets two alarm masking rules, the rule with a higher priority takes effect.
- 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 or 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.
- 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, when you import the modified file, the import will fail.
Task Example
Scenario
O&M personnel plan to commission device A at 01:00 AM every Monday in April 20XX. Each commissioning is completed within two hours, during which services of device A are interrupted. Alarms generated during this period are predictable and do not need to be handled. You need to configure masking rules to mask these alarms.
Procedure
- On the Masking Rules page, click Create and select Alarm Masking Rules.
- Set Rule name.
- Select Custom alarm sources and add device A to the custom alarm sources.
- In the Time Filter area, set By period to 20XX-04-01 00:00:00 to 20XX-04-30 23:59:59, set By day to Mon, and set By time to 01:00 to 03:00.
- In the Action area, set Masked alarms to Show in Masked Alarms.
- Retain the default settings for other parameters.
- Click OK.
Result
The alarms generated by device A from 01:00 to 03:00 AM every Monday in April 20XX are not displayed on the Current Alarms or Historical Alarms pages. You can view the masked alarms on the Masked Alarms page.
Parameter Description
Item |
Parameter |
Description |
---|---|---|
Conditions |
Alarms |
|
Alarm sources |
|
|
Advanced conditions |
Restrictions on items such as location information and alarm source types. For example, if you want to filter alarms by location information, select Location Info and contains and enter the alarm location information in the text box. |
|
Time Filter |
By period |
Time range within which the rule will take effect. |
By day |
Days for the rule to take effect in a week. |
|
By time |
Period for the rule to take effect in a day. |
|
Action |
Masked alarms |
|
Other |
Priority |
Priority of an alarm masking rule. |
Change History |
- |
After a masking rule is created, you can click a rule name and view the creator, creation time, modifier, and modification time of the rule in the Change History area. The preceding contents are not displayed for a rule that is not created completely. |
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.
- You can set rules for managed objects. For rules of non-managed objects, you can only view them.
Context
- A rule is valid only to the alarms or events reported when the rule is enabled and valid.
- Severity and type changes of an alarm or event are not delivered to NEs. Only the severity and type of the alarm or event displayed on the alarm or event page 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 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 on the Severity and Type page and select Event Severity and Type Redefinition Rules.
- By default, the rules are sorted by states (enabled or disabled), 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 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 severity and type after redefinition.
- In the Alarm Sources area, select All alarm sources or Custom alarm sources.
All alarm sources is available only when the user can manage all resources.
- 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 for the rule to take effect. You can set the effective time and effective cycle.
By default, all options of Time Filter are deselected, indicating that the rule takes effect at any time.
- Click OK.
Related Tasks
- If you need to delete or disable a rule, you can perform the following operation: In the rule list, select a desired identification rule and click Delete or Disable. Clicking Delete will permanently delete the rule. If you click Disable, the rule cannot be used. You can click Enable to enable it again if necessary.
- Users can import or export severity and type redefinition rules for statistical analysis, review, and migration. On the Severity and Type page, click Import or Export to import or export rules.
- You can import .xls files. The size of a file to be imported at a time cannot exceed 1 MB. A maximum of 1000 rules can be imported. If the imported rule name already exists, the original rule will be replaced by the imported one.
- The first row is hidden 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 meets 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 |
Sets the number of days for the rule to take effect in a week. |
|
By time |
Sets the 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 when the rule is enabled and valid.
- Name modifications are not issued to the peer NE, and 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 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 on the Name page and select Event Name Redefinition Rules.
- By default, the rules are sorted by states (enabled or disabled), 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 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
- If you need to delete or disable a rule, you can perform the following operation: In the rule list, select a desired identification rule and click Delete or Disable. Clicking Delete will permanently delete the rule. If you click Disable, the rule cannot be used. You can click Enable to enable it again if necessary.
- Users can import or export name redefinition rules for statistical analysis, review, and migration. On the Name page, click Import or Export to import or export rules.
- You can import .xls files. The size of a file to be imported at a time cannot exceed 1 MB. A maximum of 1000 rules can be imported. If the imported rule name already exists, the original rule will be replaced by the imported one.
- The first row is hidden 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 to 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, click Alarm Synchronization.
- On the Alarm Synchronization page, select alarm sources. For details about parameters of the synchronized object, see Table 4-103.
- Click Synchronize.
Configuring Correlation Rules
A correlation rule determines the root alarms and correlative alarms. When monitoring or viewing alarms, O&M personnel 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.
- You can set rules configured for managed objects. For rules not configured for managed objects, you can only view them.
Context
- A rule is valid only to the alarms reported when the rule is enabled and valid.
- A maximum of 300 custom correlation rules can be created.
- The default correlation rules can be enabled and disabled, but cannot be modified or deleted.
- By default, the rules are sorted by states (enabled or disabled), 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, click Correlation Rules.
- On the Correlation Rules page, click Default. On the tab page that is displayed, check whether a rule meeting requirements already 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 alarm: Alarm that causes multiple correlative alarms.
- Correlative alarm: Alarm that is generated due to the root alarm.
- In the Conditions area, click Create and 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.
A correlation is present 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
- If you need to disable a correlation rule, you can perform the following operation: In the correlation rule list, select a desired rule and click Delete or Disable. Clicking Delete will permanently delete the rule. The default correlation rules cannot be deleted. If you click Disable, the rule cannot be used. You can click Enable to enable it again if necessary.
- Users can import or export custom correlation rules for statistical analysis, review, and migration. On the Correlation Rules page, click Custom and then click Export or Import to export or import rules.
- You can import .xls files. The size of a file to be imported cannot exceed 1 MB. A maximum of 300 rules can be imported. If the imported rule name already exists, the original rule is replaced by the imported one.
- The first row is hidden 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 records of connection interruption alarm 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. By setting a correlation rule, you can configure alarm N generated later than alarm M as a correlative alarm.
Procedure
- On the Correlation Rules page, click Custom and then click Create.
- Set Rule name.
- 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. On the Current Alarms page, select Root alarms as the filter criterion. After you click OK, alarm N is not displayed. You only need to handle alarm M.
Parameter Description
Item |
Parameter |
Description |
---|---|---|
Alarms |
Root alarms |
Alarm that causes multiple correlative alarms. The following actions can be performed on the root alarms when the alarms meet the conditions:
|
Correlative alarms |
Alarms caused by the root alarm. The following actions can be performed on correlative alarms when the alarms meet the conditions:
|
|
Conditions |
Including Location Info and Alarm Source Type |
You can set conditions for each parameter. |
Selection Mode |
Comparison mode.
|
|
Other |
Period |
Generation interval between the root alarm and its correlative alarms. A correlation is present 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. |
Configuring Intermittent/Toggling Rules
After an intermittent/toggling rule is set, intermittent or toggling alarms 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.
- You can set rules configured for managed objects. For rules not configured for managed objects, you can only view them.
Context
- A rule is valid only to the alarms reported when the rule is enabled and valid.
- Intermittent alarm: 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 alarm: When the interval between the clearance time of an alarm and the next generation time of the same alarm (with the same alarm ID) reported by the same alarm source is less than or equal to the specified value, the toggling is triggered. The alarm is identified as a toggling alarm.
- A new intermittent/toggling rule takes effect only for the alarms that are reported after the rule is enabled.
- The system calculates and processes the alarms every 10 seconds based on the intermittent rule. If more than 1000 alarms are reported within 10 seconds, only the latest 1000 alarms are processed based on the intermittent rule. Other alarms are reported directly.
- A maximum of 1000 intermittent/toggling rules can be created.
- By default, the rules are sorted by states (enabled or disabled), 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, click 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. Set advanced conditions to filter the alarms for the rule based on alarm parameters.
- By default, Designated alarms is deselected, indicating that the rule takes effect for all alarms.
- All alarm sources is available only when the user can manage all resources.
- In the Time Filter area, set the time for the rule to take effect. You can set the effective time and effective cycle.
By default, all options of Time Filter are deselected, indicating that the rule is effective at any time.
- Configure analysis policies.
- Intermittent Policy: Set an intermittent period and action. For example, set the intermittent period to 30 seconds and set the alarm handling action to Discard. When the interval between the alarm generation time and clearance time is less than 30 seconds, the alarm will be discarded.
- 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: Set the toggling trigger condition, termination condition, and action.
- Trigger condition: If the 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 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: Set an intermittent period and action. For example, set the intermittent period to 30 seconds and set the alarm handling action to Discard. When the interval between the alarm generation time and clearance time is less than 30 seconds, the alarm will be discarded.
- In the Other area, set the priority for the rule.
- Click OK.
Related Tasks
- If you need to delete or disable a rule, you can perform the following operation: In the rule list, select a desired identification rule and click Delete or Disable. Clicking Delete will permanently delete the rule. If you click Disable, the rule cannot be used. You can click Enable to enable it again if necessary.
- Users can import or export intermittent/toggling rules for statistics, review, and migration. On the Intermittent/Toggling Rules page, click Export or Import to export or import rules.
- You can import .xls files. The size of a file to be imported cannot exceed 1 MB. A maximum of 1000 rules can be imported. If the imported rule name already exists, the original rule will be replaced by the imported one.
- The first row is hidden 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 is reported and cleared alternately within a short period of time. The cause may be that an NE or service alternates between the normal state and the abnormal state. To reduce the interference by 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: When the interval between the clearance time and the next generation time of alarm M is less than 20 seconds you set, a toggling starts. When the interval is greater than 60 seconds you set, the toggling terminates and alarm M generated during the toggling is discarded.
Procedure
- On the Intermittent/Toggling Rules page, click Create.
- Enter a rule name.
- In the Conditions area, select Designated alarms. Click Add Alarm and select M to configure an intermittent/toggling rule for alarm M.
- In the Analysis Type area, select Intermittent analysis and Toggling analysis.
- Configure 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 reported and cleared alternately again, the alarm will be discarded.
Configuring Auto Acknowledgement Rules
When the number of current alarms reaches the threshold, the system moves current alarms to the historical alarm list. To prevent important alarms from being moved, the system automatically acknowledges the current alarms in the cleared state 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.
- You can set rules configured for managed objects. For rules not configured for managed objects, you can only view them.
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, including four preset rules.
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.
- 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 states (enabled or disabled), 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, click Auto Acknowledgement Rules.
- In the auto acknowledgement rule list, check whether the first four rules (preset rules for automatically acknowledging alarms by severity) 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.
- 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: Alarms will be automatically acknowledged immediately after being cleared.
- Delayed: 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. Set advanced conditions to filter the alarms for the rule based on alarm parameters.
- By default, Designated alarms is deselected, indicating that the rule takes effect for all alarms.
- All alarm sources is available only when the user 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-105 Parameters in the Change Delay area
Parameter
Description
Execute at
Time when an auto acknowledgment rule is executed on a daily basis.
Duration (days)
Period after which a cleared but unacknowledged alarm is automatically acknowledged.
- 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
- Only users with the Administrator role can modify or delete all name groups. Other users can only modify or delete the name groups created by themselves.
- An alarm name group is a set of alarm names. An event name group is a set of event names.
- When you select a name group, the alarms or events in the name group are selected.
- You can select alarm or event name groups only when setting the filter criteria for querying alarms or events and collecting statistics on alarms.
- The procedure for creating an event name group 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, click 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.
Customized Monitoring
Alarm Management provides multiple display modes or sound prompt rules for alarms and events. You can modify them 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 as configured.
Procedure
- Choose from the main menu.
- In the navigation pane, click Color Settings.
- On the Color Settings page, set the colors for alarm and events at different severities.
- Click OK.
Setting Alarm Display Modes
To identify alarms in different states more conveniently, you can set the alarm display mode as required, facilitating identification of 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
- 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 event background colors are displayed by severity.
- Click OK.
Setting Alarm Sounds
You can set sounds for alarms at different severities to facilitate alarm monitoring.
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: Critical.mp3; Major: Major.mp3; Minor: Minor.mp3; Warning: Warning.mp3.
- Only the sound files provided by the system can be selected.
Procedure
- Choose from the main menu.
- In the navigation pane, click Alarm Sounds.
- On the Alarm Sounds page, set the sounds for alarms at different severities. Click
to listen to the selected sound file.
- Set the duration for playing the alarm sound. After the set duration, the alarm sound is automatically stopped for a reported alarm.
- 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.
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.
- Alarms that meet the highlight conditions are highlighted in red in the alarm list.
Procedure
- Choose from the main menu.
- In the navigation pane, click Highlight.
- On the Highlight page, set Effective Time and Alarm Status. If the duration in which an alarm at the corresponding severity remains in the specified state reaches the value of Effective Time, the alarm is highlighted.
- Select whether to enable the function of highlighting alarms at the corresponding severity.
- Click OK.
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
- Choose from the main menu.
- In the navigation pane, click Font Colors.
- Sets the font colors for read and unread alarms.
- Click OK.
Monitoring and Viewing Alarms or Events
You 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, you 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 managed objects that are authorized.
Procedure
- Monitoring alarms
- Choose from the main menu.
- Select an alarm monitoring method. The following table describes alarm monitoring methods.
Table 4-106 Alarm monitoring methods
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
You 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 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 of the statistics panel. In the upper right of each chart, select the chart to be displayed from the drop-down 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.
- In 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.