ANSYS Distributed Compute Gateway User's

Guide

ANSYS, Inc. Release 2020 R1

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

© 2020 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 Distributed Compute Gateway ................................................................................. 1
DCG Portal Features ................................................................................................................................ 1
Basic Concepts ....................................................................................................................................... 2
Supported Browsers ............................................................................................................................... 2
Installing and Deploying Distributed Compute Gateway .......................................................................... 3
Installing Distributed Compute Gateway ................................................................................................. 3
Activating the DCG Portal ....................................................................................................................... 3
Installing Prerequisite Software ............................................................................................................... 5
Installing .NET Core ........................................................................................................................... 6
Installing MongoDB .......................................................................................................................... 6
Obtaining and Installing an SSL Certificate .............................................................................................. 8
Installing a Third-Party Certificate ...................................................................................................... 8
Creating and Installing a Self-Signed Certificate ................................................................................ 9
Creating the Certificate Authority Certificate ............................................................................... 9
Installing the Certificate Authority Certificate .............................................................................. 9
Creating the Machine Certificate ............................................................................................... 10
Registering Applications ....................................................................................................................... 10
Enabling SSL and Nginx ........................................................................................................................ 11
Installing the File Transfer Service .......................................................................................................... 13
Configuring SSL for the File Transfer Service .......................................................................................... 13
Connecting to Distributed Compute Gateway ......................................................................................... 15
Signing in to the DCG Portal .................................................................................................................. 15
Signing Out .......................................................................................................................................... 16
Changing the DCG Portal Language ...................................................................................................... 16
Defining Distributed Compute Gateway Configurations ......................................................................... 19
Configuring Storages ............................................................................................................................ 19
Creating a New Storage Configuration ............................................................................................ 19
Editing a Storage Configuration ...................................................................................................... 21
Deleting a Storage Configuration .................................................................................................... 21
Configuring Clusters and Queues .......................................................................................................... 22
Creating a New Cluster Configuration ............................................................................................. 22
Editing a Cluster Configuration ....................................................................................................... 24
Deleting a Cluster Configuration ..................................................................................................... 24
Defining Queues ............................................................................................................................. 24
Adding a Queue ....................................................................................................................... 25
Importing Queues .................................................................................................................... 25
Enabling and Disabling a Queue ..................................................................................................... 26
Testing a Queue .............................................................................................................................. 26
Editing a Queue .............................................................................................................................. 26
Deleting a Queue ........................................................................................................................... 27
Monitoring and Managing Jobs ............................................................................................................... 29
Viewing the Status of Jobs .................................................................................................................... 29
Stopping a Job ..................................................................................................................................... 29
Sharing a Job ........................................................................................................................................ 30
Viewing Job Share Information ....................................................................................................... 30
Deleting a Job ...................................................................................................................................... 31
Releasing a Job ..................................................................................................................................... 31
Viewing Job Analytics, Transcripts, and Results ....................................................................................... 32
Viewing Speed Analytics ................................................................................................................. 33
Viewing Convergence Plots ............................................................................................................. 33

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. iii
Distributed Compute Gateway (DCG)

Viewing the Job Log ....................................................................................................................... 35

Viewing the Debug Log .................................................................................................................. 36
Viewing the Job Transcript .............................................................................................................. 37
Viewing the Solver Log ................................................................................................................... 37
Viewing the Job Command Log ...................................................................................................... 38
Viewing the Event Log .................................................................................................................... 39
Managing Job Files ............................................................................................................................... 40
Distributed Compute Gateway Administration ....................................................................................... 43
Managing Roles .................................................................................................................................... 43
Managing Jobs ..................................................................................................................................... 45

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
iv of ANSYS, Inc. and its subsidiaries and affiliates.
Getting Started with Distributed Compute Gateway
ANSYS Distributed Compute Gateway (DCG) provides a central framework for configuring and monitoring
job submission to High Performance Computing (HPC) resources. DCG's integrated environment and
tools enable you to easily connect to existing IT infrastructure, providing you with seamless access to
powerful compute resources when needed.

Currently, only ANSYS Minerva can submit jobs to DCG. All other client applications that submit jobs
to HPC resources, such as ANSYS Workbench, will continue to use ANSYS Remote Solve Manager (RSM).

Related Topics:
DCG Portal Features
Basic Concepts
Supported Browsers

DCG Portal Features

To navigate to different areas of the portal, use the navigation panel on the left side of the screen.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1
Getting Started with Distributed Compute Gateway

Basic Concepts
Learn the basic concepts and elements behind Distributed Compute Gateway (DCG).

Client Application
The ANSYS application that submits jobs to DCG.

Client Machine
The computer where ANSYS applications are installed that submit jobs to DCG.

Execution Node
The computer used for computational work. The local machine (localhost) can be an execution node if it
is serving as the HPC resource.

Head Node
The computer where jobs are submitted for scheduling. The head node can also be used as an execution
node.

HPC Configuration
A set of properties defined in DCG that specify information about a High Performance Computing (HPC)
resource.

HPC Resource
A system that supports HPC, such as a cluster. The system uses a queueing system to make optimal use
of all available resources.

Job
The actions involved in running a simulation. This means specifying input files, solver settings, hardware
settings, and output files. Jobs may be run on a local machine or an HPC cluster.

Node
A single computer.

Queue
A list of execution nodes that are suited to run a particular class of jobs.

When you submit a job to DCG, you submit it to an DCG Queue, which maps to an HPC Queue.
The HPC Queue has one or more execution nodes assigned to it and determines when and where
the job runs based on resource requests and current available resources. Queue definitions are part
of the configurations that are defined in DCG.

Supported Browsers
Distributed Compute Gateway (DCG) supports the following browsers:

Browser Minimum Supported

Version
Google 74.0.3729.131
Chrome
Mozilla 66.0.5
Firefox

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
2 of ANSYS, Inc. and its subsidiaries and affiliates.
Installing and Deploying Distributed Compute Gateway
Use the following instructions to install and set up the Distributed Compute Gateway (DCG) server and
the DCG Portal.

