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 and can be used to perform outboard copy operations.

See the documentation for your device for guidance on specifying the parameters for this command.

Privilege class

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

Syntax

Read syntax diagramSkip visual syntax diagram
>>-DEFine DATAMover--data_mover_name--Type--=--NAS-------------->

                          .-LLAddress--=--10000----.   
>--HLAddress--=--address--+------------------------+------------>
                          '-LLAddress--=--tcp_port-'   

>--USERid--=--userid--PASsword--=--password--------------------->

   .-ONLine--=--Yes-----.                                   
>--+--------------------+--DATAFormat--=--+-NETAPPDump--+------><
   '-ONLine--=--+-Yes-+-'                 +-CELERRADump-+   
                '-No--'                   '-NDMPDump----'   

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 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=NAS (Required)
Specifies that the data mover is a NAS file server.
HLAddress (Required)
Specifies either the numerical IP address or the domain name, which are used to access the NAS file server.
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 administrative ID for a NetApp file server.
PASsword (Required)
Specifies the password for the user ID to log onto the NAS file server.
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 off-line.
Important: If a library is controlled using a path from a NAS data mover to the library, and the NAS data mover is offline, the server will not be able to access the library. If the server is halted and restarted while the NAS data mover is offline, the library will not be initialized.
DATAFormat (Required)
Specifies the data format that is used by this data mover.
NETAPPDump
NETAPPDUMP must be used for NetApp NAS file servers and the IBM® System Storage® N Series.
CELERRADump
CELERRADUMP must be used for EMC Celerra NAS file servers.
NDMPDump
NDMPDump must be used for NAS file servers other than NetApp or EMC file servers.

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

Define a data mover for the NAS node named NAS1. The numerical IP address for the data mover is 9.67.97.103, at port 10000. The NAS file server is a NetApp device.
define datamover nas1 type=nas hladdress=9.67.97.103 lladdress=10000 userid=root
   password=admin dataformat=netappdump

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.TUCSON.IBM.COM at port 10000.
define datamover nas1 type=nas hladdress=netapp2.tucson.ibm.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 NAS1. The numerical IP address for the data mover is 9.67.97.103, at port 10000. The NAS file server is neither a NetApp or an EMC file server.
define datamover nas1 type=nas hladdress=9.67.97.103 lladdress=10000
    userid=root password=admin dataformat=ndmpdump

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.