NSR_SERVICE(5)

NAME
nsr_service - NetWorker server resource type ``NSR''

SYNOPSIS
type: NSR

DESCRIPTION
Each NetWorker server is described by a resource of type NSR. See nsr_resource(5) for general information on NetWorker resources. To edit the NSR resource use the command:
    nsradmin -c "type:NSR"
or use the nwadmin(8) GUI. See nsradmin(8) for information on using the NetWorker administration program.

ATTRIBUTES

The following attributes are defined for the NSR resource. 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 and read. Choice list means that any number of values can be chosen from the given list. Static attributes change values rarely. Dynamic attributes have values which can change rapidly. Hidden means it is an attribute of interest only to programs or experts, and these attributes can only be seen when the hidden option is turned on in nsradmin(8) or details option is set in nwadmin(8). For example, an attribute marked (read-only, static) has a value which is set when the resource is created and never changes, or is changed only by the server.

name			(read-only, static)
    This attribute specifies the hostname of this NetWorker server.
    Example name: mars;

version			(read-only, dynamic)
    This is the software version of the NetWorker server daemon, nsrd(8). This includes a slash and the number of clients currently licensed.
    Example: version: NetWorker 4.1 Turbo/110;

save totals			(read-only, dynamic, hidden)
    Save statistics. A string containing the total number of save sessions, the number of saves with errors (if any) and the total number of bytes saved (if any). This attribute is updated after each save session completes.
    Example: save totals: "37 sessions, 457 MB total";

recover totals			(read-only, dynamic, hidden)
    Recovery statistics. A string containing the total number of recover sessions, the number of recovers with errors (if any) and the total number of bytes recovered (if any). This attribute is updated after each recover session completes.
    Example: recover totals: "347 sessions, 48 MB total";

totals since			(read-only, dynamic)
    The time statistics collection started. This is usually the last time the NetWorker server was rebooted.
    Example: totals since: "Fri Jun 1 09:35:02 1992";

NSR operation		(read-only, choice list, hidden)
    This attribute is currently unused and is provided for backward compatibility.

parallelism			(read/write, static)
    This attribute sets the number of concurrent save sessions that this server will allow. The value can be set by an administrator. Use higher values for better performance on a fast system with lots of main memory and swap space. Use lower values to avoid overloading a slow system, or systems with little main memory and/or swap space. Warning: due to defects in some versions of UNIX, high values of parallelism may cause the system to lock up.
    Example: parallelism: 4;

session statistics		(read-only, dynamic, hidden)
    This attribute reports the statistics of each active session. There are 14 values for each set of statistics, namely, id (session's unique identifier), name (session's name), mode (read, write, browse), pool (current pool), volume (current volume), rate kb (current data transfer rate for save session), amount kb (current amount read/written by session), total kb (total amount to be read by session), amount files (current number of files recovered; to be implemented in a future release), total files (current number of files to recover; to be implemented in a future release), connect time (time session has been connected), num volumes (number of volumes to be used by recover session), used volumes (number of volumes processed by recover session), and completion (running, complete, or continued)
    Example: sessions statistics: ;

manual saves                    (read/write, hidden)
    This attribute allows the administrator to disable manual backups to the server. Scheduled backups continue to work normally.

volume priority                  (read/write)
    If a NetWorker server has volumes in locally managed jukeboxes and volumes being managed by SmartMedia, this attribute allows the administrator to assign a priority for volume selection when saving data. Determines whether the server has a preference for volumes being managed by SmartMedia, SmartMedia Priority, or whether the server has a preference for volumes in a locally managed jukebox, NearLine Priority. The default value is NearLine Priority.
    Example: volume priority: NearLine Priority;

SmartMedia save mount                  (read/write)
    This attribute controls the form of the request made to SmartMedia to mount a volume for saving data. Setting this attributes value to volume by characteristics causes NetWorker to request a volume meeting specified criteria, and lets SmartMedia select an appropriate volume from all media which satisfy the criteria specified. When this attribute's value is set to, volume by name , NetWorker will request the volume by name and SmartMedia mounts the volume requested. The default value is volume by characteristics .
    Example: SmartMedia save mount: volume by characteristics;

