Quick Start Guide

Leica Cyclone ENTERPRISE

Valid as of January 2022
Contents Introduction …………………………………………….…. 3

System Specifications ………………………………..…. 6

Installation & Licensing ……………………………...…. 14

Server Configurations & Scalability ………………..…. 25

Compatibility ………………………………………….…. 31

First-Time Login ……………………………………….... 34

Additional Features ………………………………….…. 37

Appendix A: Installing on AWS ………………….….…. 39

Appendix B: Installing on Microsoft Azure …………… 67

 Contents:

Leica Cyclone ENTERPRISE

Features & Benefits

Cyclone ENTERPRISE
Introduction
 Introduction
Leica Cyclone ENTERPRISE
A new, user managed, software solution for the reality capture market, that delivers a simplified management &
collaboration platform.

Powered by Leica Geosystems’ JetStream technology, Cyclone ENTERPRISE facilitates:

 Reality Capture Project Management

 Access to rich, full 3D Reality Capture data through desktop programs & web browsers
• Point clouds, imagery, models, & more

 Secure, flexible, self-managed deployment so you can meet your unique IT needs

4
 Introduction (cont’d)
Features & Benefits
 Centralized Management: Control user & data management features from
a simple, online, browser-based administration portal.

 Seamless Integration: Interoperability with all major CAD products from

Hexagon, Autodesk, Bentley, AVEVA, Dassault Systems & others via
CloudWorx & JetStream powered technology, delivering rich, reality capture-
based feature extraction & analysis workflows.

 Secure Project Access: Provide secure access to internal & external users
on a per-project basis. No data leaves the premise. Sessions are managed
centrally & remotely.

 Single Source of Truth: Eliminate redundant & duplicated data sources &
enable a common project view thereby improving quality & productivity.

 Web & Desktop Access: Access projects via a desktop viewer & CAD
plugins, as well as the no-install, online viewer, TruView LIVE, for quick
viewing & collaboration from anywhere on any device.

 Powered by JetStream: Cyclone ENTERPRISE harnesses the power of

Leica JetStream technology for rapid visualization & powerful collaboration.

5
 Contents:

Operating System

Deployments

Server Specifications

Client Machine Specifications

Cyclone ENTERPRISE Please see the white paper “Leica Cyclone ENTERPRISE: Scalability
& High-Performance Requirements” for additional information on how
to create scalability to meet your organisation’s needs.
System Specifications
 System Specifications (cont’d)
Note: No Linux or other server
Operating System environment is supported
 Only Windows deployment is available.
Note: It is recommended to use
 Supported Windows versions: Windows Server. Non-server versions
• Windows 10 of Windows have user session
limitations that may result in some
• Windows 10 Pro functions not working (see the
• Windows 10 Enterprise Troubleshooting chapter in the
• Windows Server 2016 (recommended) application’s Help for more info)

• Windows Server 2019 (recommended) Note: It is not recommended to

deploy within a VM environment.
Deployments Some features require a GPU,
requiring a GPU that supports vGPU
 It is recommended to deploy Cyclone ENTERPRISE on a dedicated
server machine to ensure optimal performance via full system capabilities for VM deployment. vGPU
resource allocation and reduce Port number collision. congifurations requires additional
specialized software, motherboard
 Cyclone ENTERPRISE supports cloud deployment on Amazon Web
Services (AWS) & Microsoft Azure (requires Windows instance). hardware, and complex system
configurations.

7
 System Specifications (cont’d)
Server Machine Specifications
Processor Recommended: 64 Cores, multi-threaded, at 4 GHz or higher
Minimum: 8 Cores, multithreaded, at 2.5 GHz or higher
RAM Recommended: 256 GB or higher
Minimum: 32 GB or higher
Graphics Recommended: 16 GB NVIDIA or AMD GPU with OpenGL 4.6 or newer support
Minimum: 8 GB NVIDIA or AMD GPU or higher with OpenGL 4.6 or newer support
Hard Disk Recommended:
• Installation drive: 2 TB* SSD
• Project Storage Location drive(s): SSD(s) of at least the minimum total project storage you will need
based on project quantity & average project size
Minimum:
• Installation drive: 1 TB* HDD
• Project Storage Location drive(s): HDD(s) of at least the minimum total project storage you will
need based on project quantity & average project size
Network (Server Recommended: 10Gbps on-premise & 100Gbps for cloud services
connection) Minimum: 1Gbps on-premise & 50Gbps for cloud services
Please see the Client Machine specifications for information about client device network requirements.

8 * See Notes in the next slide

 System Specifications (cont’d)
Server Machine Specifications (cont’d)
Hard Disk (cont’d)

Note: 1.25 GB is the minimum drive space required for application installation.

However, Project Import and Publish (as LGS) utilize temporary storage on the installation
drive. A typical import or publish will temporarily require approximately 2.5-times the size of the
project being imported or published (e.g., if you are importing a 100 GB LGS file, we suggest
having a minimum of 250 GB of free storage on the drive). Therefore, despite only needing 1.25
GB for installation, we recommended at least 1 TB (and possibly 2 TB or more) to accommodate
large project imports and publishes. You can use an exemplar project to refine the required
temporary storage capacity for both import and publish processes.

Project Storage drives can be added to the system via the Admin UI at any time, therefore
expanding your server capacity with additional storage is not a problem. However, if you
wish to estimate, we suggest taking an exemplar project, published as an LGS file. This should
give a baseline for per-project size and then multiply by the intended/estimated quantity of projects
to be managed in Cyclone ENTERPRISE

9
 System Specifications (cont’d)
Client Machine Specifications
Thin Client
 Hardware requirements: The Thin Client machine viewing the project via TruView LIVE does not need a
high-performance graphics card as the rendering is handled on the Server. Therefore, any reasonable
system, including lower-end tablet devices with a sufficient Wi-Fi connection, will be able to handle the
TruView LIVE session efficiently.
 Software Requirements: Cyclone ENTERPRISE works on all modern browsers. The following browsers
are tested and verified in benchmark testing.
• Chrome (Windows, MacOS, iOS, & Android)
• Safari (iOS)
• Firefox (Windows)
• Edge (Windows)

