Ansys Cloud Guide

ANSYS, Inc.
Southpointe June 2022
2600 Ansys Drive ANSYS, Inc. and
Canonsburg, PA 15317 ANSYS Europe,
Ltd. are UL
[email protected] registered ISO
http://www.ansys.com 9001: 2015
(T) 724-746-3304 companies.
(F) 724-514-9494
Copyright and Trademark Information

© 2021 ANSYS, Inc. Unauthorized use, distribution or duplication is prohibited.

ANSYS, ANSYS Workbench, AUTODYN, CFX, FLUENT and any and all ANSYS, Inc. brand, product, service and feature
names, logos and slogans are registered trademarks or trademarks of ANSYS, Inc. or its subsidiaries located in the
United States or other countries. ICEM CFD is a trademark used by ANSYS, Inc. under license. CFX is a trademark
of Sony Corporation in Japan. All other brand, product, service and feature names or trademarks are the property
of their respective owners. FLEXlm and FLEXnet are trademarks of Flexera Software LLC.

Disclaimer Notice

THIS ANSYS SOFTWARE PRODUCT AND PROGRAM DOCUMENTATION INCLUDE TRADE SECRETS AND ARE CONFID-
ENTIAL AND PROPRIETARY PRODUCTS OF ANSYS, INC., ITS SUBSIDIARIES, OR LICENSORS. The software products
and documentation are furnished by ANSYS, Inc., its subsidiaries, or affiliates under a software license agreement
that contains provisions concerning non-disclosure, copying, length and nature of use, compliance with exporting
laws, warranties, disclaimers, limitations of liability, and remedies, and other provisions. The software products
and documentation may be used, disclosed, transferred, or copied only in accordance with the terms and conditions
of that software license agreement.

ANSYS, Inc. and ANSYS Europe, Ltd. are UL registered ISO 9001: 2015 companies.

U.S. Government Rights

For U.S. Government users, except as specifically granted by the ANSYS, Inc. software license agreement, the use,
duplication, or disclosure by the United States Government is subject to restrictions stated in the ANSYS, Inc.
software license agreement and FAR 12.212 (for non-DOD licenses).

Third-Party Software

See the legal information in the product help files for the complete Legal Notice for ANSYS proprietary software
and third-party software. If you are unable to access the Legal Notice, contact ANSYS, Inc.

Published in the U.S.A.

Table of Contents
Getting Started with Ansys Cloud .............................................................................................................. 1
How Ansys Cloud Works ......................................................................................................................... 1
Ansys Cloud Licensing ............................................................................................................................ 2
Requirements for Ansys Cloud ................................................................................................................ 3
Installing Ansys Cloud Suite .................................................................................................................... 4
Checking Your Ansys Cloud Installation ................................................................................................... 9
Launching the Ansys Cloud App ........................................................................................................... 10
Launching the Cloud App in Ansys Fluent ....................................................................................... 11
Launching the Cloud App in Ansys Mechanical ................................................................................ 13
Checking Your Cloud Connection .......................................................................................................... 14
Tour of the Ansys Cloud App ................................................................................................................. 15
Installing Cloud App Updates ................................................................................................................ 17
Ansys Cloud Portal ................................................................................................................................ 17
Signing in to the Cloud Portal ......................................................................................................... 17
Cloud Portal Features ...................................................................................................................... 18
Managing Your Ansys Account ........................................................................................................ 19
Resetting Your Password ........................................................................................................... 19
Editing Your Ansys Account Settings ......................................................................................... 20
Viewing Your Cloud User Profile ...................................................................................................... 21
Signing Out of the Cloud Portal ....................................................................................................... 22
Ansys Cloud Forum ............................................................................................................................... 22
Signing in to Ansys Cloud Forum ..................................................................................................... 22
Forum Basics .................................................................................................................................. 23
Solving in the Cloud ................................................................................................................................. 25
Submitting Batch Jobs to the Cloud from Local Applications ................................................................. 25
Submitting a Job to the Cloud from Ansys Electronics Desktop ........................................................ 26
Submitting a Job to the Cloud from Ansys Fluent ............................................................................ 26
Submitting a Job to the Cloud from Ansys Mechanical ..................................................................... 30
Submitting a Job to the Cloud from SPEOS Products ....................................................................... 34
Submitting Batch Jobs to the Cloud from the Ansys Cloud Portal ........................................................... 34
Submitting an Ansys LS-DYNA Batch Job from the Cloud Portal ....................................................... 35
Submitting a Custom Batch Job from the Cloud Portal ..................................................................... 40
Renaming a Job .................................................................................................................................... 44
Editing the Time Limit of a Batch Job ..................................................................................................... 45
Stopping a Batch Job ............................................................................................................................ 47
Stopping a Batch Job from Ansys Electronics Desktop ..................................................................... 47
Stopping a Batch Job from Ansys Fluent or Ansys Mechanical .......................................................... 47
Stopping a Batch Job from the Cloud Portal .................................................................................... 49
What to Do When a Job Does Not Stop ............................................................................................ 51
Accessing Batch Job Output Files .......................................................................................................... 51
Running Applications Interactively on the Cloud ................................................................................... 53
In-Browser vs RDP Interactive Sessions ............................................................................................ 55
Starting an Interactive Session ........................................................................................................ 55
Running an In-Browser Session ....................................................................................................... 59
Closing an In-Browser Session Temporarily ...................................................................................... 63
Running an RDP Session ................................................................................................................. 65
Troubleshooting RDP Connection Issues ......................................................................................... 69
Closing an RDP Session ................................................................................................................... 71
Managing Files in Interactive Sessions ............................................................................................. 73

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. iii
Ansys Cloud Guide

Automatic File Transfers ............................................................................................................ 73

Transferring Files on Demand .................................................................................................... 74
Transfer Files from the VM to Cloud Storage ......................................................................... 74
Transfer Files from Cloud Storage to the VM ......................................................................... 75
Accessing Files from an Interactive Session ................................................................................ 76
Ending an Interactive Session .......................................................................................................... 77
Restarting an Interactive Session ..................................................................................................... 79
Checking the File Transfer Agent Status ................................................................................................. 80
Starting the File Transfer Agent ............................................................................................................. 82
Monitoring Jobs ................................................................................................................................... 83
Submitting a Job Kill Request ................................................................................................................ 86
Sharing a Job ........................................................................................................................................ 89
Deleting a Job ...................................................................................................................................... 93
Viewing Solution Progress and Results .................................................................................................... 95
Viewing a Job Transcript ....................................................................................................................... 95
Viewing Convergence Plots ................................................................................................................... 98
Viewing Monitor Report Files .............................................................................................................. 101
Viewing Result Trackers ....................................................................................................................... 103
Customizing Graphs ........................................................................................................................... 105
Postprocessing Results in the Cloud .................................................................................................... 110
Quick Postprocessing in the Cloud Portal ...................................................................................... 110
Starting a Postprocessing Session in the Cloud ........................................................................ 111
Viewer Basics .......................................................................................................................... 114
Maximizing the Viewing Area .................................................................................................. 115
Interactive Controls ................................................................................................................. 115
Animations ............................................................................................................................. 116
Object Visibility ....................................................................................................................... 117
Built-in Locations .................................................................................................................... 117
Creating a Part Group ............................................................................................................. 117
Creating a Plane ...................................................................................................................... 118
Creating a Contour Plot ........................................................................................................... 120
Creating a Vector Plot ............................................................................................................. 122
Creating an Isosurface ............................................................................................................ 124
Creating an Isovolume ............................................................................................................ 126
Global Display Settings ........................................................................................................... 128
Ending a Postprocessing Session ............................................................................................. 130
Restarting a Postprocessing Session ........................................................................................ 130
Postprocessing in the Cloud via Remote Desktop .......................................................................... 130
Downloading Ansys Electronics Desktop Results from the Cloud ......................................................... 134
Downloading Ansys Fluent Results from the Cloud .............................................................................. 134
Downloading Ansys Mechanical Results from the Cloud ...................................................................... 135
Managing Data in the Cloud ................................................................................................................... 137
Accessing Personal Data ..................................................................................................................... 137
Accessing Job Data ............................................................................................................................. 138
Managing Files and Folders ................................................................................................................. 140
Creating Folders ........................................................................................................................... 141
Uploading Files and Folders .......................................................................................................... 142
Cutting, Copying, and Pasting ........................................................................................................ 144
Renaming Files and Folders ........................................................................................................... 144
Downloading Files and Folders ..................................................................................................... 145
Deleting Files and Folders ............................................................................................................. 147

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
iv and its subsidiaries and affiliates.
 Ansys Cloud Guide

Using the Command Line to Solve in the Cloud ..................................................................................... 149

Installing the Command Line Interface ................................................................................................ 149
Submitting a Solve Job to the Cloud via the Command line ................................................................. 150
Using a Fluent Journal File to Solve in the Cloud .................................................................................. 153
Monitoring a Job Submitted from the Command Line ......................................................................... 154
Viewing Available Commands ............................................................................................................. 154
Cloud CLI Command Reference ........................................................................................................... 156
agent ........................................................................................................................................... 158
check-install ................................................................................................................................. 159
deleteJob ..................................................................................................................................... 161
download ..................................................................................................................................... 162
getLSTCVersions ........................................................................................................................... 163
getOutputs ................................................................................................................................... 164
getQueues .................................................................................................................................... 165
getUserProfile ............................................................................................................................... 167
interrupt ....................................................................................................................................... 168
jobInfo ......................................................................................................................................... 169
jobState ........................................................................................................................................ 170
login ............................................................................................................................................ 170
logout .......................................................................................................................................... 171
monitor ........................................................................................................................................ 172
openPortal ................................................................................................................................... 174
runAedt ........................................................................................................................................ 174
runCFX ......................................................................................................................................... 178
runFluent ..................................................................................................................................... 181
runLSDyna ................................................................................................................................... 185
runMAPDL .................................................................................................................................... 192
runSCANeR ................................................................................................................................... 196
runSPEOSHPC ............................................................................................................................... 199
shareJob ....................................................................................................................................... 201
upload ......................................................................................................................................... 202
uploadCustomLSDyna .................................................................................................................. 204
Analytics for Individuals ......................................................................................................................... 207
Checking Account Balances ................................................................................................................ 207
Checking Your Storage Consumption .................................................................................................. 208
Viewing the Status of Recent Jobs ....................................................................................................... 209
Job Submission Analytics .................................................................................................................... 210
Speed Analytics .................................................................................................................................. 211
Event Log ........................................................................................................................................... 213
Debug Log ......................................................................................................................................... 215
CPU and Memory Usage ..................................................................................................................... 217
HPC Commands Log ........................................................................................................................... 219
Saving a Transcript or Log to a File ....................................................................................................... 220
Analytics for Company Administrators .................................................................................................. 221
Analyzing Your Company's Cloud Usage .............................................................................................. 221
Filtering and Visualizing Data .............................................................................................................. 224
Setting a Date Range .................................................................................................................... 225
Filtering the Data .......................................................................................................................... 226
Specifying Data Display Options ................................................................................................... 227
Specifying Chart Display Options .................................................................................................. 230
Saving and Loading Filters .................................................................................................................. 233

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. v
Ansys Cloud Guide

Exporting Data to a CSV File ................................................................................................................ 234

User Management .................................................................................................................................. 235
Creating and Managing User Groups ................................................................................................... 235
Creating a User Group ................................................................................................................... 236
Adding Users to a User Group ....................................................................................................... 237
Removing a User from a User Group .............................................................................................. 240
Specifying Permissions on a User Group ........................................................................................ 242
Renaming a User Group ................................................................................................................ 244
Editing a User Group Description .................................................................................................. 244
Deleting a User Group ................................................................................................................... 245
Viewing the Company User List ........................................................................................................... 246
Viewing a User's Group Memberships ................................................................................................. 246
Project Budgeting ................................................................................................................................... 249
Creating a Project for Budget Control .................................................................................................. 249
Adding Users to a Project .................................................................................................................... 252
Removing Users from a Project ............................................................................................................ 253
How a Project Budget is Used .............................................................................................................. 254
Setting a Project as the Default ........................................................................................................... 256
Viewing a Project's Remaining Credit Balance ...................................................................................... 258
Adjusting a Project's Budget ............................................................................................................... 259
Viewing a Project's Job History ............................................................................................................ 260
Deleting a Project ............................................................................................................................... 262
Bring Your Own License (BYOL) .............................................................................................................. 263
Setting Up IP Forwarding .................................................................................................................... 263
Prerequisites for IP Forwarding ...................................................................................................... 264
Set Up the On-Premises License Server .......................................................................................... 265
Define License Proxy Settings in the Ansys Cloud Portal ................................................................. 266
Ensure Firewall Access .................................................................................................................. 268
Verify the Connection to the On-Premises License Server ............................................................... 269
Virtual Desktop Infrastructure ............................................................................................................... 273
Prerequisites for VDI ............................................................................................................................ 274
VDI Methods ....................................................................................................................................... 274
VDI Workflow ...................................................................................................................................... 275
VDI Session Management ................................................................................................................... 277
Troubleshooting ..................................................................................................................................... 281
Troubleshooting Ansys Cloud Installation Issues .................................................................................. 281
Known Issues and Limitations ............................................................................................................. 281

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
vi and its subsidiaries and affiliates.
Getting Started with Ansys Cloud
Ansys Cloud enables you to extend your solve capabilities to Cloud hardware for virtually unlimited
computational power and accelerated results. The Cloud service is delivered via a simple app that integ-
rates directly with select Ansys applications. Additionally, Cloud subscribers can sign in to a web portal
from any location or device to run simulations on the Cloud, monitor solve jobs, view resource usage,
visualize results, and access files.

Topics:
How Ansys Cloud Works
Ansys Cloud Licensing
Requirements for Ansys Cloud
Installing Ansys Cloud Suite
Checking Your Ansys Cloud Installation
Launching the Ansys Cloud App
Checking Your Cloud Connection
Tour of the Ansys Cloud App
Installing Cloud App Updates
Ansys Cloud Portal
Ansys Cloud Forum

How Ansys Cloud Works

The Ansys Cloud service is available for locally installed versions of Ansys Fluent running standalone,
Ansys Mechanical running in Workbench, Ansys Electronics Desktop, and SPEOS products. This enables
you to submit solutions to the Cloud from local versions of these applications (see Submitting Batch
Jobs to the Cloud from Local Applications (p. 25)).

If you are using Ansys Electronics Desktop or SPEOS Core, you can submit solutions to the Cloud directly
from those applications, as they have built-in support for Cloud job submission. For SPEOS job submission,
you must first install Ansys Cloud Suite (p. 4).

If you are using Ansys Fluent or Ansys Mechanical, you submit solutions from the application using the
Ansys Cloud app. This app is automatically installed when you install Ansys Cloud Suite (p. 4). When
you are ready to submit a solution to the Cloud, you launch the app directly in Ansys Fluent (p. 11) or
Ansys Mechanical (p. 13), and then use the app to submit a new job to the Cloud.

There are also ways that you can submit batch jobs to the Cloud outside of desktop applications. You
can either sign in to the Cloud portal and use an available batch job template, or you can use the Ansys
Command Line Interface (CLI). For installation and usage instructions, see Using the Command Line to
Solve in the Cloud (p. 149).

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 1
Getting Started with Ansys Cloud

As an alternative to batch job submission, you can sign in to the Cloud portal and run applications in-
teractively in the Cloud via remote desktop (see Running Applications Interactively on the Cloud (p. 53)).

To be able to submit solutions to the Cloud, or run applications on the Cloud, you must purchase a
Cloud Essentials subscription and an Ansys Elastic Licensing package. For more details see Ansys Cloud
Licensing (p. 2).

When batch jobs are submitted, input files are automatically uploaded to a data storage area in the
Cloud, and a pool of hardware and software resources is allocated to the job. When applications are
run interactively, you are prompted to upload input files from your local computer to a Cloud storage
area. Files are then uploaded to the compute resource being used to run the application.

As the solve executes on Cloud hardware, you can monitor the job locally in the Cloud app (if you are
using Ansys Fluent or Ansys Mechanical), or remotely via the Cloud portal. When a job has finished,
you can quickly validate results in a remote 3D viewer, and then download results to your local machine
for further postprocessing and data management. Or, you can perform standard postprocessing in the
Cloud via remote desktop.

When a job completes, job files are transferred from the compute resource to Cloud storage. You can
then view the files in the Cloud portal, and download files to your local computer if desired.

Ansys Cloud Licensing

To use the Cloud service, your company purchases Cloud Essentials subscriptions for accessing Cloud
services and storage, and an Ansys Elastic Licensing package for using software and hardware in the
Cloud. An administrator at your company assigns a subscription to each user who will be submitting
jobs to the Cloud. The Ansys Elastic Licensing package is shared among all users at the company.

Cloud Subscriptions
To manage your Cloud Essentials subscription, simply sign in to the Ansys Account portal at https://
myaccount.ansys.com. For more information, refer to the Ansys Account Management guide on the
Ansys Help site.

Ansys Elastic Licensing

Ansys Elastic Licensing is a flexible, pay-per-use licensing model that enables hourly-based licensing for
software, computing power, and hardware.

Different currencies are available to accommodate your specific business needs. Examples include Ansys
Elastic Currency (AEC), Ansys Hardware Currency (AHC), and Ansys Elastic Unit (AEU), although these
are subject to change.

AEC and AEU are usage-based currencies that support both software use (on-premises and in Ansys
Cloud) and hardware use on Ansys Cloud. They are a sold as a pool of pre-paid credits. The rate at which
users consume this currency depends on the products and services being used. AEC and AEU currencies
can be used on their own, or as a compliment to traditional licenses that can be connected to Ansys
Cloud using the Bring Your Own License (BYOL) (p. 263) option. BYOL involves connecting the Ansys
Cloud service to a company's license server that is hosting traditional leased or purchased floating li-
censes. When used with AEC/AEU, traditional floating software licenses that your company owns are
consumed first. When the floating licenses are not sufficient to cover all required resources for a partic-

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
2 and its subsidiaries and affiliates.
 Requirements for Ansys Cloud

ular job, the usage-based licenses are used to cover the remaining required resources (the hardware,
at a minimum).

AHC is a usage-based currency that supports ONLY hardware use on Ansys Cloud. This currency must
be used in conjunction with traditional floating licenses supplied through the Bring Your Own License
(BYOL) model (described above).

AEC and AHC are newer currencies that were introduced in fall of 2020. If you have previously purchased
AEUs, you can continue to use them until the end of your license term. Note that you cannot consume
different currencies simultaneously.

To view current rate tables for software and hardware consumption, go to https://www.ansys.com/
footer/terms-and-conditions/elastic-licensing-terms.

Administrators can control their company's Cloud spending by creating projects with established budgets,
and assigning selected users to those projects. See Project Budgeting (p. 249).

You can check project and company currency balances on the dashboard of the Ansys Cloud portal.
See Checking Account Balances (p. 207).

Requirements for Ansys Cloud

To be able to submit solutions to the Cloud from local applications or run applications interactively on
the Cloud, the following requirements must be met:

Main Requirements for All Users

• You must have an Ansys Account

• A Cloud Essentials subscription must be assigned to you by an administrator

• Ansys Elastic Licensing credits must be available for software/hardware consumption

Requirements for Job Submission from Local Applications

Ansys Electronics Desktop Version 2019 R2 or later of Ansys Electronics Desktop
users
Ansys Fluent users • Version 2019 R2 or later of Ansys Fluent running standalone

• Ansys Cloud Suite (p. 4) installed on your local machine (includes

the Ansys Cloud app)

Ansys Mechanical users • Version 2019 R2 or later of Ansys Mechanical running in Workbench

• Ansys Cloud Suite (p. 4) installed on your local machine (includes

the Ansys Cloud app)

SPEOS or SPEOS HPC users • Version 2021 R1 or later of Ansys SPEOS, SPEOS for Creo Parametric,
SPEOS for NX, or SPEOS HPC

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 3
Getting Started with Ansys Cloud

• Ansys Cloud Suite (p. 4) installed on your local machine. Among

other things, this ensures that the ANSYSCloudCli_root variable
is created, which is key to successful Cloud job submission.

Requirements for Running Applications on the Cloud

• Install Ansys Cloud Suite on your local device. See Installing Ansys Cloud Suite (p. 4).

• Start the File Transfer Agent on your device. See Starting the File Transfer Agent (p. 82).

Installing Ansys Cloud Suite

Required only for Ansys Fluent, Ansys Mechanical, and SPEOS users

(Ansys Cloud Suite installation is not required for Ansys Electronics Desktop.)

To be able to access the Cloud service from Ansys Fluent, Ansys Mechanical, or SPEOS products, or
submit solve jobs to the Cloud via the command line, you must download and install Ansys Cloud Suite.

Ansys Cloud Suite includes the following:

• The Ansys Cloud app for Ansys Fluent and Ansys Mechanical

• The File Transfer Agent

• The Ansys Cloud Command Line Interface (CLI)

• A Check Cloud Installation utility

Installation files for Windows can be found on the Dashboard or Downloads page of the Ansys Cloud
portal. An installation package for manual installation can be found on the Downloads page.

The following instructions step you through a typical Windows installation:

To install Ansys Cloud Suite on Windows:

1. Sign in to the Cloud portal at https://cloud.ansys.com.

2. On the dashboard, go to the Installation section. (The installation is also available on the Downloads
page.) Click DOWNLOAD to download the ANSYSCloud.exe file to the default download location
on your desktop.

3. Close all Ansys applications.

4. Locate the downloaded ANSYSCloud.exe file. Right-click the file and select Run as administrator.

5. In the setup dialog box, click Install:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
4 and its subsidiaries and affiliates.
 Installing Ansys Cloud Suite

6. In the Setup Wizard, click Next to set up the installation:

7. Specify an installation location:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 5
Getting Started with Ansys Cloud

8. Select the Ansys product versions for which you want to set up Cloud support:

9. Click Install to begin the installation:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
6 and its subsidiaries and affiliates.
 Installing Ansys Cloud Suite

Installation begins:

10. Click Finish to exit the setup wizard:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 7
Getting Started with Ansys Cloud

The installation is confirmed:

Once Ansys Cloud is installed, you can launch the Cloud app (p. 10) in Ansys Fluent or Ansys Mechan-
ical, or go to the Ansys Cloud portal (p. 17).

See Also:

Checking Your Ansys Cloud Installation (p. 9)

Troubleshooting Ansys Cloud Installation Issues (p. 281)

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
8 and its subsidiaries and affiliates.
 Checking Your Ansys Cloud Installation

Checking Your Ansys Cloud Installation

Use the Check Cloud Installation utility to verify that Ansys Cloud is properly installed on your computer,
that you have the latest updates, that you are connecting to the Cloud successfully, and that you are
able to transfer files and submit jobs.

The utility performs a comprehensive series of checks and reports the outcome of each one:

• Host machine details

• Ansys versions installed

• Ansys ACT installation check

• Fluent patch check

• Ansys Cloud environment variable check

• Cloud connection check

• Ansys Account connection check

• Installed CLI version

• File Transfer Agent check

• Queue configurations found

• Job submission check

• Session monitoring check

• Post-session cleanup

To check your Cloud installation:

1. Select Start → Ansys Cloud → Check Cloud Installation.

The utility begins going through its checks, and displays the results in a command window:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 9
Getting Started with Ansys Cloud

2. At step 7 of the check, the utility prompts you to sign in to your Ansys Account. Enter your Ansys
Account credentials to resume the installation check.

When all checks are complete, the command window reports the location of the Installation
report.html file should you wish to view it:

3. Press any key to close the command window.

Launching the Ansys Cloud App

Once you have installed (p. 4) the Cloud app on your computer, you can launch it in Ansys Fluent or
Ansys Mechanical.

Topics:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
10 and its subsidiaries and affiliates.
 Launching the Ansys Cloud App

Launching the Cloud App in Ansys Fluent

Launching the Cloud App in Ansys Mechanical

Launching the Cloud App in Ansys Fluent

The Cloud app is compatible with version 2019 R2 or later of Ansys Fluent running standalone.

To launch the Cloud app in Ansys Fluent:

1. Launch Ansys Fluent and ensure that Load ACT is enabled in the Fluent Launcher dialog box.

2. In the ACT window, click Launch Wizards:

3. On the Wizards page, click the Ansys Cloud tile:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 11
Getting Started with Ansys Cloud

4. When launching the app for the first time, you must sign in to the app using your Ansys Account
credentials:

You will not need to sign in again in the future unless you manually sign out of the app.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
12 and its subsidiaries and affiliates.
 Launching the Ansys Cloud App

The Cloud app loads in the ACT window. For a quick overview of the app, see Tour of the Ansys
Cloud App (p. 15).

Launching the Cloud App in Ansys Mechanical

The Cloud app is compatible with version 2019 R2 or later of Ansys Mechanical running in Workbench.

To launch the app in Ansys Mechanical 2019 R2 or later, select the Ansys Cloud tab, then click Ansys
Cloud on the ribbon:

When launching the app for the first time, you must sign in to the app using your Ansys Account
credentials:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 13
Getting Started with Ansys Cloud

You will not need to sign in again in the future unless you manually sign out of the app.

The Cloud app loads in the Wizard window, which is powered by Ansys ACT. For a quick overview
of the app, see Tour of the Ansys Cloud App (p. 15).

Checking Your Cloud Connection

If you are using the Ansys Cloud app for Ansys Fluent and Ansys Mechanical, the connection icon on
the Cloud app toolbar indicates whether or not your local machine is connected to the Cloud. If you
are connected, the status indicator is green:

If you are not connected to the Cloud, the status indicator is red. You will not be able to submit jobs
to the Cloud until the connection is established.

To reconnect to the Cloud, simply click the connection icon.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
14 and its subsidiaries and affiliates.
 Tour of the Ansys Cloud App

Tour of the Ansys Cloud App

The Ansys Cloud app for Ansys Fluent and Ansys Mechanical enables you to submit a solve job to the
Cloud, monitor the solution, view the current job state, download results from the Cloud, and postprocess
results in the Cloud using a remote visualization tool. Job transactions are captured live in the lower
monitoring window. Server operations, system processes, and errors are also captured in monitoring
logs that you can view and save.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 15
Getting Started with Ansys Cloud

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
16 and its subsidiaries and affiliates.
 Ansys Cloud Portal

Installing Cloud App Updates

In an effort to continually improve product quality, Ansys may release updates of the Cloud app
throughout the year. When an update is available, a notification is displayed when you launch the Cloud
app:

The most recent version of the app is also available on the Cloud portal at https://cloud.ansys.com. The
Windows installation is available on both the Dashboard and Downloads page. If you need to do a
manual installation, a zipped installation package is also available on the Downloads page.

Note that you do not need to uninstall an existing version of the app before installing a newer version.
The installer takes care of this automatically.

Ansys Cloud Portal

The Ansys Cloud portal provides a convenient way to remotely monitor Cloud usage and jobs via a
web browser.

Using any web-enabled computer, tablet, or smart phone, you can sign in to the Cloud portal to
download the latest versions of Cloud apps, and view up-to-the-minute information about your Cloud
services, usage, and jobs.

In this section:
Signing in to the Cloud Portal
Cloud Portal Features
Managing Your Ansys Account
Viewing Your Cloud User Profile
Signing Out of the Cloud Portal

Signing in to the Cloud Portal

Go to https://cloud.ansys.com and sign in with your Ansys Account credentials.

You can also access the portal by selecting Start → Ansys Cloud → Ansys Cloud Portal

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 17
Getting Started with Ansys Cloud

Cloud Portal Features

To navigate to different areas of the portal, use the navigation panel on the left side of the screen.
The Dashboard provides a quick snapshot of your account status, and the status of submitted jobs:

The following topics provide information on the portal's key features:

• Installing Ansys Cloud Suite (p. 4)

• Monitoring Jobs (p. 83)

• Checking the File Transfer Agent Status (p. 80)

• Viewing Solution Progress and Results (p. 95)

• Submitting a Job Kill Request (p. 86)

• Analytics for Individuals (p. 207)

• Analytics for Company Administrators (p. 221)

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
18 and its subsidiaries and affiliates.
 Ansys Cloud Portal

Managing Your Ansys Account

You use your Ansys Account to sign in to the Cloud portal. If you need to reset your password or edit
your account settings, you can do so directly from the Cloud portal. Alternatively you can sign in to
the Ansys Account portal at https://myaccount.ansys.com/ and make your changes there.

Refer to the following topics:

Resetting Your Password
Editing Your Ansys Account Settings

Resetting Your Password

If you have forgotten your Ansys Account password or simply want to change it, follow these steps
in the Cloud portal:

1. From the user menu , select Reset Password.

2. On the sign-in screen, enter the email address associated with your Ansys Account, then click
Continue.

3. When prompted for a password, click Forgot Password.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 19
Getting Started with Ansys Cloud

4. Follow the prompts to reset your password. For more information, see Resetting Your Ansys
Account Password in the Ansys Account Management guide.

Editing Your Ansys Account Settings

Your Ansys Account contains the following editable settings:

• First name

• Last name

• Phone number used for verifying your identity during sign-in

To edit your Ansys Account settings from the Cloud portal:

1. From the user menu , select Manage Ansys Account.

2. Make the desired changes in the Edit account settings dialog box:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
20 and its subsidiaries and affiliates.
 Ansys Cloud Portal

For more information, see Editing Your Ansys Account Settings in the Ansys Account Management
guide.

If you want to update your company information or marketing preferences, see Editing Your
Profile Information in the Ansys Account Management guide.

Viewing Your Cloud User Profile

Your user profile in the Cloud portal includes the name and email address associated with your Ansys
Account, your user ID, and your assigned role (administrator or standard user).

To view your profile information, click the user menu and select Profile.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 21
Getting Started with Ansys Cloud

If you need to edit your name, or the phone number used for verification during sign-in, click Manage
Ansys Account. See Editing Your Ansys Account Settings (p. 20).

If you want to update your company information or marketing preferences, see Editing Your Profile
Information in the Ansys Account Management guide.

Signing Out of the Cloud Portal

To sign out of the Cloud portal, click the user menu and select Sign out.

Ansys Cloud Forum

The Ansys Cloud Forum is a social peer-to-peer network for discussions on Cloud apps and services.
Members can ask questions, access learning resources, share suggestions and answers, and collaborate
on ideas for future product and service enhancements.
Signing in to Ansys Cloud Forum
Forum Basics

Signing in to Ansys Cloud Forum

When signing in to the Ansys Cloud forum for the first time, you are prompted to enter your Ansys
Account credentials. If you do not have an Ansys Account, you can create one during sign-in. (For
more information, refer to the Ansys Account Management guide.)

To sign in to the Ansys Cloud forum:

1. In a web browser, go to https://cloudforum.ansys.com.

You can also access the forum from the main toolbar of the Cloud app and Cloud portal — just
look for the forum icon:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
22 and its subsidiaries and affiliates.
 Ansys Cloud Forum

2. Enter the email address associated with your Ansys Account.

3. Enter your password.

4. Click Sign in.

For future visits you will not need to sign in again unless you manually sign out of the forum.

Forum Basics
Here is a quick overview of the main things that you can do on the Ansys Cloud forum, and how to
do it:

The forum includes questions and answers posted by users, tutorials, Idea boards, and Knowledge
Base articles written by Ansys experts.

You may only want to read messages or articles that other users post, but you are welcome to be a
contributor at any time. You can post questions, share comments or answers, or collaborate on ideas.
Before creating a post, you should review the Posting Guidelines and Terms of Use available on
the forum, which include instructions, regulations, and other information related to posting.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 23
Getting Started with Ansys Cloud

If there is a particular topic that interests you, you can it to have email notifications
sent to you when the item is updated.

The forum supports automatic translation of site text from English to Japanese, Korean, and Chinese
(Simplified and Traditional). For more information, select Multi-Language Support on the forum.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
24 and its subsidiaries and affiliates.
Solving in the Cloud
Ansys Cloud enables you to tap into resources located in offsite data centers. Those resources can come
in the form of extra computational power via HPC clusters, or in the form of software that is hosted on
Cloud hardware.

Solving in the Cloud is ideal when you want to run long processes, when you are not available to
provide input, or when you do not have a local application at your disposal.

To run simulations in the Cloud, you can:

• Submit solutions to the Cloud from local Ansys applications

• Submit solutions to the Cloud using batch job templates in the Cloud portal

• Run applications interactively in a virtual desktop session

When running interactive sessions from the Cloud portal, you can upload input files from your local
machine or use files from previously-run Cloud jobs.

When jobs are submitted to the Cloud you can use the Cloud portal to monitor and manage your jobs.

Topics:
Submitting Batch Jobs to the Cloud from Local Applications
Submitting Batch Jobs to the Cloud from the Ansys Cloud Portal
Renaming a Job
Editing the Time Limit of a Batch Job
Stopping a Batch Job
Accessing Batch Job Output Files
Running Applications Interactively on the Cloud
Checking the File Transfer Agent Status
Starting the File Transfer Agent
Monitoring Jobs
Submitting a Job Kill Request
Sharing a Job
Deleting a Job

Submitting Batch Jobs to the Cloud from Local Applications

When you are working in Ansys Electronics Desktop, Ansys Fluent, Ansys Mechanical, or SPEOS products,
and are ready to solve, you can submit the solve job to Ansys Cloud for processing on HPC resources.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 25
Solving in the Cloud

When a job is submitted, input files are automatically uploaded to the Cloud, and a pool of hardware
resources is allocated to the job. The number of nodes and cores provisioned depends on the values
specified when setting up the job.

Once a batch job has been submitted to the Cloud it can run to completion without any intervention
from you. A queuing system on the cluster submit host queues the job, allocates hardware resources,
and starts and manages the job.

When you submit a job from Ansys Fluent and Ansys Mechanical, you can monitor the job's status locally
using the Cloud app. For all job types, including Ansys Electronics Desktop and SPEOS jobs, you can
monitor Cloud jobs remotely in the Cloud portal. The Cloud service sends an email notification when
a job starts, completes, fails, or is stopped. In addition to monitoring a job's status, you can view a job
transcript, convergence plots, and result trackers (see Viewing Solution Progress and Results (p. 95)).

When the job has finished, the results are available in the Cloud, where you can quickly validate them
in a remote 3D visualization tool, or postprocess them in the Cloud through a remote desktop session
(see Postprocessing Results in the Cloud (p. 110)). Results can also be downloaded to your local machine
for further processing and management.

Note that to be able to submit jobs to the Cloud, you must have Ansys Cloud Suite installed on your
local computer. See Installing Ansys Cloud Suite (p. 4).

Topics:
Submitting a Job to the Cloud from Ansys Electronics Desktop
Submitting a Job to the Cloud from Ansys Fluent
Submitting a Job to the Cloud from Ansys Mechanical
Submitting a Job to the Cloud from SPEOS Products

Submitting a Job to the Cloud from Ansys Electronics Desktop

Ansys Electronics Desktop has built-in support for Cloud job submission (no apps or extensions are
required).

To submit a batch job to the Cloud from Ansys Electronics Desktop, simply use the software's Job
Management feature and select Ansys Cloud as your scheduler.

