Professional Documents
Culture Documents
ANSYS, Inc.
Southpointe
2600 ANSYS Drive
Canonsburg, PA 15317
ansysinfo@ansys.com
http://www.ansys.com
(T) 724-746-3304
(F) 724-514-9494
Release 16.0
January 2015
ANSYS, Inc. is
certified to ISO
9001:2008.
Disclaimer Notice
THIS ANSYS SOFTWARE PRODUCT AND PROGRAM DOCUMENTATION INCLUDE TRADE SECRETS AND ARE CONFIDENTIAL 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. is certified to ISO 9001:2008.
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, please contact ANSYS, Inc.
Published in the U.S.A.
Table of Contents
1. RSM Overview ......................................................................................................................................... 1
1.1. RSM Roles and Terminology .............................................................................................................. 1
1.2. Typical RSM Workflows ...................................................................................................................... 2
1.3. File Handling .................................................................................................................................... 4
1.4. RSM Integration with ANSYS Client Applications ................................................................................ 5
1.4.1. RSM Supported Solvers ............................................................................................................ 5
1.4.2. RSM Integration with Workbench ............................................................................................. 5
1.5. RSM Supported Third-Party Job Schedulers/Commercial Batch-Queuing Systems .............................. 6
2. RSM Installation and Configuration ....................................................................................................... 7
2.1. RSM Software Installation ................................................................................................................. 7
2.1.1. Installing a Standalone RSM Package ........................................................................................ 7
2.2. Using the RSM Setup Wizard ............................................................................................................. 8
2.3. RSM Service Installation and Configuration ....................................................................................... 9
2.3.1. Installing and Configuring RSM Services for Windows ............................................................... 9
2.3.1.1. Installing RSM Services for Windows .............................................................................. 10
2.3.2. Installing and Configuring RSM Services for Linux ................................................................... 11
2.3.2.1. Configuring RSM to Use a Remote Computing Mode for Linux ........................................ 11
2.3.2.2. Installing RSM Services for Linux .................................................................................... 12
2.3.2.2.1. Starting RSM Services Manually for Linux ............................................................... 12
2.3.2.2.1.1. Manually Running RSM Service Scripts for Linux ............................................ 13
2.3.2.2.2. Starting RSM Services Automatically at Boot Time for Linux ................................... 13
2.3.2.2.2.1. Installing RSM Automatic Startup (Daemon) Services for Linux ...................... 14
2.3.2.2.2.2. Working with RSM Automatic Startup (Daemon) Services for Linux ................ 15
2.3.2.3. Additional Linux Considerations .................................................................................... 16
2.3.3. Configuring a Multi-User RSM Manager or Compute Server ..................................................... 16
2.3.4. Configuring RSM for a Remote Computing Environment ......................................................... 17
2.3.4.1. Adding a Remote Connection to an RSM Manager .......................................................... 17
2.3.4.2. Adding a Remote Connection to a Compute Server ........................................................ 18
2.3.4.3. Configuring Computers with Multiple Network Interface Cards (NIC) .............................. 18
2.3.5. Configuring a Network Installation ......................................................................................... 19
2.4. Setting Up RSM File Transfers .......................................................................................................... 19
2.4.1. Operating System File Transfer Utilizing Network Shares ......................................................... 19
2.4.1.1. Windows-to-Windows File Transfer ................................................................................. 21
2.4.1.2. Linux-to-Linux File Transfer ............................................................................................ 22
2.4.1.3. Windows-to-Linux File Transfer ...................................................................................... 22
2.4.1.3.1. Additional Windows-to-Linux Configuration When Using Alternate Accounts ......... 23
2.4.1.4. Verifying OS Copy File Transfers ...................................................................................... 25
2.4.2. Eliminating File Transfers by Utilizing a Common Network Share ............................................. 25
2.4.3. Native RSM File Transfer .......................................................................................................... 27
2.4.4. SSH File Transfer ..................................................................................................................... 27
2.4.5. Custom Client Integration ...................................................................................................... 27
2.5. Accessing the RSM Database Configuration File ............................................................................... 27
2.6. Uninstalling RSM ............................................................................................................................. 28
2.6.1. Uninstall a Standalone RSM Package Manually ........................................................................ 28
2.6.1.1. Uninstalling RSM Services for Windows .......................................................................... 28
2.6.1.2. Manually Uninstalling RSM Services for Linux ................................................................. 29
2.6.1.2.1. Uninstalling RSM Automatic Startup (Daemon) Services for Linux .......................... 29
3. RSM User Interface ................................................................................................................................ 31
3.1. RSM Main Window .......................................................................................................................... 32
3.2. Menu Bar ........................................................................................................................................ 32
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
iii
iv
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
vi
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
RSM Overview
Once Compute Servers are configured, they are added to a queue (which can contain multiple
Compute Servers). Jobs must specify a queue when they are submitted to a Manager.
RSM Manager
The RSM Manager (also called the Solve Manager) is the central RSM service that dispatches jobs to
computing resources. It contains a configuration of queues (lists of Compute Servers available to run jobs).
RSM Clients submit jobs to one or more queues configured for the RSM Manager, and their jobs
are dispatched to Compute Servers as resources become available.
The RSM administrator decides if users should use the RSM Manager on their local machine or a
central RSM Manager, depending on the number of users and compute resources.
RSM Client
The RSM Client is a computer that runs both RSM and a client application such as ANSYS Workbench. RSM
enables this computer to off-load jobs to a selected queue.
Code Template
A code template is an XML file containing code files (for example, C#, VB, JScript), references, and support
files required by a job. For more information on code templates, see Job Templates.
2. The RSM Client submits jobs to the RSM Manager running locally on the same machine. You can assign a
remote Compute Server to run the job or split the job between multiple Compute Servers, optionally including your local machine (as depicted in the second workflow below). A remote Compute Server requires
RSM and the client application to be installed (the client application is typically installed with ANSYS
Workbench, which also includes RSM).
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
3. An RSM Client machine submits jobs to an RSM Manager running on a remote machine (refer to Adding a
Remote Connection to an RSM Manager (p. 17)). The remote machine also acts as the Compute Server.
This configuration is available automatically when both machines have ANSYS Workbench installed.
4. An RSM Client machine submits jobs to an RSM Manager running on a remote machine. The RSM Manager
then assigns the job to a remote Compute Server(s). The RSM Client and the Compute Servers must have
ANSYS Workbench installed. You can install ANSYS Workbench on the RSM Manager, or choose to install
only standalone RSM software, as described in RSM Software Installation (p. 7).
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
RSM Overview
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
RSM Overview
on multiple machines, you need to ensure that the software that controls the parallel processing is supported
on all of the Compute Servers.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Note
When you install a standalone RSM package, this does not mean that RSM services are installed
at the same time; you still need to install or start up necessary RSM services. For instructions,
see Installing RSM Services for Windows or Installing RSM Services for Linux.
Note
The creation of shared directories needed for use with a commercial cluster is performed
as part of the Wizard configuration.
To start RSM services when UAC is enabled on Windows 7, you must launch the wizard
using the right-click Run as administrator menu option. For instructions on enabling
or disabling UAC, see RSM Troubleshooting (p. 105).
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Note
RSM services cannot be started from a network installation. It is recommended that you install
RSM on a local machine.
For GPU requirements when Windows is installed as a service, see Requirements for the GPU
Accelerator in Mechanical APDL in the ANSYS, Inc. Installation Guide for Windows.
Note
Windows 7 users may need to select the Run as administrator option.
10
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Important
If you change any system environment variables, you must restart the RSM services in order
for the changes to take effect. If you change your user environment variables, make sure
that you end your Ans.Rsm.UPHost.exe processes (if any) on the affected machine before
trying to run jobs again.
SSH communication
Protocol Type
Installation
Requirements
Data Transfer
Efficiency
Platform Support
ANSYS recommends that you use native communication where possible, and use SSH where platform
support or IT policy requires it.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
11
12
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
13
Note
The RSM daemon service installation will only create the rsmadmin user account if the account
does not already exist. The same is true for the rsmadmins user group if the group name does
not exist. The account/group will be created locally on the computer on which the RSM service(s)
will be run. If you want the account/group to be managed in the master server by Network Information Service (NIS), you need to ask your IT department to create an rsmadmin user account
and rsmadmins group from NIS before running RSM daemon service scripts.
When an RSM package is installed under a directory, make sure that all its parent directories (not
the files in the directory) have both read and execution permissions so that the RSM service executable can be started by a non-root user.
14
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Once the daemon service is installed, the RSM service will be started automatically without rebooting.
The next time when the machine is rebooted, the installed RSM service will be started automatically.
Verifying the RSM Daemon Installation
To verify that the automatic boot procedure is working correctly, reboot the system and check to see
that the services are running by typing the appropriate ps command and looking for Ans.Rsm in the
resulting display:
ps aux | grep Ans.Rsm
2.3.2.2.2.2. Working with RSM Automatic Startup (Daemon) Services for Linux
Once an RSM daemon service is configured, any user can check the status of the service. System administrators can also start or restart the service.
Stopping the Daemon Service
To stop the daemon service:
./etc/init.d/rsmmanager160 stop
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
15
Important
If you change any system environment variables, you must restart the RSM services in order
for the changes to take effect. If you change your user environment variables, make sure
that you end your Ans.Rsm.UPHost.exe processes (if any) on the affected machine before
trying to run jobs again.
Note
~ (tilde) representation of the home directory is not supported for use in RSM paths (for example,
the Working Directory Path in the Compute Server Properties dialog box).
Different shells use different initialization files than the account's home directory and may have
a different syntax than shown above. Refer to the Linux man page for the specific shell or consult
the machine administrator.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Note
When communicating with a remote computer, whether RSM Client to RSM Manager or RSM
Manager to Compute Server, RSM services must be installed on those computers.
Launch RSM.
2.
In the RSM main window select Tools > Options. The Options dialog box appears.
3.
In the Name field, enter the name of a remote machine with the RSM Manager service installed.
4.
Select the Add button and then OK. The RSM Manager and all of its queues and Compute Servers appear
in the tree view.
5.
Passwords are cached on the RSM Manager machine, so you must set the password again. Refer to
Working with Account Passwords (p. 54) for this procedure.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
17
/>
The correct IP address is the address seen in the output of a ping program from any remote machine
to this machine using the Fully Qualified Domain Name (FQDN).
3. Save the file.
4. Restart the following services: ANSYS JobManager Service V16.0 and ANSYS ScriptHost
Service V16.0.
For Windows: On your Administrative Tools or Administrative Services page, open the Services dialog
box. Restart the services by right-clicking on the service and selecting Restart.
For Linux: Log into a Linux account with administrative privileges and ensure that Ans.Rsm.* processes
are not running. Open a terminal window in the [RSMInstall]/Config/tools/linux directory
and run the following commands:
./rsmmanager restart
./rsmserver restart
18
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
19
Once the configuration is complete, the RSM Client machine should be able to access the Project Directory on the RSM Manager machine and the RSM Manager machine should be able to access the
Working Directory on the remote Compute Server machine. The OS Copy operation will be used
automatically for file transfers.
If two RSM services are on the same machine, no configuration is necessary for OS Copy to function
between those two services. For example, in an RSM layout where the RSM Manager and Compute
Server are on the same machine, the Client is running on a separate machine, the RSM Manager can
access the Working Directory, as long as the permissions are set to allow it. In this case, the only other
20
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Note
For the sake of general applicability, the configuration instructions in the following sections
assume an RSM layout in which each service runs on a separate machine. In a typical environment, however, ANSYS suggests that the RSM Manager and Compute Server be on the
same machine.
Related Topics:
2.4.1.1. Windows-to-Windows File Transfer
2.4.1.2. Linux-to-Linux File Transfer
2.4.1.3. Windows-to-Linux File Transfer
2.4.1.4. Verifying OS Copy File Transfers
21
Note
Once target directory is shared, you can access it by typing the share path into
Windows Explorer.
22
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Note
The locations of files and method of restarting the Samba service may vary for different Linux
versions.
Verify that the Samba shares are accessible by your Windows machine, indicating that they have been
properly set up. Check this by using Windows Explorer and navigating to the locations shown below
(using your specific machine name in place of linuxmachinename):
\\linuxmachinename\RSM_Mgr for the Project Directory on the RSM Manager machine
\\linuxmachinename\RSM_CS for the Working Directory on the Compute Server machine
Permission Issues
Permission issues can occur when an alternate account is used to run jobs on the Linux side. To resolve
such issues, make sure that Samba (or a similar Linux utility) is correctly configured.
The following code sample is from the Samba configuration file, smb.conf, showing a configuration
for file sharing between three accounts:
A Windows account mapped to a Linux account
An alternate account
An account that runs as the RSM service
[RSM_CS]
path = /lsf/wbtest
browseable = yes
writable = yes
create mode = 0666
directory mode = 0777
guest ok = no
create mode:
The Samba default is 664, which corresponds to rw-rw-r--. If the alternate account is not in the same group
as the owner of the file, the job cannot write to the file and an error occurs for files that are both inputs
and outputs.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
23
Note
The locations of files and method of restarting the Samba service may vary for different Linux
versions.
User-specific Shares
Home Directory Shares
In order to use the home directory for each user as the share, a specific path variable (%H) must be used
for the shares. This is illustrated in the example below.
[RSM_CS]
path = %H/rsmtemp
browseable = yes
writable = yes
create mode = 0700
directory mode = 0700
guest ok = no
The %H path variable represents the entire home directory path. For normal use, it is recommended
that users create a subdirectory in their home directory (for example, rsmtemp) to prevent the home
directory from becoming cluttered with ANSYS solve directories, and to facilitate the cleanup of cancelled
jobs or jobs that need to be kept for some time.
Generic User Directory Shares
If for some reason you do not want to use the home directory, you can create and use another directory
provided that there is a folder for each user in the directory. In this case, the path variable %u is used,
as shown in the example below.
[RSM_CS]
path = /ansysTemp/users/%u/rsmJobs
browseable = yes
writable = yes
create mode = 0700
directory mode = 0700
guest ok = no
The $u path variable represents a users username. Therefore, the name of each folder in the chosen
directory must match the username exactly.
24
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
25
Example: You can set up RSM to use file shares in order to remove unnecessary file transfers. For example,
you might have a Linux share \usr\user_name\MyProjectFiles\, and have that same folder
shared via Samba or a similar method and mounted on the Windows Client machine as Z:\MyProjectFiles\. If you save your Workbench projects to this network location, you can set the RSM
Manager and Compute Server properties as follows in order to remove all file transfers and use the
network share directly as the working directory:
RSM Manager
For a Linux-based RSM Manager, set the Project Directory Location property to
\user\user_name\MyProjectFiles\.
For a Windows-based RSM Manager, set the Project Directory Location property to Z:\MyProjectFiles\.
Compute Server
For a Linux-based Compute Server, set the Working Directory Location property to
\user\user_name\MyProjectFiles\.
For a Windows-based Compute Server, set the Working Directory Location property to
Z:\MyProjectFiles\.
In some cases, you might still want a separate Working Directory and/or Project Directory and thus,
would not define the corresponding network file share(s) as described above. For example, if the jobs
26
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
27
Note
For a user who can log on from different machines, the system must already be configured
to use the Roaming profile.
28
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Uninstalling RSM
5. Run the command.
Note
If you are using a Windows 7 operating system, you may need to select the Run as administrator option from the right-click context menu.
The uninstaller can only stop services which were started by and are owned by the user performing the uninstall.
6. After the services have been uninstalled, delete the RSM installation directory.
Note
The uninstaller can only stop services which were started by and are owned by the user
performing the uninstall.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
29
The example below shows the command line used to uninstall RSM Manager and Compute Server service
daemons via the uninstall_daemon script.
tools/linux#> ./uninstall_daemon -mgr -svr
Important
The service account and group cannot be deleted if one or more RSM services are still being
run by that user account and service group name. You will be prompted to answer Yes or
No from the above command when there is no service is being run by these accounts and
RSM is trying to delete them.
30
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Note
On Linux platforms, if you are re-launching a running RSM window after it has been closed
or minimized, the default Linux window management behavior applies. The RSM window
will open behind an active application rather than stealing focus.
You can change this behavior in either of the following ways:
In RSM, select View > Always On Top. When maximized, the RSM window will remain on top
of all other application windows.
If you are using KDE, access your Window Behavior settings and set the Focus stealing prevention level to None.
This chapter describes the following features of the RSM user interface:
3.1. RSM Main Window
3.2. Menu Bar
3.3.Toolbar
3.4.Tree View
3.5. List View
3.6. Status Bar
3.7. Job Log View
3.8. Options Dialog Box
3.9. Desktop Alert
3.10. Accounts Dialog
3.11.Test [computeserver] Dialog
3.12. RSM Notification Icon and Context Menu
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
31
Interface
Element
Description
Menu Bar
Provides access to the following menus: File, View, Tools, and Help.
Toolbar
Contains the following tools, from left to right: the Show drop-down and
three icons: Remove, All Owner Jobs, and Job Log.
Tree View
Displays defined RSM Managers, along with the Queues and Compute
Servers configured for each.
List View
Displays a listing of current jobs. You can delete jobs from this area
by selecting one or more jobs from the list and selecting Remove
from the context menu.
Job Log
View
Displays the progress and log messages for the job selected in the
List view.
Status Bar
Selections
Function
File
Minimize
to System
Tray
Exit
32
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Menu Bar
Alternatively, you can right-click the RSM icon in the
notification area (or system tray
from in the context menu.
View
All Owner
Jobs
Job Log
Refresh
Now
Update
Speed
Tools
Help
Always On
Top
Hide When
Minimized
Desktop
Alert
Remove
Submit a
Job
Options
ANSYS
Remote
Solve
Manager
Help
About
ANSYS
Remote
Solve
Manager
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
33
3.3. Toolbar
The toolbar provides the following functions:
Tool
Selections
Function
Show
All
Jobs
Completed
Running
Queued
Failed
Cancelled
Remove
Not
applicable.
All Owner
Jobs
Selected or
deselected.
Job Log
Selected or
deselected.
This icon allows you to display or hide the Job Log view.
The function is the same as using the View > Job Log
option in the menu bar.
34
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Tree View
The Queues node for an RSM Manager contains all of the queues that have been defined for that RSM
Manager. You can expand a Queue to view the Queue Compute Servers associated with it; these are the
Compute Servers that have been assigned to the Queue (that is, the machines to which the RSM Manager
will send queued jobs for processing).
The Compute Servers node contains all of the Compute Servers associated with the RSM Manager; these
are the machines that are available to be assigned to a Queue and to which jobs can be sent for processing.
Note
If you disable an RSM Manager, Queue, or Compute Server, it will be grayed out on the Tree view.
For information on disabling RSM Managers, see Options Dialog Box (p. 40).
For information on disabling Queues, see Creating a Queue (p. 61).
For information on disabling Compute Servers, see Adding a Compute Server (p. 64).
If a connection cannot be made with an RSM Manager, the RSM Manager will be preceded by a
red X icon.
For information on testing RSM Managers, see Testing a Compute Server (p. 73).
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
35
When a queue is selected, the Properties and Delete options are available in the context menu.
When a Compute Server is selected under a Queues node or under a Compute Servers node, the
Properties, Test, and Advanced Test options are available. The Delete option becomes available if a
Compute Server that is not assigned to any queue is selected under a Compute Servers node, as shown
in the image on the right below.
When a Compute Servers node is selected, only the Add option is available.
36
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
List View
For more information on using the Tree view context menu options, see RSM Administration (p. 59).
Note
If a job is still running, you cannot remove it. Use either the Abort or the Interrupt option
in the List view context menu. Once the job Status changes to either Finished or Canceled,
you can click the Remove button to delete the job. The Interrupt command allows a job to
clean up the processes it has spawned before termination; the Abort command terminates
the job immediately. There may also be a job stopping option in the client application that
submitted the job (for example, ANSYS Workbench Mechanical Stop Solution command).
There may also be a disconnect option in the client application that submitted the job (for
example, the ANSYS Workbench Mechanical Disconnect Job from RSM command).
Function
Inquire
Inquire about a running job. This action depends on the type of job
being run.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
37
Interrupt
Remove
Deletes the selected job or jobs from the List view. Enabled only if a
completed job is selected.
Cannot be used on a running job. It functions in the same way as the
Tools > Remove option in the menu bar.
Set Priority
Allows you to set the submission priority for the selected job or jobs.
When jobs are submitted they have a default priority of Normal.
Enabled only for jobs with a Status of Queued.
The higher priority jobs in a queue run first. To change the priority of
a Queued job, right-click the job name, select Set Priority and change
the priority. Only RSM administrators can change a job priority to the
highest level.
The status of each job displayed in the List view is indicated by the Status column and an icon. For
jobs that have completed, the Status column and an icon indicate the final status of the job; the addition
of an asterisk (*) to the final status icon indicates that the job has been released.
Status
Description
Input
Pending
Queued
Running
Job is running.
Cancelled
Icon
38
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Released Icon
Failed
Description
Copy
Select All
Home
End
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
39
This option allows you to generate a Job Report for the job item selected
from the RSM List view. Enabled when the job has completed (that is, has a
final Status of Finished, Failed, or Cancelled).
The Job Report will include job details and the contents of the job log shown
in Job Log view. When generating the report, you can specify the following
report preferences:
Include Debug Messages: whether debugging messages are included in the
Job Report
Include Log Time Stamp: whether a log time stamp is included in the Job Report
Include Line Numbering: whether line numbering will be displayed on the Job
Report
Click the Browse button to select the directory to which the report will be
saved, type in report filename (RSMJob.html by default), select the report
format (HTML or text format), and click Save.
Line Numbering
Enable or disable the display of line numbers in the Job Log view. Right-click
inside the inside the Job Log view and select or deselect Line Numbering
from the context menu.
Time Stamp
Enable or disable the display of the time stamp for each line in the Job Log
view. Right-click inside the Job Log view and select or deselect Time Stamp
from the context menu.
Debug Messages
Note
When making a support call concerning RSM functionality, send the RSM job report. Note
the HTML-format job report uses color highlighting by row to distinguish the Job Log view
contents from other information, which can be helpful for troubleshooting.
40
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Desktop Alert
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
41
The Add Primary Account button allows you to define primary accounts for RSM.
When you right-click an existing account, the following context menu options are available:
Option
42
Function
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Change Password
Remove
For more detailed information on working with accounts in RSM, see RSM User Accounts and Passwords (p. 47).
By default, the RSM icon and its tooltip are static. You can, however, configure the icon and tooltip to
provide feedback on the current status of jobs. You can configure this behavior in the
Ans.Rsm.AppSettings.config file.
If you configure the icon to provide feedback, its appearance will vary according to the current status
of jobs:
Notification
Icon
Job Status
No jobs are running.
At least one job is running.
At least one job has failed.
All jobs have completed.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
43
Note
In Windows, the tooltip window has a 63-character limit. If this limit is exceeded, the current
status of jobs will not be displayed.
Go to the [ANSYS 16.0 Install]/RSM/Config folder and open the Ans.Rsm.AppSettings.config file in a text editor.
2.
3.
Set the value to one of the following to indicate the desired behavior:
None. (default) The icon and tooltip do not change or provide feedback on the current status of jobs.
Icon. Only the icon changes based on the status of jobs.
IconAndToolTip. Both the icon and tooltip change based on the status of jobs.
Menu
Option
Description
Options
44
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Description
Functions in the same way as Tools > Options on the menu bar.
Help
About
All Owner
Jobs
Desktop
Alert
Enables/disables the desktop alert window (see Desktop Alert (p. 41)).
Works in conjunction with the Tools > Desktop Alert option in the
menu bar.
Open Job
Status
Exit
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
45
46
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
47
Note
To create the RSM Admins user group and add users:
1. Right-click Computer and select Manage.
2. On the Computer Management dialog box, expand Local Users and Groups.
3. Right-click the Groups folder and select New Group.
4. On the New Group dialog box, enter RSM Admins as the Group Name and add members
by clicking the Add button.
5. On the Select Users, Computers, Service Accounts, or Groups dialog box:
Type in user names.
Click the Check Names button to check and select each name.
6. Click the Create button to create the new group.
RSM Non-Administrative Privileges If you are not a member of the RSM Admins user group, you
do not have administrative privileges for RSM. You can use the Accounts dialog box to perform the
following tasks:
Add or remove your own primary and alternate accounts
Change the passwords for your own accounts
Change the assignment of Compute Servers to your own alternate account
48
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Primary Account:
This is the main account used to communicate with RSMtypically, the account used with the client
application (ANSYS Workbench) on the RSM Client machine. By default, a primary account allows the
user to send jobs via RSM to all of the Compute Servers.
Your RSM privileges determine whether you can create and edit accounts for other users, or only for
yourself. For details, see Required Permissions for Creating and Modifying User Accounts (p. 49).
Alternate Account:
An alternate account is necessary when a remote Compute Server machine does not recognize the
primary account you are using on the Client machine. By defining an alternate account that is associated
with your primary account, you can send jobs from your primary account (on the Client) to be run under
your alternate account (on the remote Compute Server).
Example: You are using your primary account to submit jobs from a Windows Client to a remote Linux
Compute Server, but the Compute Server does not recognize your Windows-based primary account.
To send jobs to that Compute Server, you need to create an alternate account that will be recognized
and then submit your jobs under that account.
Multiple alternate accounts can be created for each primary account; a primary account with one or
more alternate accounts is called an owner account.
Note that manager (localhost) must also be assigned to an alternate account if the primary account
cannot access the manager machine.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
49
50
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
3. In the Adding Primary Account dialog box, specify account user name and password.
Enter a user name for the account (in our example, username_02).
If a primary account has not been defined for the user name youve used to log into your machine,
the User Name field will be populated with your current user name and will be read-only.
Enter and verify the password for the account. See Working with Account Passwords (p. 54) for details.
Click OK.
4. Back in the Accounts dialog box, the new primary account has been added to the Accounts list.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
51
Note
You can create primary accounts for other users only via the Accounts dialog box, as described
above. You can create primary accounts for yourself via the Accounts dialog box or either of the
following methods:
Run the RSM password application manually. For details, see Manually Running the Password
Application (p. 57).
In Workbench, select Tools > Enter Credentials for Remote Solve Manager. For details, see
Entering Credentials for Your RSM Alternate Accounts in the Workbench User's Guide.
If the primary account cannot access a Compute Server or the manager machine, you must assign
it to an alternate account. See Adding Alternate Accounts (p. 52).
Important
You will need to create an alternate account on a Windows RSM Manager when integrating
it with a Linux Compute Server, so that the Windows Manager can run the job on the Linux
Compute Server using the correct Linux credentials.
To add an alternate account to a primary account:
1. In the Accounts dialog box, right-click the primary account and select Add Alternate Account.
52
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
3. Back in the Accounts dialog box, specify the Compute Servers to which the new alternate account will
have access.
In the Alternates list, select the newly created alternate account.
In the Compute Servers list, select the check box for each Compute Server to which the account will
send jobs. (In our example, weve selected three test servers for alternate account un02_alltest).
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
53
Note
Each alternate account can have access to a different combination of Compute Servers,
but each Compute Server can only be associated with one alternate account at a time.
Click Done.
In the RSM Accounts dialog box, select a primary account to view its alternate accounts. Select an alternate account to view the Compute Servers to which it can send jobs.
Note
It is also possible to add alternate accounts via either of the following methods:
Run the RSM password application manually. For details, see Manually Running the Password
Application (p. 57).
In Workbench, select Tools > Enter Credentials for Remote Solve Manager. For details,
see Entering Credentials for Your RSM Alternate Accounts in the Workbench User's Guide.
54
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Note
It is not necessary to cache your password with the RSM Manager in the following situations:
The Client and RSM Manager are the same machine.
You are using RSM only for local background jobs.
Youve created a new account via the Accounts dialog box. When you set the password
during the creation of the account, it is automatically cached with RSM. The RSM Manager
encrypts and stores the password in a list of registered accounts.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
55
Note
It is also possible to set a password via either of the following methods:
Run the RSM password application manually. For details, see Manually Running the Password
Application (p. 57).
In Workbench, select Tools > Enter Credentials for Remote Solve Manager. For details,
see Entering Credentials for Your RSM Alternate Accounts in the Workbench User's Guide.
Note
It is also possible to change a password via either of the following methods:
In RSM, use the right-click menu to open the Set Password dialog box. If the password is
already set, entering a password into this dialog box changes the password.
Run the RSM password application manually. For details, see Manually Running the Password
Application (p. 57).
In Workbench, select Tools > Enter Credentials for Remote Solve Manager. For details,
see Entering Credentials for Your RSM Alternate Accounts in the Workbench User's Guide.
56
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Note
The rsmpassword shell script depends on its relative location in the Workbench installation; it should not be moved.
Alternate accounts are typically added to the owner account via the Accounts dialog box, but can also
be manually added and edited by running the password application. In the example below, DOMAIN\johnd is the owner account and johndoe is an alternate account to be used on a Compute
Server specified in the Accounts dialog box.
Setting password for primary (default), alternate or new alternate account.
Existing alternate accounts:
johndoe
Enter user name (DOMAIN\johnd):johndoe
Enter password for DOMAIN\johnd: ********
Re-enter password: ********
Password set for johndoe:
Your password has been encrypted and stored.
It can only be decrypted and used to run jobs on behalf of DOMAIN\johnd.
57
58
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Note
In both of the above cases, the RSM services ANSYS JobManager Service V16.0 and
ANSYS ScriptHost Service V16.0 may need to be restarted in order for administrator
privileges to take effect.
RSM configuration data, including the configurations for the RSM Manager, Compute Servers, and
queues, is stored in the RSM.Config file. For details, see Accessing the RSM Database Configuration
File (p. 27).
The following RSM administration tasks are discussed in this section:
5.1. Automating Administrative Tasks with the RSM Setup Wizard
5.2. Working with RSM Administration Scripts
5.3. Creating a Queue
5.4. Modifying RSM Manager Properties
5.5. Adding a Compute Server
5.6.Testing a Compute Server
59
RSM Administration
For information on using the wizard, see Using the RSM Setup Wizard (p. 8).
Note
In order to use the -migrate vVer command, you must first start the RSM Manager
service or process.
The migration can also be achieved by running the RSM Setup wizard to set up RSM
as a SYSTEM user and then running the rsm.exe migrate vVer command via
the command prompt.
C:\Program Files\ANSYS Inc\v160\RSM\bin>rsm.exe
Usage: rsm.exe [-m manager|machine][-clr]
[-c configFile|-s configFile|-migrate vVer]
[-stop mgr|svr|xmlrpc|all [-cancel]][-status mgr|svr]
-m manager:
RSM Manager machine (default = localhost).
-c configFile:
File containing Queues and Servers.
-s configFile:
File to save Queues and Servers.
-clr:
Clear Queues and Servers.
If used with -c, clears before configure.
-stop mgr|svr|xmlrpc|all: Stop RSM services, where:
mgr = Manager, svr = ScriptHost,
xmlrpc = XmlRpc Server, all = All three.
-cancel
Cancel all active Jobs. For use with -stop.
-status mgr|svr:
Query Manager and ScriptHost on localhost or use -m option.
-migrate vVer:
Migrate database from previous version (ex. v145).
Can be used with -clr.
60
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Creating a Queue
For Linux, you can open the main RSM window by running the rsmutils shell script, located in
the [RSMInstall]\Config\tools\linux directory. The rsmutils shell script has the same
command options noted above for Windows.
Note
The Linux shell scripts are dependent on their relative location in the ANSYS Workbench installation, so cannot be moved.
Description
Name
61
RSM Administration
Enabled
Priority
Assigned
Servers
Select the check box for each Compute Server to be used in this
queue. A queue can contain more than one Compute Server. A
Compute Server can also be a member of more than one queue.
3. Modify RSM Manager properties described below, and then click OK.
The table below lists the editable fields on the Solve Manager Properties dialog box:
Property
62
Description
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
The length of time (in D.H:MM:SS format) that a job remains in the list
view based on its status. You can set a different time period for
finished, failed, and cancelled jobs. For example, you may want to set
a longer time period for jobs that have failed so that you have ample
time to troubleshoot them, and a shorter time period for jobs that
have finished successfully to prevent an excessive number of jobs
from accumulating in the list view.
Clearing out jobs in a timely manner improves the performance of
the RSM Manager and optimizes memory usage.
Default values are as follows:
Finished jobs: 02:00:00 (2 hours)
Failed jobs: 1.00:00:00 (1 day)
Cancelled jobs: 00:10:00 (10 minutes)
When specifying a time period, the following values are acceptable:
D (days) = integer indicating the number of days
H (hours) = 023
MM (minutes) = 059
SS (seconds) = 059
You can enter only the number of days (without the zeros), only the
hours/minutes/seconds, or both.
Examples:
1.00:00:00 or 1 = one day.
1.12:00:00 = 1.5 days
02:30:00 = 2.5 hours
00.15.00 = 15 minutes
Project
Directory
The base location where the RSM Manager stores input and output
files for a job. As jobs are created, a unique subdirectory for each job
is created in the Project Directory.
When defining the location of your Project Directory, you can enter
either a path or an environment variable in the format %VAR%. If you
enter a path to a base location that does not exist on the RSM Manager
machine, RSM will automatically create the path on the machine. This
location can be either on the local disk of the RSM Manager machine
or on a network share.
Example of local absolute path: E:\Users\username\work\cfdproj
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
63
RSM Administration
Example of network share path: \\fileserver\RSMProjects
Example of environment variable: %HOME%\Projects
When a job is stopped abruptly rather than released (for instance, via
the Abort option in the right-click context menu of the List view) or
is not released immediately, you may need to take additional steps
to ensure that its files are deleted from the Project Directory on the
RSM Manager. You can ensure that job-specific files are deleted by
one of the following two methods:
Remove the job from the List view. You can do this by right-clicking
the job and selecting Remove from the context menu. Alternatively,
you can highlight the job and either select the Tools > Remove
option or press the Delete key.
Configure the system to remove the files automatically by setting
the Job Cleanup Property in the Solve Manager Properties dialog
box.
Compression The threshold at which files are compressed prior to transfer.
Threshold
There is always a trade-off between the time it takes to
compress/decompress versus the time to transfer. The appropriate
value depends on the specific network environment. Enter a value of
0 to disable compression.
Example: If you set this value to 50, files greater than 50 MB will be
compressed before being sent over the network.
In the RSM Manager tree view, right-click the Compute Servers node under the machine you are designating as the RSM Manager.
2.
Select Add from the context menu. The Compute Server Properties dialog box displays.
64
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Note
If you do not have permissions to a Compute Server machine (that is, you have not set your
account password in RSM for the Manager node), you cannot add the machine as a Compute
Server or edit its properties. For instructions on setting your password, see Working with
Account Passwords (p. 54).
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
65
RSM Administration
Examples of machine names for remote machines are comp1, comp1.win.domain.com, and
100.10.87.465.
This Compute Server is integrating with an HPC cluster
Specify whether the Compute Server being defined will be integrated with a cluster.
What is the role of [machinename]?*
Displays only when the Compute Server is not being integrated with a cluster.
Specify the role of the Compute Server being configured. Available options are:
Performs Computational Work: RSM jobs are actually executed on the Compute Server.
Communicates with remote computer which performs the work (e.g. SSH): The Compute
Server does not actually execute the jobs, but communicates with the machine that does via SSH
or another external (non-RSM) method.
How does [machinename] communicate with the cluster?*
Displays only when the Compute Server is being integrated with a cluster.
Specify the method of communication to be used between the Compute Server and the cluster.
Available options are:
Able to directly submit and monitor cluster jobs: The Compute Server can submit and monitor
cluster jobs directly, so files are transferred via network share or reuse of the Client or RSM Manager
directory that is shared to the cluster.
Uses non-RSM communication to a remote cluster node (e.g. SSH): The Compute Server requires
SSH to communicate with the node in the cluster. Files can be transferred by network share, reusing
the Client or RSM Manager shared directory, or an external mechanism (SSH).
Working Directory Location*
The Working Directory houses temporary job directories that are created by the Compute Server when
jobs are run. These job directories contain job scripts and solution files. This property specifies how the
location of the Working Directory is determined. This property may or may not be automatically determined
depending on how cluster and file management settings have been defined.
Possible options are:
66
User Specified
Shared Cluster
Directory
Signifies that the Compute Server working directory is the same as the
Shared Cluster Directory specified on the File Management tab.
Cluster Network
Share
Signifies that the Compute Server working directory is the same as what
is specified in the Cluster Network Share field under the Existing
Network Share option on the File Management tab. This is used in a
clustered setup when Uses non-RSM communication to remote cluster
node (e.g. SSH) is selected.
Network Share
Signifies that the Compute Server working directory is the same as what
is specified in the Network Share field under the Existing Network
Share option on the File Management tab. This is used in a
non-clustered setup when Communicates with a remote computer
which performs the work (e.g. SSH) is selected.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Specifies that you want to reuse the RSM Manager's project storage
directory as the working directory.
The choice between User Specified and Reuse Manager Storage exists only when the Compute
Server is the same as the RSM Manager machine, and either:
The role of the Compute Server is set to Performs Computational Work, which means that jobs will
run on the same machine as the RSM Manager.
or
The role of the Compute Server is set to Communicates with a remote computer which performs the
work (e.g. SSH), and the file transfer method on the File Management tab is not set to Existing Network
Share (Samba, CIFS, NSF).
If the Compute Server is not the same as the RSM Manager machine, but either of the above conditions is true, then only the User Specified option is available.
Otherwise, this property is automatically preset to either Shared Cluster Directory, Cluster Network
Share or Network Share according to the file transfer method and settings specified on the File
Management tab, and whether or not the Compute Server is used to run cluster jobs.
Working Directory Path*
This is the actual path to the Working Directory whose general location is determined by the Working
Directory Location property.
If the Working Directory Location property is set to User Defined, enter a path for the Working
Directory on the Compute Server machine. You can enter either an absolute local path (for example,
C:\RSMTemp) or an environment variable in the format %VAR% (for example, %TMP%).
If you will be using a native cluster configuration (that is, will not be using SSH), essentially you are
indicating that the Working Directory and the Shared Cluster Directory are the same location. As
such, the Working Directory Path property is populated with the path entered for the Shared
Cluster Directory property.
When the Compute Server and RSM Manager are two different machines, for each job that runs, a
temporary subdirectory is created in the Compute Server Working Directory. This subdirectory is
where job-specific scripts, input files, and output files are stored. When the job completes, output
files are then immediately transferred back into the Project Directory on the RSM Manager machine.
Requirements:
The Working Directory must be located on the Compute Server machine (the machine specified in the
Machine Name field).
All RSM users must have write access and full permissions to this directory.
If you will be using a cluster configuration, the directory must be shared and writable to all of the nodes
in the cluster.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
67
RSM Administration
Note that in some cluster configurations, the Working Directory may also need to exist on each cluster
node and/or may share the same physical space as the Shared Cluster Directory. Examples of Working
Directory paths are D:\RSMTemp and C:\RSMWorkDir.
Note
In a configuration where the Compute Server and RSM Manager are the same machine (that
is, the job is queued from and executed on the same machine), and the Reuse Manager
Storage option has been selected for the Working Directory Location property, the job
execution files are stored directly in the Project Directory on the RSM Manager, rather than
in the Working Directory on the Compute Server. This conserves disk space on the Compute
Server.
In a native cluster configuration (that is, you are not using SSH), when you specify that you
want to use the Shared Cluster Directory to store temporary solver files, essentially you are
indicating that the Working Directory and the Shared Cluster Directory are the same location;
as such, the Working Directory property is populated with the path entered for the Shared
Cluster Directory property in the Cluster tab. See the descriptions of the Shared Cluster
Directory and File Management properties.
Server Can Accept Jobs
Specify whether the Compute Server can accept jobs. Selected by default.
Leave selected to indicate that the Compute Server can accept jobs.
Deselect to prevent jobs from being run on this Compute Server. Primarily used when the server is offline
for maintenance.
The Server Can Accept Jobs property can also be set on the client side (that is, on the RSM Client
machine via the Workbench Update Design Point Process properties). This can be done both in
scenarios where the RSM Manager runs locally on the same machine as the RSM Client, and in
scenarios where the RSM Manager is run remotely on a different machine. In either case, the Server
Can Accept Jobs value set on the server side (that is, on the remote Compute Server machine)
takes precedence.
Maximum Number of Jobs
Specify the maximum number of jobs that can be run on the Compute Server at the same time. When this
number is reached, the server is marked as Busy.
The purpose of the Maximum Number of Jobs property is to prevent job collisions, which can
occur because RSM cannot detect the number of cores on a machine. The ability to determine a
maximum number of jobs is particularly useful when the job is simply forwarding the work to a
third-party job scheduler (for example, to an LSF or PBS Pro cluster). Default value is 1.
In a cluster configuration, this property refers to the maximum number of jobs at the server level,
not at the node/CPU level.
The Maximum Number of Jobs property can also be set on the client side (that is, on the RSM
Client machine via the Workbench Update Design Point Process properties). This can be done
both in scenarios where the RSM Manager runs locally on the same machine as the RSM Client, and
in scenarios where the RSM Manager is run remotely on a different machine. In either case, the
Maximum Number of Jobs value set on the server side (that is, on the remote Compute Server
machine) takes precedence.
68
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Note
To access the default TMP directory for Windows, go to %TMP% in Windows Explorer
or to /tmp in Linux.
Selecting this option could potentially increase disk usage on the RSM Manager.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
69
RSM Administration
Job log files are primarily used for troubleshooting. The log file for a job contains the same information displayed on the Job Log view when the job is selected in the List view of the main RSM application window.
When this option is enabled, the log file on disk is updated/saved only when a job finishes running.
The user can always see the same live log from the RSM user interface when the job is running.
Delete Job Files in Working Directory
Specify whether the temporary job subdirectories created in the Compute Server Working Directory are
deleted upon completion of the associated job. Selected by default.
Leave the check box selected to delete temporary job subdirectories and their contents upon completion
of the associated job.
Deselect the check box to save temporary job subdirectories and their contents after the completion of
the associated job.
The job files in the Working Directory are primarily used for troubleshooting. When a submitted job
fails, saved job-specific scripts and files can be helpful for testing and debugging. You can find these
files by looking at the RSM log (either in the Job Log view of the main application window or in
the job log file saved to the Working Directory on the RSM Manager machine) and finding the line
that specifies the Compute Server Working Directory.
If the Compute Server Working Directory shares (or reuses) the RSM Manager Project Directory, the
Compute Server Working Directory will not be deleted until the RSM Manager Project Directory is
deleted. This does not occur until a job is released by the client and its cleanup period expires. The
Job Cleanup Period is specified in the Solve Manager Properties (see Modifying RSM Manager
Properties (p. 62)).
Note that if the RSM Manager Project Directory shares the client working directory, then the RSM
Manager Project Directory will not be deleted until the client working directory is deleted by RSM
clients such as Workbench or EKM.
Use SSH protocol for inter- and intra-node communication (Linux only)
Specify whether RSM and solvers use RSH or SSH for inter-node and intra-node communications on Linux
machines. Deselected by default.
Leave the check box deselected to use RSH.
Select the check box to use SSH.
This setting will be applied to all Linux Compute Servers, not only those in clusters, allowing for
solvers to run in distributed parallel mode on a single machine.
When ANSYS Fluent, ANSYS CFX, ANSYS Mechanical, and ANSYS Mechanical APDL are configured
to send solves to RSM, their solvers will use the same RSH/SSH settings as RSM.
70
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
71
RSM Administration
Custom Cluster Type*
Displayed only when Custom is selected for Cluster Type.
Enter the type of custom cluster being used.
[scheduler] Job Submission Arguments
Optional.
Enter scheduler-specific arguments that will be added to the job submission command line of your
third-party job scheduler. For example, you can enter job submission arguments to specify the
queue (LSF, PBS, SGE) or the nodegroup (MS HPC) name. For valid entries, see the documentation
for your job scheduler.
72
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Note
For Linux, spaces in the Shared Cluster Directory path are not supported because Linux
does not provide full support for spaces in shared NFS directories.
Remote Shared Cluster Directory*
Displayed only when files are transferred via an external mechanism (such as SSH) between the Compute
Server and the cluster.
Enter the path to the remote shared cluster directory used to transfer files between the Compute
Server and the cluster. You can enter the path of the remote shared cluster directory manually, or
can enter an environment variable in the format %VAR%.
In which directory does the cluster job run?
Select one of the following options to indicate the directory in which the cluster job will run.
In the shared cluster directory
This option is recommended when one or more of the following is true:
You are using a native cluster setup (that is, you are not using SSH).
You have a fast network connection between the execution nodes and the Shared Cluster Directory.
You are using a solver that produces fewer, relatively small files as part of the solution and does not
make heavy use of local scratch space (for example, the CFX or the Fluent solver).
In a scratch directory local to the execution node
This option is recommended to optimize performance when one or both of the following is true:
You have a slower network connection between the execution nodes and the Shared Cluster
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).
Cluster Scratch Directory*
Displayed only when youve specified that cluster jobs will run in a scratch directory local to the execution
node.
Enter the path for a scratch directory on the execution node. You can enter the path of the scratch
directory manually, or can enter an environment variable in the format %VAR%.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
73
RSM Administration
If you select Test Server, this runs a test job on the Compute Server configuration, using the settings
provided.
If you select Advanced Test, a Test [computeservername] dialog box displays, allowing you to specify test
details in the following fields:
Client Directory for Test: Specify the directory in which the test job will be run. You can leave set to the
default (the %TEMP% environment variable) or enter a path or environment variable manually. Manually
entered items will be added as drop-down options.
Test Type: Specify the kind of Compute Server test that will be run. If you leave this field set to Basic (the
default), a standard test of the Compute Server configuration is performed. If you select File Transfer
Check, the test will verify that your files are being transferred successfully.
The List view indicates whether the test job is running, has finished, or has failed. Select the job in the
List view to view details in the Job Log below. A log message will indicate whether the test finished or
failed. If the test finishes, you can successfully run jobs on the Compute Server.
If you do not have full permissions to the Compute Server working directory, Compute Server tests will
fail. If tests fail, try deselecting the Delete Job Files in Working Directory check box on the General
tab of the Compute Server Properties dialog box. You can then examine the contents of the temporary
job directories for additional debugging information. When this option is deselected, RSM will keep the
temporary directories on the server after the job is completed. You can find the location of these temporary directories by looking for the line that specifies the "Compute Server Working Directory" in the
RSM log.
The test server job will always keep the temporary client working directory created by RSM on the client
machine, regardless of the Delete Files in Working Directory setting. You can find the location of the
temporary client working directory by looking for the line that specifies the "Client Directory" in the
RSM log.
74
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
75
Customizing RSM
assemblies (.dlls), and support files. These code templates are chosen at runtime based upon the
job template and cluster type selected to run the job.
RSM code templates are located in the [RSMInstall]\Config\xml directory.
An example code template for a server test job is shown below:
<?xml version="1.0" ?>
<codeDefinition transfer="true" prebuilt="false" assemblyName="Ans.Rsm.Test.dll">
<codeFiles>
<codeFile>Test.cs</codeFile>
</codeFiles>
<references>
<reference>Ans.TestDlls.dll</reference>
<references/>
<supportFiles>
<supportFile transfer="true" type="ascii">TestingScript.py</supportFile>
<supportFiles/>
</codeDefinition>
76
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Note
The RSM keyword entry is not yet valid for hpcCommands. It is available here so that you
can set the default jobCode for non-cluster jobs.
77
Customizing RSM
<include name="hpc_commands_extensions_SSH.xml"/>
</hpcCommands>
<protocol name="protocol_definition_SSH.xml"/>
</keyword>
If you want to customize the way jobs are run on a cluster, you will need to modify the jobConfiguration.xml file, either by editing existing keyword entries or adding new ones for each custom
cluster job type.
If significant changes are to be made to the cluster, or there are different customization requirements
for different projects, groups, and so on, then you will need to add a custom keyword entry to the
jobConfiguration.xml file.
In the example below, a new entry has been created for jobs running on a custom cluster that has been
assigned the keyword CUSTOM. It references a custom HPC commands file, hpc_commands_CUSTOM.xml, as well as the standard hpc_commands_PBS.xml file.
<keyword name="CUSTOM">
<jobCode name="GenericJobCode_base.xml"/>
<hpcCommands name="hpc_commands_CUSTOM.xml">
<include name="hpc_commands_PBS.xml"/>
</hpcCommands>
</keyword>
For more information see Modifying the Job Configuration File for a New Cluster Type (p. 83).
78
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
79
Customizing RSM
On the server-side RSM installation, you will need to log into the remote cluster (RSM Manager) machine
to perform all the tasks (steps 1 through 4). To override or modify selective cluster commands, you
must:
1. Configure RSM to use a cluster-specific code template.
2. Create copies of existing code and rename files using your new Custom Cluster Type keyword.
3. Add an entry to the job configuration file that associates your Custom Cluster Type keyword with
the cluster-specific hpc_commands_<keyword> file.
4. Edit the cluster-specific hpc_commands_<keyword> file to reference the code you want to execute.
The following sections discuss the steps needed for customizing your integration cluster:
6.2.1.1. Configuring RSM to Use a Cluster-Specific Code Template
6.2.1.2. Creating Copies of Standard Cluster Code Using A Custom Cluster Keyword
6.2.1.3. Modifying the Job Configuration File for a New Cluster Type
6.2.1.4. Modifying the Cluster-Specific HPC Commands File
80
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
81
Customizing RSM
Note
The Shared Cluster Directory you choose must be readable and writable by all users of RSM
and also by rsmadmin. The Shared Cluster Directory must be shared between all nodes of the
cluster and must be mounted using the same name (with the same parent directories).
The Local Scratch Directory you choose must be readable and writable by all users of RSM. The
scratch directory should not be shared between nodes, but it should have the same name (and
parent directories) on all nodes.
If you want to have a configuration with a shared scratch directory, specify where the job will
be run by selecting In the shared cluster directory.
Refer to Adding a Compute Server (p. 64) for information about the properties in the General and
Cluster tabs of the Compute Server Properties dialog box.
6.2.1.2. Creating Copies of Standard Cluster Code Using A Custom Cluster Keyword
As part of the setup, you must create a custom copy of the xml file that contains the definition of the
HPC commands to be used for the job execution. As a starting point, you can copy existing RSM files
as shown below:
Locate the directory [ANSYS 16.0 Install]/RSM/Config/xml. Note that all the actions listed below
should be performed on the cluster installation.
Locate the commands file that pertains to your cluster type (for instance, if you are using PBS Pro, the file
is hpc_commands_PBS.xml).
Copy the content of the hpc_commands_PBS.xml file into a new file hpc_commands_<YOURKEYWORD>.xml. If your keyword for the custom cluster was CUS_PBS like the example in Configuring
82
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Note
In order to use the native RSM cluster functionality (that is, using a fully supported cluster
type in your setup, such as LSF, PBS Pro, and so on), you must not change the file names or
contents of the corresponding cluster-specific templates provided by RSM. This can cause
those standard cluster setups to fail and will make it harder to start over if you need to
change something later on. Here we have created a custom cluster type, but used copies of
a standard template to start from; this is the recommended method.
6.2.1.3. Modifying the Job Configuration File for a New Cluster Type
As part of the setup, you must add an entry for your custom cluster keyword in the jobConfiguration.xml file, and reference the files that are needed for that cluster job type.
Locate the directory [ANSYS 16.0 Install]/RSM/Config/xml. Note that all the actions listed below
should be performed on the cluster installation.
Open the jobConfiguration.xml file and add an entry that follows the pattern shown in the sample
code below. This code corresponds to the example in preceding sections which assumes your cluster is
most like a PBS cluster.
<keyword name="YOURKEYWORD">
<jobCode name="GenericJobCode_base.xml"/>
<hpcCommands name="hpc_commands_YOURKEYWORD.xml">
<include name="hpc_commands_PBS.xml"/>
</hpcCommands>
</keyword>
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
83
Customizing RSM
</condition>
</command>
</precommands>
<primaryCommand name="submit">
<application>
<app>qsub</app>
</application>
<arguments>
<arg>
<value>-q %RSM_HPC_QUEUE%</value>
<condition>
<env name="RSM_HPC_QUEUE">ANY_VALUE</env>
</condition>
</arg>
<arg>
<value>-l select=%RSM_HPC_CORES%:ncpus=1:mpiprocs=1</value>
<condition>
<env name="RSM_HPC_DISTRIBUTED">TRUE</env>
</condition>
</arg>
<arg>
<value>-l select=1:ncpus=%RSM_HPC_CORES%:mpiprocs=%RSM_HPC_CORES%</value>
<condition>
<env name="RSM_HPC_DISTRIBUTED">FALSE</env>
</condition>
</arg>
<arg noSpaceOnAppend="true">
<value>:mem=%RSM_HPC_MEMORY%mb</value>
<condition>
<env name="RSM_HPC_MEMORY">ANY_VALUE</env>
<env name="RSM_HPC_DISTRIBUTED">TRUE</env>
</condition>
</arg>
<arg noSpaceOnAppend="true">
<value>:mem=%RSM_PBS_MEMORY_AMOUNT%</value>
<condition>
<env name="RSM_PBS_MEMORY_AMOUNT">ANY_VALUE</env>
<env name="RSM_HPC_DISTRIBUTED">FALSE</env>
</condition>
</arg>
<arg>
<value>-l place=excl</value>
<condition>
<env name="RSM_HPC_NODE_EXCLUSIVE">TRUE</env>
</condition>
</arg>
<arg>-N "%RSM_HPC_JOBNAME%" %RSM_HPC_NATIVEOPTIONS% -V -o "%RSM_HPC_STAGING%/%RSM_HPC_STDOUTFILE%"
-e "%RSM_HPC_STAGING%/%RSM_HPC_STDERRFILE%" "%RSM_HPC_STAGING%/%RSM_HPC_COMMAND%"</arg>
</arguments>
</primaryCommand>
</submit>
<cancel>
<primaryCommand name="cancel'>
<application>
<app>qdel</app>
</application>
<arguments>
<arg>%RSM_HPC_JOBID%</arg>
</arguments>
</primaryCommand>
</cancel>
<queryStatus>
<primaryCommand name="queryStatus>
<application>
<app>qstat</app>
</application>
<arguments>
<arg>%RSM_HPC_JOBID%</arg>
</arguments>
</primaryCommand>
</queryStatus>
<queryQueues>
84
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
The section in bold text is the section that provides the Submit action, which we want to customize in
this example. In the original version the Submit command invokes the cluster qsub with arguments
determined via environment variables. The actual executable that is submitted to the cluster is determined
by RSM during runtime and can be specified via an environment variable named RSM_HPC_COMMAND.
For details, see Submit Command (p. 96).
The example below shows the same section after it is customized to execute the Python file submit_PBS_EXAMPLE.py. In this example, we defined the type of application to execute (runpython,
accessed from the ANSYS installation) and the name of the Python file to be executed (submit_PBS_EXAMPLE.py).
<primaryCommand name="submit">
<application>
<app>%AWP_ROOT160%/commonfiles/CPython/2_7_3/linx64/Release/python</app>
</application>
<arguments>
<arg>
<value>%RSM_HPC_SCRIPTS_DIRECTORY%/submit_PBS_EXAMPLE.py</value>
</arg>
</arguments>
</primaryCommand>
The custom Submit command appears much simpler than the original one. However, the details of the
submission are handled inside the Python file, which contains the same arguments used in the original
section. The Python file will also contain any custom code to be executed as part of the submission.
Note
The submit_PBS_EXAMPLE.py script is provided in the [RSMInstall]/RSM/Config/scripts/EXAMPLES directory. It can be used as a starting point for a customized
Submit command. The script should be copied into the [RSMInstall]/RSM/Config/scripts directory. Alternatively, a full path to the script must be provided along with
the name.
Other commands or queries can be overridden using the same procedure. You can find the command
name in the cluster-specific hpc_commands file and replace the application that needs to be executed
and the arguments needed by the application. Details on how to provide custom commands, as well
as the description of the environment variables, are provided in Writing Custom Code for RSM Integration (p. 95).
85
Customizing RSM
on the server/cluster. It is the responsibility of the custom scripts to handle all aspects of the job execution, including transfer of files to and from the server.
The RSM installation provides some prototype code for client integration that can be tailored and
modified to meet specific customization needs. As indicated above, the steps needed for client-side
integration are very similar to those for server-side integration. On the client-side RSM installation, you
will be using the local Client machine (and RSM Manager) to perform all the tasks (steps 1 through 4),
as follows:
1. Configure RSM to use cluster-specific code template.
2. Create copies of prototype code for the custom cluster type.
3. Add an entry to the job configuration file that associates your Custom Cluster Type keyword with
the cluster-specific hpc_commands_<keyword> file.
4. Edit the cluster-specific hpc commands_<keyword> file to reference the custom commands.
5. Provide cluster-specific script\code\commands that perform the custom actions and return the required RSM output.
The following sections discuss the steps to customize your integration:
6.2.2.1. Configuring RSM to Use a Cluster-Specific Code Template on the Client Machine
6.2.2.2. Creating Copies of Sample Code Using a Custom Client Keyword
6.2.2.3. Modifying the Job Configuration File for a New Cluster Type
6.2.2.4. Modifying the Cluster-Specific HPC Commands File
6.2.2.1. Configuring RSM to Use a Cluster-Specific Code Template on the Client Machine
On the client-side RSM installation, you will be using the local Client machine (and RSM Manager) to
perform all the tasks (steps 1 through 4) in Customizing Client-Side Integration (p. 85).
After creating a new Compute Server, set up the Compute Server Properties dialog box under the
Cluster tab. You must select Cluster Type to Custom and then create a short phrase/word in the
Custom Cluster Type property as the custom cluster name. The name is arbitrary, but you should make
it simple enough to append to file names. This name will be referred to as the keyword from now on.
For supported clusters, you can include the original cluster name in the new custom name, for clarity.
For example, if your cluster is actually an LSF or PBS Pro cluster but you need to customize the RSM
interaction with it, you might use the keyword CUS_LSF or CUS_PBS. If the underlying cluster is
not a supported one, it could be called CUSTOM or any other arbitrary name. The names are in capital
letters for simplicity, but the only requirement is that the capitalization is the same in all places where
this keyword is referenced.
A custom client integration means that you are running in SSH mode or (non-RSM communication).
Thus, on the General tab of the Compute Server Properties dialog box, you need to select Uses nonRSM communication to a remote cluster node (e.g. SSH).
For the File Management tab, see Configuring File Transfer by OS Type and Network Share Availability (p. 91) for details on different file transfer scenarios.
A full example of a typical cluster setup using the local RSM Manager and custom client definition is
shown below.
86
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
87
Customizing RSM
Note
The Shared Cluster Directory you choose must be readable and writable by all users of RSM
and also by rsmadmin. The Shared Cluster Directory must be shared between all nodes of the
cluster and must be mounted using the same name (with the same parent directories).
The Local Scratch Directory you choose must be readable and writable by all users of RSM. The
scratch directory should not be shared between nodes, but it should have the same name (and
parent directories) on all nodes.
If you want to have a configuration with a shared scratch directory, specify where the job will
be run by selecting In the shared cluster directory.
Refer toAdding a Compute Server (p. 64) in the Remote Solve Manager User's Guide for information
about the properties in the General and Cluster tabs of the Compute Server Properties dialog box.
88
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Note
Any additional custom code that you want to provide as part of the customization should
also be located in the [RSMInstall]\RSM\Config\scripts directory corresponding
to your local (client) installation. Alternatively, a full path to the script must be provided
along with the name.
6.2.2.3. Modifying the Job Configuration File for a New Cluster Type
As part of the setup, you must add an entry for your custom cluster keyword in the jobConfiguration.xml file, and reference the files that are needed for that cluster job type.
Locate the directory [ANSYS 16.0 Install]/RSM/Config/xml. Note that all the actions listed below
should be performed on your client machine.
Open the jobConfiguration.xml file and add an entry that follows the pattern shown in the sample
code below. This code corresponds to the example in preceding sections which assumes your cluster is
most like an LSF cluster.
Note
In our example we have been using CUS_LSF as the keyword, but you still must replace
YOURKEYWORD with the actual custom cluster keyword you have defined.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
89
Customizing RSM
<keyword name="YOURKEYWORD">
<jobCode name="GenericJobCode_base.xml"/>
<hpcCommands name="hpc_commands_YOURKEYWORD.xml"/>
</keyword>
90
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Note
Any custom code that you want to provide as part of the customization should also be located
in the [RSMInstall]\RSM\Config\scripts directory corresponding to your local
(client) installation. Alternatively, a full path to the script must be provided along with the
name.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
91
Customizing RSM
92
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
93
Customizing RSM
If using local scratch, set to the path of the desired (cluster) local scratch space on the cluster. This local
scratch directory must be exactly the same location on all of the nodes and should be in the form of
/path/to/cluster/nodes/individual/scratch.
94
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
95
Customizing RSM
ment variable defines what type of output RSM should expect from the command. If the underlying
cluster used for the integration is one of the supported types (LSF/PBS Pro/TORQUE with Moab/SGE/MSCC)
you should set the value of RSM_HPC_PARSE to the corresponding type. Printing the output of the
command will allow the RSM code to extract the appropriate information. For example, if the LSF option
is used, RSM is expecting the output of the Submit command to contain output from LSF bsub command.
If your cluster is not one of the supported ones, you should set RSM_HPC_PARSE to CUSTOM. In this
case, it is your responsibility to parse the output of the commands and provide to RSM a variable with
the result. An optional RSM_HPC_PARSE_MARKER option can be set to a marker string of an output
line in order to indicate the line after which parsing should start. If no "start marker" is found, then RSM
will parse all of the output as the start marker was at the beginning of the output
6.3.1.3. Debugging
Debugging information, typically used for troubleshooting purposes, is shown on the RSM job log only
if the Debug Messages option is selected from the job log context menu. (To access this option, rightclick anywhere inside the job log pane of the RSM application main window.)
Output format:
RSM_HPC_DEBUG=<debugmessage>
96
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
97
Customizing RSM
98
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Description
RSM_HPC_CLUSTER_TARGET_PLATFORM
RSM_HPC_CORES
RSM_HPC_DISTRIBUTED
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
99
Customizing RSM
Set to TRUE if the target solver (specified in
RSM_HPC_JOBTYPE) supports distributed execution.
Set to FALSE if cores can be used on only one node.
RSM_HPC_FILECONTEXT
RSM_HPC_FILEDIRECTION
RSM_HPC_FILELIST
RSM_HPC_JOBID
RSM_HPC_JOBTYPE
The solver being used for the job. Possible values are
Mechanical_ANSYS, Mechanical_AUTODYN,
Mechanical_RBD, Mechanical_CONTACT,
Workbench_ANSYS, Workbench_CFX, Workbench_FLUENT, Workbench_POLYFLOW, and
Workbench_DESIGNPOINT.
The job types with the Workbench prefix are jobs
executed from within Workbench as part of the
component update. Workbench_DESIGNPOINT is
the job type corresponding to the execution of the
Workbench Update Design Points operation.
The job types with the Mechanical prefix
correspond to jobs executed from ANSYS Mechanical.
RSM_HPC_LOCAL_PLATFORM
RSM_HPC_NATIVEOPTIONS
100
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
RSM_HPC_QUEUE
RSM_HPC_STAGING
RSM_HPC_STDOUTFILE
Note
For client-side custom integration, the RSM Compute Server is running on the Client machine.
Environment Variable
Description
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
101
Customizing RSM
Specifies what type of output RSM should expect from these
commands, choose LSF, PBS, TORQUE, SGE, MSCC, or CUSTOM.
RSM_HPC_PARSE
Note
For a custom client Integration, the Compute Server is the Client machine therefore the information is made available to the custom scripts on the Client machine. In this case, the
environment variables are also passed to cluster machine on remote side.
Examples of custom information that can be provided to the cluster are:
The username of the submitter (which, for instance, provides the ability to monitor jobs submitted by a
particular user for accounting purposes) and
The license necessary to execute the job, which can be used to integrate with cluster resource management
to check ANSYS license availability before a job starts running.
For more information on how to integrate licensing with cluster software, contact your cluster administrator or ANSYS customer support.
As an example, well pass the submitters username from the client to a PBS Pro cluster.
The following sections detail the steps for providing custom information for job submissions to clusters.
6.3.4.1. Defining the Environment Variable on the Client
6.3.4.2. Passing the Environment Variable to the Compute Server
6.3.4.3. Verify the Custom Information on the Cluster
102
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
103
Customizing RSM
To view a sample of this file before the addition of custom information, see Modifying the ClusterSpecific HPC Commands File (p. 90).
Since we added the environment variable to the qsub command in the PBS Pro commands file, it will
also show up in the area of the job log indicating that the qsub command has been run.
qsub -q %RSM_HPC_QUEUE% -A %RSM_CLIENT_USERNAME% -1
select=1:ncpus=%RSM_HPC_CORES%:mpiprocs=%RSM_HPC_CORES% ...
qsub -q WB_pbsnat -A myname -1 select=1:ncpus=1:mpiprocs=1 ...
104
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Configuring RSM for Mapped Drives and Network Shares for Windows
If RSM is used to solve local or remote jobs on mapped network drives, you may need to modify security
settings to allow code to execute from those drives because code libraries may be copied to working
directories within the project.
You can modify these security settings from the command line using the CasPol utility, located under
the .NET Framework installation:
C:\Windows\Microsoft.NET\Framework64\v2.0.50727
In the example below, full trust is opened to files on a shared network drive to enable software to run
from that share:
C:\Windows\Microsoft.NET\Framework64\v2.0.50727\CasPol.exe
-q -machine -ag 1 -url "file://fileserver/sharename/*"
FullTrust -name "Shared Drive Work Dir"
For more information on configuring RSM Clients and Compute Servers using a network installation,
refer to Network Installation and Product Configuration.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
105
RSM Troubleshooting
Firewall Issues
If you have a local firewall turned on for the server and/or RSM Client machines, you will need to attach
two ports to the Exceptions List for RSM, as follows:
Add port 8160 to (Ans.Rsm.SHHost.exe).
Add port 9160 to (Ans.Rsm.JMHost.exe).
Note
Disabling UAC can cause security issues, so check with your IT department before changing
UAC settings.
Note
If you are running on a Microsoft HPC cluster with Network Address Translation (NAT) enabled,
Microsoft has confirmed this to be a NAT issues and is working on a resolution.
106
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
In most cases you will need to configure the RSM Manager and/or Compute Server machine(s) depending
on which one has multiple NIC cards installed. For instructions, refer to Configuring Computers with
Multiple Network Interface Cards (NIC) (p. 18).
Note
This limitation does not apply if files are being transferred via a network share.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
107
108
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Note
In order for the wizard to install prerequisites, UAC must be disabled on any cluster
node where prerequisites are missing and need to be installed.
Installed prerequisites include MS.NET Framework 4.0 Redistributable and MS VC++
2010 Redistributable x64. (If needed, packages from previous versions, such as MS VC++
2008 Redistributable x64, among others, could be included by editing the AutoConfig.AllPrereqInstaller entry in the Ans.Rsm.Wizard.exe.config file).
Once you have completed the RSM setup, it is recommended that you reboot the machine(s) on which MS.NET Framework 4.0 and/or MS VC++ 2010 Redistributable x64
have been installed.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
109
110
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Note
RSM and Workbench are both installed by default as product components to most ANSYS,
Inc. products. RSM can also be installed independently as a standalone package.
For cluster configurations, when you configure the head node of the cluster as an RSM Manager, it will also be configured as a Compute Server. The compute nodes in the cluster will
be configured via the head node.
2. Before starting the wizard, exit Workbench and verify that no RSM jobs are running.
3. Different privileges are necessary for different parts of the setup process. Verify that you have the appropriate privileges for the setup tasks you will perform.
For Windows,administrative privileges means that the user either has Windows administrative privileges
on the RSM Manager machine, launches the wizard via the right-click Run as administrator menu option,
or is added to the RSM Admins user group. For RSM Admins privileges, you must create the RSM Admins
user group and add users to it manually. For instructions, see RSM User Accounts and Passwords (p. 47).
For Linux,administrative privileges can be root or non-root.Non-root administrative privileges means
that the user is added to the rsmadmins user group. As a member of this group, you have administrative,
non-root permissions, which are necessary for certain parts of the setup. When a root user starts RSM
services, if the rsmadmins user group and rsmadmin account do not already exist, the rsmadmins group
is automatically created on the RSM Manager machine and an rsmadmin account is added to the group.
This account can then be used to add additional users to the group.
For Linux, if the user prefers to start the non-daemon services from the RSM Setup Wizard (as
opposed to installing and starting the services as daemons with a root account), then a user account
from the rsmadmins user group must be used. Note that if the RSM services are not installed as
daemons, the rsmadmins user group is not automatically created. Therefore, in order to start
non-daemon services via the wizard, prior to running the wizard your IT department must:
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
111
Note
To start RSM services when UAC is enabled on Windows 7, you must use the rightclick Run as administrator menu option to launch the wizard. For instructions on
enabling or disabling UAC, see RSM Troubleshooting (p. 105).
For Linux, you must have either root user or rsmadmins (non-root administrative) privileges.
Note
If you start the services with an rsmadmins non-root user account, the service will
be run by that account in non-daemon mode. Root user privileges are required for
starting RSM services as daemons. If you start RSM services as daemons, any nondaemon services will be killed.
112
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Note
To start RSM services when UAC is enabled on Windows 7, you must use the rightclick Run as administrator menu option to launch the wizard.
For Linux, you must have either root user or rsmadmins (non-root administrative) privileges. (To start
RSM services as daemons, root user privileges are required. In some cases, these tasks may need to be
performed by a member of your IT department.)
1. Log into the machine that will serve as the RSM Manager. If you are configuring a cluster, this is the head
node of the cluster.
2.
Note
For a quick-start guide on using the wizard, see the Readme file. To access this file:
For Windows: Select Start > All Programs > ANSYS 16.0 > Remote Solve Manager
> Readme - RSM Setup Wizard 16.0.
For Linux: Navigate to the [RSMInstall]\Config\tools\linux directory and
open rsm_wiz.pdf.
113
Note
UAC must be disabled on any cluster node where ANSYS Workbench prerequisites are
missing and need to be installed.
If no, verify prerequisites when prompted and then specify the service role(s) for which the local machine
is being configured.
4. Start RSM services on the local machine. If the necessary services havent already been started, the wizard
will start them when you click the Start Services button.
5. Provide RSM administrative privileges to users as necessary.
For Windows, to provide users with RSM administrative privileges, you must manually create an RSM
Admins user group and add users to this group.
For Linux, When the RSM services are started by running the wizard with root user privileges, if the
rsmadmins user group and an rsmadmin account do not already exist, the group is automatically created
on the RSM Manager machine. An rsmadmin user account is created in the new user group. This account
has administrative, non-root privileges and can be used to perform RSM administrative and configuration
tasks via the wizard on Linux.
On Linux, to provide additional users with RSM administrative privileges, you must add them to
the rsmadmins user group.
6. If you are logged in with:
Windows administrative or RSM Admin permissions, you can continue the RSM setup process via your
current wizard session.
Linux root permissions, there are no further steps that you can perform with the wizard. All further wizard
configurations must be performed by a user with rsmadmin permissions. You can close the wizard now
via the exit button and log back in with rsmadmins permissions to continue the setup.
Note
If you are on a Windows RSM Manager and continuing your existing wizard session, you have
already performed the first three steps. Skip to step #4.
114
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Note
Under certain circumstances, testing can also be performed from an RSM Manager machine
with remote access to the RSM Client. However, testing from the RSM Manager may prevent
the wizard from performing some of the setup tasks, such as those for cluster configuration.
Required Privileges
For Windows, you can have either administrative or non-administrative permissions. For Linux, you must
have non-root permissions.
1. Once the setup is finished, log into a machine that will be an RSM Client. You must log in under an account
that will be used to send jobs via RSM.
Note
In most cluster scenarios, client users (other than the user who set up the cluster) must
cache their password with the cluster prior to using the wizard for RSM configuration
testing. The only exception is for MS HPC, where if you are logged in with administrative
privileges, the wizard asks you to cache and verify your password in order to use the
wizards auto-configuration functionality.
For instructions on caching the password, see Manually Running the Password Application in the Remote Solve Manager User's Guide.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
115
116
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
117
118
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Note
SSH is not a recommended communication protocol and should be used only if it is required
by your IT policy. For ease of configuration and enhanced performance, native RSM is the
recommended communication protocol. Before proceeding with this configuration, see
Configuring RSM to Use a Remote Computing Mode for Linux (p. 11) and Configuring Native
Cross-Platform Communications (p. 11) for more information.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
119
Note
This limitation does not apply if files are being transferred via a network share.
High Maximum Number of Jobs Value When you use SSH as protocol to run RSM jobs and set a
high maximum number of jobs, some jobs could fail, providing a message such as Server unexpectedly
closed network connection. This happens because too many SSH calls are made simultaneously from
different jobs. In this case, you may need to reduce the maximum number of jobs that can be run
concurrently. To do so, go to the General tab of the Compute Server Properties dialog box and lower
the value for the Maximum Number of Jobs field.
Note
SSH configuration must be completed by your IT administrator. This section provides instructions for a PuTTY SSH implementation. Other SSH implementations are possible, and your IT
administrator can determine which one is best for your site.
120
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
121
4. Select the Path variable and then click the Edit button. The Edit System Variable dialog box appears.
5. Add the PuTTY install directory to the Variable value field (for example, C:\Program Files\putty)
and then click OK.
6. In the System variables pane, click the New button. The New System Variable dialog box appears.
7. In the New System Variable dialog, create a new environment variable named KEYPATH with a value
containing the full path to the private key file (for example, <drive>:\Program
Files\Putty\id_rsa.ppk).
122
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Use a user variable if the key file is used only by you. Use a system variable if other users are sharing
the key file. For example, if a Windows 7 user has a key file in My Documents, the variable value
should be %USERPROFILE%\My Documents\id_rsa.ppk (this expands to <drive>:\Documents and Settings\<user>\My Documents\id_rsa.ppk).
8. Click OK.
9. Reboot the computer for environment changes to take effect.
123
General Tab
The General tab is used to set the properties of the Windows Compute Server. On the General tab,
set properties as described below.
For Display Name, enter a descriptive name for the Windows Compute Server.
Set Machine Name to the network machine name for the Windows Compute Server. If the RSM Manager
and Compute Server will be on the same Windows machine, enter localhost.
In the example below, the RSM Manager and the Compute Server are on the same machine.
Set What is the role of this Compute Server? to Communicates with a remote computer which performs
the work (e.g. SSH). When you select this, Working Directory Location is set to Network Share (readonly) and Working Directory Path is disabled.
Enter the Working Directory Path if youve opted to specify the location. If the location is determined by
the system, this property is blank and disabled.
Select Use SSH protocol for inter- and intra-node communications (Linux only) so that RSM and solvers
will use SSH for inter-node and intra-node communications for Linux machines. This setting applies to all
Linux Compute Servers.
Note
When ANSYS Fluent, ANSYS CFX, ANSYS Mechanical, and ANSYS Mechanical APDL are
configured to send solves to RSM, their solvers will use the same RSH/SSH settings as RSM.
124
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
For detailed descriptions of these and the other properties, see Properties on the General Tab (p. 65).
Remote Tab
The Remote tab is used to define details about the remote Linux machine that will execute the jobs.
For Remote Computer, enter the hostname or IP address of the remote Linux computer. Next to the field,
select the platform type (in our example, Linux 64).
For Account Name, enter the name of the user account that will be used to log into the remote computer.
If the Windows and Linux account names are the same (for example, DOMAIN\testuser on Windows
and testuser on Linux) then no additional configuration is required. If the account name is different,
use the Linux Account field to enter the name of the account being used to log into the remote
Linux machine.
This Linux account is an alternate account that allows you to send jobs from the primary Windows
account on the RSM Client and run them under the alternate account on a remote Linux Compute
Server. Both accounts are defined on the RSM Accounts dialog box. For more information, see RSM
User Accounts and Passwords (p. 47).
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
125
For detailed descriptions of these and the other properties, see Properties on the Remote Tab (p. 70).
126
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Note
For an alternate file management scenario, you could also set the How do files get to/from
the Remote Computer? property to Transferred by an external mechanism (e.g. SSH),
and then must enter a path for Remote Directory. If you check back on the General tab,
you will see that the Working Directory Location property is now set to Reuse Manager
Storage.
For detailed descriptions of these and the other properties, see Properties on the File Management
Tab (p. 72).
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
127
128
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Note
If you will be using SSH for Windows-Linux communications, see Integrating Windows
with Linux using SSH/SCP for SSH setup instructions. Then refer back to this appendix for
instructions on configuring RSM to send jobs to a Linux LSF, PBS Pro, TORQUE with Moab,
or UGE (SGE) cluster.
You have the machine name of the LSF, PBS Pro, TORQUE with Moab, or UGE (SGE) submission host.
RSM has been installed on the LSF, PBS Pro, TORQUE with Moab, or UGE (SGE) submission host.
If you are using a UGE (SGE) cluster, parallel environments have already been defined by your cluster administrator.
You are able to install and run ANSYS, Inc., products, including Licensing, on both the RSM Manager and
Compute Server machines. For information on product and licensing installations, go to the Downloads
page of the ANSYS Customer Portal. For further information about tutorials and documentation on the
ANSYS Customer Portal, go to http://support.ansys.com/docinfo.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
129
Integrating RSM with a Linux Platform LSF, PBS Pro,TORQUE with Moab, or UGE (SGE)
Cluster
General Tab
On the General tab, set properties as described below.
If both the RSM Manager and Compute Server services will be on the submission host of the cluster, set
Machine Name to localhost. Otherwise, enter the network name of the submission host node that will run
the Compute Server.
In the example below, pbsclusternode1 is the name of the submission host being defined as the
Compute Server.
Select This Compute Server is integrating with an HPC cluster.
Since we are not using SSH in this example, set the How does this Compute Server communicate with
the cluster? property to Able to directly submit and monitor cluster jobs.
When you select this, Working Directory Location is set to Shared Cluster Directory (read-only)
and Working Directory Path is disabled.
For detailed descriptions of these and the other properties, see Properties on the General Tab (p. 65).
130
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Cluster Tab
On the Cluster tab, set properties as described below.
Set Cluster Type to LSF, PBS Pro, TORQUE with Moab, or UGE (SGE).
If you set Cluster Type to SGE, enter names for the predefined Shared Memory Parallel and Distributed
Parallel environments that will be used for parallel processing.
These fields default to pe_smp and pe_mpi. To use one of the default names, your cluster administrator must create a PE with the same name. The default PE names can also be edited to match the
names of your existing parallel environments.
For detailed descriptions of these and the other properties, see Properties on the Cluster Tab (p. 71).
When you are finished entering values on the Cluster tab, click OK.
131
Integrating RSM with a Linux Platform LSF, PBS Pro,TORQUE with Moab, or UGE (SGE)
Cluster
Note
For an alternate file management scenario, you could also set the How do files get to/from
the Remote Computer? property to In a scratch directory local to the execution node,
and then you must enter a path for Cluster Scratch Directory.
In this case, the Cluster Scratch Directory and the Working Directory are the same location,
so cluster jobs will be run locally on the cluster execution node. The path to this directory
must exist on all nodes.
For detailed descriptions of these and the other properties, see Properties on the File Management
Tab (p. 72).
132
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
4. Click OK.
Note
If -q <queuename> is entered from Job Submission Arguments (optional) field, this
queue name is always used, even when you submit a job or perform server test from a
compute server node under a Queue parent node. In other words, the -q <queuename>
argument takes a higher priority in specifying the cluster queue to be used.
Integration Details
RSM essentially forwards the job to the LSF, PBS Pro, TORQUE with Moab, or UGE (SGE) job scheduler.
This RSM job must build and execute the job submission command of the scheduler youve selected
in the Cluster Type drop-down of the Cluster tab of the Compute Server Properties dialog box. The
RSM job does not really do any real work; rather, it monitors the status of the job it has submitted to
the job scheduler, performing the actions listed below:
1. Reads the control file containing paths, inputs and outputs.
2. Makes temporary directories on all nodes assigned for the job.
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
133
Integrating RSM with a Linux Platform LSF, PBS Pro,TORQUE with Moab, or UGE (SGE)
Cluster
3. Copies inputs to the Working Directory of the execution host.
4. Runs the command (for example, solver).
5. Copies outputs to the staging folder on the submission host.
6. Cleans up.
134
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
3. Set your RSM password. This is the password RSM will use to run jobs on the Compute Server.
4. Note that you need to update your RSM password when you update your password on the RSM client
machine.
For details, see Working with Account Passwords (p. 54).
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
135
General Tab
On the General tab, set properties as described below.
Set Machine Name to localhost if both the RSM Manager and Compute Server services will run on the head
node of the cluster. Otherwise, enter the network name of the head node machine that will run the Compute
Server.
In the example below, HPCHeadNode is the network name of the head node being defined as the
Compute Server.
Select This Compute Server is integrating with an HPC cluster.
Since we are not using SSH in this example, leave the How does this Compute Server communicate with
the cluster? property set to Able to directly submit and monitor cluster jobs.
With this selected, Working Directory Location is set to Shared Cluster Directory (read-only) and
Working Directory Path is disabled.
136
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
For detailed descriptions of these and the other properties, see Properties on the General Tab (p. 65).
Cluster Tab
On the Cluster tab, set the Cluster Type property to Windows HPC.
For detailed descriptions of these and the other properties, see Properties on the Cluster Tab (p. 71).
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
137
Note
If you will be sending CFX jobs to a Microsoft HPC Compute Server, the In the shared cluster
directory option will always be used, regardless of the propertys setting.
138
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Note
For an alternate file management scenario, you could also set the How do files get to/from
the Remote Computer? property to In a scratch directory local to the execution node,
and then must enter a path for Cluster Scratch Directory.
In this case, the Cluster Scratch Directory and the Working Directory are the same location, so cluster
jobs will be run locally on the cluster execution node. The path to this directory must exist on all nodes.\
For detailed descriptions of these and the other properties, see Properties on the File Management
Tab (p. 72).
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
139
Passwords
RSM no longer requires users to manually cache their Windows password with Microsoft HPC. Each RSM
job runs the hpcutils.exe tool prior to submitting the job to the cluster. This tool programmatically
does the equivalent of cluscfg setcreds.
However, if you still see the error messages regarding the password in the RSM log, such as "Failed to
cache password with HPC" or "Account password MUST be cached with MS Compute Cluster," you may
need to verify that the Service Packs for Microsoft HPC Pack and Windows Server have been properly
installed. If you have not installed the Service Packs, you may still need to run cluscfg setcreds
command from cluster head node to cache the HPC password.
140
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Mixed Domains
You can use RSM when the client computer and the cluster are different domains. The assumption is
that the client computer and user account are on the corporate domain and the cluster is its own domain.
In this case, the cluster domain must be configured to have a one-way trust with the corporate domain.
That is, the cluster domain trusts the corporate domain but not vice-versa. Corporate domain users
must be able to use cluster resources (login as CORPORATE\user into a cluster node). If the cluster
administrator can add corporate domain accounts as cluster users, then this trust has likely been configured when the cluster domain was created.
Troubleshooting
If RSM jobs submitted to a Microsoft HPC cluster are failing for unknown reasons, you can gain additional
diagnostic information by running the HPC Job Manager (supplied as part of the Microsoft HPC Pack),
selecting the failed job, and examining the output section of the jobs tasks.
Depending on the installed version of Microsoft HPC, registry modification may be required to enable
the execution of commands via UNC paths. Special configuration is required if the task shows the following error:
UNC paths are not supported. Defaulting to Windows directory.
Input Error: Can not find script file "C:\Windows\ClusterJob.py".
To resolve this issue, create a text file of the following contents and save to a file (for example, commandpromptUNC.reg).
Windows Registry Editor Version 5.00
[HKEY_CURRENT_USER\Software\Microsoft\Command Processor]
"CompletionChar"=dword:00000009
"DefaultColor"=dword:00000000
"EnableExtensions"=dword:00000001
"DisableUNCCheck"=dword:00000001
Next, run the following command on the head node and all compute nodes in the cluster:
regedit -s commandpromptUNC.reg
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
141
142
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Glossary
Abort
The Abort command immediately terminates a running job. Jobs terminated via this command have a Status of Canceled.
alternate account
client application
A client application is the ANSYS application run on the local RSM Client
machine and is used to submit jobs to RSM, and then to solve those jobs
as managed by RSM. Examples include ANSYS Workbench, ANSYS Fluent,
ANSYS CFX, and so on.
client-side integration
code template
A code template is an XML file containing code files (for example, C#,
VB, JScript), references, and support files required by a job.
Compute Server
compression threshold
The compression threshold is the lower limit at which larger files will
be compressed before transferring them. File compression reduces file
sizes, so is useful for file transfers on slower networks.
Custom cluster integration is the mechanism provided by RSM that allows third parties to use custom scripts to perform the tasks needed to
integrate ANSYS Workbench with the cluster. Both client-side and serverside customizations are possible.
daemon services
execution node
head node
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
143
Glossary
installed on the head node itself ) and distributes them across the cluster
for execution.
Interrupt
The Interrupt command terminates a running job, but allows for cleanup of running processes before termination. Jobs terminated via this
command have a Status of Finished.
job
A job consists of a job template, a job script, and a processing task submitted from a client application such as ANSYS Workbench. An example
of a job is the update of a group of design points for an ANSYS Mechanical simulation.
job log
In the main RSM window, the job log displays the progress and log
messages for the job selected in the list view.
job script
job template
LSF
native mode
non-root privileges
OS Copy
parallel processing
PBS Pro
primary account
A primary account is the main account that is used to access the RSM
Client machine. Typically, it is the account used with the client application
(ANSYS Workbench) on the RSM Client machine.
144
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
queue
root privileges
Root privileges give the user administrative access to all commands and
files on a Linux system. It is recommended that root privileges are not
used for starting and running RSM services.
The RSM Admins group is a Windows user group that confers administrative privileges for RSM. Also refers to the privileges conferred on
members of this group (that is, RSM Admins privileges).
RSM Client
The RSM Client is the local machine from which RSM jobs are submitted
to a Compute Server. It runs both RSM and a client application such as
ANSYS Workbench.
RSM Manager
The RSM Manager is the central RSM service that dispatches jobs to
computing resources. It contains a configuration of queues (lists of
Compute Servers available to run jobs). The RSM Manager service can
be run locally (on the same machine as the RSM Client) or remotely (on
a standalone remote machine or as part of a cluster). For clusters, it is
typically installed on the head node.
In the RSM interface, the RSM Manager may be referred to as the
Solve Manager or simply as the Manager.
The rsmadmins user group is a Linux user group that confers administrative privileges for RSM.
scratch space
Using scratch space is the practice of storing solver files in a local directory on the Compute Server machine. Recommended to optimize performance when there is a slow network connection between execution nodes
and the Shared Cluster Directory or when the solver used produces many
relatively large files.
serial processing
In serial processing, jobs are executed on only one CPU core at a time.
server-side integration
SGE
SSH
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
145
Glossary
platform communications, but native mode is the recommended method.
See native mode.
submission host
TORQUE
UGE
146
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
Index
F
A
accounts, 47
alternate, 52
changing passwords, 56
Linux with SSH, 57
password, 54
primary, 50
set password manually, 57
setting passwords, 54
adding a Compute Server, 64
administration, 59
C
client application
defining, 1
file handling, 4
integration, 5
integration with Workbench, 5
supported solvers, 5
clusters
integration, 6
code template, 1, 75
Compute Server
adding a Compute Server, 64
Compute Server properties, 64-65
Cluster tab, 71
General tab, 65
Remote tab, 70
defining, 1
file handling, 4
remotely connecting to a Compute Server, 18
startup scripts, 12
testing, 73
configuration file, 27
configuring RSM
Linux, 11
multi-user machines, 16
multiple network interface cards, 18
remote computing, 11, 17
starting Linux RSM services at boot time, 13
Windows, 9
Configuring RSM
RSM Setup Wizard, 109
configuring RSM Services, 9
custom architecture, 75
custom integration, 75
E
EKM Servers, 12
file handling, 4
File Transfer, 19
Network Files Systems, 25
OS Copy, 19
I
installing RSM, 7
service installation, 10
Installing RSM
RSM Setup Wizard, 109
integrating
using LSF, PBS or TORQUE, 129
using Microsoft HPC, 135
using SSH/SCP, 119
J
job
defining, 1
job template, 75
L
Linux
configuration, 11
Explicit Dynamics systems, 16
native mode, 11
remote computing, 11
starting services at boot time, 13
Linux Path considerations, 16
LSF, 129
M
mapped drives, 105
Microsoft HPC, 135
multi-user machines, 16
N
native mode, 11
Network File System, 4
Network Files Systems, 25
O
OS Copy Operation, 19
P
passwords, 47
caching, 54
caching manually, 57
changing, 56
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
147
Index
setting, 54
PBS, 129
primary, 50
Compute Server, 12
EKM Servers, 12
RSM Manager, 12
supported clusters, 6
Q
T
queue
creating, 61
defining, 1
R
remote computing
configuration, 17
remotely connecting to a Compute Server, 18
remotely connecting to an RSM Manager, 17
Remote Solve Manager Setup Wizard, 109
RSM Client
defining, 1
file handling, 4
RSM Manager
file handling, 4
remotely connecting to an RSM Manager, 17
RSM Manager properties, 62
startup scripts, 12
RSM Solve Manager
defining, 1
RSM user interface
Accounts dialog box, 42
context menu, 43
desktop alert window, 41
Job Log, 32
Job Log View, 39
List View, 32, 37
main window, 32
Menu Bar, 32
Notification Area icon, 43
Options dialog, 40
server test dialog, 43
Status Bar, 32, 39
system tray icon, 43
Toolbar, 32, 34
Tree view, 32, 34
terminology, 1
third-party job schedulers
integration, 6
TORQUE, 129
troubleshooting, 105
U
user interface, 31
W
Windows
configuration, 9
installation, 10
integration with Linux using SSH/SCP, 119
integration with Platform LSF, PBS Pro or TORQUE
Cluster, 129
Wizard for RSM Setup, 109
workflows, 2
S
server test, 43
Setup Wizard, 59
SSH
integrating Windows with Linux, 119
job limitations, 120
selecting a remote computing mode, 11
SSH/SCP configuration, 119
starting RSM services manually, 12
startup scripts
148
Release 16.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.