How to get Started with ZPE Cloud?

To start using a ZPE cloud, you need to first create an account in the ZPE cloud, and enable the Nodegrid device to access the ZPE Cloud, then enroll the devices in the ZPE Cloud. Once the devices are enrolled, you can start performing the required operations. 

The following is a step-by-step walkthrough:

1. Sign up for the Cloud Account

    1.1 Login to the ZPE Cloud Account

   1.2 SSO with Identity Provider

    1.3 Forgot Password?

2. Enable ZPE Cloud Services in the Nodegrid Device

    2.1 Enabling ZPE Cloud to access the Nodegrid device

    2.2 Enabling Remote Access

3. Enroll Devices to a Company in ZPE Cloud

     3.1 Enrolling Devices Using Claim ID

     3.2 Enrolling Devices Using Transfer Key

     3.3 Enrolling Devices Using Customer Code and Enrollment Key

4. Managing Access to Devices and Permissions through Groups

    4.1 Groups and roles in ZPE Cloud

    4.2 Adding Devices to a Group in ZPE Cloud

    4.3 Adding Users to a Group in ZPE Cloud

5. Accessing Devices Remotely

6. Performing Basic Operations Using Profiles

     6.1 Scheduling Backup for a Nodegrid device using ZPE Cloud

     6.2 Restoring a Backup from ZPE Cloud

     6.3 Upgrading a Nodegrid Device using ZPE Cloud

1.     Sign up for the Cloud Account

Note: New companies have a 90-day free trial. If you want to learn more about the ZPE Cloud features and subscription, contact your account manager or send your questions to support@zpesystems.com.

To sign up for a ZPE Cloud account, perform the following actions: 

1. If you are from the EU region, use the  https://zpecloud.eu/signup URL, for other regions you can use the https://zpecloud.com/signup URL. Contact your ZPE Cloud Account manager to identify the region to create the account.

2. Enter the Email ID and click SIGN UP

   The specified email ID is used for all communication. An invitation email is sent immediately to the specified email ID.
    

3. Open the email and click the invitation link

   The user is directed to the Sign-up form.
    

4. Enter the required details in the Sign-up form:
    

5. The request is sent for approval

   Once the account is approved, an approval email is sent to the user.

6. Once the approval email is received, use the link specified in the email to log in to the ZPE Cloud account
   

1.1     Login to the ZPE Cloud Account

1. Go to the the Sign-in page located at the default page from ZPE Cloud

2. In the Email address or domain field enter the email address and click CONTINUE

   The user will be prompted to log in with the authentication methods configured.

   Note:

   You can configure the company domain URL under Settings:: Company. Once configured, one can log in using SSO without a previous created account on ZPE Cloud. This way, identity providers can provisione login capabilities in a centralized, simplified, and quick way without the creation of local accounts with credentials stored at ZPE Cloud.

   

   For example, if SSO login is enabled, based on the domain name, the system automatically identifies the authentication type. You can further continue logging in by using a combination of SSO, Password, or both.
   For more information on configuring the Identity Provider, see the Identity Provider sub-tab.

Note:

Some MFA (Multi-factor authentication) servers use the provided email as case sensitive. This way, make sure to use the exactly email format provided during the account creation if MFA is enabled at the provided User email under Users :: General tab

Note:

The login may fail if Access Control by Allowed IPs is configured under Settings :: Company and the public IP of the used network does not match any of the allowed IPs.

Note:

If Track session based on Source IP address and SSID (Session ID) is selected under Settings :: Company tab, the ZPE Cloud account session will expire if the session is used by a different public IP, such as when the public IP from the network used to login has changed. Note that it is common for public IP of IPv6 networks to change.

1.2    SSO with Identity Provider

If registered with one of these Identity Providers, use those credential channels to log into ZPE Cloud.

1. Click the required Identity Provider

   

2. On the Sign-in dialog, enter personal credentials

3. On validation, the ZPE Cloud application opens

Note:

ZPE Cloud allows a set of most common and custom SSO Identity Providers. For the full list, see: SSO tab.

1.3    Forgot Password?

1. On the Login page, click FORGOT PASSWORD

   

2. On the Forgot Password dialog, enter the email address associated with the ZPE Cloud account

   

3. Click SEND RESET REQUEST

4. When the response email is received, follow the instructions to reset the password

Still need help?

To contact the ZPE Support team, send an email describing the situation to: support@zpesystems.com

2.     Enable ZPE Cloud Services in the Nodegrid Device

Before you use the ZPE Cloud features, the ZPE Cloud needs access to the Nodegrid device. To access the device remotely, it is necessary to enable remote access. 

2.1     Enabling ZPE Cloud to access the Nodegrid device

For SR family devices, this service is enabled by default, but for other models, you need to enable it.

        Using the Nodegrid GUI