For more information, see Ansys Cloud Support for HPC Job Management in the Ansys Electronics Help.

Submitting a Job to the Cloud from Ansys Fluent

Use the Cloud app to submit a solve job to the Cloud from Ansys Fluent running standalone on your
local machine.

1. In Ansys Fluent, ensure that the desired model has been set up and is ready to solve.

2. Launch the Cloud app. Refer to Launching the Cloud App in Ansys Fluent (p. 11).

3. In the Cloud app, click NEW JOB.

The job submission form is displayed. It includes a list of the input files that will be uploaded to
the Cloud.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
26 and its subsidiaries and affiliates.
 Submitting Batch Jobs to the Cloud from Local Applications

4. Fill out the fields on the job submission form:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 27
Solving in the Cloud

Job Name

Enter a meaningful name that will help you identify the job in the job monitor.

Project

Select the project whose budget allowance you want to use for the job. If you are not a
member of a project, no projects are available to you (the only selection is 'None'). If 'None'
is selected, the job will use credits from the company pool which are not reserved for any
projects. For more information, see Project Budgeting (p. 249).

Region

Select the Cloud region that is geographically closest to you.

Machine type

Select the hardware to use for the job. The recommended hardware is pre-selected for you
if it is available. For helpful information on hardware selection, click next to the Machine
type field.

Number of nodes

Specify the number of nodes to be allocated for the job. Choose a value that will accommodate
the job parameters and requirements.

Total number of cores

Specify the maximum number of CPU cores to be used by nodes. The recommended number
of cores is automatically filled in for you. You should use at least half of the maximum available
cores. The number of cores must be a multiple of the number of nodes. If you enter an incor-
rect value, the app will automatically change it to the closest correct value.

Time limit in hours

The maximum duration of the job. When the time limit is reached, the job is interrupted. To
allow the job to run with no time limit, set the value to 0. (An email reminder will be sent
every 6 hours to remind you that the job is still running.) You can edit the time limit (p. 45)
after the job has started running.

Upload output files while running

If enabled, new and modified files written by the solver to the virtual machine's temporary
storage folder will be automatically uploaded to Cloud storage at the specified Upload Fre-
quency while the job is running. You may want to use this as a precautionary measure for
long-running jobs to prevent possible data loss should any issues arise during the job run.
Note that even if you disable this option, you can upload files on demand using the Transfer
Files (p. 74) action in the Cloud portal. Otherwise, files that are not transferred during the
job run will be automatically transferred to Cloud storage when the job completes.

Upload frequency (minutes)

The frequency at which output files are transferred from the VM to Cloud storage.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
28 and its subsidiaries and affiliates.
 Submitting Batch Jobs to the Cloud from Local Applications

Download results after completion

Enable this option to automatically download the results from the Cloud to your local machine.
Once enabled, click Browse next to the Download to field to select a target folder for the
download.

File transfer options

Select the file handling option that is best suited for the size and number of files being
transferred to the Cloud. Compressing or archiving files can make transfers smaller and faster,
reducing transfer and storage charges, but is not always necessary or beneficial. Use the table
below to compare options and select the best one for the current job. Note that the option
selected will also be used for output files.

Individual
Can Can
Can be files
quick-postprocess postprocess
used with visible
Use to results in Cloud results in
Option Compression low in
transfer portal using Cloud
bandwidth Cloud
'Post in Cloud' using 'VDI
connections file
or 'View Results' Postprocess'
explorer
Small
number
Default None
of small
files
Compresses
Small
files
number
Compress individually
of large
into .gz
files
files
Packs files
into a Large
Archive single number
archive of files
(.tar)

Advanced Options:

Additional command line arguments

Enables you to change Cloud's default Fluent command line options.

5. Click Submit Job.

The job input files begin uploading to a storage directory in the Cloud. For information on monitoring
the status of file transfers, see Checking the File Transfer Agent Status (p. 80). Once the files have
been uploaded, the Cloud service will allocate resources for the job, and the job will then start running
on Cloud hardware. Its status becomes in the job monitor.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 29
Solving in the Cloud

You can monitor the status of jobs locally in the Cloud app, or remotely from the Cloud portal. See
Monitoring Jobs (p. 83).

You will receive an email notification when a job starts, completes, fails, or is stopped, enabling you
to keep track of jobs even when you are not using the Cloud app or Cloud portal:

For information about the solution itself, see Viewing Solution Progress and Results (p. 95).

Submitting a Job to the Cloud from Ansys Mechanical

Use the Cloud app to submit a solve job to the Cloud from Ansys Mechanical running in Workbench
on your local machine.

1. In Ansys Mechanical, ensure that the desired model has been set up and is ready to solve.

2. Launch the Cloud app. Refer to Launching the Cloud App in Ansys Mechanical (p. 13).

3. In the Cloud app, click NEW JOB.

The job submission form is displayed. It includes a list of the input files that will be uploaded to
the Cloud.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
30 and its subsidiaries and affiliates.
 Submitting Batch Jobs to the Cloud from Local Applications

4. Fill out the fields on the job submission form:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 31
Solving in the Cloud

Job Name

Enter a meaningful name that will help you identify the job in the job monitor.

Project

Select the project whose budget allowance you want to use for the job. If you are not a
member of a project, no projects are available to you (the only selection is 'None'). If 'None'
is selected, the job will use credits from the company pool which are not reserved for any
projects. For more information, see Project Budgeting (p. 249).

Analysis

Select the type of analysis that you would like to solve. The list of available analysis types is
determined by the analysis systems that you have added to the project.

Region

Select the Cloud region that is geographically closest to you.

Machine type

Select the hardware to use for the job. The recommended hardware is pre-selected for you
if it is available. For helpful information on hardware selection, click next to the Machine
type field.

Number of nodes

Specify the number of nodes to be allocated for the job. Choose a value that will accommodate
the job parameters and requirements.

Total number of cores

Specify the maximum number of CPU cores to be used by nodes. The recommended number
of cores is automatically filled in for you. You should use at least half of the maximum available
cores. The number of cores must be a multiple of the number of nodes. If you enter an incor-
rect value, the app will automatically change it to the closest correct value.

Time limit in hours

The maximum duration of the job. When the time limit is reached, the job is interrupted. To
allow the job to run with no time limit, set the value to 0. (An email reminder will be sent
every 6 hours to remind you that the job is still running.) You can edit the time limit (p. 45)
after the job has started running.

Upload output files while running

If enabled, new and modified files written by the solver to the virtual machine's temporary
storage folder will be automatically uploaded to Cloud storage at the specified Upload Fre-
quency while the job is running. You may want to use this as a precautionary measure for
long-running jobs to prevent possible data loss should any issues arise during the job run.
Note that even if you disable this option, you can upload files on demand using the Transfer
Files (p. 74) action in the Cloud portal. Otherwise, files that are not transferred during the
job run will be automatically transferred to Cloud storage when the job completes.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
32 and its subsidiaries and affiliates.
 Submitting Batch Jobs to the Cloud from Local Applications

Upload frequency (minutes)

The frequency at which output files are transferred from the VM to Cloud storage.

Download results after completion

Enable this option to automatically download the results from the Cloud to your local machine.
Once enabled, click Browse next to the Download to field to select a target folder for the
download.

File transfer options

Select the file handling option that is best suited for the size and number of files being
transferred to the Cloud. Compressing or archiving files can make transfers smaller and faster,
reducing transfer and storage charges, but is not always necessary or beneficial. Use the table
below to compare options and select the best one for the current job. Note that the option
selected will also be used for output files.

Individual
Can Can
Can be files
quick-postprocess postprocess
used with visible
Use to results in Cloud results in
Option Compression low in
transfer portal using Cloud
bandwidth Cloud
'Post in Cloud' using 'VDI
connections file
or 'View Results' Postprocess'
explorer
Small
number
Default None
of small
files
Compresses
Small
files
number
Compress individually
of large
into .gz
files
files
Packs files
into a Large
Archive single number
archive of files
(.tar)

Advanced Options:

Additional command line arguments

Enables you to change Cloud's default MAPDL command line options. Default options are
dis -perf on. To keep DMP solve enter dis -perf on and your option(s). Otherwise
enter only your option(s).

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 33
Solving in the Cloud

Additional output files to retrieve

By default, all files generated by Mechanical are uploaded from the compute node to Cloud
storage. To retrieve other files, specify a comma-separated list of file names (for example,
*.dat, my_file.lis).

Include user files

Uploads all files in the user_files directory to the Cloud. In the Input Files pane you can
also add more input files from any local directory if desired.

Note:

To ensure successful use of the user files in the Cloud, you must reference the
user_files folder using "_wb_userfiles_dir(1)" in your command snippets.

5. Click Submit Job.

The job input files begin uploading to a storage directory in the Cloud. For information on monitoring
the status of file transfers, see Checking the File Transfer Agent Status (p. 80). Once the files have
been uploaded, the Cloud service will allocate resources for the job, and the job will then start running
on Cloud hardware. Its status becomes in the job monitor.

You can monitor the status of jobs locally in the Cloud app, or remotely from the Cloud portal. See
Monitoring Jobs (p. 83).

You will receive an email notification when a job starts, completes, fails, or is stopped, enabling you
to keep track of jobs even when you are not using the Cloud app or Cloud portal.

For information about the solution itself, see Viewing Solution Progress and Results (p. 95).

Submitting a Job to the Cloud from SPEOS Products

SPEOS products have built-in support for Cloud job submission. To be able to access Cloud services
from SPEOS products, you must install (p. 4) Ansys Cloud Suite.

To submit a batch job to the Cloud from SPEOS or SPEOS HPC, simply use SPEOS Core to select Ansys
Cloud as your scheduler.

For more information, see Ansys Cloud Simulations in the SPEOS product help.

Submitting Batch Jobs to the Cloud from the Ansys Cloud Portal
The Applications page of the Ansys Cloud portal includes a Batch job section for accessing predefined
batch job templates. Such templates enable you to submit solve jobs to the Cloud without having to
interact with an application. Currently, Generic Solver and LS-DYNA batch job templates are available.
More templates may become available in the future.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
34 and its subsidiaries and affiliates.
 Submitting Batch Jobs to the Cloud from the Ansys Cloud Portal

When you select a job template, you are prompted to select input files and specify job submission
settings.

When you submit a batch job, input files are automatically uploaded to the Cloud, and the requested
hardware resources are allocated.

When the job has finished, the results are available in the Cloud, where they can be quickly validated
in a remote 3D visualization tool. Results can be downloaded to your local machine for further processing
and management.

Topics:
Submitting an Ansys LS-DYNA Batch Job from the Cloud Portal
Submitting a Custom Batch Job from the Cloud Portal

Submitting an Ansys LS-DYNA Batch Job from the Cloud Portal

The LS-DYNA batch job template enables you to submit an LS-DYNA job to the Cloud from the Cloud
portal.

1. Sign in to the Cloud Portal on any device.

2. Make sure that the File Transfer Agent (p. 80) is running on your local machine.

3. In the navigation menu, select Applications.

4. On the Applications page, in the Batch Job area, click the LSTC LSDyna Solver tile.

You are prompted to specify job submission settings:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 35
Solving in the Cloud

5. To load job submission inputs from a template that you previously created, click Load template,
then selected the desired JSON file from your local file system.

6. To edit the job name, click the current job name and enter a new one. The name is used to
identify the job in the job monitor.

7. To use a project's budget allowance for the job, select the project from the Project drop-down.
If you are not a member of a project, no projects are available to you (the only selection is 'None').
If 'None' is selected, the job will use credits from the company pool which are not reserved for
any projects. For more information, see Project Budgeting (p. 249).

8. In the Input files section, specify the following:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
36 and its subsidiaries and affiliates.
 Submitting Batch Jobs to the Cloud from the Ansys Cloud Portal

Agent

The name of the machine that contains the files to be used for the job (for example, your
local machine name).

Select inputs via main input file

If enabled, all files located in the main input file directory and all subdirectories will be up-
loaded. Use the Main input file setting to select the main input file. If you prefer to select
files to upload, disable the Select inputs via main input file option and use the Include
files option instead.

Include files

This option is available when the Select inputs via main input file option is disabled. To
select the files to be uploaded for the job, click Browse from your computer and select the
desired files. Your selection must include the input file.

Main input file

Select the main input file for the job.

Input folder

(Read-only) Identifies the local folder that contains the input file.

File transfer option

Select the file handling option that is best suited for the size and number of files being
transferred to the Cloud. Compressing or archiving files can make transfers smaller and faster,
reducing transfer and storage charges, but is not always necessary or beneficial. Use the table
below to compare options and select the best one for the current job. Note that the option
selected will also be used for output files.

Individual
Can
Can be files Can
postprocess
used with visible quick-postprocess
Use to results in
Option Compression low in results in Cloud
transfer Cloud
bandwidth Cloud portal using
using 'VDI
connections file 'View Results'
Postprocess'
explorer
Small
number
Default None
of small
files
Compresses
Small
files
number
Compress individually
of large
into .gz
files
files

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 37
Solving in the Cloud

Individual
Can
Can be files Can
postprocess
used with visible quick-postprocess
Use to results in
Option Compression low in results in Cloud
transfer Cloud
bandwidth Cloud portal using
using 'VDI
connections file 'View Results'
Postprocess'
explorer
Packs files
into a Large
Archive single number
archive of files
(.tar)

9. In the Solver settings section, specify the following:

LS-Dyna solver type

Specify whether you want to use a Released or Custom version of LS-DYNA. Customized
versions of LS-DYNA can be uploaded to the Ansys Cloud portal using the uploadCustomLS-
Dyna (p. 204) command.

LS-Dyna version

Select the version of LS-DYNA to use.

LS-Dyna solver method

Specify whether you want to use Shared Memory Parallel processing (SMP) or Massively
Parallel Processing (MPP).

Memory options

Specify the amount of memory to use for the analysis. Selecting Auto allows LS-Run to es-
timate the required memory for the analysis. When using LS-DYNA MPP, selecting User
Defined enables you to specify the amount of memory to use.

Precision

The single precision version of the solver is used by default. For double precision, enable the
Double option.

Memory

If you selected the User Defined memory option, this is the amount of memory to be used
by the primary processor to decompose the model (for example, 80m). If no value is set, the
solver dynamically allocates the memory.

Memory2

If you selected the User Defined memory option, this is the amount of memory to be used
by all processors, including the primary processor, to solve the decomposed problem.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
38 and its subsidiaries and affiliates.
 Submitting Batch Jobs to the Cloud from the Ansys Cloud Portal

LS-Dyna arguments

Additional command line arguments for the solver. Click the field's info icon for a list of
examples.

10. In the Hardware settings section, specify the following:

Region

For maximum efficiency, select the region that is geographically closest to you.

Hardware configuration

Choose from a list of pre-configured hardware configurations. Use the Cores, Memory, Storage,
and GPU information to select the virtual machine that best meets the needs of the job.

Number of nodes

The number of nodes to be allocated for the job. By default this value is determined by the
selected configuration.

Number of cores

The maximum number of CPU cores to be used by the machine. By default this value is de-
termined by the selected configuration. You should use at least half of the maximum available
cores. The number of cores must be a multiple of the number of nodes.

Time limit

The maximum duration of the job in hours. When the time limit is reached, the job is inter-
rupted. To allow the job to run with no time limit, set the value to 0. (An email reminder will
be sent every 6 hours to remind you that the job is still running.) Note that you can edit the
time limit (p. 45) in the Cloud portal after the job has started running.

11. In the Output settings section, specify the following:

Automatically transfer files to my desktop when job is complete

Downloads the results to your computer after the solve. If enabled, specify the absolute path
of the local folder in the Download folder field.

Upload files to cloud storage while running every XX minutes

By default, files that are generated or modified during the job session will be automatically
uploaded to Cloud storage when the job completes. Enabling this option allows files to be
uploaded while the job is running. If enabled, set the desired upload frequency. You may
want to use this as a precautionary measure for long-running jobs to prevent possible data
loss should any issues arise during the job run. Note that you can also manually initiate a file
transfer (p. 74) while the job is running.

12. To save the specified inputs to a file for subsequent reuse, click Save as template.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 39
Solving in the Cloud

Settings are saved to a JSON file. When prompted, specify a name for the file:

The file is downloaded to the default download location on your computer. You may want to
move it to a different folder for easy retrieval later on.

13. Click Submit job.

Submitting a Custom Batch Job from the Cloud Portal

The Generic Solver template enables you to submit a batch job to the Cloud using custom commands.
For example, you might use the template to:

• Run an Ansys solver using custom variables and options that are not available in the standard Cloud
templates

• Debug a solution

• Run an application that is not part of the Ansys product offering

Preparing Required Inputs

All files required for the job must be gathered in a folder on your local machine. This includes any
scripts and custom executables that you want to run. The input folder will be uploaded to the Cloud
when you submit the job.

When a batch job is submitted using the Generic Solver template, the Virtual Machine loads all sup-
ported Ansys applications. When preparing a script, you may need to know where an application is
installed:

• Applications in the standard Ansys installation (CFX, Fluent, Workbench, and so on) are installed
in a version-specific folder such as /ansys_inc/v212. (In this example, 'v212' represents release
2021 R2).

• Ansys Electronics Desktop is installed in a version-specific folder such as /ansys_inc/An-

sysEM21.2.

If you upload a custom executable, such as a customized version of LS-DYNA, you must give execute
permission to the executable. To do this, use the following command in your bash/sh script:
chmod +x my_executable

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
40 and its subsidiaries and affiliates.
 Submitting Batch Jobs to the Cloud from the Ansys Cloud Portal

Submitting the Job

To submit a custom batch job:

1. Sign in to the Cloud portal at https://cloud.ansys.com on any device.

2. Make sure that the File Transfer Agent (p. 80) is running on your local machine so that the files
can be uploaded.

3. In the navigation menu, select Applications.

4. On the Applications page, in the Batch Job area, click the Generic Solver tile.

You are prompted to specify job submission settings:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 41
Solving in the Cloud

5. To load job submission inputs from a template that you previously created, click Load template,
then selected the desired JSON file from your local file system.

6. To edit the job name, click the current job name and enter a new one. The name is used to
identify the job in the job monitor.

7. To use a project's budget allowance for the job, select the project from the Project drop-down.
If you are not a member of a project, no projects are available to you (the only selection is 'None').
If 'None' is selected, the job will use credits from the company pool which are not reserved for
any projects. For more information, see Project Budgeting (p. 249).

8. In the Input files section, select the input files for the job:

• To upload a folder from your local computer, enable Upload a folder and its sub-folders,
then click Browse to select the folder. Once selected, the folder path is displayed in the Input
folder field.

If the input folder contains extraneous files that are not required for the job, you can specify
an Input filter to upload only the files that you need. For example, enter *.py to upload only
Python files.

• To upload files from your local computer, click Upload from your PC, then select the desired
file(s) in the file selection dialog box..

• To upload folders or files from cloud storage, click Add from cloud storage, then select the
desired items in the Choose Files(s) dialog box.

9. For the File transfer option, select the file handling option that is best suited for the size and
number of files being transferred to the Cloud. Compressing or archiving files can make transfers
smaller and faster, reducing transfer and storage charges, but is not always necessary or beneficial.
Use the table below to compare options and select the best one for the current job. Note that
the option selected will also be used for output files.

Individual Can
Can be Can
files postprocess
used with quick-postprocess
Use to visible results in
Option Compression low results in Cloud
transfer in Cloud Cloud
bandwidth portal using
file using 'VDI
connections 'View Results'
explorer Postprocess'
Small
Default None number of
small files
Compresses
Small
files
Compress number of
individually
large files
into .gz files
Packs files Large
Archive into a single number of
archive (.tar) files

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
42 and its subsidiaries and affiliates.
 Submitting Batch Jobs to the Cloud from the Ansys Cloud Portal

10. In the Solver settings section, specify the following:

Version

The Ansys release that you want to run. Depending on the version selected, some machines
may or may not be available.

Executable name

The name of the executable. For example, sh or python.

Executable argument

The argument required to run the executable. For example, run.sh.

Files to monitor

If the job generates files that you can monitor, enter the name of these files so that you can
see the output in the job monitor.

AAS connection file

This is an advanced option that enables you to use graph monitoring when running Ansys
Fluent, MAPDL, or AEDT jobs. To activate this service in the Cloud, specify the appropriate
AAS file name:

Fluent: instant_aaS_FluentId.txt
MAPDL: instant_aaS_MapdlId.txt
AEDT: OptimTee_aaS_test.aedtz

11. In the Hardware settings section, specify the following:

Region

For maximum efficiency, select the region that is geographically closest to you.

Machine

Choose from a list of pre-configured hardware configurations. Use the Cores, Memory, Storage,
and GPU information to select the virtual machine that best meets the needs of the job.

Number of nodes

The number of nodes to be allocated for the job. By default this value is determined by the
selected configuration.

Time limit

The maximum duration of the job in hours. When the time limit is reached, the job is inter-
rupted. To allow the job to run with no time limit, set the value to 0. (An email reminder will
be sent every 6 hours to remind you that the job is still running.) Note that you can edit the
time limit (p. 45) in the Cloud portal after the job has started running.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 43
Solving in the Cloud

12. In the Output settings section, specify the following:

Automatically transfer files to my desktop when job is complete

Downloads the results to your computer after the solve. If enabled, specify the absolute path
of the local folder in the Download folder field.

Upload files to cloud storage while running every XX minutes

By default, files that are generated or modified during the job session will be automatically
uploaded to Cloud storage when the job completes. Enabling this option allows files to be
uploaded while the job is running. If enabled, set the desired upload frequency. You may
want to use this as a precautionary measure for long-running jobs to prevent possible data
loss should any issues arise during the job run. Note that you can also manually initiate a file
transfer (p. 74) while the job is running.

13. To save the specified inputs to a file for subsequent reuse, click Save as template.

Settings are saved to a JSON file. When prompted, specify a name for the file:

The file is downloaded to the default download location on your computer. You may want to
move it to a different folder for easy retrieval later on.

14. Click Submit job.

Renaming a Job
You can easily rename any batch or interactive job that currently appears in the job monitor.

1. Go to https://cloud.ansys.com.

2. On the Dashboard or Jobs page, click the job in the job monitor.

3. In the job status view, click the job name.

4. In the Rename session pop-up, enter the desired job name, then click Rename.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
44 and its subsidiaries and affiliates.
 Editing the Time Limit of a Batch Job

Editing the Time Limit of a Batch Job

Each job has a time limit that determines the maximum number of hours that the job can run. When
the time limit is reached, the job is interrupted. If a time limit was not specified in the job submission
settings (or was set to 0), the job has no time limit. Whether a time limit has been set or not, you can
edit the time limit of a job once it has started running.

To edit the time limit of a running batch job:

1. Go to https://cloud.ansys.com.

2. On the Dashboard or Jobs page, click the job in the job monitor.

3. In the job status view, click next to the displayed time limit:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 45
Solving in the Cloud

4. Increase or decrease the time limit as desired, then click Change time limit. To allow the job to
run with no time limit, set the value to 0. (An email reminder will be sent every 6 hours to remind
you that the job is still running.)

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
46 and its subsidiaries and affiliates.
 Stopping a Batch Job

Stopping a Batch Job

When a solve job is running, you can sign in to the Cloud portal to stop the job on Cloud hardware,
and close the associated solver session. If you are using Ansys Fluent or Ansys Mechanical, you can also
stop a job from the Cloud app.

You may want to stop a job if you have not observed any progress in the job transcript for quite some
time (30 minutes or more).

In this section:
Stopping a Batch Job from Ansys Electronics Desktop
Stopping a Batch Job from Ansys Fluent or Ansys Mechanical
Stopping a Batch Job from the Cloud Portal
What to Do When a Job Does Not Stop

Stopping a Batch Job from Ansys Electronics Desktop

In Ansys Electronics Desktop, you can stop a job from the Monitor Job window. For more information,
see Monitor Jobs Window in the HFSS Help.

Stopping a Batch Job from Ansys Fluent or Ansys Mechanical

If you have submitted a batch job from Ansys Fluent or Ansys Mechanical, you can stop the job using
the Cloud app. Simply select the job in the job monitor, and then click the desired stop button:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 47
Solving in the Cloud

Two stop actions are available:

• ABORT: Stops the solution immediately without saving any results.

You are prompted to confirm your choice:

Note that when a job is aborted, software licenses may remain checked out for up to 90 minutes
(until the licensing times out). For jobs using elastic licensing, the aborted job may continue to incur
AEC/AEU/AHC usage charges during this period.

• INTERRUPT. Submits a request to the solver to stop the solution at the next point where data can
be safely stored for later use.

You are prompted to confirm your choice:

Note that the solver must respond to the request in order for the job to be interrupted. You should
confirm the interruption in the job monitor. If interruption is not successful, use the End Ses-
sion (p. 49) action in the Cloud portal.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
48 and its subsidiaries and affiliates.
 Stopping a Batch Job

Stopping a Batch Job from the Cloud Portal

All batch jobs can be managed remotely in the Cloud portal.

To stop a batch job from the Cloud portal:

1. Go to https://cloud.ansys.com.

2. On the Dashboard or Jobs page, click the job in the job monitor.

3. On the job view page, click End Session.

The following dialog box appears:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 49
Solving in the Cloud

4. Specify how you would like to end the job session:

• To abort the job without saving any new or modified files to Cloud storage, click the 'Abort
session' tile.

Note:

Although the job will be killed immediately, software licenses may remain checked
out for up to 90 minutes (until the licensing times out). For jobs using elastic licens-
ing, the aborted job may continue to incur AEC/AEU/AHC usage charges during
this period (applies only if the machine has started, not if you are still waiting for
the pool to start).

• To stop the job and save any new or modified files to Cloud storage, click the 'Request to stop
the session' tile. This submits a request to the solver. The job will be stopped at the next point
where data can be safely stored for later use.

5. Click End session.

• If you chose to abort the job, the job will first go into the state. When the system
responds to the request, the job state then becomes .

If the job does not abort within 10 minutes, you can submit a job kill request (p. 86) to the
Cloud operations team, who will ensure that the job is stopped completely.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
50 and its subsidiaries and affiliates.
 Accessing Batch Job Output Files

• If you chose to stop the job, the job will go into the state. When the solver re-
sponds to the request, the job state then becomes .

If the session is not stopped within 10 minutes, click Force end session to forcefully stop the
solver and save any results available at that time.

What to Do When a Job Does Not Stop

If you have attempted to stop a batch job, but it seems stuck in the Interrupting state, it is likely that
the solver is not responding.

In this case, try stopping the job a second time using the End Session action in the Cloud portal. See
Stopping a Batch Job from the Cloud Portal (p. 49).

If subsequent attempts to stop the job are not successful, you can submit a job kill request to the
Cloud operations team, who will ensure that the job is completely stopped. See Submitting a Job Kill
Request (p. 86).

Accessing Batch Job Output Files

When you submit a batch job to the Cloud from a local application, job files are written to a Cloud
storage folder that is created for the job.

To access batch job files:

1. Sign in to the Cloud Portal at https://cloud.ansys.com.

2. On the Dashboard or Jobs page, click the job in the job monitor to open the job.

3. Select the Files tab:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 51
Solving in the Cloud

Output files are located in the output folder.

On the Files tab you can analyze and postprocess results, as well as download, share, and delete
files. See Viewing Solution Progress and Results (p. 95).

Note that results are downloaded to your local machine automatically if you choose the Download
results after completion option when setting up the job. You can also download result files using
the Cloud app in your local application.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
52 and its subsidiaries and affiliates.
 Running Applications Interactively on the Cloud

Running Applications Interactively on the Cloud

Unlike batch jobs that run behind the scenes with no intervention from you, interactive jobs enable
you to interact directly with the application being used for a solution. Applications are run on the Cloud,
providing extra computational power and greater flexibility when carrying out your simulation workflows.

Interactive sessions enable you to:

• Post-process batch jobs in the Cloud, eliminating the need to transfer large files back to your local
machine for post-processing

• Perform other interactive tasks such as meshing and pre-processing when you do not have access
to a local machine that is capable of completing such tasks

The Applications page of the Cloud portal provides access to a number of Cloud-hosted applications
that you can run interactively on your desktop. You can also launch a full Windows desktop that provides
access to all available applications in a single session.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 53
Solving in the Cloud

When you launch an application on the Cloud, it becomes available on your desktop, enabling you to
interact with it as if it were local.

You have a choice of two different delivery methods: In-Browser or Remote Desktop Protocol (RDP).

When an interactive session is created, it appears as an item in the Jobs list, enabling you to act on or
revisit it as needed.

Topics:
In-Browser vs RDP Interactive Sessions
Starting an Interactive Session

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
54 and its subsidiaries and affiliates.
 Running Applications Interactively on the Cloud

Running an In-Browser Session

Closing an In-Browser Session Temporarily
Running an RDP Session
Troubleshooting RDP Connection Issues
Closing an RDP Session
Managing Files in Interactive Sessions
Ending an Interactive Session
Restarting an Interactive Session

For information on running applications for postprocessing, see Postprocessing in the Cloud via Remote
Desktop (p. 130).

In-Browser vs RDP Interactive Sessions

There are two methods available for remote session delivery: In-browser and RDP. These are described
and compared below.

In-Browser Sessions
In-browser interactive sessions are delivered via Apache Guacamole — a clientless remote desktop
gateway. All that you need to access your remote desktop is an HTML5-capable web browser. There
are no plugins or client software required, and no issues like firewall access to worry about.

With this method, setting up and starting an interactive session is a simple, one-step process. Once
a session is created, the remote desktop is launched automatically. By comparison, the RDP method
requires that you manually launch the remote desktop in a separate step.

A full remote desktop is launched directly in the Cloud portal environment. This offers a very integrated
look and feel, and seamless interactive experience.

RDP Sessions
Microsoft's Remote Desktop Protocol (RDP) enables you to connect to remotely installed applications
through a Remote Desktop Connection client. There is nothing that you need to install, as the Remote
Desktop Connection client is integrated into Microsoft Windows.

Once you have specified the settings for your session, a remote connection is established, and a session
is created in the job monitor. You must then launch the remote desktop using the Launch Desktop
action in the job view.

The remote application or Cloud desktop is launched in an independent Remote Desktop Connection
client window.

Starting an Interactive Session

To launch a remote application on your desktop, follow these steps:

1. Sign in to the Cloud Portal at https://cloud.ansys.com on a Windows laptop or desktop computer.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 55
Solving in the Cloud

2. If the input files that you intend to use are on your local machine, make sure that the File
Transfer Agent (p. 80) is running on your local machine so that the files can be uploaded.

3. In the navigation menu, select Applications.

4. On the Applications page, go to either the In-browser interactive session (p. 55) or RDP inter-
active session (p. 55) section depending on your preferred delivery method. Then, click the ap-
plication that you want to run:

• To launch a specific application such as Ansys Electronics Desktop, Fluent, Lumerical, or

Workbench, click the desired application tile.

• To launch a Windows desktop that provides access to all available Cloud-hosted applications,
click the Cloud Desktop tile.

You are prompted to set up your session:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
56 and its subsidiaries and affiliates.
 Running Applications Interactively on the Cloud

5. (Optional) To change the default session name, simply click the name and edit it. The session
name will appear in the job monitor, so you may want to include meaningful details to help
distinguish the session from other sessions and jobs in the Jobs list.

6. To use a project's budget allowance for the job, select the project from the Project drop-down.
If you are not a member of a project, no projects are available to you (the only selection is 'None').
If 'None' is selected, the job will use credits from the company pool which are not reserved for
any projects. For more information, see Project Budgeting (p. 249).

7. Set up your session by specifying the following:

Input files
a. Specify the input files to be used in the session. Selected files/folders will be uploaded to
the D:\Ansys Cloud Drive folder on the virtual machine (VM) at the start of the session.

• To upload files from the Cloud portal, click Add from cloud storage.

• To upload files from your computer, click Upload from your PC.

Note that you can transfer additional files (p. 75) from Cloud storage to the virtual machine
(VM) during the session if needed.

b. Select the File transfer option that is best suited for the size and number of files being
transferred to the Cloud. Compressing or archiving files can make transfers smaller and
faster, reducing transfer and storage charges, but is not always necessary or beneficial. Use
the table below to compare options and select the best one for the current session. Note
that the option selected will also be used for output files.

Individual
Can
Can be files Can
postprocess
used with visible quick-postprocess
Use to results in
Option Compression low in results in Cloud
transfer Cloud
bandwidth Cloud portal using
using 'VDI
connections file 'View Results'
Postprocess'
explorer
Small
number
Default None
of small
files
Compresses
Small
files
number
Compress individually
of large
into .gz
files
files
Packs files
into a Large
Archive single number
archive of files
(.tar)

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 57
Solving in the Cloud

Solver settings
Select the desired solver version from the Version drop-down.

Hardware settings

Region. Select the data center that is closest to you.

Machine. Choose from a list of pre-configured hardware configurations. Use the Cores,
Memory, Storage, and GPU information to select the virtual machine that best meets the
needs of the job.
Time limit. The maximum duration of the session in hours. When the time limit is reached,
the session is interrupted. To allow the session to run with no time limit, set the value to 0.
(An email reminder will be sent every 6 hours to remind you that the job is still running.)

Output settings
Files that are generated or modified during the session will be automatically uploaded to Cloud
storage when you end the session.

To automatically upload files during the session, enable the Upload files to cloud storage while
running option and specify the desired upload frequency. You may want to use this as a precau-
tionary measure for long-running jobs to prevent possible data loss should any issues arise during
the job run.

8. To save the specified inputs for subsequent reuse in another session, enable Save my inputs
for future use. The next time that you start an interactive session of this type, the session inputs
will be pre-filled with the values specified in this session.

9. Click Start session.

An interactive session is created and is listed as a job in the job monitor.

First, the input files are uploaded to the VM. Then, the compute resource is started. This may
take a few minutes.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
58 and its subsidiaries and affiliates.
 Running Applications Interactively on the Cloud

Once the compute resource is running, the remote connection is established. Refer to the applicable
topic below:

Running an In-Browser Session (p. 59)

Running an RDP Session (p. 65)

Running an In-Browser Session

Once the file transfer to the compute resource is complete, a remote desktop is launched inside a
virtual window that is embedded directly in the job view. You can begin interacting with the Cloud
desktop or application right away.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 59
Solving in the Cloud

Activating Full Screen Mode

To expand the remote display window so that it fills the entire screen, click full screen on the toolbar.

To exit full screen mode, press ESC on your keyboard.

Using Your Mouse and Keyboard

When you move your cursor inside the virtual window, you can start using your mouse to interact
with the Cloud desktop or remote application. If you want keyboard inputs to be captured by the
remote application, your cursor must be inside the virtual window, and you may need to click in the
window to pass keyboard control to that window. The following message in the toolbar area confirms
that the remote application is ready to receive keyboard and mouse inputs:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
60 and its subsidiaries and affiliates.
 Running Applications Interactively on the Cloud

If you move your cursor outside of the virtual window, keyboard and mouse inputs are not captured
by the remote application. This is indicated by the following warning message:

Using Hot Keys

In some cases, using the AltGr key may not work. If this occurs you can use Ctrl+Alt+[key] instead.