Note: Always be sure to have the latest

version installed.

10
 System Specifications (cont’d)
Client Machine Specifications (cont’d)
Thin Client (cont’d)
 Network Requirements: It is recommended to ensure the following performance specifications for the
Thin Client device's network/Internet connection.
• Latency: It is recommended to have latency under 25 milliseconds. Lower values are preferred.
• Bandwidth: A minimum of 100 Mbps for downstream is recommended. Higher values are preferred.

11
 System Specifications (cont’d)
Client Machine Specifications (cont’d)
Thick Client
 Hardware requirements: Cyclone ENTERPRISE projects can be seamlessly accessed by most of Leica
Geosystems Reality Capture products and the Powered by JetStream products from Leica Geosystems
and Partners.
• The Client machine requirements for connecting to Cyclone ENTERPRISE from a consuming product
such as TruView, CloudWorx, Map360, Cyclone 3DR, etc., is the same as the specification required by
the connecting product(s).
• The product datasheets and catalogues should be referenced for details.

12 * See Notes in the next slide

 System Specifications (cont’d)
Client Machine Specifications (cont’d)
Thick Client (cont’d)
 Network Requirements
• On-Premises Network: An Intranet connection minimum of 1 Gbps rate (10 Gbps recommended) is
needed for network of Thin Clients connecting to Cyclone ENTERPRISE Server.
• Internet (Cloud Deployment): It is recommended to ensure the following performance specifications
for a Thick Client machine's network/Internet connection.
o Latency: It is recommended to have latency under 25 milliseconds. Lower values are preferred.
o Bandwidth: A minimum of 100 Mbps for downstream is recommended. Higher values are
preferred.

13
 Contents:
Prepare for installation

Installing Leica Cyclone ENTERPRISE

Migrating JetStream Enterprise Projects

Installing on Amazon Web Services (AWS)

Installing on Microsoft Azure

Cyclone ENTERPRISE Installing Leica CLM & licensing

Installation & Licensing

 Installation & Licensing
Prepare for installation
Update Windows
 From Windows Update, Check for updates & apply all critical
security patches. Note: Do not run the Windows
Configure Antivirus/Antimalware Applications Update Service during Cyclone
ENTERPRISE installation.
 Disable antivirus/antimalware or other real-time protection
software, or configure antivirus/anti-malware software with the Note: Make sure that no system
following directory exclusions: reboot is pending. You should
reboot the computer after Windows
• %PROGRAMFILES%\Leica Geosystems\Cyclone Enterprise
Update before installation
• %PROGRAMDATA%\Leica Geosystems\Cyclone Enterprise
Note: Refer to your specific
• %COMMONPROGRAMFILES(x86)%\Leica Geosystems\License-
Serve antivirus software documentation on
how to configure directory
Install the .NET Framework exclusions.
 Make sure .NET Framework 4.6 or later is installed on Windows

15
 Installation & Licensing (cont’d) Note: You must have administrative
privileges on your Windows machine to
Installing Leica Cyclone ENTERPRISE correctly install Cyclone ENTERPRISE.
1. Right-click on the Cyclone ENTERPRISE setup file & select “Run
Note: Installation of Cyclone ENTERPRISE
as Administrator”.
requires at minimum 1.25 GB of storage
2. Follow the directions in the InstallShield Wizard. space for the application, but please see the
server specifications for recommended
3. Choose the Storage folder location & Select Next.
available storage.
4. To complete the installation:
Note: You cannot install Cyclone
a. Select Yes, I want to restart my computer now. ENTERPRISE on the same system as
b. Select Finish. JetStream Enterprise. Please see the next
slide for more information.

The installation will create & use the following folders: Note: If the installation is an update on the
 %PROGRAMFILES%\Leica Geosystems\Cyclone ENTERPRSE existing Cyclone ENTERPRISE, first, STOP
the server using the Cyclone ENTERPRISE
 %PROGRAMDATA%\Leica Geosystems\Cyclone ENTERPRSE Launcher (found in the system tray) to
proceed with the update.

16
 Installation & Licensing (cont’d)
Migrating JetStream Enterprise Projects Note: JetStream Enterprise & Cyclone
ENTERPRISE can NOT run
1. Uninstall JetStream Enterprise from the system. This will NOT remove
simultaneously on the same machine.
your project data.
2. Install Cyclone ENTERPRISE on the same system. Note: It is recommended to make a
backup of data of your Storage
3. During installation, Cyclone ENTERPRISE will detect the previous Locations before proceeding.
JetStream Enterprise database & migrate the Project Storage Location
information into the Cyclone ENTERPRISE database. Note: Once your JetStream Enterprise
4. After installation is complete, the Root user can login & navigate to projects are "reconnected" to the
Administration | Server | Storage Locations. Cyclone ENTERPRISE database, they
will NOT be backwards compatible.
5. Root user can use the "Reconnect" feature for each migrated Storage
Location to connect the data to the Cyclone ENTERPRISE database & Note: The server machine hardware
make the Projects available. requirements for Cyclone
6. All Projects in reconnected storage will be added to the Default Group. ENTERPRISE are very different from
the hardware requirements for
7. JetStream Enterprise has no concept of Users or Groups; it is therefore JetStream Enterprise in order to
recommending any user-access permissions and/or organization of support TruView LIVE.
Projects into Groups be conducted at this stage.

17
 Installation & Licensing (cont’d)
Installing on Amazon Web Services (AWS)

1. Create your AWS account 10. Launch EC2 Instance

2. Obtain AWS API Tokens 11. Obtain Administrator Password
3. Install AWS CLI v2 for Windows 12. Get Public IP Address of EC2 Instance
4. Configure AWS CLI Tool 13. Accessing Your EC2 Instance
5. AWS Region List 14. Initialize Data Storage Disk
6. Configure AWS Security Group for Cyclone 15. Stop Your EC2 Instance
ENTERPRISE
16. Restart Your EC2 Instance
7. Obtain Windows Server 2019 with NVIDIA Driver AMI
17. Install Leica CLM
8. Create New Key Pair
18. Install Leica Cyclone ENTERPRISE
9. Create Storage Config File
Note: See Appendix A for detailed instructions.

