nsr_client - NetWorker resource type 'NSR client'
type: NSR client
Each NSR client is described by a single resource of type NSR client (see nsr_resource(5)). To edit the NSR client resources for a Net- Worker server type: nsradmin -c "type:NSR client" See the nsradmin(8) manual page for more information on using the Net- Worker administration program. The client resource may also be edited using the NetWorker Management Console command. For each NetWorker client, this resource describes which files should be saved, the schedule used to save these files, which directive should be used to omit files from the save, how long the files' index entries should be kept in the on-line file index and the media index, and who is allowed to back up, browse, and recover this client's files. A client may have more than one resource describing it.
The following attributes are defined for resource type NSR client. The information in parentheses describes how the attribute values are accessed. Read-only indicates that the value cannot be changed by an administrator. Read/write means the value can be set as well as read. Hidden means it is an attribute of interest only to programs or experts. Hidden attributes can only be seen when the hidden option is turned on in nsradmin(8). Dynamic attributes have values which change rapidly. Encrypted attributes contain data that is not displayed in its original form. The assumption is that the data is sensitive in nature and needs to be protected from accidental disclosure. Several additional attributes (for example, administrator) are common to all resources, and are described in nsr_resource(5). Certain client attributes (e.g. "Client OS type", "CPUs", "NetWorker version" and "Enabler in use") do not get populated in the Client Setup/Information window of the NetWorker GUI, when the NetWorker Server is running under Eval mode or an Enterprise license. However, when the NetWorker server has a Workgroup/NetWork/Power edition enabler, these client attributes are refreshed appropriately in the window after the client backup. name (read-only, single string) This attribute specifies the hostname of this NetWorker client. Example: name: venus; client id (read-only) The client id is used by the media database and for index back- ups to identify a save set with a specific client. Each client has a unique client id which is automatically generated by the NetWorker server (nsrd). server (constant, single string) This attribute specifies the hostname of this client's NetWorker server. The server's hostname will be used as the default value. Example: server: jupiter; comment (read/write) This attribute is provided for the administrator to keep any explanatory remarks or supplementary information about this Net- Worker client. Example: comment: machine located in room 243; scheduled backup (read/write, choice) This attribute is provided for the administrator to disable this client for scheduled backups. This value is specific to this client resource, it does not propagate to any other existing resources for the same client. By default this attribute is Enabled. Example: scheduled backup: Disabled; archive services (read/write, choice) This attribute determines if this system can use archive ser- vices. This attribute can only be set if archive support has been enabled on the server. The choices are enabled or dis- abled. Example: archive services: enabled; schedule (read/write, choice) This attribute specifies the name of the schedule controlling the backup levels for the save sets listed in the 'save set' attribute. The default value is 'Default'. Any currently defined schedule names may be used, see nsr_schedule(5). Example: schedule: Default; browse policy (read/write, choice) This attribute specifies the name of the policy controlling how long entries will remain in this client's on-line file index. The default value is 'Month'. Any currently defined policy name may be used as long as the period defined by the policy is not longer than the retention policy's period, see nsr_policy(5). Example: browse policy: Month; retention policy (read/write, choice) This attribute specifies the name of the policy controlling how long entries will remain in the media index before they are marked as recyclable. The default value is 'Year'. Any cur- rently defined policy name may be used as long as the period defined by the policy is not shorter than the browse policy's period, see nsr_policy(5). The pool resource also contains a retention policy attribute. If the pool that a clone save set will be written to also has a defined retention policy, the longer of the client and pool policy will be utilized. Cloned save sets will utilize the pool retention policy if one is defined. Example: retention policy: Year; directive (read/write, choice) This attribute specifies the directive to use when backing up the client. The default value is NULL. The valid choices for the directive resource are names of the currently defined 'NSR directive' resources, see nsr_directive(5). Example: directive: Unix with compression directives; group (read/write, choice list) This attribute specifies the group this client is a member of. The group controls the start time for automatic backups. The value may be one of the currently defined 'NSR group' resources, see nsr_group(5). The default value is 'Default'. Example: group: Default; save set (read/write, list) This attribute lists the path names to be saved for this client. The names should be separated by comma space (, ). The default value is 'All'. On all NetWorker supported clients, 'All' refers to the mounted file systems. Also, NetWorker supports 'wildcard' at the filesystem level. Eg., For a Unix NetWorker client, '/*' refers to all mounted filesystems under '/'. And if '/space1' and '/space2' are valid filesystems, one could use '/space*' to get both these filesystems backed up on the partic- ular client. Please note that 'wildcard ' matching at the subdi- rectory level, is not supported. So, '/space1/subdir*' will not work. When a client needs to have different file systems saved on dif- ferent schedules, a Client resource is needed for each set of file systems on a particular schedule. For all the Client resources with the same name in a group, a given path name may only appear once. When a Client resource lists the save set `All', it must be the only Client resource with its name belong- ing to its group. Example: save set: /, /usr, /usr/src; Backup renamed directories (read/write, choice) This attribute enables the support of renamed directories during scheduled backups. When enabled, the save program performs a lookup in the client file index to determine whether a directory has been renamed. If a directory has been renamed, all of the files and subdirectories under the directory will be backed up. The default value is 'Disabled'. Example: Backup renamed directories: Enabled; Checkpoint enabled (read/write, choice) This attribute enables the checkpoint restart functionality dur- ing scheduled backups. When enabled, the savegrp program will attempt to continue interrupted save sets from the last check- point, rather than restart them from the begining. Savegrp will retry save sets up to `client retries' times. See the nsr_group(5) man page for more information regarding `client retries'. Example: Checkpoint enabled: Enabled; Checkpoint granularity (read/write, choice) This attribute controls the frequency of checkpoints generated during a checkpoint restart enabled save. The two options are: Directory - guarantees that a checkpoint will be created after each directory is backed up. Checkpoints may be created at intermediate points depending on the number of files in the directory; however, this is not guaranteed. This is the default. File - a checkpoint is generated after each file saved. This option introduces extra overhead and will slow down the save process. Example: Checkpoint granularity: Directory; priority (hidden, read/write, choice) This attribute controls the backup priority of this client. Priority 1 is the highest, 1000 is the lowest. Automated save- grp's will attempt to back up clients with higher priorities before clients with lower priorities. Note that this is only one factor used to determing the next client. The savegrp com- mand has many parameters to consider, and may choose a lower priority client while trying to balance the load. Example: priority: 500; remote access (read/write, string list) This attribute controls who may back up, browse, and recover a client's files. By default this attribute is an empty list, signifying that only users on the client are allowed to back up, browse, and recover its files. Additional users, hosts, and netgroups may be granted permission to access this client's files by adding their names to this attribute. Netgroup names must be preceded by an ampersand ('&'). Each line specifies a user or a group of users, using one of these formats: user/host@domain , group/host@domain , user@host , user@domain , group@host , group@domain , &netgroup (only available on plat- forms that support netgroups) , user_attribute=value[, ...]. where user is a user name; host is a host name; group is a user group name; domain is a domain name; user_attribute can be user, group, host, nwinstname, nwinstancename, domain, or domaintype (type of the domain, NIS or WINDOMAIN). The user attributes: nwinstname and nwinstancename are used to indicate a NetWorker instance name. The value that should be entered for either of these attributes is the value in the "name" field in the NSRLA resource for the machine where a matched user is connecting from. value can be any string delimited by white space. If the value has space in it, then it can be quoted with double quotes. The value may contain wild cards, "*". Entering just a user name allows that user to administer NetWorker from any host (equiva- lent to user@* or */user or user=user). Netgroup names are always preceded by an "&". The format: user_attribute=value[, ...] is more secure because the format is not overloaded. For example, if firstname.lastname@example.org is entered, then any users in the test group or users named test and that are in the domain; test.acme.com or from the host; test.acme.com will match this entry. Example: The entries: remote access: mars, *@jupiter, sam@pluto, */root; remote access: host=mars, host=jupiter, "user=sam,host=pluto", user=root; are equivalent. remote user (read/write, string) This attribute has several uses. For those clients that are accessed via the rsh(1) protocol (new clients use nsrexecd(8) instead), this attribute specifies the user login name the Net- Worker server will use to authenticate itself with the client. The default value is NULL, implying that 'root' should be used. When savegrp-p (see savegrp(8)) is run on the NetWorker server, the server runs commands on the client to determine which files to save. Note that when the nsrexecd(8) protocol is used to access the client, the remote user attribute is not used for authentication. Certain clients, such as NetWare fileservers, use this attribute along with the password attribute, below, to gain access to the files being backed up. Other clients that back up application data, such as Sybase databases, use this attribute along with the password to gain access to the application data. There may be a different value of this attribute for each resource that describes the same client. NDMP clients use this attribute along with the password attribute to configure access to a NDMP server. The same user- name (remote user attribute) and password should be configured in the Device resource as they are configured for the NDMP server. Example: remote user: operator; password (read/write, encrypted) The savegrp command uses this attribute when initiating the savefs and save commands on the client's machine. The savefs and save commands use the password to gain access to the files being backed up. If a password is given, then the "remote user" attribute for the Client resource must also be defined. There may be a different value of this attribute for each resource that describes the same client. savefs and save commands on the client's machine. The savefs and save commands use the password to gain access to the files being backed up. If a password is given, then the "remote user" attribute for the client resource must also be defined. There may be a different value of this attribute for each resource that describes the same client. This attribute does not need to be set for existing Unix clients that are not backing up any application specific data. This attribute is also used in conjunction with the remote user attribute to configure access to a NDMP server. backup command (read/write, string) The remote command to run to back up data for this client and save sets. This command can be used to perform pre and post backup processing and defaults to the save command. The value must not include a path and must start with the prefix "save" or "nsr". Example: backup command: savemsg; Save operations (read/write,string)" This attribute specifies the save operation instructions in the form of: KEYWORD:TOKEN=STATE[;KEYWORD:TOKEN=STATE;...] This attribute is required if save set attribute of this client contains non-ASCII names. Specify: I18N:mode=nativepath (for NetWorker 7.4 or later clients on UNIX platforms with non-ASCII save set names) I18N:mode=utf8path (for pre-7.4 clients and NetWorker clients on Windows platforms with non-ASCII save set names) This attribute can also be used to configure the VSS saves on Windows 2003. savegrp program uses this and "Backup renamed directories" attribute to pass the save instructions via the -o save_operations option to save program. See save (8) for more information. Example: Save operations: I18N:mode=nativepath; Pool (read/write, choice list) This attribute sets the media pool for data target selection during scheduled backup of the save sets specified in this client. This attribute is supported on 7.6.1 or later clients. Backup may fail on older (pre-7.6.1) clients for non-NULL value. This pool specification overrides any other pool criteria asso- ciated with the group or save set for this client. The default value is NULL. Example: Pool: Default; Client direct (enabled/disabled, choice) A client direct backup bypasses the storage node and writes directly to the target disk device during a scheduled backup of the client. The target disk device can be a Data Domain or an Advanced File Type (AFTD) device. When enabled, client direct is attempted on the target disk. If a client direct backup is not possible, a storage node backup is attempted. This attribute is supported on 8.0 or later clients. For pre-7.6.1 clients, leave this attribute enabled (default setting). Although client direct is not supported on pre-8.0 clients, disabling this attribute on such clients may cause the backup to fail. The default value is 'Enabled'. Example: Client direct: Enabled; executable path (read/write, string, hidden) This attribute specifies the path to use when the NetWorker server is executing commands on the client. When no path is specified, the "remote user's" $PATH is used. Example: executable path: /etc/nsr; server network interface (read/write, string, hidden) The name of the network interface on the server to be used for saves and recovers. Example: server network interface: mars-2; aliases (read/write, string list, hidden) This attribute is a list of aliases (nicknames) for the client machine that queries can match. If this list is empty, match on client name alone. Example: aliases: mars; owner notification (read/write, hidden) A notification action to be executed to send the contents of status messages to the owner/primary user of a machine (for example, savegrp completion messages). Example: owner notification: /usr/ucb/mail -s "mars' owner noti- fication" carl@mars; statistics (constant, hidden, dynamic) This attribute contains three values: the size of the client's on-line file index in kilobytes, the number of kilobytes actu- ally used, and the number of entries in the index. Example: statistics: elapsed = 1761860, index size (KB) = 776, amount used (KB) = 680, entries = 2216; index save set (update-only, hidden, dynamic) This attribute specifies the client file index save set to purge when the index operation is set to purging oldest cycle. Example: index save set: /; index path (read/write, hidden) This attribute is used to allow the NetWorker administrator to balance NetWorker online file index disk utilization across mul- tiple disk partitions. If set, this attribute contains the full path to the directory containing the client's online file index. Note that the last component of the path must match the name attribute of the Client resource (see above). If left blank, the index path defaults to the path /nsr/index/name, where name is the name attribute from the Client resource. Example: index path: /disk2/index/venus; index message (update-only, hidden, dynamic) This attribute contains the ending status message for the previ- ous index operation. This attribute is typically blank, indicating that the previous operation completed successfully. Example: index message:; index operation start (update-only, hidden, dynamic) This attribute contains the starting time of the current index operation. This attribute is a null string ("") when the opera- tion is 'Idle'. The format is weekday followed by hour and min- utes. Example: index operation start: Wednesday 02:45; index progress (update-only, hidden, dynamic) This attribute contains the progress the index has made towards finishing the current task. This attribute is blank when the operation is 'Idle'. The progress is expressed as a percentage. Example: index progress: 45; index operation (update-only, hidden, dynamic) This attribute contains the current index operation. It is nor- mally 'Idle'. Example: index operation: Reclaiming space; parallelism (read/write, hidden) This attribute specifies the maximum number of saves that should be run at the same time for the client. Example: parallelism: 2; archive users (read/write, string list) This attribute specifies a list of users that are allowed to use the archive services on the client. This attribute can only be set if archive support has been enabled on the server. To schedule an archive request for a client, root (or equivalent) must be on that client's Archive users list, or else root@client must be in the server's Administrator list. If no users are listed and the client resides in same machine as the server, only administrators and the local root user (that is, root@server) are allowed to use the archive services on the client. A value of '*' implies any user is allowed to archive or retrieve data. The '/' and '@' characters are not allowed as part of the user name. Example: archive users: paul; application information (read/write, hidden, string list) This attribute contains client application information. The use of this attribute is client specific and should be utilized as indicated by the documentation received with the product. NDMP clients fill in various parameters and values in this attribute separated by an equals sign ('='). Example: application information: HIST=yes; ndmp (read/write, choice) This attribute indicates whether or not the client resource is configured for NDMP backups. If the client is used for NDMP backups, the remote user and password attributes must be filled in. The application information attribute may also be used. Example: ndmp: yes; storage nodes (read/write, string list) This attribute is an ordered list of storage nodes for the client to use when saving its data. Its saves are directed to the first storage node that has an enabled device and a func- tional media daemon, nsrmmd(8). The default value of 'nsrserverhost' represents the server. In addition to storage node names the keyword 'curphyhost' could also be entered into the list. The entry 'curphyhost' denotes the current physical host. It is only used for virtual clients on a cluster. It should not be used on physical clients or on the client which is tied with the virtual server. Using the curphyhost keyword would enable the virtual clients backup to be directed to the storage node on which the virtual client is currently residing on. See nsr_storage_node(5) for additional detail on storage nodes. clone storage nodes (read/write, string list) The clone storage nodes attribute has been moved to the target node resource. See nsr_storage_node(5) recover storage nodes (read/write, string list) This attribute is an ordered list of storage nodes for the client to use when recovering its data. Exclusions: If the volume being recovered from is already mounted, then the recover storage node list is ignored and the volume is used from its existing location. If the volume is in a jukebox and the "read hostname" attribute is set, then the volume will be mounted on the designated host. During regular recover and clone operations, if the environment variable FORCE_REC_AFFINITY is set to "Yes" or "yes", it will force the broker to use the Recover Storage Affinity, even if the requested volume is mounted, to determine the "read" host. In a virtual tape environment(VTL libraries have "virtual juke- box" attribute set to "yes"), during Cloning, whether or not the FORCE_REC_AFFINITY is set, the behavior is always going to be as if that environment variable is set to true(yes). While cloning, if volume is not mounted and the volume is not in a jukebox with the "read hostname" set, the Server's Client resource is checked for the value of the "Recover Storage Node" for the "read" host. Then, the Client resource of the "read" host is checked for the value of the "Clone Storage Node" attribute, to determine where the "write" should go to. licensed applications (read-only, string list) This attribute contains names of the licensed applications used by the client. By default, this field is blank.
Note: The hidden attributes are not shown in these examples. A resource to define a client, called venus, backing up all of its files to the NetWorker server mars: type: NSR client; name: venus; server: mars; archive services: Disabled; schedule: Full Every Friday; browse policy: Month; retention policy: Quarter; directive: Unix with compression directives; group: Default; save set: All; Backup renamed directories: Disabled; remote access: ; remote user: ; password: ; backup command: ; Pool: ; Client direct: Enabled; aliases: venus, venus.emc.com; archive users: ; storage nodes: nsrserverhost; clone storage nodes: ; The resources for a client backing up different file systems on differ- ent schedules with the support of renamed directories enabled: type: NSR client; name: saturn; server: mars; archive services: Disabled; schedule: Default; browse policy: Month; retention policy: Quarter; directive: ; group: engineering; save set: /, /usr, /usr/src; Backup renamed directories: Enabled; remote access: venus, sam@*, jupiter/john; remote user: operator; password: ; backup command: ; Pool: ; Client direct: Enabled; aliases: saturn.emc.com; archive users: ; storage nodes: nsrserverhost; clone storage nodes: ; type: NSR client; name: saturn; server: mars; archive services: Disabled; schedule: Full on 1st Friday of Month; browse policy: Month; retention policy: Quarter; directive: Unix standard directives; group: Default; save set: /usr/src/archive; remote access: sam@venus, &netadmins, root@*; remote user: operator; password: ; backup command: ; Pool: ; Client direct: Enabled; aliases: saturn.emc.com; archive users: ; storage nodes: nsrserverhost; clone storage nodes: ;
rsh(1), ruserok(3), nsr(5), nsr_schedule(5), nsr_directive(5), nsr_group(5), nsr_policy(5), nsr_storage_node(5), save(8), savegrp(8), savefs(8), nsradmin(8), nsrexecd(8).
NetWorker 8.0.1 Dec 02, 12 nsr_client(5)