IOMOPERATE Procedure

CONNECT Statement

Provides the required information to establish a session with a SAS IOM server.
See: SECPACKAGE System Option, SECPACKAGELIST System Option
Basic CONNECT Example

CONNECT Example Using Credentials

CONNECT Example Using a URI and a Class Identifier

CONNECT Example Using a Logical Server Name

CONNECT Example with a Server Name

CONNECT Example with a URI and Explicit Server Name

CONNECT and LIST Examples Using a Spawner

CONNECT Example Using Kerberos

Syntax

Optional Arguments

LOGICALSERVERNAME=
specifies the logical server to connect to. SAS returns the first successful connection.
When you specify LOGICALSERVERNAME=, SAS ignores all other CONNECT options except for USERNAME= and PASSWORD=.
"logical-server-name"
is an alphanumeric string that is the logical name for the server that you want to connect to.
Alias LOGICAL=
Default The default metadata connection for the logical server.
Note Enclose logical-server-name in quotes.
See CONNECT Example Using a Logical Server Name
Example
logical="App Server - Logical Workspace Server"
URI=
specifies the server Uniform Resource Identifier (URI) that SAS uses to connect to the server.
When you specify URI=, SAS ignores HOST=, PORT=, PROTOCOL=, and IOMOPTIONS=. All connection options can be specified in the URI, but it can be useful to separate PASSWORD= (so that it will be blotted in the log) and CLSID= and SERVERTYPE= (so that the symbolic names can be used instead of the actual GUIDs).
"uniform-resource-identifier"
is an alphanumeric string that is the URI for the server that you want to connect to. A valid URI takes the form,
"iom://hostname:port"
Notes When URI= is specified, PORT= is not required.
Enclose uniform-resource-identifier in quotes.
The name-value pairs listed under IOMOPTIONS= can be specified as part of URI.
See CONNECT Example with a URI and Explicit Server Name
Example
uri="iom://myappserver1234:8581"
HOSTNAME=
specifies the machine or host to connect to. The value localhost can be used if the SAS session is connecting to a server on the same computer.
"host-name"
specifies the host name, fully qualified host name, or IP address of the machine hosting the server.
Alias HOST=
Note Enclose host-name in quotes.
See CONNECT Example with a Server Name
Example
host="myhost.example.com"
.
PORT=
specifies the TCP port to which the specified server listens for connections (for example, PORT=2171). This option is not required if the COM protocol is specified. This port uses a default based on the specified CLSID= or SERVERTYPE=.
port
is a valid TCP port on the specified server.
Default When a port is required but not specified, IOMOPERATE defaults to a value based on the CLSID= or SERVERTYPE= .
Note Not required when you specify PROTOCOL=COM or URI=.
See CONNECT Example with a Server Name
Example
port=2171
PROTOCOL=
specifies the network protocol for communicating with the SAS Server.
BRIDGE
specifies that the connection uses IOM Bridge protocol.
COM
specifies that the connection uses the COM protocol.
Default BRIDGE
Note When COM is specified, PORT= is not required.
See CONNECT Example Using a URI and a Class Identifier
Example
protocol=com
USERNAME=
specifies a user ID that CONNECT uses to access the specified server. If _PROMPT_ is specified without quotes, then SAS prompts for a user ID.
"user-ID"
is a valid user ID that has the required privileges to access the specified server.
Alias USERID=, USER=, UID=
Note Enclose user-ID in quotes.
See CONNECT Example Using Credentials
Example
uid="sasdemo"
PASSWORD=
specifies the password associated with the user ID. If _PROMPT_ is specified without quotes, then SAS prompts for a password.
"password"
is the password associated with the specified user ID.
Alias PASSWD=, PASS= , PWD=, PW=
Note Enclose password in quotes.
See CONNECT Example Using Credentials
Example
pw="mypass"
IOMOPTIONS=
specifies a string of name-value pairs to use when connecting to the server.
"IOM-option"
is a valid name-value pairs consist of the following:
CLASSFACTORY=class-UUID
specifies the type of server being connected to.
This is an optional parameter and is required only when connecting to a SAS 9.2 or earlier server. When connecting to SAS 9.3 and later servers, this parameter can be omitted.
The LIST TYPES command displays the full name, short name, and UUID of the known server types. Any of the UUIDs can be used with CLASSFACTORY.
class-UUID
is a 36-character alphanumeric string that represents a valid class unique universal identifier (UUID) for the server.
Alias CLSID
Note Enclose the option in quotes. Separate multiple options with a comma.
See CONNECT Example Using a URI and a Class Identifier
Example
opts="clsid=0E3B1810-6646-11D5-8863-00C04F48BC53,
user=myacct,pass=mypwd"
DOMAIN=name
specifies the authentication domain in which to select credentials from the metadata to present at connect time.
name
is an alphanumeric string that equates to a valid domain name.
Note The value of the DOMAIN never reaches the target IOM server.
Example
opts='servername=myserver,domain=mydomain'
ENCR=algorithm
specifies the encryption algorithm to request when connecting to the peer identified in this IOM URI.
algorithm
is a valid encryption algorithm. Valid algorithms are: SASPROPRIETARY, SAS/SECURE, RC2, RC4, DES, TripleDES, and AES.
Note Enclose the option in quotes. Separate multiple options with a comma.
Example
opts='encr=aes,encrlvl=1,user=myusername,
pass=mypswd'
ENCRLVL=encryption-level
specifies the level of encryption requested by the client when connecting to the peer identified in this IOM URI.
encryption-level
is a valid encryption level. Valid encryption levels are: none, credentials, and everything.
  • none: the client requests no encryption.
  • credentials: the client requests to encrypt only credentials.
  • everything: the client requests to encrypt every packet.