18
 Installation & Licensing (cont’d)
Installing on Microsoft Azure

1. Create a resource under Azure services in your account. 5. Modify Network Settings: Accept all default values.
2. Create a Virtual Machine (VM): 6. Modify Management Settings: Accept all default values.
o Assign a name. 7. Modify Advanced Settings:
o Select the Region to deploy. o Click “Select an extension to install”.
o Choose “No infrastructure redundancy”. o Select “NVIDIA GPU Driver Extension”.
o Select “Windows Server 2019 Datacenter (Gen1)”. o Ensure “Gen 1” is selected in VM generation setting
o Uncheck Azure Spot instance. o Ensure that NVIDIA GPU Driver Extension is listed.
o Select a memory size. 8. Click “Review” and “create”.
3. Specify user credentials for connecting to VM via RDP: o After a few moments, the summary page will be shown
o Allow accessing ports: Select RDP (3389), HTTP (80), stating that the VM settings passed validation.
HTTPS (443) in the inbound ports. o Once completed, a new resource containing VM will be
4. Modify Disk Settings: shown on the Resource groups page
o Select “Premium SSD (locally-redundant storage)”. 9. Obtain the VM’s IP Address
o Choose an Encryption type selection. o The IP address to be used for RDP to the VM.
o Uncheck Ultra Disk compatibility. 10. Install Leica CLM
o Choose “Create and attach a new disk”. 11. Install Leica Cyclone ENTERPRISE
o Click Change and Select a size for VM.
o Select NO for “Enable shared disk”. Note: See Appendix B for detailed instructions.

19
 Installation & Licensing (cont’d)
Installing Leica CLM & licensing
1. Install Leica CLM.
2. Open the Client License Manager for Floating Licenses located here in Windows:
Start Menu | All Programs | Leica Geosystems | Client License Manager (do
NOT choose the Node-locked CLM).
3. Choose the Activate new licenses option. Note: Cyclone ENTERPRISE
supports Client License Manager
4. Enter your Entitlement ID (EID) in the open field. To enter multiple EIDs separate (CLM), version 1.8.1 or newer.
them with a semicolon ";" & NO space.
5. After you have entered your EID, choose the Check for Activatable licenses to link Note: After a computer reboot, you
in the bottom right of the page. may need to wait for a few minutes
6. Once your licenses are activated, you can start using Cyclone ENTERPRISE. to restore the CLM server.

Using a Central/Remote CLM server Note: If you want to activate a

To use CLM on a separate machine, the following configuration file must be edited: license offline, follow instructions in
Leica CLM on setting up an EID
 “C:\ProgramData\Leica Geosystems\Cyclone ENTERPRISE\jetstreamconfig.ini”
(i.e., license) offline.
By default, the CLM server is set as the “localhost”
(LicenseManagerHostName=localhost), which is the same machine. You may replace
"localhost" with the IP address of the central/remote CLM server you wish to use.

20
 Contents:
Port Configurations

Firewall Rules

Setting up HTTPS connection…

Configuring Temporary Storage Locations…

Cyclone ENTERPRISE
Post-Installation System & Network Configurations
 Post-Installation System & Network Configurations
Port Configurations
 The default port number is 5050
 The customer can change it to other ports by editing the
configuration file. By default, the configuration file is named
“JetStreamConfig.ini” & is located at “C:\ProgramData\Leica
Geosystems\Cyclone ENTERPRISE”.
 See section Setting up HTTPS connection for Cyclone
ENTERPRISE for more information on changing port settings.

Firewall Rules
Firewall settings are required for all server machines.
 Cyclone ENTERPRISE needs sets of firewall rules to allow required Note: It is strongly recommended to
traffic by the program. allocate a dedicated machine for
 Cyclone ENTERPRISE's installer changes Windows firewall settings to running Cyclone ENTERPRISE to
allow inbound traffic on ports 80, 443, 5050 for both TCP & UDP. reduce the possibility of port number
 If the user modifies the port numbers, user must also update the collision.
Windows firewall rules to match the modified ports.

22
 Post-Installation System & Network Configurations (cont’d)
Setting up HTTPS connection for Cyclone ENTERPRISE
1. Purchase a domain name from a domain name registrar.
2. On the registrar website, create a DNS “A” record pointing to the public IP address of your Cyclone ENTERPRISE
server.
3. Allow inbound traffic.
4. On the Cyclone ENTERPRISE server, open the proxy configuration file "C:\Program Files\Leica
Geosystems\Cyclone Enterprise\Production\caddyfile" in a text editor.
5. Replace the second line with your Cyclone ENTERPRISE URL (e.g., cycloneenterprise.company.com).
6. Save the configuration file.
7. Open the Windows Task Scheduler. Locate CycloneEnterpriseHTTPSProxy in the list.
8. Right click on CycloneEnterpriseHTTPSProxy & select Enable.
9. Right-click on CycloneEnterpriseHTTPSProxy again & choose Run.
10. Verify that HTTPS is working by opening the URL in a browser, e.g., https://cycloneenterprise.company.com.

Note: See Cyclone ENTERPRISE Help document for full instructions.

23
 Post-Installation System & Network Configurations (cont’d)
Configuring Temporary Storage Locations for Import and Export

 The storage location can be modified within the “config.json” file in the
“C:\Program Files\Leica Geosystems\Cyclone ENTERPRISE\Production” folder.

Note: See Cyclone ENTERPRISE Help document for full instructions.

24
 Contents:

Scalability

Configurable Settings

Cyclone ENTERPRISE
Server Configurations & Scalability
 Server Configurations & Scalability
Scalability
 Cyclone ENTERPRISE is scalable to support enterprise-level needs. Cyclone ENTERPRISE can render an unlimited
number of points, store unlimited number of projects, & manage unlimited number of Users, & Groups*.

Point Cloud
Storage Users Projects Groups Licensing
Rendering

F U L L Y S C A L A B L E

Note: Please refer to scalability whitepaper & help document for more details.

