Install Guide
Install Guide
Guide
Published
2023-12-01
ii
Juniper Networks, the Juniper Networks logo, Juniper, and Junos are registered trademarks of Juniper Networks, Inc.
in the United States and other countries. All other trademarks, service marks, registered marks, or registered service
marks are the property of their respective owners.
Juniper Networks assumes no responsibility for any inaccuracies in this document. Juniper Networks reserves the right
to change, modify, transfer, or otherwise revise this publication without notice.
The information in this document is current as of the date on the title page.
Juniper Networks hardware and software products are Year 2000 compliant. Junos OS has no known time-related
limitations through the year 2038. However, the NTP application is known to have some difficulty in the year 2036.
The Juniper Networks product that is the subject of this technical documentation consists of (or is intended for use
with) Juniper Networks software. Use of such software is subject to the terms and conditions of the End User License
Agreement ("EULA") posted at https://support.juniper.net/support/eula/. By downloading, installing or using such
software, you agree to the terms and conditions of that EULA.
iii
Table of Contents
About This Guide | iv
1 Introduction
Virtual Lightweight Collector Overview | 2
System Requirements | 5
2 Install
Before You Install | 8
Verify Installation | 15
3 Configure
vLWC Configuration Overview | 17
4 Troubleshoot
Troubleshoot Network Settings | 29
iv
Use this guide to install the Juniper Networks® Virtual Lightweight Collector (vLWC) on a VMWare
infrastructure, perform initial software configuration, and troubleshoot issues with the vLWC network.
After completing the installation and basic configuration procedures coverd in this guide, refer to the JSI
Day One+ guide for information about further software configuration. See also: https://
www.juniper.net/documentation/product/us/en/juniper-support-insights/.
1 PART
Introduction
System Requirements | 5
2
IN THIS SECTION
Overview | 2
Overview
The Juniper Networks® Virtual Lightweight Collector (vLWC) is a VMWare-ready data collection tool for
the Juniper Support Insights. The vLWC is an alternative solution to the physical Lightweight Collector
(LWC). It brings the capabilities of the LWC in a virtual package to free physical rack space in your data
center by making use of your existing VMWare infrastructure.
Juniper Support Insights (JSI) is a cloud-based solution that provides IT and network operations teams
with actionable operational insights into Junos devices on customer networks. JSI aims to transform the
customer support experience by providing insights that help improve the network performance and
uptime.
The vLWC as a data collection tool is installed on the customer's premises. This provides an added
security to the data being collected as the data is locally collected and encrypted.
The Virtual Lightweight Collector (vLWC) is installed with three network interfaces where two of the
interfaces are the internal and external ports. The third interface is the management interface which will
be used to access the vLWC through a JSI shell or a Captive Portal web page to configure network
settings and troubleshoot issues. See Table 1 on page 3.
3
The vLWC solution is a single VMWare vApp Open Virtual Appliance (OVA) file deployed on a VMWare
virtual network. Anyone with an experience in deploying vApp on VMWare can deploy vLWC. You must
configure the network interfaces (int, ext, and cap) to proper networks before the installation process of
deploying the OVA file. Once installed in the VMWare environment, the vLWC vApp OVA package will
consist of the vApp itself and a virtual machine (VM) named ggc-lnx attached to the vApp. The ggc-lnx
VM runs the vLWC software and performs the data collection.
The following figure shows the overall deployment architecture for the vLWC, and how the vApp, VM,
network interfaces, and VMWare networks relate to each other:
4
System Requirements
IN THIS SECTION
VMWare Requirements | 5
Hardware Requirements | 6
Before installing the vLWC software in a VMWare environment, your system must meet the
requirements described in the following sections.
VMWare Requirements
Currently, VMWare is the only supported environment for vLWC, where it is deployed as a vApp OVA.
To run this vApp, your VMWare environment must meet the following minimum requirements:
Hardware Requirements
The ggc-lnx VM that runs the vLWC can be deployed in a small or large hardware configuration. Your
system must meet the minimum hardware requirements for the VM to run properly for the desired scale
of Junos devices being collected from. See Table 2 on page 6.
WARNING: The vLWC can experience data collection issues if your system does not
meet the minimum requirements. A lack of CPU and/or memory resources can cause
the vLWC to go into a holding pattern and stop collecting data.
2 PART
Install
IN THIS SECTION
To successfully install and deploy the vLWC, you must have VMWare vSphere installed on a single ESXi
server, VMWare vCenter Server, and you must meet the hardware requirements listed in "Hardware
Requirements" on page 6. You must also have one network with Internet connectivity either directly or
through an active proxy server along with the other requirements listed in "VMWare Requirements" on
page 5.
Before you begin the installation process for vLWC, you must prepare your VMWare vSphere:
• Make sure that you are able to connect to the vSphere and login to the vCenter Server. As the vLWC
will be deployed as a vApp in the vCenter Server, an active user on the vSphere with privileges to
deploy vApps is required for this installation process.
• Make sure that all the networks are created in vCenter Server to attach the three network interfaces
in the vLWC. These networks need to be setup and functional before vLWC is installed. For more
information, see "Virtual Network Interfaces for vLWC" on page 2.
The vLWC software will be provided to you by Juniper Networks® as a single downloadable OVA file.
Follow the steps below to request and download the vLWC software:
2. Fill the fields in the Request Virtual Lightweight Collector page with the necessary information. See
Table 3 on page 10.
9
An OVA file will be created specifically for your installation. The OVA file contains your serial number
as an encrypted vApp property that will be installed to the vLWC during the initial boot process of
the VM. Once the OVA file is created, you will receive an email with a link.
4. Open the email you received from Juniper Support Portal, and click the link to visit the download
portal where you can download the vLWC software.
NOTE: Ensure that you have a stable internet connection to download the vLWC software as
the file size can be between 2GB and 3GB approximately,
6. Once the vLWC software is downloaded, refer "Install vLWC and Verify Installation" on page 10 to
install the vLWC software and verify your installation.
10
Field Description
Recipients Email IDs associated with the selected account that will receive the vLWC
download link. These recipients can onboard devices in the vLWC.
Select virtual Lightweight Hardware configuration for the desired scale of Junos devices being collected
Collector Type from. Values include:
This section explains how you can install the vLWC Install vLWC using vCenter Server | 10
vApp on a VMWare environment and verify your Verify Installation | 15
installation.
8. Select the datastore you want to use for storing the virtual disk of the vLWC. Select Thick Provision
Eager Zeroed as the virtual disk format. Select your VM storage policy and click Next.
The Select networks page opens.
9. Select the VMWare network to attach to each network interface using the Destination Network
drop-down for each of the source network. You can ignore the IP allocation settings as they are not
used by the vLWC. Click Next.
12. Wait for VMWare to deploy the vApp. You should see progress bars in the recent tasks section
indicating the progress of the vApp deployment. This process can take approximately 30 minutes or
more depending on the speed of your cluster, datastores, and your connection to the vSphere.
NOTE:
• If you encounter any other error when you click Finish, it is possible that you took too
long to complete the steps above and the deployment process timed out. You can
reattempt the deployment process if this happens and if you encounter an error for the
second time, open a Juniper TAC case for assistance.
13. Once deployment is complete, to start vLWC, you can right-click the newly created vApp and click
Power > Power On from the Actions menu.
15
Verify Installation
Once installation is complete and vLWC is powered on, you can confirm a successful deployment
through the Summary page of the VM. The Summary page of the ggc-lnx VM is located under the vLWC
vApp entry. It should show an Ubuntu Linux (64-bit) VM running with VMWare tools also running along
with the IP addresses assigned to the VM in the IP addresses list. See Figure 3 on page 15.
From the Summary page, you can also launch a console connection to the VM and view the current
network status through the JSI Shell.
3 PART
Configure
Once the vLWC vApp is installed, you can add or modify various vLWC settings using one of the
following methods:
• JSI Shell; see "Configure Network Settings through JSI Shell" on page 17.
• Captive Portal web page; see "Configure Network Settings through Captive Portal" on page 21.
This section provides information on the JSI Shell. JSI Shell Overview | 17
The JSI Shell is an SSH menu system for the vLWC. It allows you to view the current network settings
and network status through an SSH login. You can use the JSI Shell as an alternate option to configure
network settings. You can interact with the JSI Shell menu system through the keyboard. See Table 4 on
page 17.
Key Action
Key Action
You can access the JSI Shell using one of the following ways:
• Through the VMWare console if networking has not been setup successfully yet on the management
(cap) interface. To login to the console, click ggc-lnx VM under the vLWC vApp and click either
Launch Web Console or Launch Remote Console in the Summary tab to open the login prompt for
the vLWC.
Use jsiuser and the hard coded password to log into the JSI Shell. You can also set a custom login
password from the JSI Shell. See "Change JSI Shell Login Password" on page 19.
NOTE: If you are changing the password for the first time, contact Juniper support to get the
initial password.
On successful login, the vLWC Main Menu (JSI Shell) screen appears. See Figure 4 on page 18.
You can change the login password for jsiuser from the JSI Shell Main Menu screen. To change the
password, select Change password for jsiuser from the vLWC Main Menu screen (using the arrow key or
pressing 6 on the keyboard), press Enter, and follow the prompts to specify the new password.
You can configure the following network settings from the JSI Shell:
• Active proxy
1. Login to the vLWC Main Menu (JSI Shell). See "Login to JSI Shell" on page 18.
2. Select Edit Network Settings (using the arrow key or pressing 3 on the keyboard) from the vLWC
Main Menu screen.
The vLWC Edit Network Settings Menu screen appears. See Figure 5 on page 19.
a. Select the interface you want to edit (options one to three) from the vLWC Edit Network Settings
Menu screen.
b. Select the appropriate options from the series of menus presented after which a vLWC Edit
interface Settings Menu screen appears for the interface you selected.
The upper half of the display lists the current network settings.
The following image provides an example of the vLWC Edit interface Settings Menu screen for a
cap interface with IPv4 address:
20
c. Use the options displayed in the bottom half of the display to modify the network settings. You
can select an appropriate option and configure the new value when the prompt appears.
The updated values will appear in the upper half of the display.
d. Once you have made all the changes, select Apply pending changes and return to network
settings to apply your changes.
NOTE: You can exit the settings from one interface and work on another interface without
losing your changes. You can then apply all changes at the same time.
a. Select Change active proxy (using the arrow key or pressing 4 on the keyboard) from the vLWC
Edit Network Settings Menu screen.
The vLWC Edit Active Proxy Settings Menu screen appears. The upper half of the display lists the
current active proxy settings. See Figure 7 on page 21.
21
b. You can enable or disable the active proxy (option 1), or configure the active proxy settings from
the vLWC Edit Active Proxy Settings Menu screen.
NOTE: After applying changes, if the network does not work as intended, reboot the vLWC.
You can use the Captive Portal web page to configure the following elements:
• External Network—Connect the vLWC to Juniper Cloud. You can use the External Network
configuration to perform device provisioning.
• Active Proxy—Use an active proxy in your network infrastructure to control access to the Internet.
Configuring an active proxy is optional.
1. Open a browser on your computer and enter the URL https://cap_interface_address in the address
bar, where cap_interface_address can be the configured static IP address, or the IP address assigned
by the DHCP server to the management (cap) interface.
The JSI Data Collector login page appears.
2. Enter the vLWC serial number in the Serial Number field and click Submit to log in.
NOTE:
22
versionserialversionserial
The following image displays the JSI Data Collector page when the vLWC is not connected.
NOTE: If the default DHCP configuration on the vLWC is successful, the Captive Portal web
page shows the vLWC's connection status as connected, and populates the fields in all the
configurations sections appropriately.
Click the Refresh icon under the External Network or Internal Network sections to refresh the
current connection states for that section.
The JSI Data Collector page displays configuration sections for the following:
• External Network—Lets you configure external network port that connects the vLWC to the
Juniper's Cloud. Supports DHCP and static addressing. The External Network configuration is
used to perform device provisioning.
• Internal Networks—Lets you configure the internal network port that connects the vLWC to the
Juniper devices on the network. Supports DHCP and static addressing.
• Active Proxy—Lets you configure the active proxy IP address as well as the port number if your
network infrastructure controls access to the Internet though an active proxy. You need not
configure this element if you are not using an active proxy.
23
3. Click the Edit button under the element that needs to be updated.
You need to modify the fields in:
• The Internal Network and External Network sections if their connection states indicate that they
are disconnected.
• The Active Proxy section if you are using an active proxy. This section is collapsed by default if an
active proxy is disabled or not configured. To configure, click Enable/disable to expand the Active
Proxy section.
If you choose to use an active proxy, ensure that it forwards all the traffic from the vLWC to the
AWS cloud proxy. Juniper cloud services blocks all the inbound traffic coming through any path
other than the AWS cloud proxy.
NOTE:
• You must use a different subnet for the IP address assigned to the internal network,
external network, and the management (cap) interface. This applies to both DHCP and
static configurations.
4. After modifying the fields, click Update to apply the changes and return to the homepage (the JSI
Data Collector page).
If you want to discard your changes, click Cancel.
If the vLWC connects to the gateway and DNS successfully, the respective configuration element
(internal or external network section) on the JSI Data Collector homepage shows the connection
status as Gateway Connected and DNS Connected with green tick marks against them.
The JSI Data Collector homepage displays the Connection Status as:
• Juniper Cloud Connected if the external connectivity to the Juniper Cloud is established and the
active proxy (if applicable) settings are correctly configured.
• Cloud Provisioned if the device is connected to Juniper Cloud and has completed the Zero Touch
Experience (ZTE) process. After the Cloud connection status becomes Juniper Cloud Connected,
it takes about 10 minutes for the provision status to become Cloud Provisioned.
The following image displays the JSI Data Collector page when the vLWC is connected successfully.
24
Table 5: Fields in the Configure Your Collector section on the JSI Data Collector page
Field Description
External Network
• IPv4
Table 5: Fields in the Configure Your Collector section on the JSI Data Collector page (Continued)
Field Description
Active Proxy
Port Enter the port number used for the active proxy.
Internal Network
• IPv4
• IPv6
Table 5: Fields in the Configure Your Collector section on the JSI Data Collector page (Continued)
Field Description
You can modify any vLWC network settings that you had configured in the Customize template page
during the installation of your vLWC vApp from the vCenter Server.
CAUTION: It is recommended that you prefer the JSI Shell or the Captive Portal web
page to modify the network settings, if possible. Changes made to the vApp properties
through the vCenter Server will overwrite all existing settings in the vLWC with the
property values, and you will have to change all settings to the correct values. Only use
this method as a last resort if you are unable to establish connectivity to the
management (cap) interface.
6. Select the vApp property and click Set Value at the top of the list. In the window that appears, enter
the new value for the vApp property. Repeat this step for all the required properties.
7. Once all the properties are updated, right-click your vLWC vApp from the list of hosts and clusters
and click Power > Power On.
The vLWC will reboot with the updated network configuration to ensure that all the changes are
applied correctly.
4 PART
Troubleshoot
IN THIS SECTION
If you face connectivity issues with the vLWC, you can troubleshoot the vApp VM using the Captive
Portal web page or the JSI Shell.
You can check the status of the management (cap) interface by accessing the Captive Portal at https://
cap_interface_address from the web browser. For more information on accessing the Captive Portal, see
"Configure Network Settings through Captive Portal" on page 21.
If the management (cap) interface is not accessible, you can access the JSI Shell through the VMWare
console. This option will always work even if none of the network interfaces are functioning properly.
You can use the JSI Shell menu system to check the current network status of the vLWC interfaces and
also change the network settings of any of the interfaces (external, internal, management).
You can use the JSI Shell to reset the network settings of vLWC to factory default of DHCP for IPv4 on
all interfaces, and reboot the vLWC to apply the changes. To perform this operation, select Reset vLWC
to factory defaults and reboot option from the vLWC Main Menu (JSI Shell). Select Yes in the
confirmation prompt.
On confirmation, you will see the output of scripts performing the reset operation. This operation may
take some time and vLWC reboots once the reset operation is complete. After vLWC reboots, you can
log back in to the JSI Shell and check the network status to confirm if IP addresses are received through
DHCP.
30
You can force VMWare to reload the current vApp property settings in the following cases:
• When the vApp properties modified through the vCenter Server did not get applied properly.
• When you need to revert the network changes made through the Captive Portal or JSI Shell to what
was set in the vApp properties.
To perform this operation, select Reapply vApp network properties to vLWC and reboot option from the
vLWC Main Menu (JSI Shell). Select Yes in the confirmation prompt.
On confirmation, you will see the output of scripts reapplying the vApp properties. This operation may
take some time and vLWC reboots to ensure that the settings are applied correctly.
You can confirm the current network status of the vLWC by selecting the View Current Network Status
option from the vLWC Main Menu (JSI Shell). vLWC performs reachability test on the network. This
operation might take some time to complete. Once the tests complete, the JSI Shell will display the
network status for each interface that is currently configured and operational in the vLWC Network
Status screen. For more information on each field, refer Table 6 on page 30.
Field Description
Field Description
Reboot the vLWC if the network settings that you modify do not apply properly to the underlying
Operating System of the vLWC. If you face issues while applying new network settings, always attempt a
vLWC reboot and confirm if the new network settings are applied before continuing with the other
troubleshooting options.
• JSI Shell—Select Reboot vLWC (using the arrow key or pressing 5 on the keyboard) from the vLWC
Main Menu, press, and confirm reboot.
• vCenter Server—Right-click ggc-lnx VM and click Power > Restart Guest OS from the Actions menu
to restart the VM.
If the vLWC does not connect to the cloud, you can click Download Light RSI in the Captive Portal web
page to download the light RSI file, create a Tech Case in the Juniper Support Portal, and attach the
downloaded RSI file to the case.
In some cases, the Juniper support engineer may ask you to attach the Extensive RSI file to the case. To
download it, click Download Extensive RSI.