Spawner Invocation Options

The following options can be used in the command to start up the spawner for a server with an IOM Bridge connection. Note that the spawner must be stopped and restarted in order to reflect configuration updates.

-allowxcmd

enables host commands and PIPE commands for all servers that are started by the spawner. By default, the spawner starts all servers with the -NOXCMD SAS system option. When you specify -allowxcmd, the spawner no longer specifies -NOXCMD when launching server sessions.

Caution: When you specify -allowxcmd, clients can use host commands to perform potentially harmful operations such as file deletion.

-authproviderdomain

because the spawner starts either a SAS Workspace Server or SAS Stored Process server, and workspace and stored process servers only authenticate against the host, the -authproviderdomain spawner option can only be used to associate a domain with the host authentication provider. For example,

authproviderdomain  (HOSTUSER:MyDomain)

Note: The spawner always authenticates against the host environment.

The -authproviderdomain spawner option has the following syntax:

authproviderdomain  (HOSTUSER:domain)

This option can be abbreviated as -authpd.

-conversationPort

specifies which port is used for communication between the spawner and the servers that the spawner launches. This option can be abbreviated as -cp.

-deinstall

Windows only. Instructs the spawner to deinstall as a Windows service. This option can be abbreviated as -di.

Note: If you specified a service name when you installed the spawner service, you must specify the same name when you deinstall the service.

-dnsMatch

specifies a DNS alias that will be accepted by the object spawner as a match for the local machine name. In addition, the spawner replaces the dnsMatch value with the local machine name in its list of servers. This option is necessary if your network configuration resolves a single DNS alias to multiple machines that run SAS object spawners.

For example: You configure SAS servers and spawners on two different machines: n1.my.org and n2.my.org. The DNS alias srv.my.org resolves to both of these machines, so clients can send a request to the alias and one of the two spawners will receive it. To support this configuration, specify -dnsMatch srv.my.org in the spawner startup command on each machine.

-dnsName

specifies which IP stack is used for communication between the spawner and the servers that the spawner launches. This option can be abbreviated as -dns.

-hostKnownBy (Load-balancing spawners only)

specifies a DNS alias that will be accepted by the object spawner as a match for the local machine name. You might need to use this option along with lbUseHostName if your server machine is known by a different machine name and IP address at your client machines.

-install

Windows only. Instructs the spawner to install as a Windows service. This option can be abbreviated as -i. When asked to install as a service, the spawner records all options specified at install time in the registry under the following key:

"SYSTEM\CurrentControlSet\Services\service-name\Parameters"

You can also specify options in the Startup Parameters when you manually start the spawner service from the Services dialog box.

-installDependencies

Windows only. Specifies the Windows services that must be started before the spawner service starts. The -installDependencies option has the following syntax:

-installDependencies "service1<;service2><;service3>"

This option can be abbreviated as -idep.

-lbUseHostName (Load-balancing spawners only)

instructs the spawner to use machine names rather than IP addresses when it directs clients to SAS servers. If the IP address for your server machine is different for connections within your network than for connections outside of your network, then this option is necessary to enable connections from outside of your network.

Note: If you use this option, the machine names in your server definitions must resolve to the correct IP addresses at your client machines.

-name

Windows only. Specifies a service name to use when installing the spawner as a service. The default value is SAS Object Spawner Daemon II.

If you specify a service name that contains embedded blank spaces, you must enclose the name in quotation marks (" ").

Note: If you install more than one spawner as a service on the same machine, you must use the -name option to give each spawner service a unique name.

-sasLogFile

specifies a fully qualified path to the file in which to log spawner activity. Enclose paths with embedded blank spaces in quotation marks. On z/OS, specify filenames similar to UNIX file paths due to the requirement for z/OS UNIX System Services. This option can be abbreviated as -slf.

Note: If you specify a log destination in the configuration metadata rather than the startup command, you might miss some messages that are generated before the log destination is set.

-sasSpawnerCn

specifies the name (used in the SAS Management Console configuration) of the spawner object to utilize for this spawner invocation configuration. If you do not specify -sasSpawnerCn, the object spawner uses the first spawner definition (on the metadata server) with the same machine name as the current host.

Note: If none of the spawner definitions contain a host name of the current host, you must specify the -sasSpawnercn option to designate which spawner definition to use.

If you specify a spawner name that contains embedded blank spaces, you must enclose the name in quotation marks (" "). This option can be abbreviated as -ssc.

-sasVerbose

when present, causes the spawner to record more detail in the log file (sasLogFile). This option can be abbreviated as -sv.

-servPass

Windows only. Specifies a password for the user name specified in the -servUser option. This option can be abbreviated as -sp.

-servUser

Windows only. Specifies a user name that the service will run under, when you also specify the -install option. This option can be abbreviated as -su.

-xmlConfigFile

specifies a fully qualified path to a metadata configuration file containing a SAS Metadata Server definition to connect to for the complete configuration. On Windows, enclose paths with embedded blank spaces in double quotation marks. On z/OS, specify filenames similar to UNIX file paths due to the requirement for z/OS UNIX System Services.

For details about generating a metadata configuration file for the SAS Metadata Server, see Metadata Configuration File.

This option can be abbreviated as -xcf.