Note: Groups are controlled by licensing, but any quantity can be purchased.
26
 Server Configurations & Scalability (cont’d)
Configurable Settings
 The configurable server settings allow customization based on performance & scalability needs.
 The scalability of a deployment depends on the number of concurrent users, workflows, & the server hardware.
• Streaming in TruView LIVE: It requires all computation & rendering to by handled by Cyclone ENTERPRISE.
Therefore, TruView LIVE is the most substantial consumer of server-side system resources.
• Streaming into Desktop Client Applications: Desktop client applications (e.g., CloudWorx, Cyclone 3DR, &
others) rely mostly on some computational power on the client machine, reducing dependency on server-side
resources. ​However, for running certain algorithms in CloudWorx server side, CPU and memory resources are
used.
• Number of cores per TruView LIVE session: Assigning a lower number of cores per TruView LIVE session
can assist with the larger volume of concurrent user; however, it may result in increased latency & degraded
performance per-user.
• Number of TruView LIVE sessions: Cyclone ENTERPRISE allows users to limit the number of TruView
sessions to prevent overloading the system & degrading performance.

Note: Please refer to Cyclone ENTERPRISE Scalability whitepaper & the application Help for more details.

27
 Server Configurations & Scalability (cont’d)
Configurable Settings (cont’d)
 Based on benchmark test results, default values are set for these parameters to ensure the performance of
the system.
 The following table provides the default values:

Parameter Description Default Value

Cores Number of CPU Cores per TruView LIVE session 4
Number of shared CPU Cores for TruView LIVE
SharedCores 'processor overflow' & reserved cores for other 4
processes
Dynamic Resolution during movement (e.g., 3D orbit
DynamicPixel 250,000 pixels
or flythrough modes)
Number of Cached Neighboring Setups to improve
CachedSetups 20
setup-to-setup transitioning

Note: Please refer to Cyclone ENTERPRISE Scalability

whitepaper & Help documentation for more details.
28
 Server Configurations & Scalability (cont’d)
Configurable Settings (cont’d)

 The TruView LIVE parameters can be modified by editing the TruViewLIVE.ini configuration file in
“C:\ProgramData\Leica Geosystems\Cyclone ENTERPRISE” folder.

 The number of TruView LIVE sessions is controlled by defining the range of accessible ports
under the “FrameServer” configuration list of "ports". This is found in the config.json file located
in the “C:\Program Files\Leica Geosystems\Cyclone ENTERPRISE\Production” folder.

Note: See Cyclone ENTERPRISE Help

documentation for full instructions.

29
 Server Configurations & Scalability (cont’d)
Configurable Settings (cont’d)

Parameters Qty or Size Latency

▲ 
Number of CPU Cores Legend:
 ▲
▲ Increases by increasing the parameter value
▲ 
Shared number of CPU Core  Decreases by increasing the parameter value
 ▲
 Favorable impact
▲ ▲  Unfavorable impact
Dynamic frame resolution
 
Note: Please refer to Cyclone ENTERPRISE
▲  Scalability & High-Performance whitepaper &
Number of Cashed Setups Help documentation (post installation) for more
 ▲
details.

30
 Contents:
Features

Importing Project Files

Cyclone ENTERPRISE
Compatibility
 Compatibility
Features

Cyclone Cyclone Rithm powered

Feature vs Product CloudWorx TruView TruView LIVE
CORE REGISTER 360 (All Modules) (f.k.a., JetStream Viewer)
by JetStream
(including BLK Ed.)

Publish to Cyclone 2021.0 &

2021.0 & higher n/a n/a n/a n/a
ENTERPRISE higher
Open Cyclone
n/a n/a 2021.0 & higher 2021.0 & higher 2021.0 & higher 2021.0 & higher
ENTERPRISE Projects
Add Models n/a n/a n/a 2021.0 & higher n/a n/a

Edit Models n/a n/a n/a 2021.0 & higher 2021.0 & higher n/a

Add GeoTags * * 2021.0 & higher 2022.0 & higher 2022.0 & higher n/a

Edit GeoTags n/a n/a 2021.0 & higher 2021.0 & higher 2021.0 & higher n/a

Add/Edit Snapshots n/a n/a 2021.0 & higher 2021.0 & higher 2021.0 & higher n/a
Access & Download
n/a n/a 2021.0 & higher 2021.0 & higher 2021.0 & higher n/a
Assets

* GeoTags can be added from Cyclone CORE and Cyclone REGISTER 360 prior to publishing to Cyclone ENTERPRISE.
32
 Compatibility (cont’d)
Import Project Files

Cyclone Cyclone
LGS ENTERPRISE 2021.0 JSA ENTERPRISE 2021.0
& higher & higher
- - 1.4.1 
1.5.1  1.5.1 
1.6.0  1.6.0 
1.6.2  1.6.2 
2020  2020 
2020.1  2020.1 
2021  - -

33
 Contents:

Launch Cyclone ENTERPRISE

First-time Login Credentials

Cyclone ENTERPRISE
First-Time Login
 First-Time Login
Launch Cyclone ENTERPRISE
 Cyclone ENTERPRISE can be opened using any supported
web browser.
 The default address and port for Cyclone ENTERPRISE are
Note: See the list of supported browsers in
as follows: the Software Requirements section.
• Address: localhost
Note: The http://localhost:5050/ is for
• Port: 5050 accessing Cyclone ENTERPRISE on the
 To access the address, type http://localhost:5050/ in the machine on which it is installed.
