IBM Tivoli Storage Manager, Version 7.1

DEFINE PATH (Define a path when the destination is a drive)

Use this syntax when you define a path to a drive.

Privilege class

To issue this command, you must have system privilege or unrestricted storage privilege.

Syntax


>>-DEFine PATH--source_name--destination_name------------------->

>--SRCType--=--+-DATAMover-+--+------------------------+-------->
               '-SERVer----'  '-AUTODetect--=--+-No--+-'   
                                               '-Yes-'     

>--DESTType--=--DRive--LIBRary--=--library_name----------------->

>----DEVIce--=--+-device_name-+--------------------------------->
                '-FILE--------'     

   .-GENERICTAPE--=--No------.  .-ONLine--=--Yes-----.   
>--+-------------------------+--+--------------------+---------->
   '-GENERICTAPE--=--+-Yes-+-'  '-ONLine--=--+-Yes-+-'   
                     '-No--'                 '-No--'     

   .-DIRectory--=--current_directory_name-.   
>--+--------------------------------------+--------------------><
   |               .-,--------------.     |   
   |               V                |     |   
   '-DIRectory--=----directory_name-+-----'

Parameters

source_name (Required)

Specifies the name of source for the path. This parameter is required.

destination_name (Required)

Specifies the name of the destination. This parameter is required.

SRCType (Required)

Specifies the type of the source. This parameter is required. Possible values are:

DATAMover: Specifies that a data mover is the source.
SERVer: Specifies that a storage agent is the source.

AUTODetect

Specifies whether the serial number for a drive is automatically updated in the database at the time that the path is defined. This parameter is optional. This parameter is only valid for paths that are defined from the local server to a drive. Possible values are:

No

Specifies that the serial number is not automatically updated. The serial number is still compared with what is already in the database for the device. The server issues a message if there is a mismatch.

Yes

Specifies that the serial number is not automatically updated to reflect the same serial number that the drive reports to Tivoli® Storage Manager.

Important:

If you did not set the serial number when you defined the drive, the server always tries to detect the serial number, and AUTODETECT defaults to YES. If you previously entered a serial number, then AUTODETECT defaults to NO.
The use of AUTODETECT=YES in this command means that the serial number set in the drive definition is updated with the detected serial number.
If you set DESTTYPE=DRIVE and AUTODETECT=YES, then the drive element number in the Tivoli Storage Manager database is automatically changed to reflect the same element number that corresponds to the serial number of that drive. This is true for drives in a SCSI library. For more information about the element number, see DEFINE DRIVE.
Depending on the capabilities of the device, the AUTODETECT parameter might not be supported.

DESTType=DRive (Required)

Specifies that a drive is the destination. When the destination is a drive, you must specify a library name.

LIBRary

Specifies the name of the library to which the drive is assigned. The library and its drives must already be defined to the Tivoli Storage Manager server. If the path is from a NAS data mover to a library, the library must have LIBTYPE of SCSI, 349X, or ACSLS.

DEVIce

Specifies the name of the device as known to the source, or FILE if the device is a logical drive in a FILE library.

The source uses the device name to access the drive. See Table 1 for examples.

Table 1. Examples of device names
Source to destination	Example
Server to a drive (not a FILE drive)	`/dev/mt3` `/dev/rmt/tsmmt3` `/dev/rmt/3mt` `mt3`
Storage agent (on a Windows system) to a drive (not a FILE drive)	`mt3`
Storage agent to a drive when the drive is a logical drive in a FILE library	`FILE`
NAS data mover to a drive	NetApp NAS file server: `rst0l` EMC Celerra NAS file server: `c436t0l1` IBM® System Storage® N Series: `rst0l`

The source uses the device name to access the drive. See Table 2 for examples.

Table 2. Examples of device names
Source to destination	Example
Server to a drive (not a FILE drive)	`/dev/tsmscsi/mt3`
Storage agent to a drive (not a FILE drive)	`/dev/tsmscsi/mt3`
Storage agent to a drive when the drive is a logical drive in a FILE library	`FILE`
NAS data mover to a drive	NetApp NAS file server: `rst0l` EMC Celerra NAS file server: `c436t0l1` IBM System Storage N Series: `rst0l`

Important:

