Tivoli Header

Administrator's Reference

REGISTER NODE (Register a Node)

Use this command to register a node to the server.

This command also automatically creates an administrative user ID with client owner authority over the node. You can use this administrative user ID to access the Web backup-archive client from remote locations through a Web browser. If an administrative user ID already exists with the same name as the node being registered, an administrative user ID is not automatically defined. The client node is registered without an administrative user ID. This process also applies if your site uses open registration.

If a client requires a different policy domain than STANDARD, you must register the client node with this command or update the registered node.

Privilege Class

To issue this command, you must have system privilege, unrestricted policy privilege, or restricted policy privilege for the policy domain to which the client node is assigned.

Syntax

>>-REGister Node--node_name--password--+------------------+----->
                                       '-PASSExp--=--days-'
 
   .-USerid--=--node_name---.
>--+------------------------+--+------------------+------------->
   '-USerid--=--+-NONE----+-'  '-CONtact--=--text-'
                '-user_id-'
 
                               .-COMPression--=--Client-----.
>--+------------------------+--+----------------------------+--->
   '-DOmain--=--domain_name-'  '-COMPression--=--+-Client-+-'
                                                 +-Yes----+
                                                 '-No-----'
 
   .-ARCHDELete--=--Yes-----.  .-BACKDELete--=--No------.
>--+------------------------+--+------------------------+------->
   '-ARCHDELete--=--+-Yes-+-'  '-BACKDELete--=--+-No--+-'
                    '-No--'                     '-Yes-'
 
>--+------------------------------+----------------------------->
   '-CLOptset--=--option_set_name-'
 
   .-FORCEPwreset--=--No------.  .-Type--=--Client-----.
>--+--------------------------+--+---------------------+-------->
   '-FORCEPwreset--=--+-No--+-'  '-Type--=--+-Client-+-'
                      '-Yes-'               '-Server-'
 
                    .-MAXNUMMP--=--1------.
>--+-------------+--+---------------------+--------------------->
   '-URL--=--url-'  '-MAXNUMMP--=--number-'
 
   .-AUTOFSRename--=--No---------.  .-KEEPMP--=--No------.
>--+-----------------------------+--+--------------------+------>
   '-AUTOFSRename--=--+-Yes----+-'  '-KEEPMP--=--+-No--+-'
                      +-No-----+                 '-Yes-'
                      '-Client-'
 
   .-VALIdateprotocol--=--No-----------.
>--+-----------------------------------+-----------------------><
   '-VALIdateprotocol--=--+-No-------+-'
                          +-Dataonly-+
                          '-All------'
 
 

Parameters

node_name (Required)
Specifies the name of the client node to be registered. The maximum length of the name is 64 characters.

You cannot specify a node name of NONE.

password (Required)
Specifies the client node's password. The maximum length of the name is 64 characters. The password is not case-sensitive. See Naming Conventions in Tivoli Storage Manager for a table that lists the characters available for specifying a password.

PASSExp
Specifies the number of days the password remains valid. You can set the password expiration period from 0 to 9999 days. A value of 0 means that the password never expires. This parameter is optional. If you do not specify this parameter, the password is set with the global expiration period of 90 days.

USerid
Specifies the administrative user ID with client owner authority. If you do not specify a user ID, by default an administrative user ID with client owner authority is created using the nodename of the client node to be registered. This parameter is optional. When PASSWORDACCESS=GENERATE is used by the client to change the password, the administrative ID with the same name can be used to access the web backup-archive client from a remote location. Possible values are:

NONE
Specifies that an administrative user ID will not be automatically defined.

otheruserid
Specifies a node ID different than the node being registered. You can use this parameter to grant client owner authority to an existing administrative user ID.

CONtact
Specifies a text string of information identifying the node. The parameter is optional. The maximum length of the text string is 255 characters. The contact information must be enclosed in quotation marks if it contains any blanks.

DOmain
Specifies the name of the policy domain to which the node is assigned. The parameter is optional. If you do not specify a policy domain name, the node is assigned to the default policy domain (STANDARD).

When a source server is registered as a node, it is assigned to a policy domain. Data from the source server is stored in the storage pool specified in the archive copy group of the default management class of that domain.