Note Enclose the option in quotes. Separate multiple options with a comma.
Example
opts='encr=aes,encrlvl=1,user=myusername,
pass=mypswd'
INTERFACEIID=UUID
UUID
is a 36-character alphanumeric string that represents a valid UUID of the desired interface within the object acquired.
Alias IID
Note Enclose the option in quotes. Separate multiple options with a comma.
Example
opts='iid=0E3B1810-6646-11D5-8863-00C04F48BC53,
user=myusername,pass=mypswd'
LOCALE=locale-name
The value for the LOCALE option specifies the locale of the connecting peer.
locale-name
is a valid locale.
Note Enclose the option in quotes. Separate multiple options with a comma.
Example
opts='locale=french,
servername=SASApp - Stored Process Server'
MAJOR=major-version-number
specifies the major portion of the bridge protocol version to use.
major-version-number
is a number that represents the major (tenths) portion of the bridge protocol version.
Note Enclose the option in quotes. Separate multiple options with a comma.
Example For SAS 9.3 this would be MAJOR=3 MINOR=0.
MINOR=minor-version-number
specifies the minor portion of the bridge protocol version to use.
minor-version-number
is a number that represents the minor (hundredths) portion of the bridge protocol version. When a minor version number does not exist, use the number zero.
Note Enclose the option in quotes. Separate multiple options with a comma.
Example For SAS 9.3 this would be MAJOR=3 MINOR=0.
NOREDIRECT
disables any load-balancing redirection that would be performed by the server. Use this option with caution. It should be used only when attempting to get an administrative connection to a load-balanced server.
Example
opts='noredirect,
servername=SASApp - Stored Process Server'
USER=user-ID
specifies the identity to use when connecting to the peer identified in this IOM URI.
user-ID
is a valid metadata identity with permission to access the peer.
Note Enclose the option in quotes. Separate multiple options with a comma.
Example
opts='user=myusername,pass=mypswd,
servername=SASApp - Stored Process Server'
PASS=password
specifies the password for the identity to use when connecting to the peer identified in this IOM URI.
password
is a valid password for the metadata identity used to access the peer.
Note Enclose the option in quotes. Separate multiple options with a comma.
Example
opts='user=myusername,pass=mypswd,
servername=SASApp - Stored Process Server'
SECURITYPACKAGE=package-name | NEGOTIATE
identifies the security package that the IOM server uses to authenticate incoming client connections.
package-name
specifies the security package that the IOM server should use to authenticate incoming client connections. Valid values are Kerberos and NTLM.
NEGOTIATE
enables the server to present a set of valid security packages (through the SECPACKAGELIST system option) that the server uses to find a match with an incoming client connection. If the client specifies a security package in the list, then the server attempts to authenticate the client using the matched security package.
Default NEGOTIATE
Note Enclose the option in quotes. Separate multiple options with a comma.
See SECPACKAGE System Option
Example
opts='sspi,securitypackage=negotiate,securitypackagelist=Kerberos,NTLM'
SECURITYPACKAGELIST=package-name, ...
specifies the security authentication packages used by the server.
Note Enclose the option in quotes. Separate multiple options with a comma. To use the SECPACKAGELIST system option, SECPACKAGE must be set to negotiate.
See SECPACKAGELIST System Option
Example
opts='sspi,securitypackage=negotiate,securitypackagelist=Kerberos,NTLM'
SERVERNAME=server-name
specifies the name of the server to which you want to connect.
server-name
is a valid server name or a unique URI that is stored in metadata.
Note Enclose the option in quotes. Separate multiple options with a comma.
Example
opts='servername=SASApp - Stored Process Server,timeout=3600'
SPN=name
specifies the service principal name that the client wishes to use with this IOM Server instance.
name
is a valid service principal name.
Note Enclose the option in quotes. Separate multiple options with a comma.
Example
opts='spn=SAS [Config-Lev1] SASMeta - Metadata Server,timeout=3600'
SSPI
identifies support for the Security Support Provider Interface for single sign-on (SSO) connections to IOM servers.
Note Use SSPI in conjunction with SECURITYPACKAGE and SECURITYPACKAGELIST.
See SECURITYPACKAGE=package-name | NEGOTIATE, SECURITYPACKAGELIST=package-name,
Example
opts='sspi,securitypackage=negotiate,securitypackagelist=Kerberos,NTLM'
TIMEOUT=milliseconds
specifies the time-out, in milliseconds, of all outcall activity.
milliseconds
a number that represents the number of milliseconds to wait before abandoning the server connection.
Note Enclose the option in quotes. Separate multiple options with a comma. The value of the TIMEOUT never reaches the target IOM server.
Example
opts='timeout=3600,servername=SASApp - Stored Process Server'
TRUSTEDSAS
indicates that the owner of the current IOM Server is to be used as the identity when connecting to the peer identified in this IOM URI.
Alias IOMOPTS=, OPTS=
Note Enclose IOM-option in quotes. Separate multiple options with a comma.
See CONNECT Example Using Kerberos
Example
opts='servername=SASApp - Stored Process Server,timeout=3600'
CLSID=
specifies the type of server being connected to.
This is an optional parameter and is required only when connecting to a SAS 9.2 or earlier server. When connecting to SAS 9.3 and later servers, this parameter can be omitted.
The LIST TYPES command displays the full name, short name, and UUID of the known server types. Any of the UUIDs can be used with CLSID.
class-UUID
is a 36-character alphanumeric string that represents a valid class UUID for the server.
Note When used as a connection parameter, enclose class-UUID in quotes.
See CONNECT Example Using a URI and a Class Identifier
Example
clsid="0E3B1810-6646-11D5-8863-00C04F48BC53"
SERVERTYPE=
specifies the type of server being connected to.
This is an optional parameter and is required only when connecting to a SAS 9.2 or earlier server. When connecting to SAS 9.3 and later servers, this parameter can be omitted.
The LIST TYPES command displays the full name, short name, and UUID of the known server types. Any of the types can be used with SERVERTYPE.
"type-name"
an alphanumeric string that represents a valid type for the server.
Alias TYPE=
See CONNECT Example with a Server Name
Example
type=storedprocess
SPAWNED=
specifies the UUID of a spawned server.
This parameter is valid only when connecting to an object spawner. It has the effect of connecting through the spawner to the spawned server.
"UUID"
is a 36-character alphanumeric string that represents a valid UUID (unique universal identifier) for the spawner.
Alias LAUNCHED=
Note Enclose UUID in quotes. Because you are connecting to the object spawner, any other connection options that follow (like PORT=, TYPE=, and so on) refer to the spawner.
See CONNECT and LIST Examples Using a Spawner
Example
spawned="E3D5D132-5DC0-46CB-A4FD-713098B1EE95"
CLUSTER NAME=
specifies the name of a cluster to connect to on the given server. This is useful when connecting to a load balanced server.
"cluster-name"
is the name of the cluster.
Alias CLUSTER=
Note Enclose cluster-name in quotes.
Example
cluster="SASApp - Logical Stored Process Server"
.
CLUSTERSERVER ID=
specifies the UUID of the server in the given cluster to connect to.
"cluster-server-UUID"
a 36-character alphanumeric string that represents a valid UUID for a server in the cluster.
Alias CLUSTERSERVER=
Requirement You must also use the CLUSTER NAME= argument.
Note Enclose cluster-server-UUID in quotes.
Example
clusterserver="15931e31-667f-11d5-8804-00c04f35ac8c"