GRDSVC_ENABLE Function

Optional Arguments

SASAPPSERVER=server-value

specifies the name of a SAS Application Server that has been defined in the SAS Metadata Repository. The SAS Application Server contains the definition for the logical grid server that defines the grid environment.

Alias:SERVER=, RESOURCE=

Restriction:Although a SAS Application Server is configured as a required grid resource in most environments, some grids are not partitioned by resource names. In these environments, passing the SAS Application Server name as a required resource causes the job to fail. To find out whether the SAS Application Server is designated as a required resource value or not in the SAS Metadata Repository, use the GRDSVC_GETINFO function call.

Interaction:The name of the SAS Application Server is passed to the grid middleware as a resource value. When the job is executed, the grid middleware selects a grid node that meets the requirements that are specified by this value. If SAS-application-server contains one or more spaces, the spaces are converted to underscores before the name is passed to the grid middleware as a resource value.

Tip:For Platform Suite for SAS, this server-value corresponds with the value of a resource that the LSF administrator has configured in the lsf.cluster.cluster-name file and the lsf.shared file on the grid-control server.

See:GRDSVC_GETINFO Function to find out whether the SAS Application Server is designated as a required resource value in the SAS Metadata Repository.To remove the SAS Application Server name as a required resource, see Modifying SAS Logical Grid Server Definitions.

Example:

%let
rc=%sysfunc(grdsvc_enable(_all_, server=SASApp));

WORKLOAD=workload-value

identifies the resource for the job to be executed on the grid. This value specifies an additional resource requirement for which the grid middleware selects the appropriate grid nodes.

The specified workload value should match one of the workload values that are defined in the SAS Application Server in the SAS Metadata Repository.

Requirement:Workload values are case sensitive

Interaction:If workload-value contains one or more spaces, the spaces are converted to underscores before the value is passed to the grid provider. If workload-value is not located in the SAS Application Server definition and no other errors occur, a 0 result code is returned, and this note is displayed:

NOTE: Workload value "gridResource" does not exist in the SAS Metadata Repository

.

Tip:For Platform Suite for SAS, this workload-value corresponds with the resource that the LSF administrator has configured in the lsf.cluster.cluster-name file and the lsf.shared file on the grid-control computer.

Example:

%let
rc=%sysfunc(grdsvc_enable(grdnode1, server=SASApp;
workload=EM));

The workload value EM specifies the resource name. EM must be assigned to a grid node in order to process this job. An example is assigning EM to machines that can process SAS Enterprise Miner jobs.

JOBNAME=job-name-macro-variable

specifies the macro variable that contains the name that is assigned to the job that is executed on the grid.

Example:

%let
hrjob=MyJobName;
%let rc=%sysfunc(grdsvc_enable(grdnode1, server=SASApp; 
jobname=hrjob)); 
 signon grdnode1;

In this example, hrjob is the name of the macro variable to which the job name is assigned. The actual job name is MyJobName. The status of the job can be tracked using the SAS Grid Manager Plug-in for SAS Management Console. In this example, you track the status of the job named MyJobName.

JOBOPTS=job-opts-macro-variable

specifies the macro variable that contains the job options. The job option name/value pairs are assigned to job-opts-macro-variable.

The job options are used by the grid job to control when and where a job runs. Job options vary according to the grid middleware provider. Job options are specified as name/value pairs in this format:

option-1=value-1;option-2=“value-2 with spaces"; ...
option-n='value-n with spaces';

For a list of the job options you can specify, see Supported Job Options .

Requirement:Use a semicolon to separate job option/value pairs. For multiple values, use a macro quoting function for the semicolon or use single or double quotation marks to enclose all job options. If the value contains one or more spaces, tabs, semicolons, or quotation marks, enclose the value in single or double quotation marks

See:For job options that are provided by middleware providers other than Platform Computing, such as Data Synapse and Univa UD, see http://support.sas.com/rnd/scalability/grid. For details about using the quoting macro function, see SAS Macro Language: Reference.

Example:

%let
rc=%sysfunc(grdsvc_enable(all, server=SASApp; jobopts=hrqueue));
%let hrqueue=queue=priority%str(;)project="HR Monthly";
signon grdnode1;
%let hrqueue='queue=priority;project="HR Yearly"';
signon grdnode2

Both jobs are sent to the priority queue. The first job is associated with the project named “HR Monthly” and the second job is associated with the project named “HR Yearly.”

"" | "

disables grid execution for the specified server ID or all server sessions.

This value is intended to be used when you have specified _ALL_ in a previous call but you want to disable it for a small number of exceptions.

Requirement:Double or single quotation marks can be used. Do not insert a space between the double or single quotation marks.

Interaction:When quotation marks are used with _ALL_, it clears all previous grid settings that were specified using the GRDSVC_ENABLE function.

Example:

%let rc=%sysfunc(grdsvc_enable(grdnode1,""));
%let rc=%sysfunc(grdsvc_enable(_all_,''));