Related Topics:
Installing Distributed Compute Gateway
Activating the DCG Portal
Installing Prerequisite Software
Obtaining and Installing an SSL Certificate
Registering Applications
Enabling SSL and Nginx
Installing the File Transfer Service
Configuring SSL for the File Transfer Service

Installing Distributed Compute Gateway

Distributed Compute Gateway (DCG) is bundled with Remote Solve Manager (RSM), so is installed
automatically when RSM is installed. For more information on installing RSM, see RSM Installation and
Startup in the Remote Solve Manager User’s Guide.

Activating the DCG Portal

After installation, the Distributed Compute Gateway user interface (DCG portal) must be activated.

Windows Server
To activate the DCG portal on a Windows server:

1. Log into a Windows account with administrative privileges.

2. Ensure that Ans.Rsm.* processes are not running in Windows Task Manager.

3. Open a command prompt run as administrator in the [RSMInstall]\bin directory.

4. Enable the DCG portal user interface and back end, by running the following command:
rsm.exe appsettings set ComputePortal UseComputePortal true

5. Set the initial system administrator user account by running the following command:
rsm.exe appsettings set ComputePortal DefaultAdminUsername AdminUsername

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 3
Installing and Deploying Distributed Compute Gateway

Replace AdminUsername with the domain and user name of the appropriate account, in the fol-
lowing format: Domain\Username.

6. Enable communication between ANSYS Minerva and the DCG portal by running the following command:
rsm.exe appsettings set Client UseGrpcApi true

7. Set the hostname that you want users to access the DCG portal on by running the following command:
rsm.exe appsettings set ServiceHost DeploymentMachineName MachineName

Replace MachineName with the name of the machine used to connect to the DCG portal.

8. Set the location of the identity server by running the following command:
rsm.exe appsettings set ServiceHost IdentityServiceUrl http://MachineName:5001

Replace MachineName with the name of the machine used to connect to the DCG portal.

9. Set the machine name to use for ANSYS Minerva and DCG communication by running the following
command:
rsm.exe appsettings set ServiceHost GrpcExternalIpOrName IPorHostname

If the service is not hosted on the particular host or IP that you want (such as localhost, or a partic-
ular IP of a specific interface) using this setting overrides the default behavior.

Replace IPorHostname with the appropriate IP name or hostname URL.

10. Ensure that every user shares the same configuration by running the following command:
rsm.exe appsettings set JobManagement ConfigurationDirectory DirectoryPath

Replace DirectoryPath with the full path to job management configuration directory.

11. Run the following command:

AnsConfigRSM.exe -servicehost

12. Create a system level environment variable named DCG_SERVER_TEST_PATH and set the value to a
directory location where all users can run jobs.

If this is not set, the default location of the test directory is C:\Windows\Temp.

Linux Server
To activate the DCG portal on a Linux server:

1. Navigate to the [RSMInstall]/Config/tools/linux directory.

2. Enable the DCG portal user interface and back end, by running the following command:
sudo -E ./rsmutils appsettings set ComputePortal UseComputePortal true

3. Set the initial system administrator user account by running the following command:

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
4 of ANSYS, Inc. and its subsidiaries and affiliates.
 Installing Prerequisite Software

sudo -E ./rsmutils appsettings set ComputePortal DefaultAdminUsername AdminUsername

Replace AdminUsername with the domain and user name of the appropriate account, in the fol-
lowing format: Domain\Username.

4. Enable communication between ANSYS Minerva and the DCG portal by running the following command:
sudo -E ./rsmutils appsettings set Client UseGrpcApi true

5. Set the hostname that you want users to access the DCG portal on by running the following command:
sudo -E ./rsmutils appsettings set ServiceHost DeploymentMachineName MachineName

Replace MachineName with the name of the machine used to connect to the DCG portal.

6. Set the location of the identity server by running the following command:
sudo -E ./rsmutils appsettings set ServiceHost
IdentityServiceUrl http://MachineName:5001

Replace MachineName with the name of the machine used to connect to the DCG portal.

7. Set the machine name to use for ANSYS Minerva and DCG communication by running the following
command:
sudo -E ./rsmutils appsettings set ServiceHost GrpcExternalIpOrName IPorHostname

If the service is not hosted on the particular host or IP that you want (such as localhost, or a partic-
ular IP of a specific interface) using this setting overrides the default behavior.

8. Replace IPorHostname with the appropriate IP name or hostname URL.

9. Ensure that every user shares the same configuration by running the following command:
sudo -E ./rsmutils appsettings set JobManagement ConfigurationDirectory DirectoryPath

Replace DirectoryPath with the full path to job management configuration directory.

10. Run the service script with the command line option servicehost, as shown below:
sudo -E [RSMInstall]/RSM/Config/tools/linux/rsmconfig -servicehost

11. Create a system level environment variable named DCG_SERVER_TEST_PATH and set the value to a
directory location where all users can run jobs.

If this is not set, the default location of the test directory is /tmp.

Installing Prerequisite Software

You must install .NET Core and MongoDB on the Distributed Compute Gateway (DCG) server before
you can deploy DCG.

Related Topics:
Installing .NET Core

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 5
Installing and Deploying Distributed Compute Gateway

Installing MongoDB

Installing .NET Core

Complete the following steps to install .NET Core.

Note:

For more information about .NET Core, refer to the Microsoft documentation (https://
docs.microsoft.com/en-us/dotnet/core/).

Windows Server
1. On a machine with internet access, download the current version of ASP .NET Core/.NET Core Runtime
and Hosting Bundle.

https://dotnet.microsoft.com/download/dotnet-core/2.2

2. If the DCG server does not have internet access, copy the package to the server.

3. Run the package to complete the installation.

Linux Server with Internet Access

Use the following link. It automatically downloads and installs the most current version of the software.