1. Log in as admin in Nodegrid GUI.

2. Go to Security::Services

3. Check the Enable ZPE Cloud field

   The ZPE Cloud URL is not editable and the field is prefilled.
    

4. Click Save
   To disable the service, uncheck the Enable ZPE Cloud field.

      Using the Nodegrid CLI

1. Log in as an admin to the Nodegrid device

2. Go to the Access tab and click Console

3. Enter the following commands:
    
   
   To check if the Nodegrid device is connected to the ZPE Cloud, log in to the Nodegrid device and go to Tracking::ZPE Cloud  where it is possible to view the details of the connection between the Nodegrid device and ZPE Cloud. It is possible to see the status of the connection (whether it is connected, reconnecting, and so on), the Device ID, and the ZPE Cloud URL the device is associated with. The following image displays the details of the Device Information page:
    

2.2     Enabling Remote Access

Remote access is one of the multiple ZPE Cloud features. It allows the user to access the Nodegrid device and target devices from anywhere in the world using an internet connection.

           Using Nodegrid GUI

1. Log in as admin in Nodegrid GUI

2. Go to Security::Services

3. Check the Enable Remote Access field if not checked

   

4. Click Save

           Using Nodegrid CLI

1. Log in as admin to the Nodegrid device

2. Go to the Access tab and click Console
    

3. Execute the following commands:
    

3.     Enroll Devices to a Company in ZPE Cloud

After enabling the Nodegrid devices to access ZPE Cloud and enabling the remote access, it is necessary to enroll the devices to start managing them. Enroll is a term used for associating a device with a ZPE Cloud company. The Enrollment process involves two steps:

• Make the devices Available in the ZPE Cloud using any of the recommended three methods, the devices are then listed on the Available tab. At this point, the device subscription is not consumed and they are ready for enrollment.

• Enroll the Available devices to enable the device subscription so that the user can use the device to perform different operations and start managing it. Once the device is enrolled, it is listed on the Devices::Enrolled page. When enrolling in a device, the subscription to the device is effective.

Three Methods to Enroll Devices in ZPE Cloud

The following are the different methods to make a Nodegrid device available in a ZPE Cloud and enroll the device: 

• Claim ID: To add a small number of devices to the cloud, use the Claim ID. It is possible to add only one device at a time using Claim ID.

• Transfer Key: It is possible to use this option when wanting to add devices in bulk. One Transfer key will have several devices associated with it. 

• Customer Code and Enrollment Key: If there is no Claim ID of the device and do not have direct access to the ZPE Cloud, it is possible to use the Customer Code and Enrollment Key to enroll the device. This action is performed using the Nodegrid UI.

3.1     Enrolling Devices Using Claim ID

To add a device using the unique 8-digit Claim ID, perform the following actions:

1. Locate the Claim ID of the Nodegrid device. Find the Claim ID on a sticker located on the device.

   The Claim ID is an 8-digit code that is unique to each device.
    

2. Log in to ZPE Cloud as a customer admin, and go to Devices::Available tab

3. Select the device

4. Click ADD BY CLAIM ID
    

5. Enter the Claim ID without the dashes
    

6. Click Save
   A confirmation message states the device has been added to your company in ZPE Cloud. The device is listed on the Available tab.
    

7. Select the device and click Enroll
    
   Once the device is enrolled, it is listed on the Enrolled tab.
   

   Note: Add a device by Claim ID can only be executed in ZPE Cloud, not via CLI or Shell.

3.2     Enrolling Devices Using Transfer Key

One of the methods to add a device to the company in ZPE Cloud is to use a unique 45-digit Transfer Key, which is a unique identifier assigned to a device or list of devices.

Perform the following actions to add single or multiple devices to the company in ZPE Cloud using Transfer Key:

1. Log in to ZPE Cloud as an admin, and go to the Devices::Available tab

2. Click ADD BY KEY
    

3. Enter the Transfer Key and click Load Devices

   All the devices associated with the Transfer Key are loaded as shown in the following image:
    

4. Click Transfer

   A confirmation message states that the devices have been loaded into your company in ZPE Cloud. The devices are listed in Devices::Available.
    

5. Select the devices that were just added and click Enroll

    
   This will enroll the devices in the ZPE Cloud. Once the device is enrolled, it is listed in Devices::Available.

3.3     Enrolling Devices Using Customer Code and Enrollment Key

Customer Code is a unique 5-digit identifier assigned to each company and Enrollment Key is a key initially randomly generated that can be changed by authorized company users in ZPE Cloud, together they represent the company's enrollment credentials.

Perform the following actions to add devices to your company in ZPE Cloud using the Customer code and Enrolment key: 

           Enrolling Devices Using the ZPE Cloud GUI

1. Log in to ZPE Cloud as an admin, and go to Settings::Enrollment

