PAS Commands User Guide2
Copyright © 1992 - 2014 Altair Engineering Inc.
Table of Contents
3Copyrights, Trademarks, & Third Party Licenses1
5What's New2
7Introduction to PAS Commands3
8Server and User Administration4
................................................................................................................................... 9Determining if the PAS Server is Up and Running
................................................................................................................................... 10Getting PAS Server Information
................................................................................................................................... 11Displaying PAS Version & Build Information
................................................................................................................................... 12Determining if the Registered User is an Administrator
................................................................................................................................... 13Getting the Staging Area Root Directory
................................................................................................................................... 14Setting the User's Password
15Submitting and Monitoring Jobs5
................................................................................................................................... 16Getting a List of all Applications
................................................................................................................................... 18Getting a List of Application Parameters
................................................................................................................................... 20Submitting a Job
................................................................................................................................... 22Checking the Status of Jobs
................................................................................................................................... 24Getting a Summary of Job Information
................................................................................................................................... 26Downloading Job Results
................................................................................................................................... 28Deleting a Job
30File Operations6
................................................................................................................................... 31Creating a Directory
................................................................................................................................... 33Uploading a File
................................................................................................................................... 35Downloading a File
................................................................................................................................... 36Deleting a File
................................................................................................................................... 37Compressing a File
................................................................................................................................... 39Displaying a List of Files
40PAS Commands7
Copyrights, Trademarks, & Third Party Licenses 3
Copyright © 1992 - 2014 Altair Engineering Inc.
1 Copyrights, Trademarks, & Third Party Licenses
PBS Application Services 12.1 Commands User Guide 12.1
Updated: Friday, August 08, 2014.
Copyright notice does not imply publication.
Altair® PBS Works™ Version 12.1Enabling On-Demand Computing™Copyright© 1994-2014 Altair Engineering Inc. All Rights Reserved.
Listed below are PBS Works™ applications.
Copyright© Altair Engineering Inc. All Rights Reserved for:Compute Manager™ 2007-2014; Display Manager™ 2007-2014; PBS™ 1994-2014; PBSProfessional® 1994-2014; PBS Application Services™ 2008-2014; PBS Analytics™ 2007-2014; andPBS Desktop™ 2007-2012
In addition to the PBS Works™ trademarks noted above, Simulation Manager™ 2007-2014, PBSPortal™ 2007-2011, e-BioChem ™ 2007-2013, e-Compute™ 2000-2007, e-Render™ 2006-2010,OpenPBS® 1994-2003, Personal PBS® 2007-2012, HyperMesh® 1990-2014, HyperCrash® 2001-2014, OptiStruct® 1996-2014, RADIOSS®1986-2014, HyperView® 1999-2014, HyperView Player®2001-2014, HyperStudy® 1999-2014, HyperGraph® 1995-2014, MotionView® 1993-2014,MotionSolve® 2002-2014, HyperForm® 1998-2014, HyperXtrude® 1999- 2014, Process Manager™2003-2014, Templex™ 1990-2014, TextView™ 1996-2014, MediaView™ 1999-2014, TableView™2013-2014, BatchMesher™ 2003-2014, HyperMath® 2007-2014, HyperWeld® 2009-2014,HyperMold® 2009-2014, Manufacturing Solutions™ 2005-2014, solidThinking® 1993-2014,solidThinking Inspire® 2009-2014, solidThinking Evolve® 1993-2014, Durability Director™ 2009-2014,Suspension Director™ 2009-2014, AcuSolve® 1997-2014, AcuConsole® 2006-2014, SimLab® 2004-2014, and Virtual Wind Tunnel™ 2012-2014 ™ are trademarks of Altair Engineering, Inc.
Altair trademarks are protected under U.S. and international laws and treaties. Copyright© 1994-2014.Additionally, Altair software is protected under patent #6,859,792 and other patents pending. All othermarks are the property of their respective owners. ALTAIR ENGINEERING INC. Proprietary andConfidential. Contains Trade Secret Information. Not for use or disclosure outside of ALTAIR and itslicensed clients. Information contained in HyperWorks® shall not be decompiled, disassembled, or“unlocked”, reverse translated, reverse engineered, or publicly displayed or publicly performed in anymanner. Usage of the software is only as explicitly permitted in the end user software licenseagreement.
Third Party Licenses
PAS Commands User Guide4
Copyright © 1992 - 2014 Altair Engineering Inc.
Technical Support
Location Telephone e-mail
North America +1 248 614 2425 [email protected]
China +86 (0)21 6117 1666 [email protected]
France +33 (0)1 4133 0992 [email protected]
Germany +49 (0)7031 6208 22 [email protected]
India +91 80 66 29 4500 [email protected]
Italy +39 800 905595 [email protected]
Japan +81 3 5396 2881 [email protected]
Korea +82 70 4050 9200 [email protected]
Scandinavia +46 (0) 46 460 2828 [email protected]
UK +44 (0)1926 468 600 [email protected]
This document is proprietary information of Altair Engineering, Inc.
What's New 5
Copyright © 1992 - 2014 Altair Engineering Inc.
2 What's New
With the 12.1 version of PBS Application Services, the following PAS Commands have been enhanced:
pas-getapp
The pas-getapp command now exposes more application parameter information. Prior to 12.1, theoutput of the pas-getapp command looked like this:
>pas-getapp –a PBSJobApp
ApplicationId=PBSJobAppApplicationName=PBSJobAppJOB_NAME(true)NCPUS(true)CHUNKS(false)CHUNK_PLACEMENT(false)MEMORY(true)MEMORY_PLACEMENT(false)JOB_SCRIPT(true)JOB_ARGS(false)FILES(false)SUBMISSION_DIRECTORY(true)
With 12.1, the output will look like this:
ApplicationId=PBSJobAppApplicationName=PBSJobAppJOB_NAME(true)(String)NCPUS(true)(Int)(Min:1)(Value=1)CHUNKS(false)(Int)(Min:1)(Value=1)CHUNK_PLACEMENT(false)(StringEnumerated)(Value=free)[Options:pack,free,scatter]MEMORY(true)(Int)(Min:10)(Value=10)MEMORY_PLACEMENT(false)(StringEnumerated)(Value=true)[Options:true,false]JOB_SCRIPT(true)(FileName)JOB_ARGS(false)(String)FILES(false)(FileNameMulti)SUBMISSION_DIRECTORY(true)(DirectoryName)
pas-submit
The following improvements have been made to the pas-submit command:
job name is not a mandatory argument
support for application arguments of type Datetime
support for application arguments of type Boolean
PAS Commands User Guide6
Copyright © 1992 - 2014 Altair Engineering Inc.
For instance, an application called MyApp has the following arguments:
pas-getapp -a MyApp
ApplicationId=MyApp
ApplicationName=MyApp
JOB_NAME(false)(String)
EXECUTION_TIME(true)(DateTime)
LOGGING(true)(BooleanWithDescription)
SHELL_SCRIPT(true)(FileName)
SUBMISSION_DIRECTORY(false)(DirectoryName)
A job can now be submitted using the following pas-submit command:
pas-submit ApplicationId=MyApp ApplicationName=MyAppEXECUTION_TIME='2014-07-30;13:40:00' LOGGING=true SHELL_SCRIPT=pbscp://blrec166/home/user1/hello_world.sh
Introduction to PAS Commands 7
Copyright © 1992 - 2014 Altair Engineering Inc.
3 Introduction to PAS Commands
The PBS Application Services™ (PAS) Commands allows users to access the power of PBSProfessional without the use of a graphical user interface, while leveraging the capabilities of PBSApplication Services and application definitions.
PAS Commands are available with PBS Application Services 11.1 and later releases. Contact yoursystem administrator to report errors, problems, or unavailability of the PAS Commands.
A variety of commands are available to assist user's with job submission and monitoring activities, aswell as job file operations. Additionally, PBS Application Services server and administrative commandsare available. Please see the following topics for a description of each command, usage information,examples, and associated error messages.
Server and user administration
Submitting and monitoring jobs
Maintaining files and directories
PAS Commands User Guide8
Copyright © 1992 - 2014 Altair Engineering Inc.
4 Server and User Administration
Server and user administrative tasks that are available are:
Determining if PBS Application Services is running
Getting PBS Application Services server information
Displaying PBS Application Services version and build information
Determing if the registered user is an administrator
Getting the staging area root directory
Setting a user's password
Server and User Administration 9
Copyright © 1992 - 2014 Altair Engineering Inc.
4.1 Determining if the PAS Server is Up and Running
Use the pas-ping command to check if the PAS server is up or down. This command will return amessage indicating the status of the PAS server - PAS server at <machine name> is up/down.
Usage
>pas-ping -v -s <PAS Server IP Address> -h
-v (Optional) User this option to obtain detailed (verbose) PAS server information. If this option isnot specified, then only the status of the PAS server will be displayed.
-s (Optional) Use this option to ping a server other than the default PAS server. If this option is notspecified, then the default PAS server will be pinged.
-h (Optional) Use this option to get usage information for the command.
Command Examples
Ping the PAS server:
>pas-ping
Ping the PAS server using verbose option to obtain complete server information:
>pas-ping -v
Ping a server other than the default PAS server:
>pas-ping –s 192.168.4.123
Command Output Example
>pas-ping
PAS server at <localhost> is up
Error Messages
PAS Server is not running:
PAS Server (server name)is down
The PAS server is currently down.
Environment varibalePAS_CONF_FILE not set
The environment variable PAS_CONF_FILE needsto be set to point to the PBS Application Servicesconfiguration file.
Path does not exist : pathname The path to the PAS Commands does not exist -call support
PAS Commands User Guide10
Copyright © 1992 - 2014 Altair Engineering Inc.
4.2 Getting PAS Server Information
Use the pas-getsrv command to display information about the PAS server, such as server hostnameand port number.
Usage
>pas-getsrv -h
-h (Optional) Use this option to get usage information for the command.
Command Examples
Get information about the PAS server:
>pas-getsrv
Command Output Example
>pas-getsrv
Server=localhost
Port=17443h
Error Messages
ERROR: Default server not found A default server has not been defined.
ERROR: Server <name or ip address> notfound
PAS server not found.
ERROR: FailedLoginException:Credentials Mismatch
Please run pas-passwd command to setthe password for pas-client user
The userid and password combination providedis invalid.
Server and User Administration 11
Copyright © 1992 - 2014 Altair Engineering Inc.
4.3 Displaying PAS Version & Build Information
Use the pas-ver command to display PAS version and build information.
Usage
>pas-ver -s <PAS Server IP Address> -h
-s (Optional) Use this option to display PAS version and build information for a server other thanthe default PAS server. If this option is not specified, then the default PAS server will beassumed.
-h (Optional) Use this option to get usage information for the command.
Command Examples
Display the PAS version and build information for the PAS server:
>pas-ver
Display the PAS version and build information for a non-default PAS server:
>pas-ver –s 192.168.4.123
Command Output Example
>pas-ver
majorVersionNumber :: 12
minorVersionNumber :: 1
patchNumber :: 0
buildId :: 20140516
platform :: Linux-x86_64
arch :: amd64
Error Messages
ERROR: Default server not found A default server has not been defined.
ERROR: Server <name or ip address> notfound
PAS server not found.
ERROR: Error in get PAS version
Connection error to PAS server: (111,'Connection refused')
The PBS Application Services server is down.
ERROR: FailedLoginException:Credentials Mismatch
Please run pas-passwd command to setthe password for pas-client user
The userid and password combination providedis invalid.
PAS Commands User Guide12
Copyright © 1992 - 2014 Altair Engineering Inc.
4.4 Determining if the Registered User is an Administrator
Use the pas-admin command to determine if the registered user has administrative privileges on thePAS server. The command will return true if the user is a PAS administrator or false if the user isnot a PAS administrator.
Usage
>pas-admin -s <PAS Server IP Address> -h
-s (Optional) Use this option to determine if the registered user has administrative privileges on aserver other than the default PAS server. If this option is not specified, then the default PASserver will be assumed.
-h (Optional) Use this option to get usage information for the command.
Command Examples
Determine if the registered user has administrative privileges:
>pas-admin
Determine if the registered user has administrative privileges for a non-default PAS server:
>pas-admin –s 192.168.4.123
Command Output Example
>pas-admin
true
Error Messages
ERROR: Default server not found A default server has not been defined.
ERROR: Error in is admin
PAS Server (server name) is downThe PBS Application Services server is down..
ERROR: FailedLoginException:Credentials Mismatch
Please run pas-passwd command to setthe password for pas-client user
The userid and password combination providedis invalid.
Server and User Administration 13
Copyright © 1992 - 2014 Altair Engineering Inc.
4.5 Getting the Staging Area Root Directory
Use the pas-getsroot command to return the root directory of the staging area on the PAS server.
Usage
>pas-getsroot -s <PAS Server IP Address> -h
-s (Optional) Use this option to return the root directory of the staging area for a server other thanthe default PAS server. If this option is not specified, then the default PAS server will beassumed
-h (Optional) Use this option to get usage information for the command.
Command Examples
Get the staging area root directory on the PAS server:
>pas-getsroot
Get the staging area root directory on a non-default PAS Server:
>pas-getsroot –s 192.168.4.123
Command Output Example
>pas-getsroot
/stage
Error Messages
ERROR: Default server not found A default server has not been defined.
ERROR: Error in get stage root
Connection error to PAS server: (111,'Connection refused')
The PBS Application Services server is down.
ERROR: FailedLoginException:Credentials Mismatch
Please run pas-passwd command to setthe password for pas-client user
The userid and password combination providedis invalid.
PAS Commands User Guide14
Copyright © 1992 - 2014 Altair Engineering Inc.
4.6 Setting the User's Password
Use the pas-passwd command to set the logged in user's password. Once this command is issued,the user will be asked to enter the new password, and then re-enter it for verification. Once thepassword is set, it will be used for all subsequent PAS command requests.
Usage
>pas-passwd -h
-h (Optional) Use this option to get usage information for the command.
Command Examples
Set the user's password:
>pas-passwd
Command Output Example
>pas-passwd
Enter user's password:xxxxxxxx
Retype password:xxxxxxxx
Changed user root's PAS password on server <localhost>
Error Messages
ERROR: Default server not found A default server has not been defined.
Submitting and Monitoring Jobs 15
Copyright © 1992 - 2014 Altair Engineering Inc.
5 Submitting and Monitoring Jobs
Job submission and monitoring commands that are available are:
Getting a list of applications available on the PBS Application Services server
Getting a list of parameters available for a specific application
Submitting a job
Checking the status of a job or all jobs
Getting a summary of job information
Downloading job results
Deleting a job
PAS Commands User Guide16
Copyright © 1992 - 2014 Altair Engineering Inc.
5.1 Getting a List of all Applications
Use the pas-getapps command to return a list of all applications known to the PAS server.
Usage
>pas-getapps -s <PAS Server IP Address> -h
-s (Optional) Use this option to retrieve a list of all applications known to a server other than thedefault PAS server. If this option is not specified, then the default PAS server will be assumed..
-h (Optional) Use this option to get usage information for the command.
Command Examples
Get a list of all application known to the PAS server:
>pas-getapps
Get a list of all applications known to a non-default PAS Server:
>pas-getapps –s 192.168.4.123
Command Output Example
>pas-getapps
ShellScript2
RADIOSS
Sleeper
JobArray
PBSJobApp
OptiStruct
BatchMesher
DirLister
MyApp
Signal Trap
ShellScript
Submitting and Monitoring Jobs 17
Copyright © 1992 - 2014 Altair Engineering Inc.
Error Messages
ERROR: Applications not registered:
No applications registered on PASserver
No applications are currently registered for thePBS Application Services server.
ERROR: Error in get applications list
Address-related error connecting toserver: (-2, 'Name or service notknown')
A connection problem occurred with the serverspecified by the option -s <hostname>
ERROR: FailedLoginException:Credentials Mismatch
Please run pas-passwd command to setthe password for pas-client user
The userid and password combination providedis invalid.
PAS Commands User Guide18
Copyright © 1992 - 2014 Altair Engineering Inc.
5.2 Getting a List of Application Parameters
Use the pas-getapp command to return a list of all parameters available for the specified application asdefined by the corresponding application definition on the PAS server. This command will also provideinformation on whether the application parameter is mandatory or optional. The output of this commandcan be redirected to a file.
Usage
>pas-getapp -a <Application name> -s <PAS Server IP Address> -h
-a (Required) Use this option to specify the name of the application for which applicationparameters will be returned.
-s (Optional) Use this option to retrieve application parameters from a server other than the defaultPAS server. If the option is not specified, then the default PAS server will be assumed.
-h (Optional) Use this option to get usage information for the command.
Command Examples
Get the parameters available for the application "optistruct" on the PAS server:
>pas-getapp –a optistruct
Get the parameters available for the application "optistruct" on a non-default PAS Server:
>-getapp –a optistruct –s 192.168.4.123
Get the parameters available for the application "optistruct" and redirect the output to a filecalled /tmp/optistruct_params:
>-getapp –a optistruct > /tmp/optistruct_params
Command Output Example
>pas-getapp –a PBSJobApp
ApplicationId=PBSJobAppApplicationName=PBSJobAppJOB_NAME(true)(String)NCPUS(true)(Int)(Min:1)(Value=1)CHUNKS(false)(Int)(Min:1)(Value=1)CHUNK_PLACEMENT(false)(StringEnumerated)(Value=free)[Options:pack,free,scatter]MEMORY(true)(Int)(Min:10)(Value=10)MEMORY_PLACEMENT(false)(StringEnumerated)(Value=true)[Options:true,false]JOB_SCRIPT(true)(FileName)JOB_ARGS(false)(String)FILES(false)(FileNameMulti)SUBMISSION_DIRECTORY(true)(DirectoryName)
Submitting and Monitoring Jobs 19
Copyright © 1992 - 2014 Altair Engineering Inc.
Error Messages
ERROR: Must specify an applicationusing -a
This command requires that an application bespecified using the option -a <Applicationname>.
ERROR: Application not registered:Application(appname) not found on PASserver
The application specified by the option -a<Application name> has not beenregistered with the PAS server.
ERROR: File IO error: app-input-<app_name>.xml
There is an IO error with the application inputfile associated with the application specified bythe option -a <Application name>.
ERROR: Error in getting applicationparameter for application <Applicationname>
A parsing error occurred while reading theapplication input file associated with theapplication specified by the option-a<Application name>.
ERROR: FailedLoginException:Credentials Mismatch
Please run pas-passwd command to setthe password for pas-client user
The userid and password combination providedis invalid.
PAS Commands User Guide20
Copyright © 1992 - 2014 Altair Engineering Inc.
5.3 Submitting a Job
Use the pas-submit command to submit a job to the PAS server. Upon successful submission of thejob, this command will return the PBS Professional job identifier.
There are two ways to submit a job using this command:
1. The application parameters can be entered manually on the command line.
2. The application parameters can be stored in a file. Use the pas-getapp command to generate alist of the application parameters, and then edit this list to fill in the appropriate parameter values.
Usage
>pas-submit -f <filepathname> -s <PAS Server IP Address> -h
-f (Optional) Use this option to specify the path to the file containing the application parametersgenerated by the pas-getapp command.
-s (Optional) Use this option to submit a job to a server other than the default PAS server. If theserver is not specified, then the default PAS server will be assumed.
-h (Optional) Use this option to get usage information for the command.
Please note that file name conventions for application arguments requires the prefix "pbscp:", followedby the hostname and absolute path of the file. For example: pbscp://blrec166/c:/opti/.
Command Examples
Submit a job by entering all application parameters at the command line:
>pas-submit ApplicationId=Optistruct ApplicationName=OptistructApplicationExtension=.fem MASTER=pbscp://blrec166/c:/bar.femBILLING_ACCOUNT=Honda JOB_NAME=My_JOB MEM=200 NCPU=2 SUBMISSION_DIRECTORY=pbscp://blrec166/c:/opti/
Submit a job by specifying the path to the file containing the application parameters:
>pas-submit –f /tmp/parm_file
Submit a job to a non-default PAS Server:
>pas-submit -f /tmp/parm_file –s 192.168.4.123
Submit a job passing an application argument of datetime:
>pas-submit ApplicationId=MyApp ApplicationName=MyApp EXECUTION_TIME='2014-07-30;13:40:00' SHELL_SCRIPT=pbscp://blrec166/home/user1/hello_world.sh
Submit a job passing an application argument of boolean:
>pas-submit ApplicationId=MyApp ApplicationName=MyApp LOGGING=trueSHELL_SCRIPT=pbscp://blrec166/home/user1/hello_world.sh
Submitting and Monitoring Jobs 21
Copyright © 1992 - 2014 Altair Engineering Inc.
Command Output Example
>pas-submit ApplicationId=PBSJobApp ApplicationName=PBSJobAppJOB_NAME=PBSJobApp_test MEMORY=10 NCPUS=1 JOB_SCRIPT=pbscp://hwesuse113-01/tmp/hello_world.sh SUBMISSION_DIRECTORY=pbscp://hwesuse113-01/tmp/PAS_output
Response from PAS server
149.hwesuse113-01
Error Messages
ERROR: Default server not found A default server has not been defined.
ERROR: File does not exist: <filename> The parameter file denoted by <filename> doesnot exist.
ERROR: Permission Denied: <filename> There is a permissions problem with theparameter file <filename>
ERROR: Unknown System Error whileopening <filename>
Error opening parameter file denoted by<filename>.
ERROR: No input parameters specifiedfor job submission
Job application parameters missing. Mustenter application parameters to submit a job.
ERROR: FailedLoginException:Credentials Mismatch
Please run pas-passwd command to setthe password for pas-client user
The userid and password combination providedis invalid.
PAS Commands User Guide22
Copyright © 1992 - 2014 Altair Engineering Inc.
5.4 Checking the Status of Jobs
Use the pas-stat command to display the status of a job (similar to the PBS Professional commandqstat -f). You can display the status of a particular job or the status of all jobs.
Usage
>pas-stat -j <jobid> -s <PAS Server IP Address> -h
-j (Optional) Use this option to get the status of a particular job. If this option is not specified, thenthe status of all jobs will be returned.
-s (Optional) Use this option to get the status of a job on a server other than the default PAS server.
-h (Optional) Use this option to get usage information for the command.
Command Examples
Check the status of a specific job on the PAS server:
>pas-stat -j 248.blrec166
Check the status of all jobs:
>pas-stat
Check the status of all jobs on a non-default PAS Server:
>pas-stat –s 192.168.4.90
Check the status of a specific job on a non-default PAS Server:
>pas-stat -j 248.blrec166 –s 192.168.4.90
Command Output Example
>pas-stat -j 129.hwesuse113-01
Job Id: 129.hwesuse113-01pbs_job_state : Qpbs_server : hwesuse113-01pbs_Account_Name : n/apbs_Job_Name : test1pbs_Job_Owner : [email protected]_Checkpoint : upbs_ctime : Wed Mar 12 13:51:37 2014pbs_Error_Path : hwesuse113-01.prog.altair.com:/var/spool/pas/temp/test1.erpbs_exec_host : n/apbs_exec_vnode : n/apbs_Hold_Types : npbs_Join_Path : npbs_Keep_Files : oepbs_Mail_Points : apbs_mtime : Wed Mar 12 13:51:38 2014pbs_Output_Path : hwesuse113-01.prog.altair.com:/var/spool/pas/temp/test1.oupbs_Priority : 0
Submitting and Monitoring Jobs 23
Copyright © 1992 - 2014 Altair Engineering Inc.
pbs_qtime : Wed Mar 12 13:51:38 2014pbs_Rerunable : Truepbs_stime : n/apbs_session_id : 0pbs_sandbox : privatepbs_jobdir : n/apbs_stagein : runtime@hwesuse113-01:/var/spool/pas/repository/applications/PBSJobApp/runtime,pbs_spawn@hwesuse113-01:/opt/altair/pas/12.1/pas/pbs_spawn,hello_world.sh@hwesuse113-01:/users/ebleicher/hello_world.shpbs_stageout : *@hwesuse113-01:/stage/ebleicher/test1pbs_Variable_List : PAS_APPLICATION=PBSJobApp,PAS_CHUNKS=1,PAS_CLIENT_HOST=127.0.0.2,PYTHONPATH=/opt/pbs/default/bin/pbs_python,PAS_SUBMISSION_DIRECTORY=pbscp://hwesuse113-01/stage/ebleicher/test1,JOB_ARGS=,AIF_MODE=enterprise,PAS_JOB_SCRIPT=pbscp://hwesuse113-01/users/ebleicher/hello_world.sh,PAS_SERVER_PORT=17084,PAS_MEMORY=1000,PAS_CHUNK_PLACEMENT=free,JOB_SCRIPT=pbscp://hwesuse113-01/users/ebleicher/hello_world.sh,PAS_MEMORY_PLACEMENT=true,PBS_HOME=/var/spool/PBS,PAS_HPCBP_ARGUMENTS=runtime/start.py,PAS_COMPUTE_MANAGER_JOB_NAME=test1,PAS_HPCBP_EXECUTABLE=/opt/pbs/default/bin/pbs_python,PAS_PYTHON_PATH=/opt/pbs/default/bin/pbs_python,PAS_JOB_NAME=test1,PAS_NCPUS=10,PAS_SERVER_VERSION=12.1.1,AIF_USER=ebleicher,PBS_O_QUEUE=workq,PBS_O_HOST=hwesuse113-01.prog.altair.compbs_comment : Can Never Run: Insufficient amount of resource ncpus (R: 10 A: 1 T: 1)pbs_etime : Wed Mar 12 13:51:38 2014pbs_SubStatus : 11pbs_array : n/apbs_array_state_count : n/apbs_array_indices_submitted : n/apbs_array_indices_remaining : n/a
Error Messages
ERROR: Default server not found A default server has not been defined.
ERROR: PAS Server error:
Unknown Job Id provided. OperationFailed. EIFL service error: 15001 .Unknown Job Id. Id: <jobid.hostname>
Job does not exist on the PAS server.
ERROR: PAS server error:
Unknown Job Id provided. OperationFailed. EIFL service error: 15001 .Unknown Job Id. Id: <jobid.hostname>
Invalid job identifier.
ERROR: FailedLoginException:Credentials Mismatch
Please run pas-passwd command to setthe password for pas-client user
The userid and password combination providedis invalid.
PAS Commands User Guide24
Copyright © 1992 - 2014 Altair Engineering Inc.
5.5 Getting a Summary of Job Information
Use the pas-sum command to display a summary of the job information (similar to the PBSProfessional command qstat). You can displays a summary of job information for a specific job, orall jobs on the PAS server.
Usage
>pas-sum -j <jobid> -s <PAS Server IP Address> -h
-j (Optional) Use this option to display a summary of job information for a specific job. If thisoption is not specified, then a summary for all jobs will be returned.
-s (Optional) Use this option to display a summary of job information for a job on a server otherthan the default PAS server. If the server is not specified, then the default PAS server will beassumed.
-h (Optional) Use this option to get usage information for the command.
Command Examples
Get a summary of the job information for a given job:
>pas-sum –j 243.blrec166
Get a summary of job information for all jobs on the PAS server:
>pas-sum
Get a summary of job information for all jobs on a non-default PAS server:
>pas-sum –s 192.168.4.123
Command Output Example
>pas-sum
pbs_jobid : 129.hwesuse113-01pbs_Job_Name : test1pbs_Job_Owner : [email protected]_job_state : Qpbs_queue : workq
Submitting and Monitoring Jobs 25
Copyright © 1992 - 2014 Altair Engineering Inc.
Error Messages
ERROR: Default server not found A default server has not been defined.
ERROR: Server <IP Address> is not found The IP Address or the Host Name does notexist in the network or the destination hostname cannot be resolved.
Unknown Job Id provided. OperationFailed. EIFL service error: 15001 .Unknown Job Id. Id: <jobid.hostname>
Job does not exist on the specified PAS server.
Unknown Job Id provided. OperationFailed. EIFL service error: 15001 .Unknown Job Id. Id: <jobid.hostname>
Invalid job identifier.
ERROR: FailedLoginException:Credentials Mismatch
Please run pas-passwd command to setthe password for pas-client user
The userid and password combination providedis invalid.
PAS Commands User Guide26
Copyright © 1992 - 2014 Altair Engineering Inc.
5.6 Downloading Job Results
Use the pas-getres command to download the files related to the given job identifier. The job must be infinished, failed, or terminated state. If the job was submitted through Compute Manager or PBSDesktop the job submission directory will be zipped and downloaded. Otherwise the standard outputfile, standard error file, and any other files specified in the stage-out list will be zipped.
Usage
>pas-getres -j <jobid> -o <pathname> -s <PAS Server IP Address> -h
-j (Required) Use this option to specify the job identifier.
-o (Required) Use this option to specify the target location where the job results files will bedownloaded.
-s (Optional) Use this option to download job results for a job on a server other than the default PASserver. If the server is not specified, then the default PAS server will be assumed.
-h (Optional) Use this option to get usage information for the command.
Command Examples
Download the job results of a given job to the specified target location:
>pas-getres –j 176.blrec166 -o C:\download\results
This command will download the job results files and create a zip file called C:\download\176-results.zip on the PAS client host.
Download the job results of a given job on a non-default PAS server:
>pas-getres –j 176.blrec166 -o C:\download\results –s 192.168.4.123
Command Output Example
>pas-getres –j 176.blrec166 -o C:\download\results
Job Id 176.blrec166 downloaded successfully
Submitting and Monitoring Jobs 27
Copyright © 1992 - 2014 Altair Engineering Inc.
Error Messages
ERROR: Default server not found A default server has not been defined.
Unknown Job Id provided. OperationFailed. EIFL service error: 15001 .Unknown Job Id. Id: <jobid.hostname>
Job does not exist on the PAS server.
ERROR: Destination not found. The target location specified by the -o<pathname> option does not exist
Unknown Job Id provided. OperationFailed. EIFL service error: 15001 .Unknown Job Id. Id: <jobid.hostname>
Invalid job identifier.
ERROR: Invalid user name/password. The userid and password provided is invalid.
PAS Commands User Guide28
Copyright © 1992 - 2014 Altair Engineering Inc.
5.7 Deleting a Job
Use the pas-del command to delete a job from the Workload Management System. The job can be inany of the following states:
JobState
Description
B Job arrays only: job array has begun.
H Job is held. A job is put into a held state by the server or by a useror administrator. A job stays in a held state until it is released by auser or administrator.
Q Job is queued, eligible to run or be routed.
R Job is running.
W Job is waiting for its requested execution time to be reached or jobspecified a staging request which failed for some reason.
Usage
>pas-del -j <jobid> -s <PAS Server IP Address> -h
-j (Required) Use this option specify the job to be deleted from the Workload Management System.
-s (Optional) Use this option to delete a job from a server other than the default PAS server. If theserver is not specified, then the default PAS server will be assumed.
-h (Optional) Use this option to get usage information for the command.
Command Examples
Delete a job from the PAS server:
>pas-del –j 243.blrec166
Delete a job from a non-default PAS server:
>pas-del –j 243.blrec166 –s 192.168.4.123
Command Output Example
>pas-del –j 151.hwesuse113-01
Job(151.hwesuse113-01) deleted successfully
Submitting and Monitoring Jobs 29
Copyright © 1992 - 2014 Altair Engineering Inc.
Error Messages
ERROR: Default server not found A default server has not been defined.
Unknown Job Id provided. OperationFailed. EIFL service error: 15001 .Unknown Job Id. Id: <jobid.hostname>
Job does not exist on the specified PAS server.
Unknown Job Id provided. OperationFailed. EIFL service error: 15001 .Unknown Job Id. Id: <jobid.hostname>
Invalid job identifier.
ERROR: FailedLoginException:Credentials Mismatch
Please run pas-passwd command to setthe password for pas-client user
The userid and password combination providedis invalid.
ERROR: PAS Server error:
Invalid request for job terminationEIFL service error: 15139 Job hasfinished. Id: <jobid.hostname>
The job has already finished and is not eligibleto be deleted.
PAS Commands User Guide30
Copyright © 1992 - 2014 Altair Engineering Inc.
6 File Operations
Job file operations that are available are:
Creating a directory
Uploading a file
Downloading a file
Deleting a file
Compressing a file
Displaying a list of files
File Operations 31
Copyright © 1992 - 2014 Altair Engineering Inc.
6.1 Creating a Directory
Use the pas-fmkdir command to create a directory on the PAS server.
Usage
>pas-fmkdir -d <directory path> -s <PAS Server IP Address> -j <jobid> -h
-d (Required) Use this option to specify the name of the directory to be created.
-s (Optional) Use this option to create a directory on a server other than the default PAS server. Ifthis option is not specified, then the default PAS server will be assumed.
-j (Optional) Use this option to make a directory in the job's execution directory. The job must bein a running state.
-h (Optional) Use this option to get usage information for the command.
Command Examples
Create a directory on the PAS server:
>pas-fmkdir -d C:\testDir
Create a directory on a non-default PAS Server:
>pas-fmkdir -d C:\testDir –s 192.168.4.123
Command Output Example
>pas-fmkdir -d C:\testDir
Directory Created successfully
PAS Commands User Guide32
Copyright © 1992 - 2014 Altair Engineering Inc.
Error Messages
ERROR: Default server not found A default server has not been defined.
ERROR: Destination not found. Invalid directory path.
ERROR: Error in file list
Connection error to PAS server: (111,'Connection refused')
Default PAS server is down.
ERROR: PAS server error
java.lang.Exception: DirectoryCreateError : directory <directory name>already exists
Cannot create directory - directory alreadyexists.
ERROR: PAS server error
java.lang.Exception: DirectoryCreateError : Permission Denied for creatingdirectory <directory name>
Do not have permissions to create thedirectory.
ERROR: FailedLoginException:Credentials Mismatch
Please run pas-passwd command to setthe password for pas-client user
The userid and password combination providedis invalid.
ERROR: PAS server error
com.altair.gw.aif.exceptions.OperationFailedException: PySpawn: PBSerror: 15139 'History job ID' 188.meta-105
The job must be in a running state to create thedirectory.
File Operations 33
Copyright © 1992 - 2014 Altair Engineering Inc.
6.2 Uploading a File
Use the pas-fup command to upload a file.
Usage
>pas-fup -f <file pathname> -o <pathname> -s <PAS Server IP Address> -z<unzip/unzipdelete> -h
-f (Required) Use this option to specify the file to be uploaded.
-o (Required) Use this option to specify the target location where the file will be uploaded.
-s (Optional) Use this option to upload a file on a server other than the default PAS server. If thisoption is not specified, then the default PAS server will be assumed.
-z (Optional) Use this option to unzip an archive file once the file has been uploaded to the targetlocation.
unzip unzip the archive file and place the contents of the zip file in the target location
unzipdelete unzip the archive file and place the contents of the zip file in the target location,and then delete the archive file
-h (Optional) Use this option to get usage information for the command.
Command Examples
Upload a file:
>pas-fup -f C:\foobar.txt -o D:\foobar.txt
Upload a file to a non-default PAS Server:
>pas-fup -f C:\foobar.txt -o D:\foobar.txt –s 192.168.4.123
Command Output Example
>pas-fup -f C:\foobar.txt -o D:\foobar.txt
File Uploaded successfully
Error Messages
ERROR: Default server not found A default server has not been defined.
ERROR: Destination not found. Invalid directory path.
ERROR: Error in upload file
[Errno 2] No such file or directory:<file name>
File you are trying to upload does not exist.
ERROR: FailedLoginException:Credentials Mismatch
Please run pas-passwd command to set
The userid and password combination providedis invalid.
PAS Commands User Guide34
Copyright © 1992 - 2014 Altair Engineering Inc.
the password for pas-client user
File Operations 35
Copyright © 1992 - 2014 Altair Engineering Inc.
6.3 Downloading a File
Use the pas-fdown command to download a file.
Usage
>pas-fdown -f <file pathname> -o <pathname> -s <PAS Server IP Address> -j<jobid> -h
-f (Required) Use this option to specify the file to be downloaded.
-o (Required) Use this option to specify the target location where the file will be downloaded.
-s (Optional) Use this option to download a file on a server other than the default PAS server. Ifthis option is not specified, then the default PAS server will be assumed.
-j (Optional) Use this option to download a file from the job's execution directory.
-h (Optional) Use this option to get usage information for the command.
Command Examples
Download a file:
>pas-fdown -f C:\foobar.txt -o D:\foobar.txt
Download a file from a non-default PAS Server:
>pas-fdown -f C:\foobar.txt -o D:\foobar.txt –s 192.168.4.123
Download a file from the job's execution directory:
>pas-fdown -f ./sleep2000.sh -o C:\sleep2000.sh -j 248.blrec166 .
Command Output Example
>pas-fdown -f C:\foobar.txt -o D:\foobar.txt
Downloaded successfully
Error Messages
ERROR: Default server not found A default server has not been defined.
ERROR: Destination not found. Invalid directory path.
ERROR: FailedLoginException:Credentials Mismatch
Please run pas-passwd command to setthe password for pas-client user
The userid and password combination providedis invalid.
PAS Commands User Guide36
Copyright © 1992 - 2014 Altair Engineering Inc.
6.4 Deleting a File
Use the pas-fdel command to delete a file from the PAS server.
Usage
>pas-fdel -f <file pathname> -s <PAS Server IP Address> -h
-f (Required) Use this option to specify the file to be deleted.
-s (Optional) Use this option to delete a file on a server other than the default PAS server. If thisoption is not specified, then the default PAS server will be assumed.
-h (Optional) Use this option to get usage information for the command.
Command Examples
Delete a file from the PAS server:
>pas-fdel -f c:/bartest.fem
Delete a file on a non-default PAS Server:
>pas-fdel -f c:/bartest.fem –s 192.168.4.123
Command Output Example
>pas-fdel -f /tmp/PAS_output/PBSJobApp_test/PBSJobApp_test.e149
File(/tmp/PAS_output/PBSJobApp_test/PBSJobApp_test.e149) deleted successfully
Error Messages
ERROR: Default server not found A default server has not been defined.
ERROR: Destination not found. Invalid directory path.
ERROR: Error from PAS server
java.lang.Exception: FileDelete Error:file <filename> does not exist
The file you are trying to delete does not exist.
ERROR: FailedLoginException:Credentials Mismatch
Please run pas-passwd command to setthe password for pas-client user
The userid and password combination providedis invalid.
File Operations 37
Copyright © 1992 - 2014 Altair Engineering Inc.
6.5 Compressing a File
Use the pas-fcompr command to compress a file on the PAS server.
Usage
>pas-fcompr -f <file pathname> -o <pathname> -s <PAS Server IP Address> -j<jobid> -h
-f (Required) Use this option to specify the file to be uploaded.
-o (Required) Use this option to specify the target location where the file will be uploaded.
-s (Optional) Use this option to compress a file on a server other than the default PAS server. Ifthis option is not specified, then the default PAS server will be assumed.
-j (Optional) Use this option to compress a file from the job's execution directory.
-h (Optional) Use this option to get usage information for the command.
Command Examples
Compress a file located on the PAS server:
>pas-fcompr -f c:/bar.fem -o c:\bar.zip
Compress a file on a non-default PAS Server:
>pas-fcompr -f c:/bar.fem -o c:\bar.zip –s 192.168.4.123
Compress a file from the job's execution directory:
>pas-fcompr -f c:/bar.fem -o c:\bar.zip -j 248.blrec166
Command Output Example
>pas-fcompr -f /tmp/PAS_output/PBSJobApp_test/PBSJobApp_test.o149 -o /tmp/j149.zip
File(/tmp/PAS_output/PBSJobApp_test/PBSJobApp_test.o149) compressed successfully
PAS Commands User Guide38
Copyright © 1992 - 2014 Altair Engineering Inc.
Error Messages
ERROR: Default server not found A default server has not been defined.
ERROR: Destination not found. Invalid directory path.
ERROR: Error from PAS server
java.lang.Exception: FileCompress: filenot found. Message from script: filepath does not exist: <path to file>
The file you are trying to compress does notexist.
ERROR: FailedLoginException:Credentials Mismatch
Please run pas-passwd command to setthe password for pas-client user
The userid and password combination providedis invalid.
File Operations 39
Copyright © 1992 - 2014 Altair Engineering Inc.
6.6 Displaying a List of Files
Use the pas-flist command to display a list of files on the PAS server.
Usage
>pas-flist -f <pathname> -s <PAS Server IP Address> -j <jobid> -h
-f (Required) Use this option to list all files in a specified location (pathname).
-s (Optional) Use this option to list all files in a specified location on a server other than the defaultPAS server. If the option is not specified, then the default PAS server will be assumed.
-j (Optional) Use this option to list a file in the job's execution directory.
-h (Optional) Use this option to get usage information for the command.
Command Examples
List files in a given location on the PAS server:
>pas-flist -f c:/stage
List files in a given location on a non-default PAS server:
>pas-flist -f c:/stage –s 192.168.4.123
List a specific file in the job's execution directory:
>pas-flist -f ./dirlister.e361 -j 248.blrec166
Command Output Example
>pas-flist -f /tmp/PAS_output
pas-fdelPBSJobApp_test_2014-05-16-19-26-38pas-fcomprPBSJobApp_test_2014-05-16-19-25-22PBSJobApp_test
Error Messages
ERROR: Default server not found A default server has not been defined.
ERROR: PAS server error
java.lang.Exception: FileList: file<pathname> does not exist
File/directory does not exist.
ERROR: FailedLoginException:Credentials Mismatch
Please run pas-passwd command to setthe password for pas-client user
The userid and password combination providedis invalid.
PAS Commands User Guide40
Copyright © 1992 - 2014 Altair Engineering Inc.
7 PAS Commands
Server and User Administration Commands
Command Description
pas-ping Use the pas-ping command to check if the PAS server is up or down.
pas-getsrv Use the pas-getsrv command to display information about the PAS server.
pas-ver Use the pas-ver command to display PAS version and build information.
pas-admin Use the pas-admin command to determine if the registered user has administrativeprivileges on the PAS server.
pas-getsroot Use the pas-getsroot command to return the root directory of the staging area on thePAS server.
pas-passwd Use the pas-passwd command to set the logged in user's password.
Submitting and Monitoring Jobs Commands
Command Description
pas-getapps Use the pas-getapps command to return a list of all applications known to the PASserver.
pas-getapp Use the pas-getapp command to return a list of all parameters available for thespecified application as defined by the corresponding application definition on thePAS server.
pas-submit Use the pas-submit command to submit a job to the PAS server.
pas-stat Use the pas-stat command to display the status of a job. You can display the status ofa particular job or the status of all jobs.
pas-sum Use the pas-sum command to display a summary of the job information. You candisplays a summary of job information for a specific job, or all jobs on the PAS server.
pas-getres Use the pas-getres command to download the files related to the given job identifier.
pas-del Use the pas-del command to delete a job from the Workload Management System.
PAS Commands 41
Copyright © 1992 - 2014 Altair Engineering Inc.
Maintaining Files and Directories Commands
Command Description
pas-fmkdir Use the pas-fmkdir command to create a directory on the PAS server.
pas-fup Use the pas-fup command to upload a file.
pas-fdown Use the pas-fdown command to download a file.
pas-fdel Use the pas-fdel command to delete a file from the PAS server.
pas-fcompr Use the pas-fcompr command to compress a file on the PAS server.
pas-flist Use the pas-flist command to display a list of files on the PAS server.
PAS Commands User Guide42
Copyright © 1992 - 2014 Altair Engineering Inc.
Index- A -administrator user 12
application parameters 18
applications 16
- B -build information 11
- C -compress 37
compress a file 37
copyright 3
create directory 31
- D -delete 28, 36
delete a file 36
delete a job 28
download 26, 35
download a file 35
download job results 26
- F -file list 39
file operations 30
- G -getting application parameters 18
- J -job information 24
job status 22
job submission 15
job summary 24
- L -listing all applications 16
listing files 39
- M -maintaining files and directories 30
monitoring 15
monitoring a job 15
- P -PAS Commands 40
pas-admin 12
pas-del 28
pas-fcompr 37
pas-fdel 36
pas-fdown 35
pas-flist 39
pas-fmkdir 31
pas-fup 33
pas-getapp 18
pas-getapps 16
pas-getres 26
pas-getsroot 13
pas-getsrv 10
pas-passwd 14
pas-ping 9
pas-stat 22
pas-submit 20
pas-sum 24
password 14
pas-ver 11
ping 9
- S -server administration 8
server information 10
server status 9
setting user's password 14
stage root directory 13
submit 20
submit a job 20
submitting 15