OBJECTSERVERPARMS System Option

Specifies start-up parameters for SAS Integrated Object Model (IOM) servers.

Valid in:	configuration file, SAS invocation, metadata
Category:	Environment Control: Initialization and Operation
PROC OPTIONS GROUP=	EXECMODES (internal)
Applies to:	workspace, stored process, OLAP, metadata
Note:	This option cannot be restricted by a site administrator. For more information, see Restricted Options in SAS System Options: Reference.
See:	OBJECTSERVER System Option

Table of Contents

Syntax

Syntax Description

Parameter Description

Details

Example

Syntax

-OBJECTSERVERPARMS "parameter-1, ... , parameter-n"

Syntax Description

parameter

The following table summarizes the valid parameters and where they can be used. (1=Do not store this parameter in metadata for servers and stored process servers. The automatically adds this parameter when it starts these servers.2=Use TIMEOUTSECONDS with servers, or stored process servers only. TIMEOUTSECONDS does not apply to workspace servers or to metadata servers.):

OBJECTSERVERPARMS and Their Usage
Parameter	Valid In
CLASSFACTORY (1)	Metadata, Command Line
CLIENTENCRYPTIONLEVEL (1)	Command Line (only)
CONNECTEVENTS	Metadata, Command Line
DNSMATCH	Command Line (only)
KEEPALIVE	Metadata, Command Line
NOMETAAUTOINIT	Metadata, Command Line
NOPREASSIGNMENT	Metadata, Command Line
NOOMROPTS	Metadata, Command Line
PORT (1)	Metadata, Command Line
PROTOCOL (1)	Metadata, Command Line
SERVER (1)	Command Line (only)
SERVICE	Metadata, Command Line
TIMEOUTSECONDS (2)	Metadata, Command Line
TRUSTSASPEER	Metadata, Command Line

Parameter Description

You can use the following parameters with OBJECTSERVERPARMS:

"classfactory | clsid = class-identifier"

If you want to specify an alternate class to expose as the top- class, use CLASSFACTORY to identify the class to .

When using the SERVER object server parameter, the classfactory does not need to be specified because it is obtained from the definition in the . This option is primarily used to start the .

class-identifier

specifies the 36-character class ID number that specifies the type of server to instantiate. (For example, 0217E202-B560-11DB-AD91-001083FF6836 specifies a SAS Metadata Server). An exposes one top-level class through its class identifier.

Valid in	Metadata, Command Line
Alias	clsid=
Default	workspace class
Restriction	Do not specify this option with spawned servers; it will be supplied automatically by the spawner.

"clientencryptionlevel | cel = none | credentials | everything"

The CLIENTENCRYPTIONLEVEL parameter specifies the degree of for the IOM server to use when making outbound calls.

NONE

use no encryption.

CREDENTIALS

(default) encrypt only a user's credentials when establishing a client session.

EVERYTHING

