dataserver

Description

(UNIX only) The executable form of the Adaptive Server program, located in $SYBASE/$SYBASE_ASE/bin.

Syntax

dataserver [-f] [-g] [-G] [-h] [-H] [-m] [-q] [-v] [-X]
	[-A system_role
	[-a path_to_CAPs_directive_file]
	[-b master_device_size [k | K | m | M | g | G | t | T] ]
	[-c config_file_for_server]
	[-d device_name]
	[-e path_to_error_log]
	[-i interfaces_file_directory]
	[-K keytab_file]
	[-L config_file_name_for_connectivity]
	[-M shared_memory_repository_directory]
	[-N licinstant]
	[-n system_privileges
	[-p sa_login_name]
	[-r mirror_disk_name]
	[-s server_name]
	[-T trace_flag]
	[-u sa/sso_name]
	[-w master | model database]
	[-y [password] ]
	[-z page_size [ k | K ] ]

Syntax for the Cluster Edition:

dataserver
-u, --admin-name=sa/sso_name 
	--buildquorum=[force] 
-a, --caps-file=filename 
-F, --cluster-input=filename 
	--cluster-takeover 
-L, --conn-config-file=[filename] 
	--create-cluster-id [=quorum]
-D, --default-db-size=size_spec 
-e, --error-log=[filename] 
-G, --event-log-server=logserv_name 
-f, --forcebuild 
-H, --ha-server 
-h, --help=[{0|1|2|3}[,display_width]]
	--instance=instance_name  
-y, --key-password=[key_password]  
-K, --keytab-file=filename
-N, --license-prop-file=filename 
-z, --logical-page-size=page_size 
-Z, --master-db-size=size_spec     
-d, --master-dev=master_device_name 
-b, --master-dev-size=[size_spec]    
	--master_key_password [=password]
-r, --master-mirror=filename   
-m, --masterrecover    
-g, --no-event-logging  
-n, --permission-login=system_privilege 
-Q, --quorum-dev=quorum_dev       
-q, --recover-quiesced    
-w, --rewrite-db=database_name      
-A, --role-logins=system_role
-p, --sa-name={SSO_login_account | sso_role | sa_role} 
-k, --server-principal=s_principal 
-M, --shared-mem-dir=directory_name  
-X, --sybmon                     
-T, --trace=trace_flag     
-v, --version

dataserver -v

Parameters

-A system_role: when enable granular permissions is set to 0, and all users are unable to log into Adaptive Server, provides the server administrator with a login account with sso_role.

-a path_to_CAPs_directive_file: specifies the path to the CAPs directive file.

-b master_device_size [ k | K | m | M | g | G | t | T ]: specifies the size of the master device or database you want to build. The server calculates the sizes, so you can use “K”, “M”, “G”, and “T” instead of exact byte numbers.

-c config_file_for_server: specifies the full path name of an Adaptive Server configuration file. Use this parameter to start Adaptive Server with the configuration values in the specified configuration file. If you specify a configuration file with the dataserver -c parameter, make sure all the parameters in this configuration file are compatible before you boot the server. If some of the configuration parameters are incompatible, the server may not boot. To avoid this, do not specify a configuration file when you build the master device. The build phase uses all default settings when you do not specify a configuration file.For more information, see the System Administration Guide.

-d device_name: is the full path name of the device for the master database. The master database device must be writable by the user who starts Adaptive Server. If you do not use the -d parameter, the default master database device name is d_master.

-e errorlogfile: is the full path name of the error log file for Adaptive Server system-level error messages.

-f: forces initialization of a device or database. -f is valid only when used with -b and/or -w. The server fails to boot if you use -f without either -b or -w. -f forces the server in different ways, depending whether -w is present. See “Potential issues of using -f and -w options together” and “Dependencies and conditions of -b and -w options” for more information.

-G logserv_name: specifies the name of the event log server.

-g: turns off event-logging.

-H: starts the High Availability (HA) server, if you have the HA feature installed on your Adaptive Server.

-h: prints this help message, then exists.

-i interfaces_file_directory: specifies the directory location of the interfaces file to search when connecting Adaptive Server. If -I is omitted, dataserver looks for a file named interfaces in the directory pointed to by your SYBASE environment variable.

-K keytab_file: specifies the path to the keytab file used for authentication in DCE.

-k, --server-principal=s_principal: specifies the server principal name.

-L config_file_name_for_connectivity: specifies the name the configuration file for connectivity.

-M sharedmem_directory: places shared memory files in the specified directory instead of in the default location, $SYBASE. If sharedmem_directory starts with “/”, the directory name is assumed to be absolute. Otherwise, the directory name is interpreted relative to $SYBASE.

--master_key_password [=password]: specifies the master key password when you provide the password on the command line or prompts for a master key password during Adaptive Server startup. The password characters are not displayed, and the password is not validated until later in the Adaptive Server startup sequence.

If you include the password on the command line, it is visible until the memory is read and used.

-m: starts Adaptive Server in single-user mode.

-N licinstant: specifies a nondefault directory location for the license cache file. The default location is $SYBASE/$SYBASE_ASE/sysam/server_name.properties.

-n system_privileges: when enable granular permissions is set to 1, and all users are unable to log into Adaptive Server, provides the server administrator with a login account with change password privilege.

-p sso_login_name: specifies the login name of a System Security Officer when starting Adaptive Server, for the purposes of getting a new password for that account. Adaptive Server generates a random password, displays it, encrypts it, and saves it in master..syslogins as that account’s new password.

-q: treats quiesced databases as “in recovery.”

-r mastermirror: starts the mirror of the master device. Use this parameter to start Adaptive Server if the master device has been damaged.

-s servername: specifies the name of the Adaptive Server to start. If -s is omitted, a server named SYBASE is started.

-T trace_flag

-u sa/sso_name: specifies the System Administrator or System Security Officer’s name you want to unlock.

-v: prints the version number and copyright message for dataserver, then exits.

-w [master | model]: specifies whether you want to write a master or model database.

-X: starts this server as sybmon, not dataserver.

-y [password]: allows you to assign a password for the encrypted private key, so that the server prompts the user for a password. This password should match the password you used to encrypt the private key when it was created. You cannot use this parameter when you are running the server in the background.

Although you can set a password with -y, for security reasons Sybase strongly discourages you from doing so.

A private key is included with your server’s digital certificate. By default, the certificate file located at /usr/local/sybase/certificates/<servername>.crt.

The location of the certificate file changes if you invoke the sp_ssladmin addcert command.

-Z [size_spec]: specifies the size of the initial master database.

-z page_size [ k | K ]: specifies the page size of the server. You must use -b and -w to use this flag, and name an even power of two between 2K and 16K, or else the server does not boot.

Examples

Example 1

Creates a new installation with a 100MB master device and a 4K page:

dataserver -d my_master_device -z 4k -b 100.02M

The spaces between options and their following arguments are optional and acceptable. This example specifies “100.02M” for a 100MB master device because the server requires 16K of overhead for its configuration area.

Example 2

Rewrites a corrupt model database:

dataserver -d d_master -w model -s server_name

Example 3

Specifies the “aseprincipal@MYREALM.COM” principal name:

$SYBASE/$SYBASE_ASE/bin/dataserver -dmaster.dat 
-s secure_ase -k aseprincipal@MYREALM.COM

Example 4

Rewrites a corrupt master database, specifying device size:

dataserver -d my_master_device -w master -z 4k

Example 5

Rewrites a corrupt master database, specifying device and page sizes, forcing the server to accept these values in preference to what it may find in the config block:

dataserver -d my_master_device -w master -z 4k -b
100.02M -f

Example 6

Rewrites a corrupt master database, specifying a page size that does not match what the server finds in its config block. This produces a failure:

dataserver -d my_master_device -w master -z 8k

00:00000:00000:2001/01/19 12:01:26.94 server The
configured server page size does not match that 
specified on the command line. To use the configured 
size, omit the command line size; to use the command 
line size, specify 'force' (-f).

Example 7

Rewrites a corrupt master database, specifying an incorrect page size, even in a normal restart. This produces a failure:

dataserver -d my_master_device -z4000

dataserver: the 'z' flag may not be used without 'b' or 
'w'. dataserver: server will ignore the 'z' flag. 
dataserver: the 'z' flag contained an invalid page size. 
dataserver: the page size must be an even power of two 
between 2048 and 16384 bytes, inclusive.

Example 8

Prompts for a master key password:

dataserver --master_key_passwd  -dd_master  -eerrorlog

Example 9

List account names with role sso_role:

$SYBASE/$SYBASE_ASE/bin/dataserver -d master.dat -s server_name-A sso_role

Example 10

List account names with role sso_role:

$SYBASE/$SYBASE_ASE/bin/dataserver -d master.dat -s server_name--role-logins sso_role

Example 11

List account names with privilege change password:

$SYBASE/$SYBASE_ASE/bin/dataserver -d master.dat -s server_name-n "change password"

Example 12

List account names with privilege change password:

$SYBASE/$SYBASE_ASE/bin/dataserver -d master.dat -s server_name--permission-logins "change password"

Usage

dataserver allows you to create devices and databases that are up to 32Gb in size, depending on the limitation of your operating system. For more information on size limits, see the installation guide for your platform.

Start Adaptive Server with the startserver command rather than by directly executing the dataserver program. If you need to change any of the default values, edit the RUN_servername file in your Sybase installation directory. See the startserver reference page for details.
Because Adaptive Server passwords are encrypted, you cannot recover forgotten passwords. If all System Security Officers lose their passwords, the -p parameter generates a new password for a System Security Officer account. Start Adaptive Server with -p, immediately log in to Adaptive Server with the new random password, and execute sp_password to reset your password to a more secure one.
When you use the -w parameter, dataserver uses the ascii-8 character set instead of the iso_1 character set. If you require the iso_8 character set for master, you can load a dump of the master database or change the character set with sqlloc (sqlloc requires the sybsystemprocs database.)
After you have finished running the Adaptive Server installation program, set the file permissions on the dataserver executable to limit who can execute it.
If you do not specify an Adaptive Server name with the -s parameter, and you have not set the DSLISTEN environment variable, dataserver uses the default Adaptive Server name SYBASE. The value of the DSLISTEN environment variable overrides this default value, and the -s parameter overrides both the default and the DSLISTEN environment variable.
Automatic login lockouts can cause a site to end up in a situation in which all accounts capable of unlocking logins (System Administrators and System Security Officers) are locked. If this occurs, use the dataserver utility with the -u parameter to check the specified login for System Administrator or System Security Officer authorization, unlock the account, and reset the value of the current failed logins counter to zero.

Potential issues of using -f and -w options together

Be particularly careful when using the -f and -w options together. When rewriting master database using the -w option, the server requires that the configuration block page size and device size are correct. If you do not provide them on the command line they must agree. The server refits the master device, and puts master and all other included databases back in their proper places.

When you use the -f option force initialization, your page size and master device size overrides those in the configuration block. In addition, -f assigns all other unknown space—allocation blocks that are either unused or are corrupted—to the master database.

Dependencies and conditions of -b and -w options

The effect of -b changes depending on whether -w is present:

-b without -w creates a new master device as named by -d (the default is d_master) and with the page size as specified by -z (the default is 2048):
- If the named device already exists as an OS file, the attempt fails, and you see a message such as:
```
File already exists. You must remove the existing 
file before attempting to create a new one using 
the server's -b option.
Unable to create master device.
```
- If the named device names an existing raw partition, the attempt fails unless you include the -f flag. This reinitializes the raw partition as a server master device.
-b with -w master tells dataserver to use the size specified in -z for the master device when recreating the master database. It implies nothing about creating a new device.

-w may or may not require additional flags if you use:

-w model – the -z and -b flags are accepted but ignored.
-w master for new installations – -z and -b are not required because the device size information is stored in the config_block.
-w master to upgrade older installations:
- The server requires -b and/or -z if the config_block does not contain a valid entry for the associated size(s). The command fails if it cannot get valid data for the page size or device size.
- You can provide -b and/or -z when the config_block contains valid entries for the size(s) they represent. However if the sizes do not match what is in the config_block, you must add -f to force your new size preferences.

Permissions

Anyone with execute permission on the binary, and who has read/write access to all the files.