Remote Solve Manager User's Guide

Expand/Collapse all

1. RSM Overview

1.1. RSM Roles and Terminology

1.2. How RSM Works

1.3. File Handling

1.4. RSM Integration with Ansys Applications

1.4.1. RSM-Supported Applications and Solvers
1.4.2. RSM Integration with Workbench

1.5. RSM Supported Third-Party Job Schedulers/Commercial Batch-Queuing Systems

2. RSM Installation and Startup

2.1. RSM Software Installation

2.1.1. Installing a Standalone RSM Package

2.2. Installing and Configuring the RSM Launcher Service

2.2.1. Supported Platform Combinations

2.2.1.1. Configuring Windows-to-Linux Communication

2.2.2. Installing and Configuring the RSM Launcher Service for Windows

2.2.3. Installing and Configuring the RSM Launcher Service for Linux

2.2.3.1. Adding Common Job Environment Variables for Jobs

2.2.3.2. Installing the RSM Launcher Service for Linux

2.2.3.2.1. Starting the RSM Launcher Service Manually for Linux

2.2.3.2.1.1. Manually Running the RSM Launcher Service Script for Linux

2.2.3.2.2. Starting the RSM Launcher Service Automatically at Boot Time for Linux

2.2.3.2.2.1. Installing the RSM Automatic Startup (Daemon) Service for Linux
2.2.3.2.2.2. Working with the RSM Automatic Startup (Daemon) Service for Linux

2.2.4. Configuring a Network Installation of RSM

2.3. Uninstalling RSM

2.4. Uninstalling the RSM Launcher Service

2.4.1. Uninstalling the RSM Launcher Service for Windows
2.4.2. Manually Uninstalling the RSM Launcher Service for Linux
2.4.3. Uninstalling the RSM Automatic Startup (Daemon) Service for Linux

3. RSM Configuration

3.1. Setting the RSM Configuration Directory

3.2. Launching the RSM Configuration Application

3.3. Defining RSM Configurations

3.3.1. Creating a New RSM Configuration

3.3.2. Specifying RSM Configuration Settings

3.3.2.1. Specifying HPC Resource Information

3.3.2.2. Specifying File Management Properties

3.3.2.2.1. File Management Properties for a Cluster

3.3.2.3. Defining and Testing RSM Queues

3.3.3. Deleting an RSM Configuration

3.4. Sharing and Accessing RSM Configurations

3.5. Setting Up Job Directories and File Transfers

3.5.1. Setting Up Client Working Directories to Eliminate the Need for File Transfers

3.5.2. Enabling OS Copy to the HPC Staging Directory

3.5.2.1. Windows-to-Windows File Transfer
3.5.2.2. Linux-to-Linux File Transfer
3.5.2.3. Windows-to-Linux File Transfer

3.5.3. Configuring a Computer with Multiple Network Interface Cards (NICs)

3.5.4. Using SSH for File Transfers

3.5.5. Custom Client Integration

4. Ansys RSM Cluster (ARC) Configuration

4.1. Important Considerations and Requirements for the Ansys RSM Cluster (ARC)

4.2. Overview of an Ansys RSM Cluster (ARC) Configuration

4.3. The Default 'Localhost' Configuration

4.4. Creating and Deploying an Ansys RSM Cluster (ARC)

4.4.1. Prerequisites for ARC Configuration
4.4.2. Configuring an Ansys RSM Cluster (ARC) Using the ARC Configuration Application
4.4.3. Configuring an Ansys RSM Cluster (ARC) Using the Command Line (arcdeploy)

4.5. Defining an RSM Configuration for an Ansys RSM Cluster (ARC)

4.6. Ansys RSM Cluster (ARC) Command Usage and Options

4.6.1. Installing ARC Cluster Services on Windows (installservice)

4.6.1.1. Installing the ARC Master Service on a Windows Head Node
4.6.1.2. Installing the ARC Node Service on Windows Execution Nodes

4.6.2. Uninstalling ARC Cluster Services on Windows (uninstallservice)

4.6.3. Installing ARC Cluster Services on Linux

4.6.3.1. Adding Common Environment Variables for an ARC on Linux
4.6.3.2. Starting ARC Cluster Services Manually on Linux (arcmaster | arcnode)
4.6.3.3. Starting ARC Cluster Services Automatically at Boot Time for Linux (install_daemon)

4.6.4. Uninstalling ARC Cluster Daemon Services on Linux (uninstall_daemon)

4.6.5. Commands for ARC Job Management

4.6.5.1. Submitting a Job (arcsubmit)
4.6.5.2. Getting the Status of a Job (arcstatus)
4.6.5.3. Cancelling a Job (arckill)

4.6.6. Configuring ARC Cluster Nodes (arcconfig node modify)

4.6.6.1. Associating ARC Execution Nodes with the Master Node
4.6.6.2. Setting the Maximum Number of Cores to be Used on an Execution Node
4.6.6.3. Setting the Maximum Resource Allocation on an Execution Node

4.6.7. Displaying Resource Availability on ARC Nodes (arcnodes)

4.6.8. Configuring ARC Queues (arcconfig queue)

4.6.8.1. Adding a Cluster Queue
4.6.8.2. Removing a Cluster Queue
4.6.8.3. Modifying a Cluster Queue

4.6.9. Displaying the Status and Details of ARC Queues (arcqueues)

4.6.10. Caching Credentials for Cluster Job Submission (arccredentials)

4.6.11. Migrating an ARC Setup from a Previous Version (arcconfig migration)

4.7. Setting the ARC_ROOT Environment Variable for Ansys RSM Cluster (ARC) Job Submission

4.8. Dealing with a Firewall in a Multi-Node Ansys RSM Cluster (ARC)

