icon-unified.svg
Experience Center

Managing Deployed Private Service Edges

After you deploy a Private Service Edge and complete the proper networking configurations, perform the following procedures to verify that the Private Service Edge is running and healthy, and that the sizing and scalability specifications you decided upon before deployment are still adequate for your organization's needs:

  • You can check the status of Private Service Edges in two ways:

    • Using the Private Service Edges page and Health dashboard. You can check the status by accessing the Private Service Edges page and using the Health dashboard within the Admin Portal.

      To check the Private Service Edge status using the Admin Portal:

      1. Go to the Service Edges page (Infrastructure > Private Access > Component > Private Service Edges). Check that the Private Service Edge you deployed appears in the table of configured Private Service Edges.

      2. Go to the Health Dashboard (Analytics > Reports > Private Applications > Health). Check that the Private Service Edge you deployed appears in the Service Edge widget. The Private Service Edge must have enrolled successfully at least once for it to appear within the Health dashboard.

        For example, if you deployed Test Private Service Edge Group -1, you see the following:

        • In Service Edges:

        • On the Health Dashboard, within the Service Edges widget:

          Health Dashboard with Service Edges widget displayed within the ZPA Admin Portal

      3. Using systemd. You can use systemd to check that the zpa-service-edge service is running on the local system.

        To check Private Service Edge status using systemd:

        1. Log in to the Private Service Edge console using your admin credentials.
        2. Enter the following command:
    [admin@zpa-service-edge~]$ sudo systemctl status zpa-service-edge
    1. A healthy Private Service Edge typically consists of two processes, the parent process and the child. However, if only the parent process is present, this could mean that the ZA Private Service Edge is not healthy. For example, the output below indicates a healthy Private Service Edge that is in an active/running status. Both the parent process of PID 2696 and the child process of PID 2705 are present.
    zpa-service-edge.service - Zscaler Private Access Service Edge                                                                                                                                                                                                                    Loaded: loaded (/usr/lib/systemd/system/zpa-service-edge.service; enabled; vendor preset: enabled)                                                                                                                                                                                                                                                                    Active: active (running) since Thu 2016-08-18 00:58:44 UTC; 2h 16min ago                                                                                                                                                                                                                                                                 Main PID: 2696 (zpa-connector)                                                                                                                                                                                                                                                                        CGroup: /system.slice/zpa-service-edge.service                                                                                                                                                                                                                                                                                ├─2696 /opt/zscaler/bin/zpa-service-edge                                                                                                                                                                                                                                                                                └─2705 zpa-service-edge-child
    1. The next example shows that the Private Service Edge (with parent process PID 2696) is in an inactive/stopped status:
    zpa-service-edge.service - Zscaler Private Access Service Edge                                                                                                                                                                                                                                                              Loaded: loaded (/usr/lib/systemd/system/zpa-service-edge.service; enabled; vendor preset: enabled)                                                                                                                                                                                                                                                                               Active: inactive (dead) since Thu 2016-08-18 03:19:03 UTC; 9s ago                                                                                                                                                                                                                                                                               Process: 2696 ExecStart=/opt/zscaler/bin/zpa-service-edge (code=killed, signal=TERM)                                                                                                                                                                                                                                                                               Main PID: 2696 (code=killed, signal=TERM)
    Close

  • After a Private Service Edge is deployed, check that the virtual machine (VM) image meets your requirements:

    1. Log in to the Private Service Edge console using your admin credentials.
    2. Enter the following command:
    [admin@zpa-service-edge ~]$ free -g

    Verify that the total available memory is at least 8 GB, as shown in the total column as the value 8. For example:

    [admin@zpa-service-edge ~]$ free -g
              total        used        free      shared  buff/cache   available
Mem:              8           0           3           0           0           8
Swap:             0           0           0
    1. Enter the following command:
    [admin@zpa-service-edge ~]$ cat /proc/cpuinfo | grep flags

    Check to see if the list includes the ht flag, which is highlighted in green within the following example:

    flags : fpu vme de pse tsc msr pae mce cx8 apic sep mtrr pge mca