license server                  (read/write, hidden)
    The name of the server on which a Legato license manager is installed and running. This attribute used to be called "GEMS server". You can set the value to a GEMStation where a GEMS license manager is running or to a machine where a Legato license manager is running. Example: license server: jupiter;

message			(read-only, dynamic, hidden)
    The last message of any kind logged. A time stamp is included at the start of the string.
    Example: message: "Mon 12:25:51 Tape full, mount volume mars.001 on /dev/nrst1";

message list			(read-only, dynamic, hidden)
    A list of recent messages, with a time stamp and a string message for each value.
    Example: message: "Mon 12:25:51 Tape full, mount volume mars.001 on /dev/nrst1";

server message			(read-only, dynamic, hidden)
    Lists recent concise general messages about the status of the server.
    Example: message: "Tape full, mount volume mars.001 on /dev/nrst1";

sequence number			(read-only, dynamic, hidden)
    The sequence number of the corrosponding server message.

server message time		(read-only, dynamic, hidden)
    The time at which the server message was generated.

server message priority		(read-only, dynamic, hidden)
    The priority of the server message. Currently these are for Networker internal use.

server message source		(read-only, dynamic, hidden)
    This attribute gives the networker component that generated the message on the server. This can be a client, a device etc.

server message category		(read-only, dynamic, hidden)
    This attribute is the category the server message belongs to. Currently these are for Networker internal use.

session				(read-only, dynamic, hidden)
    The value of this attribute is a list of session information strings. Each string includes the NetWorker client name, type of operation (saving, browsing, or recovering) and information about the save set, including name, number of bytes, and number of files. All sizes and rates are in bytes per second, Kilobytes (1024), Megabytes (a thousand Kilobytes), etc.
    Example:
    session: "venus:/usr saving to mars.001 20MB",
               "mars:/usr/src done saving 24MB";"

session message			(read-only, dynamic, hidden)
    Concise session message string of the session attribute described above.
    Example:
    session: "venus:/usr saving to mars.001",
               "mars:/usr/src done saving";"

session client name			(read-only, dynamic, hidden)
    The name of each client for which each session is active.

session rate 			(read-only, dynamic, hidden)
    The rate of data transfer for the active session.

session rate label			(read-only, dynamic, hidden)
    Unit of data transfer for the active sessons.

session device name			(read-only, dynamic, hidden)
    The name of the device on which the session is active.

pending			(read-only, dynamic, hidden)
    A list of events pending with the NetWorker event notification system (see nsr_notification(5)). The first three fields are the time, priority, and event name.
    Example: pending: "Fri 14:40:15 alert: media mount of mars.001 suggested on /dev/nrst1";

status			(read-only, dynamic, hidden)
    A list of status flags for the NetWorker server. These flags are only for use by NetWorker server-side programs (for example, savegrp) and list various features enabled in the running server. The format is currently name=boolean (true or false). The listed features and their states can change at any time.

statistics			(read-only, dynamic, hidden)
    A list of strings of the form name=number that give a number of server statistics.

types created			(read-only, static)
    A list of all the other resource types this NetWorker server can create and about which clients can query.
    Example: types created: NSR device, NSR group;

administrator			(read/write, static)
    This is a list of names (or netgroups) of users who are allowed to administer NetWorker. Normally this list is inherited by all other resources on this server. Administrators can change the values of attributes for the resource which lists them. The administrator list also determines who can add and delete resources of the other NSR types. The user "root" on the local host of the server is always an administrator. Entries specifying other administrators are of the form, user, user@host, host/user, or &netgroup. The user name and/or host name may be a wild card, "*" (any user and/or host). Entering just a user name allows that user to administer NetWorker from any host (equivalent to user@* or */user). Netgroup names are always preceded by an "&". The following example grants NetWorker administrative privileges to, "root" from any host, the user "operator" from the hosts "jupiter" and "mars", the user "admin" from any host, and all <user name, user's hostname, server's domain> in the netgroup "netadmins".
    Example: administrator: root, operator@jupiter, mars/operator, admin@*, &netadmins;

