DEFINE DATAMOVER (Define a data mover)

Use this command to define a data mover. A data mover is a named device that accepts a request from Tivoli® Storage Manager to transfer data. A data mover can be used to complete outboard copy operations.

Privilege class

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

Syntax


>>-DEFine DATAMover--data_mover_name---------------------------->

   .-Type--=--NAS--------------------.                          
>--+---------------------------------+--HLAddress--=--address--->
   |                         (1) (2) |                          
   '-Type--=--+-NASCLUSTER-+---------'                          
              '-NASVSERVER-'                                    

   .-LLAddress--=--10000----.                      
>--+------------------------+--USERid--=--userid---------------->
   '-LLAddress--=--tcp_port-'                      

                          .-ONLine--=--Yes-----.   
>--PASsword--=--password--+--------------------+---------------->
                          '-ONLine--=--+-Yes-+-'   
                                       '-No--'     

>--DATAFormat--=--+-NETAPPDump--+------------------------------><
                  +-CELERRADump-+   
                  '-NDMPDump----'

Notes:

You can specify TYPE=NASCLUSTER and TYPE=NASVSERVER only on an AIX®, Linux, Solaris, or Windows operating system.
You can specify TYPE=NASCLUSTER and TYPE=NASVSERVER only if DATAFORMAT=NETAPPDUMP.

Parameters

data_mover_name (Required)

Specifies the name of the data mover. This name must be the same as a node name that you previously registered by using the REGISTER NODE TYPE=NAS command. The data that is backed up from this NAS data mover will be assigned to this node name in the server database. A maximum of 64 characters can be used to specify the name.

Type

Specifies the type of data mover. This parameter is optional. The default value is NAS.

NAS: Specifies that the data mover is a NAS file server.
NASCLUSTER: Specifies that the data mover is a clustered NAS file server.
Restriction: You can specify the NASCLUSTER value only if DATAFORMAT=NETAPPDUMP.
NASVSERVER: Specifies that the data mover is a virtual storage device within a cluster.
Restriction: You can specify the NASVSERVER value only if DATAFORMAT=NETAPPDUMP.

HLAddress (Required)

Specifies either the numerical IP address or the domain name that is used to access the NAS file server.

Tip: To determine the numerical IP address, access the NAS file server. Then, follow the instructions in the file server documentation for obtaining the address.

LLAddress

Specifies the TCP port number to access the NAS device for Network Data Management Protocol (NDMP) sessions. This parameter is optional. The default value is 10000.

USERid (Required)

Specifies the user ID for a user that is authorized to initiate an NDMP session with the NAS file server. For example, enter the user ID that is configured on the NetApp file server for NDMP connections.

Tip: To determine the user ID, access the NAS file server. Then, follow the instructions in the file server documentation for obtaining the user ID.

PASsword (Required)

Specifies the password for the user ID to log on to the NAS file server.

Tip: To determine the password, access the NAS file server. Then, follow the instructions in the file server documentation for obtaining the password.

ONLine

Specifies whether the data mover is available for use. This parameter is optional. The default is YES.

Yes: The default value. Specifies that the data mover is available for use.
No: Specifies that the data mover is not available for use. When the hardware is being maintained, you can use the UPDATE DATAMOVER command to set the data mover offline.
If a library is controlled by using a path from a NAS data mover to the library, and the NAS data mover is offline, the server is not able to access the library. If the server is halted and restarted while the NAS data mover is offline, the library is not initialized.

DATAFormat (Required)

Specifies the data format that is used by this data mover.

NETAPPDump: Must be used for NetApp NAS file servers and the IBM® System Storage® N Series.
CELERRADump: Must be used for EMC Celerra NAS file servers.
NDMPDump: Must be used for NAS file servers other than NetApp or EMC file servers.

Example: Define a data mover by domain name

Define a data mover for the node named NAS1. The domain name for the data mover is NETAPP2.EXAMPLE.COM at port 10000.

define datamover nas1 type=nas hladdress=netapp2.example.com lladdress=10000
    userid=root password=admin dataformat=netappdump

Example: Define a data mover by IP address

Define a data mover for the node named NAS2. The numerical IP address for the data mover is 203.0.113.0, at port 10000. The NAS file server is not a NetApp or EMC file server.

define datamover nas2 type=nas hladdress=203.0.113.0 lladdress=10000
    userid=root password=admin dataformat=ndmpdump

Example: Define a data mover for a clustered file server by IP address

Define a data mover for the clustered file server named NAS3. The NAS file server is a NetApp device. The numerical IP address for the data mover is 198.51.100.0, at port 10000.

define datamover nas3 type=nascluster hladdress=198.51.100.0 
    lladdress=10000 userid=root password=admin dataformat=netappdump

Related commands

Table 1. Commands related to DEFINE DATAMOVER
Command	Description
DEFINE PATH	Defines a path from a source to a destination.
DELETE DATAMOVER	Deletes a data mover.
QUERY DATAMOVER	Displays data mover definitions.
REGISTER NODE	Defines a client node to the server and sets options for that user.
UPDATE DATAMOVER	Changes the definition for a data mover.