browser
Note: If you are accessing Cyclone
ENTERPRISE from another machine on
the same network, replace "localhost" with
the IP address of the Windows machine
Cyclone ENTERPRISE is installed on (e.g.,
http://192.0.0.0:5050).

35
 First-Time Login (cont’d)
First-time Login Credentials
 During installation, a default Root user is created.
 The Root user credentials are required when logging Note: Once logged in for the first time as
into Cyclone ENTERPRISE for the first time. Root, you may begin creating other users.

 The username and password for the "Root" user Note: You will be required to change the
account are as follows: default password for the Root user upon
first login.
• Username: root
• Password: root Note: The default root user password
("root") is only valid for 48 hours after
Cyclone ENTERPRISE is installed and the
server is initiated. If you do not login within
this period, you will be required to reset the
root user's password by running the
“ResetPassword.exe” utility in the
application’s installation directory.

36
Cyclone ENTERPRISE
Additional Features
 Additional Features
To setup and run Cyclone ENTERPRISE, additional features are provided. Please refer to Cyclone
ENTERPRISE Help Document and published Whitepapers for more details.

Some of the important features include:

 Creating and Editing Users

 Publishing and Uploading to Cyclone ENTERPRISE

 Managing Projects in Cyclone ENTERPRISE

 Checking license status

 Customizations

 Downstream Consumption

 and more

38
 Introduction
Create AWS account
Obtain AWS API Tokens
Install AWS CLI v2 for Windows
Configure AWS CLI Tool
AWS Region List
Configure AWS Security Group for Cyclone ENTERPRISE
Contents: Obtain Windows Server 2019 with NVIDIA Driver AMI
Create New Key Pair
Create Storage Config File
Launch EC2 Instance
Obtain Administrator Password
Get Public IP Address of EC2 Instance
Accessing Your EC2 Instance
Appendix A: Initialize Data Storage Disk
Stop Your EC2 Instance
Installing & Licensing on Restart Your EC2 Instance
Installing Leica CLM & licensing
Amazon Web Services (AWS) Installing Leica Cyclone ENTERPRISE
 Installing & Licensing on Amazon Web Services (AWS)
Introduction
This section provides instructions for deploying Cyclone ENTERPRISE on the cloud when running the Cyclone
ENTERPRISE server on Amazon Web Services (AWS).

Note: This guide assumes you have experience with the

Windows command-line interface.

Note: Prior experience with AWS is not required but is

helpful.

Note: Customers with an existing AWS account can skip

section Create your AWS account and proceed to section
Obtain AWS API Tokens. As a best security practice, we
recommend that you create a new IAM user specifically
for Cyclone Enterprise. Instructions for this task are in the
section.

40
 Installing & Licensing on Amazon Web Services (AWS)
Create AWS account
1. Open https://aws.amazon.com.
2. Select Create an AWS Account at the top right corner of the page.
3. Enter your account information, and then choose Continue. Ensure
that your account information is accurate.
4. Select Professional. Note: Account activation may take up to an
5. Enter your company information. hour.
You will be notified by email when your
6. Accept the AWS Customer Agreement. account is ready.
7. Choose Create Account and Continue.
Note: For more information on the AWS
8. Enter your credit card information. Your AWS usage expenses will signup process, see
be charged on this card. Click Verify and Add. https://aws.amazon.com/premiumsupport/k
9. Choose SMS or Voice call and your mobile phone number to nowledge-center/create-and-activate-aws-
confirm your identity. account/.
10. Select Basic Plan for the support plan.

41
 Installing & Licensing on Amazon Web Services (AWS)
Obtain AWS API Tokens
Once you receive an email indicating that your account is ready, follow these instructions to get API tokens
needed for Cyclone ENTERPRISE deployment.

1. Open https://console.aws.amazon.com/ 6. Select Users on the left panel.

2. Select the Root User. 7. Click Add User.
3. Enter the email address that you used for AWS 8. Enter your username.
registration. Click Next. 9. Select both Programmatic access and AWS
4. Enter the password. Click Sign In. Management Console access.
5. Enter “iam” in the search at the top of the page. 10. Choose a Custom password and enter your
You will immediately see the IAM entry under password. Security best practice dictates that you
Services. Click IAM. should pick a new password that is different from
that of your root username account.
11. Uncheck User must create a new password at next
sign-in.
12. Click Next: Permissions.

42
 Installing & Licensing on Amazon Web Services (AWS)
Obtain AWS API Tokens (cont’d)

43
 Installing & Licensing on Amazon Web Services (AWS)
Obtain AWS API Tokens (cont’d)

13. Select Attach existing policies directly. 16. Click Next: Tags.
17. Click Next: Review.
18. Click Create User.
19. Click the Download .csv button. Keep the .csv file
in a safe location. The file contains your Access
key ID, Secret access key, and your Management
Console access

14. Per good security practices, users should be given

the lowest level of permissions to get their job
done. We suggest creating a new IAM user that
has access to EC2 resources only. Enter
"amazonec2fullaccess" in the search box.
15. Select AmazonEC2FullAccess entry in the Policy
name table.

44
 Installing & Licensing on Amazon Web Services (AWS)
Obtain AWS API Tokens (cont’d)

20. Access key ID and Secret access key are your API
tokens. This is the only time AWS displays your API
tokens. Make sure you write them down.
21. Note: Do NOT share the Access key ID and Secret
access key with ANYBODY.
22. Save the URL for accessing AWS Management
Console.
23. Click Close.

45
 Installing & Licensing on Amazon Web Services (AWS)
Install AWS CLI v2 for Windows
The AWS CLI tool is a command-line tool to manage your AWS services. The AWS CLI tool greatly simplifies
AWS operations including EC2 instance deployment.

1. Download tzhe AWS CLI MSI installer for Windows:

https://awscli.amazonaws.com/AWSCLIV2.msi
2. Run the MSI installer and follow the on-screen instructions.
3. To verify the installation, open the Command Prompt window
and type "aws --version". Note: The provided sample
commands are not compatible with
PowerShell unless noted.

Note: Your version may vary, but

this will ensure the CLI tools is
correctly installed.

46
 Installing & Licensing on Amazon Web Services (AWS)
Configure AWS CLI Tool

1. Enter “aws configure” in the Command Prompt window.

2. Enter the Access Key ID and Secret Access Key that you
obtained earlier.
3. Press Enter again to accept "None" for "Default output
format".

Note: Refer to the AWS Region List table in the following section. Look
up the Region ID (e.g., eu-west-2) of the city closest to you.

47
 Installing & Licensing on Amazon Web Services (AWS)
AWS Region List

Region Name Region ID Region Name Region ID

Virginia us-east-1 Hong Kong ap-east-1
Ohio us-east-2 Mumbai ap-south-1
Oregon us-west-2 Seoul ap-northeast-2
N. California us-west-1 Singapore ap-southeast-1
Canada - Central ca-central-1 Sydney ap-southeast-2
Frankfurt eu-central-1 Tokyo ap-northeast-1
Ireland eu-west-1 Bahrain me-south-1
London eu-west-2 São Paulo sa-east-1
Milan eu-south-1 Cape Town af-south-1
Paris eu-west-3 Stockholm eu-north-1

Note: Note: Please check AWS resources for possible changes.

48
 Installing & Licensing on Amazon Web Services (AWS)
Configure AWS Security Group for Cyclone ENTERPRISE
An AWS Security Group is a firewall for your EC2 instance to control inbound and outbound traffic.

1. Create a new security group named "secgroupcyent“

• aws ec2 create-security-group --group-name secgroupcyent --description security-
group-for-Cyclone-Enterprise

Note: Continuing in the command prompt, enter the

following.

Note: It is highly recommended to copy and paste the

commands into a text editing program, e.g., Notepad
++, to review the code (e.g., remove empty lines)
before entering in the command line.

Note: The placeholders in the code that are tagged by

"<>" should be revised to match your information such
as IP address, AMI ID, Instance ID, etc.

49
 Installing & Licensing on Amazon Web Services (AWS)
Configure AWS Security Group for Cyclone ENTERPRISE (cont’d)
2. Create rules that control incoming traffic to your EC2 instance. By default, only three ports are open for inbound
traffic: 3389 (remote desktop), 443 (https), and 80 (http).
• aws ec2 authorize-security-group-ingress --group-name secgroupcyent --protocol tcp -
-port 3389 --cidr <your IP address>/32
• aws ec2 authorize-security-group-ingress --group-name secgroupcyent --protocol tcp -
-port 443 --cidr 0.0.0.0/0
• aws ec2 authorize-security-group-ingress --group-name secgroupcyent --protocol tcp -
-port 80 --cidr 0.0.0.0/0
3. Optionally, create a rule that allows inbound traffic on Cyclone ENTERPRISE’s default port 5050.
• aws ec2 authorize-security-group-ingress --group-name secgroupcyent --protocol tcp -
-port 5050 --cidr 0.0.0.0/0

50
 Installing & Licensing on Amazon Web Services (AWS)
Obtain Windows Server 2019 with NVIDIA Driver AMI

Use the following command to find the latest Microsoft Windows Server 2019 with NVIDIA driver AMI ID for your
region.
• aws ec2 describe-images --filters "Name=name,Values=*windows-server-2019-vGaming*" --
output json --query "sort_by(Images, &CreationDate)[-1].[ImageId]“

In the above example, the AMI ID is “ami-0dd72aaea6cfc25f1”.

Alternatively, you can locate the region in the table below that is closest to you and its AMI ID

Note: Search online for “NVIDIA Gaming PC - Windows Server 2019”

51
 Installing & Licensing on Amazon Web Services (AWS)
Obtain Windows Server 2019 with NVIDIA Driver AMI (cont’d)

Currently, some of the regional AMI IDs are as the followings (subject to change):

Region AMI ID Region AMI ID

Virginia ami-0b66e8e7b0afc8be2 London ami-097dc276efcc881f6
Ohio ami-0147100c2f00ccbe9 Paris ami-0d541568461085683
Oregon ami-04308b8ea71bf4d67 Stockholm ami-08315628a321d0f62
N. California ami-0dd72aaea6cfc25f1 Singapore ami-0186e18f594075934
Canada - Central ami-0be1644c5e0af3d05 Sydney ami-07b464682a7ef0108
Frankfurt ami-0d1e1c5d07d06bcf3 Tokyo ami-0f8a3a1d1446b963d
Ireland ami-0bdd2f8c63e3cd8c1 Seoul ami-093179249cbbb7d04

Note: NVIDIA regularly publishes new updated AMIs and

so the list of AMI IDs will constantly change.

52
 Installing & Licensing on Amazon Web Services (AWS)
Create New Key Pair

A key pair is a set of credentials that you use to authenticate your identity to gain access to a computer.

This step creates a key pair file called "cyent-key-pair" that you will use to access your EC2 instance. Ensure
you keep the output file ‘cyent-key-pair.pem’ in a safe location.

aws ec2 create-key-pair --key-name cyent-key-pair --output text --

query KeyMaterial > cyent-key-pair.pem

Note: DO NOT LOSE THIS FILE!

53
 Installing & Licensing on Amazon Web Services (AWS)
Create Storage Configuration File

Create a new text file named "blockdevice.json" with the following contents:

The following configuration creates a 100GB C drive (DeviceName: /dev/sda1) and 300GB D drive
(DeviceName: /dev/sda2) for your EC2 instance. We recommend that you use the D drive as a data storage
location. You can adjust the “VolumeSize” value (in GB) for /dev/sda2 to meet your data storage requirement.
{
"DeviceName": "/dev/sda1", Note: Please reference the section on Initialize Data Storage Disk in
"Ebs": { this document for details.
"DeleteOnTermination": false,
"VolumeSize": 100,
Note: A 3rd device will be also listed on the server. This device is called
"VolumeType": "gp2"
} an EC2 instance storage volume, which accompanied with the GPU
}, instance. The data on this device is only stored temporarily, and all the
{ data will be deleted after restarting or shutting down the EC2. For more
"DeviceName": "/dev/sda2", information, please see the following links:
"Ebs": { • https://docs.aws.amazon.com/whitepapers/latest/aws-storage-
"DeleteOnTermination": false, services-overview/amazon-ec2-instance-storage.html
"VolumeSize": 300, • https://aws.amazon.com/premiumsupport/knowledge-
"VolumeType": "gp2" center/instance-store-vs-ebs/
}
54 }
 Installing & Licensing on Amazon Web Services (AWS)
Launch EC2 Instance

Cyclone ENTERPRISE requires a GPU-based instance such as

‘g4dn’ to function. Note: The placeholders in the code that are
tagged by "<>" should be revised to match
For best performance, we recommend ‘g4dn.2xlarge’ as the your information such as IP address, AMI ID,
minimum instance type for the Cyclone ENTERPRISE server. EC2 Instance ID, etc.
pricing varies based on several factors including region, upfront
payment amount, and duration. Note: For complete EC2 pricing information,
please refer t:
Launch a new EC2 instance using the AMI ID from a previous step. https://aws.amazon.com/ec2/pricing/reserved
-instances/pricing/windows/#ris-nav
aws ec2 run-instances --instance-type g4dn.2xlarge --
image-id <AMI ID> --key-name cyent-key-pair --block-
device-mappings file://blockdevice.json --security-
groups secgroupcyent

55
 Installing & Licensing on Amazon Web Services (AWS)
Launch EC2 Instance (cont’d)

If you see this error, open the link shown in a browser.

Click Continue to Subscribe.

Click Accept Terms.

Note: For security purposes, you may have to re-authenticate by logging

into the AWS Management website again. Login using the credentials you
used in the Create Your AWS Account section.

56
 Installing & Licensing on Amazon Web Services (AWS)
Launch EC2 Instance (cont’d)

Wait a few moments. The following screen will appear. You can log out from the AWS Management
website at this point.

Note: Verify that the Software/hr prices

are all zero. The Windows Server 2019
with NVIDIA Driver AMI is provided at no
cost. However, you are still responsible
for AWS charges for all AWS resources
used.

57
 Installing & Licensing on Amazon Web Services (AWS)
Launch EC2 Instance (cont’d)

Repeat the EC2 launch command.

aws ec2 run-instances --instance-type

g4dn.2xlarge --image-id <AMI ID> --key-name
cyent-key-pair --block-device-mappings
file://blockdevice.json --security-groups
secgroupcyent

A screen similar to the following will appear after a few

moments. Note the “InstanceId” value (e.g., “i-
0e51c56d597c3f5c6”).

AWS is provisioning your EC2 instance at this time.

After a few minutes, run the following command to
check the status of your EC2 instance.

aws ec2 describe-instance-status --instance-

ids <instance id >

58
 Installing & Licensing on Amazon Web Services (AWS)
Launch EC2 Instance (cont’d)

Run the following command

aws ec2 describe-instance-status --instance-ids

<instance id >

Verify that all Status values are “passed”. If either Status shows
“initializing”, wait a few minutes and repeat the command until both Status
show “passed”.

Note: The placeholders in the code that are tagged by "<>"

should be revised to match your information such as IP address,
AMI ID, Instance ID, etc.

59
 Installing & Licensing on Amazon Web Services (AWS)
Obtain Administrator Password

Locate the ‘cyent-key-pair.pem’ key file that you created in the

Create New Key Pair section above. To retrieve your
administrator password, you need to specify both your Note: The placeholders in the code that are tagged
“InstanceId” and your key file. by "<>" should be revised to match your
information such as IP address, AMI ID, Instance
aws ec2 get-password-data --instance-id ID, etc.
<InstanceId> --priv-launch-key <your cyent-key-
pair.pem>

If PasswordData is empty (as shown below), AWS is still

provisioning your EC2 instance. Wait 5-10 minutes and repeat
the command.

Once EC2 provision is complete, the PasswordData string is

the Windows’ administrator password for your EC2 instance.

60
 Installing & Licensing on Amazon Web Services (AWS)
Get Public IP Address of EC2 Instance

aws ec2 describe-instances --instance-ids

<InstanceId> --
query "Reservations[].Instances[].PublicIpAddress" Note: The placeholders in the code that are
tagged by "<>" should be revised to match your
information such as IP address, AMI ID, Instance
ID, etc.

Note: In most cases, AWS will assign a new

public IP address to your EC2 instance after
rebooting.

Note: For instruction on how to get an Elastic IP,

please see AWS documentation.

61
 Installing & Licensing on Amazon Web Services (AWS)
Accessing Your EC2 Instance
Once the administrator password and the public IP of the EC2 instance
are set, you can access the instance

1. Running the Remote Desktop Connection program.

2. Click Show Options.
3. Enter your EC2 instance’s IP in the Computer box.
4. Enter <your EC2 instance’s IP>\Administrator in the User name box.
5. Click Connect.
6. Enter your password from the previous step.
7. Click OK.
8. On the next dialog, select Don’t ask me again for connections to this
computer. Click Yes.
9. The Remote Desktop window will open after a few seconds.
10. Follow Cyclone ENTERPRISE installation instructions to install
Cyclone ENTERPRISE on your EC2 instance.

62
 Installing & Licensing on Amazon Web Services (AWS)
Initialize Data Storage Disk
By default, AWS doesn’t automatically initialize a second storage drive (i.e., the 300GB D drive).
Perform these steps to initialize the data drive:

1. Connect to your EC2 instance using Remote Desktop

Connection.
2. Open PowerShell window (press the Windows key and
type powershell). Select “Windows PowerShell” in
the context menu.
3. Initialize the second disk.

Initialize -Disk -Number 1 -

PartitionStyle MBR

4. Create a new partition on the second disk.

5. Format the new partition.

63
 Installing & Licensing on Amazon Web Services (AWS)
Stop Your EC2 Instance
In some cases, you may wish to stop your EC2 instance to reduce your
AWS charges when you know the system will not be in use. To do so,
please follow these steps:
1. Access your server via Remote Desktop Connection.
2. Click the Windows button
3. Select Power.
4. Select Shut down.
5. Select Continue.

Note: Your EC2 instance will be stopped after a

few minutes.

64
 Installing & Licensing on Amazon Web Services (AWS)
Restart Your EC2 Instance
To restart your existing Cyclone ENTERPRISE EC2 instance:
1. Open the command prompt window.
2. Start your instance using the AWS CLI command. You will need your
instance ID from the Launch Your EC2 Instance section.
aws ec2 start-instances --instance-ids <instance id>

3. After a few minutes, run the following command to check the status of Note: The placeholders in the code
your EC2 instance. that are tagged by "<>" should be
aws ec2 describe-instance-status --instance-ids <instance revised to match your information such
id> as IP address, AMI ID, Instance ID,
etc.
4. Verify that all Status values are “passed”. If either Status shows
“initializing”, wait a few minutes and repeat the command until both Note: You can use the same Windows
Status’ show “passed”. administrator password to log on to
5. In most cases, AWS will assign a new public IP address to your EC2 your EC2 instance via Remote
instance. Refer to the Get Public IP Address of EC2 Instance section for Desktop Connection.
instructions to query an instance’s public IP address.

65
 Installing & Licensing on Amazon Web Services (AWS)

Installing Leica CLM & licensing

• Same as the regular installation in the Installing Leica
CLM and Licensing Section.

Installing Leica Cyclone ENTERPRISE

• Same as the regular installation in the Installing Leica
Cyclone ENTERPRISE section.

66
 Introduction

Create Resource in Azure

Setup Virtual Machine

Create New Disk

Network Settings

Contents: Management Settings

Advanced Settings

Review & Finalize

Obtain the VM IP Address

Installing Leica CLM & licensing

Installing Leica Cyclone ENTERPRISE

Appendix B:
Installing & Licensing on Microsoft Azure
 Installing & Licensing on Microsoft Azure
Introduction
This section provides instructions for deploying
Cyclone ENTERPRISE on Microsoft Azure.

68
 Installing & Licensing on Microsoft Azure
Create Resource in Azure
1. Log into your Azure account.
2. On the main page, select “Create a resource” under Azure
services.

3. Under Windows Server 2019 Datacenter, select Create.

4. On Create a virtual machine page, select your active subscription.
5. Leave the default value in the Resource group box as “(New)
Resource Group”.

Note: An active Azure account with a valid subscription is required.

69
 Installing & Licensing on Microsoft Azure
Setup Virtual Machine Note: The selected region must support NVv3-series
1. Enter the virtual machine name, e.g., vmcyent1 VMs.
2. Select the Region where you want to deploy the VM.
Note: NV-series VMs are only available in select
3. Choose “No infrastructure redundancy required” in the region. For availability of NV-series VMs, see
Availability options. https://azure.microsoft.com/en-us/global-
4. Select “Windows Server 2019 Datacenter – Gen1” infrastructure/services/?products=virtual-machines.

5. Uncheck Azure Spot instance. Note: Cyclone ENTERPRISE has been tested on
6. In the Size dropdown box, select “Standard_NV12s_v3 – NVv3-series virtual machines powered by Intel Xeon
12 vcpus, 112 GiB memory (your estimated monthly E5-2690 v3 and NVIDIA Tesla M60 GPU.
cost)”.

Note: If you don’t see this option, click “See all sizes” and search for NV in the table. You may need to request
cores quota to be able to select a GPU VM type.

Note: By default, an Azure subscription doesn’t have enough cores quota to launch any GPU-powered VMs. You
will need to increase the cores quota in your Azure subscription for NVv3 series to 12 cores. To request a quota
increase, refer to instructions at https://docs.microsoft.com/en-us/azure/azure-portal/supportability/per-vm-quota-
requests.

70
 Installing & Licensing on Microsoft Azure
Setup Virtual Machine (cont’d)
7. You may select a larger size (e.g., Standard_NV24s_v3). Generally, a larger size VM delivers
better visualization experience.

Note: Cyclone ENTERPRISE is NOT compatible with NVv4- and NC-series.

8. Specify user credentials in the "Administrator account” section.

Note: You will be using these credentials to connect to your VM via RDP.

9. Select “Allow selected ports”.

Note: Select RDP (3389), HTTP (80), HTTPS (443) in the Select inbound ports.

10. Depending on your corporate IT policy, you may be able to use your existing Windows Server
license. If that’s the case, check the “Would you like to use an existing Windows Server
license?” box.
11. Click “Next : Disks >”.

71
 Installing & Licensing on Microsoft Azure
Setup Virtual Machine (cont’d)

72
 Installing & Licensing on Microsoft Azure
Create New Disk
1. Select “Premium SSD (locally-redundant storage)”.
2. Accept default Encryption type selection. You can optionally choose to manage encryption key yourself.
3. Leave Ultra Disk compatibility unchecked.
4. Choose “Create and attach a new disk”.
5. On Create a new disk page, accept default Name and Source type.
6. Click Change size and select the desired data disk size for your VM.
7. Select No for “Enable shared disk”.
8. Click OK.
9. Click “Next : Networking >”.

73
 Installing & Licensing on Microsoft Azure
Create New Disk (cont’d)

74
 Installing & Licensing on Microsoft Azure
Network Settings
1. Accept all default values on Networking page.
2. Accept all default values on Networking page.

75
 Installing & Licensing on Microsoft Azure
Management Settings
1. Accept all default values on Management page.
2. Click “Next : Advanced >”.

76
 Installing & Licensing on Microsoft Azure
Advanced Settings
1. On Advanced page, click “Select an extension to install”.
2. Select “NVIDIA GPU Driver Extension”. Click Create. Click OK.
3. Ensure “Gen 1” is selected in VM generation setting.
4. Ensure that NVIDIA GPU Driver Extension is listed in the Extensions section.

77
 Installing & Licensing on Microsoft Azure
Review & Finalize
1. Click “Review + create”. After a few moments, the summary page
will be shown stating that the VM settings passed validation.
2. Click Create (deployment takes a few minutes).
3. Once deployment is completed, Azure displays the following
screen.
4. You will see a new resource group containing your VM on the
Resource groups page (e.g., vmcyent1_group_06161051 in the
screenshot below).

78
 Installing & Licensing on Microsoft Azure
Obtain the VM IP Address
1. Open the new resource group page.
2. Select the VM.
3. Note the VM’s public IP address.
4. With the IP address, you can RDP to the VM using
the credentials specified earlier.

79
 Installing & Licensing on Microsoft Azure

Installing Leica CLM & licensing

• Same as the regular installation in the Installing Leica
CLM and Licensing Section.

Installing Leica Cyclone ENTERPRISE

• Same as the regular installation in the Installing Leica
Cyclone ENTERPRISE section.

80