For 349X libraries, the alias name is a symbolic name that is specified in the /etc/ibmatl.conf file. For 349X libraries, the alias name is a symbolic name that is specified in the c:\winnt\ibmatl.conf file. For more information, refer to the IBM Tape Device Drivers Installation and User’s Guide. The guide can be downloaded from the IBM Systems support site at the following URL: http://www.ibm.com/support/docview.wss?uid=ssg1S7002972.
For information about how to obtain names for devices that are connected to a NAS file server, consult the product information for the file server. For example, for a NetApp file server, connect to the file server using Telnet and issue the SYSCONFIG command. Use this command to determine device names for drives:
```
sysconfig -t
```

GENERICTAPE

Specifies whether the tape drive to be used is a GENERICTAPE device class type. If the device is a tape drive and is not supported by Tivoli Storage Manager but is supported for the Windows operating system, you can use it with the generic tape format. To use the drive, specify GENERICTAPE=Yes when you define a path to the drive. The default is No. Possible values are:

Yes: Specifies that the tape drive to be used is a GENERICTAPE device class type.
No: Specifies that the tape drive to be used is not a GENERICTAPE device class type.

ONLine

Specifies whether the path is available for use. This parameter is optional. The default is YES. Possible values are:

Yes: Specifies that the path is available for use.
No: Specifies that the path is not available for use.

The source and the destination must both be available to use the path.

For example, if the path from a data mover to a drive is online, but either the data mover or the drive is offline, you cannot use the path.

DIRectory

Specifies the directory location or locations where the storage agent reads and writes the files that represent storage volumes for the FILE device class that is associated with the FILE library. The DIRECTORY parameter is also used for devices of type REMOVABLEFILE. For REMOVABLEFILE devices, the DIRECTORY parameter provides information for the server (not a storage agent) along with the DRIVE parameter to describe access to the device. This parameter is optional.

For a path from a storage agent to a FILE device, this parameter is only valid when all of the following conditions are true:

The source type is SERVER (meaning a storage agent that has been defined as a server to this server).
The source name is the name of a storage agent, not the server.
The destination is a logical drive that is part of a FILE library that is created when the device class was defined.

If you specified multiple directories for the device class associated with the FILE library, you must specify the same number of directories for each path to the FILE library. Do not change or move existing directories on the server that the storage agent is using so that the device class and the path remain synchronized. Adding directories is permitted. Specifying a mismatched number of directories can cause a runtime failure.

The default value for DIRECTORY is the directory of the server at the time the command is issued. The Windows registry is used to locate the default value.

Use a naming convention that you can use to associate the directory with a particular physical drive. This can help ensure that your configuration is valid for sharing the FILE library between the server and storage agent. If the storage agent is on a Windows system, use a universal naming convention (UNC) name. When the storage agent lacks permission to access remote storage, it experiences mount failures.

The account that is associated with the storage agent service must either be an account within the local administrator's group or an account within the domain administrator's group. If the account is in the local administrator's group, the user ID and password must match that of an account with permissions to access storage as provided by the system that administers the remote share. For example, if a SAMBA server is providing access to remote storage, the user ID and password in the SAMBA configuration must match that of the local administrator user ID and password associated with the storage agent service.

define devclass file devtype=file shared=yes mountlimit=1
directory=d:\filedir\dir1
define path sta1 file1 srctype=server desttype=drive
library=file1 device=file
directory=\\192.168.1.10\filedir\dir1

In the previous example, the DEFINE DEVCLASS command establishes the shared file system in the directory that is accessed by the server as D:\FILEDIR\DIR1. The storage agent, however, is using UNC name \\192.168.1.10\FILEDIR\DIR1. This means that the system with TCP/IP address 192.168.1.10 is sharing the same directory using FILEDIR as the shared name. Also, the storage agent service has an account that can access this storage. It can access it either because it is associated with a local account with the same user ID and password as 192.168.1.10 or it is associated with a domain account that is available on both the storage agent and on 192.168.1.10. If appropriate to the installation, you can replace the 192.168.1.10 with a symbolic name such as:

example.yourcompany.com

Attention:

Storage agents access FILE volumes by replacing a directory name in a volume name with a directory name from a directory in the list provided with the DEFINE PATH command. Directories that are specified with this parameter are not validated on the Tivoli Storage Manager server.
Tivoli Storage Manager does not create shares or permissions, or mount the target file system. You must complete these actions before you start the storage agent.

Example: Define a path from a server to a drive

Define a path from a server to a drive. In this case, the server name is NET1, the drive name is TAPEDRV6, the library is NETLIB, and the device name is mt4. Set AUTODETECT to NO.

define path net1 tapedrv6 srctype=server autodetect=no desttype=drive
    library=netlib device=mt4

