Level 1 | level2 | Function |
MSP Portal | Use this menu to view organizations. | |
Add Organization/Site | Use this menu to configure organizations and sites. | |
OrganizationOperators | Use this menu to create operators that can manage organizations, sites and devices. | |
Click on an organization to view the following: | ||
Organization View | Use this menu to add, edit or delete sites to/from your organization. | |
Organization Events | Use this menu to view logs of things that have happened in an organization. | |
Organization Settings | Use this menu to set up schedules for firmware upgrade and issue CLI commands. | |
Site View | Click on a site to view the access the Site View. Use these menus to manage devices. | |
License Calculator | Use this menu to view license keys and plan licenses that you need. | |
CNA Management | Managing CNA | Use this menu to view CNA details and remove organizations and/or sites. |
Update Schedules | Use this menu to view CNA firmware upload schedules and edit future schedules. | |
Administrator | Use this menu to create and view administrators that manage CNAs. | |
User Profile | Use this menu to add names and a time zone for your myZyxel account. | |
System Information | Use this menu to view system notifications or enable/disable notifications. |
Label | Description |
MSP Portal | |
Search | Type (part of) the name of an organization or tag, then click Search to display matches found. |
Auto Refresh | Select this to have the CNC update sites found every 30 seconds. |
n Organizations | This displays the number of organizations in this MSP Portal. |
Organization | This displays the name of the organization. |
Site | This displays the number of sites (groups of devices) in this organization. |
Devices | Status may display the following colors: • Green: This displays the number of devices that are online. • Amber: This displays the number of devices that are online with non-acknowledged notifications in this organization. • Red: This displays the number of devices that are offline in this organization. |
Tags | A tag is an alternative way of searching by grouping organizations with a common tag. For example, you could group organizations by customer or region. If you tag all organizations based in Germany with ‘DE’, then all organizations located in Germany will display when you search for the tag ‘DE’. You can create up to 10 unique tags for each organization. A tag name can be no more than 32 characters long. |
Action | The Setting icon allows you to change the name, and/or the search tags of an organization. The Delete icon allows you to remove an organization. If you only have one organization, you can't edit or delete it. But you could create another organization, and then edit or delete the previous one. |
Label | Description |
Add Organization/Site | |
Organization Name | Select an existing organization or click + Add New Organization to create a new one. |
Consume credit from | First, select the account of the CNA owner. Then select the CNA registered to this account in the CNA field below. The CNC consumes license credit from this CNA linked account. When activating a license, you must also use the account of the actual CNA owner. You cannot change the linked account after the organization is created. To change the linked account you would have to delete the organization and then recreate it. |
Site Name | Type the site name belonging to this organization. |
Tags | A tag is an alternative way of searching by grouping sites with a common tag. For example, you could group sites by customer or region. If you tag all sites based in Germany with ‘DE’, then all sites located in Germany will display when you search for the tag ‘DE’. Type up to 10 unique tags for each site. A tag name can be no more than 32 characters long |
CNA | CNAs belonging to the above selected account (in Consume credit from) appear here. Select one. (No CNA) appears if there are no CNAs belonging to the above selected account. |
Cancel | Click this to return to the previous menu without saving any changes. |
Save | Click this to save your changes. |
label | description |
Action | Select Add Organization Operators to create a new operator at MSP level. Select Delete Organization Operators to remove an operator. |
Operators | |
Email | This displays the email address of the operator. |
Organization Privilege | This displays the organization privilege for this operator: • Full - with this privilege, you can add or remove organizations. You also have full privileges to all sites. • Read-Only - with this privilege, you can view individual organization information. • None - with this privilege, you cannot add, remove or view organizations. |
Site Privilege | This displays the site privilege for this operator: • Full - with this privilege, you can add or remove devices from sites. • Read-Only - with this privilege, you can view individual device information. • Monitor-Only - with this privilege, you can view device summary table information only. |
Action | The Setting icon allows you to change the organization and site privileges of an existing operator. The Delete icon allows you to remove the operator. |
Organization | |
Organization Name | Select the organization on which you want to create this operator. |
Label | Description |
License Calculator | |
License Keys | These fields display information on currently registered licenses. |
Activated at | This shows the date the license was activated. |
License key | This displays the license key. |
service | This shows the number of devices that can be managed for one year with this license. |
Type | This shows that this is a standard license. |
Status | The Activate icon displays if the license needs to be activated. Click it to activate the license. |
+License | Click this to register a new license key. |
Plan to add | Use these fields to select the type and number of licenses that you plan to have. |
Managing | Select the number of actual managed devices that you plan to have. Depending on the type and number of licenses that you have, you will then see the expiry date for this number of managed devices below this field. |
Contact Zyxel Sales | Click this to go to a web page that shows you how to contact sales agents for your region. |
Label | Description |
CNA Management | |
Latest Firmware Version | This displays the latest firmware version available for the CNA. You will see a CNA Firmware Update screen if the CNA firmware is out of date. |
Release Note | Click this to download the release notes for the latest firmware version shown in the previous field. |
+Update Schedule | Select one or more check boxes for CNAs, then click this to schedule an upgrade for the selected CNAs to the latest firmware version. |
Own by: | Use this field to see all CNA(s) belonging to this account. You can select yourself or an account which is managed by you. |
CNAs | Select one or more check boxes for CNAs that require firmware upgrading. Use Search to find a particular CNA using (part of) a CNA name or tag. |
Status | This shows if the CNA is online (green) or not (red). |
Name | This is the name of this CNA. |
Current Version | This displays the firmware version installed now on the CNA. |
MAC | This the MAC address of this CNA registered at myZyxel. |
Organization and Site | This is the name of the organization to which the CNA belongs. Click the hyperlink to see the sites to which the CNA belongs. |
Utilization | This displays the number of devices currently being managed and the total number of devices that can be managed via this CNA (250). |
Tags | This displays the tags for this CNA. A tag is an alternative way of grouping CNAs. For example, you could group CNAs by customer or region. If you tag all CNAs based in Germany with ‘DE’, then all CNAs located in Germany will display when you search for the tag ‘DE’. |
Action | The Setting icon allows you to change the name, and/or the search tags of a CNA. You can also view CNA related details and remove organizations and/or sites. Say CNA owner A authorizes B to be an administrator for A. B can assign A’s CNA to serve any sites and these sites will consume A’s license credits. B has Full privilege on these sites. A has NO privilege to see or change the settings of these organizations or sites created by B. B can register and/or activate licenses for A. If A wants to stop B being an administrator, but B doesn’t remove the CNA from B’s organizations and/or sites, then A must come to this menu to remove B’s organizations and/or sites. Otherwise the CNC will consume A’s credit daily as usual. |
add/register CNA | Click the link to go to myZyxel to finish registering the CNA. |
Label | Description |
CNA Management | |
Latest Firmware Version | This displays the latest firmware version available for the CNA. |
Release Note | Click this to download the release notes for the latest firmware version shown in the previous field. |
Own by: | Use this field to see all CNA(s) belonging to this account. You can select yourself or an account which is managed by you. |
CNA Firmware Update Schedules | |
Time | This displays the date and time the firmware upload to the CNA took place or will take place. |
CNA | This displays the name of the CNA to which the firmware upload took place or will take place. |
MAC | This displays the MAC address of the CNA to which the firmware upload took place or will take place. |
Target Version | This is the firmware version that the CNA will upgrade to. |
Action | Click the Setting icon to change a future schedule. Past schedules cannot be edited. Click the Delete icon to remove a schedule. Click the Result icon to see the status of the firmware upload. |
Label | Description |
CNA Management | |
Latest Firmware Version | This displays the latest firmware version available for the CNA. |
Release Note | Click this to download the release notes for the latest firmware version shown in the previous field. |
Own by: | Use this field to see all CNA(s) belonging to this account. You can select yourself or an account which is managed by you. |
n Administrators | This field displays the number of administrators managing this CNA. An assigned administrator can see and use the CNA of the owner. Sites created by these administrators consume license credits from the CNA account owner. These administrators can also register and activate licenses for the CNA account owner. For example, CNA owner A authorizes B to be an administrator for A. B can assign A’s CNA to serve any sites and these sites will consume A’s license credits. B has Full privilege on these sites. A has NO privilege to see or change the settings of these organizations or sites created by B. B can register and/or activate licenses for A. B can register and/or activate licenses for A. |
Email | This displays the email address of the administrator. |
Last login | This displays the date and time the administrator last logged in. |
Action | Click the Delete icon to remove an administrator. The CNA owner cannot be removed. You also cannot remove yourself. |
+Administrator | Click this and enter a valid myZyxel account email address to create a new administrator. |
Label | Description |
User Profile | |
Email | This displays the email address of the person logged into the CNC via myZyxel. |
First Name | Type the first name of the person for identification purposes. |
Last Name | Type the family name of the person for identification purposes. |
Time zone | Select the time zone where the person is located. |
Last Login | This displays the date and time this person last logged into CNC. |
Link to myZyxel | Click this to go to myZyxel. |
Update | Click this to save changes to this menu. |
Label | Description |
Organization View | |
Search | Type (part of) the name of a site, then click Search to display organization matches found. |
Auto Refresh | Select this to have the CNC update sites found every 30 seconds. |
n Sites | This displays summary information for each discovered site. |
Site | This displays the name of the site. |
Devices | Status may display the following colors: • Green: This displays the number of devices that are online. • Amber: This displays the number of devices that are online with non-acknowledged notifications in this organization. • Red: This displays the number of devices that are offline in this organization. |
CNA | This displays the name of the CNA that is managing this site. |
Tags | A tag is an alternative way of searching by grouping sites with a common tag. For example, you could group sites by customer or region. If you tag all sites based in Germany with ‘DE’, then all sites located in Germany will display when you search for the tag ‘DE’. You can create up to 10 unique tags for each site. A tag name can be no more than 32 characters long. |
Action | The Setting icon allows you to change the name, and/or the search tags of a site. The Delete icon allows you to remove a site. You sill see a warning saying this action cannot be undone and you will immediately lose all configuration and client data associated with the site. |
Label | Description |
Legend | Click this for more information on severity levels. |
Event ID | This ID uniquely identifies the event. An event is a log of something that has happened to a device. The hyperlink takes you a menu showing details of this event. |
Task ID | This ID uniquely identifies the task. Use [+] to specify an item to display exclusively and [-] to display everything except it. |
Severity | This displays the event severity level. Use [+] to specify an item to display exclusively and [-] to display everything except it. |
Time | This is the time that the event occurred. Click [<] to display events that happened before the timestamp. Click [>] to display events that happened after the timestamp. |
Organization Name | This is the name of the organization that caused the event. Use [+] to specify an item to display exclusively and [-] to display everything except it. |
Site Name | This is the name of the site in the organization named above that caused the event. Use [+] to specify an item to display exclusively and [-] to display everything except it. |
Event Name | This is the name of the event. Use [+] to specify an item to display exclusively and [-] to display everything except it. |
label | description |
Add New Schedule | Select this to configure a schedule to update firmware to a specific model. |
Delete Schedules | Select a schedule and click this to remove it. |
Delete All Completed Schedules | Click this button to remove all completed schedule tasks. |
Firmware Upgrade Task List | |
Start Time | This is the date (yyyy-mm-dd) and time (hh:mm:ss) the task begins. |
End Time | This is the date (yyyy-mm-dd) and time (hh:mm:ss) the task ends. |
Model | This is the device type to which the firmware will be uploaded. |
Target Firmware Information | This is the firmware version that will be uploaded. The firmware version is in ‘trunk-version (model-code.release#)’ format. For example, V4.11(AAHY.1) means that the firmware trunk version is 4.11, AAHY identifies the NWA5123-NI model and .1 is the second firmware release (.0 is the first) for this model. Firmware versions followed by a date and time means ‘date version’ firmware which may be patch firmware to fix a bug and is not officially released yet. |
Status | The status may display the following colors: • Green indicates the number of devices that have successfully completed firmware upgrade. • Red indicates the number of devices that have failed to complete the firmware upgrade. • This shows Processing while a firmware upgrade task is ongoing. |
Result | Click the Result icon to see the summary of the firmware upgrade per site. This Result screen shows the status of the firmware upgrade task. • Green indicates the number of devices that have successfully completed firmware upgrade. • Red indicates the number of devices that have failed to complete the firmware upgrade. • Blue indicates the total number of devices in the firmware upgrade task. The Update Time shows the time when the table was last updated. Click Events to view the logs regarding this firmware upgrade task. |
Label | Description |
Add Schedule | |
Model | Select one device type to which the firmware will be uploaded. |
Sites | Select the specific sites (of the type selected) to which the firmware are uploaded. |
Firmware | Select either an Official Firmware or Date Firmware version that will be uploaded. The firmware version is in ‘trunk-version(model-code.release#)’ format. For example, V4.11(AAHY.1) means that the firmware trunk version is 4.11, AAHY identifies the NWA5123-NI model and .1 is the second firmware release (.0 is the first) for this model. A firmware version followed by a date and time means ‘date’ firmware which may be patch firmware to fix a bug and is not officially released yet. |
Release Note | Click this to download the selected firmware related release note from the Zyxel website. |
Upload | First download the ‘date’ firmware to your computer and then click this to upload it to the CNC. |
Description | Type some optional information on the firmware upgrade schedule that may be helpful to other administrators. |
Download Firmware Setting | The following two settings are related to the firmware download from CNC to the CNA. These are the steps to upgrade firmware. • CNA downloads firmware from the CNC within the specified timeout and number of attempts allowed (retries). • CNA uploads firmware to its managed device(s). The managed device(s) reboots to complete the firmware upgrade. • After the managed device(s) reboots, the CNA polls it and send the result to the CNC. |
Timeout | Select how long the CNA should take downloading firmware from the server before the CNC considers the firmware upload task failed. |
Retries | Select how many times the CNA should retry downloading firmware from the server within the Timeout period before the CNC considers the firmware download failed. |
Schedule Setting | |
Timeout | Select how long the firmware upgrade task should last, before the CNA. |
The following two settings are related to the firmware upload from the CNC to the device(s). | |
Upgrade Now | Select this to update firmware to the device after clicking OK below. |
Schedule Time | Select this and then the calendar icon to set a date for the upload. Select the clock icon within the calendar screen to set the time. |
OK | Click this to save your changes and proceed. |
Cancel | Click this to return to the previous menu without saving any changes. |
Label | Description |
Organization Push CLI | |
Add New Schedule | Click this to configure the model type, nodes, commands and command transfer settings. |
Delete Schedules | Select a schedule and click this to remove it. |
Delete All Completed Schedules | Click this button to remove all completed schedule tasks. |
Push CLI Task List | This shows an overview of the command transfer tasks completed or in progress |
Start Time | This is the date (yyyy-mm-dd) and time (hh:mm:ss) the task begins. |
End Time | This is the date (yyyy-mm-dd) and time (hh:mm:ss) the task ends. |
Type | This displays whether the task is scheduled to occur once or is recurring. |
Model | This displays the model for the command transfer. Commands may be uploaded to many nodes of the same model in a task. |
Status | The status may display the following colors: • Green indicates the number of devices that have successfully completed push CLI task. • Red indicates the number of devices that have failed to complete the push CLI task. • This shows Processing while a firmware upgrade task is ongoing. |
Result | Click the Result icon to see the status of the push CLI task. The Result screen shows the status of the push CLI task. • Green indicates the number of devices that have successfully completed the push CLI task. • Red indicates the number of devices that have failed to complete the push CLI task. • Blue indicates the total number of devices in this push CLI task. The Update Time shows the time when the table was last updated. Click Events to view the logs regarding this push CLI task. |
Label | Description |
Model | In order to issue commands to a managed device, make sure to select a model that supports SSH and has a Command Line Interface. |
Sites | Select the specific sites (of the type selected) to which the CLI commands are applied. |
Interface | This displays the IP address of the device to which the command will be transferred. |
Site Name | This displays the identification name configured of the sites in the organization. |
Node Number | This displays the how many devices of the model selected are in each site. |
Description | Type some text to describe the purpose of this command execution task. |
Commands | See the model CLI Reference Guide for command syntax. Each command must be on a separate row. • Type set timeout N (N = 1 to 1800 seconds) to set the timeout time limit on the expect commands. • Expect is to wait for a specific word string in a period of time configured with set timeout command. If the expected word string doesn’t show up, the next command written in the script will be implemented. Type expect “Router>” to wait for the keyword “Router>”. • Send is the responding action when the expected word string configured with expect command shows up. Type send “show version\r” to show the version of CNA, and type \r which means to enter, in the end of the command string when finished. • If a particular command needs more time to execute, type sleep N (N = 1 to 1800 seconds) after the command to delay execution of the following command by N seconds. |
Schedule Setting | Configure when the commands should be transferred here. |
Timeout | Set the timeout time for the entire push CLI task. |
Push Now | Select this, then click OK to transfer the commands immediately. |
Scheduled | Select this to configure a date and time when the commands should be transferred. |
Type | Select if the command transfer should recur Daily, Weekly, Monthly or just Once. |
Start Date / End Date | If you select a recurring type, then enter the beginning and end dates for transfer here (or select from the calendar). Date format should be yyyy-mm-dd. |
Every / Day | If you select Weekly, then select which day Every week it should occur. if you select Monthly, then select which Day of the month it should occur. |
Time | Select the time in hour-month format for when the command transfer should occur. |
OK | Click this to save your changes and proceed. |
Cancel | Click this to return to the previous menu without saving any changes. |
Label | Description |
n Operators where n is the number of operators created in CNC. | |
Name | This displays the name of the operator. |
Email | This displays the email address of the operator. |
Organization Privilege | This displays the organization privilege for this operator: • Full - with this privilege, you can add or remove organizations. You also have full privileges to all sites. • Read-Only - with this privilege, you can view individual organization information. • None - with this privilege, you cannot add, remove or view organizations. |
Site Privilege | This displays the site privilege for this operator: • Full - with this privilege, you can add or remove devices from sites • Read-Only - with this privilege, you can view individual device information • Monitor-Only - with this privilege, you can view device summary table information only. |
Action | The Setting icon allows you to change the organization and site privileges of an existing operator. The Delete icon allows you to remove the operator. |
Label | Description |
Add/Edit Operator | |
Email | When adding an operator, type the email address of the operator. It must be a myZyxel account email address. When editing an operator, this displays the email address of the operator. |
Organization Privilege | Select an organization privilege from: • Full - with this privilege, you can add or remove organizations. You also have full privileges to all sites. • Read-Only - with this privilege, you can you can view individual organization information. • None - with this privilege, you cannot add, remove or view organizations. |
Site Privilege | Select a site privilege from: • Full - with this privilege, you can add or remove devices from sites • Read-Only - with this privilege, you can view individual device information • Monitor-Only - with this privilege, you can view device summary table information only. |
Cancel | Click this to return to the previous menu without saving any changes. |
Save | Click this to save your changes. |