sdeservice (Windows only)

The sdeservice command manages the ArcSDE service on Windows operating systems.

Usage syntax

sdeservice -o create -p <ArcSDE_admin_password> [-n] [-H <sde_directory>]
[-d {ORACLE,SID | SQLSERVER,SQLSERVERINSTANCE | DB2,DB2INSTANCE | INFORMIX | POSTGRESQL,PGINSTANCE}]
[-i <service>] [-u <service_user>] [-P <service_user_password>] [-s <data_source>]

sdeservice -o delete
[-d {ORACLE,SID | SQLSERVER,SQLSERVERINSTANCE | DB2,DB2INSTANCE | INFORMIX | POSTGRESQL}]
[-i <service>] [-N]

sdeservice -o list [-i <service>]

sdeservice -o modify -r <registry_keyword> -p <ArcSDE_admin_password> -v <new_value> [-i <service>]
[-d {ORACLE,SID | SQLSERVER,SQLSERVERINSTANCE | DB2,DB2INSTANCE | INFORMIX | POSTGRESQL}]

sdeservice -o register -r <registry_keyword> -v <value> -p <ArcSDE_admin_password> [-i <service>]
[-d <ORACLE,SID | SQLSERVER,SQLSERVERINSTANCE | DB2,DB2INSTANCE | INFORMIX | POSTGRESQL>]

sdeservice -o unregister -r <registry_keyword> -p <ArcSDE_admin_password> [-i <service>]
[-d {ORACLE,SID | SQLSERVER,SQLSERVERINSTANCE | DB2,DB2INSTANCE | INFORMIX | POSTGRESQL}]

sdeservice -h

sdeservice -?

Operations

Operation	Description	Example
create	Creates an ArcSDE service on Windows	Create an ArcSDE service
delete	Deletes an ArcSDE service from Windows	Delete an ArcSDE service
list	Displays service information for all or a specified ArcSDE service	Display service information
modify	Modifies an existing registry keyword	Modify registry keyword
register	Adds a registry keyword to the Windows registry	Add a keyword to the Windows registry
unregister	Removes a registry keyword from the Windows registry	Remove a keyword from the Windows registry

Options

Options	Description
-d	Used to identify to which DBMS the service connects and service dependency A service dependency identifies a service that should start before ArcSDE. DB2INSTANCE, SQLSERVERINSTANCE, SID, or PGINSTANCE are optional and are used to identify an instance of a database, either remote or local. SID (default: ORCL), DB2INSTANCE (default: DB2-0), SQLSERVERINSTANCE SQL Server named instance or data source (default: MSSQLServer), or PGINSTANCE (default:pgsql-8.3).
-h or -?	Use either of these options to see the usage and options for the command. Note: If using a C shell, use -h or "-\?".
-H	ArcSDE home directory (SDEHOME); only needed if the SDEHOME variable isn't set or multiple services are in use
-i	ArcSDE service name; required if default value esri_sde not used
-n	Exclude database service from list of services that are ArcSDE dependent.
-N	No verification is performed; the operation begins immediately after being invoked
-o	Operation
-p	DBMS password for ArcSDE administrator ArcSDE for Coverages password syntax: password; layer_admin_password.
-P	ArcSDE service user password (Windows service log on account password)
-r	Registers/Unregisters/Modifies the following Windows registry keywords: SDEHOME—ArcSDE software location SDE_DBA_PASSWORD—ArcSDE administrator DBMS user's password SDE_DBA_USER—ArcSDE administrative user name ADMIN_DATABASE (Not used for Oracle)—Name of database containing the ArcSDE geodatabase NLS_LANG (ORACLE only)—ArcSDE server code page NET_SERVICE_NAME (ORACLE only)—Oracle TWO_TASK or LOCAL environment variable
-s	The data source name The name of the DBMS instance to which the ArcSDE service connects
-u	ArcSDE Windows service account user* User must be a Windows user who has administrator permissions on the server computer. Include the domain name if needed. For example, if you are logged in to the LAMBERT domain and your user name is joe, enter LAMBERT\joe. You should be logged in as this user when you create the service.
-v	Registry value