https://dotnet.microsoft.com/download/linux-package-manager/rhel/runtime-current

Linux Server without Internet Access

1. On a machine with internet access, download the current version of .NET Core Binaries x64.

https://dotnet.microsoft.com/download/dotnet-core/2.2

2. Copy the package to the DCG server.

3. Run the package to complete the installation.

Installing MongoDB
Complete the following steps to install MongoDB.

1. Install the MongoDB software.

• If the DCG server has internet access, download and install the software using the instructions provided
in the MongoDB documentation:

https://docs.mongodb.com/manual/administration/install-community/

• If the DCG server does not have internet access:

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
6 of ANSYS, Inc. and its subsidiaries and affiliates.
 Installing Prerequisite Software

a. On a machine with internet access, connect to https://www.mongodb.com/download-center/

community.

b. Download the current release of the MongoDB Community Server package for your operating
system.

c. Transfer the package to the DCG server and run it to complete the installation, following the install-
ation instructions provided on the download center site.

2. Create a system level environment variable named MongoDBConnectionString and set the value
to mongodb://localhost:27017, adjusting the port number if it has been modified from the default.

3. On Linux servers, update the MongoDB configuration file.

a. Open the /etc/mongod.conf file in a text editor.

b. Change the text to the following:

#replication: -->
replication:
enableMajorityReadConcern: true

c. Save and close the file.

d. To restart the MongoDB service, run the following command.

sudo service mongod restart

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 7
Installing and Deploying Distributed Compute Gateway

Obtaining and Installing an SSL Certificate

You must obtain a valid SSL certificate for the Distributed Compute Gateway (DCG) server. This can be
an officially validated third-party certificate, or a self-signed certificate generated for the DCG server.

Important:

When creating a certificate, you must specify the hostname as it will be accessed from the
ANSYS Minerva server. This is the value specified for the URL: Discovery Service setting in
the Job Server definition in ANSYS Minerva (see Defining Job Servers in the ANSYS Minerva
Installation Guide for more details).

For example, if you have server1.company.com:50051 then your certificate must be generated
as server1.company.com. The two must match.

Related Topics:
Installing a Third-Party Certificate
Creating and Installing a Self-Signed Certificate

Installing a Third-Party Certificate

To use a third-party certificate, you must first purchase one from an SSL certificate provider. Once
you have obtained the certificate, install it on the Distributed Compute Gateway (DCG) server.

To install a third-party certificate:

1. Copy the third-party CA certificate to the [RSMInstall]/RSM/Config/certificates folder.

2. Delete the default ca.crt certificate.

3. Rename the third-party certificate copied in step 1 as ca.crt.

4. Copy the third-party machine certificates to the [RSMInstall]/RSM/Config/certificates

folder.

5. Rename the third-party machine certificates to:

• server_DeploymentMachineName.crt

• server_DeploymentMachineName.key

• server_DeploymentMachineName.pfx

DeploymentMachineName is the value chosen when activating the DCG Portal (p. 3).

Alternatively, you can specify the machine certificate .pfx file name in the
Ans.Rsm.Appsettings.config file by adding the following setting:
<add key="PortalPFXFilename" value="certificateFileNameHere.pfx" />

Once you have installed the certificate on the DCG server, you must also install it on the ANSYS
Minerva server. See Installing a Third-Party Certificate in the ANSYS Minerva Installation Guide.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
8 of ANSYS, Inc. and its subsidiaries and affiliates.
 Obtaining and Installing an SSL Certificate

Creating and Installing a Self-Signed Certificate

You can generate an SSL certificate for the Distributed Compute Gateway (DCG) server.

To create and install a self-signed certificate:

1. Create the certificate authority (CA) certificate (p. 9).

2. Install the certificate authority (CA) certificate (p. 9).

3. Create the machine certificate (p. 10).

Creating the Certificate Authority Certificate

The first step of the process is to create the certificate authority (CA) certificate.

1. Using a Linux machine, locate the shell scripts in the [RSMInstall]/RSM/Config/certific-

ates folder.

2. To create a new CA certificate, run the following script:

sudo ./CreateCACert.sh

a. Use the default passcode 1111.

If you use a different passcode, you must change the server certificate scripts.

b. Fill out the requested items about your location.

c. Pick a generic name for the Common Name setting, do not use a single machine name.

d. Leave the Challenge Password setting blank.

Installing the Certificate Authority Certificate

The second step in the process is to install the certificate authority (CA) certificate on every machine
that interacts with DCG, including clients, the DCG server, cluster execution nodes, and so on. Refer
to the appropriate instructions below.

For information on installing a self-signed certificate on the ANSYS Minerva server, see Installing a
Self-Signed Certificate in the ANSYS Minerva Installation Guide.

Windows
1. Open the Run app.

2. In the Open field, type certlm.msc and click OK.

3. In the Certificates - Local Computer list, right-click Trusted Root Certification Authorities and
select All Tasks → Import.

4. In the Certificate Import Wizard dialog box, click Next.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 9
Installing and Deploying Distributed Compute Gateway

5. To the right of the File Name field, click Browse and navigate to the location of the ca.crt certificate
you created previously.

6. Select the certificate and click Open.

7. Complete the Certificate Import wizard, accepting all default settings.

Linux
Run the following commands:

Version Commands
SLES sudo cp ca.crt /etc/pki/trust/anchors/
sudo update-ca-certificates

RHEL/CentOS sudo cp ca.crt /etc/pki/ca-trust/source/anchors

sudo update-ca-trust enable
sudo update-ca-trust extract

Creating the Machine Certificate

The final step in the process is to create the machine certificate.

1. Using a Linux machine, locate the shell scripts in the [RSMInstall]/RSM/Config/certific-

ates folder.

2. To create a new machine certificate, run the following script:

sudo ./createServerCertWithName.sh DeploymentMachineName

DeploymentMachineName is the value chosen when activating the DCG Portal (p. 3).

Note:

If you changed the password for the CA certificate (p. 9), you must edit this script
to include that password instead of 1111.

3. Leave the passwords blank when prompted.

4. Copy the .crt, .key, and .pfx files that were created to the DCG host machine's [RSMIn-
stall]/RSM/Config/certificates folder.

Registering Applications
Applications are the definition of the workflows for Distributed Compute Gateway (DCG). Whenever a
job is run, an application is chosen to define what to do for the job. Here we have predefined the ap-

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
10 of ANSYS, Inc. and its subsidiaries and affiliates.
 Enabling SSL and Nginx

plications that are required to run jobs through ANSYS Minerva, however an onsite methods developer
may want to customize these workflows to tailor them to fit individual needs.

Note:

To register applications, the Developer role must be assigned to your account. For more in-
formation see Managing Roles (p. 43).

1. Sign in to the DCG Portal (p. 15).

2. In the navigation panel, click Developer.

3. Click .

4. In the Register new application dialog box, click Choose File.

5. Browse to [RSMInstall]/RSM/bin/DCGServices/workflows/DefaultDcgCommands1.json.

6. Click .

7. Repeat steps 3-6, browsing to [RSMInstall]/RSM/bin/DCGServices/workflows/Default-

DcgCommands5.json.

Enabling SSL and Nginx

After installing the SSL certificate, you must change settings on the Distributed Compute Gateway (DCG)
server to allow SSL to be used.

Windows Server
1. Log into a Windows account with administrative privileges.

2. Ensure that Ans.Rsm.* processes are not running in Windows Task Manager.

3. Open a command prompt run as administrator in the [RSMInstall]\bin directory.

4. Run the following command:

rsm.exe appsettings set ComputePortal UseSslForPortal true

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 11
Installing and Deploying Distributed Compute Gateway

5. Run the following command:

rsm.exe appsettings set ServiceHost IdentityServiceUrl https://MachineName:5001

Replace MachineName with the name of the machine used to connect to the DCG portal.

Note:

Ensure the IdentityServiceUrl starts with https, not http.

6. Open the [RSMInstall]\bin\ComputePortal\comf\nginx.conf file in a text editor.

7. Uncomment all lines starting with ssl_.

8. Change the certificate name and key to the appropriate location and name that you set in Obtaining and
Installing an SSL Certificate (p. 8).

9. Uncomment the two lines that include ssl at the end (listen NNNN ssl).

10. Comment the two adjoining lines that do not use ssl (listen NNNN).

Linux Server
1. Navigate to the [RSMInstall]/Config/tools/linux directory.

2. Run the following command:

./rsmutils appsettings set ComputePortal UseSslForPortal true

3. Run the following command:

./rsmutils appsettings set ServiceHost IdentityServiceUrl https://MachineName:5001

Replace MachineName with the name of the machine used to connect to the DCG portal.

Note:

Ensure the IdentityServiceUrl starts with https, not http.

4. Open the [RSMInstall]/RSM/bin/ComputePortal/conf/nginx.conf file in a text editor.

5. Uncomment all lines starting with ssl_.

6. Change the certificate name and key to the appropriate location and name that you set in Obtaining and
Installing an SSL Certificate (p. 8).

7. Uncomment the two lines that include ssl at the end (listen NNNN ssl).

8. Comment the two adjoining lines that do not use ssl (listen NNNN).

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
12 of ANSYS, Inc. and its subsidiaries and affiliates.
 Configuring SSL for the File Transfer Service

Installing the File Transfer Service

The file transfer service is used to pass input and output files between ANSYS Minerva and Distributed
Compute Gateway (DCG) when jobs are submitted.

To install the file transfer service:

1. Download and install Python 3.

https://www.python.org/downloads/

Alternately, you can acces Python using the files located in the ANSYS unified installation, located
in C:\Program Files\ANSYS Inc\Release version\commonfiles\CPython\3_6

2. Check that the Python preferred installer program (pip) is installed:

a. From a command prompt, run:

python -m pip -V

b. If an error occurs, install pip by following the directions at https://pip.pypa.io/en/stable/installing/.

3. Upgrade pip to the latest version by running the following command:

python -m pip install --upgrade pip

4. Obtain the following file transfer service whl files from Artifactory.

• AnsysFTS-1.0-py3-none-any.whl

• requirements.txt

5. Install the whl file by running the following command:

python -m pip install /path/to/AnsysFTS-1.0-py3-none-any.whl -r /path/to/requirements.txt

6. Set the environment variable FTS_PYTHON to the location of the python executable used to install the
file transfer service.

For example:
FTS_PYTHON=/ansys_inc/v195/commonfiles/CPython/3_6_5/linx64/Release/python/bin/python

Configuring SSL for the File Transfer Service

To use SSL with the file transfer service, you must enable it.

To configure SSL for the file transfer service:

1. Navigate to the [RSMInstall]/RSM/Config/services directory and edit the machineser-

vices_settings.json file.

2. Under the ServiceHosts section, look for the FTS service.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 13
Installing and Deploying Distributed Compute Gateway

"$type": "Ansys.Hpc.ServiceConfig.ServiceHostSettings, Ans.Hpc.ServiceConfig",

"Services": [ "FTS" ],

"Type": "External",

"Scope": "User",

"Register" : true,

"HostApp": "%FTS_PYTHON%",

"HostArgs": "-E -m com.ansys.xfer.FileTransferService -v D -L 10"

},

3. Add the following two command line options to HostArgs:

-cert CERT, --cert CERT

path to a X.509 certificate for SSL communications

-prikey PRIKEY, --prikey PRIKEY

path to the certificate's private key file

Note:

These options must use the same .crt and .key file you generated previously when
Creating the Machine Certificate (p. 10).

