HP Scalable Visualization Array Version 1.1 Visualization System Software Reference Guide

svaAllocateJob(3)
svaAllocateJob
svaAllocateJob -- Allocates cluster resources and starts a job.
Synopsis
svaAllocateJob
Parameters
This command does not use any formal parameters on the command line. Instead, use the shell environment
variables to pass values to the command.
Returns
If the allocation succeeds, the requested resources are allocated, the SLURM_JOBID variable is set to the
job id, and a 0 is returned.
Description
Allocates resources based on the settings in the following environment variables. Starts a SLURM job with
those resources.
theProgramName The name of the job that is given to SLURM. This shows up when
squeue/sinfo is used to query the status of the job.
SVA_Compute_Count The number of compute nodes requested for allocation.
SVA_Display_Surface The name of the Display Surface and its related display resources (display
nodes and devices) requested for allocation.
SVA_Render_Count The number of render nodes requested for allocation. (Display nodes
determined from the SVA_Display_Surface variable.)
When you call svaAllocateJob, the Job Settings Configuration File is created and populated with the
tags for the SVA_JOB section and a section for each host allocated to the job.
The following variables are set for the running job from the SVA_JOB section of the Job Settings Configuration
File. These values are set in the Job Settings Configuration File when resources are selected for the job.
SVA_Compute_Count
SVA_Compute_Hosts
SVA_Display_Count
SVA_Display_Hosts
SVA_Execution_Host
SVA_Render_Count
SVA_Render_Hosts
The associated tags from the SVA_JOB section are exactly the same strings, except in uppercase. For
example, for the environment variable SVA_Compute_Count, the tag is SVA_COMPUTE_COUNT.
The environment variable SVA_Total_Count is set to the sum of SVA_Compute_Count,
SVA_Display_Count, and SVA_Render_Count.
The SVA_ROLE and SVA_RANK tags are set in the Job Settings Configuration File for each compute, display,
and render host allocated to the job. They are not set as shell environment variables. The role of a node is
set to DISPLAY, RENDER, or COMPUTE. The rank is a unique number within the role of the host as it applies
to the job. The numbers are generated starting from 1 when resources are allocated to the job.
When svaAllocateJob returns successfully, these nodes are allocated on behalf of the job script. It is up
to the calling script to free the resources after the job finishes by using the scancel command, from which
the job id can be retrieved from the environmental variable, SLURM_JOBID.
Make sure the job launch script sources the svainit file before this function is called:
. svainit
Functions, Script Commands, and Environment Variables 15