Example: Define a path from a data mover server to a drive for backup and restore

Define a path from the data mover that is a NAS file server to the drive that the NAS file server will use for backup and restore operations. In this example, the NAS data mover is NAS1, the drive name is TAPEDRV3, the library is NASLIB, and the device name for the drive is rst0l.

define path nas1 tapedrv3 srctype=datamover desttype=drive library=naslib
    device=rst0l

Example: Define a path from a storage agent to a drive for backup and restore

Define a path from storage agent SA1 to the drive that the storage agent uses for backup and restore operations. In this example, the library is TSMLIB, the drive is TAPEDRV4, and the device name for the drive is /dev/tsmscsi/mt3.

define path sa1 tapedrv4 srctype=server desttype=drive library=tsmlib
    device=/dev/tsmscsi/mt3

Example: Define a path from a storage agent to a drive for backup and restore

define path sa1 tapedrv4 srctype=server desttype=drive library=tsmlib
    device=/dev/mt3

Example: Define a path to give a storage agent access to shared disk storage

Define a path that gives the storage agent access to files on disk storage that is shared with the Tivoli Storage Manager server. Drive FILE9 is defined to library FILE1 on the server. The storage agent SA1 accesses FILE9. On the storage agent, this data is on directory \\192.168.1.10\filedata.

AIX operating systems HP-UX operating systems Sun Solaris operating systems The data for FILE9 resides on the server at /tsmdata/filedata.

Windows operating systems The data for FILE9 resides on the server at d:\tsmdata\filedata.

define path sa1 file9 srctype=server desttype=drive library=file1 device=file
    directory="\\192.168.1.10\filedata"

Example: Configure a storage agent to use a FILE library

The following example illustrates the importance of matching device classes and paths to ensure that storage agents can access newly created FILE volumes.

Suppose you want to use these three directories for a FILE library: Windows operating systems

c:\server
d:\server
e:\server

/opt/tivoli1
/opt/tivoli2
/opt/tivoli3

Use the following command to set up a FILE library named CLASSA with one drive named CLASSA1 on SERVER1:

Windows operating systems

define devclass classa devtype=file 
directory="c:\server,d:\server,e:\server" 
shared=yes mountlimit=1

define devclass classa devtype=file 
directory="/opt/tivoli1,/opt/tivoli2,/opt/tivoli3" 
shared=yes mountlimit=1

You want the storage agent STA1 to be able to use the FILE library, so you define the following path for storage agent STA1:
```
define path sta1 classa1 srctype=server desttype=drive device=file
directory="\\192.168.1.10\c\server,\\192.168.1.10\d\server,
\\192.168.1.10\e\server" library=classa
```
```
define path sta1 classa1 srctype=server desttype=drive device=file
directory="/opt/ibm1,/opt/ibm2,/opt/ibm3" library=classa
```
In this scenario, the storage agent, STA1, replaces the directory name c:\server with the directory name \\192.168.1.10\c\server to access FILE volumes that are in the c:\server directory on the server.

In this scenario, the storage agent, STA1, replaces the directory name /opt/tivoli1 with the directory name /opt/ibm1/ to access FILE volumes that are in the /opt/tivoli1 directory on the server.
File volume c:\server\file1.dsm is created by SERVER1. If you later change the first directory for the device class with the following command:
```
update devclass classa directory="c:\otherdir,d:\server,e:\server"
```
SERVER1 is still able to access file volume c:\server\file1.dsm, but the storage agent STA1 is not able to access it because a matching directory name in the PATH directory list no longer exists. If a directory name is not available in the directory list that is associated with the device class, the storage agent can lose access to a FILE volume in that directory. Although the volume is still accessible from the Tivoli Storage Manager server for reading, failure of the storage agent to access the FILE volume can cause operations to be retried on a LAN-only path or to fail.
If file volume /opt/tivoli1/file1.dsm is created on SERVER1, and if the following command is issued,
```
update devclass classa directory="/opt/otherdir,/opt/tivoli2,
/opt/tivoli3"
```
SERVER1 is still able to access file volume /opt/tivoli1/file1.dsm, but the storage agent STA1 is not able to access it because a matching directory name in the PATH directory list no longer exists. If a directory name is not available in the directory list that is associated with the device class, the storage agent can lose access to a FILE volume in that directory. Although the volume is still accessible from the Tivoli Storage Manager server for reading, failure of the storage agent to access the FILE volume can cause operations to be retried on a LAN-only path or to fail.

Feedback