cmov pat pse36 clflush mmx fxsr sse sse2 ht syscall nx rdtscp lm
constant_tsc rep_good nopl xtopology eagerfpu pni pclmulqdq ssse3 fma cx16
pcid sse4_1 sse4_2 x2apic movbe popcnt tsc_deadline_timer aes xsave avx
f16c rdrand hypervisor lahf_lm abm fsgsbase bmi1 avx2 smep bmi2 erms
invpcid xsaveopt
    1. Enter the following command:
    [admin@zpa-service-edge ~]$ cat /proc/cpuinfo | grep processor

    You should see a list of processors, for example:

    processor : 0
processor : 1
processor : 2
processor : 3

    If your list of flags included ht in step 3, then you should see a minimum of 4 processors displayed here. If not, then you should see a minimum of 2 processors.

    To learn more, see Private Service Edge Specifications and Sizing Requirements.

    Close

After verifying your deployment, perform the following procedures to manage and maintain the system:

  • The default admin account username is admin and the password is zscaler. For enhanced security, you must use the passwd command to change the credentials on the default admin account. If you forget a changed admin account password, Zscaler recommends deploying a new Private Service Edge rather than trying to recover it.

    To change the default admin account credentials:

    1. Log in to the Private Service Edge console using the default admin username and password.
    2. Enter the passwd command, then enter the current default password (zscaler).
    [admin@zpa-service-edge ~]$ passwd 
Changing password for user admin. 
Changing password for admin. 
(current) UNIX password:
New password:
Retype new password:
passwd: all authentication tokens updated successfully. 
[admin@zpa-service-edge ~]$
    1. Enter the logout command.
    [admin@zpa-service-edge ~]$ logout
    Close

  • To log in to the Private Service Edge console, enter the admin credentials.

    zpa-service-edge login: admin 
Password: *******

    After the initial boot of a Private Service Edge instance, it can take up to 15 minutes for the admin credentials to apply. So, if you receive an invalid credentials error after initial boot, wait a few minutes and try again.

    To log out of the Private Service Edge console, enter logout:

    [admin@zpa-service-edge ~]$ logout
    Close

  • The Private Service Edge is configured to start automatically at system boot. In some scenarios, it might be necessary to stop, start, or restart the Private Service Edge.

    1. Log in to the system hosting the Private Service Edge package via SSH, or log in to the local Private Service Edge console using your admin credentials.
    2. Using systemd, enter the appropriate command:

    Start:

    [admin@zpa-service-edge ~]$ sudo systemctl start zpa-service-edge

    Stop:

    [admin@zpa-service-edge ~]$ sudo systemctl stop zpa-service-edge

    Restart:

    [admin@zpa-service-edge ~]$ sudo systemctl restart zpa-service-edge

    The following logs might be seen in the Private Service Edge console when a Private Service Edge is restarted, upgraded, or downgraded. This potential error can be ignored:

    Mar 23 12:45:39 centos zpa-service-edge-child[18383]: Upgrade prep error for: Connector, err: ZPATH_RESULT_ERR, upgrade_id: 73195382414249455
    Close

  • The Private Service Edge records logs using the syslog facilities of the local Linux system.

    To view Private Service Edge logs:

    1. Log in to the Private Service Edge console using your admin credentials.
    2. Enter the following command:
    [admin@zpa-service-edge ~]$ sudo journalctl -u zpa-service-edge

    The information displayed includes the log output of the Private Service Edge to the local system logging facilities. Also, a running Private Service Edge periodically outputs status messages, for example:

    -------- Service Edge Status:ID=217246525011525974:Name=Test Service Edge-1:Ver=18.42.1 -------- 