Copying and Pasting Text

Use the Clipboard panel on the toolbar to copy text to and from the remote clipboard.

When you open this remote clipboard panel, any text that was last copied to your local clipboard is
automatically displayed in the panel. You can then copy and paste the text where it is needed.

Similarly, if you select text in your remote application and use the Copy function or Ctrl+C, the text
automatically appears in the remote clipboard panel, enabling you to copy and paste it where needed.

Note:

There is a limit on the number of characters that can be copied to the clipboard at one
time (approximately 6000). Exceeding this limit may cause the session to disconnect. To
work around this issue, copy and paste the text in smaller portions instead of copying all
of it at once.

Alternatively, if a file on your local machine has a large amount of content, you may want
to upload the file (p. 142) from your local machine to cloud storage, and then use the
Transfer files feature to transfer the file to the VM (p. 75). Similarly, if a file on the VM has

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 61
Solving in the Cloud

a large amount of content, you can transfer the file to cloud storage (p. 74) at any time,
and then download the file (p. 145) from cloud storage to your local machine.

Monitoring the Session

To view the status of the session, access logs, or access the Cloud storage folder associated with the
session, click Monitoring on the toolbar.

This displays the job view where session information can be accessed:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
62 and its subsidiaries and affiliates.
 Running Applications Interactively on the Cloud

To return to the virtual window, click Show screen on the toolbar.

Troubleshooting In-Browser Sessions

There are some known issues associated with in-browser interactive sessions. For a description of issues
and possible workarounds, see Known Issues and Limitations (p. 281). Additional information and
support may be available on the Ansys Cloud Forum at https://cloudforum.ansys.com.

Closing an In-Browser Session Temporarily

If you have launched a remote desktop in an in-browser interactive session, you can close the remote
desktop temporarily and later resume it. Closing the session transfers files back to Cloud storage, but
does not end the interactive session from which the remote desktop was launched. If you no longer
need the remote desktop, you should instead end the interactive session (p. 77).

To close a remote desktop:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 63
Solving in the Cloud

1. Use the file explorer on the Cloud desktop to ensure that any files that you want to retain are
saved in the D:\Ansys Cloud Drive folder. Files in this folder will be transferred to the
Cloud storage folder that you selected when setting up the interactive session.

2. On the Cloud desktop, double-click the Save session and exit shortcut:

You are prompted to confirm that you want to exit the session:

3. Click OK to close the remote session.

The remote session is disconnected. When you want to relaunch the remote desktop, click Reconnect
in the status message:

Note:

Disconnecting a session is intended for short-term use. When a remote session is discon-
nected, the interactive session remains in the state, and the Virtual Machine
(VM) keeps running, potentially incurring unnecessary usage costs.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
64 and its subsidiaries and affiliates.
 Running Applications Interactively on the Cloud

Running an RDP Session

When you start an RDP interactive session, the remote desktop does not launch automatically. To
launch it you must use the Launch desktop action in the job view.

1. If not already open, locate the interactive session in the job monitor and open it. In the Status
notifications, ensure that the session is ready, then click Launch Desktop:

You are prompted to launch the remote desktop on your device:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 65
Solving in the Cloud

2. Click Connect.

A connection is attempted. This may take a few moments. If there is an issue making the connec-
tion, see Troubleshooting RDP Connection Issues (p. 69).

You may be warned that the RemoteApp program cannot be identified. This is a normal security
measure. If this occurs, enable the Don't ask me again for connections to this computer check
box, then click Connect.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
66 and its subsidiaries and affiliates.
 Running Applications Interactively on the Cloud

Do the same if you get a certificate error. (Enable the check box and click Yes.)

The Remote Desktop client prepares to launch your application:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 67
Solving in the Cloud

The application or Cloud desktop is launched in a remote desktop window.

The Cloud desktop is a typical Windows desktop that provides access to applications through the
Start menu and desktop shortcuts:

If you minimize or navigate away from a remote session window, a specially marked shortcut on your
Windows taskbar enables you to bring the window back into view:

See Also: Troubleshooting RDP Connection Issues (p. 69)

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
68 and its subsidiaries and affiliates.
 Running Applications Interactively on the Cloud

Troubleshooting RDP Connection Issues

To ensure the best connection possible, the File Transfer Agent is used by default to establish a remote
desktop connection.

If the File Transfer Agent is unable to connect to the remote machine, you may see errors such as
the following in the Launch Desktop dialog box:

Try the following steps to resolve connection issues:

1. Ensure that your firewall is not blocking the remote connection. To learn about the ports used
for remote desktop (VDI) connections, and recommendations for managing your firewall system,
refer to Firewall Configuration Information on the Ansys Cloud Forum.

2. If there are no firewall issues, restart the File Transfer Agent (p. 82), then try launching the desktop
again.

3. If you are unable to connect to the remote machine using the File Transfer Agent, try the following
alternative method:

a. In the Launch Desktop dialog box, click Advanced.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 69
Solving in the Cloud

b. Click Get password.

A password is displayed:

c. Copy the password to your Clipboard.

d. Click Download rdp file.

A Remote Desktop Protocol (.rdp) file is downloaded to the default download location on
your computer.

e. Run the downloaded .rdp file.

f. When prompted, paste the password that you copied to your Clipboard:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
70 and its subsidiaries and affiliates.
 Running Applications Interactively on the Cloud

g. Click OK to launch the remote desktop.

Closing an RDP Session

If you have launched a Cloud desktop in an RDP interactive session, you can close the remote desktop
session temporarily if you want to resume work later, or end the session if you are finished your work.
Refer to the applicable instructions below.

Closing a Remote Session Temporarily

If you are not finished your remote work, you can disconnect the remote session temporarily and
later relaunch it (p. 65) when you are ready to resume your work.

To close a remote session temporarily, you can do one of the following:

• Click the close button on the Remote Desktop Connection control panel at the top of the screen:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 71
Solving in the Cloud

• On the remote desktop, select Start > (Power) > Disconnect.

Important:

• Disconnecting a remote session is intended for short-term use. Closing the remote
desktop session using the methods above does not end the interactive session from
which the remote session was launched, and does not transfer any files back to Cloud
storage. Any applications that were running during the remote session will continue to
run. If you are in fact finished your remote work and do not need to relaunch the remote
desktop, then you should end the interactive session (p. 77) to stop applications from
running and avoid unnecessary usage charges.

• DO NOT use the Shutdown option in the remote desktop's Start menu power options
to end a remote desktop session.

• If you have launched a single application in an interactive session, closing the application
in the remote display window closes the application on the remote computer.

Ending a Remote Session

If you have launched a Cloud desktop in an RDP interactive session and have finished your remote
work, you should close the remote desktop session using the method below. This method also ends
the interactive session from which the remote desktop was launched, and transfers files back to Cloud
storage.

To close a remote desktop session:

1. Use the file explorer on the Cloud desktop to ensure that any files that you want to retain are
saved in the D:\Ansys Cloud Drive folder. Files in this folder will be transferred to the
Cloud storage folder that you selected when setting up the interactive session.

2. On the Cloud desktop, double-click the Save session and exit shortcut:

You are prompted to confirm that you want to exit the session:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
72 and its subsidiaries and affiliates.
 Running Applications Interactively on the Cloud

3. Click OK to close the remote session.

The remote desktop closes, and the state of the interactive session becomes in the job
monitor.

Managing Files in Interactive Sessions

When you set up an interactive session (p. 55), you specify a Cloud storage folder containing the files
that you want to use during your remote desktop session. When the session is launched, the files in
this folder are transferred to D:\Ansys Cloud Drive on the virtual machine (VM). During the
session you can transfer additional files (p. 74) from Cloud storage to the VM if needed.

As you interact with applications on the Cloud, only files that are saved to D:\Ansys Cloud Drive
on the remote computer will be transferred back to Cloud storage. Therefore, it is important that you
save your simulation files to this location during your session.

In this section:
Automatic File Transfers
Transferring Files on Demand
Accessing Files from an Interactive Session

Automatic File Transfers

When you end a session (p. 77) and select the 'Request to stop the session' option, files that were
generated or modified during the session are automatically transferred from the virtual machine's
temporary storage folder to Cloud storage. However, if you select the 'Abort session' option, or the
session is unintentionally aborted for some other reason, result files are not transferred to Cloud
storage. If there are remote files that you want to save, you must manually initiate a file trans-
fer (p. 74) before aborting the session.

If you enabled the Upload files while running option when setting up the session, new and
modified files are automatically transferred to Cloud storage at regular intervals while the session
is running.

If you disabled the Upload files while running option, no files are transferred to Cloud storage
during the session. However, you can manually initiate a file transfer during the session if desired

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 73
Solving in the Cloud

using the Transfer Files action. See Transfer Files from the VM to Cloud Storage (p. 74). Otherwise,
result files will be automatically transferred to Cloud storage at the end of the session.

Transferring Files on Demand

While an interactive session is running, you can initiate a file transfer between the VM and Cloud
storage at any time, in either direction.

You can:
Transfer Files from the VM to Cloud Storage
Transfer Files from Cloud Storage to the VM

Once a remote session has ended, on-demand file transfer actions are no longer valid.

Transfer Files from the VM to Cloud Storage

During an interactive session you can initiate a transfer of new or modified files from the VM's
temporary storage folder (D:\Ansys Cloud Drive) to the session's Cloud storage folder.
This makes the files available in the Cloud portal.

To transfer files from the VM to Cloud storage, select Transfer files → VM > Cloud storage on
the session view toolbar.

A visual indicator is displayed when the request for transfer is accepted:

A progress bar on the job status page enables you to monitor the progress of the transfer.

If you have chosen to end a session, you can also transfer files on demand by clicking Start new
transfer in the session status view. Note, however, that if you have requested to stop the session
instead of aborting it, you do not need to do this, as files will automatically be transferred to
Cloud storage when the session ends.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
74 and its subsidiaries and affiliates.
 Running Applications Interactively on the Cloud

Transfer Files from Cloud Storage to the VM

During an interactive session you can upload additional files from any Cloud storage folder to
the VM's temporary storage folder (D:\Ansys Cloud Drive). This makes the files available
for use during the session. If the files are on your local machine, you must upload (p. 142) them
to a Cloud storage folder to be able to transfer them to the VM.

To transfer files to the VM:

1. Select Transfer files → Cloud storage > VM on the session view toolbar.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 75
Solving in the Cloud

2. In the Choose File(s) dialog box, select the file(s) or folder(s) that you want to upload.

A visual indicator is displayed when the request for transfer is accepted:

A progress bar on the job status page enables you to monitor the progress of the transfer.

Accessing Files from an Interactive Session

To access files that were added or modified during an interactive session:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
76 and its subsidiaries and affiliates.
 Running Applications Interactively on the Cloud

1. Sign in to the Cloud Portal at https://cloud.ansys.com.

2. In the job monitor, click the interactive job to open it. Then, select the Files tab.

Alternatively you can select Files in the portal's navigation menu, and navigate to the folder
from there.

If you Abort an interactive session instead of using End Session to interrupt it, no files are saved
or transferred back to the Cloud unless you manually initiate a file transfer (p. 74) before aborting
the job.

Ending an Interactive Session

When you are finished your interactive session and no longer need the application or Cloud desktop
that you have been running, you should end the session to free up the compute resource. When
ending a session you can choose whether you want to save files that were generated or modified
during the session.

To end an interactive session:

1. If not already open, locate the interactive session in the job monitor and open it.

2. Click End Session.

The following dialog box appears:

3. Specify how you would like to end your session:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 77
Solving in the Cloud

• To abort the session without saving any new or modified files to Cloud storage, click the 'Abort
session' tile.

Note:

Although the job will be killed immediately, software licenses may remain checked
out for up to 90 minutes (until the licensing times out). For jobs using elastic licens-
ing, the aborted job may continue to incur AEC/AEU/AHC usage charges during
this period (applies if the machine has started, not if you are still waiting for the
pool to start).

• To stop the session and save any new or modified files to Cloud storage, click the 'Request to
stop the session' tile. This submits a request to the system to stop the session. If an application
such as a solver is running, the session will be stopped at the next point where data can be
safely stored for later use.

4. Click End session.

• If you chose to abort the session, a request is sent to the system to abort the session. During
this time, the session is in the state. When the system responds to the request,
the session state then becomes .

If the job does not abort within 10 minutes, you can submit a job kill request (p. 86) to the
Cloud operations team, who will ensure that the job is stopped completely.

• If you chose to stop the session, a request is sent to the system to stop the session. During
this time, the session is in the state. When the system responds to the request,
the session state then becomes .

If the session is not stopped within 10 minutes, click Force end session to forcefully stop the
session. This kills any running solver processes and saves any results available at that time.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
78 and its subsidiaries and affiliates.
 Running Applications Interactively on the Cloud

Note:

You can restart an interactive session (p. 79) at a later time.

Restarting an Interactive Session

If you have ended (p. 77) an interactive session, you can restart it when you are ready to resume
application or Cloud desktop use. This saves you from having to set up a new interactive session.

To restart an interactive session:

1. If not already open, locate the aborted session in the job monitor and open it.

2. Click Restart.

You are prompted to restart the job:

3. Click Restart.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 79
Solving in the Cloud

The status of the session becomes in the job monitor. The compute resource is
started, and then data is transferred from the selected Cloud storage folder to the compute re-
source.

For an in-browser session, the remote desktop launches automatically once the data transfer is com-
plete.

For an RDP session, you must launch the remote desktop (p. 65) again to resume use of the remote
application or desktop.

Note:

You cannot restart an interactive session that has been shared with you.

Checking the File Transfer Agent Status

When you submit batch jobs to the Cloud from local applications, job files are transferred between
your local machine and the Cloud by a File Transfer Agent that is installed on your local machine. In
this scenario, the File Transfer Agent starts automatically when a job is submitted to the Cloud.

When you start an interactive session from the Cloud portal, the File Transfer Agent is used to transfer
data from Cloud storage to the compute resource. If you have not submitted jobs or started interactive
sessions previously, you must manually start the File Transfer Agent on your local machine.

You can check the status of the File Transfer Agent from the Cloud app (if you are using Ansys Fluent
or Ansys Mechanical), or from the Cloud portal.

Cloud App for Ansys Fluent and Ansys Mechanical

In the Cloud app, the file transfer icon on the main toolbar indicates the current status of the File
Transfer Agent:

: The File Transfer Agent is running, and ready to transfer files to the Cloud.
: The File Transfer Agent is busy transferring files to the Cloud.
: The File Transfer Agent is not running, and must be restarted. See Starting the File Transfer
Agent (p. 82).

To view additional information about the File Transfer Agent status, click the File Transfer Agent icon
on the toolbar. Details and options are displayed in the File Transfer Agent dialog box:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
80 and its subsidiaries and affiliates.
 Checking the File Transfer Agent Status

Cloud Portal
You can check the status of the File Transfer Agent remotely by signing in to the Ansys Cloud portal
on your local machine.

The file transfer icon on the main toolbar indicates the current status of the File Transfer Agent:

The status is also displayed on the Dashboard page:

If the File Transfer Agent is not connected ( ), you must start it on your local machine. See Starting
the File Transfer Agent (p. 82).

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 81
Solving in the Cloud

Starting the File Transfer Agent

The File Transfer Agent must be running on your local machine to enable the transfer of files between
your local computer and Cloud storage, and between Cloud storage and the compute resource. If the
status (p. 80) of the agent is currently red ( ), this means that the agent is not running.

When you submit a job to the Cloud from a local application, the File Transfer Agent starts automatically.
In rare cases, however, you may notice that a job is stuck waiting for the File Transfer Agent to complete
a task. In this case you must manually restart the agent on your machine.

If you want to run applications interactively on the Cloud, and have not submitted jobs or run interactive
sessions before, then you must start the File Transfer Agent on your machine before starting your first
interactive session.

You can start or restart the File Transfer Agent in one of the following ways:

• In the Cloud app for Ansys Fluent and Ansys Mechanical, click the File Transfer Agent icon on the
toolbar:

Then, in the Ansys Cloud Agent dialog box, click Restart Agent:

• From your computer's Start menu, select Ansys Cloud > Restart File Transfer Agent.

• Using the Ansys Cloud Command Line Interface (CLI (p. 149)), issue the following command: ansy-
scloudcli agent --start.

To check to see if the agent is running, see Checking the File Transfer Agent Status (p. 80)).

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
82 and its subsidiaries and affiliates.
 Monitoring Jobs

Monitoring Jobs
You can monitor any job submitted to Ansys Cloud by accessing the Cloud portal. Jobs submitted from
Ansys Electronics Desktop, Ansys Fluent, and Ansys Mechanical can also be monitored locally within
the application.

Monitoring Jobs in Ansys Electronics Desktop

If you are using Ansys Electronics Desktop, you can use the software's Monitor Jobs function to mon-
itor jobs that you have submitted to the Cloud.

For more information, see the following topics in the Electronics Desktop Help:

• Ansys Cloud Support for HPC Job Management

• Monitor Jobs Window

Monitoring Jobs in Ansys Fluent and Ansys Mechanical

If you are using Ansys Fluent or Ansys Mechanical, you can monitor jobs locally in the Cloud app. You
can view details about each submitted job, such as its start time, current state (Running, Completed,
Failed, Interrupted), size of output files, and job identification number:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 83
Solving in the Cloud

Monitoring Jobs in the Cloud Portal

To monitor the status of batch jobs and interactive sessions, sign in to the Cloud portal at https://
cloud.ansys.com.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
84 and its subsidiaries and affiliates.
 Monitoring Jobs

On the Dashboard page of the Cloud portal, the Recent jobs tile provides a quick look at the status
of recently submitted jobs, and lets you know how many jobs are actively running vs how many you
are allowed to run at one time:

To view details about a specific job, click the job in the Recent jobs tile.

To view more detailed information about submitted jobs, click View jobs in the Recent jobs tile, or
select Jobs in the navigation pane.

The Jobs page is displayed:

For each job you can see:

• The state of the job (Running, Completed, Interrupted, Aborted, Failed)

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 85
Solving in the Cloud

• The start time and finish time (if applicable)

• The number of Ansys Elastic Licensing credits consumed, in the currency of your Ansys Elastic Licensing
package

• The amount of storage space consumed by job files.

Note:

When a job starts, its Currency Usage is unavailable for a period of time (typically about 30
minutes), as this information comes from the Ansys Elastic Licensing portal. As the job pro-
gresses, the Currency Usage value updates when the Cloud portal receives updated data
from the licensing portal.

To refresh a job list on the Jobs page, click [Refresh] above the list.

While a solution is running, you can monitor its progress and view a live convergence chart. See Viewing
Convergence Plots (p. 98).

For a detailed look at what has happened or is currently happening behind the scenes for a selected
job, see Viewing a Job Transcript (p. 95).

Submitting a Job Kill Request

If you have attempted to stop a running batch job or end an interactive session, and the job or session
has not stopped within 10 minutes, you can submit a request to the Cloud operations team to completely
kill the job for you. This will stop the execution of the job on Cloud hardware, close the job session,
and release all hardware resources associated with the job.

Note:

• Do not submit a job kill request unless you have already tried to stop the job yourself
and have waited at least 10 minutes.

See the following:

– Stopping a Batch Job (p. 47)

– Ending an Interactive Session (p. 77)

• You cannot submit a job kill request for a job that has been shared with you. You must
be the owner of the job.

If you have attempted to stop a batch job from a desktop application, try stopping it again using the
End Session action in the Cloud portal. See Stopping a Batch Job from the Cloud Portal (p. 49).

To submit a job kill request, click the Submit job kill request icon on the Cloud portal toolbar:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
86 and its subsidiaries and affiliates.
 Submitting a Job Kill Request

Job Kill Request Wizard

When you choose to submit a job kill request, a wizard is launched for submitting the request:

In the wizard:

1. Click Next.

2. On the Job ID screen, enter the job's identification number, then click Search. You can find the
identification number in the job monitor on the Jobs page, or on the job view page of a selected
job. If you submitted the job kill request from the job view, the job ID is pre-filled for you.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 87
Solving in the Cloud

3. Click Next.

4. On the Confirmation screen, review the details of the job kill request:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
88 and its subsidiaries and affiliates.
 Sharing a Job

5. Click Next to send the request. The request is confirmed:

6. Click Finish to close the wizard.

Sharing a Job
When you share a job that you have submitted with other users, those users can monitor the job or
view information about it in the Cloud portal. You may, for example, want to share a job with adminis-
trators or technical support staff so that they can troubleshoot issues more efficiently.

To share a job:

1. Sign in to the Cloud portal at https://cloud.ansys.com.

2. On the Dashboard or Jobs page, click the job in the job monitor.

3. On the job view page, click Share. You are prompted to specify share settings:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 89
Solving in the Cloud

4. Select the tab that corresponds to the person or group with whom you would like to share the
job, then enter the required information:

• Users. Share with other users at your company who are able to access the Cloud portal.

In the Email field, enter the email address associated with each user's Ansys Account.

• Groups. Share with a predefined group of users at your company.

Enable the desired group with whom you would like to share the job.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
90 and its subsidiaries and affiliates.
 Sharing a Job

• Support. Share with Ansys Technical Support.

Make sure that you submit a support ticket before sharing the job. Your Technical Support
provider will provide you with a Support Request number. Enter this number in the Support
request ticket number field. This will allow the provider to access your session and files (if in-
cluded).

5. Specify whether you want to Include input and output files. If enabled, recipients will be able to
access the files on the Files tab of the job view. Note that files may be shared to regions outside
of the region to which the job was submitted.

If disabled, recipients will need to request access to the files. They will be able to send a request
from the Files tab of the job view:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 91
Solving in the Cloud

Ensure that the Request access to input files option is Activated, then click Send request.

6. Optionally specify a Message to provide further detail about the job.

7. To copy a link to the job to your clipboard, click Copy link at the bottom of the dialog box. The
link is immediately copied to your clipboard. A confirmation is displayed:

8. When you are ready to share the job, click Share. An email notification is sent to the specified re-
cipient(s).

The job appears on the recipient's Jobs page, in the Shared with me pane.

Note:

Only the owner of a job can share it with others and perform actions like 'Delete' or 'End
Session' (or 'Restart' for an interactive job). However, any user with whom the job has been
shared can postprocess the solution in the Cloud.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
92 and its subsidiaries and affiliates.
 Deleting a Job

Viewing Job Share Information

To see a list of users and/or groups with whom you have shared a job, click the job on the Dashboard
or Jobs page to display the job view. Job share details are displayed to the right of the toolbar:

Deleting a Job
To free up data storage space in the Cloud, or simply clean up the job monitor, you can delete completed
jobs from the system. When you delete a job, all data associated with the job is deleted as well.

To delete a job:

1. Sign in to the Cloud portal at https://cloud.ansys.com.

2. Go to the Jobs page, and then enable the check box of the job(s) that you want to delete. Note
that jobs in the Running state cannot be deleted.

3. Click Delete.

4. Confirm your selections before proceeding with the deletion:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 93
Solving in the Cloud

Deleted jobs are removed from the job monitor in the Cloud portal and the Cloud app.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
94 and its subsidiaries and affiliates.
Viewing Solution Progress and Results
When a solve job is submitted to the Cloud, job details and transactions are reported live as they occur,
enabling you to closely monitor the job's progress.

Once a solution starts iterating, you can view convergence plots that show how residuals are evolving
as the solution progresses. When the solution has completed, you can validate the results in the portal's
3D viewer and then download and read in the results in your desktop application. Or, you can postprocess
results in a Cloud-hosted application via remote desktop.

Topics:
Viewing a Job Transcript
Viewing Convergence Plots
Viewing Monitor Report Files
Viewing Result Trackers
Customizing Graphs
Postprocessing Results in the Cloud
Downloading Ansys Electronics Desktop Results from the Cloud
Downloading Ansys Fluent Results from the Cloud
Downloading Ansys Mechanical Results from the Cloud

Viewing a Job Transcript

When a job is submitted to the Cloud, information about the job is captured in a running job transcript.

A job transcript includes detailed information about the following:

• Application inputs (that you specified on your local machine)

• Cloud service transactions, such as:

– Uploads and downloads

– Resource pool creation

– Solver runs

• Solver output

• Local client transactions (for example, download of result files from the Cloud)

You can view the transcript for any job in any state using the Cloud app or Cloud portal.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 95
Viewing Solution Progress and Results

Cloud App for Ansys Fluent and Ansys Mechanical

To view a job transcript in the Cloud app, simply enable the job's check box in the job monitor. The
transcript is automatically displayed in the lower Monitoring pane:

To save the transcript to a text file, click [Save].

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
96 and its subsidiaries and affiliates.
 Viewing a Job Transcript

Cloud Portal
To view a job transcript in the Cloud portal:

1. Go to https://cloud.ansys.com.

2. On the Dashboard or Jobs page, click the job in the job monitor.

3. On the job view page, select the Text monitor tab.

4. From the Display drop-down, select MainTranscript. Use the Show dropdown to control the
number of messages shown in the transcript window:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 97
Viewing Solution Progress and Results

Viewing Convergence Plots

During the solution phase, and after the solution has been completed, you can display convergence
plots in both the Cloud app and Cloud portal. When a convergence plot is displayed, you can use two
additional dropdown menus to choose the X-Axis and Y-Axis values to plot.

When a solution is in progress, convergence plots update in real time.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
98 and its subsidiaries and affiliates.
 Viewing Convergence Plots

Cloud App for Ansys Fluent and Ansys Mechanical

To view convergence plots in the Cloud app:

1. Launch the Cloud app (p. 10) in your desktop application, then select the job in the job monitor.

2. In the Monitoring pane, click [Solution Monitor].

3. In the monitor, select the desired values to plot on the X and Y axes.

The following choices are available for Fluent:

• continuity

• epsilon

• Iteration

• k

• x-velocity

• y-velocity

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 99
Viewing Solution Progress and Results

• z-velocity

The following choices are available for Mechanical:

• Bisection

• Cum Iter

• F CRIT

• F L2

• Line Search Parameter

• Load Step

• Max DOF Incr

• Remesh

• Sub-step

• Time Incr

• U CRIT

• U INF

Cloud Portal
To view convergence plots in the Cloud portal:

1. Sign in to the Cloud portal at https://cloud.ansys.com.

2. On the Dashboard or Jobs page, click the job in the job monitor.

3. On the job view page, select the Graph monitor tab.

4. From the Display drop-down, select convergence-residuals for a Fluent job or Convergence for
a Mechanical job.

To ensure that the complete curve is plotted, you should select All from the Show drop-down.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
100 and its subsidiaries and affiliates.
 Viewing Monitor Report Files

To edit the current graph or create a new graph, see Customizing Graphs (p. 105).

Viewing Monitor Report Files

When a monitor is defined for an Ansys Fluent solution, you can view the resulting report files in both
the Cloud app and Cloud portal.

Cloud App for Ansys Fluent

To view monitor report files in the Cloud app:

1. Launch the Cloud app (p. 10) in your desktop application, then select the job in the job monitor.

2. In the Monitoring pane, click [Trackers].

3. From the drop-down, select Report Files@monitorName.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 101
Viewing Solution Progress and Results

4. Use the Graph drop-down to add a new graph or select other available graphs (if applicable).

Cloud Portal
To view monitor report files in the Cloud portal:

1. Sign in to the Cloud portal at https://cloud.ansys.com.

2. On the Dashboard or Jobs page, click the job in the job monitor.

3. On the job view page, select the Graph monitor tab.

4. From the Display drop-down, select Report Files, then from the adjacent drop-down select the
desired report file set to view.

To ensure that the complete curve is plotted, you should select All from the Show drop-down.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
102 and its subsidiaries and affiliates.
 Viewing Result Trackers

5. Use the left pane to specify what you would like to display on the X and Y axes.

To edit the current graph or create a new graph, see Customizing Graphs (p. 105).

Viewing Result Trackers

For non-linear Ansys Mechanical solutions you can view graphs of specific displacement and contact
results as a function of time. Result trackers can be viewed in both the Cloud app and Cloud portal.

Cloud App for Ansys Mechanical

To display result trackers in the Cloud app:

1. Launch the Cloud app (p. 10) in your desktop application, then select the job in the job monitor.

2. In the Monitoring pane, click [Trackers].

3. From the adjacent drop-down, select Trackers.

4. From the Graph drop-down, select the graph that you want to view.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 103
Viewing Solution Progress and Results

Cloud Portal
To view result trackers in the Cloud portal:

1. Sign in to the Cloud portal at https://cloud.ansys.com.

2. On the Dashboard or Jobs page, click the job in the job monitor.

3. On the job view page, select the Graph monitor tab.

4. From the Display drop-down, select Trackers.

To ensure that the complete curve is plotted, you should select All from the Show drop-down.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
104 and its subsidiaries and affiliates.
 Customizing Graphs

5. By default, Time is plotted on the X axis. To view a different graph, select it in the Graphs pane.

To edit the current graph or create a new graph, see Customizing Graphs (p. 105).

Customizing Graphs
When viewing graphs in the Cloud app or Cloud portal, you can create new graphs to view specific sets
of data. In the Cloud portal you can also edit existing graphs and save graph configurations that can
be loaded into other job views.

Creating a Graph in the Cloud App

When viewing convergence plots, monitor reports, result trackers, and HPC performance graphs for a
job in the Cloud app, you can create a new graph that displays data of your choice on the X and Y axes.

1. Launch the Cloud app (p. 10) in your desktop application, then select the job in the job monitor.

2. In the Monitoring pane, go to the appropriate graph display window:

• For convergence plots, click .

• For monitor reports (Fluent), result trackers (Mechanical), or HPC performance graphs, click ,
then select the desired graph type from the adjacent drop-down.

3. From the Graph drop-down, select Add new graph.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 105
Viewing Solution Progress and Results

4. In the Create new graph dialog box, specify a name for the graph, then select the data to be
displayed on the X and Y axes. For example,

5. Click OK. The graph is displayed and also added to the Graph drop-down.

Creating a Graph in the Cloud Portal

In the Cloud portal, when a graph is displayed on the Graph monitor tab in a job view, you can use
the actions in the Graphs pane to add, edit, save, and load graph configurations to suit your needs.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
106 and its subsidiaries and affiliates.
 Customizing Graphs

To add a new graph, click in the Graphs pane.

To edit the currently selected graph, click .

In the Add Graph or Edit Graph dialog box, specify the desired graph settings. The available options
depend on the solver and the type of graph currently selected in the Display drop-down (for example,
HeadNodePerf, convergence-residuals, or Trackers).

The following example shows the available graph options for a Fluent job when HeadNodePerf is se-
lected for display:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 107
Viewing Solution Progress and Results

Use the X-axis and Y-axis settings to specify how you would like data to be plotted.

When there is a large range of values, selecting the y logarithmic option presents data on a logarithmic
scale rather than a linear scale.

Note:

Graph customizations apply to the current job only. However, you can save customiza-
tions (p. 109) to a file so that you can load them in other job views.

Deleting a Graph
In the Cloud portal you can delete graphs that are not needed.

To delete a graph:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
108 and its subsidiaries and affiliates.
 Customizing Graphs

1. In the Graphs pane, select the graph that you want to delete.

2. Click .

Saving Custom Graph Configurations

In the Cloud portal, if you have added, edited, or deleted graphs in a graph display window, you can
save your configuration of graphs to a file so that you can subsequently load (p. 109) the configuration
in another job view.

To save a graph configuration:

1. In the Graphs pane, click ..

2. Enter a name for the configuration, then click OK. Configurations are saved to a .json file.

Loading a Saved Graph Configuration

In the Cloud portal, when you save (p. 109) a configuration of graphs to a file, you can load the config-
uration in other job views.

To load a saved graph configuration:

1. In the Graphs pane, click on the toolbar.

2. In the File Upload dialog box, select the .json file to load. By default, graph configurations are
saved in your computer's default download location (for example, C:\Users\username\Down-
loads).

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 109
Viewing Solution Progress and Results

Restoring the Default Graph Configuration

In the Cloud portal, if you have added, edited, or deleted graphs in a graph display window, you can
restore the default list of graphs and their default settings by clicking in the Graphs pane.

Note:

This action removes any new graphs that were added to the view. If you want to retain graph
customizations for possible reuse in the future, you can save (p. 109) them to a file.

Postprocessing Results in the Cloud

There are two types of postprocessing available in the Cloud:

Quick Postprocessing. Use a visualization tool in the Cloud portal to perform lightweight postpro-
cessing of results so that you can validate them before downloading them to your local desktop
application. Use the tool to view and rotate the 3D model, view built-in locations and cutting planes,
and create custom locations and cutting planes on the fly.
Standard Postprocessing. Run a Cloud-hosted version of the application normally used for post-
processing results via a remote desktop session. For example, Ansys Fluent is launched for postpro-
cessing Fluent result files.

Topics:
Quick Postprocessing in the Cloud Portal
Postprocessing in the Cloud via Remote Desktop

Quick Postprocessing in the Cloud Portal

When a job that you have submitted to the Cloud completes, you can use the View results action
in the Cloud portal (or POST IN CLOUD in the Cloud app) to perform lightweight postprocessing of
solution results directly in the Cloud portal. This enables you to quickly validate results before
downloading them to your local desktop application. The built-in postprocessing tool offers basic
visualization capabilities. It enables you to view and rotate the 3D model, view built-in locations and
cutting planes, and create custom locations and cutting planes.

You can start a postprocessing session from the Cloud app for Ansys Fluent and Ansys Mechanical,
or directly in the Cloud portal. When you start a session, a new job is created in the job monitor.

Once you have validated the results in the Cloud, you can download the results (p. 134) to your local
machine for further processing if desired.

Topics:
Starting a Postprocessing Session in the Cloud
Viewer Basics
Maximizing the Viewing Area
Interactive Controls
Animations

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
110 and its subsidiaries and affiliates.
 Postprocessing Results in the Cloud

Object Visibility
Built-in Locations
Creating a Part Group
Creating a Plane
Creating a Contour Plot
Creating a Vector Plot
Creating an Isosurface
Creating an Isovolume
Global Display Settings
Ending a Postprocessing Session
Restarting a Postprocessing Session

If you would like to perform full postprocessing using Cloud resources, see Postprocessing in the
Cloud via Remote Desktop (p. 130).

Note:

For Ansys CFX solutions, the portal's View results feature only supports steady-state
solutions that have been written as a single CFX .res file. Transient or multi-configuration
solutions are not supported. Solutions written to .cff or .flprj files are also not sup-
ported.

Starting a Postprocessing Session in the Cloud

When a solve job completes, you can start a postprocessing session in the Cloud from the Cloud
app, or in the Cloud portal.

Cloud App for Ansys Fluent and Ansys Mechanical

To start a postprocessing session from the Cloud app:

1. Launch the Cloud app (p. 10) in your desktop application, then select the job in the job
monitor.

2. Click POST IN CLOUD. (Note that this option is disabled if you chose 'Archive' as the file
transfer option when setting up the job.)

A connection is made to the Ansys Cloud server:

Once the connection is made, you are prompted to sign in to the Cloud portal.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 111
Viewing Solution Progress and Results

3. Sign in to the Cloud portal using your Ansys Account credentials.

A postprocessing session is prepared on the Jobs page:

Once the results are loaded, you can begin postprocessing (p. 114) them.

Cloud Portal
To start a postprocessing session directly in the Cloud portal:

1. Sign in to the Cloud portal at https://cloud.ansys.com.

2. On the Dashboard or Jobs page, click the job in the job monitor.

3. On the job view page, click View results.

Note:

• This option is disabled if you chose 'Archive' as the file transfer option when setting
up the job.

• For Ansys CFX solutions, the View results feature only supports steady-state
solutions that have been written as a single CFX .res file. Transient or multi-
configuration solutions are not supported. Solutions written to .cff or .flprj
files are also not supported.

4. When prompted, proceed with postprocessing the solution results:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
112 and its subsidiaries and affiliates.
 Postprocessing Results in the Cloud

A postprocessing session is prepared on the Jobs page:

Once the results are loaded, you can begin postprocessing (p. 114) them.

Note:

Navigating to another page will end the postprocessing session, and the state of the
postprocessing job will change to in the job monitor. You can, however,
restart (p. 130) the session later if needed.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 113
Viewing Solution Progress and Results

Viewer Basics
When you start a postprocessing session for a solution in the Cloud portal, the results are loaded
into a 3D viewer window:

Use your mouse to zoom, pan, and rotate. On-screen aids and toolbars provide additional viewing
control.

Related Topics:

Maximizing the Viewing Area (p. 115)

Interactive Controls (p. 115)
Animations (p. 116)
Object Visibility (p. 117)
Built-in Locations (p. 117)
Creating a Part Group (p. 117)
Creating a Plane (p. 118)
Creating a Contour Plot (p. 120)
Creating a Vector Plot (p. 122)

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
114 and its subsidiaries and affiliates.
 Postprocessing Results in the Cloud

Creating an Isosurface (p. 124)

Creating an Isovolume (p. 126)

Maximizing the Viewing Area

To maximize the viewing area of the postprocessing window, you can switch to full window mode
at any time by clicking Full Window on the toolbar. This temporarily hides the rest of the Cloud
portal interface and extends the view window to the bounds of the browser window.

To toggle full window mode off, click on the visualization toolbar.

Interactive Controls
When viewing a model, you can use your mouse to zoom in and out, pan, and rotate the model.

Zooming In and Out

To zoom in and out, use one of the following:

• Mouse scroll wheel (or middle mouse button if you have an older mouse)

• Shift + left mouse button

Panning
To pan the view, use Ctrl + left mouse button.

Rotating the Model

To rotate the model freely, click and drag with your left mouse button.

To set a new pivot point for rotations, right-click the desired point and select Set Pivot Point Here.
To reset the pivot point to the default point, right-click and select Reset Pivot.

For quick, preset orientations, use the orientation aid in the lower left corner of the viewer window:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 115
Viewing Solution Progress and Results

Animations
Animations are associated with Mechanical results. The behavior of an animation depends on the
type of simulation performed. For information about animation types, see the Animation topic in
the Ansys Mechanical User's Guide.

Playing an Animation
For Mechanical results, an animation control bar is displayed in the top right corner of the viewer
window. Use the control bar to play and pause the animation, step back and forward one frame at
a time, rewind to the beginning, or fast forward to the end.

Adjusting Animation Speed

To increase or decrease the speed of animation, go to Display Options > Settings and edit the
Animation Frame Rate. This is the number of frames displayed per second. The higher the value,
the faster the animation will play.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
116 and its subsidiaries and affiliates.
 Postprocessing Results in the Cloud

Object Visibility
To hide an object from view, right-click the object and select Hide. Or, click the object in the Display
Options panel.

To display a hidden object, click the object in the Display Options panel.

Built-in Locations
A location is defined as a part or plane.

The Display Options panel contains a list of Built-In Locations that are part of the original simu-
lation file:

Clicking on a location in this list toggles its visibility on and off. You cannot rename or edit the
contents of a built-in location, but you can control its display properties.

Creating a Part Group

You may want to create a location that has multiple parts associated with it, enabling you to
highlight or control those parts as a group.

To create a part group:

1. Click on the visualization toolbar.

Or, in the Display Options panel, click next to My Locations, then select Part Group in
the Create Location dialog box.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 117
Viewing Solution Progress and Results

2. In the Part Group Properties dialog box, specify the properties of the part group:

• Name. A name to identify the part group in the locations list.

• Part. To assign a part to the location, click the part in the list to highlight it. Use Ctrl+click
or Shift+click to select multiple parts.

• Color. Click the color swatch to select a display color for the location's part(s) from the
Color dialog box.

• Draw Style. Choose how you want to render the location's part(s):

– Surface

– Surface Mesh

– Surface Outline Mesh

– Lines

– Points

– Outline

– Hidden Lines Removed

• Eye Lift. Use when facing z fighting issues (triangles rendered in the same plane). By applying
eye lift to one part, it will be moved slightly towards the eye, resolving these issues. Choose
from three eye lift factors (0.01, 0.1, or 1.0), or turn eye lift Off.

• Opacity. 1.0 is fully opaque, 0.0 is fully transparent (invisible).

• Smooth Shading. When enabled, the color changes from pixel to pixel, resulting in a smooth
color transition between two adjacent polygons, and a smoother appearance overall. When
disabled, flat shading is used, where every pixel is rendered with the same color.

Creating a Plane
A plane is a two-dimensional area that exists within the boundaries of the computational domain.
Typically a plane is used to create a section view of a model, where the model is peeled away as
you move the plane back and forth through the model.

To create a plane:

1. Click on the visualization toolbar.

Or, in the Display Options panel, click next to My Locations, then select Plane in the
Create Location dialog box.

2. In the Plane Properties dialog box, specify the properties of the plane:

• Name. A name to identify the plane in the locations list.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
118 and its subsidiaries and affiliates.
 Postprocessing Results in the Cloud

• Point. The coordinates of a point on the plane.

• Normal. A normal vector to the plane. When clipping is enabled, this determines the side
of the plane on which the object is peeled away.

To flip the normal so that the object is peeled away on the opposite side, click Flip Normal.

• Color. Click the color swatch to select a display color for the plane from the Color dialog
box.

• Show Mesh. Applies a mesh to the plane.

• Clip Scene. When clipping is enabled, the model is peeled away on the Normal side of the
plane, creating a sectional view. This lets you see internal details that may not be visible
from outside. When enabled, the clipping tool becomes enabled in the Display Options
panel.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 119
Viewing Solution Progress and Results

You can then use the slider to peel away the model as you move the plane.

Creating a Contour Plot

Contour plots are used to examine how a variable changes locally or throughout the model, and
are often useful for locating severe gradients and conditions (for example, hot spots on the surfaces
of objects).

To create a contour plot:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
120 and its subsidiaries and affiliates.
 Postprocessing Results in the Cloud

1. Click on the visualization toolbar.

Or, in the Display Options panel, click next to My Graphics, then select Contour in the
Create Graphic dialog box.

2. In the Contour Properties dialog box, specify a Name for the contour, as well as the following
properties:

• Location. Select the location (parts) to which you want to apply contours.

• Scalar. The variable that you want the contours to represent. For example, selecting Tem-
perature will display contours that show temperature fluctuations across a location.

• Opacity. 1.0 is fully opaque, 0.0 is fully transparent (invisible).

3. Click Save. The contour plot is added to the My Graphics list in the Display Options panel,
and displayed in the view window:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 121
Viewing Solution Progress and Results

Creating a Vector Plot

Certain result items can be displayed using vectors, such as the vector principal stresses or vector
principal strain results. Total deformation, total velocity and total acceleration can also be displayed
using vectors. When you create a vector plot in the viewer, you can control various display settings.

To create a vector plot:

1. Click on the visualization toolbar.

Or, in the Display Options panel, click next to My Graphics, then select Vector in the
Create Graphic dialog box.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
122 and its subsidiaries and affiliates.
 Postprocessing Results in the Cloud

2. In the Vector Properties dialog box, specify a Name for the plot, as well as the following
properties:

• Location. The location (parts) on which you want to display vector plots.

• Vector. The result item to display as vectors:

• Color. The color in which the vectors will be displayed.

• Scale Factor. A scaling value to control the size of vectors.

• Grid Spacing. This applies to planes only. It is used to control the spacing between vectors.

• Scale Mode. An alternate way to scale the vectors. It is applied along with the Scale Factor.

Scale Mode has 2 settings:

– Absolute. The actual magnitude of the vector is used and scaled by the Scale Factor.

– Relative. The Scale Factor is relative to the bounding box, so a Scale Factor of 0.1 means
that the longest vector will be 10% of the bounding box extents.

3. Click Save. The vector plot is added to the My Graphics list in the Display Options panel,
and displayed in the view window:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 123
Viewing Solution Progress and Results

Creating an Isosurface
An isosurface is a surface upon which a particular variable has a constant value.

To create an isosurface:

1. Click on the visualization toolbar.

Or, in the Display Options panel, click next to My Graphics, then select Isosurface in the
Create Graphic dialog box.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
124 and its subsidiaries and affiliates.
 Postprocessing Results in the Cloud

2. In the Isosurface Properties dialog box, specify a Name for the isosurface, as well as the fol-
lowing properties:

• Scalar. The variable that you want to track:

• Scalar Value. The value (constant) of the variable being tracked.

• Color. Click the color swatch to select a color for the isosurface.

• Opacity. 1.0 is fully opaque, 0.0 is fully transparent (invisible).

Together, the variable and its value define the extents of the surface.

3. Click Save. The isosurface is added to the My Graphics list in the Display Options panel, and
displayed in the view window:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 125
Viewing Solution Progress and Results

Creating an Isovolume
An isovolume is a volume or three-dimensional region throughout which a particular variable has
a constant value.

To create an isovolume:

1. Click on the visualization toolbar.

Or, in the Display Options panel, click next to My Graphics, then select Isovolume in the
Create Graphic dialog box.

2. In the Isovolume Properties dialog box, specify a Name for the isovolume, as well as the
following properties:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
126 and its subsidiaries and affiliates.
 Postprocessing Results in the Cloud

• Scalar. The variable that you want to track:

• Minimum/Maximum Scalar Result Value. The range of the values that define the bounds
of the volume.

• Color. The color used for isovolume display.

• Opacity. 1.0 is fully opaque, 0.0 is fully transparent (invisible).

3. Click Save. The isvolume is added to the My Graphics list in the Display Options panel, and
displayed in the view window:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 127
Viewing Solution Progress and Results

Global Display Settings

The Settings section in the Display Options panel contains settings that apply globally to results
display for certain solution types:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
128 and its subsidiaries and affiliates.
 Postprocessing Results in the Cloud

The available settings are described below.

Displacement Scale
For models that include a mesh displacement in the results, the Displacement Scale value changes
the scale of that displacement.

Solution State
Some files have many solutions calculated at different times. To display solution results from a
particular point in time, select a time from the State dropdown:

Animation Frame Rate

When animations are played, this is the number of frames displayed per second. The higher the
value, the faster the animation will play.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 129
Viewing Solution Progress and Results

Ending a Postprocessing Session

When you are finished your postprocessing session in the Cloud portal, click Save and Exit to save
the session in its current state, and exit the job.

The job's state becomes in the job monitor.

You can restart (p. 130) the session later if needed.

Restarting a Postprocessing Session

Any postprocessing session that is in the state can be restarted if needed, enabling
you to pick up where you left off.

To restart a postprocessing session, click Restart on the toolbar. When prompted, confirm that you
want to restart the job.

It may take a moment for the postprocessing session to load.

Postprocessing in the Cloud via Remote Desktop

When a solve job completes you can use the VDI Postprocess action in the Cloud portal to perform
full postprocessing of results in the Cloud. An application running on the Cloud is made available to
you in a remote desktop session, enabling you to interact with the application just as you would if
you were running the application locally. The application launched depends on the solution type.
For example, Ansys Fluent is launched for postprocessing Fluent result files, and LS-PrePost is launched
for postprocessing the results of an Ansys LS-DYNA or LSTC job.

To launch a postprocessing session:

1. Sign in to the Cloud Portal at https://cloud.ansys.com on a Windows laptop or desktop computer.

2. If not already open, locate the job in the job monitor and open it.

3. Click VDI Postprocess.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
130 and its subsidiaries and affiliates.
 Postprocessing Results in the Cloud

You are prompted to specify your session settings:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 131
Viewing Solution Progress and Results

4. In the Start your Desktop dialog box, specify the following:

• Version. The desired application version to run.

• Hardware settings. Choose from a list of pre-configured hardware configurations. Use the
Cores, Memory, Storage, and GPU information to select the virtual machine that best meets
your postprocessing needs.

• Time limit. The maximum duration of the session in hours (for no time limit, enter 0). When
the time limit is reached, the session is interrupted. You can edit the time limit (p. 45) in the
Cloud portal after the job has started running.

• Upload files while running. Files that are generated or modified during the session will be
automatically uploaded to Cloud storage when you end the session. Enabling this option up-
loads files to Cloud storage while the session is running. If disabled, you can manually transfer
files (p. 74) to Cloud storage during an active session if desired.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
132 and its subsidiaries and affiliates.
 Postprocessing Results in the Cloud

• Upload frequency. The frequency at which output files are transferred from the VM to Cloud
storage.

5. Click Start.

The interactive session starts and is listed as a 'Desktop postprocess' job in the job monitor.

First, the compute resource is started:

Once the remote resource is running, result files are transferred from the Cloud job folder to the
compute resource.

Once the file transfer is complete, a remote desktop launches in a virtual window embedded in
the job view. You can then launch and interact with a postprocessing application. For information
about working in a remote view, see Running an In-Browser Session (p. 59).

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 133
Viewing Solution Progress and Results

Downloading Ansys Electronics Desktop Results from the Cloud

If you did not choose to automatically download results when submitting an Ansys Electronics Desktop
job to the Cloud, you can use the job monitor in Ansys Electronics Desktop to download results.

When the status of a Cloud job is Completed in Ansys Electronics Desktop, a Download menu becomes
available in the Monitor Job window. It contains the following options:

Download Results: Downloads the full results

Download S Parameters: Downloads only exported S parameters
Download Files: Downloads files matching a specified pattern

Downloading Ansys Fluent Results from the Cloud

If you did not choose to download results automatically when submitting a Fluent solve job to the
Cloud, you can use the Cloud app to download the result files from the Cloud to a specified location
on your local machine.

To download Fluent results from the Cloud:

1. Launch the Cloud app (p. 10) in Ansys Fluent, then select the job in the job monitor.

2. On the toolbar, click DOWNLOAD RESULTS.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
134 and its subsidiaries and affiliates.
 Downloading Ansys Mechanical Results from the Cloud

3. In the Browse For Folder dialog box, select or create a target folder for the downloaded files, and
then click OK. The files are downloaded to the specified folder.

Note:

To have results download automatically when a job completes, enable the Download results
after completion option on the job submission form. See Submitting a Job to the Cloud
from Ansys Fluent (p. 26).

Downloading Ansys Mechanical Results from the Cloud

If you did not choose to download results automatically when submitting a Mechanical solve job to
the Cloud, you can use the Cloud app to download the result files from the Cloud to your local project.

To download Mechanical results from the Cloud:

1. Launch the Cloud app (p. 10) in Ansys Mechanical, then select the job in the job monitor.

2. On the toolbar, click DOWNLOAD RESULTS. Result files begin downloading to your local project.
You can monitor the progress of the download in the Monitoring pane:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 135
Viewing Solution Progress and Results

Note:

To have results download automatically when a job completes, enable the Download results
after completion option on the job submission form. See Submitting a Job to the Cloud
from Ansys Fluent (p. 26).

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
136 and its subsidiaries and affiliates.
Managing Data in the Cloud
There are two areas where data is stored in the Cloud:

Personal Data. This is a personal Cloud storage space that only you can see and access. You can create
folders in this area and upload files that you want to use in interactive sessions.

Jobs Data. This area stores the input, monitoring, and output files associated with Fluent and Mechan-
ical batch jobs, and the monitoring files associated with interactive sessions and AEDT batch jobs.

You can organize, rename, upload, and download files and folders in both the Personal Data and Jobs
Data areas. Folders in either area can be used as the job folder for an interactive session.

Files stored in the Cloud consume storage space that has been allotted to you. Therefore, it is a good
idea to periodically delete files that are no longer needed. To see how much storage is currently being
used, see Checking Your Storage Consumption (p. 208).

For specific information about how data is handled during remote desktop sessions, see Managing Files
in Interactive Sessions (p. 73).

Topics:
Accessing Personal Data
Accessing Job Data
Managing Files and Folders

Accessing Personal Data

You can upload files and folders to a Personal Data area in the Cloud which only you can access.
Typically you would do this when you want to run an interactive session on the Cloud using files from
your local computer. The Personal Data area is also where input and output files from AEDT batch jobs
are written.

To access your Personal Data area:

1. Sign in to the Cloud portal at https://cloud.ansys.com.

2. In the navigation pane, select Files.

3. On the Files page, on the Personal Data tab, select the data center to which you want to upload
files or from which you want to retrieve files:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 137
Managing Data in the Cloud

For information on organizing, uploading, and downloading files, see Managing Files and Folders (p. 140).

Accessing Job Data

Job data includes the input, monitoring, and output files associated with a job.

In the Cloud portal, you can access job data on the Files page, or on the Files tab of a job object.

To access job data, sign in to the Cloud portal at https://cloud.ansys.com.

There are two ways to access job data in the Cloud portal:

• Select Files in the navigation pane, then select either the Personal Data or Jobs Data tab depending
on where the files were written.

If you select Jobs Data, a list of jobs is displayed:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
138 and its subsidiaries and affiliates.
 Accessing Job Data

Click the job whose files you want to access. The job's files are displayed:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 139
Managing Data in the Cloud

• On the Dashboard or Jobs page, select the job in the job monitor to open it. Then, in the job view,
select the Files tab:

For information on organizing, renaming, uploading, and downloading files and folders, see Managing
Files and Folders (p. 140).

See Also:

• Accessing Batch Job Output Files (p. 51)

• Managing Files in Interactive Sessions (p. 73)

Managing Files and Folders

Both the Personal Data and Jobs Data areas provide the ability to organize, rename, upload, and
download files. Keep in mind that data stored in the Cloud consumes storage space that has been al-
lotted to you, so it is a good idea to check your resource usage (p. 208) periodically and delete files that
you no longer need.

Topics:
Creating Folders
Uploading Files and Folders
Cutting, Copying, and Pasting
Renaming Files and Folders
Downloading Files and Folders

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
140 and its subsidiaries and affiliates.
 Managing Files and Folders

Deleting Files and Folders

Creating Folders
Prior to uploading files to the Personal Data or Jobs Data areas you may want to create folders to
keep files organized and easy to find.

To create a folder:

1. Sign in to the Cloud portal at https://cloud.ansys.com.

2. Go to Personal Data (p. 137) or Jobs Data (p. 138), then go to the area or folder where you want
to create a folder.

3. Click New Folder.

4. Type a name for the folder, then click Create:

You can now upload (p. 142), move, or copy items to the new folder.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 141
Managing Data in the Cloud

Uploading Files and Folders

When you want to run applications interactively in the Cloud, you can upload files and folders from
your local computer to the Personal Data or Jobs Data area in the Cloud for use in interactive sessions.

Before uploading files, make sure that the File Transfer Agent (p. 80) is running.

To upload files and folders:

1. Sign in to the Cloud portal at https://cloud.ansys.com.

2. In the navigation pane, select Files.

3. Go to either Personal Data (p. 137) or Jobs Data (p. 138), then go to the area or folder where you
want to upload files.

4. Click Upload.

5. In the Encrypted File Upload dialog box, click the dropdown next to Upload and select either
Files or Folder:

6. Click Browse to open a file selector, then select the files or folder that you want to upload from
your local machine.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
142 and its subsidiaries and affiliates.
 Managing Files and Folders

7. (Optional) To create a subfolder for the uploaded files or folder in the target location, enter a
folder name in the Create subfolder field. This is particularly convenient if you are uploading
files instead of a folder, as it helps to keep files organized in the storage area.

8. Select the File transfer option that is best suited for the size and number of files being transferred
to the Cloud. Compressing or archiving files can make transfers smaller and faster, reducing
transfer and storage charges, but is not always necessary or beneficial. Use the table below to
compare options and select the best one for the current upload.

Can be used
Individual files
with low
Option Compression Use to transfer visible in Cloud
bandwidth
file explorer
connections
Small number of small
Default None
files
Compresses files
Small number of large
Compress individually into .gz
files
files
Packs files into a single
Archive Large number of files
archive (.tar)

9. Click Upload.

The File Transfer Agent uploads the selected files to the Cloud:

10. Refresh the view to display your uploaded files.

Using the Command Line Interface to Upload Files

If you are unable to upload files using the File Transfer Agent, you can use the Command Line Interface
(CLI) to upload the files manually.

1. In the Encrypted File Upload dialog box, click Show CLI command.

The appropriate command is displayed:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 143
Managing Data in the Cloud

2. Copy and paste the command in a Command Prompt window.

For more information about the upload command, see upload (p. 202) in the CLI Command Reference.

Cutting, Copying, and Pasting

When working in a data view on the Files page or the Files tab of a job view, you can cut or copy
items in one folder and paste them into another folder.

To cut, copy, and paste:

1. Enable the check box of the file(s) or folder(s) that you want to cut or copy.

2. On the toolbar, click either Cut or Copy.

3. Within the view, navigate to the folder where you want to paste the item(s):

• If you are on the Files tab of a job view, you can only paste the item(s) within the job's folder
structure.

• If you are on the Files page, you can paste the item(s) in any folder that is accessible on that
page. If the target folder is outside the current location, use either the tabs or breadcrumb on
the Files page to navigate to the desired folder.

4. Open the target folder, then click Paste on the toolbar.

Renaming Files and Folders

When working in a data view on the Files page or the Files tab of a job view, you can rename files
and folders to suit your needs.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
144 and its subsidiaries and affiliates.
 Managing Files and Folders

To rename a file or folder:

1. Enable the check box of the file or folder that you want to rename.

2. On the toolbar, click Rename.

3. In the Rename dialog box, type the new name, then click Rename.

Downloading Files and Folders

You can download any files or folders that are stored in the Personal Data or Jobs Data areas in the
Cloud.

Before downloading files, make sure that the File Transfer Agent (p. 80) is running.

To download files or folders:

1. Sign in to the Cloud portal at https://cloud.ansys.com.

2. Go to Personal Data (p. 137) or Jobs Data (p. 138), then locate the files or folder that you want to
download.

3. Select the desired item(s), then click Download on the toolbar.

If you are downloading only a single item, you can simply click next to the item without
having the select the item.

4. In the Encrypted File Download dialog box, click Browse to select a target folder on our local
computer. The path of the selected folder is displayed:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 145
Managing Data in the Cloud

5. Click Download.

The File Transfer Agent downloads the selected files to the local folder:

Using the Command Line Interface to Download Files

If you are unable to download files using the File Transfer Agent, you can use the Command Line
Interface (CLI) to download the files manually.

1. In the Encrypted File Download dialog box, click Show CLI command.

The appropriate command is displayed:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
146 and its subsidiaries and affiliates.
 Managing Files and Folders

2. Copy and paste the command in a Command Prompt window.

For more information about the download command, see download (p. 162) in the CLI Command
Reference.

Deleting Files and Folders

Files stored in the Cloud consume allotted storage space. Therefore, it is a good idea to periodically
delete files that are no longer needed. To see how much storage is currently being used, see Checking
Your Storage Consumption (p. 208).

To delete files and folders from Cloud storage:

1. Sign in to the Cloud portal at https://cloud.ansys.com.

2. Go to Personal Data (p. 137) or Jobs Data (p. 138), then locate the files or folder that you want to
delete.

3. Select the desired item(s), then click Delete on the toolbar.

If you are deleting only a single item, you can simply click next to the item without having
the select the item.

4. Confirm the item(s) to be deleted, then click Delete.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 147
Managing Data in the Cloud

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
148 and its subsidiaries and affiliates.
Using the Command Line to Solve in the Cloud
The Ansys Cloud Command Line Interface (CLI) enables you to submit Ansys CFX, Ansys Electronics
Desktop, Ansys Fluent, Ansys LS-DYNA, Ansys Mechanical, Ansys VRXPERIENCE, and SPEOS HPC solve
jobs to the Cloud using the command line. The CLI provides a way to execute tasks that are not currently
supported in the Ansys Cloud app, such as running Fluent using a journal file, or running a Fluent case
with UDFs attached.

Using a set of command line arguments you can specify job submission settings such as the solver to
run, the name of the input file (or journal to execute), the solver version, and solver precision. You can
also issue commands to perform other actions such as stopping or sharing a job. Jobs submitted using
the CLI appear in the Cloud portal, where you can monitor their progress, perform actions on them,
and validate results.

Topics:
Installing the Command Line Interface
Submitting a Solve Job to the Cloud via the Command line
Using a Fluent Journal File to Solve in the Cloud
Monitoring a Job Submitted from the Command Line
Viewing Available Commands
Cloud CLI Command Reference

Installing the Command Line Interface

The Ansys Cloud Command Line Interface (CLI) is included in the Ansys Cloud Suite installation package.

For instructions on installing the Ansys Cloud Suite, see Installing Ansys Cloud Suite (p. 4).

When you install the Ansys Cloud Suite, the Ansys Cloud CLI directory path is automatically added to
your PATH environment variable:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 149
Using the Command Line to Solve in the Cloud

The PATH is the system variable that your operating system uses to locate needed executables from
the command line or Terminal window.

The Ansys Cloud CLI directory contains all of the executables necessary for running Cloud jobs from
the command line.

Submitting a Solve Job to the Cloud via the Command line

Once you have installed (p. 149) the Ansys Cloud Command Line Interface (CLI), you can use the command
line to submit Ansys CFX, Ansys Electronics Desktop, Ansys Fluent, Ansys LS-DYNA, Ansys Mechanical,
Ansys VRXPERIENCE, and SPEOS HPC solve jobs to the Cloud.

To submit a job to the Cloud:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
150 and its subsidiaries and affiliates.
 Submitting a Solve Job to the Cloud via the Command line

1. In a command window, cd to the directory containing the job input file (and journal file if you are
using one).

Note:

Submitting jobs from system folders such as C:\Users\[username] is not recom-

mended, as Ansys Cloud does not have the permissions required to access such folders.
This can prevent your input file(s) from being uploaded to the cloud, resulting in job
failure. If your input file is located in such a folder, copy or move the file to a non-system
folder and submit the job from there.

In the case where a folder is accessible but some of its files and folders are not accessible
(including hidden files and sub-folders), ensure that the input files that you want to use
have the appropriate permissions to be uploaded and use the --files option in the
command line to explicitly specify the files to be uploaded for the job.

2. Type ansyscloudcli, followed by the desired job submission commands and arguments. Enter
commands and arguments in the order in which they should be executed.

The following example shows the submission of a Fluent job using a journal file, with results being
downloaded to a folder on the local machine:

D:\Simulation Files\Fluent\fluent-elbow>ansyscloudcli runFluent -j "FluentElbow" -i "elbow.cas"

-q "Flexible_eastus_Standard_HB60rs_2022R1" -n 2 -m 32 -w -d "D:\Simulation Files\fluent-el-
bow\output"

Here is a breakdown of this command line entry:

ansyscloudcli Launches the Ansys Cloud Command Line Interface (AN-

SYSCloudCLI.exe).
runFluent Launches Ansys Fluent.
-j Fluent Elbow The job name is 'FluentElbow'. This is how the job will be
identified in the job monitor.
-i "elbow.cas" The input file name is elbow.cas.
-q Use queue 'Flexible_eastus_Standard_HB60rs_2022R1'.
"Flexible_eastus_Standard_HB60rs_2022R1" Each queue represents a specific data center region and
solver version. Queue names prefixed with Small, Medium,
Large, XLarge, or XXLarge have preset hardware
configurations, while those prefixed with 'Flexible' are
associated with a specific machine type and provide the
flexibility to specify the number of nodes (-n) and
maximum number of cores (-m) to be used for the job.
-n 2 Use 2 compute nodes.
-m 32 Use a maximum of 32 cores.
-w Wait for job to finish. Display a live job transcript during
job run.
-d "D:\Simulation Download results to the folder D:\Simulation
Files\fluent-elbow\output" Files\fluent-elbow\output.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 151
Using the Command Line to Solve in the Cloud

For detailed information about all available CLI commands and options, see the Cloud CLI Command
Reference (p. 156).

Once the job is submitted, activity is reported in the Command window. This is the same information
that is reported in the job transcript when using the Cloud app or Cloud portal.

Once a job has been submitted, you will receive a 'Job Started' email notification, and you can monitor
the job in the Cloud portal. See Monitoring a Job Submitted from the Command Line (p. 154).

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
152 and its subsidiaries and affiliates.
 Using a Fluent Journal File to Solve in the Cloud

Using a Fluent Journal File to Solve in the Cloud

A journal file contains a sequence of commands, arranged as they would be if they were being entered
interactively in an application. The purpose of a journal file is to automate a series of commands instead
of entering them repeatedly on the command line. You can create a journal file to run a simple or more
elaborate case, or perform multiple or sequential runs.

Here is a sample journal file, t_junction.jou:

/file/set-tui-version "2022 R1"

/file/read-case "t_junc.cas.gz"

/define/user-defined/compiled-functions compile "libudf" yes "udf1.c" "" ""

/define/user-defined/compiled-functions load "libudf"

/define/user-defined/function-hooks/execute-at-end moyenne_sonde::libudf ""

/define/user-defined/function-hooks/execute-at-end "moyenne_sonde::libudf" ""

/solve/initialize/hyb-initialization

/solve/iterate 225

wcd "t_junc-%i.gz"

exit

yes

This journal file indicates the name of the case file to be read in (t_junc.cas.gz), and specifies a
sequence of Fluent text user interface (TUI) commands.

Some TUI commands reference User Defined Functions (UDFs). A UDF is a C or C++ function that can
be dynamically loaded with the Fluent solver to enhance its standard features. Note that there is no
need to compile UDFs because the Cloud machines have compilers installed. However, you should
compile UDFs and test the routine locally before submitting to the Cloud. Your local directory should
contain the case file with UDF plugged in, the .c file, and a journal file.

To use a journal file when submitting a Fluent solve job to the Cloud:

1. Open a command window in the directory that contains the Fluent case file and journal file. In the
example above, the directory would contain t_junc.cas.gz and t_junction.jou.

2. Issue the Ansys Cloud CLI runFluent (p. 181) command and include the --jou option in the command
line entry.

For example:
>ansyscloudcli runfluent -j t_junction --jou t_junction.jou
-q Flexible_eastus_Standard_HB60rs_2022R1 -n 2 -m 32

This command line entry specifies that you want to run a job named 't_junction' and execute the
journal file t_junction.jou using the HPC queue Flexible_EastUS_Stand-
ard_HB60rs_2022R1.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 153
Using the Command Line to Solve in the Cloud

For detailed examples and How-To information, visit the Ansys Cloud Forum at https://cloudforum.an-
sys.com.

For detailed information about all available CLI commands and options, see the Cloud CLI Command
Reference (p. 156).

Monitoring a Job Submitted from the Command Line

When you submit a job to the Cloud via the command line, you can sign in to the Cloud portal at https://
cloud.ansys.com to monitor the job's progress, stop or share the job, or postprocess the results:

See Also: Ansys Cloud Portal (p. 17)

Viewing Available Commands

Before submitting a solve job to the Cloud via the command line, you may want to familiarize yourself
with the available job submission commands and arguments.

To view a list of available commands, open a command window and cd to the directory containing
the job input file. At the prompt, type ansyscloudcli -h:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
154 and its subsidiaries and affiliates.
 Viewing Available Commands

To view information about a command's available arguments, use ansyscloudcli [command] -h.

The following example shows help for the runFluent command:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 155
Using the Command Line to Solve in the Cloud

For more detailed information about commands and their options, see the Cloud CLI Command Refer-
ence (p. 156).

Cloud CLI Command Reference

This section provides detailed information about the commands that can be issued using the Ansys
Cloud Command Line Interface (AnsysCloudCLI.exe), including a description of each command's

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
156 and its subsidiaries and affiliates.
 Cloud CLI Command Reference

arguments and options. To view a quick list of commands from the command line, or a quick list of
options for a given command, see Viewing Available Commands (p. 154).

Note:

• The CLI help listing (ansyscloudcli -h) includes some commands that are not intended
for general use. Also, some command options are not supported at this time. Such com-
mands and options are not covered in this command reference.

• When specifying a value for an option which contains spaces or special characters, you
must enclose the value in quotation marks. Examples include file names, paths, and queue
names.

Commands:
agent
check-install
deleteJob
download
getLSTCVersions
getOutputs
getQueues
getUserProfile
interrupt
jobInfo
jobState
login
logout
monitor
openPortal
runAedt
runCFX
runFluent
runLSDyna
runMAPDL
runSCANeR
runSPEOSHPC
shareJob
upload
uploadCustomLSDyna

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 157
Using the Command Line to Solve in the Cloud

agent
Use the agent command and available options to start or stop the File Transfer Agent. This utility is
installed when you install the Ansys Cloud Suite. It is responsible for transferring files between your
local machine and the Cloud. Normally, the File Transfer Agent starts automatically when a job is
submitted. However, there may be a time when it stops running, and must be restarted.

Usage
agent [options]

Options
Option Description Sample Usage
-s| --stop Stops the File Transfer Agent. agent -s
--start Starts the File Transfer Agent when it has not been started agent --start
yet.
--restart Restarts the File Transfer Agent when it has stopped agent --restart
running.
--setenvironment Sets the ANSYSCloudCLI_ROOT environment variable. agent --setenvir-
This is only needed when you have installed the Cloud onment
Suite manually (from the zipped installation package)
instead of using the *.exe installer.
--no-ui Disables the File Transfer Agent interface, effectively agent --no-ui
disabling the ability to browse for files from the Cloud
portal. When this option is used, files can only be uploaded
from or downloaded to your local machine using the
Command Line Interface (CLI).
--ui If the File Transfer Agent interface has been disabled, this agent --ui
re-enables it.
-? | -h | --help Get information about the command, such as available agent -h
options.

Sample Output
>ansyscloudcli agent --start
ANSYS Cloud CLI
----------------------------------------

Version 21.2.2112.41
[2022-01-05 12:41:50Z] - Connected to the server address https://cloud-api.ansys.com/Agent/.
Start process.
ANSYS Cloud agent has been started.

Related Topics

Checking the File Transfer Agent Status (p. 80)

Starting the File Transfer Agent (p. 82)

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
158 and its subsidiaries and affiliates.
 Cloud CLI Command Reference

check-install
Use the check-install command to launch the Check Cloud Installation utility. This utility verifies
that Ansys Cloud is properly installed on your computer, that you have the latest updates, that you
are connecting to the Cloud successfully, and that you are able to transfer files and submit jobs. For
more information about the checks performed and the resulting report, see Checking Your Ansys
Cloud Installation (p. 9).

Usage
check-install