4.9. Example: Setting Up a Multi-Node Ansys RSM Cluster (ARC)

5. RSM Integration with a Cluster or Cloud Portal

5.1. Configuring RSM to Use SSH for Job Submission and/or File Transfers to a Remote Linux Cluster

5.1.1. Defining a Configuration for a Remote Linux Cluster (SSH)
5.1.2. Configuring PuTTY SSH
5.1.3. Linux Path Configuration Requirements

5.2. Integrating RSM with a Microsoft HPC or Windows-Based Cluster

5.3. Integrating RSM with a Cloud Portal

6. RSM User Accounts and Passwords

6.1. Automatic Account Creation

6.1.1. Credential Caching from Workbench

6.2. Adding a User Account

6.3. Changing an Account Password

6.4. Deleting a User Account

6.5. Manually Running the Password Application

7. RSM Settings and Utilities

7.1. Specifying the Job Cleanup Period

7.2. Performing Administrative Tasks with the RSM Utilities Application

7.2.1. Managing RSM Configurations and Queues (rsm.exe | rsmutils config)

7.2.1.1. Creating an RSM Configuration
7.2.1.2. Deleting a Configuration
7.2.1.3. Creating an RSM Queue
7.2.1.4. Deleting an RSM Queue
7.2.1.5. Listing RSM Configurations and Queues

7.2.2. Editing RSM Application Settings (rsm.exe | rsmutils appsettings)

7.2.2.1. Specifying a Port Range for User Proxy Processes

7.2.2.2. Specifying a Port Range for User Proxy Socket File Transfers

7.2.2.3. Specifying a Directory for RSM Configuration Files

7.2.2.3.1. Querying the Location of the RSM Configuration Directory
7.2.2.3.2. Specifying the Location of the RSM Configuration Directory

7.2.3. Managing Credentials for RSM Queues (rsm.exe creds)

7.2.3.1. Caching Credentials for an RSM Queue
7.2.3.2. Validating Credentials for an RSM Queue
7.2.3.3. Listing the RSM Configurations Associated with an Account
7.2.3.4. Listing the Accounts Associated with an RSM Queue

7.2.4. Migrating RSM from a Previous Version

7.3. Refreshing the View

8. RSM Custom Integration

8.1. Understanding RSM Custom Architecture

8.1.1. Job Templates
8.1.2. Job Scripts
8.1.3. HPC Commands File
8.1.4. Job Configuration File

8.2. Custom Cluster Integration Setup

8.2.1. Customizing Cluster-Side Integration

8.2.1.1. Creating Copies of Standard Cluster Code Using a Custom Cluster Keyword
8.2.1.2. Modifying the Job Configuration File for a New Cluster Type
8.2.1.3. Modifying the Cluster-Specific HPC Commands File
8.2.1.4. Creating a Configuration for the Custom Cluster

8.2.2. Customizing Client-Side Integration

8.2.2.1. Creating Copies of Sample Code Using a Custom Client Keyword
8.2.2.2. Modifying the Job Configuration File for a New Cluster Type
8.2.2.3. Modifying the Cluster-Specific HPC Commands File
8.2.2.4. Creating a Configuration for the Custom Cluster

8.2.3. Configuring SSH/Custom File Transfers

8.3. Writing Custom Code for RSM Integration

8.3.1. Parsing of the Commands Output

8.3.1.1. Getting Output from Primary Commands in the Parsing Scripts
8.3.1.2. Outputting Variables from the Parsing Scripts
8.3.1.3. Required Output from Commands
8.3.1.4. Commands Output in the RSM Job Log

8.3.2. Customizable Commands

8.3.2.1. Submit Command
8.3.2.2. queryStatus Command
8.3.2.3. getAllStatus Command
8.3.2.4. queryQueues Command
8.3.2.5. getAllQueues Command
8.3.2.6. Cancel Command
8.3.2.7. createStorage Command
8.3.2.8. deleteStorage Command
8.3.2.9. uploadToStorage Command
8.3.2.10. downloadFromStorage Command
8.3.2.11. listStorageContents Command

8.3.3. Custom Integration Environment Variables

8.3.3.1. Environment Variables Set by RSM
8.3.3.2. Optional Environment Variables Set by Customer

8.3.4. Providing Custom Client Information for Job Submission

8.3.4.1. Defining the Environment Variable on the Client
8.3.4.2. Passing the Environment Variable to the Cluster
8.3.4.3. Verify the Custom Information on the Cluster

9. RSM Job Monitoring

9.1. Launching the RSM Job Monitoring Application

9.2. Monitoring Jobs in the RSM Job Monitoring Application

9.2.1. Viewing the Status of Jobs
9.2.2. Enabling Live Job Monitoring
9.2.3. Controlling the Job List Display
9.2.4. Filtering the Job List

9.3. Viewing a Job Log

9.3.1. Controlling the Job Log Display
9.3.2. Copying Text in the Job Log Display
9.3.3. Saving a Job Report
9.3.4. Hiding/Showing the Job Log Pane

9.4. Managing Jobs

9.4.1. Terminating a Job
9.4.2. Removing a Job

10. RSM Cluster Load Monitoring

10.1. Launching the RSM Cluster Load Monitoring Application

10.2. Monitoring a Cluster in the RSM Cluster Load Monitoring Application

10.3. Viewing Cluster Job Information

10.3.1. Sorting and Filtering the Cluster Job List

10.4. Controlling the Display of Cluster Monitors

11. RSM Troubleshooting

11.1. Accessing RSM Log Files
11.2. Troubleshooting RSM-Related Issues
11.3. Troubleshooting Product-Related Issues
11.4. Known Issues and Limitations