UPDATE PATH (Change a path when the destination is a drive)

Privilege class

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

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 server or a storage agent is the source.

AUTODetect

Specifies whether the serial number for a drive or library will be automatically detected, reported, and updated in IBM Spectrum® Protect. This parameter is optional. This parameter is only valid for paths defined from the local server to a drive or a library. Possible values are:

No

Specifies that the serial number is not automatically updated.

Yes

Specifies that the serial number is automatically updated to reflect the same serial number that the drive reports to IBM Spectrum Protect.

Important:

1. If you have not previously entered a serial number, then AUTODETECT defaults to YES. If you have previously entered a serial number, then AUTODETECT defaults to NO.
2. AUTODETECT=YES in this command overrides the serial number set in the DEFINE DRIVE command.
3. If you set DESTTYPE=DRIVE and AUTODETECT=YES, then the drive element number in the IBM Spectrum Protect database will be 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 the DEFINE DRIVE command.
4. Depending on the capabilities of the device, the AUTODETECT parameter may 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. This parameter is required.

LIBRary

Specifies the name of the library to which the drive is assigned. The library and its drives must already be defined to the 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/rmt3
Storage agent 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

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

Table 3. Examples of device names

Source to destination	Example
Server to a drive (not a FILE drive)	mt3
Server to a drive (REMOVABLEFILE drive)	e:
Storage agent 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

Important:

• For 349X libraries, the alias name is a symbolic name that is specified in the /etc/ibmatl.conf file. For more information, see IBM Tape Device Drivers Installation and User's Guide, which can be downloaded from the IBM Systems support site at 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

ONLine

Specifies whether the path is available for use. This parameter is optional. 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 for a storage agent to access the files in a 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.

On storage agents, 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.
• If multiple directories were specified for the device class associated with the FILE library, the same number of directories must be specified with the DIRectory parameter of the DEFINE PATH command, for each drive in the FILE library. Storage agent directories are not validated on the server. Specifying incorrect directories can cause a run-time failure.

The directory name or names identify the 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 default value for DIRECTORY is the directory of the server at the time the command is issued.

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, the storage agent will experience mount failures.

The account associated with the storage agent service must be either 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 machine which 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 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 machine 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 which 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 which 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

Important:

• IBM Spectrum Protect does not create shares or permissions, or mount the target file system. You must perform these actions before starting the storage agent.
• You can modify a list of directories only by replacing the entire list.
• You must ensure that storage agents can access newly created FILE volumes. To access FILE volumes, storage agents replace names from the directory list in the device-class definition with the names in the directory list for the associated path definition. The following 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:

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

  

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

  1. You use the following command to set up a FILE library named CLASSA with one drive named CLASSA1 on SERVER1:

     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

  2. 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 server1 sta1 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

     In this scenario, the storage agent, STA1, will replace 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.

     

     define path server1 sta1 srctype=server desttype=drive device=file
     directory="/opt/ibm1,/opt/ibm2,/opt/ibm3" library=classa

     In this scenario, the storage agent, STA1, will replace 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.

  3. 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 will still be able to access file volume c:\server\file1.dsm, but the storage agent STA1 will not be 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 associated with the device class, the storage agent can lose access to a FILE volume in that directory. Although the volume will still be accessible from the 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.
  4. 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 will still be able to access file volume /opt/tivoli1/file1.dsm, but the storage agent STA1 will not be 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 associated with the device class, the storage agent can lose access to a FILE volume in that directory. Although the volume will still be accessible from the 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.