For example:
{

"$type": "Ansys.Hpc.ServiceConfig.ServiceHostSettings, Ans.Hpc.ServiceConfig",

"Services": [ "FTS" ],

"Type": "External",

"Scope": "User",

"Register" : true,

"HostApp": "%FTS_PYTHON%",

"HostArgs": "-E -m com.ansys.xfer.FileTransferService -cert

[RSMInstall]/RSM/Config/certificates/server_server1.company.com.crt
-prikey [RSMInstall]/RSM/Config/certificates/server_server1.company.com.key
-v D -L 10"

},

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
14 of ANSYS, Inc. and its subsidiaries and affiliates.
Connecting to Distributed Compute Gateway
An administrator at your organization can provide tyour sign-in credentials for the Distributed Compute
Gateway (DCG) portal.

If the DCG portal is hosted on a local network, all that you need to connect to it is a web browser. If
the portal is hosted on a remote server, an internet connection is also required.

You typically connect to the DCG portal by submitting a job in ANSYS Minerva; administrators can also
connect directly using a URL

Related Topics:
Signing in to the DCG Portal
Signing Out
Changing the DCG Portal Language

Signing in to the DCG Portal

To sign in to the DCG portal:

1. Submit a job in ANSYS Minerva.

2. If you are submitting a job for the first time, or have not previously cached your credentials, the DCG
portal Login page opens in a new browser tab. To sign in:

a. Enter your user name and password.

If the Login page is not displayed, click Sign In.

b. To store your user name and password for future use, select the Remember My Login check box.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 15
Connecting to Distributed Compute Gateway

c. Click Login.

3. If your credentials have been previously cached, from the job view click .

Signing Out
To sign out of the DCG portal, select Log out from the User menu in the top right corner of the applic-
ation window.

Changing the DCG Portal Language

The DCG portal text can be displayed in English, French, German, Japanese, and Chinese. The language
used is detected automatically from your internet browser locale settings.

You can override these settings temporarily for the current session.

To change the settings temporarily, in the top-right corner of the application window, select a language
from the Language menu.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
16 of ANSYS, Inc. and its subsidiaries and affiliates.
 Changing the DCG Portal Language

To change the language permanently, update your internet browser locale settings.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 17
 Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
18 of ANSYS, Inc. and its subsidiaries and affiliates.
Defining Distributed Compute Gateway Configurations
Distributed Compute Gateway (DCG) integrates with established on-premise clusters using configurations
that you define directly in DCG. Information specified in a DCG configuration includes:

• Details about the HPC resource where jobs are submitted, such as the domain name of a cluster submit host

• Client-to-HPC communication protocols

• File transfer method (from client machine to HPC staging directory)

• Queues available for simulation jobs

Related Topics:
Configuring Storages
Configuring Clusters and Queues

Configuring Storages
For jobs to be successfully executed on the HPC resource, job files must be staged in a location that
the HPC resource can access. Also, job output files may need to be transferred back to ANSYS Minerva
after a job has been executed.

Storage configurations specify how ANSYS Minerva transfers job files to the HPC resource.

Related Topics:
Creating a New Storage Configuration
Editing a Storage Configuration
Deleting a Storage Configuration

Creating a New Storage Configuration

Specify how files are sent to the HPC staging directory.

To create a new storage configuration:

1. In the navigation panel, under Configurations, click Storage.

2. Click .

3. Specify the following settings:

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 19
Defining Distributed Compute Gateway Configurations

Setting Description
Name The name that appears in the Storage Configuration list. Do not use the name of an
existing configuration.
Host The machine that serves as the cluster submit host, where the scheduling software is
installed.

• If jobs will be submitted to the cluster submit host from any other machine, enter the
deployment machine name you set when activating the DCG portal (p. 3), even if the
machine on which you are currently working (the local machine) is the submit host.

• If the machine on which you are currently working (the local machine) is the cluster
submit host, and jobs will not be submitted to it from any other machine, you can enter
localhost in this field.

Platform The operating system of the submit host.

Server The path to the HPC staging directory which all execution nodes can see.
Path
Transfer The method of transferring files to the HPC staging directory. Select from the following:
Types
• OS Copy: Use this option when the HPC staging directory is a shared location that client
machines can access.

• StreamCopy: Use this option when the HPC staging directory is in a remote location
that is not visible to client machines.

• SSH: Use this option when transferring files using a Windows client machine to the HPC
staging directory on a remote Linux cluster.

• Custom: Use this option when the HPC staging directory is in a remote location that is
not visible to client machines, and you need to use an external custom mechanism for
file transfers.

Alternate Displayed when Linux is selected from the Platform drop-down list.
Paths
When integrating with a Windows to Linux workflow, there may be many shared
drives used by the Windows clients that you want to configure. Alternate paths are
a list of the Linux paths that equate to Windows share drives that Windows clients
have.

To add an alternate path, type the name in the Alternate Paths field and press
Enter. You can add one or more alternate paths.
Share Displayed when OS Copy is selected from the Transfer Types list.
Names
The HPC staging network share name used to locate and identify the HPC staging
directory.

To add a share name, type the name in the Share Names field and press Enter.
You can add one or more share names.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
20 of ANSYS, Inc. and its subsidiaries and affiliates.
 Configuring Storages

Setting Description
Proxy Displayed when SSH or Custom is selected from the Transfer Types list.
Machine
The name of the submit host containing the user proxy process. This process
performs operations such as job submission, monitoring, and file transfer on the
user’s behalf when the submit host is a remote machine.
Proxy Displayed when SSH or Custom is selected from the Transfer Types list.
Account
The account name used to access the remote Linux submit host when the DCG
portal is hosted on a Windows machine.
Custom Displayed when Custom is selected from the Transfer Types list.
Protocol
The keyword of your choosing that represents the transfer type. It is a short word
or phrase that you append to the file names of your custom integration files. For
more information, see RSM Custom Integration in the Remote Solve Manager User’s
Guide.

4. Click .

Editing a Storage Configuration

You can edit an existing storage configuration if required.

To edit a storage configuration:

1. In the navigation panel, under Configurations, click Storage.

2. In the row of the storage configuration you want to edit, click [Edit].