Options
Option Description Sample Usage
-s | --silent Runs the Check Cloud Installation utility in silent mode (no check-install
interface displayed). -s
-? | -h | Get information about the command, such as available options. check-install
--help -h

Sample Output
>ansyscloudcli check-install -s
ANSYS Cloud CLI
----------------------------------------

Version 21.2.2112.41
ANSYS Cloud Installation Report - 1/5/2022 5:42:53 PM
===========================================================
1 - Host machine details
===========================================================
Connected with computer MYDOMAIN/jsmith@HQJSMITH3
OS version: Microsoft Windows 10.0.19042
Processor count: 4
Is 64 bit process: True

===========================================================
2 - List ANSYS Installation(s)
===========================================================
List of ANSYS version(s) installed:2020 R1, 2020 R2, 2021 R1, 2021 R2, 2022 R1.

===========================================================
3 - ANSYS Cloud ACT installation check
===========================================================
Wbex extraction check:
ANSYS Cloud ACT installed for version 2020 R1: OK.
ANSYS Cloud ACT installed for version 2020 R2: OK.
ANSYS Cloud ACT installed for version 2021 R1: OK.
ANSYS Cloud ACT installed for version 2021 R2: OK.
ANSYS Cloud ACT installed for version 2022 R1: OK.

===========================================================
4 - ANSYS Cloud environment variable check
===========================================================
Path
ANSYSCloudCLI has been added to the PATH environement variable: OK.
ANSYSCloudCLI_ROOT
ANSYSCloudCLI_ROOT, is set to C:\Program Files\ANSYS Inc\ANSYS Cloud\ANSYS Cloud CLI: OK.

===========================================================

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 159
Using the Command Line to Solve in the Cloud

5 - Starting the Client...

===========================================================
HttpFactoryService is Adding the Default Client.
Client started: OK.
Currently connected to the following endpoints:
Identity: https://a365dev.b2clogin.com/tfp/ca4ff45a-2733-40d5-a4b2-3c0f308bac91/B2C_1A_AnsysId_signup_signin/
oauth2/v2.0/authorize
Apps: https://cloud-api.ansys.com/Application/
Monitoring: https://cloud-api.ansys.com/Monitoring/
Resource: https://cloud-api.ansys.com/Resource/

===========================================================
6 - ANSYS Account connection check
===========================================================
Signing in to your ANSYS Account...
Silent mode enabled. Trying to renew token silently
Connection successful: OK.

===========================================================
7 - Checking installation version
===========================================================
The installed version CLI 21.2.2111.20 is not up-to-date
Version 21.2.2112.41 is available.
===========================================================
8 - File Transfer Agent check
===========================================================
Trying to start the file transfer agent.
The agent is started with Process Id: 16712: OK.
Agent registered to the server: OK.

===========================================================
9 - Check queues configuration
===========================================================
596 queue(s) were found: OK.

===========================================================
10 - Check Elastic Licensing configuration
===========================================================
Elastic Licensing PIN has been configured.: OK.

===========================================================
11 - Job submission check
===========================================================
Try to submit a job
A new session initiated with id 61d5d90ac22dd36d568ff948: OK.
Starting the session
The session has started: OK.

===========================================================
12 - Session Monitoring check
===========================================================
[2022-01-05 17:44:43Z] Starting Job:

[2022-01-05 17:44:44Z] Project: Project D (02406941-4545-436f-a056-d47772680224)

[2022-01-05 17:44:46Z] Assigning task to file transfer agent MYDOMAIN/jsmith@HQJSMITH3.
[2022-01-05 17:44:46Z] Waiting for agent to take the task...
[2022-01-05 17:43:21Z] File transfer start (agentUpload:61d5d90cd169a79f52cecacc:agentUploadWF).
[2022-01-05 17:43:23Z] Transferring data from local machine to cloud storage...
[2022-01-05 17:43:26Z] Upload complete.
Data transferred 22 B.
Data transfer rate 0 MB/s.
[2022-01-05 17:43:27Z] Agent MYDOMAIN/jsmith@HQJSMITH3 has completed the task agentUpload:
61d5d90cd169a79f52cecacc:agentUploadWF.
[2022-01-05 17:44:59Z] Assigning task to file transfer agent MYDOMAIN/jsmith@HQJSMITH3.
[2022-01-05 17:44:59Z] Waiting for agent to take the task...
[2022-01-05 17:43:32Z] File transfer start (agentDownload:61d5d90dd169a79f52cecacf:agentDownloadWF).
[2022-01-05 17:43:33Z] Transferring data from cloud storage to local machine...
[2022-01-05 17:43:35Z] Download complete.
Data transferred 32 B.
Data transfer rate 0 MB/s.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
160 and its subsidiaries and affiliates.
 Cloud CLI Command Reference

[2022-01-05 17:43:37Z] Agent MYDOMAIN/jsmith@HQJSMITH3 has completed the task agentDownload:

61d5d90dd169a79f52cecacf:agentDownloadWF.
Session Monitoring successfull: OK.
The session completed successfully: OK.

Check decryption:
File decryption successful: OK.

===========================================================
13 - Finalizing
===========================================================
Cleaning temporary directory

Deleting the test session

Session sucessfully deleted: OK.

Installation report visible at

C:\Users\jsmith\AppData\Local\Ansys\Cloud\Installation report.html

deleteJob
Use the deleteJob command to delete a completed job from the job monitor in the Ansys Cloud
portal. When you delete a job, all data associated with the job is deleted as well. This frees up Cloud
data storage space.

Either the job name or job ID is required to execute this command.

Usage
deleteJob [options]

Options
Option Description Sample Usage
-j | --job Specifies the name of the job to delete. deleteJob -j "Fluent
<name> Elbow"
-i | --id <jobId> Specifies the ID of the job to delete. You can deleteJob -i
obtain the job ID in the Cloud portal by clicking 5c61af77309b7e08986632ef
the job in the Jobs dashboard widget or going
to the Jobs page.
--verbose Returns verbose error messages, which may be deleteJob --verbose
helpful when troubleshooting issues.
-? | -h | --help Get information about the command, such as deleteJob -h
available options.

Sample Output
>ansyscloudcli deleteJob -j "Fluent Elbow"
ANSYS Cloud CLI
----------------------------------------

Version 21.2.2112.41

Job successfully deleted

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 161
Using the Command Line to Solve in the Cloud

When the command has been executed, the job will no longer appear in the Cloud portal job monitor.

See Also: Deleting a Job (p. 93)

download
Use the download command to download files from Cloud storage to your local machine.

Usage
download [options]

Options
Option Description Sample Usage
-i | --id <jobId> To retrieve files associated with a job, use this -i
option to specify the ID of the job. You can 5c61af77309b7e08986632ef
obtain the job ID in the Cloud portal by clicking
the job in the Jobs dashboard widget or going
to the Jobs page.
-r | -region Specifies the data center region where the files -r eastus
<region> are stored:

• centralindia

• eastus

• japaneast

• northcentralus

• northeurope

• southcentralus

• westeurope

• westus

--folder <folder> Specifies the Cloud storage folder from which --folder "Fluent Elbow"
you want to retrieve files.
-t | (Optional) Specifies the target folder for the -t "D:\Projects"
--target-folder downloaded files. If no value is specified, the
<folder> current folder is used.
-f | --filter Filters the files to be retrieved. By default, all -f "*.dat;*.txt"
<filter> the files in the specified folder are sent.
Wildcards can be used, and multiple filters can
be specified by separating them with a
semi-colon (;).

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
162 and its subsidiaries and affiliates.
 Cloud CLI Command Reference

--regex-filter Filters the files retrieved using a regular --regex-filter

<filter> expression as search criteria. ".*[.]txt;.*[.]png"
--files <fileList> List of files to download, separated by a --files "elbow.cas;el-
semi-colon (;) bow.dat"
--verbose Returns verbose error messages, which may be --verbose
helpful when troubleshooting issues.
-? | -h | --help Get information about the command, such as download -h
available options.

Sample Output
>ansyscloudcli download -r eastus --folder "Fluent Elbow" --files "elbow.cas;elbow.dat"
ANSYS Cloud CLI
----------------------------------------

Version 21.2.2112.41

55.5 % done (1.77 MB /3.19 MB, 0.57 MB/s)

Fluent Elbow/elbow.cas
100 % done (3.19 MB /3.19 MB, 0.63 MB/s)
Fluent Elbow/elbow.dat
3.19 MB.
0.63 MB/s.
2 files downloaded.
0 files skipped.
Download complete.
Data transferred 3.19 MB.
Data transfer rate 0.63 MB/s.

getLSTCVersions
If you want to run LSTC installations of LS-DYNA when submitting LS-DYNA jobs, you can use the
getLSTCVersions command to see a list of LS-DYNA versions available in the Cloud.

Usage
getLSTCVersions [options]

Options
Option Description Sample Usage
-? | -h | Get information about the command, such as available options. getLSTCVersions
--help -h

Sample Output
>ansyscloudcli getlstcversions
ANSYS Cloud CLI
----------------------------------------

Version 21.2.2112.41
9.3.1; 10.0.0; 10.1.0; 10.2.0; 11.0.0; 11.1.0; 11.2.0; 12.0.0

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 163
Using the Command Line to Solve in the Cloud

getOutputs
Use the getOutputs command to download a job's output files to your local machine.

Either the job name or job ID is required to execute this command.

Usage
getOutputs [options]

Options
Option Description Sample Usage
-j | --job <name> Specifies the name of the job from which you getOutputs -j "Fluent
want to retrieve outputs. Elbow"
-i | --id <jobId> Specifies the ID of the job from which you want getOutputs -i
to retrieve outputs. You can obtain the job ID 5c61af77309b7e08986632ef
in the Cloud portal by clicking the job in the
Jobs dashboard widget or going to the Jobs
page.
-f | --filter Filters the files to be retrieved. By default, all getOutputs -j "Fluent
<filter> the files of the output folder are sent. Wildcards Elbow" -f "*.dat;*.txt"
can be used, and multiple filters can be
specified by separating them with a semi-colon
(;).
--regex-filter Filters the files retrieved using a regular --regex-filter
<filter> expression as search criteria. ".*[.]txt;.*[.]png"
--files <fileList> List of files to download, separated by a getOutputs -j "Fluent
semi-colon (;) Elbow" --files file.rst
--verbose Returns verbose error messages, which may be getOutputs --verbose
helpful when troubleshooting issues.
-? | -h | --help Get information about the command, such as getOutputs -h
available options.

Sample Output
>ansyscloudcli getOutputs -i 5c658dc9fc644212ac8d2235
ANSYS Cloud CLI
----------------------------------------

Version 21.2.2112.41

output/file.DSP
output/file.cnd
11.2 % done (3.01 MB /26.86 MB, 0.63 MB/s)
22.4 % done (6.01 MB /26.86 MB, 0.78 MB/s)
33.5 % done (9.01 MB /26.86 MB, 0.77 MB/s)
44.7 % done (12.01 MB /26.86 MB, 0.83 MB/s)
55.9 % done (15.01 MB /26.86 MB, 1.03 MB/s)
67 % done (18.01 MB /26.86 MB, 1.11 MB/s)
78.2 % done (21.01 MB /26.86 MB, 1.18 MB/s)
89.4 % done (24.01 MB /26.86 MB, 1.27 MB/s)
output/file.rst

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
164 and its subsidiaries and affiliates.
 Cloud CLI Command Reference

99.9 % done (26.82 MB /26.86 MB, 1.42 MB/s)

output/file0.err
output/solve.out
output/stderr.txt
output/stdout.txt
26.86 MB.
1.37 MB/s.
7 files downloaded.
0 files skipped.

The destination of the downloaded files depends on whether the job is a Fluent job or Mechanical
job. When downloading MAPDL results, note that a new folder named output is created in the path.

Related Topics

Downloading Ansys Fluent Results from the Cloud (p. 134)

Downloading Ansys Mechanical Results from the Cloud (p. 135)

getQueues
Use the getQueues command to get a list of available queues for a selected product, version, or region.
This helps you identify the name of the queue to which you want to submit a job.

Each queue represents a specific data center region, solver, and solver version. Queue names prefixed
with Small, Medium, Large, XLarge, or XXLarge have preset hardware configurations, while those
prefixed with 'Flexible' provide the flexibility to specify the number of nodes and maximum number
of cores to be used for the job.

Usage
getQueues [options]

Options
Option Description Sample Usage
-? | -h | --help Get information about the command, such as getQueues -h
available options.
--rsm Used by RSM to get queues in a specific format. getQueues --rsm
-p | --product Displays a list of queues for a specific product: getQueues -p Flu-
<product> ent
• Fluent

• MAPDL

-v | --version Displays a list of queues for a specific Ansys version: getQueues -v

<version> 2022R1
• 2019R2

• 2019R3

• 2020R1

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 165
Using the Command Line to Solve in the Cloud

• 2020R2

• 2021R1

• 2021R2

• 2022R1

-r | --region Displays a list of queues for a specific data region: getQueues -r

<region> eastus
• centralindia

• eastus

• japaneast

• northcentralus

• northeurope

• southcentralus

• westeurope

• westus

--details Displays a list of queues with details about each getQueues --de-
queue: Display Name, Description, Cores, Nodes, tails
Region, Product(s), and VM Size. See Sample
Output:Detailed Queue List (p. 167) below.
--verbose Returns verbose error messages, which may be helpful getQueues --verb-
when troubleshooting issues. ose

Sample Output: List of Queues with Version 2022 R1 Applications in Eastern US

Region
>ansyscloudcli getQueues -v 2022R1 -r eastus
ANSYS Cloud CLI
----------------------------------------

Version 21.2.2112.41
List of queues:
Flexible_eastus_Standard_HB60rs_2022R1
Flexible_eastus_Standard_HC44rs_2022R1
Flexible_eastus_Standard_HB120rs_v3_2022R1
SmallHBv3_EastUS_Speos_2022R1
MediumHBv3_EastUS_Speos_2022R1
LargeHBv3_EastUS_Speos_2022R1
XLargeHBv3_EastUS_Speos_2022R1
SmallHC_EastUS_Speos_2022R1
MediumHC_EastUS_Speos_2022R1
LargeHC_EastUS_Speos_2022R1
XLargeHC_EastUS_Speos_2022R1
XXLargeHC_EastUS_Speos_2022R1
SmallHB_eastus_RDP_2022R1
SmallHC_eastus_RDP_2022R1
Medium_eastus_RDP_2022R1
SmallHBv3_eastus_RDP_2022R1

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
166 and its subsidiaries and affiliates.
 Cloud CLI Command Reference

Small_eastus_RDP_2022R1
Large_eastus_RDP_2022R1
XLarge_eastus_RDP_2022R1
Flexible_eastus_Standard_HB120rs_v2_2022R1
Flexible_eastus_Standard_HB120_96rs_v3_2022R1
Flexible_eastus_Standard_HB120_64rs_v3_2022R1
Flexible_eastus_Standard_HB120_32rs_v3_2022R1

Sample Output:Detailed Queue List

(partial list shown)
>ansyscloudcli getqueues --details
ANSYS Cloud CLI
----------------------------------------
Version 21.2.2112.41
List of queues:
Small_EastUS_AEDT_2019R2
DisplayName: Small
Description: 8 cores, 1 node, 1.4 AEUs/hr
Cores: 8
Nodes: 1
Region: eastus
Product(s): AEDT 194
VMSize:
Name: Standard_H16r
Memory: 112 GB
Storage: 2000 GB
HasRdma: True
Medium_EastUS_AEDT_2019R2
DisplayName: Medium
Description: 16 cores, 1 node, 1.4 AEUs/hr
Cores: 16
Nodes: 1
Region: eastus
Product(s): AEDT 194
VMSize:
Name: Standard_H16mr
Memory: 224 GB
Storage: 2000 GB
HasRdma: True
Large_EastUS_AEDT_2019R2
DisplayName: Large
Description: 32 cores, 2 nodes, 2.8 AEUs/hr
Cores: 32
Nodes: 2
Region: eastus
Product(s): AEDT 194
VMSize:
Name: Standard_H16mr
Memory: 224 GB
Storage: 2000 GB
HasRdma: True

getUserProfile
Use the getUserProfile command to display the username (email address), owner ID, and resource
usage of the user submitting a job.

Usage
getUserProfile [options]

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 167
Using the Command Line to Solve in the Cloud

Options
Option Description Sample Usage
-? | -h | Get information about the command, such as available options. getUserProfile
--help -h

Sample Output
>ansyscloudcli getUserProfile

Version 21.2.2112.41
User Profile:
[email protected]

aa3c53e2-87ea-4184-b873-c843e6e083c3

Resource Usage
Available AECs: 4732594.1
Storage Used: 771.22 MB of 1 TB
Concurrent Jobs: 0 / 5

interrupt
Use the interrupt command to stop a running job at the end of the current iteration and save the
results at that point. Adding the --hard option kills the job without saving any output.

Either the job name or job ID is required to execute this command.

Usage
interrupt [options]

Options
Option Description Sample Usage
-? | -h | Get information about the command, such as available interrupt -h
--help options.
-i <jobId> Specifies the ID of the job to interrupt. You can obtain interrupt -i
the job ID in the Cloud portal by clicking the job in 5c63102d309b7e089873868a
the Jobs dashboard widget or going to the Jobs
page.
--hard Kills the job without saving results. interrupt -i
5c63102d309b7e089873868a
--hard
--verbose Returns verbose error messages, which may be helpful interrupt --verbose
when troubleshooting issues.

Sample Output
>ansyscloudcli interrupt -i 5c63102d309b7e089873868a --hard
ANSYS Cloud CLI
----------------------------------------

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
168 and its subsidiaries and affiliates.
 Cloud CLI Command Reference

Version 21.2.2112.41
Job successfully interrupted

When the command has been successfully executed, the job state changes to either Aborted, Com-
pleted, or Failed depending on the job type and option specified. Also, an email notification is sent
to the job submitter.

See Also: Stopping a Batch Job (p. 47)

jobInfo
Use the jobInfo command to display information about a submitted job, such as the start time, current
state, and owner ID.

Either the job name or job ID is required to execute this command.

Usage
jobInfo [options]

Options
Option Description Sample Usage
-j | --job Specifies the name of the job for which you want jobInfo -j "Fluent El-
<name> to display information. bow"
-i | --id <jobId> Specifies the ID of the job for which you want to jobInfo -i
display information. You can obtain the job ID in 5c61af77309b7e08986632ef
the Cloud portal by clicking the job in the Jobs
dashboard widget or going to the Jobs page.
--verbose Returns verbose error messages, which may be jobInfo -j "Fluent El-
helpful when troubleshooting issues. bow" --verbose
-? | -h | --help Get information about the command, such as jobInfo -h
available options.

Sample Output
>ansyscloudcli jobInfo -j "Fluent Elbow"
ANSYS Cloud CLI
----------------------------------------

Version 21.2.2112.41

FluentElbow - 61d6fc268c1ea29c1d91158a
CreationTime: 1/6/2022 2:26:46 PM
StartedTime: 1/6/2022 2:26:46 PM
Submitter: CLI 21.2.2112.41
Region: eastus
State: Completed
Owner: e88310cf-fc37-4d44-b838-1bc7013c9a91
Current: 0.4 AEC

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 169
Using the Command Line to Solve in the Cloud

If using the -j <Name> option, and there is more than one job with the same name, only a list of
jobs and their IDs is displayed in the output. In this case you must determine the ID of the job for
which you want to display information and use the -i option when issuing the jobInfo command.

jobState
Use the jobState command to display the current state of a submitted job. Possible job states are
Running, Aborted, Failed, and Completed.

Either the job name or job ID is required to execute this command.

Usage
jobState [options]

Options
Option Description Sample Usage
-j | --job Specifies the name of the job for which you want jobState -j "Fluent
<name> to display the job state. Elbow"
-i | --id <jobId> Specifies the ID of the job for which you want to jobState -i
display the job state. You can obtain the job ID 5c61af77309b7e08986632ef
in the Cloud portal by clicking the job in the Jobs
dashboard widget or going to the Jobs page.
--verbose Returns verbose error messages, which may be jobState -j "Fluent
helpful when troubleshooting issues. Elbow" --verbose
-? | -h | --help Get information about the command, such as jobState -h
available options.

Sample Output
>ansyscloudcli jobState -j "Fluent Elbow"
ANSYS Cloud CLI
----------------------------------------

Version 21.2.2112.41

State: Failed

If using the -j <Name> option, and there is more than one job with the same name, only a list of
jobs and their IDs is displayed in the output. In this case you must determine the ID of the job for
which you want to display the state and use the -i <jobId> option when issuing the jobInfo command.

See Also: Monitoring Jobs (p. 83)

login
Use the login command to sign in to your Ansys Account.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
170 and its subsidiaries and affiliates.
 Cloud CLI Command Reference

Usage
login

Options
Option Description Sample Usage
-p | -password Specifies your Ansys Account password needed for login -p mypass-
<password> sign-in. word
--verbose Returns verbose error messages, which may be login --verbose
helpful when troubleshooting issues.
--token Saves a token so that you will be signed in login --token
automatically when subsequent commands that
require sign-in are executed.
-? | -h | --help Get information about the command, such as login -h
available options.

Sample Output
>ansyscloudcli login
ANSYS Cloud CLI
----------------------------------------

Version 21.1.2107.3

Identity: https://ANSYSAccount.b2clogin.com/tfp/f9894f76-4216-4cdb-94c6-125c4941e1e6/
B2C_1A_AnsysId_signup_signin/oauth2/v2.0/authorizeApps: https://cloud-api.ansys.com/Application/
Monitoring: https://cloud-api.ansys.com/Monitoring/
Resource: https://cloud-api.ansys.com/Resource/

Unable to set the token, please login again.

Connection successful.
Remote version: 21.1.2107.3

logout
Use the logout command to sign out of your Ansys Account. This command has no required arguments
or options.

Usage
logout

Options
Option Description Sample
Usage
-? | -h | Get information about the command, such as available options. logout -h
--help

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 171
Using the Command Line to Solve in the Cloud

Sample Output
>ansyscloudcli logout
ANSYS Cloud CLI
----------------------------------------

Version 21.1.2107.3

Signed out.

monitor
Use the monitor command to display a transcript, event log, debug log, or analytics for a submitted
job.

This corresponds to the information that you can view on the monitoring tabs in a job view.

Either the job name or job ID and is required to execute this command. If no task option is specified,
the job transcript will be displayed by default.

Usage
monitor [options]

Options
Option Description Sample Usage
-j | --job Specifies the name of the job for which you want monitor -j "Fluent El-
<name> to display monitoring information. bow"
-i | --id Specifies the ID of the job for which you want monitor -i
<sessionId> to display monitoring information. You can 5c61af77309b7e08986632ef
obtain the job ID in the Cloud portal by clicking
the job in the Jobs dashboard widget or going
to the Jobs page.
-t | --task Specifies the monitoring thread to display: monitor -j "Fluent El-
<taskName> bow" -t Analytics
• MainTranscript: Application inputs, job
transactions, uploads/downloads,
resource pool creation, solver output

• WorkflowEventOrState: Server
operations and system processes

• Debug: Server operations and system

operations with error messaging and
additional details

• HPCCommands: HPC commands issued

during a job run

• Analytics: Upload and download speeds,

and length of time taken by the Cloud to

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
172 and its subsidiaries and affiliates.
 Cloud CLI Command Reference

perform tasks such as pool creation and

solver execution

-l | --last Specifies that you want to display the latest To retrieve the last 10 lines
<numberOfLines> messages only, with the number of messages to of the job transcript:
display.
monitor -j "Fluent
Elbow" -t MainTran-
script --last 10
-n | --next Used in conjunction with the position option To retrieve the next 20 lines
<numberOfLines> to specify the number of messages to display from the last position:
from the specified position.
monitor -j "Fluent
Elbow" -t MainTran-
script -p 368 --
next 20
-p | --position Displays the thread starting at a specific position To retrieve 20 lines from
<id> in the thread. Position is dependent on the the top of the job
background storage and is not necessarily the transcript:
message number or line number.
monitor -j "Fluent
Elbow" -t MainTran-
script -p 0 --next
20

The last position is printed

at the end of the previous
command output.
-? | -h | --help Get information about the command, such as monitor -h
available options.

Sample Output
>ansyscloudcli monitor -j "Fluent Elbow" -t Analytics
ANSYS Cloud CLI
----------------------------------------

Version 21.2.2112.41

UploadFromDesktop: 0.48 MB/s

UploadFromDesktop: 24.712 s

HealthCheckMaximumLatency: 0.65 (us)

HealthCheckMinimumBandwidth: 8071.48 (MB/s)

PoolAllocateTime: 57.1595383 s

PoolCreationTime: 163.0908578 s

DownloadToComputeNode: 3.48 MB/s

DownloadToComputeNode: 3.376 s

SolverTime: 64.718 s

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 173
Using the Command Line to Solve in the Cloud

Batch running time: 132.654898 s

Hardware usage time: 132.654898 s

DownloadToDesktop: 0.46 MB/s

DownloadToDesktop: 8.58 s

Related Topics

Viewing a Job Transcript (p. 95)

Event Log (p. 213)
Debug Log (p. 215)
HPC Commands Log (p. 219)
Speed Analytics (p. 211)

openPortal
Use the openPortal command to open the Ansys Cloud portal. This command has no required argu-
ments or options.

Usage
openPortal

Options
Option Description Sample Usage
--verbose Returns verbose error messages, which may be helpful openPortal --verb-
when troubleshooting issues. ose
-? | -h | Get information about the command, such as available logout -h
--help options.

runAedt
Use the runAedt command to submit an Ansys Electronics Desktop solve job to the Cloud.

Usage
runAedt [options]

Options
Option Description Sample Usage
-j | --job <name> Specifies a name for the job. The specified name will -j "Optim Tee"
be used to identify the job in the job monitor in the
Cloud portal.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
174 and its subsidiaries and affiliates.
 Cloud CLI Command Reference

-p | --project Specifies that you want to use credits from the -p "Project A"
<projectId> budget of a project. To be able to use a project's
budget, you must be a member of the project. or
For more information, see Project
Budgeting (p. 249). -p "02406941-
4545-436f-
The value can be the project name or its ID. If no a056-
value is specified, the project set as the d47772680224"
default (p. 256) is used.

For instructions on obtaining a project name or

ID, see How a Project Budget is Used (p. 254).
-i | --input The name of the input file to be submitted for the -i "OptimTee.aedt"
<input> solve.
-q | --queue The name of the queue to which the job will be -q "Flexible_east-
<queue> submitted. Each queue represents a specific data us_Stand-
center region and solver version. Queue names ard_HC44rs_2022R1"
prefixed with Small, Medium, Large, XLarge, or XXLarge
have preset hardware configurations, while those
prefixed with 'Flexible' are associated with a specific
machine type and provide the flexibility to specify the
number of nodes (-n) and maximum number of cores
(-m) to be used for the job. You can use the
getQueues (p. 165) command to view a list of available
queues.
-n | --nodes When using a 'Flexible' queue, the number of nodes -n "2"
<nodes> to be allocated for the job. Choose a value that will
accommodate the job parameters and requirements.
-m | -max The maximum number of CPU cores to be used by the -m "32"
<coresCount> machine. You should use at least half of the maximum
available cores. The number of cores must be a
multiple of the number of nodes.
-f | --filter Filters the files sent to VMs for the solve. By default, -f "*.dat;*.txt"
<filter> all files in the current folder are sent. Wildcards can
be used, and multiple filters can be specified by
separating them with a semi-colon (;).
--regex-filter Filters the files sent for the solve using a regular --regex-filter
<filter> expression as search criteria. ".*[.]txt;.*[.]png"
--files <fileList> List of files sent for the solve, separated by a --files
semi-colon (;) "file.hfss"
-w | --wait Wait until the job is completed. Use this option if you -w
want to see a live job transcript in the command
window upon job submission.

Note that if you do not include the --wait option,

you can still see the job transcript updating in
the Cloud portal if you choose to monitor the job
there.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 175
Using the Command Line to Solve in the Cloud

-d | --download Download results to a specified folder. -d "D:\Simulation

<path> Files\Electron-
ics\output"
-v | --version Specifies the version of solver to use: -v 2022R1
<version>
• 2019R2

• 2019R3

• 2020R1

• 2020R2

• 2021R1

• 2021R2

• 2022R1

You do not need to specify this option unless the

selected queue supports multiple solver versions.
--verbose Returns verbose error messages, which may be helpful runAedt --verbose
when troubleshooting issues.
-t | --time-limit The maximum duration of the session in hours. When -t "8"
<time-limit> the time limit is reached, the session is interrupted.
You can edit the time limit (p. 45) in the Cloud portal
after the job has started running.
--upload-frequency If this option is specified, new and modified files --upload-frequency
<value> written by the solver to the virtual machine's "30"
temporary storage folder will be automatically
uploaded to Cloud storage at the specified
frequency while the job is running. Specify the
value in minutes.

Note that even if this option is not specified, you

can upload files on demand using the Transfer
Files (p. 74) action in the Cloud portal. Files that
are not transferred during the job run will be
automatically transferred to Cloud storage when
the job completes.
--gz Use when transferring a small number of large files. --gz
Ideal for low-bandwidth connections. Files are
individually compressed to reduce their size and speed
up transfer to the Cloud. Output files will also be
compressed. Reduces data and transfer charges, and
lets you see the folder structure in the Cloud file
explorer. Performance may be poor if used to transfer
a large number of files.
--tar Use when transferring a large number of files. Files --tar
are compressed into a single archive file for a smaller,

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
176 and its subsidiaries and affiliates.
 Cloud CLI Command Reference

faster transfer to the Cloud. Output files will also be

compressed. Reduces data transfer and storage
charges. Note that the folder structure will not be
visible in the Cloud file explorer. You will not be able
to select specific files to download. Also, the View
Results action cannot be used for quick postprocessing
in the Cloud portal.
-? | -h | --help Get information about the command, such as available runAedt -h
options.

Sample Output (Partial)

>ansyscloudcli runaedt -j "OptimTee" -i "OptimTee.aedt" -q "Flexible_EastUS_Standard_HC44rs_2022R1" -w
-d "D:\Simulation Files\AEDT\output
ANSYS Cloud CLI
----------------------------------------

Version 21.2.2112.41

Session started with ID: 61d5fbb68c1ea29c1d8421ef. Session available at:

https://cloud.ansys.com/sessions/61d5fbb68c1ea29c1d8421ef
[2022-01-05 20:12:40Z] Starting Job:
Input file: OptimTee.aedt
Queue: Flexible_eastus_Standard_HC44rs_2022R1
Number of nodes: 1
Number of cores: 44
Input folder: D:\Simulation Files\AEDT
Exhaustive list of files to upload:
Download results after completion: True

[2022-01-05 20:12:41Z] Project: Project D (02406941-4545-436f-a056-d47772680224)

[2022-01-05 20:12:44Z] Assigning task to file transfer agent MYDOMAIN/jsmith@HQJSMITH3.
[2022-01-05 20:12:44Z] Waiting for agent to take the task...
[2022-01-05 20:11:22Z] File transfer start (agentUpload:61d5fbba523528807e763603:agentUploadWF).
[2022-01-05 20:11:24Z] Transferring data from local machine to cloud storage...
[2022-01-05 20:11:28Z] Upload complete.
Data transferred 639.95 KB.
Data transfer rate 0.24 MB/s.
[2022-01-05 20:11:29Z] Agent MYDOMAIN/jsmith@HQJSMITH3 has completed the task agentUpload:
61d5fbba523528807e763603:agentUploadWF.
[2022-01-05 20:13:06Z] Starting compute resources... (this may take a few minutes)
[2022-01-05 20:30:04Z] Transferring data from cloud storage to compute resource...
[2022-01-05 20:30:07Z] Download complete.
Data transferred 639.98 KB.
Data transfer rate 0.96 MB/s.
[01/05/2022 20:30:08] Expanded Executable: sh
[01/05/2022 20:30:08] Expanded Arguments: -c "ipList=10.0.1.4 ; ipaddrs=($(echo ${ipList} | tr ';' '
')); for ip in ${ipaddrs[@]}; do s=$ip* ; if [[ 10.0.1.4:6000 != $s ]]; then echo 'Node '$ip; ssh -tt $ip
echo 'export ANSYSLMD_LICENSE_FILE='$ANSYSLMD_LICENSE_FILE >> /home/_azbatch/.bashrc ; ssh -tt $ip
sudo /ansys_inc/AnsysEM/rsm/Linux64/ansoftrsmservice restart ; fi; done"
[01/05/2022 20:30:08] Expanded Redirect File:
[01/05/2022 20:30:08] Expanded Working Directory: /mnt/resource/batch/tasks/workitems/
acc21_2_2201_12-61d5fbba523528807e763606/job-1/wfexec/wd
[01/05/2022 20:30:08] Running process: sh -c "ipList=10.0.1.4 ; ipaddrs=($(echo ${ipList} | tr ';' '
')); for ip in ${ipaddrs[@]}; do s=$ip* ; if [[ 10.0.1.4:6000 != $s ]]; then echo 'Node '$ip; ssh -tt $ip
echo 'export ANSYSLMD_LICENSE_FILE='$ANSYSLMD_LICENSE_FILE >> /home/_azbatch/.bashrc ; ssh -tt $ip
sudo /ansys_inc/AnsysEM/rsm/Linux64/ansoftrsmservice restart ; fi; done" in /mnt/resource/batch/tasks/
workitems/acc21_2_2201_12-61d5fbba523528807e763606/job-1/wfexec/wd
[2022-01-05 20:30:08Z] Start AEDT solve
ANSYS Electromagnetics 22.1 Configuration
...

If you do not include the --wait option, the output will display the job session ID only:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 177
Using the Command Line to Solve in the Cloud

ANSYS Cloud CLI

----------------------------------------

Version 21.2.2112.41

Session started with ID: 5e8b70f0de5fe83b80e22a0a. Session available at:

https://cloud.ansys.com/sessions/5e8b70f0de5fe83b80e22a0a

For full monitoring capabilities you can sign in to the Cloud portal at https://cloud.ansys.com.

See Also: Submitting a Job to the Cloud from Ansys Electronics Desktop (p. 26)

runCFX
Use the runCFX command to submit an Ansys CFX solve job to the Cloud.

Usage
runCFX [options]

Options
Option Description Sample Usage
-j | --job <name> Specifies a name for the job. The specified -j "CFX Mixer"
name will be used to identify the job in the
job monitor in the Cloud portal.
-p | --project Specifies that you want to use credits from -p "Project A"
<projectId> the budget of a project. To be able to use
a project's budget, you must be a member or
of the project. For more information, see
Project Budgeting (p. 249). -p "02406941-
4545-436f-
The value can be the project name or its a056-
ID. If no value is specified, the project set d47772680224"
as the default (p. 256) is used.

For instructions on obtaining a project

name or ID, see How a Project Budget is
Used (p. 254).
-def <definition_file> The name of the CFX-Solver input file for a -def "StaticMix-
single configuration simulation (.def). er.def"
-mdef The name of the CFX-Solver input file for a -mdef "StaticMix-
<multiple_definition_file> multi-configuration or operating point er.mdef"
simulation (.mdef).
-cont-from-file <res_file> Continues the run from the one contained in -cont-from-file
an existing results file (.res). "StaticMix-
er_001.res"
-ini-file <ini_file> Uses the initial values from an existing results -ini-file "Static-
file (Initial Values File). Mixer_001.res"

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
178 and its subsidiaries and affiliates.
 Cloud CLI Command Reference

