Compute Manager 1 Administrator’s Guide - PBS Works · Compute Manager 13.1 Administrator’s Guide iv Technical Support Contact technical support based on your location by phone

Compute Manager 1

Administrator’s Guide

Compute Manager 13.1 Administrator’s Guide

Intellectual Property Rights Notice: Copyrights, Trademarks, and Third Party Licenses Updated: August 31, 2016

Altair® PBS Works™ 13.1

Enabling On-Demand Computing™

Copyright© 1994-2016 Altair Engineering Inc. All Rights Reserved.

Compute Manager™ 2007-2016; Display Manager™ 2007-2016; PBS™ 1994-2016; PBS Professional® 1994-2016; PBS Application Services™ 2008-2016; PBS Analytics™ 2007-2016; and PBS Desktop™ 2007-2012; PBS Portal™ 2007-2011; e-BioChem ™ 2007-2013; e-Compute™ 2000-2007; e-Render™ 2006-2010; OpenPBS® 1994-2003 and Personal PBS® 2007-2012.

Other Altair software applications include:

Altair Simulation Cloud Suite: Simulation Manager™ 2003-2016; Compute Manager™ 2003-2016; Display Manager™ 2003–2016; and Process Manager™ 2003-2016.

Altair HyperWorks®: HyperMesh® 1990-2016; HyperCrash® 2001-2016; OptiStruct® 1996-2016; RADIOSS®1986-2016; HyperView® 1999-2016; HyperView Player® 2001-2016; HyperStudy® 1999-2016; HyperGraph® 1995-2016; MotionView® 1993-2016; MotionSolve® 2002-2016; HyperForm® 1998-2016; HyperXtrude® 1999- 2016; Process Manager™ 2003-2016; Templex™ 1990-2016; TextView™ 1996-2016; MediaView™ 1999-2016; TableView™ 2013-2016; BatchMesher™ 2003-2016; HyperMath® 2007-2016; HyperWeld® 2009-2016; HyperMold® 2009-2016; Manufacturing Solutions™ 2005-2016; solidThinking® 1993-2016; solidThinking Inspire® 2009-2016; solidThinking Evolve® 1993-2016; Durability Director™ 2009-2016; Suspension Director™ 2009-2016; AcuSolve® 1997-2016; AcuConsole® 2006-2016; SimLab® 2004-2016; Virtual Wind Tunnel™ 2012-2016; FEKO™ (©1999-2014 Altair Development S.A. (Pty) Ltd.; ©2014-2016 Altair Engineering, Inc.); MDS™ 2011-2016 and VisSim™ 1989-2016.

Altair Packaged Solution Offerings (PSOs) Copyright© 2008-2016 Automated Reporting Director™ 2008-2016; Impact Simulation Director™ 2010-2016; Model Mesher Director™ 2010-2016; Model Verification Director™ 2013-2016; Squeak and Rattle Director™ 2012-2016; Virtual Gauge Director™ 2012-2016; Weld Certification Director™ 2014-2016.

Altair intellectual property rights are protected under U.S. and international laws and treaties. Additionally, Altair software is protected under patent #6,859,792 and other patents pending. All other marks are the property of their respective owners.

ALTAIR ENGINEERING INC. Proprietary and Confidential. Contains Trade Secret Information. Not for use or disclosure outside of Altair and its licensed clients. Information contained in Altair software shall not be decompiled, disassembled, “unlocked”, reverse translated,

Special Notice: Pre-release versions of Altair software are provided ‘as is’, without warranty of any kind. Usage is strictly limited to non-production purposes.

ii


reverse engineered, or publicly displayed or publicly performed in any manner. Usage of the software is only as explicitly permitted in the end user software license agreement. Copyright notice does not imply publication.

Third Party Licenses

AcuConsole contains material licensed from Intelligent Light (www.ilight.com) andused by permission.

Software Security Measures:

Altair Engineering Inc. and its subsidiaries and affiliates reserve the right to embed software security mechanisms in the Software for the purpose of detecting the installation and/or use of illegal copies of the Software. The Software may collect and transmit non-proprietary data about those illegal copies. Data collected will not include any customer data created by or used in connection with the Software and will not be provided to any third party, except as may be required by law or legal process or to enforce our rights with respect to the use of any illegal copies of the Software. By using the Software, each user consents to such detection and collection of data, as well as its transmission and use if an illegal copy of the Software is detected. No steps may be taken to avoid or detect the purpose of any such security mechanisms.

iii

http://www.altairhyperworks.com/ClientCenter3rdPartyLicense.aspx

http://www.altairhyperworks.com/ClientCenter3rdPartyLicense.aspx

www.ilight.com


Technical Support

Contact technical support based on your location by phone or email.

This document is proprietary information of Altair Engineering, Inc.

Location Telephone EmailAustralia +1 800 174 396 [email protected] +86 21 6117 1666 [email protected] +33 1 4133 0992 [email protected] +49 7031 6208 22 [email protected] +91 80 66 29 4500

+1 800 425 0234 (Toll Free)[email protected]

Italy +39 800 905595 [email protected] +81 3 5396 2881 [email protected] +82 70 4050 9200 [email protected] +91 80 66 29 4500


North America +1 248 614 2425 [email protected] +49 7031 6208 22 [email protected] +46 46 460 2828 [email protected] +91 80 66 29 4500


South America +55 11 3884 0414 [email protected] +44 1926 468 600 [email protected]

iv

Contents

About this Guide ix

Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ixRelated Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ixDocument Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xAcronyms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xii

Chapter 1: Introduction to Compute Manager 1

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Supported Platforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Supported Browsers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Pre-installation planning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Hardware Requirements for CM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Prerequisites for Using CM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Google Chrome Frame plug-in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Licensing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Authentication, Authorization and Profile Sharing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Authorization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Profile Sharing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Options for Populating AMS with Users and Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

PBS Works Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Software Organization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Chapter 2: Post-Installation Steps 7

Configuring the License Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Adding the License Server in Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Adding the License Server in the Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Changing the AMS Administrator’s Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Migrating the AMS Datastore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Populating AMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Logging into AMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Adding Users and Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Managing User Accounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Managing User Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Defining Access Policies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20PAS Server Level Access Policies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21UI Level Access Policies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

v

Updating Default Access Policies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Creating Access Policies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Configuring Custom Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Configuring CM for RVS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Configuring Notifications for a Job State Change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Logging into CM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Adding and Registering PAS Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Adding a PAS Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Registering a PAS Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Chapter 3: Starting and Stopping PBS Works 43

Starting the PBS Works Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43Stopping the PBS Works Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Restarting the PBS Works Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Determining the Status of the PBS Works Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Chapter 4: Compute Manager Advanced Configuration 45

Adding a Generic Action for a PAS server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Defining a Generic Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Defining a generic action execution script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Mapping Help Topics and Icons to an Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Mapping a File Extensions to an Icon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52Installing and Configuring Google Chrome Frame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Enabling a Secure Connection between CM and PAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Mapping a MIME type to a File Extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Setting Maximum Page Size for Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Changing the Job Refresh Rate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57Changing the PAS Staging Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57Refreshing Application Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Configuring JVM Performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Improving CM Response Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Changing the Scheduled Time for Job Deletion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60Changing the Location of the Monitoring Action Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61Changing the Communication Timeout between CM and PAS . . . . . . . . . . . . . . . . . . . . . . . 63Customizing the Available Job Monitoring Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Changing the PAS Application Retrieval Timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Enabling RVS Traffic through CM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

vi Contents

Configuring RVS Admin Auto Refresh Interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69Configuring the Default Home Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Adding Site Specific Web Pages to CM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71Launching an Application Installed on a Remote Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

Configuring the Client to Open a Remote Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75Configuring Cross Mount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75Server Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76Modifying Application Launch Framework Client Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

Configuring Local Dynamic Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Setting the Popup Timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78Configuring the Advance Upload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79Configuration for Larger Sites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

Setting the Maximum Active Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79Setting the Work Memory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80Changing the Shared Buffer Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80Setting the Effective Cache Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81Changing Java Heap Memory in Linux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81Changing Java Heap Memory in Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

Enabling Apple Push Notifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82Configuring Time Interval of PAS Admin Requests on Credentials Expiration . . . . . . . . . 83Enabling Push Update Detailed Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84CM Configuration Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

Chapter 5: PBS Works Log Files 87

Chapter 6: Troubleshooting 89

Refresh Button Error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

Glossary 91

Contents vii

viii Contents

About this Guide

This document describes how to install, configure and administer PBS Works.

This chapter contains the following topics:• Audience• Related Documentation• Document Conventions• Acronyms

AudienceThis document is intended for administrators who perform the following tasks:

• Install and administer PBS Works products• Monitor the operation of PBS Works products• Troubleshoot PBS Works products

Related DocumentationThe other PBS Works related documents are as follows:

• PBS Works Installation Guide• PBS Works Administrator’s Guide• PBS Works Release Notes• Compute Manager Administrator’s Guide• Display Manager Administrator’s Guide• Results Visualization Service Administrator’s Guide

Documentation can be found at the following URL:

http://www.pbsworks.com/SupportGT.aspx?d=PBS-Professional,-Documentation

ix

http://www.pbsworks.com/SupportGT.aspx?d=PBS-Professional,-Documentation


Document ConventionsThe following typographical conventions are used in this document:

PBS Works Home Directory

CONFIG_HOME is where the PBS Works configuration and log files are stored. The location of this directory is platform dependent. For more information see Software Organization on page 6.

For example:

config.properties is stored in CONFIG_HOME\services\cm\config

PBS Works Execution Directory

SERVER_HOME is where the PBS Works binaries are stored. The location of this directory is platform dependent. For more information see Software Organization on page 6.

For example:

PBSWorksService.bat is stored in SERVER_HOME\scripts\

Installation Location

<INSTALL_DIR> is the location in a file system where an Altair product is installed. It is used when referencing a file that may need to be accessed or viewed by a systems administrator. For example:

<INSTALL_DIR>/portal/config.xml

File Pathname

Names of a file or a directory are displayed as follows:

/home/user1/submission_dir/PBSJobApp/174.hwesuse113.oe

Keyboard Inputs

Keyboard inputs, for example commands that are entered are displayed as follows:

./etc/init.d/pbsworks-pbsa start

Code Example and File Contents

Examples of programming code or the contents of a file are displayed as follows: if userInputs['ACCOUNT']:

job.attr_accounting_label =userInputs['ACCOUNT']

x


Parameters, Environment Variables, XML tags

Environment variables, XML tags, parameters, and references to a snippet of a file are displayed as follows:

Set the value of the MaxBackupIndex parameter to the maximum number of log files to keep.

UI Controls

User Interface controls such as command buttons, tab names, menu options, application fields, or items in a list are displayed as follows:

Click the Settings button.

Document References

References to an external document are displayed as follows:

For more information see the PBS Works 13.1 Administrator’s Guide.

Messages

Log file messages or messages returned from a command are displayed as follows:Please make sure PBSA engine and Monetdb Server are not running.

Notes

Information or notes that supplement or emphasize important points are displayed as follows:

Tips

Tips that makes your work easier are displayed as follows:

The default TOC type for a result file is set in the plugin_def.xml file

If you get an error during registration of the HyperView Player, right click on the shortcut and choose the Run as Administrator option from the context menu.

xi


Cautions

Cautions draw special attention to any action that could cause damage to the product or cause the loss of data. For example:

AcronymsThe following acronyms are used in this guide.

Do not turn the monitor off by unplugging it from the computer or wall socket. Severe damage to the monitor may result. Turn the monitor off before unplugging it.

Table 1. Acronyms

Term DefinitionAD Active DirectoryALF Application Launch FrameworkALM Altair License Management SystemAMS Access Management ServiceAPNS Apple Push Notification ServiceCAE Computer Aided EngineeringCentOS Community Enterprise Operating SystemCFD Computational Fluid DynamicsCM Compute ManagerDM Display ManagerESR Extended Support ReleaseFEA Finite Element AnalysisHPC High Performance ComputingHWU HyperWorks UnitIANA Internet Assigned Numbers AuthorityJRE Java Runtime EnvironmentJVM Java Virtual MachineLDAP Lightweight Directory Access ProtocolMBD Multi Body DynamicsMIME Multipurpose Internet Mail Extensions

xii


