.\"
.\" $Id: nsr_client.5,v 1.6.2.3 2006/04/26 18:52:18 castrv Exp $ Copyright (c) 2005 EMC Corporation.
.\"
.\"
.\" Copyright (c) 2005 EMC Corporation.
.\"
.\" All rights reserved.  This is an UNPUBLISHED work, and
.\" comprises proprietary and confidential information of EMC.
.\" Unauthorized use, disclosure, and distribution are strictly
.\" prohibited.  Use, duplication, or disclosure of the software
.\" and documentation by the U.S. Government is subject to
.\" restrictions set forth in a license agreement between the
.\" Government and EMC or other written agreement specifying
.\" the Government's rights to use the software and any applicable
.\" FAR provisions, such as FAR 52.227-19.
.\"
.TH "NSR_CLIENT" 5 "Aug 23, 06" "StorEdge EBS 7.3.2"
.SH NAME
nsr_client \- Sun StorEdge EBS resource type ``NSR client''
.SH SYNOPSIS
.B  "type: NSR client"
.SH DESCRIPTION
Each NSR client is described by a single resource of type
.BR "NSR client"
(see
.BR nsr_resource (5)).
To edit the NSR client resources for a Sun StorEdge EBS server type:
.br
.sp
.RS
\fR\s10nsradmin -c "type:NSR client"\fP\s0
.RE
.br
.sp
See the
.BR nsradmin (8)
manual page for more information on
using the Sun StorEdge EBS administration program.
The Client resource may also be edited using
.B Sun StorEdge EBS Management Console.
.LP
For each Sun StorEdge EBS 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
online 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.
.SH ATTRIBUTES
.LP
The following attributes are defined for resource type
.BR "NSR client" .
The information in parentheses describes how the attribute values are accessed.
.B Read-only
indicates that the value cannot be changed by an administrator.
.B Read/write
means the value can be set as well as read.
.B 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
.BR nsradmin (8).
.B Dynamic
attributes have values which change rapidly.
.B 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
.BR nsr_resource (5).
.LP
Certain client attributes (such as "Client OS type", "CPUs", "Sun StorEdge EBS version"
and "Enabler in use") do not get populated in the Client Setup/Information
window of the Sun StorEdge EBS interface, when the Sun StorEdge EBS Server is running under
Eval mode or an Enterprise license. However, when the Sun StorEdge EBS server has
a Workgroup/NetWork/Power Edition enabler, these client attributes
are refreshed appropriately in the window after the client backup.
.TP
.BR "name" "				(read-only, single string)"
This attribute specifies the hostname of this Sun StorEdge EBS client.
.br
.I Example:
\fR\s10name: venus;\fP\s0
.TP
.BR "server" "			(constant, single string)"
This attribute specifies the hostname of this client's Sun StorEdge EBS server.
The server`s hostname will be used as the default value.
.br
.I Example:
\fR\s10server: jupiter;\fP\s0
.TP
.BR "comment" "			(read/write)"
This attribute is provided for the administrator to keep any explanatory
remarks or supplementary information about this Sun StorEdge EBS client.
.br
.I Example:
\fR\s10comment: machine located in room 243;\fP\s0
.TP
.BR "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.
.br
.I Example:
\fR\s10scheduled backup: Disabled;\fP\s0
.fi
.TP
.BR "archive services" "	(read/write, choice)"
This attribute determines if this system can use archive services.
This attribute can only be set if archive support has been enabled on
the server.
The choices are enabled or disabled.
.I Example:
\fR\s10archive services: enabled;\fP\s0
.fi
.TP
.BR "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
.BR nsr_schedule (5).
.br
.I Example:
\fR\s10schedule: Default;\fP\s0
.TP
.BR "browse policy" "		(read/write, choice)"
This attribute specifies the name of the policy controlling how
long entries will remain in this client's online 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
.BR nsr_policy (5).
.br
.I Example:
\fR\s10browse policy: Month;\fP\s0
.TP
.BR "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 currently 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
.BR 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.
.br
.I Example:
\fR\s10retention policy: Year;\fP\s0
.TP
.BR "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
.BR nsr_directive (5).
.br
.I Example:
\fR\s10directive: UNIX with compression directives;\fP\s0
.TP
.BR "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
.BR nsr_group (5).
The default value is `Default'.
.br
.I Example:
\fR\s10group: Default;\fP\s0
.TP
.BR "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 Sun StorEdge EBS supported clients, `All' refers to the mounted file systems. 
Also, Sun StorEdge EBS supports 
.I `wildcard'
at the 
.I filesystem level. 
For example, For a UNIX Sun StorEdge EBS 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 particular
client. Please note that 
.I `wildcard ' matching
at the 
.I subdirectory level, is not supported.  
So, `/space1/subdir*' will not work.
.sp
When a client needs to have different file systems saved on different
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 belonging to its group.
.br
.I Example:
\fR\s10save set: /, /usr, /usr/src;\fP\s0
.TP
.BR "priority" "			(hidden, read/write, choice)"
This attribute controls
the backup priority of this client.  Priority 1 is the highest, 1000 is the
lowest.  Automated savegrp's will attempt to back up clients with higher
priorities before clients with lower priorities.  Note that this is only one 
factor used to determine the next client. The
.B savegrp
command has many parameters to consider, and may choose a lower
priority client while trying to balance the load.
.br
.I Example:
\fR\s10priority: 500;\fP\s0
.TP
.BR "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:
.IR user/host@domain
,
.IR group/host@domain
,
.IR user@host
,
.IR user@domain
,
.IR group@host
,
.IR group@domain
,
.IR &netgroup
(only available on platforms that support netgroups)
,
\fIuser_attribute\fB=\fIvalue\fI[\fB,\fI ...]\fR.

where \fIuser\fR is a user name; \fIhost\fR is a host name;
\fIgroup\fR is a user group name; \fIdomain\fR is a domain
name; \fIuser_attribute\fR can be \fBuser\fR, \fBgroup\fR,
\fBhost\fR, \fBnwinstname\fR, \fBnwinstancename\fR, \fBdomain\fR,
or \fBdomaintype\fR (type of the domain, \fBNIS\fR or \fBWINDOMAIN\fR).

The user attributes: \fBnwinstname\fR and \fBnwinstancename\fR are
used to indicate a Sun StorEdge EBS 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.

\fIvalue\fR 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 Sun StorEdge EBS
from any host (equivalent to \fIuser\fB@*\fR or \fB*/\fIuser\fR or
\fBuser=\fIuser\fR).  Netgroup names are always preceded by an "&".

The format: \fIuser_attribute\fB=\fIvalue\fI[\fB,\fI ...]\fR is more
secure because the format is not overloaded. For example,
if \fItest@test.acme.com\fB is entered, then any users in the
\fItest\fB group or users named \fItest\fB and that are in the domain;
\fItest.acme.com\fB or from the host; \fItest.acme.com\fB will match
this entry.
.br
.I Example:
The entries:

\fR\s10remote access: mars, *@jupiter, sam@pluto, */root;\fP\s0

\fR\s10remote access: host=mars, host=jupiter, "user=sam,host=pluto",
user=root;\fP\s0

are equivalent.
.TP
.BR "remote user" "		(read/write, string)"
This attribute has several uses.
For those clients that are accessed via the
.BR rsh (1)
protocol (new clients use
.BR nsrexecd (8)
instead),
this attribute specifies the user login name the Sun StorEdge EBS
server will use to authenticate itself with the client.
The default value is NULL, implying that `root' should be used.
When
.BR savegrp -p
(see
.BR savegrp (8))
is run on the Sun StorEdge EBS server, the server runs commands on the client
to determine which files to save.
Note that when the
.BR nsrexecd (8)
protocol is used to access the client, the remote user attribute
is not used for authentication.
.br
Certain clients, such as NetWare fileservers, use this attribute along
with the
.B 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.
.IP ""
NDMP clients use this attribute along with the
.B password
attribute to configure access to a NDMP server.
The same username 
.RB ( "remote user " "attribute)"
and 
.B password
should be configured in the Device
resource as they are configured for the NDMP server.
.br
.I Example:
\fR\s10remote user: operator;\fP\s0
.TP
.BR "password" "			(read/write, encrypted)"
The
.B savegrp
command uses this attribute when initiating the 
.B savefs
and
.B save
commands on the client's machine.
The 
.B savefs
and
.B 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.
.IP ""
This attribute does not need to be set for existing UNIX clients that
are not backing up any application specific data.
.br
This attribute is also used in conjunction with the
.B "remote user"
attribute to configure access to a NDMP server.
.TP
.BR "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
.B save
command.
The value must not include a path and
must start with the prefix "save" or "nsr".
.br
.I Example:
\fR\s10backup command: savemsg;\fP\s0
.TP
.BR "executable path" "	(read/write, string, hidden)"
This attribute specifies the path to use when the Sun StorEdge EBS server is
executing commands on the client. When no path is specified, the
"remote user's" $PATH is used.
.br
.I Example:
\fR\s10executable path: /etc/nsr;\fP\s0
.TP
.BR "server network interface" "  (read/write, string, hidden)"
The name of the network interface on the server to be used for saves and
recovers.
.br
.I Example:
\fR\s10server network interface: mars-2;\fP\s0
.TP
.BR "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.
.br
.I Example:
\fR\s10aliases: mars;\fP\s0
.TP
.BR "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).
.br
.I Example:
\fR\s10owner notification: /usr/ucb/mail -s "mars' owner notification" carl@mars;
.TP
.BR "statistics" "		(constant, hidden, dynamic)"
This attribute contains three values: the size of the client's online file
index in kilobytes, the number of kilobytes actually used, and the number of
entries in the index.
.br
.I Example:
.br
\fR\s10statistics: elapsed = 1761860, index size (KB) = 776,
            amount used (KB) = 680, entries = 2216;\fP\s0
.TP
.BR "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.
.br
.I Example:
\fR\s10index save set: /;\fP\s0
.TP
.BR "index path" "		(read/write, hidden)"
This attribute is used to allow the Sun StorEdge EBS administrator to balance
Sun StorEdge EBS online file index disk utilization across multiple 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 \fIname\fP attribute of the
Client resource (see above).  If left blank, the index path defaults
to the path \fR/nsr/index/\fP\fIname\fP, where \fIname\fP is the
\fRname\fP attribute from the Client resource.
.br
.I Example:
\fR\s10index path: /disk2/index/venus;\fP\s0
.TP
.BR "index message" "		(update-only, hidden, dynamic)"
This attribute contains the ending status message
for the previous index operation.
This attribute is typically blank, indicating that the previous operation
completed successfully.
.br
.I Example:
\fR\s10index message:;\fP\s0
.fi
.TP
.BR "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 operation is `Idle'.
The format is weekday followed by hour and minutes.
.br
.I Example:
\fR\s10index operation start: Wednesday 02:45;\fP\s0
.fi
.TP
.BR "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.
.br
.I Example:
\fR\s10index progress: 45;\fP\s0
.fi
.TP
.BR "index operation" "	(update-only, hidden, dynamic)"
This attribute contains the current index operation.
It is normally `Idle'.
.br
.I Example:
\fR\s10index operation: Reclaiming space;\fP\s0
.fi
.TP
.BR "parallelism" "		(read/write, hidden)"
This attribute specifies the maximum number of saves that should be run at
the same time for the client.
.br
.I Example:
\fR\s10parallelism: 2;\fP\s0
.fi
.TP
.BR "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.
.br
.I Example:
\fR\s10archive users: paul;\fP\s0
.PP
.BR "application information" " (read/write, hidden,"
.RS
string list)
.br
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 ('=').
.br
.I Example:
\fR\s10application information: HIST=yes;\fP\s0
.RE
.TP
.BR "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
.BR "remote user" " and " "password"
attributes must be filled in.
The
.B "application information"
attribute may also be used.
.br
.I Example:
\fR\s10ndmp: yes;\fP\s0
.TP
.BR "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 functional media daemon,
.BR 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
.BR nsr_storage_node (5)
for additional detail on storage nodes.
.TP
.BR "clone storage nodes" "   (read/write, string list)
This attribute specifies the hostnames of the storage nodes that are to be selected for
the `save' side of clone operations.
Cloned data originating from this client is directed to the first node listed in
the `clone storage node' list that has both an enabled device and a functional media daemon,
.BR nsrmmd (8).
There is no default value.  If this attribute has no value, the server's
.B 'clone storage nodes'
will be consulted.  If this attribute also has no value, then the server's
.B 'storage nodes'
attribute will be used to select a target node for the clone.  See
.BR nsr_storage_node (5)
for additional detail on storage nodes.
.TP
.BR "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. It is also used for the recover side of a clone operation.
.BR

Exclusions: 
.BR

If the volume being cloned or recovered from is already mounted, then the
recover storage node list is ignored and the volume is used from its existing location.
.BR

If the volume is in a jukebox and the "read hostname" attribute is set, then the 
recover storage node list is ignored and the volume will be mounted on the designated host, unless the FORCE_REC_AFFINITY environment variable is set to "yes".
.BR
.TP
.BR "licensed applications" "   (read-only, string list)
This attribute contains names of the licensed applications used by the client.
By default, this field is blank.
.SH EXAMPLES
.LP
.BR Note:
The hidden attributes are not shown in these examples.
.LP
A resource to define a client, called venus,
backing up all of its files to the Sun StorEdge EBS server mars:
.LP
.br
.nf
\fR\s10
                        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;
               remote access: ;
                 remote user: ;
                    password: ;
              backup command: ;
                     aliases: venus, venus.emc.com;
               archive users: ;
               storage nodes: nsrserverhost;
         clone storage nodes: ;
.fi
.LP
The resources for a client backing up different file systems on
different schedules:
.LP
.br
.nf
\fR\s10
                        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;
               remote access: venus, sam@*, jupiter/john;
                 remote user: operator;
                    password: ;
              backup command: ;
                     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: ;
                     aliases: saturn.emc.com;
               archive users: ;
               storage nodes: nsrserverhost;
         clone storage nodes: ;

.fi
.LP
.SH SEE ALSO
.na
.hy 0
.BR rsh (1),
.BR ruserok (3),
.BR nsr (5),
.BR nsr_schedule (5),
.BR nsr_directive (5),
.BR nsr_group (5),
.BR nsr_policy (5),
.BR nsr_storage_node (5),
.BR save (8),
.BR savegrp (8),
.BR savefs (8),
.BR nsradmin (8),
.BR nsrexecd (8)
.hy 14
.ad