-ccl <ccl_file> Imports simulation settings from a CFX -ccl "StaticMix-

Command Language file (.ccl). er.ccl"
-double Use the double precision Ansys CFX solver. -double
-q | --queue <queue> The name of the queue to which the job will -q "Flexible_east-
be submitted. Each queue represents a specific us_Stand-
data center region and solver version. Queue ard_HB60rs_2022R1"
names prefixed with Small, Medium, Large,
XLarge, or XXLarge have preset hardware
configurations, while those prefixed with
'Flexible' are associated with a specific machine
type and provide the flexibility to specify the
number of nodes (-n) and maximum number
of cores (-m) to be used for the job. You can
use the getQueues (p. 165) command to view
a list of available queues.
-n | --nodes <nodes> When using a 'Flexible' queue, the number of -n "2"
nodes to be allocated for the job. Choose a
value that will accommodate the job
parameters and requirements.
-m | -max <coresCount> The maximum number of CPU cores to be used -m "32"
by the machine. You should use at least half
of the maximum available cores. The number
of cores must be a multiple of the number of
nodes.
-v | --version <version> Specifies the version of solver to use: -v 2022R1

• 2019R2

• 2019R3

• 2020R1

• 2020R2

• 2021R1

• 2021R2

• 2022R1

You do not need to specify this option

unless the selected queue supports
multiple solver versions.
-a | --arguments <input> Additional command line arguments for -a "-use-mesh-
the solver. from-iv"

Separate arguments with a space and

enclose them all with a set of double
quotation marks (" "). If you need to pass
an argument that contains quotation

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 179
Using the Command Line to Solve in the Cloud

marks, use \ as the escape character so

that the quotation mark is recognized as
part of the argument string.
-f | --filter <filter> Filters the files sent to VMs for the solve. By -f "*.res;*.txt"
default, all files in the current folder are sent.
Wildcards can be used, and multiple filters can
be specified by separating them with a
semi-colon (;).
--regex-filter <filter> Filters the files sent for the solve using a --regex-filter
regular expression as search criteria. ".*[.]txt;.*[.]png"
--files <fileList> List of files sent for the solve, separated by a --files "StaticMix-
semi-colon (;) er.def;StaticMix-
er.ccl"
-w | --wait Wait until the job is completed. Use this option -w
if you want to see a live job transcript in the
command window upon job submission.

Note that if you do not include the --wait

option, you can still see the job transcript
updating in the Cloud portal if you choose
to monitor the job there.
-d | --download <path> Download results to a specified folder. -d "D:\Simulation
Files\fluent-el-
bow\output"
--verbose Returns verbose error messages, which may --verbose
be helpful when troubleshooting issues.
-t | --time-limit The maximum duration of the session in hours. -t "8"
<time-limit> When the time limit is reached, the session is
interrupted. You can edit the time limit (p. 45)
in the Cloud portal after the job has started
running.
--upload-frequency If this option is specified, new and --upload-frequency
<value> modified files written by the solver to the "30"
virtual machine's temporary storage folder
will be automatically uploaded to Cloud
storage at the specified frequency while
the job is running. Specify the value in
minutes.

Note that even if this option is not

specified, you can upload files on demand
using the Transfer Files (p. 74) action in
the Cloud portal. Files that are not
transferred during the job run will be
automatically transferred to Cloud storage
when the job completes.
--gz Use when transferring a small number of --gz
large files. Ideal for low-bandwidth

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
180 and its subsidiaries and affiliates.
 Cloud CLI Command Reference

connections. Files are individually compressed

to reduce their size and speed up transfer to
the Cloud. Output files will also be compressed.
Reduces data and transfer charges, and lets
you see the folder structure in the Cloud file
explorer. Performance may be poor if used to
transfer a large number of files.
--tar Use when transferring a large number of files. --tar
Files are compressed into a single archive file
for a smaller, faster transfer to the Cloud.
Output files will also be compressed. Reduces
data transfer and storage charges. Note that
the folder structure will not be visible in the
Cloud file explorer. You will not be able to
select specific files to download. Also, the View
Results action cannot be used for quick
postprocessing in the Cloud portal.
-? | -h | --help Get information about the command, such as runCFX -h
available options.

Sample Output
ansyscloudcli runCFX -def perf_Airfoil_100M.def -j CFX_aircraft100M -a "-ccl run.ccl -part-large"
-n 8 -m 352 -v 2022R1 -q Flexible_eastus_Standard_HB60rs_2022R1
ANSYS Cloud CLI
----------------------------------------

Version 21.2.2112.41

Session started with ID: 61d6082c8c1ea29c1d84a0f1. Session available at:

https://cloud.ansys.com/sessions/61d6082c8c1ea29c1d84a0f1

For full monitoring capabilities you can sign in to the Cloud portal at https://cloud.ansys.com.

runFluent
Use the runFluent command to submit an Ansys Fluent solve job to the Cloud.

Usage
runFluent [options]

Options
Option Description Sample Usage
-j | --job <name> Specifies a name for the job. The specified name will -j "Fluent Elbow"
be used to identify the job in the job monitor in the
Cloud portal.
-p | --project Specifies that you want to use credits from the -p "Project A"
<projectId> budget of a project. To be able to use a project's
or

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 181
Using the Command Line to Solve in the Cloud

budget, you must be a member of the project. -p "02406941-

For more information, see Project 4545-436f-
Budgeting (p. 249). a056-
d47772680224"
The value can be the project name or its ID. If no
value is specified, the project set as the
default (p. 256) is used.

For instructions on obtaining a project name or

ID, see the How a Project Budget is Used (p. 254).
-i | --input The name of the input file to be submitted for the -i "elbow.cas"
<input> solve.
--jou <journal> The name of the journal file to execute. --jou "_read_flu-
ent_case.jou"
-q | --queue The name of the queue to which the job will be -q "Flexible_east-
<queue> submitted. Each queue represents a specific data us_Stand-
center region and solver version. Queue names ard_HB60rs_2022R1"
prefixed with Small, Medium, Large, XLarge, or XXLarge
have preset hardware configurations, while those
prefixed with 'Flexible' are associated with a specific
machine type and provide the flexibility to specify the
number of nodes (-n) and maximum number of cores
(-m) to be used for the job. You can use the
getQueues (p. 165) command to view a list of available
queues.
-n | --nodes When using a 'Flexible' queue, the number of nodes -n "2"
<nodes> to be allocated for the job. Choose a value that will
accommodate the job parameters and requirements.
-m | -max The maximum number of CPU cores to be used by the -m "32"
<coresCount> machine. You should use at least half of the maximum
available cores. The number of cores must be a
multiple of the number of nodes.
-f | --filter Filters the files sent to VMs for the solve. By default, -f "*.dat;*.txt"
<filter> all files in the current folder are sent. Wildcards can
be used, and multiple filters can be specified by
separating them with a semi-colon (;).
--regex-filter Filters the files sent for the solve using a regular --regex-filter
<filter> expression as search criteria. ".*[.]txt;.*[.]png"
--files <fileList> List of files sent for the solve, separated by a --files "el-
semi-colon (;) bow.cas;elbow.dat"
-w | --wait Wait until the job is completed. Use this option if you -w
want to see a live job transcript in the command
window upon job submission.

Note that if you do not include the --wait option,

you can still see the job transcript updating in
the Cloud portal if you choose to monitor the job
there.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
182 and its subsidiaries and affiliates.
 Cloud CLI Command Reference

-d | --download Download results to a specified folder. -d "D:\Simulation

