sp_addserver

Defines a remote server, or the name of the local server; specifies the server for remote procedure calls (RPCs) when using the host and port parameters.

Syntax

sp_addserver lname [, class [, pname]]

Component Integration Services (CIS) only:

sp_addserver 'logical_server_name', ASEnterprise, 'host:port:filter'

Parameters

lname – is the name used to address the server on your system. sp_addserver adds a row to the sysservers table if there is no entry already present for lname. Server names must be unique and must conform to the rules for identifiers.
class – identifies the category of server being added. A server class of “null” defaults to “ASEnterprise”. Allowable values for the class parameter are:
- local – local server (there can be only one) used only once after start-up, or after restarting the SAP ASE server, to identify the local server name so that it can appear in messages printed by the SAP ASE server
- null – remote server with no category defined
- ASEnterprise – all versions of SAP ASE; support for SQL Server 4.9 is not provided.
- ASAnywhere – Adaptive Server Anywhere version 6.0 or later.
- ASIQ – a server with server class ASIQ is any version of Adaptive Server IQ of 12.0 or later.
- direct_connect (Component Integration Services only) – an Open Server-based application that conforms to the direct_connect interface specification.
- sds– conforms to the interface requirements of a Specialty Data Store™ as described in the SAP ASE Specialty Data Store Developer’s Kit manual.
Note: The SAP ASE server does not support server class db2. To use db2, migrate your db2 server class to direct_connect class.
pname – is the name in the interfaces file for the server named lname. This enables you to establish local aliases for other SAP ASE servers or Backup Servers that you may need to communicate with. If you do not specify a pname, lname is used.
(Component Integration Services only) You can use pname to specify the hostname or IP address and the port of the server you wish to connect to. This enables you to bypass the need for directory services (such as LDAP or an interfaces file) for the server when using the CT-Library. Use the following format:
- ```
"hostname:port"
```
- ```
"ipaddr:port"
```
Note: You must enclose the hostname and port with single or double quotes to use this option.
filter – in cluster environments – adds a remote server for remote procedure calls (RPCs).
```
filter = ssl [= 'CN = common_name']
```
Use this format to declare the host:port number:
```
ip_address:port
```

Examples

Example 1 – (In cluster environments) Adds a remote server named big_logical_server:
```
sp_addserver 'big_logical_server', ASEntrprise, 
    'maynard:23954:ssl= "CN=ase1.big server 1.com"'
```
The rules for common names are the same as those used for dynamic listeners and the directory service entries.
Example 2 – Adds an entry for a remote server named GATEWAY in master.dbo.sysservers. The pname is also GATEWAY:
```
sp_addserver GATEWAY
```
Example 3 – Adds an entry for a remote server named GATEWAY in master.dbo.sysservers. The pname is VIOLET. If there is already a sysservers entry for GATEWAY with a different pname, the pname of server GATEWAY changes to VIOLET:
```
sp_addserver GATEWAY, null, VIOLET
```
Example 4 – Adds an entry for the local server named PRODUCTION:
```
sp_addserver PRODUCTION, local
```
Example 5 – (Component Integration Services only) Adds an entry for a remote SAP ASE server with the host name “myhost” with port number 10224:
```
sp_addserver S1, ASEnterprise, "myhost:10224"
```
Note: If you use this syntax for pname, the SAP ASE site handler cannot successfully connect to this server; only CIS connections recognize this syntax for pname.
Example 6 – (Component Integration Services only) Adds an entry for a remote SAP ASE server with the host IP 192.123.456.010 with port number 11222:
```
sp_addserver S3, direct_connect, "192.123.456.010:11222"
```

Usage

There are additional considerations when using sp_addserver:

The sysservers table identifies the name of the local server and its options, and any remote servers that the local server can communicate with.

To execute a remote procedure call on a remote server, the remote server must exist in the sysservers table.
If lname already exists as a server name in the sysservers table, sp_addserver changes the remote server’s srvnetname to the name specified by pname. When it does this, sp_addserver reports which server it changed, what the old network name was, and what the new network name is.
The installation or upgrade process for your server adds an entry in sysservers for a Backup Server. If you remove this entry, you cannot back up your databases.
The SAP ASE server requires that the Backup Server have an lname of SYB_BACKUP. If you do not want to use that as the name of your Backup Server, or if you have more than one Backup Server running on your system, modify the pname for server SYB_BACKUP with sp_addserver so that the SAP ASE server can communicate with Backup Server for database dumps and loads.
If you specify an lname, pname and class that already exist in sysservers, sp_addserver prints an error message and does not update sysservers.
Use sp_serveroption to set or clear server options.

See also Remote Servers in Component Integration Services User’s Guide.

Permissions

The permission checks for sp_addserver differ based on your granular permissions settings.

Setting	Description
Enabled	With granular permissions enabled, you must be a user with `manage server` privilege. To execute sp_addserver for a server that is a shared disk cluster, you must be a user with `manage cluster` privilege and `manage server` privilege.
Disabled	With granular permissions disabled, you must be a user with sso_role.

Auditing

Values in event and extrainfo columns from the sysaudits table are:

Information	Values
Event	38
Audit option	exec_procedure
Command or access audited	Execution of a procedure
Information in `extrainfo`	Roles – Current active roles Keywords or options – NULL Previous value – NULL Current value – NULL Other information – All input parameters Proxy information – Original login name, if set proxy in effect