NSR_JUKEBOX(5)

NAME

NSR jukebox − NetWorker resource type “NSR jukebox”

SYNOPSIS

type: NSR jukebox

DESCRIPTION

Each jukebox known to NetWorker is described by a single resource of type NSR jukebox. This resource describes the physical characteristics of a jukebox. See nsr_resource(5) for more information on NetWorker resources. To edit the NSR jukebox resources for a NetWorker server, type:

nsradmin -c "type:NSR jukebox"

or use the nwadmin(8) GUI. See the nsradmin(8) manual page for more information on using the NetWorker administration program.

ATTRIBUTES

The following attributes are defined for resource type NSR jukebox. The information in parentheses describes how the attribute values are accessed. Create-only indicates that the value cannot be changed by an administrator, except when the resource is created. Read-only indicates that the value cannot be changed by an administrator. Read/write means the value can be set as well as read at any time. Choice list means that any number of values can be chosen from the given list. Yes/no means only a yes or no choice is possible. Single string means that only a single value is allowed. Number means that only numeric values are allowed. Static attributes change values rarely, if ever. Dynamic attributes have values which 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 the View Details menu pulldown in nwadmin(8)). For example, an attribute marked (read-only, dynamic) has a value which cannot be changed by the administrator but which may change each time it is retrieved from the NetWorker server due to underlying state changes. Several additional attributes (e.g. administrator) are common to all resources, and are described in nsr_resource(5).

name(create-only, single string)
This attribute specifies the name of this jukebox.
Example: name: Huntington;

model(create-only, single string)
This attribute specifies the jukebox model and the format of the control commands.
Example: model: EXB-10i;

physical slots(read-only, list of numbers, hidden)
This attribute specifies the first and last physical slot numbers in the jukebox. The first slot number must be less than or equal to the last slot number, the numbers must be specified as two separate attribute values.
Example: physical slots: 1, 54;

control port(read/write, single string)
This attribute specifies the path of the control port for the jukebox robotics. Control commands (load slot 47 into drive b, for example) are sent to the jukebox via the control port.
Example: control port: /dev/ttya;

devices(read/write, list of strings)
This attribute lists the device pathnames of the devices in the jukebox. Each entry that appears in this attribute must have a corresponding NSR device resource. There must be the same number of entries in the devices attribute as there are devices in the jukebox. In addition, they must be listed in the same order as they are physically installed in the jukebox. The entries are specified as separate attribute values.
Example: devices: /dev/nrst1, /dev/nrst2;

number devices(read/write, single number, hidden)
The number of configured devices in the jukebox. This value corresponds to the number of entries in the devices attribute.
Example: number devices: 2;

write enabled(read/write, yes/no, hidden)
This attribute indicates whether writing can be done to the mounted volume. This attribute is only used during a jukebox “Load” operation. This attribute is used to pass information between NetWorker programs, and should not be changed manually by the administrator.
Example: write enabled: Yes;

bar code reader(read/write, yes/no)
This attribute indicates whether NetWorker should use the bar code label from the media if the jukebox has a bar code label reader. This should only be enabled if the jukebox has a bar code label reader.
Example: bar code reader: No;

match bar code labels(read/write, yes/no)
This attribute indicates whether NetWorker should use the bar code label instead of a label template when labeling media volumes. This should only be enabled if the jukebox has a bar code label reader and the attribute "bar code reader" is enabled.
Example: match bar code labels: No;

volume expiration(read/write, single string, hidden)
This attribute is the expiration time of a volume that is currently being labeled, or the result of a “Verify label” operation. This attribute is used to pass information between NetWorker programs, and should not be changed manually by the administrator.

available slots(read/write, list of numbers)
This attribute specifies the slots containing volumes available to automatically satisfy NetWorker requests for writable volumes. When automatically selecting a writable volume, nsrjb(8) will only consider volumes from the list of available slots. The slots are specified as a list of ranges, one range per attribute value. A range may be a single slot number or a pair of slot numbers separated by a dash. The first number of a pair must be less than or equal to the second.

When satisfying requests to mount a particular volume (i.e., by its volume name) or slot, all of the volumes in the slots listed in physical slots can be used. This allows the jukebox to be partitioned, with saves restricted to a group of volumes while all of the volumes contained within the jukebox are accessible for recovers.
Example: available slots: 1-10;

enabler code(read-only, single string, hidden)
This attribute lists the enabler code for the NSR license resource (see nsr_license(5)) corresponding to this jukebox resource. A jukebox cannot be used until a license enabler has been loaded to control that jukebox.
Example: enabler code: 123456-123456-123456;

operation(read/write, choice list, hidden)
This attribute shows the operation currently being performed on the jukebox. This attribute is used to pass information between NetWorker programs, and should not be changed manually by the administrator.
Example: operation: Load;

operation message(read-only, single string, hidden)
This displays an error message after a jukebox operation fails.
Example: operation message: ;