MOM Machine Oriented MiniserverPAS PBS Application ServicePBS Portable Batch SystemPBSA PBS AnalyticsRFB Remote File BrowserRHEL Red Hat Enterprise LinuxRVS Results Visualization ServiceSLES SuSE Linux Enterprise ServerSSH Secure Socket ShellSSL Secure Sockets LayerSSO Single Sign-OnUI User InterfaceXML eXtensible Markup Language

Table 1. Acronyms

Term Definition

xiii


xiv

1. Introduction to Compute Manager

IntroductionCompanies who have invested in high-performance computing (HPC) resources -- like clusters, supercomputers and cloud environments -- need these resources operating reliably around the clock. And just as importantly, the systems need to be easy to use, manage, and scale while still being cost-effective.

Altair’s PBS Works™ addresses these challenges with the most comprehensive suite of integrated HPC workload management products available from a single vendor. PBS Works simplifies and streamlines the management of HPC resources with powerful policy-based job scheduling, user-friendly web portals for job submission and remote visualization.

Components available through the installation of PBS Works:• Compute Manager™• Display Manager™• Access Management Services• Results Visualization Service

Compute Manager

Compute Manager™ (CM) is a job submission and monitoring portal which enables users to run, monitor and manage workloads on distributed resources remotely. Compute Manager uses the High Performance Computing (HPC) workload management capability of Altair's PBS Applica-tion Services (PAS) and PBS Professional for efficient resource utilization, access to the cloud for job submission, and subsequent accounting.

CM provides a web-based user interface and with minimal configuration. Compute Manager automates the job submission process, allowing users to spend more time creating better models and simulations. End user productivity improves since there are no complicated commands to learn or complex scripts to create and maintain. PBS Application Services allows you to tailor Compute Manager to fit your applications and user preferences, making job submission simple and error free.

1


Display Manager

Display Manager (DM) is a platform for collaboration and remote visualization of applications and data. It enables high performance remote display of applications over the networks using a web browser. It fosters team work and communications by allowing to share the sessions among users. Authorized users can all view and control a single session without downloading any files. This vir-tual-team productivity feature can save the costs associated with expensive face-to-face meetings and eliminate the need for multiple users in different sites to download Big Data files.

Results Visualization Service

Results Visualization Service (RVS) provides features to access, process and visualize CAE results remotely, through a web browser, without installing any post-processing desktop applications. RVS is available as part of the PBS Works suite and after installation it is available through the Compute Manager web applications. CAE analysts can monitor simulations in real-time by tracking and visualizing relevant parameters from solver log files. Plots and animations can be created remotely without downloading huge raw results files from compute clusters or remote networks locations. A variety of Finite Element Analysis (FEA) and Multi Body Dynamics (MBD) solvers are supported.

For more information about Results Visualization Service see the Results Visualization Service Installation and Administration Guide.

Access Management Service

Access Management Service (AMS) provides a centralized configuration system for authentication and authorization. With AMS administrators can manage users and groups, as well as access con-trol policies.

Supported PlatformsCompute Manager is supported on the following platforms:

Windows 64bit• Windows Server 2008 R2 • Windows Server 2012 • Windows Server 2012 R2

Linux 64bit • Red Hat Enterprise Linux (RHEL) 5, 6, and 7• Cent OS 5, 6, and 7• Suse Linux Enterprise Server (SLES) 11 and 12

2 Introduction to Compute Manager


Supported BrowsersWindows

