Server naming best practices

Use these descriptions as a reference when you install or upgrade an IBM Storage Protect server.

Instance user ID

The instance user ID is used as the basis for other names related to the server instance. The instance user ID is also called the instance owner.

For example: tsminst1

The instance user ID is the user ID that must have ownership or read/write access authority to all directories that you create for the database and the recovery log. The standard way to run the server is under the instance user ID. That user ID must also have read/write access to the directories that are used for any FILE device classes.

Linux operating systemsAIX operating systems

Home directory for the instance user ID

The home directory can be created when creating the instance user ID, by using the option (-m) to create a home directory if it does not exist already. Depending on local settings, the home directory might have the form: /home/instance_user_ID

For example: /home/tsminst1

The home directory is primarily used to contain the profile for the user ID and for security settings.

Linux operating systemsAIX operating systems

Database instance name

The database instance name must be the same as the instance user ID under which you run the server instance.

For example: tsminst1

Windows operating systems

Database instance name on Windows

The database instance name is the name of the server instance as it appears in the registry.

For example: Server1

Linux operating systemsAIX operating systems

Instance directory

The instance directory is a directory that contains files specifically for a server instance (the server options file and other server-specific files). It can have any name that you want. For easier identification, use a name that ties the directory to the instance name.
You can create the instance directory as a subdirectory of the home directory for the instance user ID. For example: /home/instance_user_ID/instance_user_ID

The following example places the instance directory in the home directory for user ID tsminst1: /home/tsminst1/tsminst1

You can also create the directory in another location, for example: /tsmserver/tsminst1

The instance directory stores the following files for the server instance:
  • The server options file, dsmserv.opt
  • The server key database file, cert.kdb, and the .arm files (used by clients and other servers to import the Secure Sockets Layer certificates of the server)
  • Device configuration file, if the DEVCONFIG server option does not specify a fully qualified name
  • Volume history file, if the VOLUMEHISTORY server option does not specify a fully qualified name
  • Volumes for DEVTYPE=FILE storage pools, if the directory for the device class is not fully specified, or not fully qualified
  • User exits
  • Trace output (if not fully qualified)
Windows operating systems

Instance directory on Windows

The instance directory is a directory that contains files specifically for a server instance (the server options file and other server-specific files). It can have any name that you want. For easier identification, use a name that ties the directory to the instance name.
You can use a name that includes the name of the server instance as it appears (or will appear) in the registry. Default server instance names have the form Serverx.

For example: C:\tsm\server1

The instance directory stores the following files for the server instance:
  • The server options file, dsmserv.opt
  • The server key database file, cert.kdb, and the .arm files (used by clients and other servers to import the Secure Sockets Layer certificates of the server)
  • Device configuration file, if the DEVCONFIG server option does not specify a fully qualified name
  • Volume history file, if the VOLUMEHISTORY server option does not specify a fully qualified name
  • Volumes for DEVTYPE=FILE storage pools, if the directory for the device class is not fully specified, or not fully qualified
  • User exits
  • Trace output (if not fully qualified)

Database name

The database name is always TSMDB1, for every server instance. This name cannot be changed.

Server name

The server name is an internal name for IBM Storage Protect, and is used for operations that involve communication among multiple IBM Storage Protect servers. Examples include server-to-server communication and library sharing.

The server name is also used when you add the server to the Operations Center so that it can be managed using that interface. Use a unique name for each server. For easy identification in the Operations Center (or from a QUERY SERVER command), use a name that reflects the location or purpose of the server. Do not change the name of an IBM Storage Protect server after it is configured as a hub or spoke server.

If you use the wizard, the default name that is suggested is the host name of the system that you are using. You can use a different name that is meaningful in your environment. If you have more than one server on the system and you use the wizard, you can use the default name for only one of the servers. You must enter a unique name for each server.

Linux operating systemsAIX operating systemsFor example:
  • PAYROLL
  • SALES
Windows operating systemsFor example,
  • TUCSON_SERVER1
  • TUCSON_SERVER2

Directories for database space and recovery log

The directories can be named according to local practices. For easier identification, consider using names that tie the directories to the server instance.

For example, for the archive log:
  • Linux operating systemsAIX operating systems/tsminst1_archlog
  • Windows operating systemsf:\server1\archlog