COMPression
Specifies whether the client node compresses its files before sending them to the server for backup and archive. The parameter is optional. The default value is CLIENT.

Possible values are:

Client
Specifies that the client determines whether to compress files.

Yes
Specifies that the client node compresses its files before sending them to the server for backup and archive.

No
Specifies that the client node does not compress its files before sending them to the server for backup and archive.

ARCHDELete
Specifies whether the client node can delete its own archive files from the server. The parameter is optional. The default value is YES. Possible values are:

Yes
Specifies that the client node can delete its own archive files from the server.

No
Specifies that the client node cannot delete its own archive files from the server.

BACKDELete
Specifies whether the client node can delete its own backup files from the server. The parameter is optional. The default value is NO. Possible values are:

No
Specifies that the client node cannot delete its own backup files from the server.

Yes
Specifies that the client node can delete its own backup files from the server.

CLOptset
Specifies the name of the option set to be used by the client. The parameter is optional.

FORCEPwreset
Specifies whether to force a client to change or reset the password. The parameter is optional. The default value is NO. Possible values are:

No
Specifies that the password expiration period is set by the SET PASSEXP command. The client does not need to change or reset the password while attempting to logon to the server.

Yes
Specifies that the client node password will expire at the next logon. The client must change or reset the password at that time. If a password is not specified, you will receive an error message.

Type
Specifies the type of node being registered. The parameter is optional. The default value is CLIENT. Possible values are:

Client
Specifies that the client node is a backup-archive client, HSM client, or TDP application client.

Server
Specifies that the client node is a source server being registered on the target server.

URL
Specifies the URL address that is used in your Web browser to administer the Tivoli Storage Manager client. The parameter is optional.

MAXNUMMP
Specifies the maximum number of mount points a node is allowed to use on the server. A client node uses a mount point when it stores data to a sequential access storage pool. A sequential access storage pool can be tape, optical, or FILE on disk. For some operations, a client may run multiple processes and can therefore use multiple mount points. If the client stores its data to a storage pool that has copy storage pools defined for simultaneous backup, the client may need additional mount points. The parameter is optional. The default value is 1. You can specify an integer from 0-999. A value of 0 specifies that a node cannot acquire any mount point for a backup or archive operation. However, the server will still allow the node a mount point for a restore or retrieve operation.

For nodes that store data on primary storage pools with a list of copy storage pools defined: you must specify one mount point for each storage pool of sequential device type. For example, if a primary storage pool has one copy storage pool defined, and the primary storage pool is a DISK device type, the MAXNUMMP should be 1. However, if that same primary storage pool has a next storage pool that is sequential and it has two copy storage pools defined, then specify a value of 3.

For server-to-server backup: if one server is at a different version than the other server, set the number of mount points on the target server to a value higher than 1, or you will receive an error.

KEEPMP
Specifies whether the client node keeps the mount point for the entire session. The parameter is optional. The default value is NO. Possible values are:

Yes
Specifies that the client node must retain the mount point during the entire session. If policy definitions cause data to be stored to a disk storage pool after storing data to a sequential access storage pool, any mount points held by the session will not be released.

No
Specifies that the client node release the mount point during the session. If policy definitions cause data to be stored to a disk storage pool after storing data to a sequential access storage pool, any mount points held by the session will be released.

AUTOFSRename
Specify whether file spaces are renamed when the client system upgrades to a client that supports Unicode, or let the client decide if the file space should be renamed. The renaming, if allowed, occurs when the client runs one of the following operations: archive, selective backup, full incremental backup, or partial incremental backup. The renaming changes the names of existing backed-up file spaces that are not in Unicode in server storage. Then the file spaces are backed up in Unicode. You can use this parameter for Unicode-enabled Tivoli Storage Manager clients using Windows NT , Windows 2000, Windows XP, and Windows 2002 operating systems. The default is NO.
Note:
After the client with support for Unicode is installed, any new file spaces that the client backs up are stored in server storage using the UTF-8 code page. UTF-8 is a byte-oriented encoding form specified by the Unicode Standard.
Possible values are:

Yes
Existing file spaces are automatically renamed when the client system upgrades to a client that supports Unicode, and the client runs one of the following operations: archive, selective backup, full incremental backup, or partial incremental backup. The renaming occurs whether the client uses the graphical user interface, the command line, or the client scheduler.

For example, the server renames a drive as follows:

Original name: D_DRIVE
New name: D_DRIVE_OLD 

The new name indicates that the file space is stored on the server in a format that is not Unicode.

No
Existing file spaces are not automatically renamed when the client system upgrades to a client that supports Unicode, and the client runs one of the following operations: archive, selective backup, full incremental backup, or partial incremental backup.

Client
The option AUTOFSRENAME in the client's option file determines whether file spaces are renamed.

By default, the client option is set to PROMPT. When the client system upgrades to a client that supports Unicode and the client runs a Tivoli Storage Manager operation with the graphical user interface or the command line, the program displays a one-time prompt to the user about whether to rename file spaces.

When the client scheduler runs an operation, the program does not prompt for a choice about renaming, and does not rename file spaces. Backups of existing file spaces are sent as before (not in Unicode).

Refer to the appropriate Backup-Archive Installation and User's Guide book for more information on the client option.

VALIdateprotocol
Specify whether Tivoli Storage Manager performs a cyclic redundancy check (CRC) to validate the data sent between the client and server. The parameter is optional. The default is NO. Possible values are:

No
Specifies that data validation not be performed on any data sent between the client and server.

Dataonly
Specifies that data validation be performed only on file data that is sent between the client and server. This does not include the file metadata. This mode impacts performance because additional overhead is required to calculate and compare CRC values between the client and the server.

All
Specifies that data validation be performed on all client file data, client file metadata, and Tivoli Storage Manager server metadata that is sent between the client and server. This mode impacts performance as additional overhead is required to calculate and compare CRC values between the client and the server.

Examples

Task 1

Register the client node JOEOS2 with the password SECRETCODE and assign this node to the DOM1 policy domain. This node can delete its own backup and archive files from the server. All files are compressed by the client node before they are sent to the server. This command automatically creates a JOEOS2 administrative user ID with password SECRETCODE. In addition, the administrator now has client owner authority to the JOEOS2 node.

Command:
register node joeos2 secretcode domain=dom1
 archdelete=yes backdelete=yes
 compression=yes

Task 2

Register the client node FRAN and prevent an administrative user ID from being automatically defined.

Command:
register node fran xy34z userid=none

Task 3

Grant client owner authority to an existing administrative user ID, HELPADMIN, when registering the client node JAN. This would not automatically create an administrator ID named JAN, but would grant client owner authority for this node to the HELPADMIN administrator.

Command:
register node jan pwdsafe userid=helpadmin

Task 5

Register a node name of ED whose data is backed up to a primary storage pool that also has a list of 2 copy storage pools defined. The primary storage pool is of disk device type, and the 2 copy storage pools are of sequential device type. Specify 2 as the maximum number of mount points. The client's network has been unstable during the last few weeks. The client wants assurance that his data is not corrupted as it is sent over the network. Specify that Tivoli Storage Manager should validate all data that is sent by this user to the server.

Command:
register node ed pw45twx maxnummp=2 validateprotocol=all

Related Commands

Table 192. Commands Related to REGISTER NODE

Command Description
DEFINE ASSOCIATION Associates clients with a schedule.
DEFINE MACHNODEASSOCIATION Associates a Tivoli Storage Manager node with a machine.
DELETE FILESPACE Deletes data associated with client's filespaces.
LOCK NODE Prevents a client from accessing the server.
REGISTER ADMIN Defines a new administrator without granting administrative authority.
REMOVE NODE Removes a client from the list of registered nodes for a specific policy domain.
RENAME NODE Changes the name for a user that belongs to a specific policy domain.
QUERY NODE Displays partial or complete information about one or more clients.
SET PASSEXP Specifies the number of days after which a password is expired and must be changed.
SET REGISTRATION Specifies whether users can register themselves or must be registered by an administrator.
UNLOCK NODE Enables a locked user in a specific policy domain to access the server.
UPDATE ADMIN Changes the password or contact information associated with any administrator.
UPDATE NODE Changes the attributes associated with a client node.


[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]