Certificate will expire in 370 days, 21 hours, 39 minutes
Control connection state: fohh_connection_connected, local:[10.80.202.1]:53040 
remote:broker1a.ec2.prod.zpath.net...3.245]:443
RPC Messages: BrkRq = 0, BrkRqAck = 0, BindReq = 0, BindReqAck = 0, AppRtDisc = 0, 
AppRtReq = 0, DsnAstChk = 0
Broker data connection count = 0, backed_off connections = 0
Data Transfer: Total ToBroker = 0 bytes, Total FromBroker = 0 bytes 
Mtunnels: Total Created = 0, Total Freed = 0, Current Active = 0
Registered apps count = 0, alive app = 0, passive_health = 0, service_count = 0, 
target_count = 0, alive_target ...target = 0
    1. To create a text file containing the current Private Service Edge log information, use the following command:
    [admin@zpa-service-edge ~]$ sudo journalctl > dump-of-journalctl.txt

    Older Private Service Edge logs are automatically stored in the /var/log/messages file.

    Close

  • You can install monitoring or endpoint security tools on the Private Service Edge host operating system as long as the tools do not interfere with Zscaler processes or compete for resources. You must ensure that other tools do not consume host operating system resources to an extent that results in resources available for the Private Service Edge services dropping below minimum provisioning requirements. It is the organization’s responsibility to ensure that the tools you run don’t interfere with the proper operation of the internal processes and external communication of the Private Service Edge services.

    Close

  • You must re-enroll the Private Service Edge to replace its provisioning key or if it is moved to new hardware. For both cases, you must use a new key with the VM image you originally deployed.

    To replace a provisioning key for an Private Service Edge:

    1. Log in to the Admin Portal and go to Service Edges.
    2. Locate the Private Service Edge you want to replace the provisioning key for and click the Delete icon.
    3. In the confirmation window that appears, click Delete.
    4. (Optional) If you do not already have your new Private Service Edge provisioning key, be sure to complete the procedure for adding a new Private Service Edge with a new provisioning key.
    5. Log in to the Private Service Edge console using your admin credentials.
    6. To temporarily enable sshd, enter the following command:
    [admin@zpa-service-edge ~]$ sudo systemctl start sshd
    1. Enter the following command to stop the zpa-service-edge service:
    [admin@zpa-service-edge ~]$ sudo systemctl stop zpa-service-edge
    1. Enter the following command to remove the old provisioning key file:
    [admin@zpa-service-edge ~]$ sudo rm -rf /opt/zscaler/var/service-edge/
    1. Create a new provisioning key file with 644 permissions, at /opt/zscaler/var/service-edge/provision_key. For example:
    [admin@zpa-service-edge ~]$ sudo touch /opt/zscaler/var/service-edge/provision_key