3. In the Storage Configuration dialog box, change the settings as appropriate.

4. Click .

Deleting a Storage Configuration

If a storage configuration is no longer required, you can delete it.

To delete a storage configuration:

1. In the navigation panel, under Configurations, click Storage.

2. In the row of the storage configuration you want to remove, click [Delete].

3. In the Confirm dialog box, click .

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 21
Defining Distributed Compute Gateway Configurations

Configuring Clusters and Queues

The Cluster Configurations and Queues page allows you to specify information about the HPC resource
and set up or import Distributed Compute Gateway (DCG) queues.

Related Topics:
Creating a New Cluster Configuration
Editing a Cluster Configuration
Deleting a Cluster Configuration
Defining Queues
Enabling and Disabling a Queue
Testing a Queue
Editing a Queue
Deleting a Queue

Creating a New Cluster Configuration

Specify information about the HPC resource.

To create a new cluster configuration:

1. In the navigation panel, under Configurations, click Cluster.

2. Click .

3. Specify the following settings:

Setting Description
Name The name that appears in the Cluster Configuration list. Do not use the name of
an existing configuration.
Host The machine that serves as the cluster submit host, where the scheduling software
is installed.

• If jobs will be submitted to the cluster submit host from any other machine, enter
the deployment machine name you set when activating the DCG portal (p. 3), even
if the machine on which you are currently working (the local machine) is the submit
host.

• If the machine on which you are currently working (the local machine) is the cluster
submit host, and jobs will not be submitted to it from any other machine, you can
enter localhost in this field.

Platform The operating system used by the cluster.

Use SSH Displayed when Linux is selected from the Platform drop-down list. Select this check
box to use the SSH protocol to submit jobs from a Windows DCG client to a remote
Linux submit host.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
22 of ANSYS, Inc. and its subsidiaries and affiliates.
 Configuring Clusters and Queues

Setting Description
HPC Type Select one of the following from the drop-down list:

• Windows HPC

• LSF

• PBS Pro

• TORQUE with Moab

• UGE (SGE)

• ARC (ANSYS Cluster)

Choose this option if you are not integrating with a third-party cluster or
Cloud portal.

• Custom

Custom Displayed when Custom is selected from the Platform drop-down list.
HPC Type
A keyword representing the HPC resource that you append to the file names of
your custom integration files. For more information, see RSM Custom Integration
in the Remote Solve Manager User’s Guide.
Parallel Displayed when UGE (SGE) is selected from the Platform drop-down list.
Environment
names Shared memory parallel processing distributes solve power over multiple
processors on the same machine. Distributed parallel processing distributes
solve power across multiple cores on a single node, or across multiple nodes.
For information on configuring parallel environments, consult the documentation
of the simulation product you are using.
Keep By default, job files are deleted from the HPC staging directory after the job has run.
staging Selecting Keep staging files may be useful for troubleshooting failed jobs. However,
files retained job files consume disk space, and require manual removal.
Local Use this option to optimize performance when one or both of the following is true:
Scratch
• There is a slower network connection between the cluster nodes and the HPC staging
directory.

• You are using a solver that produces numerous, relatively large files as part of the
solution and makes heavy use of local scratch space (for example, Mechanical solvers).

All input files are copied from the HPC staging directory into that local scratch
directory. Then, when the job finishes running, the requested output files
generated by the job is copied back to the HPC staging directory.

In the Local HPC Scratch Directory field, enter the local path of a scratch
directory on the cluster node (for example, C:\Shares\Local_Share\ScratchDir
on Windows). You can enter the path of the scratch directory manually or use
an environment variable in the format %VAR%.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 23
Defining Distributed Compute Gateway Configurations

Setting Description
If the cluster is running on Windows, you must create a network share path for
the local scratch directory on each node. In the Share path for Local Scratch
field, enter the network share path of the local scratch directory. This path starts
with a non-editable [ExecutionNode] variable. When a job is submitted, the
[ExecutionNode] variable is replaced with the actual machine name of each
execution node assigned to the job.

4. Click .

Editing a Cluster Configuration

You can edit an existing cluster configuration if required.

To edit a cluster configuration:

1. In the navigation panel, under Configurations, click Cluster.

2. In the row of the cluster configuration you want to edit, click [Edit].

3. In the Cluster Configurations dialog box, change the settings as appropriate.

4. Click .

Deleting a Cluster Configuration

If a cluster configuration is no longer required, you can delete it.

To delete a cluster configuration:

1. In the navigation panel, under Configurations, click Cluster.

2. In the row of the cluster configuration you want to remove, click [Delete].

3. In the Confirm dialog box, click .

Defining Queues
DCG queues are the queues that users see in client applications when they choose to submit jobs to
DCG. Queue names can match the names of queues or queueing mechanisms defined on the HPC
resource. The important thing to remember is that each DCG queue name must be unique.

There are two ways to define DCG queues: you can either import a list of HPC queues (p. 25) and
define an DCG queue for each HPC queue, or you can manually add a DCG queue (p. 25) and assign
an HPC queue to it.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
24 of ANSYS, Inc. and its subsidiaries and affiliates.
 Configuring Clusters and Queues

Adding a Queue
You can manually add a queue to the Queues list.

To add a queue:

1. In the navigation panel, under Configurations, click Cluster.

2. Under Queue Configurations, select a cluster configuration from the drop-down list.

3. Click .

4. In the DCG Queue field, specify a unique name for the queue.

5. In the HPC Queue field, enter the name of an existing HPC queue.

6. To set the queue as available for use, select the Enable check box.

7. To send a test job to the HPC resource using the associated HPC queue, click .

The status of the test (p. 26) is displayed.

8. Click .

Importing Queues
You can import a list of HPC queues into the Queues list.

To import queues:

1. In the navigation panel, under Configurations, click Cluster.

2. Under Queue Configurations, select a cluster configuration from the drop-down list.

3. Click Import.

4. In the row of the first imported HPC queue, click [Edit].

