SASGSUB Syntax: Common Arguments

The following arguments are valid for all SASGSUB commands. Argument values that contain spaces must be contained in quotation marks.

Syntax

Required Arguments

Optional Arguments

Syntax

-METASERVER server
-METAUSER user-ID
-METAPORT port
-METAPASS password
-METAPROFILE profile-name
-METACONNECT connection-name
-XMLCONFIGFILE pathname
-GRIDAPPSERVER sas-application-server
<-GRIDCONFIG grid-option-file >
< -GRIDLICENSEFILE grid-enabled-license-file>
<-LOGCONFIGLOC logging-option-file>
<-GRIDLIBPATH path>
<-VERBOSE>
<-GRIDUSER grid-logon-username | _PROMPT_>
<–GRIDPASSWORD grid-logon-password | _PROMPT_>
<-GRIDPLUGINPATH grid-jar-file-path>
<-JREOPTIONS java-runtime-options>

Required Arguments

-GRIDAPPSERVER sas-application-server

specifies the name of the SAS Application Server that contains the grid's logical grid server definition. This option is stored in the configuration file that is automatically created by the SAS Deployment Wizard.

-METASERVER server

specifies the name or IP address of the SAS Metadata Server.

You must specify either -METASERVER, -METAPORT, -METAUSER, and -METAPASS; or -METAPROFILE and -METACONNECT; or -XMLCONFIGFILE. You cannot specify more than one group of options.

This option is stored in the configuration file that is automatically created by the SAS Deployment Wizard.

-METAPORT port

specifies the port to use to connect to the SAS Metadata Server specified by the -METASERVER argument. This option is stored in the configuration file that is automatically created by the SAS Deployment Wizard.

-METAUSER user-ID

specifies the user ID to use to connect to the SAS Metadata Server specified by the -METASERVER argument. This option is stored in the configuration file that is automatically created by the SAS Deployment Wizard. Specify _PROMPT_ for user-ID to specify that the SAS Grid Manager Client Utility prompts the user for a user ID.

-METAPASS password | _PROMPT_

specifies the password of the user specified in the -METAUSER argument. If the value of the argument is set to _PROMPT_, the user is prompted for a password. This option is stored in the configuration file that is automatically created by the SAS Deployment Wizard.

-METAPROFILE profile_pathname

specifies the pathname of the connection profile for the SAS Metadata Server.

You must specify either -METASERVER, -METAPORT, -METAUSER, and -METAPASS; or -METAPROFILE and -METACONNECT; or -XMLCONFIGFILE. You cannot specify more than one group of options.

This option is stored in the configuration file that is automatically created by the SAS Deployment Wizard.

If you are using a clustered metadata server, you can use -METAPROFILE to specify the clustered metadata server definition XML file. In this scenario, you do not need to specify the -METACONNECT option.

-METACONNECT connection-name

specifies the name of the connection to use when connecting to the SAS Metadata Server. The connection must be defined in the metadata profile specified in the -METAPROFILE argument. This option is stored in the configuration file that is automatically created by the SAS Deployment Wizard.

-XMLCONFIGFILE pathname

specifies the path to an XML file that contains the metadata profile connection information.

You must specify either -METASERVER, -METAPORT, -METAUSER, and -METAPASS; or -METAPROFILE and -METACONNECT; or -XMLCONFIGFILE. You cannot specify more than one group of options.

Optional Arguments

-GRIDLICENSEFILE grid-enabled-license-file

specifies the path and filename of a SAS license file that contains the SAS Grid Manager license. The default value is to retrieve the license file information from metadata. If specified, the location must point to a valid SID file that contains a SAS Grid Manager license. Do not use this option unless instructed by SAS Technical Support.

-GRIDCONFIG grid-option-file

specifies the path and filename of a file containing other SASGSUB options. The default value is sasgsub.cfg.

-LOGCONFIGLOC logging-option-file

specifies the path and name of a file containing any options for the SAS logging facility. SASGSUB uses the App.Grid logger name with these keys:

App.Grid.JobID	specifies the job ID as returned by Platform Suite for SAS.
App.Grid.JobName	specifies the job name.
App.Grid.JobStatus	specifies the job status. Possible values are Submitted, Running, or Finished.
App.Grid.JobDir	specifies the job directory name.
App.Grid.JobDirPath	specifies the full path of job directory.
App.Grid.JobSubmitTime	specifies the time at which the job was submitted.
App.Grid.JobStartTime	specifies the time at which the job started running.
App.Grid.JobEndTime	specifies the time at which the job completed.
App.Grid.JobHost	specifies the host that ran the job.

-GRIDLIBPATH path

the path to the shared libraries used by the utility. This value is set in the configuration file and should not be altered. The path cannot contain spaces.

-VERBOSE

specifies that extra debugging information is printed. If this argument is not specified, only warning and error messages are printed.

-GRIDUSER grid-logon-password | _PROMPT_

specifies the user name to be used to log on to the grid, if required by the grid provider. This option is not required if the grid uses Platform Suite for SAS. Specify _PROMPT_ for grid-logon-username to specify that the SAS Grid Manager Client Utility prompts the user for a user ID.

-GRIDPASSWORD grid-logon-password | _PROMPT_

specifies the password to log on to the grid, if required by the grid provider. This option is not required if the grid uses Platform Suite for SAS. Specify _PROMPT_ for grid-logon-password to specify that the SAS Grid Manager Client Utility prompts the user for a password.

-GRIDPLUGINPATH grid-jar-file-path1 ... grid-jar-file-pathN

specifies a list of paths to search for additional grid provider JAR files. Paths are separated by semicolons and cannot contain spaces. This option is not required if the grid uses Platform Suite for SAS.

-JREOPTIONS java-runtime-options

specifies any Java run-time options that are passed to the Java Virtual Machine. This argument is required if you are using a grid provider other than Platform Suite for SAS. This option is stored in the configuration file that is automatically created by the SAS Deployment Wizard.