operation device(read/write, single string, hidden)
This attribute is used to pass the name of the device to which the current operation refers. This attribute is used to pass information between NetWorker programs, and should not be changed manually by the administrator.
Example: operation device: /dev/nrst1;

operation slots(read/write, single string, hidden)
This attribute is used to pass the the slots on which the current operation will be performed. This attribute is used to pass information between NetWorker programs, and should not be changed manually by the administrator.
Example: operation slots: 1-10;

operation template(read/write, single string, hidden)
This attribute shows the template that the label operation will use. The verify operation sets this to the the volume name found on a piece of media. This attribute is used to pass information between NetWorker programs, and should not be changed manually by the administrator.
Example: operation template: Default;

operation volume pool(read/write, choice list, hidden)
This attribute specifies the default volume pool to use when labeling. This attribute is used to pass information between NetWorker programs, and should not be changed manually by the administrator.
Example: operation volume pool: NonFull;

volumes(read/write, list of strings, hidden)
This attribute contains a list of resident volume names. The order corresponds to the slot number. This attribute is used to pass information between NetWorker programs, and should not be changed manually by the administrator.
Example: volumes: mars.001, mars.002, mars.003, mars.004;

loaded volumes(read/write, list of strings, hidden)
This attribute contains the names of the volumes currently loaded on the jukebox devices. The order is with respect to the devices attribute. This attribute is used to pass information between NetWorker programs, and should not be changed manually by the administrator.
Example: loaded volumes: mars.089, mars.003;

Using the names specified in the previous devices attribute, mars.089 is loaded in ‘/dev/nrst1’ and mars.003 is loaded in ‘/dev/nrst2’.

loaded bar codes(read/write, list of strings, hidden)
This attribute contains the bar codes of the loaded volumes, if the use of bar codes is enabled for the jukebox. The order is with respect to the devices attribute. This attribute is used to pass information between NetWorker programs, and should not be changed manually by the administrator.
Example: loaded bar codes: 12345, 67890;

Using the names specified in the previous devices attribute, the volume with bar code 12345 is loaded in ‘/dev/nrst1’ and the volume with bar code 67890 is loaded in ‘/dev/nrst2’.

loaded slots(read/write, list of numbers, hidden)
This attribute contains the slot numbers of the loaded volumes. The order is with respect to the devices attribute. This attribute is used to pass information between NetWorker programs, and should not be changed manually by the administrator.
Example: loaded slots: 48, 3;

Using the names specified in the previous devices attribute, the volume in slot 48 is loaded in ‘/dev/nrst1’ and the volume in slot 3 is loaded in ‘/dev/nrst2’.

event tag(read/write, single number, hidden)
This attribute contains the tag (unique identifier) of the last notification event sent to the nsrd(8) daemon. The tag is used by nsrjb(8) to clear the previous event. This attribute is used to pass information between NetWorker programs, and should not be changed manually by the administrator.
Example: event tag: 6319962287;

event message(read/write, single string, hidden)
This attribute contains the text of the last notification event sent to the nsrd(8) daemon. The nsrjb(8) command will send a notification event to nsrd when operator intervention is needed before nsrjb can proceed. This attribute is used to pass information between NetWorker programs, and should not be changed manually by the administrator.
Example: event message: could not unload device /dev/nrst2 into slot 4;

messages(read/write, list of strings, hidden)
This attribute contains a log of messages reflecting previous operations nsrjb(8) has done. Generally, an entry is made each time nsrjb is invoked and for each mechanical operation. Each entry is time stamped. This attribute is used to pass information between NetWorker programs, and should not be changed manually by the administrator.
Example: messages: 04/01/91 01:15:08 loaded slot 4 into drive a;

minimum space(read/write, single string, hidden)
This attribute contains the low water mark for remaining space. When the remaining space on the volumes contained in the available slots is less than the minimum space, a notification is sent to nsrd. This hidden attribute can be modified by a user.

The minimum space may be specified as a number of gigabytes or megabytes. Either ‘G’ or ‘g’ may be used for gigabytes, ‘M’ or ‘m’ for megabytes.
Example: minimum space: 7g;

jukebox options(read-only, list of strings, hidden)
This attribute contains a list of the options for this jukebox. This option is automatically set after jukebox creation.
Example: jukebox options: two_sided;

EXAMPLE

A resource defining a jukebox named Huntington is shown. The model attribute specifies a ‘Lago Datawheel’ jukebox. The control port attribute specifies the control commands will be written to ‘/dev/ttya’. The device attribute lists the pathnames of the two tape devices in the jukebox, ‘/dev/nrst1’ and ‘/dev/nrst2’. Since the jukebox has no bar code reader, the two bar code yes/no attributes are both set to ‘No’. The available slots attribute lists the slots to consider when automatically selecting a volume to load for writing. The available slots are 1 through 50. The hidden attributes are not displayed.

type: NSR jukebox;
name: Huntington;
model: Lago Datawheel;
control port: /dev/ttya;
devices: /dev/nrst1, /dev/nrst2;
bar code reader: No;
match bar code labels: No;
available slots: 1-50;

Museum