5. In the DCG Queue field, specify a unique name for the queue.

6. To set the queue as available for use, select the Enable check box.

7. To send a test job to the HPC resource using the associated HPC queue, click .

The status of the test (p. 26) is displayed.

8. Click .

9. Repeat steps 4 to 8 for each imported queue.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 25
Defining Distributed Compute Gateway Configurations

Enabling and Disabling a Queue

When you create a queue, it is available for selection in client applications when you select the Enable
check box in the Queue Configurations dialog box.

To control whether a queue is available for use after you create it, select or clear the queue’s Enabled
check box in the Queue Configurations list.

Testing a Queue
When you test a queue, DCG sends a test job to the HPC resource using the associated HPC queue.

To test a queue, click in the queue’s Test column.

Note:

Only enabled queues can be tested.

The status of the test is displayed in the Status column.

Job is being submitted and is in progress

Job is successful

Job has failed

Job status is unknown

Editing a Queue
You can edit an existing queue if required.

To edit a queue:

1. In the navigation panel, under Configurations, click Cluster.

2. Under Queue Configurations, select a cluster configuration from the drop-down list.

3. In the row of the queue you want to edit, click [Edit].

4. In the Queue Configurations dialog box, change the settings as appropriate.

5. Click .

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
26 of ANSYS, Inc. and its subsidiaries and affiliates.
 Configuring Clusters and Queues

Deleting a Queue
If a queue is no longer required, you can delete it.

To delete a queue:

1. In the navigation panel, under Configurations, click Cluster.

2. Under Queue Configurations, select a cluster configuration from the drop-down list.

3. In the row of the queue you want to remove, click [Delete].

4. In the Confirm dialog box, click .

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 27
 Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
28 of ANSYS, Inc. and its subsidiaries and affiliates.
Monitoring and Managing Jobs
You can submit solve jobs to Distributed Compute Gateway (DCG) from ANSYS Minerva, then monitor
and manage the jobs using the DCG portal.

To learn how to submit jobs in ANSYS Minerva, see the ANSYS Minerva User’s Guide.

Related Topics:
Viewing the Status of Jobs
Stopping a Job
Sharing a Job
Deleting a Job
Releasing a Job
Viewing Job Analytics, Transcripts, and Results
Managing Job Files

Viewing the Status of Jobs

To view details about your jobs as well as any jobs that have been shared with you, select My Jobs in
the navigation panel.

For a detailed look at what has happened or is currently happening behind the scenes for a selected
job, click the job in the job monitor. Alternatively, select the check box to the left of the job name and

click [Monitor the Job].

To refresh the information on the My Jobs page, click [Refresh].

Stopping a Job
When a solve job is running, you can stop the job on Distributed Compute Gateway (DCG) hardware
and close the associated solver session.

When you stop a job, its state becomes in the job monitor.

To stop a job:

1. In the navigation panel, click My Jobs.

2. Click the job to stop in the job monitor.

3. On the job view page, click [Stop].

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 29
Monitoring and Managing Jobs

The solution is stopped immediately without saving any data.

Sharing a Job
When you share a job that you submitted with other users, those users can monitor the job or view
information about it in the DCG portal.

To share a job:

1. In the navigation panel, click My Jobs.

2. Click the job to share in the job monitor.

3. On the job view page, click [Share Job].

4. Enter the user name of the user that you are sharing the job with.

5. Click .

The job appears on the user’s My Jobs page, in the Shared with me pane.

Viewing Job Share Information

You can see a list of users that a job is shared with.

To view job share information:

1. In the navigation panel, click My Jobs.

2. Click the job in the job monitor.

3. On the job view page, click [Information].

The job share details are displayed.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
30 of ANSYS, Inc. and its subsidiaries and affiliates.
 Releasing a Job

Deleting a Job
To free up data storage space or 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. In the navigation panel, click My Jobs.

2. To the left of the job name, select the check box of each job you want to delete.

3. Click .

4. Read the confirmation message to ensure that the jobs you selected are correct.

5. Click .

Releasing a Job
If jobs have been shared with you that you no longer need to monitor, you can remove them from your
shared list by releasing them.

To release a job:

1. In the navigation panel, click My Jobs.

2. To the left of the job name, select the check box of each job you want to release.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 31
Monitoring and Managing Jobs

3. Click .

4. Read the confirmation message to ensure that the jobs you selected are correct.

5. Click .

Viewing Job Analytics, Transcripts, and Results

When a solve job is submitted to Distributed Compute Gateway (DCG), job details and transactions are
reported live as they occur, allowing 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.

You can also view analytics and detailed event and debug logs where server transactions, system pro-
cesses, and error messages are recorded.

Related Topics:
Viewing Speed Analytics
Viewing Convergence Plots
Viewing the Job Log
Viewing the Debug Log
Viewing the Job Transcript
Viewing the Solver Log
Viewing the Job Command Log
Viewing the Event Log

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
32 of ANSYS, Inc. and its subsidiaries and affiliates.
 Viewing Job Analytics, Transcripts, and Results

Viewing Speed Analytics

You can see the length of time taken by Distributed Compute Gateway (DCG) to perform solver exe-
cution tasks.

1. In the navigation panel, click My Jobs.

2. Click the job in the job monitor.

3. 3. In the Monitoring tab, select Analytics from the Thread drop-down menu.

Viewing Convergence Plots

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

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

To view convergence plots:

1. In the navigation panel, click My Jobs.

2. Click the job in the job monitor.

3. In the Monitoring tab, select Convergence from the Thread drop-down menu.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 33
Monitoring and Managing Jobs

Tip:

To ensure that the complete curve is plotted, select All messages from the Display
drop-down menu.

4. 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

• z-velocity

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
34 of ANSYS, Inc. and its subsidiaries and affiliates.
 Viewing Job Analytics, Transcripts, and Results

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

You can also plot multiple curves on the same graph.

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

Viewing the Job Log