<path> Files\fluent-el-
bow\output"
-2d Switch to the 2D, double-precision solver. -2d
-sp Use the single-precision version of Fluent. (The -sp
double-precision solver is used by default.)
-a | --arguments Additional command line arguments for the -a "-mpi=openmpi
<input> solver. -affinity=off -
mpiopt=\"--map-by
Separate arguments with a space and enclose numa\" "
them all with a set of double quotation marks ("
"). If you need to pass an argument that contains
quotation marks, use \ as the escape character
so that the quotation mark is recognized as part
of the argument string.
-v | --version Specifies the version of solver to use: -v 2022R1
<version>
• 2019R2

• 2019R3

• 2020R1

• 2020R2

• 2021R1

• 2021R2

• 2022R1

You do not need to specify this option unless the

selected queue supports multiple solver versions.
--verbose Returns verbose error messages, which may be helpful runFluent --verb-
when troubleshooting issues. ose
-t | --time-limit The maximum duration of the session in hours. When -t "8"
<time-limit> the time limit is reached, the session is interrupted.
You can edit the time limit (p. 45) in the Cloud portal
after the job has started running.
--upload-frequency If this option is specified, new and modified files --upload-frequency
<value> written by the solver to the virtual machine's "30"
temporary storage folder will be automatically
uploaded to Cloud storage at the specified
frequency while the job is running. Specify the
value in minutes.

Note that even if this option is not specified, you

can upload files on demand using the Transfer
Files (p. 74) action in the Cloud portal. Files that
are not transferred during the job run will be

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 183
Using the Command Line to Solve in the Cloud

automatically transferred to Cloud storage when

the job completes.
--gz Use when transferring a small number of large files. --gz
Ideal for low-bandwidth connections. Files are
individually compressed to reduce their size and speed
up transfer to the Cloud. Output files will also be
compressed. Reduces data and transfer charges, and
lets you see the folder structure in the Cloud file
explorer. Performance may be poor if used to transfer
a large number of files.
--tar Use when transferring a large number of files. Files --tar
are compressed into a single archive file for a smaller,
faster transfer to the Cloud. Output files will also be
compressed. Reduces data transfer and storage
charges. Note that the folder structure will not be
visible in the Cloud file explorer. You will not be able
to select specific files to download. Also, the View
Results action cannot be used for quick postprocessing
in the Cloud portal.
-? | -h | --help Get information about the command, such as available runFluent -h
options.

Sample Output (Partial)

ansyscloudcli runfluent -j "Fluent Elbow" -i "elbow.cas" -q "Flexible_eastus_Standard_HC44rs_2022R1"
-n 2 -m 32 -w -d "D:\Simulation Files\Fluent\fluent-elbow\output"
ANSYS Cloud CLI
----------------------------------------

Version 21.2.2112.41
/!\ We do not recommend using less that 50% of the maximum available cores
Session started with ID: 61d5e8a18c1ea29c1d834d7d. Session available at:
https://cloud.ansys.com/sessions/61d5e8a18c1ea29c1d834d7d
[2022-01-05 18:51:16Z] Starting Job:
Input file: elbow.cas
Journal file:
Queue: Flexible_eastus_Standard_HC44rs_2022R1
Number of nodes: 2
Number of cores: 32
Input folder: D:\Simulation Files\Fluent\fluent-elbow
Exhaustive list of files to upload:
Download results after completion: True

[2022-01-05 18:51:17Z] Project: Project D (02406941-4545-436f-a056-d47772680224)

[2022-01-05 18:51:19Z] Assigning task to file transfer agent MYDOMAIN/jsmith@HQJSMITH3.
[2022-01-05 18:51:19Z] Waiting for agent to take the task...
[2022-01-05 18:49:56Z] File transfer start (agentUpload:61d5e8a5d15e04dbeaff5d37:agentUploadWF).
[2022-01-05 18:49:57Z] Transferring data from local machine to cloud storage...
[2022-01-05 18:50:16Z] Upload complete.
Data transferred 6.29 MB.
Data transfer rate 0.37 MB/s.
[2022-01-05 18:50:21Z] Agent MYDOMAIN/jsmith@HQJSMITH3 has completed the task agentUpload:
61d5e8a5d15e04dbeaff5d37:agentUploadWF.
[2022-01-05 18:52:16Z] Starting compute resources... (this may take a few minutes)
[2022-01-05 18:55:09Z] =============== HPC Health Check Process Start. ===============
[2022-01-05 18:55:11Z] Total Duration of the Health Check Process : 1.13 s
[2022-01-05 18:55:11Z] =============== HPC Health Check Process Succeeded. ===============
[2022-01-05 18:55:48Z] Transferring data from cloud storage to compute resource...
[2022-01-05 18:55:50Z] Download complete.
Data transferred 6.29 MB.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
184 and its subsidiaries and affiliates.
 Cloud CLI Command Reference

Data transfer rate 5.15 MB/s.

[2022-01-05 18:55:50Z] Start Fluent solve
/ansys_inc/v221/fluent/fluent22.1.0/bin/fluent -r22.1.0 3ddp -t32 -mpi=intel -pib.ofed -cnf=10.0.1.6,10.0.1.7
-gu -driver x11 -i __input.jou -aas
...

If you do not include the --wait option, the output will display the job session ID only:
ANSYS Cloud CLI
----------------------------------------

Version 21.2.2112.41
Session started with ID: 5e8b70f0de5fe83b80e22a0a. Session available at:
https://cloud.ansys.com/sessions/5e8b70f0de5fe83b80e22a0a

For full monitoring capabilities you can sign in to the Cloud portal at https://cloud.ansys.com.

See Also: Submitting a Job to the Cloud from Ansys Fluent (p. 26)

runLSDyna
Use the runLSDyna command to submit an Ansys LS-DYNA solve job to the Cloud.

Usage
runLSDyna [options]

Options
Option Description Sample Usage
-j | --job <name> Specifies a name for the job. -j "DEM Injection"
The specified name will be
used to identify the job in
the job monitor in the Cloud
portal.
-p | --project Specifies that you want -p "Project A"
<projectId> to use credits from the
budget of a project. To or
be able to use a
project's budget, you -p "02406941-4545-436f-a056-
must be a member of d47772680224"
the project. For more
information, see Project
Budgeting (p. 249).

The value can be the

project name or its ID.
If no value is specified,
the project set as the
default (p. 256) is used.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 185
Using the Command Line to Solve in the Cloud

For instructions on
obtaining a project
name or ID, see How a
Project Budget is
Used (p. 254).
-i | --input The name of the input file -i "DEM_injection.k"
<name> to be submitted for the
solve.
-a | --arguments Additional command -a "p=my-pfile"
<input> line arguments for the
solver.

Separate arguments
with a space and
enclose them all with a
set of double quotation
marks (" "). If you
need to pass an
argument that contains
quotation marks, use \
as the escape character
so that the quotation
mark is recognized as
part of the argument
string.
--smp Specifies that the --smp
computation should be
performed in Shared
Memory Parallel mode. (The
default mode is Distributed.)
--single Specifies that the --single
single-precision version of
the solver is to be used.
-q | --queue The name of the queue -q "Flexible_eastus_Stand-
<queue> to which the job will be ard_HC44rs_2022R1"
submitted. Each queue
represents a specific
data center region and
solver version. Queue
names prefixed with
Small, Medium, Large,
XLarge, or XXLarge
have preset hardware
configurations, while
those prefixed with
'Flexible' are associated
with a specific machine
type and provide the
flexibility to specify the

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
186 and its subsidiaries and affiliates.
 Cloud CLI Command Reference

number of nodes (-n)

and maximum number
of cores (-m) to be
used for the job.

To view a list of
available queues, use
the getQueues (p. 165)
command.

Note: If you intend to

use an LSTC version of
LS-DYNA, you must
choose a queue and
LSTC version that is
supported for your
chosen licensing
model. See LSTC
Version Support in
Cloud (p. 191).
-n | --nodes When using a 'Flexible' -n "2"
<nodes> queue, the number of nodes
to be allocated for the job.
Choose a value that will
accommodate the job
parameters and
requirements.
-m | -max The maximum number of -m "32"
<coresCount> CPU cores to be used by the
machine. You should use at
least half of the maximum
available cores. The number
of cores must be a multiple
of the number of nodes.
-v | --version Specifies the version of -v 2022R1
<version> solver to use:

• 2019R2

• 2019R3

• 2020R1

• 2020R2

• 2021R1

• 2021R2

• 2022R1

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 187
Using the Command Line to Solve in the Cloud

You do not need to

specify this option
unless the selected
queue supports
multiple solver
versions.

Note:

Version
2019 R2 of
LS-DYNA
does not
support
Ansys Elastic
Licensing.
However,
you can use
this version
if you have
a floating
LS-DYNA
2019 R2
license and
have
connected
your
on-premises
license
server to
the Cloud.
For more
information
see Bring
Your Own
License
(BYOL) (p. 263).

-f | --filter Filters the files sent to VMs -f "*.k;*.key"

<filter> for the solve. By default, all
files in the current folder are
sent. Wildcards can be used,
and multiple filters can be
specified by separating
them with a semi-colon (;).
--regex-filter Filters the files sent for the --regex-filter ".*[.]txt;.*[.]png"
<filter> solve using a regular
expression as search criteria.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
188 and its subsidiaries and affiliates.
 Cloud CLI Command Reference

--files <fileList> List of files sent for the --files "DEM_injection.k;test.dat"

solve, separated by a
semi-colon (;)
-w | --wait Wait until the job is -w
completed. Use this option
if you want to see a live job
transcript in the command
window upon job
submission.

Note that if you do not

include the --wait
option, you can still see
the job transcript
updating in the Cloud
portal if you choose to
monitor the job there.
-d | --download Download results to a -d "D:\Simulation Files\LS-Dyna\out-
<path> specified folder. put"
--verbose Returns verbose error --verbose
messages, which may be
helpful when
troubleshooting issues.
--lstc-version Specifies that you want --lstc-version "11.2"
<version> to use an LSTC release
of LS-DYNA (not an
Ansys one), and the
LSTC version to use.

To view a list of
versions available in
the Cloud, use the
getLSTCVersions (p. 163)
command.

To check which LSTC

versions are supported
for your chosen
licensing model, see
LSTC Version Support
in Cloud (p. 191).
-? | -h | --help Get information about the runLSDyna -h
command, such as available
options.
-t | --time-limit The maximum duration of -t "8"
<time-limit> the session in hours. When
the time limit is reached, the
session is interrupted. You
can edit the time

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 189
Using the Command Line to Solve in the Cloud

limit (p. 45) in the Cloud

portal after the job has
started running.
--custom-exe Specifies that you want to --custom-exe "ls-dyna_cus-
<tarName> use a custom installation of tom_exe.tar.gz"
LS-DYNA that has been
uploaded to the Ansys
Cloud portal using the
uploadCustomLSDyna (p. 204)
command.
--memory When using LS-DYNA MPP, --memory "80M"
<memoryValue> this is the amount of
memory to be used by the or
primary processor to
decompose the model. If no --memory "80m"
value is set, the solver
dynamically allocates the
memory.
--memory2 When using LS-DYNA MPP, --memory "20M"
<memoryValue> this is the amount of
memory to be used by all or
processors, including the
primary processor, to solve --memory "20m"
the decomposed problem.
--upload-frequency If this option is --upload-frequency "30"
<value> specified, new and
modified files written
by the solver to the
virtual machine's
temporary storage
folder will be
automatically uploaded
to Cloud storage at the
specified frequency
while the job is
running. Specify the
value in minutes.

Note that even if this

option is not specified,
you can upload files on
demand using the
Transfer Files (p. 74)
action in the Cloud
portal. Files that are
not transferred during
the job run will be
automatically
transferred to Cloud

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
190 and its subsidiaries and affiliates.
 Cloud CLI Command Reference

storage when the job

completes.
--gz Use when transferring a --gz
small number of large
files. Ideal for
low-bandwidth connections.
Files are individually
compressed to reduce their
size and speed up transfer
to the Cloud. Output files
will also be compressed.
Reduces data and transfer
charges, and lets you see
the folder structure in the
Cloud file explorer.
Performance may be poor if
used to transfer a large
number of files.
--tar Use when transferring a --tar
large number of files. Files
are compressed into a single
archive file for a smaller,
faster transfer to the Cloud.
Output files will also be
compressed. Reduces data
transfer and storage
charges. Note that the
folder structure will not be
visible in the Cloud file
explorer. You will not be
able to select specific files
to download. Also, the View
Results action cannot be
used for quick
postprocessing in the Cloud
portal.

LSTC Version Support in Cloud

Licensing LSTC
Queue Requirement
Type Version
LaaS 11.2 or later 2020 R1 or later
9.3.1 or *LSTC version 12.0 requires minimum 2020 R1 queue. Other versions
BYOL (Ansys)
later* supported on all queues.
9.3.1 or
BYOL (LSTC) All LSTC versions supported on all queues
later

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 191
Using the Command Line to Solve in the Cloud

Sample Output (Partial)

>ansyscloudcli runlsdyna -j "DEM Injection" -i "DEM_injection.k" -q "Flexible_eastus_Standard_HC44rs_2022R1"
-n 2 -m 32 -w -d "D:\Simulation Files\LS-DYNA\Output"
ANSYS Cloud CLI
----------------------------------------
Version 21.2.2112.41
/!\ We do not recommend using less that 50% of the maximum available cores
Session started with ID: 61d5ed478c1ea29c1d83852d. Session available at:
https://cloud.ansys.com/sessions/61d5ed478c1ea29c1d83852d
[2022-01-05 19:11:05Z] Starting Job:
Queue: Flexible_eastus_Standard_HC44rs_2022R1
Number of nodes: 2
Number of cores: 32
Input folder: D:\Simulation Files\LS-DYNA
Input file: DEM_injection.k
Exhaustive list of files to upload:
Download results after completion: True
Solver version: 221
Distributed: True

[2022-01-05 19:11:06Z] Project: Project D (02406941-4545-436f-a056-d47772680224)

[2022-01-05 19:11:08Z] Assigning task to file transfer agent MYDOMAIN/jsmith@WJSMITH3.
[2022-01-05 19:11:08Z] Waiting for agent to take the task...
[2022-01-05 19:09:40Z] File transfer start (agentUpload:61d5ed4ad15e04dbeaff5e23:agentUploadWF).
[2022-01-05 19:09:42Z] Transferring data from local machine to cloud storage...
[2022-01-05 19:41:53Z] Upload complete.
Data transferred 3.41 GB.
Data transfer rate 1.81 MB/s.
[2022-01-05 19:41:55Z] Agent MYDOMAIN/jsmith@WJSMITH3 has completed the task agentUpload:
61d5ed4ad15e04dbeaff5e23:agentUploadWF.
[2022-01-05 19:43:32Z] Starting compute resources... (this may take a few minutes)
[2022-01-05 19:47:53Z] =============== HPC Health Check Process Start. ===============
[2022-01-05 19:47:55Z] Total Duration of the Health Check Process : 1.17 s
[2022-01-05 19:47:55Z] =============== HPC Health Check Process Succeeded. ===============
[2022-01-05 19:48:32Z] Transferring data from cloud storage to compute resource...
[2022-01-05 19:49:03Z] Download complete.
Data transferred 3.41 GB.
Data transfer rate 116.71 MB/s.
[2022-01-05 19:49:03Z] Start LS-Dyna solve
[2022-01-05 19:49:03Z] Using auto mode for memory management
Executing /ansys_inc/v221/ansys/bin/ansys221 I=DEM_injection.k -dis -machines 10.0.1.4:16:10.0.1.6:16
-lsdynampp
...

If you do not include the --wait option, the output will display the job session ID only:
ANSYS Cloud CLI
----------------------------------------

Version 21.2.2112.41
Session started with ID: 5f5f716a7131dc15c86e7367. Session available at:
https://cloud.ansys.com/sessions/5f5f716a7131dc15c86e7367

For full monitoring capabilities you can sign in to the Cloud portal at https://cloud.ansys.com.

runMAPDL
Use the runMAPDL command to submit an Ansys Mechanical solve job to the Cloud.

Usage
runMAPDL [options]

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
192 and its subsidiaries and affiliates.
 Cloud CLI Command Reference

Options
Option Description Sample Usage
-j | --job <name> Specifies a name for the job. The specified name will -j "Hyper Elast-
be used to identify the job in the job monitor in the ic"
Cloud portal.
-p | --project Specifies that you want to use credits from the -p "Project A"
<projectId> budget of a project. To be able to use a project's
budget, you must be a member of the project. or
For more information, see Project
Budgeting (p. 249). -p "02406941-
4545-436f-
The value can be the project name or its ID. If a056-
no value is specified, the project set as the d47772680224"
default (p. 256) is used.

For instructions on obtaining a project name or

ID, see How a Project Budget is Used (p. 254).
-q | --queue The name of the queue to which the job will be -q "Flexible_east-
<queue> submitted. Each queue represents a specific data us_Stand-
center region and solver version. Queue names ard_HC44rs_2022R1"
prefixed with Small, Medium, Large, XLarge, or
XXLarge have preset hardware configurations, while
those prefixed with 'Flexible' are associated with a
specific machine type and provide the flexibility to
specify the number of nodes (-n) and maximum
number of cores (-m) to be used for the job. You can
use the getQueues (p. 165) command to view a list of
available queues.
-v | --version Specifies the version of solver to use: -v 2022R1
<version>
• 2019R2

• 2019R3

• 2020R1

• 2020R2

• 2021R1

• 2021R2

• 2022R1

You do not need to specify this option unless

the selected queue supports multiple solver
versions.
-i | --input The name of the input file to be submitted for the -i "Hyper_elast-
<input> solve. ic.dat"

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 193
Using the Command Line to Solve in the Cloud

-n | --nodes When using a 'Flexible' queue, the number of nodes -n "2"

<nodes> to be allocated for the job. Choose a value that will
accommodate the job parameters and requirements.
-m | -max The maximum number of CPU cores to be used by -m "32"
<coresCount> the machine. You should use at least half of the
maximum available cores. The number of cores must
be a multiple of the number of nodes.
-f | --filter <filter> Filters the files sent to VMs for the solve. By default, -f "*.dat;*.txt"
all files in the current folder are sent. Wildcards can
be used, and multiple filters can be specified by
separating them with a semi-colon (;).
--regex-filter Filters the files sent for the solve using a regular --regex-filter
<filter> expression as search criteria. ".*[.]txt;.*[.]png"
--files <fileList> List of files sent for the solve, separated by a --files "file.dat"
semi-colon (;)
-w | --wait Wait until the job is completed. Use this option if you -w
want to see a live job transcript in the command
window upon job submission.

Note that if you do not include the --wait option,

you can still see the job transcript updating in
the Cloud portal if you choose to monitor the
job there.
-d | --download Download results to a specified folder. -d "D:\Simulation
<path> Files\MAPDL\out-
put"
-o | --options Specifies MAPDL command line options. -o "-db 4096 -m
<options> 8192"
--additional-outputs By default, all MAPDL-generated files are uploaded --additional-out-
<filter> from the compute node to the output folder. The puts "*.dat;
additional-outputs option enables you to retrieve my_file.lis"
other files as well. Wildcards can be used, and
multiple filters can be specified by separating them
with a semi-colon (;).
--verbose Returns verbose error messages, which may be helpful --verbose
when troubleshooting a failed job.
-t | --time-limit The maximum duration of the session in hours. When -t "8"
<time-limit> the time limit is reached, the session is interrupted.
You can edit the time limit (p. 45) in the Cloud portal
after the job has started running.
--upload-frequency If this option is specified, new and modified files --upload-frequency
<value> written by the solver to the virtual machine's "30"
temporary storage folder will be automatically
uploaded to Cloud storage at the specified
frequency while the job is running. Specify the
value in minutes.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
194 and its subsidiaries and affiliates.
 Cloud CLI Command Reference

Note that even if this option is not specified, you

can upload files on demand using the Transfer
Files (p. 74) action in the Cloud portal. Files that
are not transferred during the job run will be
automatically transferred to Cloud storage when
the job completes.
--gz Use when transferring a small number of large files. --gz
Ideal for low-bandwidth connections. Files are
individually compressed to reduce their size and
speed up transfer to the Cloud. Output files will also
be compressed. Reduces data and transfer charges,
and lets you see the folder structure in the Cloud file
explorer. Performance may be poor if used to transfer
a large number of files.
--tar Use when transferring a large number of files. Files --tar
are compressed into a single archive file for a smaller,
faster transfer to the Cloud. Output files will also be
compressed. Reduces data transfer and storage
charges. Note that the folder structure will not be
visible in the Cloud file explorer. You will not be able
to select specific files to download. Also, the View
Results action cannot be used for quick
postprocessing in the Cloud portal.
-? | -h | --help Get information about the command, such as runMAPDL -h
available options.

Sample Output (Partial)

>ansyscloudcli runmapdl -j "Hyper Elastic" -i "Hyper_elastic.dat" -q "Flexible_eastus_Standard_HC44rs_2022R1"
-n 2 -m 32 -w -d "D:\Simulation Files\MAPDL\output"
ANSYS Cloud CLI
----------------------------------------
Version 21.2.2112.41
/!\ We do not recommend using less that 50% of the maximum available cores
Session started with ID: 61d609dd8a6b9bdff75c461d. Session available at:
https://cloud.ansys.com/sessions/61d609dd8a6b9bdff75c461d
[2022-01-05 21:13:04Z] Starting Job:
Input file: Hyper_elastic.dat
Queue: Flexible_eastus_Standard_HC44rs_2022R1
Number of nodes: 2
Number of cores: 32
MAPDL options:
Input folder: D:\Simulation Files\MAPDL
Exhaustive list of files to upload:
Include user files: False
Download results after completion: True

[2022-01-05 21:13:06Z] Project: Project D (02406941-4545-436f-a056-d47772680224)

[2022-01-05 21:13:08Z] Assigning task to file transfer agent MYDOMAIN/jsmith@HQJSMITH3.
[2022-01-05 21:13:08Z] Waiting for agent to take the task...
[2022-01-05 21:11:46Z] File transfer start (agentUpload:61d609e2d15e04dbeaff60d9:agentUploadWF).
[2022-01-05 21:11:48Z] Transferring data from local machine to cloud storage...
[2022-01-05 21:12:40Z] Upload complete.
Data transferred 87.63 MB.
Data transfer rate 1.69 MB/s.
[2022-01-05 21:12:45Z] Agent MYDOMAIN/jsmith@HQJSMITH3 has completed the task agentUpload:
61d609e2d15e04dbeaff60d9:agentUploadWF.
[2022-01-05 21:14:21Z] Starting compute resources... (this may take a few minutes)

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 195
Using the Command Line to Solve in the Cloud

[2022-01-05 21:28:37Z] =============== HPC Health Check Process Start. ===============

[2022-01-05 21:28:39Z] Total Duration of the Health Check Process : 1.53 s
[2022-01-05 21:28:40Z] =============== HPC Health Check Process Succeeded. ===============
[2022-01-05 21:29:17Z] Transferring data from cloud storage to compute resource...
[2022-01-05 21:29:20Z] Download complete.
Data transferred 87.63 MB.
Data transfer rate 47.09 MB/s.
[2022-01-05 21:29:20Z] Start MAPDL solve
...

If you do not include the --wait option, the output will display the job session ID only:
ANSYS Cloud CLI
----------------------------------------

Version 21.2.2112.41
Session started with ID: 5ef3893d183e96186433ec0a. Session available at:
https://cloud.ansys.com/sessions/5ef3893d183e96186433ec0a

For full monitoring capabilities you can sign in to the Cloud portal at https://cloud.ansys.com.

See Also: Submitting a Job to the Cloud from Ansys Mechanical (p. 30)

runSCANeR
Use the runSCANeR command to run a driving simulation in the Cloud using Ansys VRXPERIENCE
Driving Simulator powered by SCANeR™.

Usage
runSCANeR [options]

Options
Option Description Sample Usage
-j | --job <name> Specifies a name for the job. The specified name will -j "SCANeR Test"
be used to identify the job in the job monitor in the
Cloud portal.
-p | --project Specifies that you want to use credits from the -p "Project A"
<projectId> budget of a project. To be able to use a project's
budget, you must be a member of the project. or
For more information, see Project
Budgeting (p. 249). -p "02406941-
4545-436f-a056-
The value can be the project name or its ID. If d47772680224"
no value is specified, the project set as the
default (p. 256) is used.

For instructions on obtaining a project name or

ID, see How a Project Budget is Used (p. 254).
-i | --input The name of the archive containing the files needed -i "SCANeRstu-
<input> for the solve. dio.zip"

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
196 and its subsidiaries and affiliates.
 Cloud CLI Command Reference

-c | --config The name of the configuration folder. -c "NCAP"

<name>
--directory The directory that contains the scenarios. --directory "CCRb"
-a | --arguments Additional command line arguments for the -a "-argumentName"
<input> solver.

Separate arguments with a space and enclose

them all with a set of double quotation marks
(" "). If you need to pass an argument that
contains quotation marks, use \ as the escape
character so that the quotation mark is
recognized as part of the argument string.
--cores-by-instance The number of cores to be used per SCANeR instance. --cores-by-instance
<number> The default value is 1. "2"
-q | --queue The name of the queue to which the job will be -q "Medium-
<queue> submitted. Each queue represents a specific data NV12s_SouthCent-
center region and solver version. Queue names ralUS_SCANeR_2020R2"
prefixed with Small, Medium, Large, XLarge, or
XXLarge have preset hardware configurations. You
can use the getQueues (p. 165) command to view a
list of available queues.
-v | --version Specifies the version of solver to use: -v 2022R1
<version>
• 2019R2

• 2019R3

• 2020R1

• 2020R2

• 2021R1

• 2021R2

• 2022R1

You do not need to specify this option unless

the selected queue supports multiple solver
versions.
-f | --filter Filters the files sent to VMs for the solve. By default, -f "*.dat;*.txt"
<filter> all files in the current folder are sent. Wildcards can
be used, and multiple filters can be specified by
separating them with a semi-colon (;).
--regex-filter Filters the files sent for the solve using a regular --regex-filter
<filter> expression as search criteria. ".*[.]txt;.*[.]png"
--files <fileList> List of files sent for the solve, separated by a --files "SCANeRstu-
semi-colon (;) dio.zip"

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 197
Using the Command Line to Solve in the Cloud

-w | --wait Wait until the job is completed. Use this option if you -w
want to see a live job transcript in the command
window upon job submission.

Note that if you do not include the --wait option,

you can still see the job transcript updating in
the Cloud portal if you choose to monitor the
job there.
-d | --download Download results to a specified folder. -d "D:\Simulation
<path> Files\SCANeR\out-
put"
--verbose Returns verbose error messages, which may be --verbose
helpful when troubleshooting a failed job.
-t | --time-limit The maximum duration of the session in hours. When -t "8"
<time-limit> the time limit is reached, the session is interrupted.
You can edit the time limit (p. 45) in the Cloud portal
after the job has started running.
-? | -h | --help Get information about the command, such as runSCANeR -h
available options.

Sample Output (Partial)

>ansyscloudcli runscaner -j "SCANeR Test" -i "SCANeRstudio.zip" -c "NCAP" --directory "CCRb"
-q "MediumNV12s_SouthCentralUS_SCANeR_2020R2" --files "SCANeRstudio.zip" -w
ANSYS Cloud CLI
----------------------------------------

Version 21.1.2102.16
Session started with ID: 60271efebab7f04744026da3. Session available at:
https://cloud.ansys.com/sessions/60271efebab7f04744026da3
[2021-02-13 00:35:41Z] Starting Job:
Queue: MediumNV12s_SouthCentralUS_SCANeR_2020R2
Number of Nodes: 3
Number of cores: 36
Input File: SCANeRstudio.zip
Download results after completion: False

[2021-02-13 00:36:20Z] Assigning task to file transfer agent MYDOMAIN/jsmith@HQJSMITH3.

[2021-02-13 00:36:20Z] Waiting for agent to take the task...
[2021-02-13 00:36:06Z] File transfer start (agentUpload:60271f023ac7434adc33e37d:agentUploadWF).
[2021-02-13 00:36:35Z] Transferring data from local machine to cloud storage...
[2021-02-13 00:37:20Z] Starting compute resources... (this may take a few minutes)
[2021-02-13 00:36:41Z] Upload complete.
Data transferred 6.56 MB.
Data transfer rate 1.17 MB/s.
[2021-02-13 00:36:43Z] Agent MYDOMAIN/jsmith@HQJSMITH3 has completed the task agentUpload:
60271f023ac7434adc33e37d:agentUploadWF.
[2021-02-13 00:41:53Z] Transferring data from cloud storage to compute resource...
[2021-02-13 00:41:53Z] Download complete.
Data transferred 6.56 MB.
Data transfer rate 16.37 MB/s.
[2021-02-13 00:41:58Z] Start SCANeR solve
[2021-02-13 00:41:59Z] Starting slice 1/36
[2021-02-13 00:41:59Z] Starting slice 2/36
[2021-02-13 00:41:59Z] Starting slice 3/36
[2021-02-13 00:41:59Z] Starting slice 4/36
[2021-02-13 00:41:59Z] Starting slice 5/36
[2021-02-13 00:41:59Z] Starting slice 6/36
[2021-02-13 00:41:59Z] Starting slice 7/36
[2021-02-13 00:41:59Z] Starting slice 8/36

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
198 and its subsidiaries and affiliates.
 Cloud CLI Command Reference

[2021-02-13 00:41:59Z] Starting slice 9/36

...

If you do not include the --wait option, the output will display the job session ID only:
ANSYS Cloud CLI
----------------------------------------

Version 21.2.2112.41
Session started with ID: 60271efebab7f04744026da3. Session available at:
https://cloud.ansys.com/sessions/60271efebab7f04744026da3

For full monitoring capabilities you can sign in to the Cloud portal at https://cloud.ansys.com.

runSPEOSHPC
Use the runSPEOSHPC command to submit a SPEOS HPC solve job to the Cloud.

Usage
runSPEOSHPC [options]

Options
Option Description Sample Usage
-j | --job Specifies a name for the job. The specified name will be -j "Light Sys-
<name> used to identify the job in the job monitor in the Cloud tem"
portal.
-p | --project Specifies that you want to use credits from the budget -p "Project
<projectId> of a project. To be able to use a project's budget, you A"
must be a member of the project. For more
information, see Project Budgeting (p. 249). or

The value can be the project name or its ID. If no -p

value is specified, the project set as the default (p. 256) "02406941-
is used. 4545-436f-
a056-
For instructions on obtaining a project name or ID, d47772680224"
see How a Project Budget is Used (p. 254).
-sv5 <name> The path to the SV5 file to be used for the simulation. -sv5 "D:\Simula-
tion
Files\SPEOS\Light
Sys-
tem\LG_50M_Color-
imetric.sv5"
-a | --arguments Additional command line arguments for the solver. -a "-check"
<input>
Separate arguments with a space and enclose them
all with a set of double quotation marks (" "). If you
need to pass an argument that contains quotation
marks, use \ as the escape character so that the

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 199
Using the Command Line to Solve in the Cloud

quotation mark is recognized as part of the argument

string.
-q | --queue The name of the queue to which the job will be submitted. -q "SmallHC_East-
<queue> Each queue represents a specific data center region and US_Speos_2022R1"
solver version. Queue names prefixed with Small, Medium,
Large, XLarge, or XXLarge have preset hardware
configurations. You can use the getQueues (p. 165)
command to view a list of available queues.
-v | --version Specifies the version of solver to use: -v 2022R1
<version>
• 2019R2

• 2019R3

• 2020R1

• 2020R2

• 2021R1

• 2021R2

• 2022R1

You do not need to specify this option unless the

selected queue supports multiple solver versions.
-w | --wait Wait until the job is completed. Use this option if you want -w
to see a live job transcript in the command window upon
job submission.

Note that if you do not include the --wait option, you

can still see the job transcript updating in the Cloud
portal if you choose to monitor the job there.
-d | --download Download results to a specified folder. -d "D:\Simula-
<path> tion
Files\SPEOS\Light
System\output"
--verbose Returns verbose error messages, which may be helpful --verbose
when troubleshooting a failed job.
-t | --time-limit The maximum duration of the session in hours. When the -t "4"
<time-limit> time limit is reached, the session is interrupted. You can
edit the time limit (p. 45) in the Cloud portal after the job
has started running.
-? | -h | --help Get information about the command, such as available runSPEOSHPC -h
options.

Sample Output (Partial)

>ansyscloudcli runspeoshpc -j "Light System" -sv5 "D:\Simulation Files\SPEOS\Light System\
LG_50M_Colorimetric.sv5" -q "SmallHC_EastUS_Speos_2022R1" -t "4" -w -d "D:\output"
ANSYS Cloud CLI

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
200 and its subsidiaries and affiliates.
 Cloud CLI Command Reference

----------------------------------------

Version 21.2.2112.41
Session started with ID: 61d60ec28a6b9bdff75c7002. Session available at:
https://cloud.ansys.com/sessions/61d60ec28a6b9bdff75c7002
[2022-01-05 21:33:56Z] Starting Job:
Queue: SmallHC_EastUS_Speos_2022R1
Number of nodes: 1
Total number of cores: 44
Input folder: D:\Simulation Files\SPEOS\Light System
SV5 input iile name: LG_50M_Colorimetric.sv5
Exhaustive list of files to upload:
Files to monitor: no
Download results after completion: True

[2022-01-05 21:33:58Z] Project: Project D (02406941-4545-436f-a056-d47772680224)

[2022-01-05 21:34:00Z] Assigning task to file transfer agent MYDOMAIN/jsmith@HQJSMITH3.
[2022-01-05 21:34:00Z] Waiting for agent to take the task...
[2022-01-05 21:32:39Z] File transfer start (agentUpload:61d60ec6d15e04dbeaff617a:agentUploadWF).
[2022-01-05 21:32:40Z] Transferring data from local machine to cloud storage...
[2022-01-05 21:32:44Z] Upload complete.
Data transferred 505.09 KB.
Data transfer rate 0.21 MB/s.
[2022-01-05 21:32:46Z] Agent MYDOMAIN/jsmith@HQJSMITH3 has completed the task agentUpload:
61d60ec6d15e04dbeaff617a:agentUploadWF.
[2022-01-05 21:34:19Z] Starting compute resources... (this may take a few minutes)
[2022-01-05 21:43:33Z] Transferring data from cloud storage to compute resource...
[2022-01-05 21:43:36Z] Download complete.
Data transferred 505.14 KB.
Data transfer rate 0.67 MB/s.
[2022-01-05 21:43:37Z] Start SpeosHPC solve
FileDescription: Speos HPC 2022
FileVersion: 2022.1.0.2626
(c) 2022 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited.
Optis.IntelMPI load succeed
Initializing the Speos environment...
Processing the command line...
Formatting the input sv5 filename...
Trying to connect to an Ansys license server...
Creating the SPEOS system...
Loading the sv5 file...
MPI Rank 0: number of threads = 44
MPI Rank 0: the number of threads is modified by the command line option.
Requesting 44 physical cores to the license server.
Simulation running on 1 computers with a total of 44 threads, on 44 cores (on 44 available)...

Running the simulation...

...

If you do not include the --wait option, the output will display the job session ID only:
ANSYS Cloud CLI
----------------------------------------

Version 21.2.2112.41
Session started with ID: 601c3c83b6e7f96364a57f44. Session available at:
https://cloud.ansys.com/sessions/601c3c83b6e7f96364a57f44

For full monitoring capabilities you can sign in to the Cloud portal at https://cloud.ansys.com.

See Also: Submitting a Job to the Cloud from SPEOS Products (p. 34)

shareJob
Use the shareJob command to share a submitted job with another user.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 201
Using the Command Line to Solve in the Cloud

Either the job name or job ID and the email address of the target user are required to execute this
command.

Usage
shareJob [options]

Options
Option Description Example
-j | --job <name> Specifies the name of the job to share. -j "Fluent Elbow"
-i | --id <jobId> Specifies the ID of the job to share. You can -i
obtain the job ID in the Cloud portal by 5c61af77309b7e08986632ef
clicking the job in the Jobs dashboard widget
or going to the Jobs page.
-e | --email Specifies the email address of the user with -e "jane.doe@com-
<email> whom you would like to share the job. The pany.com"
user must have an Ansys Account, and the
email address specified must be the one
associated with that account.
--verbose Returns verbose error messages, which may --verbose
be helpful when troubleshooting a failed job.
-? | -h | --help Get information about the command, such as -h
available options.

Sample Output
>ansyscloudcli shareJob -j "Fluent Elbow" -e "[email protected]"
ANSYS Cloud CLI
----------------------------------------

Version 21.2.2112.41

An email notification is sent to the user, and the job appears on the user's Jobs page in the Cloud
portal, in the Shared with me pane.

See Also: Sharing a Job (p. 89)

upload
Use the upload command to upload files to Cloud storage.

Usage
upload [options]

Options
Option Description Sample Usage

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
202 and its subsidiaries and affiliates.
 Cloud CLI Command Reference

-j | --job If uploading files to a job folder, this specifies the -j "Fluent Elbow"
<name> name of the job. Alternatively you can use the job
ID.
-i | --id If uploading files to a job folder, this specifies the -i
<jobId> ID of the job. This is an alternative to specifying 5c61af77309b7e08986632ef
the job name. You can obtain the job ID in the
Cloud portal by clicking the job in the Jobs
dashboard widget or going to the Jobs page.
-r | -region Specifies the data center region where the target -r eastus
<region> folder is located:

• centralindia

• eastus

• japaneast

• northcentralus

• northeurope

• southcentralus

• westeurope

• westus

-f | --filter Filters the files to be uploaded. By default, all the -f "*.dat;*.txt"

<filter> files in the specified folder are sent. Wildcards can
be used, and multiple filters can be specified by
separating them with a semi-colon (;).
--files List of files to upload, separated by a semi-colon --files "elbow.cas;el-
<fileList> (;) bow.dat"
-d | --directory Specifies the Cloud storage folder to which you -d "Fluent Elbow"
<dir> want to upload files.
-s | --source (Optional) Specifies the local folder from which -s "D:\Projects"
<dir> you want to upload files. By default, files are
uploaded from the current folder.
--no_encryption Specifies that files should not be encrypted. --no_encryption
--gz Use when transferring a small number of large --gz
files. Ideal for low-bandwidth connections. Files
are individually compressed to reduce their size
and speed up transfer to the Cloud. Output files
will also be compressed. Reduces data and transfer
charges, and lets you see the folder structure in
the Cloud file explorer. Performance may be poor
if used to transfer a large number of files.
--tar Use when transferring a large number of files. --tar
Files are compressed into a single archive file for

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 203
Using the Command Line to Solve in the Cloud

a smaller, faster transfer to the Cloud. Output files

will also be compressed. Reduces data transfer and
storage charges. Note that the folder structure will
not be visible in the Cloud file explorer. You will
not be able to select specific files to download.
Also, the View Results action cannot be used for
quick postprocessing in the Cloud portal.
-? | -h | --help Get information about the command, such as upload -h
available options.

Sample Output
>ansyscloudcli upload -r eastus --files "elbow.cas;elbow.dat" -d "Fluent Elbow"
ANSYS Cloud CLI
----------------------------------------

Version 21.2.2112.41
elbow.cas
elbow.dat
3.19 MB.
0.77 MB/s.
2 files uploaded.
0 files skipped.

uploadCustomLSDyna
Use the uploadCustomLSDyna command to upload a customized version of LS-DYNA to the Ansys
Cloud portal. The full path to the executable (.exe) as well as the region name are required. The
TAR file is uploaded to a folder named LSDynaCustomExeFolder in the portal.

To specify that you want to use this custom installation for a solve, use the custom-exe option with
the runLSDyna (p. 185) command.

Usage
uploadCustomLSDyna [options]

Options
Option Description Sample Usage
-? | -h | --help Get information about the command, such uploadCustomLSDyna -h
as available options.
--customTarPath The full path to the TAR file containing the uploadCustomLSDyna --custom-
<path> custom executable. TarPath "D:\LSDYNA\Cus-
tom\lsdyna_cus-
tom_exe.tar.gz" --region
"eastus"
--region The data region to which the custom uploadCustomLSDyna --custom-
<Region> installation will be uploaded, with no TarPath "D:\LSDYNA\Cus-
spaces in the name. tom\lsdyna_cus-

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
204 and its subsidiaries and affiliates.
 Cloud CLI Command Reference

Examples: tom_exe.tar.gz" --region

"eastus"
• centralindia

• eastus

• japaneast

• northcentralus

• northeurope

• southcentralus

• westeurope

• westus

Sample Output
>ansyscloudcli uploadcustomlsdyna --customTarPath "D:\LSDYNA\Custom\lsdyna_custom_exe.tar.gz" --region
"eastus"
ANSYS Cloud CLI
----------------------------------------

Version 21.2.2112.41
lsdyna_custom_exe.tar.gz
5.23 KB.
0.01 MB/s.
1 files uploaded.
0 files skipped.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 205
 © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
206 and its subsidiaries and affiliates.
Analytics for Individuals
Use the Ansys Cloud portal dashboard to get information about your Cloud usage such as credit
spending or file storage consumption. You can also use the Cloud portal or Cloud app for Ansys Fluent
and Ansys Mechanical to view analytics for a selected job, such as upload/download speeds, and detailed
event and debug logs where server transactions, system processes, and error messages are recorded.

Topics:
Checking Account Balances
Checking Your Storage Consumption
Viewing the Status of Recent Jobs
Job Submission Analytics
Speed Analytics
Event Log
Debug Log
CPU and Memory Usage
HPC Commands Log
Saving a Transcript or Log to a File

Checking Account Balances

Every job that is run in Ansys Cloud consumes Ansys Elastic Licensing credits (for example, AECs) from
your company's account.

To see the number of Ansys Elastic Licensing credits remaining in your company's account, sign in to
the Ansys Cloud portal at https://cloud.ansys.com. The company balance is displayed in the My balances
tile of the Ansys Cloud portal dashboard.

The value comes directly from the Ansys Elastic Licensing Portal and is shown in the currency of your
Ansys Elastic Licensing package. For more information, see Ansys Cloud Licensing (p. 2).

If you are a member of a project, you can see both the company balance and the project balance in
the My balances tile. For more information about projects, see Project Budgeting (p. 249).

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 207
Analytics for Individuals

To access more detailed information about your account, such as usage transactions and summary
statements, go to the Ansys Elastic Licensing Portal at https://licensing.ansys.com.

Checking Your Storage Consumption

When you submit jobs to Ansys Cloud, files uploaded for the job or generated by the job are stored in
Ansys Cloud.

To see how much storage you have used, sign in to the Ansys Cloud portal at https://cloud.ansys.com.
On the dashboard, the Storage tile displays the amount of data storage that you have used compared
to amount that has been allotted to you:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
208 and its subsidiaries and affiliates.
 Viewing the Status of Recent Jobs

Viewing the Status of Recent Jobs

To quickly check on your most recent jobs, sign in to the sign in to the Ansys Cloud portal at https://
cloud.ansys.com.

The Recent jobs tile on the dashboard indicates the number of jobs that are running concurrently
compared to the maximum number of concurrent jobs allowed. You can also see the status of recently
submitted jobs.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 209
Analytics for Individuals

Job Submission Analytics

The Cloud server keeps track of how many jobs you have submitted this month, and what solvers and
queues you have used.

To view job submission analytics for the current month:

1. Sign in to the Cloud portal at https://cloud.ansys.com.

2. In the navigation pane, select Analytics.

The charts on the Analytics page identify the total number of jobs submitted, the number of jobs
per solver, and the number of jobs per queue:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
210 and its subsidiaries and affiliates.
 Speed Analytics

Speed Analytics
Use the Cloud app or Cloud portal to view the speed of uploads and downloads for a selected job, and
length of time taken by the Cloud to perform tasks such as pool creation and solver execution.

Cloud App for Ansys Fluent and Ansys Mechanical

To view speed analytics in the Cloud app:

1. Launch the Cloud app (p. 10) in your desktop application, then select the job in the job monitor.

2. In the Monitoring pane, click [Analytics].

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 211
Analytics for Individuals

3. To save the log to a text file, click [Save].

Cloud Portal
To view speed analytics in the Cloud portal:

1. Sign in to the Cloud portal at https://cloud.ansys.com.

2. On the Dashboard or Jobs page, click the job in the job monitor.

3. On the job view page, select the Tabular monitor tab.

4. From the Display drop-down, select Analytics:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
212 and its subsidiaries and affiliates.
 Event Log

Event Log
An event log records server operations and system processes that occur when transactions are being
executed for a job. You can view an event log in the Cloud app or the Cloud portal.

Cloud App for Ansys Fluent and Ansys Mechanical

To view a job's event log in the Cloud app:

1. Launch the Cloud app (p. 10) in your desktop application, then select the job in the job monitor.

2. In the Monitoring pane, click [Events].

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 213
Analytics for Individuals

3. To save the log to a text file, click [Save].

Cloud Portal
To view a job's event log in the Cloud portal:

1. Sign in to the Cloud portal at https://cloud.ansys.com.

2. On the Dashboard or Jobs page, click the job in the job monitor.

3. On the job view page, select the Tabular monitor tab.

4. From the Display drop-down, select WorkflowEventOrState:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
214 and its subsidiaries and affiliates.
 Debug Log

Debug Log
A debug log is similar to an event log (p. 213) in that it records server operations and system processes,
but offers an additional level of detail such as error messaging that can assist Cloud and IT support staff
in pinpointing and diagnosing issues. You can view a debug log in both the Cloud app and Cloud portal.

Cloud App for Ansys Fluent and Ansys Mechanical

To view a job's debug log in the Cloud app:

1. Launch the Cloud app (p. 10) in your desktop application, then select the job in the job monitor.

2. In the Monitoring pane, click [Debug].

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 215
Analytics for Individuals

3. To save the log to a text file, click [Save].

Cloud Portal
To view a job's debug log in the Cloud portal:

1. Sign in to the Cloud portal at https://cloud.ansys.com.

2. On the Dashboard or Jobs page, click the job in the job monitor.

3. On the job view page, select the Text monitor tab.

4. From the Display drop-down, select Debug:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
216 and its subsidiaries and affiliates.
 CPU and Memory Usage

CPU and Memory Usage

When a job is submitted to the Cloud, CPU and memory usage data is sent from the HPC cluster head
node to the Cloud portal every minute. You can use the HeadNodePerf thread to view this data for a
selected job. Such data is helpful when a job has failed, as it enables you to verify whether or not the
remote machine had enough resources to run the solution. You can view HPC performance data in
both the Cloud app and the Cloud portal.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 217
Analytics for Individuals

Cloud App for Ansys Fluent and Ansys Mechanical

To view HPC performance data in the Cloud app:

1. Launch the Cloud app (p. 10) in your desktop application, then select the job in the job monitor.

2. In the Monitoring pane, click [Trackers].

3. From the adjacent drop-down, select HeadNodePerf.

4. From the Graph drop-down, select the graph that you want to view.

Cloud Portal
To view HPC performance data in the Cloud portal:

1. Sign in to the Cloud portal at https://cloud.ansys.com.

2. On the Dashboard or Jobs page, click the job in the job monitor.

3. On the job view page, select the Graph monitor tab.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
218 and its subsidiaries and affiliates.
 HPC Commands Log

4. From the Display drop-down, select HeadNodePerf.

5. By default, Memory is plotted on the X axis. To view a different graph, select it in the Graphs pane.

To ensure that the complete curve is plotted, select All from the Show drop-down.

To edit the current graph or create a new graph, see Customizing Graphs (p. 105).

HPC Commands Log

While a job is running, the Cloud service may need to issue commands to the HPC cluster to execute
particular actions. For example, when you stop a job in the Cloud app or portal, a command must be
sent to the cluster to stop the job. Such commands are captured in a log in the Cloud portal.

To view an HPC commands log:

1. Sign in to the Cloud portal at https://cloud.ansys.com.

2. On the Dashboard or Jobs page, click the job in the job monitor.

3. On the job view page, select the Text monitor tab.

4. From the Display drop-down, select HPCCommands:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 219
Analytics for Individuals

Saving a Transcript or Log to a File

When using the Cloud app for Ansys Fluent and Ansys Mechanical, you can save a job transcript, debug
log, or event log to a text file for easy sharing when needed.

To save a transcript or log:

1. In the Cloud app, select the desired job in the job list.

2. In the Monitoring pane, use the toolbar to select the transcript or log that you want to save.

3. When the transcript or log is displayed in the Monitoring pane, click [Save].

4. In the Save As dialog box, specify a name and save location for the resulting text (*.txt) file, then
click Save.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
220 and its subsidiaries and affiliates.
Analytics for Company Administrators
If you are a member of the administrators group, you can use an admin-level Analytics tool to get insight
into your company's usage of Ansys Cloud. Pre-configured charts and tables provide information about
resource usage, job counts, data transfer rates, data volume, and system latency.

Topics:
Analyzing Your Company's Cloud Usage
Filtering and Visualizing Data
Saving and Loading Filters
Exporting Data to a CSV File

Analyzing Your Company's Cloud Usage

If you are a member of the administrators group you have access to an Analytics tool that enables you
to analyze your company's Cloud usage.

To access analytics for your company:

1. Sign in to the Cloud portal as a Company Admin.

2. In the navigation pane, select Company Admin → Analytics.

3. On the Admin Analytics page, set up the desired view:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 221
Analytics for Company Administrators

a. Select the category of analytics that you would like to view:

Usage. Data relating to the consumption of resources and elastic currency.

Jobs. Data relating to jobs submitted by users.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
222 and its subsidiaries and affiliates.
 Analyzing Your Company's Cloud Usage

Data Transfer. Speed and volume of data transferred between users and Ansys Cloud.
Latency. Time used for pool creation and allocation, hardware time used, and number of
pool delays.

b. Select the type of data that you would like to analyze. The options vary depending on the
category selected.

By default, data is displayed in a chart. If you prefer to view data in a table, use the Chart
drop-down to select the Table format.

The table below provides a quick overview of the types of data that can displayed for each
category.

Category Charts Chart Display

Usage Cores Number of cores
consumed
Core Hours Number of core hours
consumed
Instance Usage Number of VM
instances created
Currency Count of elastic
Consumption licensing units used
by type
(AEU/AHC/AEC)
Jobs Job Count Number of jobs that
were run
Data Transfer Upload Speed Speed at which data
was uploaded to
cloud storage from
users' local machines
(MB/s)
Upload Speed Speed at which data
(Internal) was uploaded to
cloud storage from
virtual machines
(MB/s) — available
only for some solvers
like AEDT
Download Speed Speed at which data
was downloaded from
cloud storage to
users' local machines
Download Speed Speed at which data
(Internal) was downloaded from
cloud storage to
virtual machines
MB Uploaded Megabytes of data
uploaded to cloud

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 223
Analytics for Company Administrators

storage from users'

local machines
MB Uploaded Megabytes of data
(Internal) uploaded to cloud
storage from virtual
machines
MB Downloaded Megabytes of data
downloaded from
cloud storage to
users' local machines
MB Downloaded Megabytes of data
(Internal) downloaded from
cloud storage to
virtual machines
Latency Pool Allocation Time Seconds taken to
allocate jobs to a VM
pool
Pool Delays The number of times
a job failed to start
after 5 attempts and
a wait of 30 minutes
to start trying again
Pool Creation Time Seconds taken to
create the pool that
solves the job
Hardware Time Hardware time used
(in seconds)

c. Use the filter panel to modify the data display. See Filtering and Visualizing Data (p. 224).

d. When filters have been specified, click Apply to refresh the data displayed in the chart or
table.

Filtering and Visualizing Data

When viewing data on the Admin Analytics page, you can use the filter panel to customize the results
display.

When you apply a set of filters, selections in the Date Range and Filters panes are retained in browser
memory and automatically reapplied in subsequent sessions. You can also save a filter configuration
to a file, enabling you to quickly reload that configuration at any time. See Saving and Loading Fil-
ters (p. 233).

Topics:
Setting a Date Range
Filtering the Data

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
224 and its subsidiaries and affiliates.
 Filtering and Visualizing Data

Specifying Data Display Options

Specifying Chart Display Options

Setting a Date Range

To display data for a specific time period, use the Date Range filter:

1. Specify the date range by selecting a Start Date and End Date.

2. From the Group By drop-down, select the unit of time by which you would like to group data
(Hour, Day, Week, Month, Year).

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 225
Analytics for Company Administrators

Filtering the Data

To specify the types of data to be included in the results, use the Filters pane:

• Use the check boxes to enable or disable entire categories, or expand a category to filter individual
values within the category (for example, selected regions within the Regions category).

When selections are made across categories, the AND operator is used. For example, if you are
viewing a Jobs chart, selecting Fluent in the Application category and eastus in the Regions
category displays all Fluent jobs from the Eastern U.S. region.

When multiple selections are made within a single category, the OR operator is used. For example,
if you select both Fluent and MAPDL from the Application category, and eastus from the Regions
category, you will see all Fluent and MAPDL jobs from the Eastern U.S. region. Data is filtered if it
comes from a Fluent OR MAPDL job, effectively summing these values.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
226 and its subsidiaries and affiliates.
 Filtering and Visualizing Data

• Use the search field to quickly find a specific filter value. For example, typing west in the search
field displays the Regions category and westeurope region in the filter tree:

To redisplay the full filter tree, clear the search field and press Enter.

Specifying Data Display Options

To specify how you would like data to be displayed in the chart or table, use the Data Options pane.

• To group data by a selected filter category, select the category from the Grouping drop-down. For
example, if you wanted to show Core Hour usage by application, you would select 'Application
Name' as the grouping option:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 227
Analytics for Company Administrators

• (Jobs only) To choose whether the dates displayed in the Job Count chart/table reflect the start
date or end date of jobs, make a selection from the Time Unit Field drop-down:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
228 and its subsidiaries and affiliates.
 Filtering and Visualizing Data

• To specify how you want data to be measured, make a selection from the Measurement Type
drop-down:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 229
Analytics for Company Administrators

Specifying Chart Display Options

To customize the way data is displayed in the chart, use the Visuals pane:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
230 and its subsidiaries and affiliates.
 Filtering and Visualizing Data

• To add a sum line to the chart, select one or more columns in the Sum section whose values you
want to add together.

For example, if you were viewing Currency Consumption and wanted to see the total number of
AEC units consumed over a period of time, you would select AEC (Sum) in the Sum drop-down.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 231
Analytics for Company Administrators

Here is a sample result:

• To specify how multiple values are shown in each column, use the Stack section. By default, values
are displayed side-by-side in individual bars. Enabling the Stack Values option stacks values in a
single bar.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
232 and its subsidiaries and affiliates.
 Saving and Loading Filters

Saving and Loading Filters

If you find that you are often applying the same set of filters on the Admin Analytics page, you can
save your selections to a file for easy reloading in the future.

Note:

Only selections on the Date Range and Filters panes are saved.

Saving a Filter Configuration

To save the current filter selections to a file:

1. Click in the filter panel.

2. Specify a meaningful name for the filter configuration, then click Save. Filter configurations are
saved as .json files.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 233
Analytics for Company Administrators

The file is downloaded to the default download location on your computer. For easy search and
retrieval, you may want to create a folder specifically for your filter configurations, and move the
file into that folder.

Loading a Saved Filter Configuration

To load a filter configuration that you have saved:

1. Click in the filter panel.

2. In the Open dialog box, locate and select the desired filter configuration file (for example, fil-
ter.json), then click Open.

The saved filter options are applied to the filter panel, and the chart is refreshed.

Note:

Filter configurations saved before June 2022 may not be compatible with the current release
of Ansys Cloud.

Exporting Data to a CSV File

If you are an administrator viewing data analytics (p. 221) for your company, you can use the Export as
CSV action to export data to a Microsoft Excel spreadsheet.

1. On the Admin Analytics page, display the chart from which you would like to export data, and
apply filters (p. 224) if desired.

2. On the toolbar, click Export as CSV.

A .csv file is downloaded to the default download location on your computer. Conveniently, the
file name indicates the data type, time unit, and date range of the selected chart. For example,
Job_Count_Day_2022-03-01_2022-03-31.csv.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
234 and its subsidiaries and affiliates.
User Management
Ansys Cloud users are assigned to one or more user groups in the Ansys Cloud portal. Each user group
has a specific set of permissions that determine what users in that group can see and do in the Ansys
Cloud portal.

When a user signs in to Ansys Cloud for the first time, they are added to the Users list in the Ansys
Cloud portal, and become members of the company's 'all users' group. Members of this group can
submit jobs and launch applications, and monitor and control their own jobs.

Selected users may be assigned administrator rights in the Ansys Account portal, enabling those users
to perform administrative functions (p. 235) in the Ansys Cloud portal. For information on user manage-
ment in the Ansys Account portal, see Managing Multiple Subscriptions and Users in the Ansys Account
Management guide.

Administrators can create new user groups for purposes such as project budgeting (p. 249), which allows
a pool of Cloud credits to be reserved for a specific group of users.

This section describes how to manage users and user groups in Ansys Cloud.

Topics:
Creating and Managing User Groups
Viewing the Company User List
Viewing a User's Group Memberships

Creating and Managing User Groups

A user group is a list of users created for a specific purpose. Each group has a specific set of permissions
that determine what users in that group can do and access in the Ansys Cloud portal. In other words,
the permissions of individual users are determined by the permissions set for the user group(s) to which
they belong.

The following user groups are available by default:

User Group Main Functions

Company users • Submit jobs and launch applications

• Monitor and manage their own jobs

Company • Create and manage user groups

administrators
• Create and manage budgeting projects

• View cloud usage information for the entire company

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 235
User Management

User Group Main Functions

• View audit logs

• View all users in the system and add them to user groups

• Set up Bring Your Own License (BYOL)

By default, all users can view user groups on which they have 'View' permission. To be able to edit a
user group, a user must have 'Edit' permission on the user group. If a user has only 'View' permission
on a user group, all editing functions are disabled in the user group view.

Members of the administrators group can create additional user groups if desired and manage the
users, permissions, and properties of any available user group.

Topics:
Creating a User Group
Adding Users to a User Group
Removing a User from a User Group
Specifying Permissions on a User Group
Renaming a User Group
Editing a User Group Description
Deleting a User Group

Creating a User Group

You can create a user group if you are member of the administrators group.

To create a user group:

1. In the navigation panel, select User groups.

2. On the User Groups page, click Create group.

3. Specify a name and optional description of the group:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
236 and its subsidiaries and affiliates.
 Creating and Managing User Groups

4. Click Create group.

The group is added to the list of user groups. You can now add users (p. 237) to the group and
specify the permissions (p. 242) that other users have on the group.

Adding Users to a User Group

You can add users to a user group if you are a member of the administrators group.

You can add one or more users to a user group in the user group view. You can also add a user to
a group while viewing the user's profile.

Note:

The Company and Company administrators groups are read-only. You cannot add users
to these groups in the Ansys Cloud portal. This is done in the Ansys Account portal at ht-
tps://myaccount.ansys.com. For more information see the Ansys Account Management guide
in the Ansys Account portal or on the Ansys Help site.

Adding Users in the User Group View

To add users to a user group from the user group view:

1. In the navigation panel, select User groups.

2. On the User Groups page, locate and select the desired user group.

The user group view is displayed:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 237
User Management

3. Click Add users.

4. In the Add users to group dialog box, start typing a user's email address in the search field.
Results appear dynamically as you type.

Note:

If the desired user does not appear in the search results, it is likely that they are not
part of the Users list (see Viewing the Company User List (p. 246)). Users are added to
this list when they sign in to the Ansys Cloud portal for the first time.

5. When the desired email address is visible in the results, select it.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
238 and its subsidiaries and affiliates.
 Creating and Managing User Groups

The user is staged for addition to the group:

6. To add another user, use the search field again.

7. When you have selected the users that you want to add to the group, click Add.

The users are added to the list in the user group.

Adding a User to a Group from the User's Profile Page

To add a user to a group from the user's profile page:

1. In the navigation pane, select Company Admin → Users.

2. On the Users page, select the user in the list to display their profile.

3. On the user's profile page, click Add user to group.

4. In the Add group dialog box, start typing the name of the group to which you want to add the
user. Results appear dynamically as you type.

5. When the desired group is displayed in the results, select it. The group is displayed as a selection:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 239
User Management

To add the user to an additional group, use the search field again.

6. Click Add to add the user to the selected group(s).

Removing a User from a User Group

You can remove users from a user group if you are a member of the User Administrators group, or
any group with the 'Full control user group' permission. Removing a user from a user group removes
the permissions that the user currently has as a member of the group. The user remains in the system
and can be added to a different group if desired.

You can remove a user from a group in the user group view, or on the user's profile page.

Removing a User in the User Group View

To remove a user from a group in the user group view:

1. In the navigation panel, select User groups.

2. On the User Groups page, locate and select the desired user group. The user group view is dis-
played.

3. Click Remove in the table row of the user that you want to remove:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
240 and its subsidiaries and affiliates.
 Creating and Managing User Groups

4. Confirm that the correct user is selected, then click Remove user.

The user is removed from the group.

Removing a User from a Group on the User's Profile Page

To remove a user from a group from the user's profile page:

1. In the navigation pane, select Company Admin → Users.

2. On the Users page, select the user in the list to display their profile.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 241
User Management

3. On the user's profile page, click in the appropriate user group row and select Remove user
from group.

You are prompted to confirm your choice:

4. Click Remove user. The user is removed from the group.

Specifying Permissions on a User Group

The creator of a user group can control whether a specific user or group can view and/or edit the
user group.

To specify permissions on a user group:

1. In the navigation pane, select User Groups.

2. On the User groups page, search for and select the user group for which you want to specify
permission overrides.

3. In the user group view, select the Permissions tab.

In the Users and Groups sections you can see the permissions that users and groups have on
this group. Note that only the users and groups that you have permission to see are listed. For
example, if you do not have the 'Modify users' permission, you will only see yourself listed in the
Users section. Also, the Users list only contains the users that are currently in the user group.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
242 and its subsidiaries and affiliates.
 Creating and Managing User Groups

4. To set permissions for individual users or groups, click Edit Permissions.

5. Set permissions as desired for a user or group. Note that only the users and groups that you
have permission to see are listed.

Available permissions:

• View. The user or group can see the user group on the User groups page, and view its
properties.

• Edit. The user or group can edit the user group (for example, add or remove users).

• ListUsers. The user or group can see the list of users assigned to the group on the Details
tab.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 243
User Management

6. Click Save.

The user or group for which you modified permissions will now have updated permissions on
the current user group.

Renaming a User Group

You can rename a user group if you are a member of the User Administrators group.

To rename a user group:

1. In the navigation panel, select User groups.

2. On the User Groups page, locate and select the desired user group. The user group view is dis-
played.

3. Click Edit group name, then make the desired change:

4. Click Save to update the group name.

Editing a User Group Description

You can edit a user group's description if you are a member of the administrators group. Ideally the
description should briefly indicate the main functions and permissions of the group.

To edit a user group description:

1. In the navigation panel, select User groups.

2. On the User Groups page, locate and select the desired user group. The user group view is dis-
played.

3. Click Edit description, then make the desired change:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
244 and its subsidiaries and affiliates.
 Creating and Managing User Groups

4. Click Save to update the group description.

Deleting a User Group

You can delete a user group if you are a member of the User Administrators group. When you delete
a user group, the users in the group remain in the system but no longer have the permissions that
were specified for the group.

To delete a user group:

1. In the navigation panel, select User groups.

2. On the User Groups page, locate and select the desired user group. The user group view is dis-
played.

3. Click Delete group.

You are prompted to confirm your choice:

4. Click Delete group to delete the user group.

The user group is removed from the User Groups list.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 245
User Management

Viewing the Company User List

Users are automatically added to the Users list when they successfully sign in to the Ansys Cloud portal
for the first time. Only members of the administrators group can see this list.

To view a list of users who have signed in to Ansys Cloud, select Company Admin → Users.

The Users page is displayed:

To view information about a user, search for and select the user in the list.

Viewing a User's Group Memberships

For any given user in the system, administrators can see the user groups (p. 235) to which the user be-
longs, and add them to other user groups if desired. User groups are mainly created for project
budgeting (p. 249) purposes.

To view a user's group memberships:

1. Company Admin → Users.

2. Search for and select the user whose memberships you want to see.

On the Details tab of the user's profile you can see the groups to which the user belongs:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
246 and its subsidiaries and affiliates.
 Viewing a User's Group Memberships

To view information about a user group, such as its members and permissions, click in the user
group row and select View group detail. The user group view is displayed.

In the user profile view you can add the user to a group, or remove them from a group.

See the following topics:

Adding Users to a User Group (p. 237)

Removing a User from a User Group (p. 240)

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 247
 © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
248 and its subsidiaries and affiliates.
Project Budgeting
Administrators can set budgets on Ansys Cloud infrastructure spending for selected groups of users.
Budgets are set on projects to which user groups are assigned. Projects are created specifically for
budgeting control, enabling companies to keep a handle on their Ansys Cloud usage.

When you set a budget on a project, you allocate a number of Ansys Elastic licensing credits (AECs or
AEUs) from your company's licensing pool. These credits are reserved for the members of the project
and cannot be used by others. Budgets can be adjusted at any time to allow increased or decreased
spending.

Project spending can be monitored in the project view.

Topics:
Creating a Project for Budget Control
Adding Users to a Project
Removing Users from a Project
How a Project Budget is Used
Setting a Project as the Default
Viewing a Project's Remaining Credit Balance
Adjusting a Project's Budget
Viewing a Project's Job History
Deleting a Project

Creating a Project for Budget Control

A project is created to control Ansys Cloud infrastructure spending for a selected group of users. When
defining a project you add a user group to the project and specify an allotment of Ansys Elastic licensing
credits (AECs or AEUs) from your company's licensing pool. Budgets help to prevent unnecessary
spending and give your company better control over its Ansys Cloud usage.

The credits that you allot to a project are reserved for the members of the project and cannot be used
by other groups. When all of the allotted credits have been used, members of the project can no longer
run jobs. If jobs are actively running when the threshold is reached, the jobs will be terminated unless
the project allows a budget overrun.

You can create a budgeting project if you are member of the User Administrators group or any group
with full user group permissions.

To create a project:

1. In the navigation pane, select Company Admin → Projects.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 249
Project Budgeting

2. On the Project Budgets page, click Create project.

3. Specify a name and optional description for the project, then click Save.

The project is added to the Project Budgets list.

4. In the list, click the project's name or click Edit in the table row to open the project view.

5. On the Budget tab, click Add credits, then specify the number of Ansys Elastic licensing credits
(AECs or AEUs) to add from your company pool.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
250 and its subsidiaries and affiliates.
 Creating a Project for Budget Control

The project budget is established:

6. To allow actively running jobs to complete when the budget threshold is reached, enable Allow
budget overrun. If an overrun is not allowed, active jobs will be terminated when the threshold
is reached.

7. Select the Members tab, then click Add group. In the Add group dialog box, start typing the
name of the user group that you want to assign to the project. Results appear dynamically as you
type.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 251
Project Budgeting

When the desired group is displayed, select it.

If a user group with the desired members has not yet been created, click Manage groups and
then create a user group (p. 236) with the desired members. Once the group is created, return to
your project on the Projects page and click Add group on the Members tab to add the group to
the project.

Once a project is created, members assigned to the project can begin consuming the credits that have
been budgeted for the project.

Adding Users to a Project

Administrators can add a user group to a project to give members of that group access to the pool of
Ansys Elastic licensing credits reserved for the project.

To add users to a budgeting project:

1. In the navigation pane, select Company Admin → Projects.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
252 and its subsidiaries and affiliates.
 Removing Users from a Project

2. On the Project Budgets page, click the project name or click Edit in the project row to open the
project view.

3. In the project view, select the Members tab.

4. Click Add group. In the Add group dialog box, start typing the name of the user group that you
want to assign to the project. Results appear dynamically as you type.

When the desired group is displayed, select it.

If a user group with the desired members has not yet been created, click Manage groups and
then create a user group (p. 236) with the desired members. Once the group is created, return to
the project view and add the group on the Members tab.

Removing Users from a Project

When users are removed from a project, they no longer have access to the pool of Ansys Elastic licensing
credits reserved for the project. The users remain in the system and can use credits that are not reserved
for projects (if any are available). Note that you cannot remove individual users from a project, only
user groups.

To remove users from a budgeting project:

In the navigation pane, select Company Admin → Projects.

1. On the Project Budgets page, click the project name or click Edit in the project row to open the
project view.

2. In the project view, select the Members tab.

3. In the table row of the user group that you want to remove, click Remove.

You are prompted to confirm the removal:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 253
Project Budgeting

4. Click Remove group to remove the group from the project.

How a Project Budget is Used

When members of a project submit jobs to Ansys Cloud they can select or specify the project when
setting up jobs. This option is available when setting up jobs using the Ansys Cloud portal, the Ansys
Cloud app, or the Command Line Interface (CLI).

When a project is selected, the credits used for the job come out of that project's budget.

If a project is not selected, the job uses credits that are not reserved for projects, if available.

For convenience, members of a project can specify that they want a project to be the default pro-
ject (p. 256) selected when setting up a job.

Ansys Cloud Portal

When setting up a job session in the Ansys Cloud portal, members of a project select the project from
the Project drop-down:

Ansys Cloud App

When using the Cloud app in Ansys Fluent or Ansys Mechanical, members of a project select the project
from the Project drop-down in the job submission form:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
254 and its subsidiaries and affiliates.
 How a Project Budget is Used

Ansys Cloud Command Line Interface (CLI)

When using the Command Line Interface (CLI) to submit a job you can assign the job to a project by
specifying the -p option.

The value can be the project name or its ID. If no value is specified, the project set as the default (p. 256)
is used.

If you are an administrator, you can obtain the project name or ID from the project view on the Projects
page (select Company Admin → Projects).

If you are not an administrator, you can obtain the name of a project to which you belong from the
My balances tile on the Ansys Cloud portal dashboard:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 255
Project Budgeting

To obtain the project ID:

1. In the My balances tile, click View projects.

2. On the Project Budgets page, hover over the project's information icon and then click to copy
the ID to your clipboard.

Setting a Project as the Default

If you are a member of a project, setting a project as the default ensures that the project is used by
default when jobs are submitted to Ansys Cloud. This means that the project will be selected by default
in the Project drop-down when submitting a job using the Ansys Cloud portal or Cloud app. (See How
a Project Budget is Used (p. 254).) Note that you can still select a different project or 'None' for a partic-
ular job if desired.

When using the Command Line Interface (CLI), specifying the -p option with no value specifies that the
default project is to be used.

To set a project as the default project:

1. On the Ansys Cloud portal dashboard, locate the project in the My balances tile.

2. Click next to the project name and select Set as default project.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
256 and its subsidiaries and affiliates.
 Setting a Project as the Default

An icon is displayed next to the project name to indicate that it is the default project:

Unsetting a Project as the Default

If you no longer want a project to be set as the default, follow these steps to unset it as the default:

1. On the Ansys Cloud portal dashboard, locate the project in the My balances tile.

2. Click next to the project name and select Unset as default project.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 257
Project Budgeting

Viewing a Project's Remaining Credit Balance

If you are a member of a project, you can see the project's remaining credit balance in the My balances
tile of your Ansys Cloud dashboard:

If you are an administrator, you can see the remaining balance for any project on the Projects page
(Company Admin → Projects).

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
258 and its subsidiaries and affiliates.
 Adjusting a Project's Budget

If you open a project you can see the remaining budget as a percentage:

Adjusting a Project's Budget

Administrators can increase or decrease the number of credits available in a project's budget at any
time. As an example, you may want to increase the budget if more credits are needed to complete
active or additional jobs, or if there is a negative credit balance due to budget overrun.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 259
Project Budgeting

To adjust a project's budget:

1. In the navigation pane, select Company Admin → Projects.

2. On the Project Budgets page, click the project name or click Edit in the project row to open the
project view.

3. In the project view, add or remove credits as desired.

To allow actively running jobs to complete when the budget threshold is reached, enable Allow
budget overrun. If an overrun is not allowed, active jobs will be terminated when the threshold
is reached.

Note that if you have allowed budget overrun on a project, and the budget currently has a negative
balance, adding credits to the budget to bring the remaining balance up to zero increases the Total
allocated budget (for all projects) by that amount. However, the total credits available in the company
balance (which includes credits allocated to projects) does not change because that value is based on
the number of credits already consumed by the company. In the case of a negative balance being re-
plenished, the credits added to bring the project balance to zero have already been consumed by the
project and have impacted the company balance. Therefore, in this case, the Credits allocated to
projects + Credits not reserved by projects ≠ Total credits available in the company balance. Only
credits that increase the project balance to a positive value have an impact on the Available credits
to allocate (credits not reserved by projects).

Viewing a Project's Job History

Administrators can view a detailed history of jobs that have been logged against a project. In the job
history view you can see:

• The number of jobs submitted

• Who submitted each job

• The number of credits used by each job

• The status and duration of each job

To view a project's job history:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
260 and its subsidiaries and affiliates.
 Viewing a Project's Job History

1. In the navigation pane, select Company Admin → Projects.

2. On the Project Budgets page, click the project name or click Edit in the project row to open the
project view.

3. In the project view, select the Job history tab:

To filter the list by a specific property, click in the corresponding column header and select a
filter value. For example, to see only the jobs submitted by a particular user, click in the User
column and then search for and select the user:

To remove the filter and return to the previous view, click the enabled filter icon and clear the filter
value:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 261
Project Budgeting

Deleting a Project
As an administrator you may want to delete projects that no longer require Ansys Cloud resources. Any
remaining credits in the project budget are returned to the company pool, enabling them to be used
by other projects or users.

To delete a project:

1. In the navigation pane, select Company Admin → Projects.

2. On the Project Budgets page, click the name of the project to delete, or click Edit in the project
row. This opens the project view.

3. In the project view, click and select Delete project:

You are prompted to confirm your choice:

4. Click Delete project.

The project is removed from the Project Budgets page. Users are unassigned from the project,
and all unused credits are returned to the company pool.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
262 and its subsidiaries and affiliates.
Bring Your Own License (BYOL)
Bring Your Own License (BYOL) is a licensing model that enables you to use your existing Ansys software
licenses to leverage the power of cloud computing instead of using pay-as-you-go licensing.

This section describes the steps required to set up a connection to an on-premises license server in
order to utilize your company's floating Ansys software licenses on Ansys Cloud.

Currently, Ansys supports connection to an on-premises license server via IP forwarding.

To set up BYOL for your company, you must be a member of the administrators group.

Note:

Even if you are using BYOL to provide software licenses, you must still have a pool of Ansys
Elastic Licensing credits to cover hardware usage on Ansys Cloud.

Topics:
Setting Up IP Forwarding

Setting Up IP Forwarding
IP forwarding allows an operating system to route packets through other networks. When IP forwarding
is configured, the address and/or port numbers of a packet are sent to a new destination. IP forwarding
is quick to set up, and the easiest configuration method for using your on-premises license server for
Cloud jobs. It is a self-service solution that requires no ongoing maintenance.

The following diagram shows the setup within Ansys Cloud to facilitate IP forwarding:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 263
Bring Your Own License (BYOL)

Refer to the following topics:

Prerequisites for IP Forwarding
Set Up the On-Premises License Server
Define License Proxy Settings in the Ansys Cloud Portal
Ensure Firewall Access
Verify the Connection to the On-Premises License Server

Prerequisites for IP Forwarding

To set up IP forwarding, you need the following:

• An Ansys Account and an active Ansys Cloud Essentials subscription assigned to your account.

• Designation as Company Administrator on Ansys Cloud. An Ansys representative designates an

individual as the Company Administrator for a company when Ansys Cloud subscriptions are pur-
chased. If needed, admin privileges can be granted to other users at the company.

• An IT administrator with access to your company's on-premises license server.

• The public IP address of the on-premises license server or firewall. The IP address must be static.

• A list of associated license and vendor ports:

– Ensure that vendor ports are fixed in license files

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
264 and its subsidiaries and affiliates.
 Setting Up IP Forwarding

– For Ansys FlexLM licensing these are typically ports 1055,1056, and 2325

• License as a Service (LaaS) account settings (CLS ID and PIN). This is needed for hardware license
checkouts on Ansys Cloud in addition to on-premises software license checkouts. This information
can be obtained from the Ansys Elastic Licensing Portal.

Set Up the On-Premises License Server

An IT administrator must complete the following steps on the local on-premises workstation where
the license server is hosted.

Step 1: Obtain Port Information

First, obtain the port (license and the vendor) information from the license file and/or the license
logs. For both FlexLM and RLM there are 2 processes that handle license access:

• License Server (lmgrd or rlm)

• Vendor Daemon

For FlexLM, look at the part of the log when the license server was started. It will display information
in the format shown below. You will need to obtain the ports from this part of the log:
00:00:00 (lmgrd) FlexNet Licensing (<license manager version>) started on <hostname>

00:00:00 (lmgrd) lmgrd tcp-port <license server port>

00:00:00 (lmgrd) Started <vendor daemon> (pid <pid>)

00:00:00 (lmgrd) <vendor daemon> using TCP-port <vendor port>

Step 2: Update Vendor Ports

Each time the license server is restarted the vendor port(s) might change. Therefore we need to persist
a port number to be further used in the Ansys Cloud IP Filtering setup. Before making changes to
the vendor port(s), make sure that you temporarily shut down the license server and confirm that
there are no running jobs.

1. Open the license file in a text editor with admin privileges.

2. Edit the vendor port(s) to assign a fixed port to the vendor daemon. It is recommended that you
use port 1056, as shown in the example below:
VENDOR ansyslmd PORT=1056

Step 3: Restart the License Server and Verify Changes

1. To apply the changes, restart the license server.

2. Look at the flexnet license log file and verify that the vendor port is correctly updated.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 265
Bring Your Own License (BYOL)

Define License Proxy Settings in the Ansys Cloud Portal

A user designated as a Company Administrator must perform the following steps in the Ansys Cloud
portal.

1. Sign in to the Ansys Cloud portal at https://cloud.ansys.com.

2. In the navigation pane, select Company Admin → License Settings.

The License Settings page is displayed:

3. For a desired region, click Activate.

4. Specify the following on the License Server Connection Setup form:

a. From the License Proxy Mode drop-down, select IP Forwarding.

b. Leave Enable high availability set to No. This option is currently unavailable.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
266 and its subsidiaries and affiliates.
 Setting Up IP Forwarding

c. In the Destination IP field, specify the public IP address of the on-premises license server
or firewall to which you want to forward traffic.

d. Specify the remote license port information:

License Interconnect Port (usually 2325)

License Port (usually 1055)
Vendor Port (usually 1056)

e. For LS-DYNA license manager, specify whether you want to use an Ansys or LST license
manager when submitting LS-DYNA jobs.

Note that if using an LST license manager, users must specify the --lstc-version option
when submitting LS-DYNA jobs. If not specified, the job will fail with a licensing error.

5. Click Submit. You are prompted to confirm your action:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 267
Bring Your Own License (BYOL)

6. Click Continue.

The license server connection begins Activating. The deployment process can take a few minutes:

When the proxy has been launched, the status becomes Active:

7. Note the IP address in the Ansys proxy address column. You can click to copy the IP address
to your clipboard. You will use this address to adjust the firewall rules (p. 268) on your Internet
gateway to allow inbound connections from the Ansys Cloud license proxy to the on-premises
license server.

Note that if you have more than one compute region (for example, East US and West US), there
will be a distinct IP address for each region.

8. Make sure that you are also handling the port forwarding internally on your on-premises network
for the license and vendor ports provided above.

Next step: Ensure Firewall Access (p. 268)

Ensure Firewall Access

Firewalls can often cause issues in BYOL setups. Use the tips and guidelines below to ensure that
Windows and Linux firewalls as well as company firewalls allow traffic to flow properly.

• In the ansyslmd.ini file on the license server, set the ANSYSLI_EXTERNAL_IP entry to the IP of
the firewall's Internet-facing IP address. Then, restart the license services.

• Set up port forwarding on the main firewall for ports 1055, 1056, and 2325 (for the incoming Ansys
IP address).

• The DNS resolution for the public-facing IP address used in the step above must resolve for both
reverse lookups, and the name returned must resolve in a forward lookup to something that will
eventually get to the IP address. Trying the DNS name of the firewall in the Cloud Admin interface
and your license server may help.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
268 and its subsidiaries and affiliates.
 Setting Up IP Forwarding

• The IP and DNS must be static.

• Add a new A-name record to the DNS hosting service to set the public IP address to a fixed DNS
name (for example, 127.0.0.1 server.abc.com).

• Use the Fully Qualified Domain Name in the license file (for example, server.abc.com).

• For VDI: If the license server and workstation both return the same public IP address when the
"What's my IP address" search is performed in a web browser, you can work around this issue by
making the license server egress to the Internet on a different public IP address. You then need to
provide the new public-facing, Internet-routable IP address to Ansys Support so that the Ansys
Cloud DevOps team can update the Ansys Cloud Database for your configuration.

Next step: Verify the Connection to the On-Premises License Server (p. 269)

Verify the Connection to the On-Premises License Server

Use the Check utility to test the connection to your on-premises license server and ensure that licenses
are getting checked out.

1. In the License Server Connection pane, click Check for an active data region:

2. Ensure that you have adjusted your firewall rules as indicated in the Check license server con-
nection dialog box. If you are ready to verify the connection, click Check.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 269
Bring Your Own License (BYOL)

A session is started in which a Transmission Control Protocol (TCP) request is submitted to the
expected port and IP address.

If the connection to the on-premises license server is successful, the following messages are
displayed on the job status page:

Otherwise, if the connection fails, the following messages are displayed:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
270 and its subsidiaries and affiliates.
 Setting Up IP Forwarding

What to do when the connectivity test fails

IT networking and security teams will need to work with firewall and forwarding settings until this
test passes. They may need to monitor traffic to the firewalls to determine the point of failure. Testing
may also be done outside the "Check" utility, by not restricting the Source IP on the firewalls. You
can try running a command on a device outside the network to test each port's connectivity.

From a Windows command line, run the following command for each of the three ports (1055, 1056,
2325), changing 127.0.0.1 to the DESTINATION IP and the Port value as appropriate:

powershell -Command "Test-NetConnection 127.0.0.1 -Port 1055"

A successful test looks similar to the following:

ComputerName : 127.0.0.1

RemoteAddress : 127.0.0.1

RemotePort : 1055

InterfaceAlias : Loopback Pseudo-Interface 1

SourceAddress : 127.0.0.1

TcpTestSucceeded : True

Once connectivity is successful, the firewalls may be modified to restrict to only the Ansys Proxy Ad-
dress.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 271
 © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
272 and its subsidiaries and affiliates.
Virtual Desktop Infrastructure
Ansys Cloud uses Virtual Desktop Infrastructure (VDI) technology to enable users to run Cloud-hosted
applications using their local computers. A VDI service provides each user with a comprehensive desktop
system instance (for example, Windows Server 2016). Virtual machines (VMs) provide users with the
same desktop-based experience that they would have on the host operating system itself. Microsoft's
Remote Desktop Protocol (RDP) is used on a user's machine to provide a graphical interface to connect
to remote desktops and applications.

The following diagram shows the setup that supports VDI within Ansys Cloud:

This section provides technical details about how VDI works in Ansys Cloud. For information on running
a virtual session, see Running Applications Interactively on the Cloud (p. 53).

Topics:
Prerequisites for VDI
VDI Methods
VDI Workflow

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 273
Virtual Desktop Infrastructure

VDI Session Management

Prerequisites for VDI

The requirements below must be met in order to use VDI in Ansys Cloud.

Licensing Requirements
• License as a Service (LaaS) account settings (CLS ID and PIN). This is needed for hardware license
checkouts on Ansys Cloud.

• If you have floating Ansys software licenses that you would like to use for cloud computing, you must
set up a connection to your on-premises license server. For instructions, see Bring Your Own License
(BYOL) (p. 263).

User Requirements
Any user who wants to run a remote Cloud desktop or application must have the following:

• An Ansys Account

• A Cloud Essentials subscription (assigned by an admin in the Ansys Account portal)

• (In-browser sessions) An HTML5-capable web browser

• (RDP sessions) A Windows-based computer that allows outbound RDP access on port 50000

VDI Methods
Ansys Cloud uses VDI technology in the following ways:

Application Virtualization
Application virtualization is a technology that enables users to access and use a remotely installed ap-
plications from their local computers. A fully virtualized application is not installed on hardware in the
traditional sense. Instead, a hypervisor layer intercepts the application, which at runtime acts as if it is
interfacing with the original operating system and all of the resources managed by it, when in reality
it is not.

Desktop as a Service
Desktop as a Service (DaaS) enables the delivery of Cloud-hosted virtual desktops to users' computers
via the Remote Desktop Protocol. In the Cloud portal, users can launch a virtual desktop using the
Cloud Desktop app on the Applications page.

In DaaS mode, all the components of the desktop are virtualized, which allows for a highly flexible and
much more secure desktop delivery model. In addition, this approach supports a more complete desktop
workflow as it allows a full control of all applications installed on the VM. This is the simplest configur-
ation that allows you to run jobs and desktops using Ansys Cloud.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
274 and its subsidiaries and affiliates.
 VDI Workflow

However, this does not provide any automated disaster and recovery strategy as all VDI sessions are
dynamic and short-lived in nature. If a user’s computer suddenly fails, all data and associated work is
not recoverable at that moment. The current VDI solution does not provide any user profile management
which means that all session-based configuration of the desktop and user-specific settings are lost when
VDI is terminated.

VDI Workflow
In the Cloud portal, users launch virtual desktops and virtualized applications by selecting an app in
either the In-browser interactive session or RDP interactive session area of the Applications page.
Users can choose a specific application to run, or, if they want to access to multiple applications in a
single session, they select the Cloud Desktop app.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 275
Virtual Desktop Infrastructure

To see the steps that take place when users launch a virtual desktop session, see Running Applications
Interactively on the Cloud (p. 53).

When a solve job completes, users can also postprocess the results in a virtual session by selecting the
VDI Postprocess action in the job view. See Postprocessing in the Cloud via Remote Desktop (p. 130).

RDP Sessions
Upon receiving a VDI session request, a pool creation is initiated, and a remote visualization resource
is allocated. Upon Batch Pool creation a temporary certificate is generated for each run and associated
with the pool. Since the VDI resource is behind a Network Security Group (NSG) with tightly controlled

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
276 and its subsidiaries and affiliates.
 VDI Session Management

access rules, a remote user Public IP is added to the NSG, allowing inbound connection to the RDP port
50000 to the Visualization Node. On the node itself a randomly generated set of user credentials is
created, the RDP session is registered, and an RDP connection file is presented to the user.

When an Ansys Cloud service needs to access a simulation data file, as for Azure Batch service, the VDI
service uses a certificate to decrypt the file. Since the certificate is tied to a pool, once the job is done
all resources associated with that pool are deleted along with temporary certificates and any registered
NSG changes.

VDI Session Management

Virtual desktop sessions are classified as jobs in the Ansys Cloud portal. This means that users can access
them through the job monitor on the Dashboard or Jobs page. See Monitoring Jobs in the Cloud
Portal (p. 84).

When the status of a session is , this indicates that VMs are up:

Clicking the job in the job monitor opens a job view where you can control the session and view detailed
status information. For an in-browser session (p. 59), the virtual desktop itself is displayed in the job
view:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 277
Virtual Desktop Infrastructure

For an RDP session (p. 65), the job view shows the status of the session by default (for example, con-
nection and file transfer status). You can also access this view for an in-browser session by clicking
Monitoring on the toolbar.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
278 and its subsidiaries and affiliates.
 VDI Session Management

During a virtual session, job output files are written to the D:\ANSYS Cloud Drive folder on the
remote resource. By default, new and modified files are automatically transferred to Cloud storage every
15 minutes (unless you specify otherwise during session setup (p. 55)). You can also manually transfer
files (p. 74) at any time during the session.

When you end the session (p. 77) and request to stop it, any files that were not transferred during the
session are automatically transferred from D:\ANSYS Cloud Drive to Cloud storage. You can then
access the files on the Files tab in the job view. See Accessing Job Data (p. 138).

When you abort a session instead of stopping it, no files are transferred to Cloud storage. To abort the
session, click End Session in the job view and select the 'Abort session' option. Or, close the remote
desktop window. A session may also be aborted unintentionally due to hardware or connection issues.
Aborted sessions can be restarted using the Restart action in the job view.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 279
 © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
280 and its subsidiaries and affiliates.
Troubleshooting
Use this section to learn about common issues that you may encounter when installing and using Ansys
Cloud services. Additional information may be available on the Ansys Cloud Forum at https://cloudfor-
um.ansys.com.

Topics:
Troubleshooting Ansys Cloud Installation Issues
Known Issues and Limitations

Troubleshooting Ansys Cloud Installation Issues

If you experience issues with your Ansys Cloud installation, first try using the Check Cloud Installa-
tion (p. 9) utility to identify problem areas.

In some cases your firewall may be blocking Ansys Cloud services. To learn about the ports used by
Ansys Cloud services, and recommendations for managing your firewall system, refer to Firewall Config-
uration Information on the Ansys Cloud Forum.

Known Issues and Limitations

The following are known issues and limitations in the current release of Ansys Cloud. Workarounds are
provided where possible.

Interactive Sessions
• When using the remote Clipboard feature during an in-browser interactive session, there is a limit
on the number of characters that can be copied to the clipboard at one time (approximately 6000).
Exceeding this limit may cause the session to disconnect. To work around this issue, copy and paste
the text in smaller portions instead of copying all of it at once.

Alternatively, if a file on your local machine has a large amount of content, you may want to upload
the file (p. 142) from your local machine to cloud storage, and then use the Transfer files feature to
transfer the file to the VM (p. 75). Similarly, if a file on the VM has a large amount of content, you
can transfer the file to cloud storage (p. 74) at any time and then download the file (p. 145) from
cloud storage to your local machine.

• When running an in-browser interactive session, keyboard shortcuts do not work.

On Chrome, you can enable window/tab management shortcuts like Ctrl+N, Ctrl+T, and Ctrl+W by
creating a shortcut to the Cloud portal and setting it to open in a new window.

For more information, refer to the following:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 281
Troubleshooting

– https://support.google.com/chrome_webstore/answer/3060053?hl=en

– https://support.google.com/chrome/thread/40449276?hl=en

• When running Ansys Workbench in an interactive session, only products that support the current
version of Ansys Elastic Licensing are available in the component list. For a list of compatible products,
see the Ansys Elastic Licensing (as a service) Rate Table document in the Elastic Licensing Terms.
If you are using Bring Your Own License (BYOL) to provide software licenses and have a license
server from an older release, products compatible with that version of Elastic Licensing will be available
to you in Ansys Cloud.

• When using Bring Your Own License (BYOL), an issue may occur if the license server and workstation
both have the same public IP address. (You can do a 'What's my IP address' search in a web browser
to determine this.) To work around this issue, make the license server egress to the Internet on a
different public IP address, then provide the new public-facing, Internet-routable IP address to Ansys
Support so that the Ansys Cloud DevOps team can update the Ansys Cloud Database for your config-
uration.

• When running Ansys Workbench in an in-browser interactive session, attempting to open Mechanical
APDL from a Mechanical APDL system may not work. In Workbench, a default license may be checked
out, but that license may not be one that is available in the Elastic Licensing pool.

To work around this issue you can manually select a valid license in the analysis properties:

• When running Ansys Workbench in an interactive session, attempting to read CFD results may result
in CFD-Post closing unexpectedly.

You may see errors like these:

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
282 and its subsidiaries and affiliates.
 Known Issues and Limitations

This issue has been observed on VMs with the Windows Server 2016 operating system. It is the result
of an HDF5 file locking issue. The HDF5 version used in 2022 R1 will result in failure when the under-
lying file system does not support file locking, or where locks have been disabled. For additional
background information, refer to https://support.hdfgroup.org/ftp/HDF5/releases/ReleaseFiles/hdf5-
1.10.1-RELEASE.txt.

To disable file locking operations, set the following environment variable on the VM:
HDF5_USE_FILE_LOCKING=FALSE.

• When launching Ansys Fluent in an in-browser interactive session, you may encounter the following
error:

A VKI license is required for import/export functions in Fluent.

If you are connected to an on-premises license server as part of the Bring Your Own License (p. 263)
(BYOL) model, you can resolve this issue by adding the acfd_key to the license server.

If you are not using BYOL, import/export functions will not be available in Fluent.

• When submitting an Ansys LS-DYNA analysis from Ansys Mechanical in an in-browser session, using
an MPI option other than 'Intel' causes Mechanical to crash:

Intel MPI is the only MPI type supported for job submission to Ansys Cloud.

• When running Ansys Fluent 2021 R1 on an AMD machine (HB, HBv2, HBv3) in an interactive session,
the solve may be slow if using MS-MPI (the default MPI type). To work around this issue, try setting
the MPIEXEC_AFFINITY variable as described in Environment Variables for the mpiexec Command.
For example, MPIEXEC_AFFINITY=3:P

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 283
Troubleshooting

This issue does not occur when running Fluent 2021 R2 or later because newer releases use Intel MPI
by default. However, if MS-MPI is selected in a newer release, the issue could occur.

• In rare cases, launching a Cloud Desktop on Microsoft Edge may result in a "failed to connect" error.
To work around this issue, use Chrome or Firefox instead.

Batch Job Submission

• Ansys Fluent in Workbench 2021 R2 or earlier: When you open Fluent in Workbench and submit a
job to Ansys Cloud using the Cloud app in Fluent, the .dat file is not uploaded. In cases where you
do not need the entire set of data within Workbench, you can work around this issue by running
standalone Fluent.

This issue was fixed in Release 2022 R1 and therefore only occurs in pre-2022 R1 releases.

• When using the Ansys Cloud app to submit jobs from Ansys Fluent or Ansys Mechanical, selecting a
different file transfer option when your cursor is in a text field prevents the selected file transfer option
from being used. To avoid this issue, remove focus from any text fields (by clicking in blank space)
before selecting a file transfer option. To ensure that the desired file transfer option is used, verify
that the description shown is the correct one for the option that is selected.

• Ansys Mechanical/LS-DYNA 2021 R2 or later: When an LS-DYNA analysis is submitted to Ansys Cloud
from Mechanical using the Ansys Cloud app, some of the results may be null when 'READ RESULTS'
is used to read the result file for the analysis. To work around this issue, use the Trackers monitor in
the Cloud app to view the desired results.

• When submitting a batch job to Ansys Cloud from Ansys Electronics Desktop, the ability to select a
project is not available in AEDT. However, if you set a project as the default in the Ansys Cloud portal,
the job will use the default project. See Setting a Project as the Default (p. 256).

• When using the Command Line Interface (CLI), submitting a job from a system folder such as
C:\Users\[username] may result in a failed job. This occurs because Ansys Cloud does not have
the permissions required to access such folders, preventing the upload of input files to the cloud.
Even if a folder is accessible, the job may still fail if any of the folder's contents (including hidden
files and sub-folders) have restricted permissions, as the folder's entire contents are examined.