*A user who is not an administrator but has been granted the log on as a service permission can also run the service. When using Windows authentication for the DBMS, the service user must also have the Replace a process level token permission to switch the security context of the gsrvr.exe process to the connecting user.

Discussion

The sdeservice administration utility manages the ArcSDE services and registry entries on Windows platforms. Services are created and registered with either this tool or with the ArcSDE Post Installation wizard. Creating a service adds Windows registry entries.

Use the modify option to modify existing registry entries such as SDEHOME or SDE_DBA_PASSWORD. Use the register option to register new entries not provided by default, such as ADMIN_DATABASE. The unregister option removes the entry.

The delete operation will delete the ArcSDE service and all related registry entries.

Examples

Create an ArcSDE service

Use the create operation to make a new ArcSDE service on a machine with a Windows operating system. In all create examples, you must manually edit %windir%\system32\drivers\etc\services and %SDEHOME%\etc\services.sde to add the service name and port number.

This example creates a new ArcSDE service for Informix:

sdeservice -o create -d INFORMIX -p sde.space -i esri_inf -u informix -P sde.inf

The following example will create a new ArcSDE service for Microsoft SQL Server:

sdeservice -o create -d SQLSERVER -p spatial.data -i esri_sde -H z:\arcgis\arcsde\sqlexe

In this example, a new ArcSDE service, esri_psql, is created for a PostgreSQL geodatabase on a machine named server4. The name of the PostgreSQL instance is pgsql-8.3.

sdeservice -o create -d POSTGRESQL,pgsql-8.3 -i esri_psql -s server4

Please enter SDE DBA password:

Successfully created and registered esri_psql

Notice that in the previous example, the ArcSDE administrator's password was not included in the command with the -p option. If omitted, you are prompted to provide the password.

This example creates a new SQL Server ArcSDE service pointing to a named instance called Oceans\GIS1:

sdeservice -o create -d SQLSERVER,Oceans\GIS1 -p spatial.data -i esri_sde01 -H z:\arcgis\arcsde\sqlexe

The instance name in the previous statement could have been specified with the -s option instead, since for SQL Server the instance name and data source are the same. For example:

sdeservice -o create -d SQLSERVER -s Oceans\GIS1 -p spatial.data -i esri_sde01 -H z:\arcgis\arcsde\sqlexe

Note: It is assumed the ArcSDE administrator user for which you are providing the password (-p) is SDE. It is also assumed that the name of the database to which the service applies is SDE. If your ArcSDE administrator user is not SDE, such as when you use a DBO schema in SQL Server, you must set the SDE_DBA_USER registry key to the login name of the DBO user using sdeservice -o register. If the name of your database is not SDE, you must set the ADMIN_DATABASE registry key to the name of your database using the sdeservice -o register command.

Delete an ArcSDE service

The delete operation deletes an existing ArcSDE service on a machine with a Windows operating system.

This example deletes an ArcSDE service on PostgreSQL:

sdeservice -o delete -i esri_pgs -d POSTGRESQL

Display service information

The list operation displays service information for all ArcSDE services or an ArcSDE service specified in the command. Below, information will be listed for the service miss.

Note: If the service name is esri_sde, you do not need to specify the -i option; you could just type sdeservice -o list.

sdeservice –o list –i miss

SDE service Information
-----------------------------------------------------------------------------------------
RDBMS: SQLServer
Name: ArcSde Services(miss)
SDEHOME: C:\ArcGIS\ArcSDE\sqlexe
Datasource: MOOSE
Admin_database: gisdb
Version: 9.3.0
Status: SERVICE_RUNNING

Modify a registry keyword

Use the modify operation to modify an existing Windows registry keyword.

sdeservice -o modify -r SDEHOME -p spatial.data -v c:\ArcSDE2\ora10gexe -d ORACLE10G,ORCL

Add a keyword to the Windows registry

This example registers an ADMIN_DATABASE (database with system tables) named Seamounts.

sdeservice -o register -d SQLSERVER -r ADMIN_DATABASE -v Seamounts -i sde2 -p spatial.data

Remove a keyword from the Windows registry

The unregister operation removes an existing keyword from the Windows registry. Here, the registry keyword added in the last example is unregistered.

sdeservice -o unregister -r ADMIN_DATABASE -d SQLSERVER -i sde2 -p spatial.data

Home