contact name			(read/write, static)
    This attribute is used for product licensing/registration purposes. It must be specified before printing the registration information from the registration window.
    Example: contact name: contact_name;

company			(read/write, static)
    This attribute is used for product licensing/registration purposes. Your company name must be specified before printing the registration information from the registration window.
    Example: company: Legato;

street address			(read/write, static)
    This attribute is used for product licensing/registration mailing purposes. Specify your mailing street address.
    Example: street address: 3145, Porter Drive;

city/town			(read/write, static)
    This attribute is used for product licensing/registration mailing purposes.
    Example: city/town: Palo Alto;

state/province			(read/write, static)
    This attribute is used for product licensing/registration mailing purposes.
    Example: state/province: CA;

zip/postal code			(read/write, static)
    This attribute is used for product licensing/registration mailing purposes.
    Example: zip/postal code: 94304;

country			(read/write, static)
    This attribute is used for product licensing/registration mailing purposes.
    Example: country: USA;

phone			(read/write, static)
    This attribute is used for product licensing/registration purposes. This attribute must to be specified before printing the registration information from the registration window.
    Example: phone: 650-812-6100;

fax			(read/write, static)
    This attribute is used for product licensing/registration purposes.
    Example: fax: 650-812-6031;

email address			(read/write, static)
    This attribute is used for product licensing/registration purposes.
    Example: email address: support@legato.com;

server OS type			(read/write, static)
    This attribute is used for product licensing/registration purposes.
    Example: server OS type: Solaris;

purchase date			(read/write, static)
    This attribute is used for product licensing/registration purposes. It specifies the purchase date of the product enabler code. This attribute must be specified before printing the registration information from the registration window.

product serial number			(read/write, static)
    This attribute is used for product licensing/registration purposes. It must be specified before printing the registration information from the registration window.

mm op message			(read/write, dynamic, hidden)
    This attribute lists the descriptive message for the most recently completed media database operation. The NetWorker program (such as nsrmm(8)) that requested the operation clears this attribute as soon as it has read the result. An administrator should never change this attribute manually.

mm operation value              (read/write, dynamic, hidden)
    This attribute is used by programs such as nsrmm(8) to pass the desired media database operation location or flags to the NetWorker server. The value is automatically cleared when the operation completes. An administrator should never change this attribute manually.

mm operation	(read/write, choice list, dynamic, hidden)
    This attribute is used by programs such as nsrmm(8) to pass the media database operation type currently desired to the NetWorker server. The possible choices are: purge volume, purge save set, delete volume, delete save set, mark volume, mark save set, unmark volume, unmark save set, specify volume location, specify volume flags, and specify save set flags. The server serializes such operations and performs the appropriate queries on nsrmmdbd(8). The value is automatically cleared when the operation completes. An administrator should never change this attribute manually.

mm operation id		(read/write, dynamic, hidden)
    This attribute is used by programs such as nsrmm(8) to pass the desired media database operation identifier to the NetWorker server. The value is automatically cleared when the operation completes. An administrator should never change this attribute manually.

nsrmon info		(read/write, dynamic, hidden)
    This attribute is used by programs such as nsrmon(8) to pass information about remote daemon requests to the NetWorker server. The value is automatically cleared when the request completes. An administrator should never change this attribute manually. See nsr_storage_node(5) for a description of storage nodes and remote daemons.

nsrmmd count		(read-only, dynamic, hidden)
    This attribute is used by programs such as nsrd(8) to track the number and location of the media daemons, nsrmmd(8).