encrypt all data (including a user's credentials) sent during a client session.

Valid in	Command Line (only)
Alias	cel=
Default	CREDENTIALS
Restriction	Do not specify this option with spawned servers; it will be supplied automatically by the spawner.
Interaction	This option is used only by the bridge protocol engine.
See	"protocol = bridge \| com \| (com, bridge)"

"connectevents | noconnectevents"

When set, CONNECTEVENTS enables the workspace server to send events that might come back from CONNECT server sessions.

Valid in	Metadata, Command Line
Alias	(no alias)
Default	CONNECTEVENTS
Restriction	Used with workspace, pooled workspace, and stored process servers only.

"dnsmatch | dns"

The object spawner replaces all instances of 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 servers.

For example, you configure SAS OLAP servers 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 a server on one of the two machines will receive it. To support this configuration, specify DNSMATCH=srv.my.org in the server start-up command on each machine.

Valid in	Command Line (only)
Alias	dns
Restriction	Do not specify this option with spawned servers; it will be supplied automatically by the spawner, when you specify the -dnsMatch object spawner option.

"keepalive=interval"

The KEEPALIVE parameter sends an event packet to inactive clients on a regular interval to prevent disconnection by network firewalls.

interval

a number that specifies the interval (in seconds) that the IOM server sends event packets. The minimum value is 30 seconds. A zero value turns off the KEEPALIVE parameter.

Valid in	Metadata, Command Line
Alias	(no alias)

"nometaautoinit | metaautoinit"

The NOMETAAUTOINIT parameter specifies that the IOM server should not connect back to the SAS Metadata Server during start-up in order to obtain additional configuration information such as object server parameters and pre-assigned libraries. In SAS 9.2 and later, IOM servers connect to the metadata server by default (METAAUTOINIT is on).

Valid in	Metadata, Command Line
Alias	(no alias)
Default	METAAUTOINIT
Restriction	The NOMETAAUTOINIT parameter is applicable only if you have specified your logical server with the SERVER object server parameter.
See	Add System Options to the Workspace Server Launch Command

"nopreassignment | preassignment"

The NOPREASSIGNMENT parameter specifies that the IOM server should not load any pre-defined SAS libraries.

A SAS server with NOPREASSIGNMENT set still uses metadata for initialization of options at start-up, but this server does not do preassignment.

Valid in	Metadata, Command Line
Alias	(no alias)
Default	PREASSIGNMENT

"noomropts"

Specifying NOOMROPTS allows the server to connect to the metadata server at start-up, but does no metadata-based options initialization and prevents library preassignment.

Valid in	Metadata, Command Line
Alias	(no alias)
Default	NOOMROPTS

"port = port-number"

The PORT parameter specifies the TCP/IP port on which the protocol engine listens for client connections.

port-number

is a valid TCP/IP port number.

Valid in	Metadata, Command Line
Alias	(no alias)
Restriction	Do not specify this option with spawned servers; it will be supplied automatically by the spawner.

"protocol = bridge | com | (com, bridge)"

The PROTOCOL parameter specifies the protocol engines to launch in server mode. Server mode indicates that the protocol engines will listen for client connections.

BRIDGE

is a protocol engine that you can launch in server mode.

COM

is a protocol engine that you can launch in server mode.

Valid in	Metadata, Command Line
Alias	(no alias)
Restriction	Do not specify this option with spawned servers; it will be supplied automatically by the spawner.
Tip	If you specify (com, bridge), then a multi-user server can simultaneously support clients that use different protocols. COM is not supported on all servers.

"server = 'logical-server-name' | 'omsobj:LogicalServer/object-ID'"

The SERVER parameter can be used to retrieve many of the OBJECTSERVERPARMS options (including PORT, PROTOCOL, and CLASSFACTORY) from a SAS Metadata Repository.

'logical-server-name'

the logical server name for the IOM run-time and server application to use to locate configuration information in a SAS Metadata Repository. Enclose in single quotation marks, as shown in this example: SERVER='sasapp - Logical OLAP'.

'omsobj:LogicalServer/object-ID'

the object definition ID that is generated for the logical server for the IOM run-time and server application to use to locate configuration information in a SAS Metadata Repository. Enclose in single quotation marks.

To determine the generated object ID, in , select the logical server definition, and then select File

Properties from the menu bar. Use the Uniform Resource Identifier (URI) formatted value that is shown in the ID field as the argument for the object ID, as shown in this example: SERVER='omsobj:LogicalServer/01234567.01234567'

Valid in	Command Line (only)
Alias	(no alias)
Restriction	Do not specify this option with spawned servers; it will be supplied automatically by the spawner.

"service = service-name"

The SERVICE parameter specifies the TCP name for the port that the IOM Bridge protocol engine will use to listen for connections from clients.

service-name

a valid TCP service name (for example, from /etc/services on a UNIX system).

Valid in	Metadata, Command Line
Alias	(no alias)
Restriction	Do not specify this option with spawned servers; it will be supplied automatically by the spawner.
Interaction	Use with the IOM Bridge protocol engine.
See	"protocol = bridge \| com \| (com, bridge)"

"timeoutseconds = seconds"

The TIMEOUTSECONDS parameter specifies the time interval that an OLAP server or a stored process server waits before it stops a client process and cleans up the server run-time environment context.

seconds

the interval in seconds that an OLAP server or a stored process server waits before stopping a client process. seconds is a number that is equal to or greater than five.

Valid in	Metadata, Command Line
Alias	(no alias)
Restriction	Does not apply to the workspace servers or to the SAS metadata server.

"trustaspeer | tsaspeer = pathname"

The TRUSTSASPEER parameter enables SAS peer sessions from IOM servers to connect as trusted peer sessions.

This parameter is valid only for the command that starts the SAS Metadata Server. For more information, see Trusted Peer Connections in the SAS Intelligence Platform: Security Administration Guide.

For information about clustering metadata servers, see Using Metadata Server Clustering in SAS Intelligence Platform: System Administration Guide.

pathname

is a pathname to a file containing XML that describes the allowable trusted peer connections, the users who can connect, and the machines from where the connections can be established.

Enclose the pathname in single quotation marks if there is a space in the path. For example:

'C:\SAS
                                       Config\FoundationServers\Lev1\SASMeta\MetadataServer\trustedPeers.xml'

Valid in	Metadata, Command Line
Alias	(no alias)
Restriction	This parameter is valid only for the command that starts the SAS Metadata Server.
Interaction	If you specify a blank or empty file, then you disable trusted peer support.

Details

All object server parameters are applicable on the command line that starts the server:

In configuration files on z/OS, do not precede system options with a hyphen. Also, an equal sign must precede the first parameter that follows the OBJECTSERVERPARMS keyword. For example:
```
objectserver  objectserverparms="cel=credentials protocol=bridge port=8561"
```
For servers that are started by the object spawner, the object server parameters come from your server definition in the SAS Metadata Repository. (The server definition is located under the Server Manager plug-in of SAS Management Console. In the server definition, select the Options tab to locate the Object Server Parameters field).
For servers that are not spawned (such as those that are run from command scripts or those that are run as services or ) you use the sas -objectserver -objectserverparms "parameters" invocation to specify the object server parameters on the command line.

To simplify the command that is needed to invoke an IOM server, the server start-up sequence by default connects back to the metadata server in order to fetch additional information, including object server parameters. You can fetch object server parameters from metadata as follows:

Note: Object server parameters that are specified on the command line always override object server parameters obtained from a SAS metadata repository.

When you start the server with a script, some object server parameters cannot be obtained from the metadata. (In the preceding table, only those parameters that are designated as “Metadata” in the “Valid In” column can be stored in the metadata.)
When you start the server with a , all object server parameters can be obtained from the metadata.
Certain object server parameters are automatically added by the object spawner when it starts workspace and stored process servers. Therefore, the following parameters should not be stored in metadata for workspace and stored process servers: CLASSFACTORY, CLIENTENCRYPTIONLEVEL, PORT, PROTOCOL, SERVER, and SERVICE.

Note: If you want to add additional configuration options to the metadata server, copy the entire objectserverparms line from SAS-configuration-directory/Lev1/server-context/MetadataServer/sasv9.cfg to SAS-configuration-directory/Lev1/server-context/MetadataServer/sasv9_usermodes.cfg and then modify any options you need. For details, see Modifying the Metadata Server Invocation Options in SAS Intelligence Platform: System Administration Guide.

CAUTION

Do not modify the options in sasv9_usermods.cfg only. For example, Adding only -objectserverparms “keepalive=90” without adding other existing options, results in failure to start the Metadata service and instead starts the Workspace server.

Example

This example shows how the OBJECTSERVERPARMS system option can be used in a configuration file that is used to start the metadata server:

-objectserver 
-objectserverparms "cel=credentials protocol=bridge port=8561 classfactory=
0217E202-B560-11DB-AD91-001083FF6836 trustsaspeer=C:\SAS\
FoundationServers\Lev1\SASMeta\MetadataServer\trustedPeers.xml"

Note: In configuration files on z/OS, do not precede system options with a hyphen. Also, an equal sign must precede the first parameter that follows the OBJECTSERVERPARMS keyword. For example:

objectserver  objectserverparms="cel=credentials protocol=bridge port=8561"

OBJECTSERVERPARMS System Option

Syntax

Syntax Description

Parameter Description

"classfactory | clsid = class-identifier"

class-identifier

"clientencryptionlevel | cel = none | credentials | everything"

NONE

CREDENTIALS

EVERYTHING

"connectevents | noconnectevents"

"dnsmatch | dns"

"keepalive=interval"

interval

"nometaautoinit | metaautoinit"

"nopreassignment | preassignment"

"noomropts"

"port = port-number"

port-number

"protocol = bridge | com | (com, bridge)"

BRIDGE

COM

"server = 'logical-server-name' | 'omsobj:LogicalServer/object-ID'"

'logical-server-name'

'omsobj:LogicalServer/object-ID'

"service = service-name"

service-name

"timeoutseconds = seconds"

seconds

"trustaspeer | tsaspeer = pathname"

pathname

Details

Example

See Also