Utilities for SAS Federation Server

Introduction

SAS Federation Server contains several utilities that assist with management of your server environment. Utilities include database migration, password encryption and system database backup and restore. Utilities are available for the UNIX and Windows operating systems.

UNIX Utilities

dfsadmin Utility

SAS Federation Server for UNIX contains the dfsadmin utility, located in the bin directory of the installation root. Run any of the commands in dfsadmin using the following syntax: ./bin/dfsadmin yourcommand where yourcommand is one of the following commands:

Command	Description
`start`	Starts SAS Federation Server. Example: `./bin/dfsadmin start`
`stop`	Stops SAS Federation Server. Example: `./bin/dfsadmin stop`
`status`	Checks the run status of SAS Federation Server.
`migrate`	Migrate the Federation Server database from an older version options: <old_install_dir>
`crypt`	Print the encrypted version of a password options: [<password>] For additional information see Password Encryption.
`help`	Displays command usage and options.
`version`	Displays version information.

Password Encryption

The dfsadmin utility contains a crypt command from where you can key the password on the command line in plain text, or let it prompt you so that the password is not echoed to terminal. The password is encrypted using the encryption type installed on the server.

For example,

./bin/dfsadmin crypt my_passwd

Key a password with the crypt command:

[admin@reason fedserver]$ ./bin/dfsadmin crypt my_passwd
{SAS002}1950043249132FE80CEC515733C508D5

Invoke the crypt command and let it prompt for a password:

[admin@reason fedserver]$ ./bin/dfsadmin crypt
Enter password:
Confirm password:
Encrypted value: {SAS002}1950043249132FE80CEC515733C508D5

Note: Enclose the encrypted password in single quotation marks when using it in a connection string.

Database Backup and Restore

It is recommended that you backup the Federation Server databases periodically, especially the system catalog, SYSCAT.tdb. A utility named dfsutil is provided with SAS Federation Server installation and is located in /bin of the installation directory. Using dfsutil, you can back up the system database (SYSCAT.tdb) and other databases such as the SQL Logging database (SQL_Log). However, the SQL Logging database cannot be backed up with dfsutil if it was changed to a third party data store. You can also restore databases using dfsutil as long as the database was backed up using the same utility.

Note: If you backup a database with dfsutil, then you are required to restore that database using dfsutil.

Backup

To backup a database, use the -db parameter with the dfsutil command. For example:

install-path/bin/dfsutil
backup -db syscat
/path/to/backup           
install-path/bin/dfsutil
backup -db sql_log
/path/to/backup

Restore

To restore a database, use the -db parameter with the dfsutil command. For example:

install-path/bin/dfsutil
restore -db syscat
/path/to/backup           
install-path/bin/dfsutil
restore -db sql_log
/path/to/backup

Windows Utilities

Password Encryption

Use the dfs_crypt utility to encrypt passwords. dfs_crypt, is located in the /bin directory of the installation path for SAS Federation Server.

Navigate to [drive:]\Program Files\SASHome\FedServer\server1\bin> and enter: dfs_crypt password
An encrypted password is returned: {SAS002}A984D9084D59A9EA

Note: Enclose the encrypted password in single quotation marks when using it in a connection string.

Database Backup and Restore

It is recommended that you backup the Federation Server databases periodically, especially the system catalog, SYSCAT.tdb. A utility named dfsutil is provided with SAS Federation Server installation and is located in /bin of the installation directory. Using dfsutil, you can back up the system database (SYSCAT.tdb) and other databases such as the SQL Logging database (SQL_Log). However, the SQL Logging database cannot be backed up with dfsutil if it was changed to a third party data source. You can also restore databases using dfsutil as long as the database was backed up using the same utility.

Note: If you backup a database with dfsutil, then you are required to restore that database using dfsutil.

Backup

To backup a database, use the -db parameter with the dfsutil command. For example:

install-path\bin\dfsutil
backup -db syscat
\path\to\backup           
install-path\bin\dfsutil
backup -db sql_log
\path\to\backup

Restore

To restore a database, use the -db parameter with the dfsutil command. For example:

install-path\bin\dfsutil
restore -db syscat
\path\to\backup           
install-path\bin\dfsutil
restore -db sql_log
\path\to\backup