When a job is submitted to Distributed Compute Gateway (DCG), detailed information about the job
is captured in the job log.

To view the job log:

1. In the navigation panel, click My Jobs.

2. Click the job in the job monitor.

3. In the Monitoring tab, select DCG_JobLog from the Thread drop-down menu.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 35
Monitoring and Managing Jobs

Viewing the Debug Log

The debug log records server operations, system processes, and error messages. It includes an addi-
tional level of detail that is useful for diagnosing issues.

To view the debug log:

1. In the navigation panel, click My Jobs.

2. Click the job in the job monitor.

3. In the Monitoring tab, select Debug from the Thread drop-down menu.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
36 of ANSYS, Inc. and its subsidiaries and affiliates.
 Viewing Job Analytics, Transcripts, and Results

Viewing the Job Transcript

To view the job transcript:

1. In the navigation panel, click My Jobs.

2. Click the job in the job monitor.

3. In the Monitoring tab, select MainTranscript from the Thread drop-down menu.

Viewing the Solver Log

Each job submitted to Distributed Compute Gateway (DCG) is processed by one or more solving ap-
plications. The application produces a log file, providing a complete command record of the session.
This log file can be viewed in the DCG portal.

For details on what information the log contains, refer to the appropriate application documentation.
The example log shown here is for Mechanical APDL.

To view the solver log:

1. In the navigation panel, click My Jobs.

2. Click the job in the job monitor.

3. In the Monitoring tab, select solver name from the Thread drop-down menu.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 37
Monitoring and Managing Jobs

Viewing the Job Command Log

To view the job command log:

1. In the navigation panel, click My Jobs.

2. Click the job in the job monitor.

3. In the Monitoring tab, select job name from the Thread drop-down menu.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
38 of ANSYS, Inc. and its subsidiaries and affiliates.
 Viewing Job Analytics, Transcripts, and Results

Viewing the Event Log

The event log records server operations and system processes that occur when transactions are being
executed for a job.

To view the event log:

1. In the navigation panel, click My Jobs.

2. Click the job in the job monitor.

3. In the Monitoring tab, select WorkflowEventOrState from the Thread drop-down menu.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 39
Monitoring and Managing Jobs

Managing Job Files

For each job that you submit to Distributed Compute Gateway (DCG), associated input, monitoring,
and output files are written to a remote working directory. While the job is in progress, you can access
these folders and files in the DCG portal and download them.

After the job is complete, the job monitoring and output files are sent to ANSYS Minerva and the
working directory is erased.

To manage job files:

1. In the navigation panel, click My Jobs.

2. Click the running job in the job monitor.

3. Switch to the Files tab.

4. To download a file, in the Action column, click [Download].

Note:

This function is meant for downloading log files as the job is running. The maximum
file size you can download is 5 MB. To download larger input and result files, use ANSYS
Minerva.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
40 of ANSYS, Inc. and its subsidiaries and affiliates.
 Managing Job Files

To delete a file, in the Action column, click [Delete].

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 41
 Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
42 of ANSYS, Inc. and its subsidiaries and affiliates.
Distributed Compute Gateway Administration
If your user profile has administrative rights, you can manage roles for all Distributed Compute Gateway
(DCG) portal users. You can also manage all submitted jobs, not just your own or ones that have been
shared with you.

Related Topics:
Managing Roles
Managing Jobs

Managing Roles
You can control what aspects of the Distributed Compute Gateway (DCG) portal a user can access by
adding roles to or removing roles from their user profile.

To manage roles:

1. In the navigation panel, under Admin, click Identity Admin.

2. In the Username field, enter the domain name and user name of the profile you want to update.

3. Click .

The user profile is displayed.

4. In the Roles list, you can perform the following actions:

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 43
Distributed Compute Gateway Administration

• To remove a role, click [Delete] next to the role name.

• To add a role, type the name in the New role field and press Enter. You can select from the following
roles:

Role Functions
Admin – Configure storages (p. 19)

– Configure clusters and queues (p. 22)

– Monitor and manage jobs (p. 29) in the My Jobs page.

Developer – Configure storages (p. 19)

– Configure clusters and queues (p. 22)

– Monitor and manage jobs (p. 29) in the My Jobs page.

– Manage roles for all users (p. 43)

– View and stop jobs for all users (p. 45)

– Install and deploy DCG (p. 3)

SystemAdmin – Configure storages (p. 19)

– Configure clusters and queues (p. 22)

– Monitor and manage jobs (p. 29) in the My Jobs page.

– Manage roles for all users (p. 43)

– View and stop jobs for all users (p. 45)

User – View storages (p. 19) (cannot add, edit, or delete)

– View clusters and queues (p. 22) (cannot add, edit, or delete)

– Monitor and manage jobs (p. 29) in the My Jobs page.

Important:

A cached browser token can prevent role changes from being properly applied to a user
profile. If the user cannot access the expected DCG portal functions, first have them log
out of the portal and log back in. If this does not work, have them complete the following
steps:

1. Log out of the DCG portal.

2. Open the browser settings and clear cookies, site data, and cached images and files.

3. To ensure all of the data is deleted, close the browser then re-open it.

4. Log in to the DCG portal.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
44 of ANSYS, Inc. and its subsidiaries and affiliates.
 Managing Jobs

Managing Jobs
You can view all jobs submitted to Distributed Compute Gateway (DCG) by any user, and stop any job
currently running.

To manage jobs:

1. In the navigation panel, under Admin, click Jobs Admin.

2. Open the jobs view page for a job.

• To search for a specific job, type the session or job ID into the Job Id field and click .

The search results are displayed.

• To open the jobs view page from the Job list click the arrow to the left of the session ID.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 45
Distributed Compute Gateway Administration

3. To stop a running job (p. 29), click [Stop].

The solution is stopped immediately without saving any data.

4. To download debug logs, click .

A DebugLog.txt file is downloaded.

Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
46 of ANSYS, Inc. and its subsidiaries and affiliates.