nsrmmd polling interval		(read/write, hidden)
    This attribute specifies the number of minutes between polling events of a remote nsrmmd(8). nsrd(8) polls a remote nsrmmd(8) at this interval, to determine whether it is running. If it determines from this poll that the daemon is no longer running, it will restart the nsrmmd(8), with a delay set by the `nsrmmd restart interval'; see the nsrmmd restart interval description. See nsr_storage_node(5) for additional details on this attribute and storage nodes.

nsrmmd restart interval		(read/write, hidden)
    This attribute specifies the number of minutes between restart attempts of a remote nsrmmd(8). When nsrd(8) determines that a remote nsrmmd(8) has terminated, it periodically attempts to restart the remote daemon. A value of zero for this attribute means the daemon should be restarted immediately. See nsr_storage_node(5) for additional details on this attribute and storage nodes.

nsrmmd control timeout		(read/write, hidden)
    This attribute specifies the number of minutes nsrd(8) waits for storage node requests.

enabler code		(read/write, dynamic, hidden)
    This attribute specifies the enabler code for the base enabler of the server software.

SS cutoff size		(read/write, hidden)
    This attribute sets the default "save set cut off size" to be used when saving. A blank value uses the built in default value. A non blank value for this attribute consists of a number followed by KB, MB, or GB signifying Kilobytes, Megabytes, or Gigabytes. Note that this field only affects clients older than version 6.0. Continuation save sets have been eliminated for version 6.0 and above.

EXAMPLE

A complete example follows:

	type:	NSR;
	name:	mars;
	version:	NetWorker 4.1 Turbo/110;
	save totals:	"84 sessions, 3597 MB total";
	recover totals:	1 session;
	totals since:	"Fri Oct 14 12:41:31 1994";
	NSR operation:	Idle Write Read Verify label Label ;
	parallelism:	4;
	manual saves:	Enabled Disabled ;
	message:	\
"Mon 14:37:25 media alert event: recover waiting for 8mm tape mars.001";
	message list:	\
"Mon 07:10:12 media info: loading volume man.001 into /dev/nrst11"
"Mon 07:10:33 /dev/nrst11 mount operation in progress"
"Mon 07:11:15 /dev/nrst11 mounted 8mm 5GB tape man.001
	session:	"mars:george browsing",
"mars:/home/mars starting recovery of 9K bytes";
	session statistics:	;
	pending:	\
"Mon 14:40:15 media alert:  recover waiting for 8mm tape mars.001";
	status:	disabled=false, jukebox=true, dm=true,
			archive=true, cds=true, turbo=true,
			single=false;
	statistics:	elapsed = 257415, saves = 1176, recovers = 12,
			save KB = 12050007, recover KB = 28272839,
			bad saves = 0, bad recovers = 0,
			current saves = 1, current recovers = 0,
			max saves = 12, max recovers = 1, mounts = 0,
			recover delays = 0, saving daemons = 0,
			recovering daemons = 0, idle daemons = 0;
	types created:	NSR device, NSR group, NSR directive,
			NSR notification, NSR client, NSR policy,
			NSR schedule, NSR pool, NSR label, NSR jukebox,
			NSR license, NSR archive client,
			NSR archive list;
	administrator:	root;
	contact name:	Technical Support;
	company:	Legato;
	street address:	3145, Porter Drive;
	city/town:	Palo Alto;
	state/province:	CA;
	zip/postal code:	94304;
	country:	USA;
	phone:	650-812-6100;
	fax:	650-812-6220;
	email address:	support@legato.com;
	purchase date:	;
	product serial number:	;
	mm op message:	;
	mm operation value:	;
	mm operation:	;
	mm operation id:	;
	nsrmon info:	;
	nsrmmd count:	"mars:2";
	nsrmmd polling interval:	3;
	nsrmmd restart interval:	2;
	nsrmmd control timeout:		5;
	enabler code:	;
	SS cutoff size:	;

FILES
/nsr/res/nsr.res - this file should never be edited directly. Use nwadmin(8) or nsradmin(8) instead.

SEE ALSO
netgroup(5), nsr(5), nsr(8), nsr_device(5), nsr_group(5), nsr_notification(5), nsr_resource(5), nsr_storage_node(5), nsradmin(8), nsrd(8), nsrmm(8), nsrmmdbd(8), nsrmon(8), nwadmin(8), recover(8), save(8).