2. Under Settings::Enrollment, ensure that the Enable Device Enrolment field is enabled

    

3. Copy the Customer Code and Enrollment key to use in the next steps

4. Log in to the Nodegrid Device's GUI as an admin, and go to System::Toolkit tab

5. Under System::Toolkit, click Cloud Enrollment
    

6. Enter the Customer Code and Enrollment Key copied in Step 3

7. Click Save
    
   A confirmation message states that the device has been transferred to the company in ZPE Cloud.

8. Go back to ZPE Cloud, the device will now appear in Devices::Available
    

9. Select the device that was just added and click Enroll

   This will enroll the device in the ZPE Cloud.
    
   Once the device is enrolled, it is listed on Devices::Enrolled.

         Enrolling a Device Through CLI

1. Log in to ZPE Cloud as an admin, and go to Settings::Enrollment

2. Under Settings::Enrollment, check the Enable Device Enrollment field and click Save

3. Copy the Customer Code and Enrollment key to use in the next steps

4. Log in to the Device's CLI as an admin, and type the following commands:
   
   

    Note: Replace the <customer_code> and <Enrollment_Key> with the actual Customer Code and the Enrollment Key.

5. Login to ZPE Cloud, go to Devices::Available

   The device is listed on this page.

6. Select the device that was just added and click Enroll
   This will enroll the device in ZPE Cloud and the device is listed in Devices::Enrolled.

   Note: Adding a device by Customer Code and Enrollment Key can only be done via API, CLI, GUI, or Shell strictly restricted to ZPE only. It is not possible to add a device by Customer code and Enhancement key through ZPE Cloud.

    The devices are now successfully enrolled in ZPE Cloud. It is possible to start monitoring them and perform operations in ZPE Cloud.

4.     Managing Access to Devices and Permissions through Groups

The Groups tab streamlines the management of devices and users within your organization. By organizing devices and users into groups, it is possible to apply configurations, and upgrades, and manage access permissions more efficiently. This centralized approach simplifies administrative tasks and enhances operational efficiency.

Imagine the organization has multiple departments, each requiring specific devices and user access levels. By creating groups for each department, it is possible to easily manage their configurations, apply software updates, control user access and company-wide configurations permissions without the need to handle each device or user individually.

4.1     Groups and roles in ZPE Cloud

The devices and users assigned to a Group can access the device based on the permissions role granted to the Group.

• Administrator role: the users from this Group can see, apply operations and remote access all the devices added to the company. They also can manage the company-wide configurations at ZPE Cloud.

• Operator role: the users from this Group can see, apply operations and remote access only the devices added to the group. They cannot manage the company-wide configurations at ZPE Cloud.

• User role: the users from this Group can see and remote access only the devices added to the group. They cannot manage the company-wide configurations at ZPE Cloud neither Apply operations to the devices.

Note that Devices and users can be associated with more than one group, this way, a more granular and flexible access from users to the devices is possible. In example, one device may only be acessible to the users from Group A, while another device may be accessible and granted apply operations permissions to the users at Group B.

4.2     Adding Devices to a Group in ZPE Cloud

Adding devices to specific groups in ZPE Cloud helps organize and manage your network infrastructure effectively. By assigning devices to a group, it is possible to control access and visibility of devices for users in that group.

1. Log in into ZPE Cloud as an admin

2. Go to Groups::Devices

3. Select the devices you want to add to the group
    

4. Click Add

5. Select the group for the devices to be added to.

   

6. Click Add on Group

            Verifying that a Device is Added to the Group

1. Log into ZPE Cloud as an admin

2. Go to Groups::Devices

3. Click the All drop-down list

   All the available groups are listed.

4. Click the required group
   

5. See the list of devices added to your group

4.3     Adding Users to a Group in ZPE Cloud

Adding Users to specific groups in ZPE Cloud helps organize and manage the teams effectively. By assigning users to a group, it is possible to control access and visibility of devices for users in that group.

1. Log into ZPE Cloud as an admin

2. Go to Groups::Users

3. Select the Users to add to the group
    

4. Click Add

5. Select the group that the devices will be added to

   

6. Click Add on Group

            Verifying that a User is Added to the Group

1. Log into ZPE Cloud as an admin

2. Go to Groups::Users

3. Click the All drop-down list

   All the available groups are listed.

4. Click the required group
   

5. See the list of users added to the group

5.      Accessing Devices Remotely

Once these devices are enrolled in the ZPE cloud, it is possible to access them from anywhere via ZPE Cloud. To access the device remotely:

1. Log into the ZPE cloud

2. Go to Device::Enrolled

3. Navigate to the device to access

4. Click Connect

   1. To connect to the device using the web UI click Web

   2. To connect the device using the CLI,  click Console

      

5. Enter the Username and Password of the device and click login

   

   

   Congratulations! You are now successfully logged in to the Nodegrid Device