• Firefox 45.3 ESR (Only Extended Support Release is supported. Please refer to https://www.mozilla.org/en-US/firefox/organizations/)

• Google Chrome 45.x and 46.x• Internet Explorer 11

Linux • Firefox 45.3 ESR (Only Extended Support Release is supported. Please refer to https://

www.mozilla.org/en-US/firefox/organizations/)• Google Chrome 45.x and 46.x

OSX • Safari 8.x and 9.x

Pre-installation planningPlease review the following sections before installing Compute Manager:

• Hardware Requirements for CM• Prerequisites for Using CM• Google Chrome Frame plug-in• Licensing• Authentication, Authorization and Profile Sharing• PBS Works Database

Hardware Requirements for CM Please review the following hardware requirements for Compute Manager.

Table 1. Hardware requirements for CM

Hardware Minimum Requirement RecommendedCPU 2 CPU cores with a minimum

speed of 2.5 GHz4 CPU cores with a minimum speed of 2.5 GHz

Memory (Physical) 2 GB 8 GBDisk Space 2 GB 4 GB

Introduction to Compute Manager 3


Prerequisites for Using CMIn order to register a user session of Compute Manager 13.1 to an Enterprise PBS Professional complex, the complex head node must be running PBS Application Services 12.x or later. Please contact your site administrator for further information.

Google Chrome Frame plug-inInternet Explorer versions 11 do not natively support the multi-file upload mechanisms for local files nor the file upload progress meter in Compute Manager. It has been observed that many times installing the Chromium projects Google Chrome Frame plug-in on Windows XP, Vista and Win-dows 7 has provided indirect support for this. However, this configuration has not formally been tested, so it is not fully supported by Altair. Please use the Chromium projects at your own discre-tion.

LicensingFor users to log into any of the PBS Works products, PBS Works must have access to an activated and running Altair License Management System (ALM) that allows a PBS Works product to draw license units. During the installation of PBS Works, you will be prompted to supply information about the license server (port and hostname/IP address). You may supply the information at this time, or PBS Works can be configured with this information post-installation.

The following HyperWorks Units (HWUs) are drawn for Compute Manager:• 2 HWUs are checked out at CM/DM server startup and stay locked all the time.• 1 additional HWU per concurrently logged in user is required.

Authentication, Authorization and Profile Sharing

Authentication

Authentication is the process of verifying the identity of an entity who attempts to access a PBS Works application. During installation, PBS Works products can be configured to use either Win-dows based or SSH based authentication, or can be configured to authenticate against the AMS datastore.

The AMS datastore is an internal repository automatically installed with PBS Works. It is used for storing users, groups, and access policies. If authentication is performed against the AMS data-store, then the datastore must be populated with users and/or groups before users can log into the CM web application.



Authorization

Authentication is the process of verifying someone's identity. Authorization is the process of spec-ifying the access permissions for that identity. Access policies are defined through AMS. Compute Manager and Display Manager supports specific authorization policies. By default, users who login to CM have authorization to access:

• all PAS servers• all applications installed on the PAS servers

AMS can be used to change this default authorization. Use AMS to control things, such as: • who can register a PAS server• which applications are available for job submission• who can browse local or remote files• which modules are available for the users

Profile Sharing

Job submission profiles are customized shortcuts for submitting jobs with CM. If multiple jobs are submitted to the same application with the same arguments, it makes sense to create a profile that has these arguments pre-populated. Job submission profiles can be shared among users and groups, however to share job submission profiles, users and groups must be added to AMS.

Options for Populating AMS with Users and Groups

There are two options available for populating AMS with users and groups:• During installation of PBS Works products, there is an option to connect AMS to a Win-

dows Active Directory (AD), or a Lightweight Directory Access Protocol (LDAP) compat-ible server. AMS will automatically be populated with those users and groups stored in the LDAP/AD. However, adding and deleting users via the AMS console is restricted when an LDAP/AD is being used. AMS can only be used to define access policies.

• Populate AMS with users and groups using the AMS console.

Introduction to Compute Manager 5


PBS Works DatabasePostgres will be installed by the PBS Works installer. The installer creates a database super user, “pbsworksuser”, if one is not supplied during installation.

The PBS Works database is installed and configured to use port 6767. If this port is not available during installation, then the PBS Works installer will increment the port number and try again. This will continue until a free port is found, or until 100 consecutive ports are refused at which point the installer will ask for a port.

Software OrganizationAfter a successful installation of PBS Works, two main directory structures are created. The loca-tion of these directories is platform dependent.

PBS Works home directory (CONFIG_HOME)

This is where the PBS Works configuration and log files are stored.

The default location for CONFIG_HOME is:

on Windows: C:\altair\pbsworks\13.1\home

on Linux: /var/spool/pbsworks/13.1/home

PBS Works execution directory (SERVER_HOME)

This is where the PBS Works binaries are stored.

The default location for SERVER_HOME is:

on Windows: C:\altair\pbsworks\13.1\exec

on Linux: /opt/altair/pbsworks/13.1/exec


2. Post-Installation Steps

Once the installation of all Compute Manager is complete, the following post-installation steps are required:

1. Configuring the License Server when a license server was not supplied during installation.2. Changing the AMS Administrator’s Password.3. Setting up authentication, authorization and profile sharing by performing one of the fol-

lowing steps:- Migrating the AMS Datastore. - Populating AMS for authentication, authorization and profile sharing.

4. Configuring Custom Resources. 5. Configuring CM for RVS when RVS is installed. 6. Configuring Notifications for a Job State Change. This step is not required, but is highly

recommended.7. Logging into CM.8. Adding and Registering PAS Servers for Compute Manager.

There are other advanced configuration topics. For more information see Compute Manager Advanced Configuration.

7


Configuring the License Server A license server must be configured during the installation of PBS Works, you will be prompted to supply information about the license server (port and hostname/IP address). You may supply the information at this time, or PBS Works can be configured with this information post-installation.

You can configure the license servers after installation in console mode or in the application.

Adding the License Server in ConsoleThe license server information is stored in the adminSettings.xml file.

The location of this file for a typical installation of a PBS Works product is:

on Windows: CONFIG_HOME\services\framework\data

on Linux: CONFIG_HOME/services/framework/data

Change the port and hostname of the XML element <value> to the port and hostname of the license server in the format port@hostname.

The PBS Works service must be restarted for these changes to take effect.

You must have administrative privileges to configure the Compute Man-ager license server.

Separate multiple server details with a colon (:) in Linux and with a semi-colon (;) in Windows.

<Category name="License Server"> <Setting name="Location" preference="true"> <value>6200@trlicsrv03</value> <class>com.altair.awpf.services.preferences.model.StringPreference</class> <displayName>Server Location</displayName> <isEnforced>true</isEnforced> <private>false</private> </Setting></Category>

8 Post-Installation Steps


Adding the License Server in the ApplicationYou can update the license server in the application as follows:

1. Click the Settings button . 2. Click Settings > License Server.3. Enter the details of the license server. You can provide multiple license server details.

4. Click the Apply. 5. Click Ok.6. Restart the PBS Works service.

Separate multiple server details with a colon ( : ) in Linux and with a semicolon (;) in Windows.

Post-Installation Steps 9


Changing the AMS Administrator’s Password Once a PBS Works product is installed, changing the AMS administrator password from the default of "adminadmin" to a secure site-specific password is highly recommended.

To change the AMS administrator password:

1. Navigate to the following directory:

on Windows: SERVER_HOME\binaries\common

on Linux: SERVER_HOME/binaries/common

2. Issue the following command to change the AMS administrator password:

SERVER_HOME/thirdparty/java/bin/java -jar AccessManagerInstallation.jar update-admin-password <oldpassword> <newpassword>

3. Encrypt the new password by issuing the following command (this command will output the password in its encrypted format):

SERVER_HOME/thirdparty/java/bin/java -jar AccessManagerInstallation.jar encrypt <newpassword>

4. Edit the file following file:

on Windows: SERVER_HOME\services\cm\config\authzlogin.properties

on Linux: SERVER_HOME/services/cm/config/authzlogin.properties

5. Change <ENCRYPTED_AMS_PASSWORD> to the encrypted format of the new password.

password=<ENCRYPTED_AMS_PASSWORD>

6. Restart the PBS Works service.



Migrating the AMS DatastoreMigrating the AMS datastore from your previous version of CM avoids having to re-enter users, groups, and authorization policies into AMS. To migrate the AMS datastore from your previous version of CM to 13.1, you will need to merge the previous version of the AMS datastore files with the 13.1 versions.

The previous version of the AMS datastore files should have been saved prior to installing a PBS Works 13.1 product. For more information see "AMS migration from previous versions of CM" in the PBS Works 13.1 Administrator’s Guide.

The files that will need to be merged are those that were saved prior to installing PBS Works 13.1 and the following files that are located in the PBS Works installation 13.1 directory:

• CONFIG_HOME/AMS/AAServiceHome/applications/cm/cmPolicy.xml

• CONFIG_HOME/AMS/AAServiceHome/resources/AA_Users.xml • CONFIG_HOME/AMS/AAServiceHome/resources/AA_Groups.xml

After installing PBS Works 13.1, follow these instructions for merging the files:

1. Copy all <user></user> tags from the previous version of AA_Users.xml to the 13.1 version of AA_Users.xml, except the users amadmin and portal_admin. Do not overwrite these users in the 13.1 version of AA_Users.xml:

The user amadmin is the AMS administrator and the user portal_admin is the PBS Works portal administrator entered during installation.

The xmllint command line tool may have to be used to reformat the XML files in a more readable format. Use the following command:xmllint --format <file_name> > temp_file

<?xml version="1.0" encoding="UTF-8"?><users> <user userName="amadmin"> <password>fnGbROpp3kCV65tCw52RBcsUmMnJfhuMnkgfm23UAQs=</password> </user> <user userName="<portal_admin"> <password>9z1WNgdMqjh42kPr7gGhbbKKlzVOWfeeVvQX00fRVc0=</password> </user></users>



2. Copy all <group></group> tags from the previous version of AA_Groups.xml to the 13.1 ver-sion of AA_Groups.xml, but do not overwrite the altairadmin group in the 13.1 version of AA_Groups.xml:

3. As the PBS Works portal administrator, log into Compute Manager.

4. Add all previous PBS Professional servers. It is VERY important to add a server with the same CM server name that was used for the previous CM release. You can determine those names by viewing the previous version of the cmPolicy.xml file, and searching for the tag Resource name="CM/Server”. You will see something similar to:

where hwe1 and hwe2 are the CM server names.

5. Once all servers have been added, copy the previous version of the cmPolicy.xmlfile to the location of the 13.1 version.


<?xml version="1.0" encoding="UTF-8" standalone="yes"?><groups> <group name="altairadmin" privilegeType="TRUE"> <user>portal_admin</user> </group></groups>

<Resource name="CM/Server"> <Resource name="CM/Server/hwe1"> <Resource name="CM/Server"> <Resource name="CM/Server/hwe2">



Populating AMS AMS must be populated with users and groups when any of the following conditions are met:

• AMS was chosen as the mechanism for authentication and is not connected to a LDAP/AD• your site wants to use the profile sharing functionality of CM• your site wants to define user or group access policies

For more information about authentication, authorization, or profile sharing see Authentication, Authorization and Profile Sharing on page 4.

Populating AMS requires the following steps:1. Logging into AMS.2. Adding Users and Groups when AMS is not connected to a LDAP/AD.3. Defining Access Policies for CM. This step is not required, but is highly recommended.

Logging into AMS To log into AMS, enter the following in the address bar of any supported browsers.

<PBS_WORKS_HOSTNAME:PORT>/pbsworks/ui/ams/

For more information about supported browsers see Supported Browsers on page 3.

The AMS login page will open in the browser as shown below:



Use the PBS Works portal administrator credentials to log into AMS. These credentials are speci-fied during the installation of PBS Works.

Adding Users and Groups

Managing User Accounts

Use the Users tab to manage user accounts added to AMS using the AMS console or through a connection to an LDAP/AD.

The Status Messages area provides information on the latest actions performed.

The Filter Records field above a column’s title can be used to filter the information displayed.

If Single Sign-On (SSO) is enabled, then the AMS login page will not be displayed.

Users cannot be added or deleted when AMS is connected to an LDAP/AD.



Use the Delete button located in the same row as the user to delete a user.

Click Add New to add a new user. Enter the user account information. The required fields are marked with an asterisk (*). Click Save to create the new user account.



Select a user in the list to view details of the user account.

Click the Edit tab to edit the user account details.

Once all updates to the user account information are complete, click Save.



Managing User Groups

Click the Groups tab to manage groups added to AMS using the AMS console or through a con-nection to an LDAP/AD.

The Status Messages area provides information on the latest actions performed.

The Filter Records field above a column’s title can be used to filter the information displayed.

Use the Delete button located in the same row as the group to delete a group.

User Groups cannot be added or deleted when AMS is connected to an LDAP/AD.



Click Add New to add a new group. Enter the group information. The required fields are marked with an asterisk (*). Click Save to create the new group.

Select a group in the list to view details of the group account.



Click the Edit tab to edit members of a group.

Select a user from the Available Users list and click to add the user to the group.

Select a user from the Users in the group list and click to remove the user from the group.

You can set administrator privileges for a group by enabling the Set Admin Privilege check box.

Once all updates are complete, click Save.



Defining Access PoliciesAccess policies determine which users or groups are granted access to perform certain activities. For instance, user1 can access the application Optistruct or the CFD group can access the Job Monitoring page.

To access the policies1. Click the Policies tab.

A list of available applications will be displayed. In this example, the only application available is Compute Manager (cm).

2. Click the cm application name.



Two categories of access policies are available:• PAS Server Level Access Policies on page 21• UI Level Access Policies on page 22

PAS Server Level Access Policies

The following default policies are established for each PAS server added to CM. You may modify these default policies to further restrict access.

• REGISTER_SERVER_POLICY - allows access to the PAS server for all authenticated users.• JS_LOCAL_BROWSE_POLICY - allows all authenticated users the ability to access local

files. • JS_REMOTE_BROWSE_POLICY - allows all authenticated users the ability to access

remote files located on the PAS server.• REGISTER_WITH_CUSTOM_CREDENTIALS - allows all authenticated users to register

the PAS server using custom credentials.• DISPLAY_APP_POLICY - allows all authenticated users to display all applications

installed on the PAS server.• DISPLAY_PROFILE_POLICY - restricts all authenticated users to view the shared pro-

files.



Click the expand/collapse icon next to Server to view PAS server level access policies.

UI Level Access Policies

UI level access policies can be established to restrict access to specific components of the CM user interface such as CM modules or web pages (Job Monitoring, Remote File Operations, and Job Submission), or specific UI components (buttons, panes, tool bars, etc.) within a module.

The following default policies are established for the UI. You may modify these default policies to further restrict access.

• CM_UI_DISPLAY_POLICY - allows access by all authenticated users to all modules and associated UI components.

• RFB_COMPONENTS_DISPLAY_POLICY - allows access by all authenticated users to all components of the Remote File Browsing web page.

Click the expand/collapse icon next to UI to view UI level access policies.



Updating Default Access Policies

The default policies can be modified to further restrict access.

To change access for a default policy:1. Select a default access policy in the Resource-Policy Names area.

Once a policy has been selected, the policy detail will be displayed. In this example, the default policy CM/Server/PAS Server/REGISTER_SERVER_POLICY has been selected. Currently, all authenticated users are allowed to register with this PAS server.

2. Enable the Edit checkbox.

3. Select users and/or groups.

To allow or deny access for all authenticated users enable the All Authen-ticated Users checkbox. To set access policies for a specific user/group or a set of users/groups, disable the All Authenticated Users checkbox.



4. Choose the appropriate ACTION Name based on the table below.

5. Choose the ALLOW option to allow access or the DENY option to restrict access from the Action Value list.

6. Click Save.

Action Name DefinitionREGISTER defines which users and groups can register with a PAS

server.DISPLAY_APP defines which users and groups can access applications

installed on a PAS server or can be used to define which users and groups can access profiles.

DISPLAY_UI defines which users and groups can access specific UI components.

LOCAL_BROWSE defines which users and groups can access local files during job submission.

REMOTE_BROWSE defines which users and group can access remote files located on a PAS server.

REGISTER_WITH_CUSTOM_-CREDENTIALS

defines which users and group can register with a PAS server using custom credentials.



Creating Access Policies

If you want to further restrict access to applications or specific components of the CM user inter-face, you will have to create some additional access policies using the following two categories:

• Application - restricts access to specific application installed on the PAS server.• MODULES - restricts access to specific UI components such as web pages, buttons, etc.

Managing Access to a Specific Application

You can create policies to restrict access to specific applications. By default, all authenticated users have access to view all application.

To add an access policy for an application:1. Click Application in the Resource-Policy Names area.2. Select the application from the list.

3. Click the Add New Policy button.4. Enter the policy name in the Policy Name text box. 5. Select the appropriate users and/or groups.

The policies created under applications or specific components of the CM user interface will override the default policy.



6. To allow access to the application, select the ALLOW option from the DISPLAY_APP Action Value list. To deny access to the application, select the DENY option from the DIS-PLAY_APP Action Value list.

7. Click Save.

Managing Access to UI Components

You can create policies to restrict access to certain UI components such as web pages, buttons, and tool bars. The Modules tree breaks each CM web page into its separate components and you may create policies that restrict access to these components.

For example, if you want to restrict access to the Job Monitoring page, then you would create an access policy by selecting MONITOR_MODULE. If you want to restrict access to the action bar of the Job Monitoring page, then you would create an access policy by selecting ACTION_BAR under MONITOR_MODULE.



To add an access policy for a UI component:1. Click on a UI component in the Resource-Policy Names area. In this example, an access

policy will be created for the Job Monitoring page.

2. Click the Add New Policy button.3. Enter the policy name in the Policy Name text box. 4. Select the appropriate users and/or groups.5. To allow access to the UI component, select the ALLOW option from the DISPLAY_UI

Action Value list . To deny access to the UI component, select the DENY option from the from the DISPLAY_UI Action Value list.



6. Click Save.



Configuring Custom ResourcesFor CM to support PBS Professional custom resources the custom resources must be defined to CM. This information is stored in the jobAttrib.xml file. The location of the file for a typical installation of CM is:

on Windows: CONFIG_HOME\services\cm\config

on Linux: CONFIG_HOME/services/cm/config

After this file is modified, the PBS Works service must be restarted for the changes to take effect.

The following XML defines the custom resource to CM:

The following table describes the XML attributes of the custom resource definition:

<resources> <resource name="string" displayName="string" resourceType="string" visible="true/false" type="string" detailOnly="true/false"/></resources>

Table 1. Attributes of the custom resource definition

Attribute Description Valid Valuesname Name of the resource as

defined by PBS Profes-sional in the <PBS_HOME>/server_priv/resourcedef file, where <PBS_HOME> is the PBS Professional home directory.

Must be alphanumeric [A-Z], [a-z], [0-9], and can include an underscore.

displayName The name of the custom resource as it will be dis-played on the Job Moni-toring page of the CM web application.

Must be alphanumeric [A-Z], [a-z], [0-9], and can include an underscore and spaces.



resourceType Determines whether the custom resource is a PBS Professional resource list type or a resource used type. By default, custom resources are of resource list type.

list custom resource is a resource list type

used custom resource is a resource used type

visible Enables or disables the display of the custom resource on the CM Job Monitoring page. If this property is dis-abled, then the detai-lOnly attribute is ignored.

true enable display of the custom resource

false disable the display of the custom resource

type The data type of the cus-tom resource as it is defined in CM.

duration supports duration which is stored as a long value in PBS. To use the CM data type of duration, the value of the PBS custom resource should be stored in an epoch date format.

long supports PBS resource type long.float supports PBS resource type float.string supports PBS resource type string

and string_array.boolean supports PBS resource type Bool-

ean.size supports PBS resource type size.

detailOnly Enables or disables the availability of the custom resource as a displayable column in the job grid of the CM Job Monitoring page.

true The custom resource will only be displayed on the Property tab of the Job Monitoring page.

false The custom resource can be added as a displayable column in the job grid, and will also be dis-played on the Property tab of the Job Monitoring page.

Table 1. Attributes of the custom resource definition

Attribute Description Valid Values



For example, custom resources are defined in the PBS Professional resourcedef file:

Add the following XML to the jobAttrib.xml file to define the pas_billing_accounts custom resource to CM:

The custom resource can now be added to the job grid of CM Job Monitoring page.

pas_billing_accounts type=string_arraypas_policies type=string_arraypas_applications type=string_arraypas_applications_enabled type=string_array flag=hpas_platform type=string_array flag=hpas_candidate_hosts type=string_arraypas_operating_system type=string_array flag=hpas_cpu_arch type=string_array flag=h

<resources> <resource name="pas_billing_accounts" displayName="Billing Account" resourceType="list" visible="true" type="string" detailOnly="false"/></resources>



The custom resource is displayed on the Property tab of the Job Monitoring page.

Setting the XML attribute visible to false disables the display of the custom resource entirely.

Changing the XML attribute detailOnly to true disables the availability of the custom resource as a displayable column in the job grid of the Job Monitoring page. However, the custom resource will be displayed on the Property tab of the Job Monitoring page.

<resources> <resource name="pas_billing_accounts" displayName="Billing Account" resourceType="list" visible="false" type="string" detailOnly="false"/></resources>

<resources> <resource name="pas_billing_accounts" displayName="Billing Account" resourceType="list" visible="true" type="string" detailOnly="true"/></resources>



Configuring CM for RVSDue to a known problem with the RVS cache, the following configuration must be performed for the 12.0 and later releases of CM. This configuration is necessary only when RVS is installed.

1. If the cache.manifest file does not exist, start the PBS Works service. The file is located in the following directory for a typical installation of CM:

on Windows: SERVER_HOME\binaries\framework\applica-tions\login\resources\<LOCALE_NAME>\manifest\framework

on Unix/Linux: SERVER_HOME/binaries/framework/applications/login/resources/<LOCALE_NAME>/manifest/framework

2. Edit the cache.manifest file and add the following to the end of the file:

plugins/rm/plugin.js

The contents of the cache.manifest file should now look like this:

3. Edit the file platform.xml. The location of this file for a typical installation of CM is:

on Windows: CONFIG_HOME\framework\config

on Linux: CONFIG_HOME/framework/config

4. Disable the generation of the cache.manifest file on server startup by modifying the follow-ing line, setting the value to false:

<generate-manifest-on-startup>false</generate-manifest-on-startup>


CACHE MANIFEST#Version 23243423423342

CACHE:../framework/login/login/resources/images/login/btn_login.png../framework/login/login/resources/images/login/icnUsername.png../framework/login/login/resources/images/login/icnPassword.png../framework/login/login/resources/images/login/btn_help.png../framework/login/login/resources/images/login/icnLogin.png../framework/login/login/resources/images/login/imgLoader.gifplugins/rm/plugin.js



Configuring Notifications for a Job State ChangeUsers of CM can configure email notifications when a job's state changes, including who will receive the email notification, and when the email will be sent. Currently, Compute Manager sup-ports sending email notifications for the following job state changes:

• job is aborted• job begins execution• job finishes execution

However, the email will not be sent unless the application associated with the job has been config-ured accordingly. This is done through the application definition.

Configuring email notifications requires two steps:

1. Each CM user must set their email preferences through the CM web application.

a. Click the Settings button . b. Click Settings > Compute Manager. c. Enter an e-mail id in the Email field to indicate to whom the e-mail will be sent. d. Select any or all of the options in the Notify when job state changes to list to indicate

when the e-mail will be sent.



2. The application definition must be modified to support the email notification. This is accomplished by modifying the application definition submittime script, presubmit.py, with the following lines of code:

This code captures the mail preferences entered through Compute Manager, and sets the job's mail options so that PBS Professional knows to send an email when a particular job state is reached.

import re

''' Mail Options '''

if userInputs['MAIL_USERS']: job.attr_mail_list = userInputs['MAIL_USERS']

if userInputs['MAIL_POINTS']:

mail_points = userInputs['MAIL_POINTS']

if re.match(r"[abe]", mail_points): job.attr_mail_options = mail_points



Logging into CMUse any of the Supported Browsers to login to CM through the URL:

http://<hostname>:<port>/pbsworks

Once the PBS Works login screen is displayed, enter your Username and Password and click Login.

If Single Sign-On (SSO) is enabled, then the CM login page will not dis-played.



Adding and Registering PAS ServersCompute Manager communicates with your PBS Professional workload manager through PBS Application Services (PAS). PAS is software that sits on top of your PBS Professional complex, exposing a collection of web services that allow Compute Manager to submit, monitor and manage jobs on your remote PBS Professional complex. PAS is installed on the PBS Professional headnode.

A PAS server must be added to CM before non-administrative users can submit jobs to its associ-ated PBS Professional Complex. Once the PAS server is added, all CM users, including the admin-istrator, must establish a connection to the PBS Professional complex by registering the PAS server.

Submitting jobs to a PBS Professional complex requires the following steps:• Adding a PAS Server - The PAS server, installed on the headnode of the PBS complex,

must be added to CM by a PBS Works administrator.• Registering a PAS Server - Users must register with the PAS server to establish a connec-

tion to the PBS complex.

Once a user registers the PAS server, CM automatically populates itself with the available PBS complex queues, jobs, and applications. The user is now able to submit and manage their jobs.

Auto Register option allows the administrator to register the server(s) to all the users while Adding a PAS Server.



Adding a PAS ServerThe following information will be requested when a PAS server is added:

• the hostname of the machine where PAS is installed (typically the PBS Professional head-node)

• the administrator's login credentials• the home location path for the users• whether to enable communication between CM and PAS over https• whether to automatically register the PAS server for all users?

To add a PAS Server:

1. Click the Settings button .

2. Click Manage.



3. Click Add.

The Add Server dialog box is displayed:



4. Enter the following information and click Add to add the server:- name of the PAS server as it will be known in Compute Manager in the Server Name

field.- hostname of the machine where PAS is installed (typically the PBS Professional head-

node) in the Host field.- the login credentials of the machine where PAS installed in the Username and Pass-

word fields.- configure the user's default home location in the Home Path filed. By default, the

home path location is $Home. Compute Manager displays the contents of this home directory path from the Remote Files web page, Job Submission web page, and in the Files Contents tab in the Monitoring web page. Refer to Configuring the Default Home Path.

- for a secure connection between Compute Manager and the PAS server, enable the Connect over SSL check box.

- enable the Auto Register check box to register the PAS server automatically for all users.

5. Click Add to add the server.

If the PAS server is added successfully, the following message will be displayed. Click OK.

If the server add fails, then review the CM log file CONFIG_HOME/logs/cm/cm.log, and the PAS log file <PAS_HOME>/logs/pas-server.log to determine the cause of the failure.

The Auto Register option is disabled, if Single Sign-On (SSO) is enabled.



PAS servers that were successfully added will now be displayed.

6. Click Add, if you want to add another PAS servers. When you are done adding servers, click Close.



Registering a PAS Server

1. To register a PAS server, click the Settings button .

2. Click Register.

3. Choose a PAS server from the Servers list by selecting the server name and click Save.

By default, Use CM Credentials check box is enabled to log into Compute Manager (this only works if your PAS credentials are the same as your CM credentials). If you want to reg-ister with the PAS Server other than the CM credentials, then disable the Use CM Creden-tials check box and enter the Username and Password credentials which is available in the PAS Server.

A notification of the successful registration of the server can be viewed by clicking the Messages link in the Compute Manager toolbar.

The Use CM Credentials option is disabled, if Single Sign-On (SSO) is enabled.


3. Starting and Stopping PBS Works

Use the information in this chapter to start, stop, and restart the PBS Works service.

Typically, the PBS Works service is installed and configured to use port 8086. If this port is not available during installation, then the PBS Works installer will increment the port number and try again. This will continue until a free port is found, or until 100 consecutive ports are refused at which point the installer will ask for a port.

If PBS Works is installed on a Windows platform, then a separate service is registered specifically for the PBS Works database. This service will automatically be started when the PBS Works service is started.

Starting the PBS Works ServiceLinux

At the Linux command line prompt enter:/etc/init.d/pbsworks start

Windows

1. Navigate to Control Panel -> Administrative Tools -> Services.

2. Right-click PBSWorks Service

3. Select Start.

43


Stopping the PBS Works ServiceLinux

At the Linux command line prompt enter:/etc/init.d/pbsworks stop

Windows



3. Select Stop.

Restarting the PBS Works ServiceLinux

At the Linux command line prompt enter:/etc/init.d/pbsworks restart

Windows



3. Select Restart.

Determining the Status of the PBS Works ServiceLinux

At the Linux command line prompt enter:/etc/init.d/pbsworks status

Windows


2. View the Status column of the PBSWorks Service to determine the status of the service.

44 Starting and Stopping PBS Works

4. Compute Manager Advanced Configuration

This chapter contains advanced configuration options for Compute Manager. Changes to the default settings associated with the following topics is NOT necessary to use Compute Manager. For an overview of CM configuration files see CM Configuration Files.

• Adding a Generic Action for a PAS server• Mapping Help Topics and Icons to an Application• Mapping a File Extensions to an Icon• Installing and Configuring Google Chrome Frame• Enabling a Secure Connection between CM and PAS• Mapping a MIME type to a File Extension• Setting Maximum Page Size for Files• Changing the Job Refresh Rate• Changing the PAS Staging Directory• Refreshing Application Definitions• Configuring JVM Performance• Improving CM Response Time• Changing the Scheduled Time for Job Deletion• Changing the Location of the Monitoring Action Bar• Changing the Communication Timeout between CM and PAS• Customizing the Available Job Monitoring Properties• Changing the PAS Application Retrieval Timeout• Enabling RVS Traffic through CM• Configuring RVS Admin Auto Refresh Interval• Configuring the Default Home Path• Adding Site Specific Web Pages to CM• Launching an Application Installed on a Remote Server• Configuring Local Dynamic Application• Setting the Popup Timeout

45


• Configuring the Advance Upload• Configuration for Larger Sites

- Setting the Maximum Active Connections- Setting the Work Memory- Changing the Shared Buffer Size- Setting the Effective Cache Size- Changing Java Heap Memory in Linux- Changing Java Heap Memory in Windows

• Enabling Apple Push Notifications• Configuring Time Interval of PAS Admin Requests on Credentials Expiration• Enabling Push Update Detailed Logs

Adding a Generic Action for a PAS serverA generic action is similar to an application definition's application action. The main difference is that an application action is associated with particular application, while generic actions are simple python scripts that run on a PAS server irrespective of the job or application.

An XML file is used to define generic actions. Since generic actions are associated with a PAS server, a separate XML file must be maintained for each PAS server. For a typical installation of CM, these XML files are located in:

on Windows: CONFIG_HOME\services\cm\config\genericActions

on Linux: CONFIG_HOME/services/cm/config/genericActions

The naming convention of a generic action XML file is servername.xml where servername is the name of the server as it is known to CM (the PBS Works portal administrator chooses this name when the PAS server is added to CM).

46 Compute Manager Advanced Configuration


Below is an example of a generic action for the server "hwe1", stored in a XML file called hwe1.xml. A job can be selected from the Job Monitoring page of CM, and the generic action can be exe-cuted. This generic action allows a command and command options to be entered. CM will then run the command. For an example of this generic action see the topic “Executing a Job Action” in the Compute Manager User’s Guide.

<?xml version="1.0" encoding="UTF-8"?><GenericActionsList xmlns="http://schemas.altair.com/gen-actions" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:schemaLocation="gen-actions.xsd"> <GenericAction> <Name>EXECUTE_COMMAND</Name> <DisplayName>Execute Command</DisplayName> <Description>Enter a command to execute</Description> <ScriptLocation>/home/pbsadmin/GenericActions/ExecCmd.py</ScriptLocation> <ArgumentChoice> <ArgumentString> <Name>COMMAND</Name> <Description>Enter a command to execute</Description> <DisplayName>Command to execute</DisplayName> <InputRequired>true</InputRequired> </ArgumentString> </ArgumentChoice> <ArgumentChoice> <ArgumentString> <Name>ARGUMENTS</Name> <Description>Enter any command arguments</Description> <DisplayName>Command arguments</DisplayName> <InputRequired>true</InputRequired> </ArgumentString> </ArgumentChoice> <ShowOutput>true</ShowOutput> </GenericAction></GenericActionsList>

Compute Manager Advanced Configuration 47


Defining a Generic ActionThe following XML elements provide a way of identifying and describing the generic action:

• <Name> is the internal name of the generic action.• <DisplayName> is the name of the generic action that will be displayed to the user via CM. • <Description> is the description of the generic action. • <ScriptLocation> is the location of the execution script.

<ArgumentChoice> defines arguments (input fields) that a user will enter prior to executing the generic action.

The following elements define an argument:• <Name> defines the internal name of the generic action argument.• <Description> is a description displayed when a rollover of the field is triggered in CM.• <DisplayName> is the name of the argument that will be displayed by CM. • <InputRequired> indicates a required field (a true value indicates a required argument).

<GenericAction> <Name>EXECUTE_COMMAND</Name> <DisplayName>Execute Command</DisplayName> <Description>Enter a command to execute</Description> <ScriptLocation>/home/pbsadmin/GenericActions/ExecCmd.py</ScriptLocation></GenericAction>

<ArgumentChoice> <ArgumentString> <Name>COMMAND</Name> <Description>Enter a command to execute</Description> <DisplayName>Command to execute</DisplayName> <InputRequired>true</InputRequired> </ArgumentString></ArgumentChoice><ArgumentChoice> <ArgumentString> <Name>ARGUMENTS</Name> <Description>Enter any command arguments</Description> <DisplayName>Command arguments</DisplayName> <InputRequired>true</InputRequired> </ArgumentString></ArgumentChoice>



The last element, <ShowOutput>, enables or disables the display of the generic action output. If the value is set to true, then the output of the generic action can be viewed by selecting the Actions tab on the Job Monitoring page of CM.

Defining a generic action execution scriptThe generic action script is a python script that is responsible for executing the generic action, using the information entered by the user (defined by the generic action XML file). You can directly edit this script, taking full advantage of Python to add further inspection and complexity to the execution of the generic action. In this example, the python script will create a subprocess to execute the command entered by the user.

import subprocess, sys, os

def execcmd(cmd): try: p = subprocess.Popen(cmd, shell=True, stdout=subprocess.PIPE, stderr=subprocess.STDOUT) data = "" for line in p.stdout.readlines(): data = data + line except: errTtype = sys.exc_type try: errName = errTtype.__name__ except AttributeError: errName = errType data = "Error: " + str(errName) + " --- " + str(sys.exc_value) return data

cmd = sys.argv[1]cmd = cmd + " " + sys.argv[2]print (cmd)print execcmd(cmd)sys.stdout.flush()



Mapping Help Topics and Icons to an ApplicationHelp topics can be added to CM and these topics can be mapped to a specific application. Access to the help topic is through the Job Submission page. In addition, application icons can be mapped to an application.

The XML file, app-helper.xml, is where application help topics and application icons are mapped to an application. The location of this file for a typical installation of CM is:



The help topic is stored in an HTML file. For a typical installation of Compute Manager, the help topics must be placed in the following directory:

on Windows: SERVER_HOME\applications\cm\binaries\ui\applicationHelp

on Linux: SERVER_HOME/applications/cm/binaries/ui/applicationHelp

Create applicationHelp folder to place the HTML files, if the folder does not exists in the specified location.



For a typical installation of Compute Manager, the icon image file must be placed in the following directory:

on Windows: SERVER_HOME\applications\cm\binaries\ui\images\appicons

on Linux: SERVER_HOME/applications/cm/binaries/ui/images/appicons

This is an example of a help topic and icon that has been mapped to an application:

The following table describes the XML attributes of the application help and icon mapping file:

Create appicons folder to place the icons, if the folder does not exists in the specified location.

<applications>

<application id="SampleApp" helpUrl="ui/cm/applicationHelp/SampleApp.html" icon="appicons/SampleApp.png" />

</applications>

Table 1. Attributes of the application help and icon mapping file

XML Attribute Descriptionid The name of the application as it is defined through the PAS application

definition.helpURL Location of the help topic.icon Location of the icon image file.



Mapping a File Extensions to an IconIcons can be mapped to a file extension. This information is used by CM to display customized file types and icons when viewing remote files.

The XML file, file-extension.xml, is where file extensions are mapped to an icon. The location of this file for a typical installation of CM is:





These are examples of file extensions that have been mapped to an icon:

The following table describes the XML attributes of the file extension mapping file:

<fileextensions> <fileextension name="pdf" displayText="Acrobat" icon="icon_pdf.png" ></fileexten-sion> <fileextension name="xml" displayText="XML" icon="icon_xml.png" ></fileextension> <fileextension name="zip" displayText="Archive" icon="icon_zip.png" ></fileexten-sion> <fileextension name="doc" displayText="Word" icon="icon_word.png" ></fileexten-sion> <fileextension name="docx" displayText="Word" icon="icon_word.png" ></fileexten-sion> <fileextension name="txt" displayText="Text" icon="icon_text.png" ></fileexten-sion> </fileextensions>

Table 2. Attributes of the file extension mapping file

XML Attribute Description name The file extension.displayText CM will display this as the files type.icon Icon image file.



Installing and Configuring Google Chrome FrameInstalling Google Chrome Frame on IE 8 and 9 can significantly improve the performance of RVS, especially plotting use cases. However, the plug-in appears to have some random issues with the Hyperview Player plug-in, which sometimes leads to unexpected behavior during animation data viewing. In these instances, the generated animation file (h3d) can be downloaded and viewed locally using the standalone version of HyperView player. This configuration (Google Chrome Frame + IE 8/9/10/11) has not been formally tested, so it is not fully supported by Altair. If issues arise, it may be recommended to uninstall the plug-in.

To install Google Chrome Frame:

1. Open Internet Explorer 8, 9, 10, or 11.

2. Go to http://www.google.com/chromeframe/.

3. Download Google Chrome Frame.

4. Close Internet Explorer.

5. Open Internet Explorer.

6. Go to Manage Add-ons to verify that the Google Chrome Frame plug-in is installed and enabled. If it is not enabled, then enable the plug-in.

To configure Google Chrome Frame, modify the cm.html file. The location of the file for a typical installation of CM is:

on Windows: SERVER_HOME\applications\cm\binaries\ui

on Linux: SERVER_HOME/applications/cm/binaries/ui

1. Edit the cm.html file.

2. Change the value of content to IE=Edge,chrome=1:

<meta http-equiv="X-UA-Compatible" content="IE=Edge,chrome=1">

For more information see http://www.chromium.org/developers/how-tos/chrome-frame-getting-started/


http://www.google.com/chromeframe/

http://www.chromium.org/developers/how-tos/chrome-frame-getting-started/


Enabling a Secure Connection between CM and PASEnabling a secure connection (SSL) between CM and PAS can be done while adding a PAS server to CM. A check box is available that enables the secure connection between CM and the PAS server. No other special configuration is required for CM.

Mapping a MIME type to a File ExtensionMIME (Multipurpose Internet Mail Extensions) is a specification for formatting non-ASCII mes-sages so that they can be sent over the Internet. In addition to e-mail applications, web browsers also support various MIME types. This enables the browser to display files that are not in HTML format.

The file, mimetypes.default, is where MIME types are mapped to a file extension. The location of this file for a typical installation of CM is:



The format of the file is:

mimeType1 ext1 ext2....extn

These are examples of MIME types that have been mapped to a file extension:

The Internet Assigned Numbers Authority (IANA) is responsible for the global coordination of Internet protocol resources and maintains a list of valid MIME types at http://www.iana.org/proto-cols/.

text/calendar ics ifbtext/css csstext/csv csvtext/directorytext/dnstext/enrichedtext/html html htmtext/plain txt text conf def list log in py fem out


http://www.iana.org/protocols/

http://www.iana.org/protocols/


Setting Maximum Page Size for FilesCM allows the systems administrator to set the maximum file size (in bytes) for displaying a file in a single page. This information is stored in the file config.properties. The location of this file for a typical installation of CM is:



Two parameter in this file are responsible for setting the maximum page size for a file:• maxFileSize - Any files larger than this value will have an option to be viewed in multiple

pages having a page size of pageSize. • pageSize - Determines the page size to display.

When CM displays a file greater in size than maxFileSize, the user will be presented with four options:

1. Download the file2. Show the file in one page3. Show the file in multiple pages4. Edit the file


# The values below are in bytes# Default max is set to 1000k i.e. 1000*1024maxFileSize=1024000# Default page size is set to 500k i.e 500*1024pageSize=512000



Changing the Job Refresh RateThe default time interval for the CM scheduler to refresh the job details on the Job Monitoring page of CM is ten (10) seconds after the minute. This time interval can be changed by updating the cron expression in the spring-config.xml file. The location of the file for a typical installation of CM is:

on Windows: SERVER_HOME\services\cm\config

on Linux: SERVER_HOME/services/cm/config

This is the area of the file that will need to be modified:


Changing the PAS Staging DirectoryAfter job submission, CM copies the job files to the PAS staging directory before the job is trans-ferred to PBS Professional for execution. When PBS Professional selects the job for execution, the files are staged-in to the execution host from the staging directory. Upon job completion, any files the job wants to retain are staged-out by PBS Professional to the staging directory, and CM retrieves them from there.

Changing the stage directory must be done through PAS. For more information see “Configuring PBS Application Services” in the PBS Application Services Administrator's Guide. This guide can be downloaded from the PBS Works documentation user area.

All CM users will have to unregister and re-register with the PAS server to use the new staging directory.

<bean id="updateJobsTrigger" class="org.springframework.scheduling.quartz.CronTrig-gerBean"> <property name="jobDetail"> <ref bean="updateJobsBean" /> </property> <property name="cronExpression">

<value>0/10 * * * * ?</value> </property> <property name="name" value="updateJob" /> <property name="group" value="jobGroup" /></bean>



Refreshing Application DefinitionsPBS Application Services requires a predefined set of instructions, called application definitions, to describe application parameters to users, store their responses, and prepare those responses for job execution via PBS Professional. These application definitions are stored in a central repository and PAS will make PBS Professional aware of each of them upon server startup.

When a user selects an application on the Job Submission page of CM, CM makes a call to PAS to retrieve the application definition information. Prior to CM 12.1, this information was cached by CM. If an application definition was updated at the PBS Application Services layer, then CM had to be refreshed by restarting the PAS server, and then waiting for CM to refresh the application.

In CM 12.1 or later, the application information is no longer cached. If an application definition is updated at the PBS Application Services layer, CM can be refreshed by clicking on F5 to refresh the CM session. This reduces the wait time necessary for modifications to an application definition to appear in CM, greatly improving the development cycle for application definition authors.

Configuring JVM PerformanceTo ensure the proper scalability of larger job history counts, you may want to adjust the Java Vir-tual Machine (JVM) memory heap size of the portal. See “Configuring JVM Performance” in the PBS Works Administrator's Guide for more details. This guide can be downloaded from the PBS Works documentation user area.



Improving CM Response TimeThere are several parameters that can be adjusted to improve CM response time. These parameters are located in the config.properties file. For a typical installation of CM, this file is stored at:



The recommended values for these parameters are based on the following factors and need to be considered before making any adjustments:

1. Deployment configuration of CM, PAS, and PBS Professional2. Hardware configuration3. Memory4. Number of jobs5. Number of concurrent users

Before any changes are made to improve the response time of CM, it is important to understand how CM communicates with PAS.

Periodically, CM communicates with PAS to synchronize job information. CM queries PAS for a summary of job information for all jobs. The information supplied by PAS provides CM with enough information to determine whether there are any new jobs since the last synchronization, or if anything has changed in reference to any known jobs, for instance, job status or job details.

Once CM determines which jobs have changed or are new, it again queries PAS for full job infor-mation (the equivalent of qstat -fx) for those jobs. Depending on how may jobs are currently being processed by PAS, the information returned in this query can be extremely large. Therefore, CM requests this data in chunks. Each chunk represents a certain number of jobs. Currently, CM is configured to make these requests in chunks of 1000 jobs. If 5000 jobs have changed since the last synchronization, then the full job information is returned in 5 chunks of 1000 jobs.

The parameter that determines the chunk size is jobBatchUpdateChunkSize:

jobBatchUpdateChunkSize=1000

In addition, during the synchronization, CM determines if any jobs have been removed from PAS (qdel), and will delete these jobs from CM. The job deletion activity can degrade CM response

Contact Altair site support before making changes to these parameters.



time, so a configurable parameter is available that allows the deletion of the jobs to be done via a cron job that is scheduled to run once a day, rather than deleting the jobs during the synchroniza-tion. The parameter that determines the deletion activity is deleteJobsByScheduler:

deleteJobsByScheduler=true

If this parameter is set to true, the job deletion will be performed as a cron job. The scheduling of this cron job is done via the spring-config.xml file. For more information see Changing the Scheduled Time for Job Deletion. If this parameter is set to false, the job deletion will be per-formed during the CM/PAS synchronization.

Communication between CM and PAS is multi-threaded. CM implements a thread pool to reduce the overhead of creating and destroying threads, and to limit the amount of threads to avoid exces-sive memory consumption due to resource thrashing. CM by default has a thread pool size of 4, however this is configurable and can be changed via the threadPoolSize parameter. When JobUp-dateThreadEnabled=false, then it is assumed that threadPoolSize=1.

JobUpdateThreadEnabled=true

threadPoolSize=4

Changing the Scheduled Time for Job DeletionBy default, jobs that have been deleted from PAS are removed from the CM database every 30 minutes. This can be changed by updating the cron expression in the spring-config.xml file. The location of the file for a typical installation of CM is:





<bean id="deleteJobsTrigger" class="org.springframework.scheduling.quartz.CronTrig-gerBean"> <property name="jobDetail"> <ref bean="deleteJobsBean" /> </property> <property name="cronExpression">

<value>0 0/30 * * * ?</value> </property></bean>


http://www.quartz-scheduler.org/documentation/quartz-1.x/tutorials/crontrigger


Changing the Location of the Monitoring Action BarCM allows the systems administrator to choose where to locate the CM Monitoring job action bar. This information is stored in a file called config.properties. The location of this file for a typical installation of CM is:



The job action bar can be located at the top of the Monitoring page by setting the value of jobActionBarOnTop to true:

jobActionBarOnTop=true



Or, it can be placed in the middle of the CM Monitoring page (default location) by setting the value of jobActionBarOnTop to false:

jobActionBarOnTop=false:




Changing the Communication Timeout between CM and PASCM provides the following connection timeout values for communication between CM and PBS Application Services. There are three categories and the timeout values vary depending on the type of operation that is being performed:

• Short• Long• Extra long

Exceptions are the job submission operations GetApplicationDefinition and RefreshApplica-tionDefinition. The timeout value for these operations can be configured by updating a parame-ter in the config.properties file - for more information see Changing the PAS Application Retrieval Timeout.

Operations for Job Submission & Job Monitoring Timeout Category Default length of timeout

GetApplicationActions Short 300000 ms (5 min)MoveJob Short 300000 ms (5 min)OrderJobs Short 300000 ms (5 min)TerminateJob Short 300000 ms (5 min)SubmitJob Short 300000 ms (5 min)GetJobSummary Long 600000 ms (10 min)deleteFinishedJob Long 600000 ms (10 min)GetJobs Long 600000 ms (10 min)ExecuteApplicationAction Extra Long 5 X Long timeout value

Operations for Remote Files Timeout Category Default length of timeoutdirectoryCreate Short 300000 ms (5 min)directoryDelete Short 300000 ms (5 min)fileList Short 300000 ms (5 min)fileRead Short 300000 ms (5 min)fileDelete Short 300000 ms (5 min)



To change the default values for the timeout categories, edit the script file server-start.sh on Linux or PBSWorksService.bat on Windows. The location of this file for a typical installation of a PBS Works product is:

on Windows: SERVER_HOME\scripts

on Linux: SERVER_HOME/scripts

Add these two lines (XXXXX values are in milliseconds):

JAVA_OPTS="$JAVA_OPTS -DPAS_REQUEST_LONG_TIMOUT=XXXXXX"

JAVA_OPTS="$JAVA_OPTS -DPAS_REQUEST_SHORT_TIMOUT=XXXXXX"

After these lines:

#--- CM Specific Pararmeters

echo "Setting CM Paramters"


getHomeDirectory Short 300000 ms (5 min)compress Short 300000 ms (5 min)uncompress Short 300000 ms (5 min)fileRenameMove Short 300000 ms (5 min)fileCopy Short 300000 ms (5 min)fileDataReplace Short 300000 ms (5 min)fileWrite Extra Long 5 X Long timeout valueRunPythonScript Extra Long 5 X Long timeout value

Operations for Remote Files Timeout Category Default length of timeout



Customizing the Available Job Monitoring Properties CM has the ability to enable and disable the job properties that will be displayed on the Job Moni-toring page of the CM web application. This information is stored in the jobPropertiesDef.xml file. The location of the file for a typical installation of CM is:



By default, CM displays all job properties on the Property tab, and allows all job properties to be added as columns to the job grid of the Job Monitoring page.

For example, the following image of the Job Monitoring page shows that the job property Account can be added as a column to the job grid, and is also is displayed on the job Property tab.



The following is an example of the content of the jobPropertiesDef.xml file:

The following table describes the XML attributes of the job properties definition file:

For example, the following XML configures CM to display a job property called queueName on the Property tab of the Job Monitoring page, and also makes it available to add as a column of the job grid. By default, all job properties are configured in this way.

<property name="queueName" type="string" visible="true" detailOnly="false" />

Changing the XML attribute visible to false disables the display of the job property entirely.

<property name="queueName" type="string" visible="false" detailOnly="false" />

<?xml version="1.0" encoding="iso-8859-1" ?><properties> <property name="jobName" type="string" visible="true" detailOnly="false" /> <property name="jobDirectory" type="string" visible="true" detailOnly="false" /> <property name="queueName" type="string" visible="true" detailOnly="false" /></properties>

Table 3. Attributes of the job properties definition file

Attribute Description Value Valuesname The name of the job property as

it is defined within CM.The value of this attribute should NOT be changed.

type The data type of the job property as it is defined in CM.

The value of this attribute should NOT be changed.

visible Enables or disables the display of the job property on the CM Job Monitoring page. If this property is set to false, then the detai-lOnly attribute is not necessary.

true enable the display of the job property

false disable the display of the job property

detailOnly Enables or disables the availabil-ity of the job property as a dis-playable column in the job grid of the CM Job Monitoring page.

true The job property will only be dis-played on the Property tab of the Job Monitoring page.

false The job property can be added as a displayable column in the job grid, and will also be displayed on the Property tab of the Job Moni-toring page.



Changing the XML attribute detailOnly to true disables the availability of the job property as a displayable column in the job grid of the Job Monitoring page. However, the job property will be displayed in the Property tab of the Job Monitoring page.

<property name="queueName" type="string" visible="true" detailOnly="false" />


Changing the PAS Application Retrieval TimeoutDynamic applications are a special type of application that allows the job submission form to react to information entered by a CM user. For example, two versions of the application Optistruct are available. The newest version (Optistruct 11.0) contains a new application argument called TURBO BOOST. The dynamic application feature allows the job submission form to change depending on the selection of the Optistruct version.

With the introduction of dynamic applications, CM is no longer caching applications and their associated arguments. Therefore, any time you select an application and display its job submission form, a call is made to PAS to get the latest version of the application.

After making the call to PAS to retrieve the application, by default, CM will wait for ten (10) sec-onds for a response from PAS. If there is no response within 10 seconds, the call times out and the following error message is displayed:



Failed to refresh application definition

The default timeout value of 10 seconds can be changed, and this information is stored in a file called config.properties. The location of this file for a typical installation of CM is:



The parameter refreshAppDefTimeOut determines the timeout value. The timeout value is in milli-seconds (10000 milliseconds is 10 seconds):

# time-out setting for PAS refresh-app-def service call (in milliseconds)

refreshAppDefTimeOut=10000


Enabling RVS Traffic through CMResults Visualization Service traffic can be routed through Compute Manager, eliminating the need for RVS to be directly accessible to a client through the URL http://<rvsServer>:<rvsPort>.

Enabling RVS traffic through Compute Manager is done by modifying the file rvs_data_pro-vider.xml. The location of this file for a typical installation of RVS is:

on Windows: SERVER_HOME\services\rm\config

on Linux: SERVER_HOME/services/rm/config

Change the value of host from RVS_SERVER to CM_SERVER:

<FileProvider host="CM_SERVER" />




Configuring RVS Admin Auto Refresh IntervalCompute Manager allows you to set the RVS plot refresh time ie., minimum time interval for refreshing the plot while a job is running.

To specify the RVS admin auto refresh interval:

1. Click the Settings button . 2. Click Settings > Compute Manager. 3. Enter the value for RVS Admin Auto Refresh Interval.

4. Click Apply. 5. Click Ok.

The RVS Admin Auto Refresh Interval value set by the admin will over-ride the RVS Auto Refresh Interval value specified by the user.



Configuring the Default Home PathCompute Manager allows the system administrators to configure the default home location of all users when a PAS server is added to CM. Compute Manager displays the contents of this home directory path from the Remote Files web page, Job Submission web page, and in the Files Con-tents tab in the Monitoring web page.

You can configure the default home path while Adding a PAS Server.

If home location path is configured as /home/pbsworks/Documents, then when the user clicks on the Home icon from the web pages it will display the directory structure of the home location path (in this case /home/pbsworks/Documents) defined while adding the PAS server.

You can also mention the home location path as /home/$USER_Home or /home/%U. This will display the directory structure of the user when the Home icon is clicked from the web pages.

Some examples for setting the user's home directory:• /home/tsmith• /home/$USER_HOME which translates to /home/tsmith• /home/%U which translates to /home/tsmith• /stage/%U which translates to /stage/tsmith

Variables that can be used to define the user's default home location are $HOME which represents the PAS home directory and $USER_HOME or %U which represents the user name.

The user’s credentials should be available in the PAS server when you define the home location path with the user ($USER_HOME or %U).

An error message will be displayed if the custom path defined is not available.



Adding Site Specific Web Pages to CMThree default web pages are available with CM after installation:

• Monitoring• Remote Files• Job Submission

You can add site specific pages to CM and link to those pages just as you would link to the default web pages.

Compute Manager allows the system administrators to configure custom pages. You can create custom pages providing a URL link or by providing web application.

To create a custom page with a URL link update the information in the customization.xml file.

The location of this file for a typical installation of CM is:



The format of the file is:

The following table describes the XML attributes of the application help and icon mapping file:

<page pageName="page" pageIcon="page_icon.png"> <links> <link linkName="link" linkIcon="link_icon.png" url="url link"></link> <link linkName="link1" linkIcon="link_icon1.png" url="url link1"></link> </links></page>


XML Attribute DescriptionpageName The name of the site specific web page.page_icon Location of the site specific icon image file.linkName The name of the link in the site specific webpage.



To create a custom page with web application, update the URL location in the following format:

Following is an example of the custom pages created in the application. The Altair custom pages is created by updating the customization.xml file available in CONFIG_HOME\services\cm\config:

icon Location of the link icon image file.url Location of the help topic. This can be a web page URL or a location of the

html file.

Update the page icons and the link icons in the folder: SERVER_HOME\applications\cm\binaries\ui\images\custom_pages

The icon size should be 16x16 pixels

<link linkName="link1" linkIcon="link_icon1.png" url="custom_pages/<web_app_pro-ject_folder_name>/<file_name_to_be_invoked>"></link>

The web application has to be placed in the folder: SERVER_HOME\applications\cm\binaries\ui\custom_pages

<pages>

<page pageName="Altair" pageIcon="altair_icon.png">

<links>

<link linkName="Altair Product Design" linkIcon="altair_icon.png" url="http://www.altairproductdesign.com/"></link>

<link linkName="Altair Process Automation" linkIcon="altair_icon_1.png" url="custom_pages/process/AltairProcess.htm"></link>

</links>

</page>

</pages>


XML Attribute Description



In the above example, the first link created for the Altair page is the URL link and the second one is the web application that is placed in the SERVER_HOME\applications\cm\binaries\ui\cus-tom_pages.

The icons mentioned in the pages and links are placed in the SERVER_HOME\applications\cm\bina-ries\ui\images\custom_pages

When you login to the application, the following screen is displayed with the Altair page being added:



The Altair web page created will be displayed. Click on Altair tab and Altair Product Design website URL will be displayed:

Click on Altair Process Automation tab and the web application will be displayed:



Launching an Application Installed on a Remote ServerIn PBS Works 13.1, applications can be launched on a remote server (usually the PBS execution host) from the Compute Manager file context menu.

This can be performed only when DM is installed and configured with the application to be launched.

Refer to Display Manager Administrator’s Guide for more information on Managing Applications.

Configuring the Client to Open a Remote ApplicationThe Java Runtime Environment (JRE) must be installed on the client machine to open a remote application. Follow these instructions to install and configure the JRE:

• Download and install the latest JRE from https://java.com/en/downloads.• Configure JRE by opening the Java control panel and adding the server URL as an excep-

tion in the site exception list.• When the browser prompts to run the Java applet, choose To Allow and Remember.

Configuring Cross MountThe cross mount is required in a situation where the execution directory and the hosts are cross mounted. When you enable the cross mount, then the transfer of files between them does not hap-pen when you open a remote display session.

To enable the cross mount, change the status of the crossMount variable to true in the con-fig.properties.

By default, the crossMount is disabled. The location of this file for a typical installation of CM is:



# Cross Connection - If set then there all the PBS server's and mom's are sharedcrossMount=false



https://java.com/en/downloads


Server ConfigurationTo open or launch an application installed on a remote server, then configure Compute Manager with those applications.

To configure applications for all the users, open appregistry.xml located at

CONFIG_HOME\services\alf\config\users\global\remote\

For example:

<appresource> <name>HyperMeshALF</name> <id>HyperMeshALF</id> <args> <argument> <name>FILE_INPUT</name> <value></value> <prefix></prefix> </argument> </args></appresource>

Modifying Application Launch Framework Client LocationYou can modify the Application Launch Framwork (ALF) client location in the application as fol-lows:

1. Click the Settings icon, and choose the Settings option from the drop down menu as shown below:



A Settings dialog box will be displayed.

2. Click Application Launch Framework and update the ALF Client Location.

Configuring Local Dynamic ApplicationThe dynamic applications are a special type of application that allows the job submission form to react to information entered by a CM user. The local dynamic application allows the user to access their machine to provide these information.

By default, the local dynamic application is disabled. This can be changed in a file called con-fig.properties. The location of this file for a typical installation of CM is:





The parameter localdynamicapp determines if the local dynamic application is enabled or dis-abled. To enable the local dynamic application, change the value of to true.

# master file analyzer - enabled flag

localdynamicapp=false


Setting the Popup TimeoutCM has introduced non-intrusive popup message on successful job submission. A popup message will be displayed within the Compute Manager toolbar indicating the job was submitted success-fully along with the Job ID. You can click the Job ID in the popup message to monitor the status of the job.

The popup message will disappear after the configured timeout value.

An example of the popup message is as follows:

The default popup message timeout value of 10 seconds (10000 milliseconds) can be changed, and this information is stored in a file called config.properties. The location of this file for a typical installation of CM is:



The parameter popupTimeout determines the popup message timeout value. The popup timeout value is in milliseconds (10000 milliseconds is 10 seconds):

# popup Timeout (in milliseconds)

popupTimeout=10000




Configuring the Advance UploadCM allows the systems administrator to configure uploading a folder in the Files panel.

By default, the advance upload is disabled. This can be changed in a file called config.properties. The location of this file for a typical installation of CM is:



The parameter advanceUploadEnabled determines if the advance upload is enabled or disabled. To enable the advance upload, change the value to true.

# property to enable/disable the advance upload feature. Default : false

advanceUploadEnabled=false


Configuration for Larger SitesYou have to perform the following configuration changes if your site is handling more than Fifty Thousand (50,000) jobs.

Setting the Maximum Active ConnectionsCM allows the systems administrator to set the maximum number of active connections that can be allocated at the same time.

The default number of active connections is set to 8. This can be changed by updating the maxAc-tive property in the spring-config.xml file. The location of this file for a typical installation of CM is:



Even if the advance upload is enabled, this feature will be available to each individual users only if the Enable local dynamic app. def. is enabled in the Settings.




<property name="maxActive" value="8" />

You can change this value to the 50 which is the maximum number of active connections.


Setting the Work MemoryThe work memory specifies the amount of memory to be used by internal sort operations and hash tables before writing to temporary disk files.

The default work memory value is four megabytes (4MB). This information is stored in a file called postgresql.conf. The location of this file for a typical installation of CM is:

on Windows: SERVER_HOME\thirdparty\postgres\pbsworksdata

on Linux: SERVER_HOME/thirdparty/postgres/pbsworksdata

The parameter work_mem determines the amount of work memory to be used and it is commented by default:

# work_mem = 4MB

Remove the comment mark (#) from the line and update the value to 32 megabytes (32MB):

work_mem = 32MB

For more information on the work memory, refer http://www.postgresql.org/docs/9.4/static/run-time-config-resource.html


Changing the Shared Buffer SizeThe shared buffer size sets the amount of memory the database server uses for shared memory buffers.

The default value is typically 128 megabytes (128MB). This information is stored in a file called postgresql.conf. The location of this file for a typical installation of CM is:




http://www.postgresql.org/docs/9.4/static/runtime-config-resource.html


The parameter shared_buffers determines the amount of memory the database server uses for shared memory buffers.

Change the value from 128MB to four gigabytes (4GB):

shared_buffers = 4GB

For more information on the shared buffer size, refer http://www.postgresql.org/docs/9.4/static/runtime-config-resource.html


Setting the Effective Cache SizeSets the planner's assumption about the effective size of the disk cache that is available to a single query.

The default is 128 megabytes (128MB). This information is stored in a file called postgresql.conf. The location of this file for a typical installation of CM is:



The parameter effective_cache_size determines the disk cache that is available to a single query and it is commented by default:

# effective_cache_size = 128MB

Remove the comment mark (#) from the line and update the value to 12 gigabytes (12GB):

effective_cache_size = 12GB

For more information on the effective cache size, refer http://www.postgresql.org/docs/9.1/static/runtime-config-query.html


Changing Java Heap Memory in LinuxTo change the Java Heap memory limit in Linux:

1. Stop the PBSWorks Service: /etc/init.d/pbsworks stop2. Edit the CM start up script server-start.sh located in the directory SERVER_HOME/

scripts/

3. Change the script to set the Java Heap memory limit as per your requirement.


http://www.postgresql.org/docs/9.1/static/runtime-config-query.html

http://www.postgresql.org/docs/9.4/static/runtime-config-resource.html


SET CATALINA_OPTS="-Xmx4096"

4. Start the PBSWorks Service: /etc/init.d/pbsworks start

Changing Java Heap Memory in WindowsTo change the Java Heap memory limit in Windows:

1. Stop the PBSWorks Service:i. Navigate to Control Panel -> Administrative Tools -> Services. ii. Right-click PBSWorks Service iii. Select Stop.

2. Edit the CM start up script PBSWorksService.batlocated in the directory: SERVER_HOME\scripts\

3. Change the value of JvmOptions in the script to set the Java Heap memory limit as per your requirement.The default value of JvmOptions in the PBSWorksService.bat script is:--JvmOptions "-Xmx4096"

4. At the Windows command line prompt enter:cd SERVER_HOME\scripts

PBSWorksService remove

PBSWorksService install

5. Start the PBSWorks Service:i. Navigate to Control Panel -> Administrative Tools -> Services. ii. Right-click PBSWorks Service iii. Select Start.

Enabling Apple Push NotificationsCompute Manager supports push notifications to Apple devices. If you enable the push notifica-tions, CM will send the notifications to those devices where CM mobile application is installed.

By default the Apple Push Notifications is disabled. This can be changed by updating the enableApns property in the config.properties file. The location of this file for a typical installa-tion of CM is:





Change the value of enableApns property value to true:

# To enable APNS

enableApns=false

You can also change the connection timeout value of the APNS in the config.properties file:

# Connection Timeout (seconds)

apnsConnectionTimeout=5


Configuring Time Interval of PAS Admin Requests on Credentials ExpirationCM gets vital data like job information from PAS server based on the PAS admin credentials and stores in the Database. If the PAS admin credentials are invalid, then any PAS admin requests from CM to the PAS server is delayed for a certain interval of time. During this time, if PAS admin cre-dentials are corrected in the CM server, the PAS admin requests will be processed without any delay.

The default minimum time interval is set to 30 minutes for the PAS admin requests to be sent to the server on login failure. This can be changed by updating the minFailedPASAdminCallInterval value in the config.properties file. The location of this file for a typical installation of CM is:



Change the value of minFailedPASAdminCallInterval to as per your requriement:

# Minimum interval (minutes) between consecutive admin calls to PAS, once found invalid

# To ensure admin accounts won't get locked

minFailedPASAdminCallInterval=30




Enabling Push Update Detailed LogsCM allows the administrator to enable the detailed logs push notifications.

By default, the push update detailed logs is disabled. This can be changed in a file called con-fig.properties. The location of this file for a typical installation of CM is:



The parameter enablePushUpdateLogs determines if the detailed logs to be updated is enabled or disabled. To enable the push update detailed logs, change the value to true.

# Enable Push Update Detailed Logs

enablePushUpdateLogs=false




CM Configuration FilesThe files in the table below can be modified to customize Compute Manager. These files are located in the PBS Works installation directory. By default, PBS Works products are installed in the following directory.

on Windows: <INSTALL_DIR> is C:\altair\pbsworks\13.1

on Linux: <INSTALL_DIR> is /opt/altair/pbsworks/13.1

Two main directory structures CONFIG_HOME and SERVER_HOME are created during installation. For more information see Software Organization on page 6.

Table 4. Compute Manager Configuration Files

File Name CustomizationCONFIG_HOME/services/cm/config/config.proper-ties

• Setting Maximum Page Size for Files • Improving CM Response Time• Changing the Location of the Moni-

toring Action Bar• Changing the PAS Application

Retrieval Timeout• Configuring Local Dynamic Appli-

cation• Setting the Popup Timeout• Configuring Cross Mount• Configuring the Advance Upload• Enabling Apple Push Notifications• Configuring Time Interval of PAS

Admin Requests on Credentials Expiration

• Enabling Push Update Detailed Logs



SERVER_HOME/services/cm/config/spring-con-fig.xml

• Changing the Job Refresh Rate• Changing the Scheduled Time for

Job Deletion• Setting the Maximum Active Con-

nectionsCONFIG_HOME/services/cm/config/mime-types.default

Mapping a MIME type to a File Exten-sion

CONFIG_HOME/services/cm/config/genericActions/<server>.xml

Adding a Generic Action for a PAS server

CONFIG_HOME/services/cm/config/app-helper.xml Mapping Help Topics and Icons to an Application

CONFIG_HOME/services/cm/config/file-exten-sion.xml

Mapping a File Extensions to an Icon

Windows: SERVER_HOME\scripts\PBSWorksSer-vice.bat Linux: SERVER_HOME/scripts/server-start.sh

• Changing the Communication Tim-eout between CM and PAS

• Changing Java Heap Memory in Linux

CONFIG_HOME/services/cm/config/jobProperties-Def.xml

Customizing the Available Job Moni-toring Properties

SERVER_HOME/applications/cm/binaries/ui/cm.html

Installing and Configuring Google Chrome Frame

SERVER_HOME/services/rm/config/rvs_data_pro-vider.xml

Enabling RVS Traffic through CM

CONFIG_HOME/services/cm/config/customiza-tion.xml

Adding Site Specific Web Pages to CM

SERVER_HOME/thirdparty/postgres/pbsworksdata • Setting the Work Memory• Changing the Shared Buffer Size• Setting the Effective Cache Size

Table 4. Compute Manager Configuration Files

File Name Customization


5. PBS Works Log Files

Compute Manager Log File

The Compute Manager log file can be found at CONFIG_HOME/logs/cm/cmlog.log

Apache Tomcat Log File

The Apache Tomcat log file can be found at SERVER_HOME/thirdparty/apache/tomcat/logs/cata-lina.out

Postgres Server Log File

The Postgres server log file can be found at SERVER_HOME/thirdparty/postgres/pbsworksdata/postgres_server.log

87


88 PBS Works Log Files

6. Troubleshooting

Refresh Button ErrorProblem: The Refresh button is displayed after upgrading to CM 13.0 from previous version.

Solution: With CM 13.0, the Refresh button should not be displayed. Try clearing your browser's cache.

To clear the browser cache in: • Chrome: Refer to https://support.google.com/chrome/answer/95582?hl=en• FireFox: Refer to https://support.mozilla.org/en-US/kb/how-clear-firefox-cache• IE 9 and above: Refer to http://windows.microsoft.com/en-us/windows7/how-to-delete-

your-browsing-history-in-internet-explorer-9• Safari 8: Refer to https://support.apple.com/kb/PH19215?viewlo-

cale=en_US&locale=en_US

89

https://support.google.com/chrome/answer/95582?hl=en

https://support.mozilla.org/en-US/kb/how-clear-firefox-cache

http://windows.microsoft.com/en-us/windows7/how-to-delete-your-browsing-history-in-internet-explorer-9

http://windows.microsoft.com/en-us/windows7/how-to-delete-your-browsing-history-in-internet-explorer-9

https://support.apple.com/kb/PH19215?viewlocale=en_US&locale=en_US

https://support.apple.com/kb/PH19215?viewlocale=en_US&locale=en_US


90 Troubleshooting

Glossary

Account. An account is an arbitrary character string, which may have meaning to one or more hosts in the batch system. Frequently, an account is used as a grouping for charging for the use of resources.

Accounting Log. The PBS Professional accounting log is a text file containing information about a cluster's HPC job activity.

Administrator. A person who administers a product (CM, DM, RVS, PAS, PBSA, or PBS), per-forming functions such as downloading, installing, upgrading, configuring, or managing the product. Administrator is distinguished from "site administrator", although often these are the same person.

Access Management Service, AMS. A centralized configuration system for authentication and authorization.

Application Definition. A predefined set of instructions to describe your application parameters to users, store their responses, and prepare those responses for job execution via PBS Professional. An application definition provides a flexible set of instructions that can be manipulated to allow for precise control over all aspects of application-specific parameters and job execution.

Chart. A charts is a visual representation of data. Charts are used to ease understanding of large quantities of data and the relationships between parts of the data.

Cluster. A relatively homogeneous set of systems that are used as if they are a single machine.

Commands, PBSA Commands, PAS Commands. A set of command-line commands. PBSA Commands are commands that assist with the configuration of PBSA. PAS Commands provide job submission, monitoring, as well as file operations capabilities from the command-line.

Complex. A PBS complex consists of the machines running one primary server+Scheduler (plus, optionally, a secondary backup server+Scheduler) and all the machines on which the MoMs (attached to this server+Scheduler) are running. A complex can be a heterogeneous mix of system architectures, and can include one or more clusters.

Consumable resource. A consumable resource is a resource that is reduced or taken up by being used. Examples of consumable resources are memory or CPUs.

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

91


CPU. Has two meanings, one from a hardware viewpoint, and one from a software viewpoint: • A core. The part of a processor that carries out computational tasks. Some systems present

virtual cores, for example in hyperthreading.• Resource required to execute a program thread. PBS schedules jobs according, in part, to

the number of threads, giving each thread a core on which to execute. The resource used by PBS to track CPUs is called "ncpus". The number of CPUs available for use defaults to the number of cores reported by the OS. When a job requests one CPU, it is requesting one core on which to run.

Custom group. Custom groups are specific to PBS Analytics, and are an alternative for tracking usage of HPC resources at a project level for sites running versions of PBS Professional prior to 11.2.

Custom resource. A resource that is not defined in PBS as shipped. Custom resources are created by the PBS administrator or by PBS for some systems.

Daily Parsing. A PBSA activity where information from the PBS Professional accounting logs is parsed, and then loaded into a database. Once the PBS Professional accounting logs have been parsed for the first time (see Initial Parsing), daily parsing is scheduled by default to occur at 1:00 am, and will parse any newly generated accounting logs.

Dashboard. A dashboard is a visual display of the most important information needed to achieve one or more objectives; consolidated and arranged on a single screen so the information can be monitored at a glance.

Dimension. A field or variable that is displayed on a PBSA chart. Dimensions are the independent variable (often denoted by the x-axis) whose variation does not depend on another variable. Examples are users, software, servers, and nodes. PBSA requires that Dimensions be displayed on the x-axis or z-axis (in the case of a three dimensional chart).

Demonstration Database. A database that is loaded with demonstration data. An installation option is available that installs PBSA with a demonstration database, so that all out-of-the box charts, dashboards, and slideshows can be viewed, and all key features of PBSA can be accessed and evaluated.

Execution host. A computer which runs PBS jobs. An execution host is a system with a single operating system (OS) image, a unified virtual memory space, one or more CPUs and one or more IP addresses. Systems like Linux clusters, which contain separate computational units each with their own OS, are collections of hosts. Systems such as the SGI ICE are also collections of hosts. The SGI Altix 4700 is a single execution host.

92 Glossary of Terms


An execution host can be comprised of one or more vnodes. For example, the SGI Altix 4700, while being a single execution host, can contain multiple vnodes, where each vnode is a blade. On the SGI ICE, each blade is treated as a vnode. See Vnode.

File Service Provider, FSP. A PAS mechanism for executing remote file operations on the PBS Professional execution hosts. It removes the dependency upon PBS Professional for remote file operations and file transfers.

Finished Jobs. Jobs whose execution is done, for any reason:• Jobs which finished execution successfully and exited • Jobs terminated by PBS while running • Jobs whose execution failed because of system or network failure • Jobs which were deleted before they could start execution

Fully Qualified Domain Name, FQDN. The complete domain name for a specific computer, or host, on the Internet. The FQDN consists of two parts: the hostname and the domain name.

Furnishing Server. The server from which the job is pulled when peer scheduling is implemented.

Group. A collection of system users. A user must be a member of at least one group, and can be a member of more than one group.

Head Node. Machine where the PBS Server is installed.

High Performance Computing, HPC. High Performance Computing (HPC) most generally refers to the practice of aggregating computing power in a way that delivers much higher perfor-mance than one could get out of a typical desktop computer or workstation in order to solve large problems in science, engineering, or business.

Holiday. A non-working day usually associated with a special day of celebration.

Host. A machine running an operating system. A host can be made up of one or more vnodes.

Initial Parsing. A PBSA activity where information from the PBS Professional accounting logs is parsed, and then loaded into a database. Initial parsing is when the accounting logs are parsed for the first time after installation and configuration of PBSA is complete. Initial parsing may take anywhere from several hours to several days depending upon the amount of data stored in the PBS Professional accounting log(s), number of processors, and amount of available RAM.

Job or Batch job. A unit of work managed by PBS. A job is a related set of tasks, created and sub-mitted by the user. The user specifies the resources required by the job, and the processes that make up the job. When the user submits a job to PBS, the user is handing off these tasks to PBS to

Glossary of Terms 93


manage. PBS then schedules the job to be run, and manages the running of the job, treating the tasks as parts of a whole. A job is usually composed of a set of directives and a shell script.

Job ID, Job identifier. When a job is successfully submitted to PBS, PBS returns a unique identi-fier for the job. Format: sequence_number[.server][@new server]

Job State. A job exists in one of the possible states throughout its existence within the PBS system. For example, a job can be queued, running, or exiting.

License Server. A centralized computer software system which provides access tokens, or keys, to client computers in order to enable licensed software to run on them.

Measure. A field or variable that is displayed on a PBSA chart. Measures are the dependent vari-able (often denoted by the y-axis) whose value changes dependent on the other variables. Exam-ples are total numbers of jobs, average memory used, and total CPU walltime. Measures are displayed on the y-axis. The PBSA Web Application refers to Measures as Values.

MoM. The daemon which runs on an execution host, managing the jobs on that host. MoM is the informal name for the process called pbs_mom. One MoM runs on each execution host.

MoM runs each job when it receives a copy of the job from the server. MoM creates a new session that is as identical to the user's login session as possible. For example under UNIX, if the user's login shell is csh, then MoM creates a session in which .login is run as well as .cshrc. MoM returns the job's output to the user when directed to do so by the server.

MoM is a reverse-engineered acronym that stands for "Machine Oriented Mini-server".

Mother Superior. Mother Superior is the MoM on the head or first host of a multihost job. Mother Superior controls the job, communicates with the server, and controls and consolidates resource usage information. When a job is to run on more than one execution host, the job is sent to the MoM on the primary execution host, which then starts the job.

Node. No longer used. See Execution Host.

Nodeclass. A custom resource that groups or classifies PBS Professional nodes. PBSA automati-cally assign a nodeclass based on cores and memory when node information is added to PBSA via the pbsa-config-nodes command.

Node Details. A map of your site's PBS Professional cluster, that is each PBS Professional server and its associated execution hosts. This information is stored in a configuration file, and is used by PBSA to provide HPC resource usage statistics.

Non-consumable resource. A non-consumable resource is a resource that is not reduced or taken up by being used. Examples of non-consumable resources are Boolean resources and walltime.



Non-Prime Time Hours. Non-working hours.

Owner, Job owner. The user who submitted a specific job to PBS.

Parsing. A PBSA activity where information from the PBS Professional accounting logs is parsed, and then loaded into a database.

PAS_EXEC.The path containing PAS executables. The path under which PAS executables are installed on the local system. The location of this directory is platform dependent.

PAS_HOME. The path containing PAS configuration and log files. The path under which PAS configuration and log files are installed on the local system. The location of this directory is plat-form dependent.

PBS Analytics, PBSA. A job accounting and reporting solution that provides PBS Works adminis-trators with advanced analytics to support data-driven planning and decision making. Data from multiple PBS Professional servers can be consolidated, providing a global view of your HPC usage for chargeback, capacity planning, troubleshooting and project management.

PBS Application Services, PAS. A middleware component that communicates with the PBS Pro-fessional complex and the operating system, and provides services for the front end client applica-tions such as graphical user interfaces.

PBS Professional. A workload management system consisting of a server, a Scheduler, and any number of execution hosts each managed by a MoM. PBS accepts batch jobs from users, and schedules them on execution hosts according to the policy chosen by the site. PBS manages the jobs and their output according to site-specified policy.

PBS Works. PBS Works is a suite of products for comprehensive, secure workload management for high-performance computing (HPC) environments.

PBS_EXEC. The path containing PBS executables. The path under which PBS executables are installed on the local system.

PBS_HOME. The path containing PBS files. The path under which PBS files are installed on the local system.

PBSA Data Collector, Data Collector. A software component of PBSA, installed on execution hosts, responsible for making the PBS Professional accounting logs accessible to the PBSA engine.

PBSA Engine, PBSA Web Application. A software component of PBSA that consists of web ser-vices, a database, and an analytics engine responsible for the analysis and visualization of HPC resources.



PBSA Hook. A mechanism for adding a custom resource to PBSA.

PBSA Parser, Parser. A software component of PBSA that is responsible for parsing the PBS Pro-fessional accounting logs and loading this information into the PBSA database.

PBSWORKS_EXEC. The path containing PBS Works executables. The path under which PBS Works executables are installed on the local system. The location of this directory is platform dependent.

PBSWORKS_HOME. The path containing PBS Works configuration and log files. The path under which PBS Works configuration and log files are installed on the local system. The location of this directory is platform dependent.

Peer scheduling. A feature allowing different PBS complexes to automatically run each others' jobs. This way jobs can be dynamically load-balanced across the complexes. Each complex involved in peer scheduling is called a peer.

Prime Time Hours. Working hours.

Project. In PBS, a project is a way to group jobs independently of users and groups. A project is a tag that identifies a set of jobs. Each job's project attribute specifies the job's project.

Queue. A queue is a named container for jobs at a server. There are two types of queues in PBS: routing queues and execution queues. A routing queue is a queue used to move jobs to other queues including those that exist on other PBS servers. A job must reside in an execution queue to be eligible to run and remains in an execution queue during the time it is running. In spite of the name, jobs in a queue need not be processed in queue order (first-come first-served or FIFO).

Resource. A resource can be something used by a job, such as CPUs, memory, high-speed switches, scratch space, licenses, or time, or it can be an arbitrary item defined for another pur-pose. PBS has built-in resources, and allows custom-defined resources.

Scheduler. The PBS scheduler is the daemon which implements the site's job scheduling policy controlling when and where each job is run. The scheduler is the process called pbs_sched.

Scheduling. The process of selecting which jobs to run when and where, according to a predeter-mined policy. Sites balance competing needs and goals on the system(s) to maximize efficient use of resources (both computer time and people time).

Server. The central PBS daemon, which does the following:• Handles PBS commands • Receives and creates batch jobs• Sends jobs for execution



The server is the process called pbs_server. Each PBS complex has one primary server, and if the complex is configured for failover, a secondary server. The server contains a licensing client which communicates with the licensing server for licensing PBS jobs.

Server Configuration File. A file containing all configurable parameters available with PAS.

Service User. Windows platforms only. The user under which the CM or PAS Windows service is registered.

Site Configuration File. A central repository for site specific information that can be used across all application definitions.

User. Has two meanings:• A person who submits jobs to PBS, as differentiated from Operators, Managers and

administrators.• A system user, identified by a unique character string (the user name) and by a unique

number (the user ID). Any person using the system has a username and user ID.

User ID, UID. A unique numeric identifier assigned to each user.

Values. The PBSA Web Application refers to Measures as Values. Values are the dependent vari-able (often denoted by the y-axis) whose value changes dependent on the other variables. Exam-ples are total numbers of jobs, average memory used, and total CPU walltime. Values are displayed on the y-axis.

Vnode. A virtual node, or vnode, is an abstract object representing a set of resources which form a usable part of an execution host. This could be an entire host, or a nodeboard or a blade. A single host can be made up of multiple vnodes. Each vnode can be managed and scheduled inde-pendently. Each vnode in a complex must have a unique name. Vnodes can share resources, such as node-locked licenses.


