.\" .\" $Id: nsr_service.5,v 1.2.32.8 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_SERVICE" 5 "Aug 23, 06" "StorEdge EBS 7.3.2" .SH NAME nsr_service \- Sun StorEdge EBS server resource type ``NSR'' .SH SYNOPSIS .B "type: NSR" .SH DESCRIPTION Each Sun StorEdge EBS server is described by a resource of type .BR "NSR" . See .BR nsr_resource (5) for general information on Sun StorEdge EBS resources. To edit the .B NSR resource use the command: .RS \fR\s10nsradmin \-c "type:NSR"\fP\s0 .RE See .BR nsradmin (8) for information on using the Sun StorEdge EBS administration program. .SH ATTRIBUTES .PP The following attributes are defined for the .B NSR resource. 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 and read. .B Choice list means that any number of values can be chosen from the given list. .B Static attributes change values rarely. .B Dynamic attributes have values which can change rapidly. .B 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 .BR nsradmin (8). For example, an attribute marked .B "(read-only, static)" has a value which is set when the resource is created and never changes, or is changed only by the server. .TP .BR "name" " (read-only, static)" This attribute specifies the hostname of this Sun StorEdge EBS server. .br .I Example \fR\s10name: mars;\fP\s0 .TP .BR "version" " (read-only, dynamic)" This is the software version of the Sun StorEdge EBS server daemon, .BR nsrd (8). This includes a slash and the number of clients currently licensed. .br .I Example: \fR\s10version: Sun StorEdge EBS 4.1 Turbo/110;\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 server. .br .I Example: \fR\s10comment: machine located in room 243;\fP\s0 .TP .BR "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. .br .I Example: \fR\s10save totals: "37 sessions, 457 MB total";\fP\s0 .TP .BR "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. .br .I Example: \fR\s10recover totals: "347 sessions, 48 MB total";\fP\s0 .TP .BR "totals since" " (read-only, dynamic)" The time statistics collection started. This is usually the last time the Sun StorEdge EBS server was rebooted. .br .I Example: \fR\s10totals since: "Fri Jun 1 09:35:02 1992";\fP\s0 .TP .BR "NSR operation" " (read-only, choice list, hidden)" This attribute is currently unused and is provided for backward compatibility. .TP .BR "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 a lot 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. .BR Warning : due to defects in some versions of UNIX, high values of parallelism may cause the system to lock up. .br .I Example: \fR\s10parallelism: 4;\fP\s0 .TP .BR "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, .BR id (session's unique identifier), .BR name (session's name), .BR mode (read, write, browse), .BR pool (current pool), .BR volume (current volume), .BR "rate kb" (current data transfer rate for save session), .BR "amount kb" (current amount read/written by session), .BR "total kb" (total amount to be read by session), .BR "amount files" (current number of files recovered; to be implemented in a future release), .BR "total files" (current number of files to recover; to be implemented in a future release), .BR "connect time" (time session has been connected), .BR "num volumes" (number of volumes to be used by recover session), .BR "used volumes" (number of volumes processed by recover session), and .BR completion (running, complete, or continued) .br .I Example: \fR\s10sessions statistics: ;\fP\s0 .TP .BR "monitor rap" " (read/write, hidden)" This attribute allows the administrator to enable logging changes made to the configuration resources into the /nsr/logs/rap.log. .TP .BR "manual saves" " (read/write, hidden)" This attribute allows the administrator to disable manual backups to the server. Scheduled backups continue to work normally. .TP .BR "public archives" " (read/write)" This attribute determines whether a user can retrieve archived files that are owned by another user. .TP .BR "volume priority" " (read/write)" If a Sun StorEdge EBS 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. This attribute determines whether the server has a preference for volumes being managed by SmartMedia, .B "SmartMedia Priority," or whether the server has a preference for volumes in a locally managed jukebox, .B "NearLine Priority." The default value is .B "NearLine Priority." .br .I Example: \fR\s10volume priority: NearLine Priority;\fP\s0 .TP .BR "SmartMedia save mount" " (read/write)" This attribute controls the form of the request made to SmartMedia to mount a volume for saving data. Setting the value of this attributes to .BR "volume by characteristics" causes Sun StorEdge EBS 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 .B "volume by name", Sun StorEdge EBS will request the volume by name and SmartMedia mounts the volume requested. The default value is .B "volume by characteristics". .br .I Example: \fR\s10SmartMedia save mount: volume by characteristics;\fP\s0 .TP .BR "license server" " (read/write, hidden)" The name of the server on which a Sun StorEdge EBS 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 Sun StorEdge EBS license manager is running. .I Example: \fR\s10license server: jupiter;\fP\s0 .TP .BR "update licenses" " (choice, read-only, dynamic, hidden)" Set to `Yes' if this server should attempt to re-synchronize its externally managed licenses immediately. .TP .BR "message" " (read-only, dynamic, hidden)" The last message of any kind logged. A timestamp is included at the start of the string. .br .I Example: \fR\s10message: "Mon 12:25:51 Tape full, mount volume mars.001 on /dev/nrst1";\fP\s0 .TP .BR "message list" " (read-only, dynamic, hidden)" A list of recent messages, with a timestamp and a string message for each value. .br .I Example: \fR\s10message: "Mon 12:25:51 Tape full, mount volume mars.001 on /dev/nrst1";\fP\s0 .TP .BR "server message" " (read-only, dynamic, hidden)" Lists recent, concise general messages about the status of the server. .br .I Example: \fR\s10message: "Tape full, mount volume mars.001 on /dev/nrst1";\fP\s0 .TP .BR "sequence number" " (read-only, dynamic, hidden)" The sequence number of the corresponding server message. .TP .BR "server message time" " (read-only, dynamic, hidden)" The time at which the server message was generated. .TP .BR "server message priority" " (read-only, dynamic, hidden)" The priority of the server message. Currently these are for Sun StorEdge EBS internal use. .TP .BR "server message source" " (read-only, dynamic, hidden)" This attribute names the Sun StorEdge EBS component, such as a client or device, that generated the message on the server. This can be a client, a device etc. .TP .BR "server message category" " (read-only, dynamic, hidden)" This attribute is the category the server message belongs to. Currently these are for Sun StorEdge EBS internal use. .TP .BR "session" " (read-only, dynamic, hidden)" The value of this attribute is a list of session information strings. Each string includes the Sun StorEdge EBS 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. .br .I Example: .nf \fR\s10session: "venus:/usr saving to mars.001 20MB", "mars:/usr/src done saving 24MB";\fP\s0" .fi .TP .BR "session message" " (read-only, dynamic, hidden)" Concise session message string of the session attribute described above. .br .I Example: .nf \fR\s10session: "venus:/usr saving to mars.001", "mars:/usr/src done saving";\fP\s0" .fi .TP .BR "session client name" " (read-only, dynamic, hidden)" The name of each client for which each session is active. .TP .BR "session rate " " (read-only, dynamic, hidden)" The rate of data transfer for the active session. .TP .BR "session rate label" " (read-only, dynamic, hidden)" Unit of data transfer for the active sessions. .TP .BR "session device name" " (read-only, dynamic, hidden)" The name of the device on which the session is active. .TP .BR "pending" " (read-only, dynamic, hidden)" A list of events pending with the Sun StorEdge EBS event notification system (see .BR nsr_notification (5)). The first three fields are the time, priority, and event name. .br .I Example: \fR\s10pending: "Fri 14:40:15 alert: media mount of mars.001 suggested on /dev/nrst1";\fP\s0 .TP .BR "status" " (read-only, dynamic, hidden)" A list of status flags for the Sun StorEdge EBS server. These flags are only for use by Sun StorEdge EBS server-side programs (for example, .BR savegrp ) and list various features enabled in the running server. The format is currently \fIname\fR=\fIboolean\fR (true or false). The listed features and their states can change at any time. .TP .BR "statistics" " (read-only, dynamic, hidden)" A list of strings of the form \fIname\fR=\fInumber\fR that give a number of server statistics. .TP .BR "LSSV reg code" " (read-write, hidden)" Customer registration code, for "EMC Single Server Version for Oracle". .TP .BR "Jobsdb retention in days" " (read/write, static)" Minimum time to keep completed job records in the active jobs database, in days. After this time, records will be purged out of the active jobs database. NMC server should retrieve job records within this time for long-term monitoring purposes. Make sure that the NMC server does not stay off-line for a period of time longer than the interval specified by this attribute. .br Warning: large values of this attribute may cause the active jobs database to grow very large on busy servers, potentially causing performance problems. Adjust with caution. .TP .BR "Jobsdb maximum size" " (read/write, static)" Maximum size that the active jobs database is allowed to grow to. If the database size exceeds this value, the database is purged until the size drops at least 10% below the maximum set by this attribute. Records are selected from oldest to youngest. This value supercedes the retention time. Setting this value too low will cause records to be purged prematurely. .br Warning: large values of this attribute may cause the active jobs database to grow very large on busy servers, potentially causing performance problems. Adjust with caution. .TP .BR "types created" " (read-only, static)" A list of all the other resource types this Sun StorEdge EBS server can create and about which clients can query. .br .I Example: \fR\s10types created: NSR device, NSR group;\fP\s0 .TP .BR "administrator" " (read/write, static)" This is a list of names (or netgroups) of users who are allowed to administer Sun StorEdge EBS. Users in this list are members of the Administrators user group. This list is inherited from the Users attribute in the Administrators user group resource. Only users with the .IR "Change Security Settings" privilege can see or modify this attribute. The user "root" on the local host of the server is always an administrator. Entries specifying other administrators are of the form: \fIuser\fR, \fIuser\fB@\fIhost\fR, \fIuser\fB@\fIdomain\fR, \fIgroup\fB@\fIhost\fR, \fIgroup\fB@\fIdomain\fR, \fIhost\fB/\fIuser\fR \fB&\fInetgroup\fR, or \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 following example grants Sun StorEdge EBS Administrators membership to, "root" from any host, the user "operator" from the hosts "jupiter" and "mars", the user "admin" from any host, and all in the netgroup "netadmins". .br .I Example: \fR\s10administrator: root, operator@jupiter, mars/operator, admin@*, &netadmins;\fP\s0 The following example grants Sun StorEdge EBS Administrator membership to the user "root" on host "pluto", users in group "Backup Operators" from windows domain "Accounting", and user "joe" in NIS domain "YP.fubar.COM". .br .I Example: \fR\s10administrator: "user=root,host=pluto", "group=\\"Backup Operators\\", domain=Accounting, domaintype=windomain", "user=joe, domain=YP.fubar.COM, domaintype=NIS";\fP\s0 .TP .BR "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. .br .I Example: \fR\s10contact name: contact_name;\fP\s0 .TP .BR "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. .br .I Example: \fR\s10company: EMC Corporation;\fP\s0 .TP .BR "street address" " (read/write, static)" This attribute is used for product licensing/registration mailing purposes. Specify your mailing street address. .br .I Example: \fR\s10street address: 176 South Street;\fP\s0 .TP .BR "city/town" " (read/write, static)" This attribute is used for product licensing/registration mailing purposes. .br .I Example: \fR\s10city/town: Hopkinton;\fP\s0 .TP .BR "state/province" " (read/write, static)" This attribute is used for product licensing/registration mailing purposes. .br .I Example: \fR\s10state/province: MA;\fP\s0 .TP .BR "zip/postal code" " (read/write, static)" This attribute is used for product licensing/registration mailing purposes. .br .I Example: \fR\s10zip/postal code: 01748;\fP\s0 .TP .BR "country" " (read/write, static)" This attribute is used for product licensing/registration mailing purposes. .br .I Example: \fR\s10country: USA;\fP\s0 .TP .BR "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. .br .I Example: \fR\s10phone: 877-534-2867;\fP\s0 .TP .BR "fax" " (read/write, static)" This attribute is used for product licensing/registration purposes. .br .I Example: \fR\s10fax: 650-745-1477;\fP\s0 .TP .BR "email address" " (read/write, static)" This attribute is used for product licensing/registration purposes. .br .I Example: \fR\s10email address: support@emc.com; .TP .BR "server OS type" " (read/write, static)" This attribute is used for product licensing/registration purposes. .br .I Example: \fR\s10server OS type: Solaris;\fP\s0 .TP .BR "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. .TP .BR "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. .TP .BR "mm op message" " (read/write, dynamic, hidden)" This attribute lists the descriptive message for the most recently completed media database operation. The Sun StorEdge EBS program (such as .BR 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. .TP .BR "mm operation value" " (read/write, dynamic, hidden)" This attribute is used by programs such as .BR nsrmm (8) to pass the desired media database operation location or flags to the Sun StorEdge EBS server. The value is automatically cleared when the operation completes. An administrator should never change this attribute manually. .PP .BR "mm operation" " (read/write, choice list, dynamic," .RS hidden) .br This attribute is used by programs such as .BR nsrmm (8) to pass the appropriate media database operation type to the Sun StorEdge EBS 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 .BR nsrmmdbd (8). The value is automatically cleared when the operation completes. An administrator should never change this attribute manually. .RE .TP .BR "mm operation id" " (read/write, dynamic, hidden)" This attribute is used by programs such as .BR nsrmm (8) to pass the desired media database operation identifier to the Sun StorEdge EBS server. The value is automatically cleared when the operation completes. An administrator should never change this attribute manually. .TP .BR "nsrmon info" " (read/write, dynamic, hidden)" This attribute is used by programs such as .BR nsrmon (8) to pass information about remote daemon requests to the Sun StorEdge EBS server. The value is automatically cleared when the request completes. An administrator should never change this attribute manually. See .BR nsr_storage_node (5) for a description of storage nodes and remote daemons. .TP .BR "nsrmmd count" " (read-only, dynamic, hidden)" This attribute is used by programs such as .BR nsrd (8) to track the number and location of the media daemons, .BR nsrmmd (8). .TP .BR "nsrmmd polling interval" " (read/write, hidden)" This attribute specifies the number of minutes between polling events of a remote .BR nsrmmd (8). .BR nsrd (8) polls a remote .BR 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 .BR nsrmmd (8), with a delay set by the `nsrmmd restart interval'; see the .BR nsrmmd restart interval description. See .BR nsr_storage_node (5) for additional details on this attribute and storage nodes. .TP .BR "nsrmmd restart interval" " (read/write, hidden)" This attribute specifies the number of minutes between restart attempts of a remote .BR nsrmmd (8). When .BR nsrd (8) determines that a remote .BR 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 .BR nsr_storage_node (5) for additional details on this attribute and storage nodes. .TP .BR "nsrmmd control timeout" " (read/write, hidden)" This attribute specifies the number of minutes .BR nsrd (8) waits for storage node requests. .TP .BR "enabler code" " (read/write, dynamic, hidden)" This attribute specifies the enabler code for the base enabler of the server software. .TP .BR "vendor ID" " (read/write, hidden)" Identifier of the vendor that built and shipped this server. .TP .BR "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 Release 6.0. Continuation save sets have been eliminated for Release 6.0 and above. .TP .BR "User ID" " (dynamic, hidden)" This attribute contains the user ID by which the Sun StorEdge EBS server authenticated you. The user ID is usually in the format .IR "user/host@domain". .TP .BR "Privileges" " (dynamic, hidden)" This attribute lists the privileges that you have. .TP .BR "Member of" " (dynamic, hidden)" This attribute lists the user groups that you are a member of. .TP .BR "hostname" " (read-only, hidden)" This attribute gives the hostname of the machine on which the service that controls this resource is running. It is used internally and cannot be changed by the administrator. .TP .BR "ONC program number" " (read-only, hidden)" The Open Network Computing (sunrpc) identification number for the client to server protocol provided by this service. .TP .BR "ONC version number" " (read-only, hidden)" The version of the above protocol. .TP .BR "ONC transport" " (choice, read-write, hidden)" The Open Network Computing (sunrpc) transport protocols supported are TCP (Transport Control Protocol) or UDP (User Datagram Protocol). .TP .BR "timezone offset" " (read-only, hidden)" This attribute displays the server's timezone offset from GMT. .SH EXAMPLE .PP A complete example follows: .br .nf \fR\s10 .ta \w' nsrmmd polling interval:'u+1nR +2n type: NSR; name: mars; version: "Sun StorEdge EBS 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; parallelism: 4; manual saves: Enabled; Monitor RAP: 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: "EMC Corporation"; street address: 176 South Street; city/town: Hopkinton; state/province: MA; zip/postal code: 01748; country: USA; phone: 877-534-2867; fax: 650-745-1477; email address: support@emc.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: ; timezone offset: GMT-0800; \fR\s0 .ta .fi .SH FILES .I /nsr/res/nsrdb \- files in this directory should never be edited directly. Use .BR nsradmin (8) instead. .SH SEE ALSO .na .BR netgroup (5), .BR nsr (5), .BR nsr (8), .BR nsr_device (5), .BR nsr_group (5), .BR nsr_notification (5), .BR nsr_resource (5), .BR nsr_storage_node (5), .BR nsradmin (8), .BR nsrd (8), .BR nsrmm (8), .BR nsrmmdbd (8), .BR nsrmon (8), .BR recover (8), .BR save (8). .ad