[admin@zpa-service-edge ~]$ sudo chmod 644 /opt/zscaler/var/service-edge/provision_key
    1. Copy the provisioning key from the Admin Portal, paste it into the file, and save. Use an editor, such as vi.
    [admin@zpa-service-edge ~]$ sudo vi /opt/zscaler/var/service-edge/provision_key

    If you are unfamiliar with the vi editor, you can also use the following echo and tee commands to paste in the provisioning key:

    echo "<Service Edge Provisioning Key>" | sudo tee /opt/zscaler/var/service-edge/provision_key

    Make sure that the key is within double quotes (").

    1. Enter the following command to verify the file's content:
    [admin@zpa-service-edge ~]$ sudo cat /opt/zscaler/var/service-edge/provision_key

    The output should return the provisioning key you entered in the previous step.

    1. Enter the following command to start the zpa-service-edge service:
    [admin@zpa-service-edge ~]$ sudo systemctl start zpa-service-edge
    1. For all platforms, with the exception of AWS and Azure, enter the following command to disable sshd:
    [admin@zpa-service-edge ~]$ sudo systemctl stop sshd

    For AWS and Azure, make sure that you disable inbound access via port 22.

    Close

  • If you need to replace a deployed Private Service Edge using a new provisioning key on an existing VM image, complete the Replace a Private Service Edge provisioning key procedure above. If you need to replace a deployed Private Service Edge using an existing provisioning key on a new VM image, complete the following steps:

    1. Log into the Admin Portal and go to Service Edge Provisioning Keys.
    2. On the Service Edge Provisioning Keys page, locate the existing key you want to use and click the Edit icon.
    3. In the Edit Service Edge Provisioning Key window, increase the Maximum Reuse of Provisioning Key value to accommodate the number of Private Service Edges you are going to replace. To learn more, see Editing Private Service Edge Provisioning Keys.
    4. Deploy the new replacement Private Service Edge VM images using the existing provisioning key from step 3 above. By doing so, these new Private Service Edges automatically join the same Private Service Edge Group as the Private Service Edges you are replacing. To learn more, see the Deployment Guide for your Private Service Edge.
    5. When the new Private Service Edges are deployed, they appear within the Health dashboard. Verify that the new Private Service Edges in the Private Service Edge Group are enabled and showing an Up Time. To learn more, see Viewing Service Edge Details.
    6. Go to Service Edges.
    7. On the Service Edges page, locate the Private Service Edges you want to replace and click the Edit icon.
    8. In the Edit Service Edges window, set the Status to Disabled. To learn more, see Editing a Deployed Private Service Edge.
    9. Verify that user access to your applications is still working as desired.
    10. To ensure that all user traffic has fully transferred to the new replacement Private Service Edges, wait at least 24 hours before deleting the old disabled Private Service Edges.

    When the user sessions have expired on the disabled Private Service Edges, delete them within the Admin Portal and remove any old VM instances from your environment.

    Close

  • Occasionally, it might be necessary to update the operating system software to mitigate major security vulnerabilities that were discovered in Linux. Because the images are based on the open-source CentOS operating system, you can use existing facilities to update the system.

    To update the Private Service Edge system software:

    1. Log in to the Private Service Edge console using your admin credentials.
    2. Enter the following command to upgrade the local system software:
    [admin@zpa-service-edge ~]$ sudo yum update -y

    After running the sudo yum update command, the following response is returned. Zscaler handles the entitlement and recommends ignoring this response:

    Updating Subscription Management repositories.
Unable to read consume identity

This system is not registered with an entitlement server. You can use "rhc" or "subscription-manager" to register.
    1. After completing the update process, reboot the Private Service Edge using the following command:
    [admin@zpa-service-edge ~]$ sudo reboot
    Close

  • There are multiple ways to upgrade the Private Service Edge software package:

      1. Log in to the Private Service Edge console using your admin credentials.
      2. Edit the /etc/yum.conf file. Use an editor, such as vi.
      [admin@zpa-service-edge ~]$ sudo vi /etc/yum.conf

      Add the proxy server and port information as well as the proper authentication credentials for it, for example:

      # The proxy server - proxy server:port number
proxy=http://proxy.example.com:8080
# Proxy authentication
proxy_username=proxyusername
proxy_password=proxypassword
      1. Update the Private Service Edge software package using the following command:
      [admin@zpa-service-edge ~]$ sudo yum update
      1. After completing the update process, restart the Private Service Edge using the following command:
      [admin@zpa-service-edge ~]$ sudo systemctl restart zpa-service-edge
      Close
      1. Log in to the Private Service Edge console using your admin credentials.
      2. Update the ZPA Private Service Edge software package using the following command:
      [admin@zpa-service-edge~]$ sudo yum update zpa-service-edge
      1. After completing the update process, restart the Private Service Edge using the following command:
      [admin@zpa-service-edge ~]$ sudo systemctl restart zpa-service-edge
      Close
      1. Download one of the following RPM packages:
      2. Use the scp command to copy the RPM package to the Private Service Edge, for example:
      $ scp <RPM Version>
      1. Log in to the Private Service Edge console using your admin credentials.
      2. Update the Private Service Edge software package using the following command:
      [admin@zpa-service-edge ~]$ sudo rpm -Uvh zpa-service-edge-24.650.5-1.el9.x86_64.rpm
      1. Make sure that the update completes successfully, for example:
      [admin@zpa-service-edge~]$ sudo rpm -Uvh zpa-service-edge-24.650.5-1.el9.x86_64.rpm
[sudo] password for admin:
Preparing... ################################# [100%]
Updating / installing...
1:zpa-service-edge-24.650.5-1.el9 ################################# [ 50%]
Warning: zpa-service-edge.service changed on disk. Run 'systemctl daemon-reload' to reload units.
Cleaning up / removing...
2:zpa-service-edge-24.650.5-1.el9 ################################# [100%]
      1. Restart the Private Service Edge using the following command:
      [admin@zpa-service-edge ~]$ sudo systemctl restart zpa-service-edge
      Close
    Close
Related Articles
Managing Deployed Private Service EdgesMonitoring Private Service Edge PerformanceTroubleshooting Private Service Edges for Private Applications