Spawner Invocation Options

The following options can be used in the command to start up the spawner for an IOM Bridge server. 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

Associates a default domain with the host. For example,

authproviderdomain (hostuser:Raleigh)

The -authproviderdomain option has the following syntax:

authproviderdomain  (hostuser:<domain>)

For more details about the -authproviderdomain option, see AUTHPROVIDERDOMAIN Option in the SAS Language Reference: Dictionary.

This option can be abbreviated as -authpd.

-configFile

Specifies a fully qualified path to the file that contains spawner configuration information. Enclose paths with embedded blanks in quotation marks. On Windows, enclose paths with embedded blanks in double quotation marks. On z/OS, specify filenames similarly to //dsn:myid.objspawn.log for MVS and //hfs:filename.ext for OpenEdition files.

This option may be abbreviated as -cf.

-deinstall

Windows only. Instructs the spawner to deinstall as a Windows Service. This option may 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.

-install

Windows only. Instructs the spawner to install as a Windows service. This option may 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 may 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 may be abbreviated as -idep.

-ldapBase

Specifies the Distinguished Name (DN) in which to base all subsequent LDAP searches. This option may be abbreviated as -lb.

-ldap_binddn

Specifies the Distinguished Name (DN) in which to bind to the LDAP server. This, along with ldap_bindpw, might be needed when your network directory is secured. This option may be abbreviated as -lbd.

-ldapHost

Specifies the DNS Name of the machine that is hosting the network directory that contains the spawner's configuration information. This option may be abbreviated as -lh.

-ldapPort

Specifies the port on the ldapHost on which to connect. The default is 389. This option may be abbreviated as -lp.

-ldap_bindpw

Specifies the password that is associated with the ldap_binddn or ldapURL given. This, along with the ldap_binddn or bind information in the ldapURL, might be needed when your network directory is secured. This option may be abbreviated as -lpw.

-ldapURL

Specifies the LDAP URL that contains the host, port, base, bind, and, optionally, password information in which to utilize in order to obtain the spawner configuration information. This option may be abbreviated as -lu.

-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.

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.

 -noSecurity

Instructs the spawner not to authenticate clients. Clients will execute as the user that launched the spawner. This option is useful during development.

WARNING: Because clients connected to the -noSecurity spawner execute as the user that launched the spawner, it is strongly suggested that the host in which the spawner is executing not be connected to a network. Otherwise, data that is accessible by the user that launched the spawner is at risk.

Note: If you use the -noSecurity option, the -install option is ignored.

-sasLogFile

Specifies a fully qualified path to the file in which to log spawner activity. Enclose paths with embedded blanks 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 may 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 LDAP 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 blanks, you must specify the name in quotes (" "). This option can be abbreviated as -ssc.

-sasVerbose

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

-servPass

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

-servUser

Windows only. Specifies a username 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 system configuration file containing an LDAP server definition to connect to for the complete configuration. On Windows, enclose paths with embedded blanks in double quotation marks. On z/OS, specify filenames similar to UNIX file paths due to the requirement for z/OS UNIX System Services. This option may be abbreviated as -xcf.

To create a system configuration file for the LDAP server, see Using the IT Configuration Application.