6.      Performing Basic Operations Using Profiles

Now that the devices have been enrolled in the ZPE Cloud, it is possible to perform different operations on these devices. The Profile tab allows performing various operations but in this document, we have covered some of the basic operations to get started. These operations are as follows:

• Scheduling Backup for a Nodegrid device using ZPE Cloud

• Restoring a Backup from ZPE Cloud

• Upgrading a Nodegrid Device using ZPE Cloud

6.1      Scheduling Backup for a Nodegrid Device using ZPE Cloud

ZPE Cloud enables managing on-demand and scheduled backups of your Nodegrid devices. To schedule the backup:

1. Log into ZPE Cloud

2. Go to Devices::Enrolled

3. Select the devices to back up and then click Backup

   It is possible to back up multiple devices at once.
   

4. Select the required type of File Protection:

   • None:  If selected, the backup file is not encrypted.

   • TPM Encrypted:  If selected, the backup is encrypted using the TPM key and it cannot be opened outside of the device.

   • Password Encrypted: If selected. the backup is encrypted using a file protection password. Backups with File Protection type as 'Password Encrypted' require File Protection enabled on the device, otherwise, the Backup will fail.

5. Select the File Storage

   • Temporary: The file is overwritten if it is the oldest file and the device's limit of 5 backups is reached.

   • Persistent: The file will not be overwritten by any other backup:
      

6. In the Apply section, select the schedule to run the backup: 

   • Now: The update procedure will start right after you click the Save button.

   • Schedule: You can select the start date and time for the update. You can make your backup Recurrent on an hourly, daily, weekly, or monthly basis.
      

7. Click Save

Backup Storage Limit

Every Nodegrid device is allowed to 5 backups persistent stored on ZPE Cloud. After the 5th backup is stored persistently, any new Backup request is rejected, being temporary or persistent. On the 5th Backup, if at least one of the stored backups is Temporary, the new Backup will delete the oldest Temporary Backup stored and become stored in its place, rotating the Temporary Backups.

ZPE Cloud Extended Storage app expands ZPE Cloud storage capabilities for Nodegrid devices with different subcriptions for Storage size, Download and Upload rates. It is useful to expand the Nodegrid device persistent storage limit to store any number of Backups that fits the choosen storage subscription on ZPE Cloud.

Backup Daily Limits

Every Nodegrid device is allowed to 10 backups daily performed. The limit resets everyday at 00:00 UTC. It can represent at customer choice, 10 recurrent scheduled Backups that executed on a day, or 10 scheduled/apply now Backups or a mix total of 10 recurrent scheduled or scheduled/apply now Backups that were performed that day.

Also, note, the Backup Daily limit is not cumulative, this way, 8 backups executed in a day, will not allow 12 backups to be executed on the next day. Once the limit is reached, requests for new Backups will result in the following error message: “Backup daily limit reached (10). Limit resets everyday at next 00:00 UTC“. For recurrent scheduled Backups, new Jobs generated to execute the schedule will fail automatically and the error message will be available at Job History under Profiles::Operations::<Job> page.

Scheduled Backup Limits

Every Nodegrid device is allowed to maximum of 10 scheduled Backups registered. It can represent at customer choice, 10 recurrent scheduled Backups, or 10 scheduled Backups or a mix total of 10 recurrent scheduled or scheduled Backups.

Once the limit is reached, the creation of a new Recurrent Backup will fail with an error message per Nodegrid device that reached the limit: “Device <hostname> <serial number> reached the maximum number of Recurrent schedules (10)”, in which, hostname and serial number will mention the Nodegrid devices that reached the limit and Nodegrid devices that did not reach the limit will successfully add new scheduled Backups.

6.2      Restoring a Backup from ZPE Cloud

ZPE Cloud allows restoring a backup of your Nodegrid devices in a few steps.

1. Log into ZPE Cloud

2. Go to Profiles::Backup

3. Select the backup image and click Restore

   It is possible to download the file to your local computer.
   

4. Select the device to restore and click Apply

   The restoration will start immediately.
    

6.3      Upgrading a Nodegrid Device using ZPE Cloud

ZPE cloud enables managing on-demand and scheduled software updates of the Nodegrid devices.

1. Log into ZPE Cloud

2. Go to Devices::Enrolled

3. Select the device to update and then click Software Upgrade

   It is possible to select multiple devices at once.
    

4. Select the image to use. ZPE provides the images.

   It is possible to use the search to find the images quickly. if you don’t find the required image, contact the ZPE Support team.

5. In the Apply section, select either of the following three options: 

   • Now: The update procedure will start right after clicking the Save button.

   • On First Connection: The moment the device changes the state from Never connected to Connected.

   • Schedule: Select the day and the hour of the device update.
      

6. Click Save