Examples of error messages that you may see:

– uploadInputs - Exception: UploadFileException - Can't upload file

uploadInputs - Exception: IOException - The process cannot access the file 'C:\DumpStack.log.tmp'
because it is being used by another process.

– uploadInputs - Exception: UnauthorizedAccessException - Access to the path 'C:\Documents and Settings'

is denied.
uploadInputs - state: ExecutionFailed

– Error: Access to the path 'C:\Users\testuser\AppData\Local\Application Data' is denied.

The job has failed.

Ways to resolve this issue:

– If your input files are in a system folder, copy or move them to a non-system folder and submit
the job from there.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
284 and its subsidiaries and affiliates.
 Known Issues and Limitations

– If your input files are in an accessible folder that potentially contains items with limited permissions,
make sure that your input files have sufficient permissions to be uploaded and use the --files
option in the command line to explicitly specify the names of files to be uploaded.

• When using the Command Line Interface (CLI), and files to be used for the job are located in a sub-
folder of the current directory (the directory in which you opened the command prompt), you should
only use relative paths for the -i | --input, -f | --filter, or --files arguments. For example, if you open
a command prompt in the C:\Simulation\WIP directory, and the input file ConnectingRod.dat
is located in the C:\Simulation\WIP\Tests\Test2 sub-folder, specify the input argument as
follows: -i Tests/Test2/ConnectingRod.dat. An absolute path should not be used.

• When submitting an LS-DYNA job using the Command Line Interface (CLI), you cannot use version
2019 R2 of LS-DYNA if Ansys Elastic Licensing is being used.

Version 2019 R2 of LS-DYNA does not support Ansys Elastic Licensing. However, you can use this
version if you have a floating LS-DYNA 2019 R2 license and have connected your on-premises license
server to the Cloud. For more information see Bring Your Own License (BYOL) (p. 263).

Results Postprocessing
• For Ansys CFX solutions, the Cloud portal's View results feature only supports steady-state solutions
that have been written as a single CFX .res file. Transient or multi-configuration solutions are not
supported. Solutions written to .cff or .flprj files are also not supported.

© ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
and its subsidiaries and affiliates. 285
 © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information of ANSYS, Inc.
286 and its subsidiaries and affiliates.