HP StorageWorks File System Extender CLI Reference Guide

HP StorageWorks

File System Extender Software

CLI reference

First edition (October 2006)

Part number: T3648-96013

CONTENTS 2

Contents

1 FSE command index 2

2 FSE command documentation 3

1 FSE command index

1.1 List of FSE commands

FSE command-line interface includes the following commands:

fse 3 fsebackup 14 fsebak 23 fsecheck 27 fsedrive 32 fseﬁle 38 fsejob 49 fselibrary 55 fsemedium 63 fsepartition 76 fsepool 88 fserecover 96 fserestore 101

HP StorageWorksFileSystemExtenderSoftware CLI reference

2 FSE command documentation 3

fsesystem 108

2 FSE command documentation

2.1 NAME

fse:

Initiate or terminate the FSE server or FSE client operation. Show current status of the FSE daemons (services). Conﬁgure mount points for HSM ﬁle systems (on Windows platform only). Enable or disable Limited Access Mode for a particular HSM ﬁle system (on Windows platform only).

2.1.1 SYNOPSIS

fse ––start fse ––stop fse ––restart fse ––status fse ––mount MountPoint VolumeName fse ––umount MountPoint VolumeName fse ––dismount–ntfs VolumeName fse ––limit–access VolumeName fse ––full–access VolumeName fse ––list–volumes [– –detail]

2.1.2 DESCRIPTION

The fse command (startup script on Linux systems, executable on Windows systems) affects core FSE components. It should be used with a maximum care as its usage can lead to improper FSE server or client operation or no operation at

HP StorageWorksFileSystemExtenderSoftware CLI reference

2.1 NAME 4

all. FSE administrator has to know exactly what he is doing when using this command.

The command is used to perform these FSE administrator’s tasks:

• startor shut down FSE processes to enable or cease the FSE implementation (FSE server, FSE client) operation,

• restart FSE (server, client) processes in case of problems,

• print status information for the conﬁguration–independent FSE daemons (services) running in the FSE implementation (FSE server, FSE client),

• on Windows systems, conﬁgure mount points for HSM ﬁle systems, mount or unmount HSM ﬁle systems,

• on Windows systems, dismount a newly formatted volume, enable or disable Limited Access Mode for a particular HSM ﬁle system,

• on Windows systems, enumerate all local volumes and report their status with respect to the FSE implementation.

FSE PROCESSES Core FSE components, as for fse command, are running FSE processes, that are responsible for proper FSE operation. There are two groups of FSE processes: conﬁguration–independent and conﬁguration– dependent. The conﬁguration–independent FSE processes, also called FSE daemons (services), allow FSE software to operate and intercommunicate. The conﬁguration–dependent FSE processes control a single conﬁgured FSE resource. FSE administrator may conﬁgure more than one resource of the same kind, so there can be several FSE processes of the same kind running simultaneously. Currently, the only resources that are controlled by their own processes are FSE partition and FSE library.

CONSOLIDATED AND DISTRIBUTED FSE IMPLEMENTATIONS It is possible to either set up FSE on a consolidated system or distribute its functionality across one FSE server and an arbitrary number of FSE clients. In ﬁrst case, all FSE processes are running on the same system, in the other some of them only on FSE server as FSE server processes (marked with S character), some only on

HP StorageWorksFileSystemExtenderSoftware CLI reference

2.1 NAME 5

each FSE client as FSE client processes (marked with C character) and some on both/all (marked with S+C characters).

Conﬁguration–independent FSE processes – FSE daemons (services) are:

• Service (S+C),

• Resource Manager (S),

• Management Interface (S),

• File System Event Manager∗ (C).

∗ ... there is one File System Event Manager running on each FSE client host. It controls an arbitrary number of HSM ﬁle systems that reside on the same FSE client host.

Conﬁguration–dependent FSE processes:

• Partition Manager (S),

• Back End Agent (S),

• Library Agent (S).

fse ––status prints info on the conﬁguration–independent FSE processes only. For each FSE daemon (service) fse – –status prints its binary name, its current status (running, stopped) and the associated process ID(s). If the command is executed on FSE server (FSE client) it only prints info on the FSE server (FSE client) daemons (services). The daemon (service) binary names are listed in the following table.

-------------------------------------------| PROCESS | FSE DAEMON (SERVICE) |

-------------------------------------------| fse-svc | Service | | fse-rm | Resource Manager | | fse-mif | Management Interface | | fse-fsevtmgr | File System Event Manager |

--------------------------------------------

HP StorageWorksFileSystemExtenderSoftware CLI reference

2.1 NAME 6

POST–START AND PRE–STOP SCRIPTS FSE administrator can set up two

helper scripts which perform arbitrary automated tasks at the FSE implementation (FSE server, FSE client) startup and shut–down time. They are executed by the fse command.

Both helper scripts have to be placed in the /opt/fse/sbin (on Linux systems) or %InstallPath%\bin directory (on Windows systems) on a local machine, and have to be named as speciﬁed below:

• post_start.sh (on Linux systems) or post_start.cmd (on Windows systems) ... this is the post–start helper script. It is executed after all FSE processes have been started up and all existing HSM ﬁle systems with an entry in the /etc/fstab ﬁle (on Linux systems) or all existing HSM ﬁle systems with a deﬁned mount point (on Windows systems) have been mounted, i.e. right after the FSE implementation is put into its fully operational state;

• pre_stop.sh (on Linux systems) or pre_stop.cmd (on Windows systems) .....

this is the pre–stop helper script. It is executed before all mounted HSM ﬁle systems are unmounted and all running FSE processes are shut down, i.e. right before the FSE implementation is pulled out of its fully operational state.

If any of these scripts does not exist, it is simply ignored. IMPORTANT: The commands that you specify in the post–start and pre–stop

scripts should not block the execution of the fse command. Thus, they have to conform to the following rules:

• They must not require interactive input.

• They must ﬁnish in a reasonable time and afterwards return the control to the script afterwards.

VOLUME STATES ON WINDOWS SYSTEMS On Windows systems, the fse – –list–volumes [––detail] command enumerates volumes on the local system

and reports their states from the FSE viewpoint. Possible values of the reported parameter Status and their explanations are:

HP StorageWorksFileSystemExtenderSoftware CLI reference

2.1 NAME 7

• Regular ...... the volume is mounted using HSM ﬁle system and operates

as a regular FSE partition.

• WORM ......... the volume is mounted using HSM ﬁle system and operates

as a WORM FSE partition.

• LAM .......... the volume is mounted using HSM ﬁle system and operates in

the Limited Access Mode. The operation of HSM FS ﬁlter for that volume was manually switched to LAM using the fse ––limit–access command. Use the fse – –full–access command to switch the HSM FS ﬁlter operation for the volume back to the Full Access Mode.

• LAM–No–HSM ... this status is the same as LAM with the only difference that the fse–hsm process is not running. There are various causes of this condition. If you have run the fse ––umount command on this volume recently, you can start fse–hsm by running the fse – –mount command. If the command reports an error "HSM already started. Unmount ﬁrst.", run fse ––umount again and examine the FSE error log to determine the cause of the fse–hsm failure.

• Unattached ... this status is the same as Unknown with the only difference that the HSM FS ﬁlter once had control over the volume.

• No–Conﬁg .... this status is the same as LAM–No–HSM but the cause is

different. Possible reasons are a disabled or removed FSE partition. To resume using the volume as HSM ﬁle system, enable or add the corresponding FSE partition again. To use the volume natively (through NTFS), run the command fse – –dismount–ntfs.

• Inactive ..... the volume is prepared to be mounted using HSM ﬁle system

but the HSM FS ﬁlter is not attached to it yet. Either the volume was formatted and the corresponding FSE partition has not been conﬁgured yet, or the volume has not been accessed yet. Run the command fse ––mount on the volume. If the volume status does not change, run fse ––dismount–ntfs.

• Unknown ...... the volume is not under the FSE control or the fse–fsevtmgr

process is not running. In the latter case, most probably the FileSystemID variable in the FSE partition conﬁguration has wrong contents that must be corrected.

HP StorageWorksFileSystemExtenderSoftware CLI reference

2.1 NAME 8

2.1.3 OPTIONS

• ––start This option has different effects depending on whether the fse command is

executed in a consolidated FSE implementation, in a distributed FSE implementation on an FSE server, or in a distributed FSE implementation on an FSE client.

If used on a consolidated FSE system, the – –start option:

1. initiates omniNames – the omniORB naming service daemon, if it is not running yet,

2. initiates the FSE operation starting up all FSE processes (see FSE PROCESSES for details on FSE processes),

3. mounts all existing HSM ﬁle systems with an entry in the /etc/fstab ﬁle (on Linux systems),

4. executes the post–start script, if it exists (see POST–START AND PRE–STOP SCRIPTS for details on the post–start script).

If used on FSE server in a distributed FSE implementation, it:

1. initiates omniNames – the omniORB naming service daemon, if it is not running yet,

2. initiates the FSE server operation starting up all FSE server processes (see FSE PROCESSES for details on FSE server processes),

3. executes the post–start script, if it exists.

If used on FSE client in a distributed FSE implementation, it:

1. initiates the FSE client operation starting up all FSE client processes (see FSE PROCESSES for details on FSE client processes),

2. mounts all existing HSM ﬁle systems with an entry in the /etc/fstab ﬁle (on Linux systems),

3. executes the post–start script, if it exists.

HP StorageWorksFileSystemExtenderSoftware CLI reference

2.1 NAME 9

• ––stop As with the – –start option, the effects of this option depend on where the

fse command is executed. If used on a consolidated FSE system, the – –stop option:

1. executes the pre–stop script, if it exists (see POST–START AND PRE–STOP SCRIPTS for details on the pre–stop script),

2. unmounts all mounted HSM ﬁle systems (on Linux systems),

3. terminates the FSE operation shutting down all running FSE processes (see FSE PROCESSES for details on FSE processes).

If used on FSE server in a distributed FSE system, it:

1. executes the pre–stop script, if it exists,

2. terminates the FSE server operation shutting down all running FSE server processes (see FSE PROCESSES for details on FSE server processes).

If used on FSE client in a distributed FSE system, it:

1. executes the pre–stop script, if it exists,

2. unmounts all mounted HSM ﬁle systems (on Linux systems),

3. terminates the FSE client operation shutting down all running FSE client processes (see FSE PROCESSES for details on FSE client processes).

• ––restart This option has the same effect as a consecutive invocationof the fse – –stop

and fse – –start commands.

Note:

In a distributed or mixed FSE implementation, restarting the FSE processes on FSE server requires restarting processes on particular FSE client to allow normal operation of each FSE partition conﬁgured on that client.

HP StorageWorksFileSystemExtenderSoftware CLI reference

2.1 NAME 10

• ––status Show status of each FSE (server, client) daemon (service), i.e.

conﬁguration–independent FSE (server, client) process. For details on FSE daemon (service) status info, see section FSE PROCESSES.

• ––mount

• ––umount Linux systems: The command fse ––mount | – –umount should not be

used by the FSE administrator directly. It is called by fse–svc daemon (service) during a recovery of an HSM ﬁle system.

Windowssystems: Use the command fse – –mount | – –umount with great care. It should be used instead of mountvol command if you want to administrate an FSE partition (for example to enable or disable it).

– fse ––mount command will create a mount point MountPoint for the

volume VolumeName and trigger HSM FS ﬁlter to connect to volume device ﬁle and start fse–hsm.

– fse ––umount command will stop fse–hsm and switch the HSM FS

ﬁlter operation for managing accesses to the volume VolumeName from Full Access Mode to Limited Access Mode. For information on Limited Access Mode, see description of the ––limit–access option.

• MountPoint A directory path that represents the mount point to which the VolumeName

NTFS volume will be mounted.

• VolumeName Volume ID of an NTFS volume that stores an HSM ﬁle system on a Win-

dowsclient. Volume ID is volume name without the \\?\ preﬁx and without the trailing backslash.

• ––dismount–ntfs Windows systems only: Dismount the newly formatted NTFS volume

VolumeName. Dismount is achieved by sending an appropriate code (the FSCTL_DISMOUNT_VOLUME ioctrl code) to the volume. Later, when the volume is mounted again, the HSM FS ﬁlter can attach to it before

HP StorageWorksFileSystemExtenderSoftware CLI reference

2.1 NAME 11

NTFS, and thus gain control over it. Note that the fse – –dismount–ntfs command will fail in case the volume is in use, that is, when some processes have open handles on it.

• ––limit–access Windows systems only: Switch the HSM FS ﬁlter operation for manag-

ing accesses to the volume VolumeName from Full Access Mode to Limited Access Mode. In this mode, modiﬁcations on the corresponding HSM ﬁle system are not allowed. The volume remains mounted to its mount point, fse–hsm continues to run for the HSM ﬁle system and online ﬁles are still migrated and released. Recalls of ofﬂine ﬁles are denied. When an ofﬂine ﬁle is accessed while the HSM ﬁle system operates in Limited Access Mode, the application that is accessing the ﬁle receives an error and the ﬁle is not recalled. For more information on Limited Access Mode, see the FSE user guide.

• ––full–access Windows systems only: Switch the HSM FS ﬁlter operation for manag-

ing accesses to the volume VolumeName from Limited Access Mode to Full Access Mode. This change is possible only if the corresponding fse–hsm process is running and the HSM ﬁle system on the volume operates in Limited Access Mode. For more information on Full Access Mode, see the FSE user guide.

• ––list–volumes Windows systems only: Enumerate all volumes on the local system and

report their states with respect to the FSE implementation. Reported information for a volume includes:

1. Volume ID ..... ID string of the volume,

2. Status ........ current volume status,

3. Mount point ... volume mount point.

See section VOLUME STATES ON WINDOWS SYSTEMS for descrip- tion of the volume states.

• ––detail

HP StorageWorksFileSystemExtenderSoftware CLI reference

2.1 NAME 12

Windows systems only: Retrieve additional volume information and dis-

play the retrieved data in the ParameterName: ParameterValue format with each parameter in its own line. The following additional information is reported:

1. Device ... the device string of the device which the volume is linked to.

Additionally, a more descriptive content is reported for the Status parameter. This option can only be used in combination with the – –list–volumes option.

2.1.4 EXAMPLES

• Create a mount point for the speciﬁed volume and trigger HSM FS ﬁlter to connect to volume device ﬁle and start fse–hsm (on Windows systems):

fse ––mount I:\fs02 \\?\Volume{86eec883–a640–11d7–9be3– 00096bb08bc0}\

• Stop fse–hsm and enable Limited Access Mode for the speciﬁed volume (on Windows systems):

fse ––umount c:\emptydir \\?\Volume{d9568629–da27–11d7–bf21– 0050da45607}\

• Disconnect NTFS from the speciﬁed volume (on Windows systems):

fse ––dismount–ntfs \\?\Volume{d9568629–da27–11d7–bf21– 0050da45607}\

• Enable Limited Access Mode for the speciﬁed volume (on Windows systems):

fse ––limit–access \\?\Volume{d9568629–da27–11d7–bf21– 0050da45607}\

• Disable Limited Access Mode (switch back to Full Access Mode) for the speciﬁed volume (on Windows systems):

fse – –full–access \\?\Volume{d9568629–da27–11d7–bf21– 0050da45607}\

HP StorageWorksFileSystemExtenderSoftware CLI reference

2.1 NAME 13

• Retrieve additional information about volumes on the local system; display each of the retrieved parameters in a separate line (on Windows systems):

fse ––list–volumes – –detail

2.1.5 FILES

• /opt/fse/sbin/post_start.sh (on Linux systems), %InstallPath%\bin\post_start.cmd (on Windows systems)

The post–start helper script.

• /opt/fse/sbin/pre_stop.sh (on Linux systems), %InstallPath%\bin\pre_stop.cmd (on Windows systems) The pre–stop helper script.

2.1.6 COPYRIGHT

2.1.7 SEE ALSO

fsesystem(8), fsepartition(8), fserestore(8), fseintro(7).

HP StorageWorksFileSystemExtenderSoftware CLI reference

2.2 NAME 14

2.2 NAME

fsebackup:

Create backup image with complete FSE server state.

2.2.1 SYNOPSIS

fsebackup [{–f | ––ﬁle} BackupFileName [– –nomedia]] fsebackup [{–f | ––ﬁle} BackupFileName] [{–m | ––medium} Barcode [–i |

––init]] fsebackup {–h | ––help} fsebackup {–v | ––version}

2.2.2 DESCRIPTION

Each FSE command communicates with the FSE processes through the Management Interface (fse–mif). Toexecutean FSE command, the Management Interface must be running. If the connection to the Management Interface fails, check its status by running the fse – –status command. In case the Management Interface is not running, start it with the fse – –start command. Additionally, fsebackup also requires Partition Manager processes (fse–pm) for all conﬁgured FSE partitions to be running. This can be checked with the fsesystem or fsepartition command. If tape will be used as a backup destination, Resource Manager (fse–rm) must also be running. You can check its status with the fse command.

After a successful command execution fsebackup notiﬁes the FSE administrator with a suitable message, which is printed to the standard output stream (stdout). If there was an error during the command execution, an appropriate error message is printed to the standard error stream (stderr).

BACKUP CONCEPTS fsebackup creates backup image with consistent state of FSE databases and system ﬁles on the FSE server at a particular point in time. Backup image can be stored on disk (local or remote disk volume or share), on tape (FSE medium in the backup FSE media pool), or on both backup destinations.

HP StorageWorksFileSystemExtenderSoftware CLI reference

2.2 NAME 15

In case of disaster, you can use the fserestore command to restore the complete FSE state from such backup image.

The backed up items include entities that are shared among FSE clients in the FSE implementation, as well as entities that belong to each particular FSE client. The following entities are backed up:

• Global conﬁguration ﬁles (omniORB.cfg, services.cfg, trace.cfg)

• Resource Management Database (RMDB)

• Conﬁguration Database (CfgDB)

• File System Catalogs (FSCs)

• Fast Recovery Information (FRI)

Additionally, the log ﬁles on the FSE server are also backed up:

• FSEeventlog (renamed to fse_<YYYY><MM><DD>.log in the backup image, where <YYYY><MM><DD> is the current timestamp)

• FSE error log (renamed to error_<YYYY><MM><DD>.log in the backup image, where <YYYY><MM><DD> is the current timestamp)

• HSM ﬁle system logs (only if FSE server is part of a consolidated FSE system)

Note:

User data on HSM ﬁle systems and the belonging Hierarchical Storage Management Databases (HSMDBs) are not backed up. If disaster occurs on a particular HSM ﬁle system, you can use the inherent HSM ﬁle system recovery functionality to recover from it. HSM ﬁle system recovery can be started with the fserecovercommand. For more information, see the FSE user guide.

PREREQUISITES FSE backup uses logical volume snapshot technology to keep the operation of FSE implementation almost unobstructed during the backup window. To be able for the FSE backup to use this technology, all entities that are

HP StorageWorksFileSystemExtenderSoftware CLI reference

2.2 NAME 16

backed up have to reside on LVM logical volumes (on Linux systems) or additional snapshot software needs to be installed in advance (on Windows systems). This is an essential prerequisite. For details on the required snapshot software on Windows platform, see the FSE release notes.

When tape is used as backup destination, FSE backup stores backup images to tape media of the backup FSE media pool. This media pool should therefore be conﬁgured before fsebackup is run. Backup FSE media pool is an FSE media pool conﬁgured with the BACKUP type and preferably one data volume on its media. Since FSE backup uses only the ﬁrst data volume on each backup medium, this way you ensure that storage capacity of the backup FSE media pool is optimally used. For details on conﬁguring media pools, see the fsepool man page. Note that backup FSE media must be formatted and initialized before they can be used.

Warning:

As an FSE administrator, it is your responsibility to keep track of which backup image is stored on which backup FSE medium (with tape as backup destination) or in which backup image ﬁle (with disk as backup destination). With tape as backup destination, fsebackup only checks if the backup FSE media pool is conﬁgured, and if there is enough free space on any medium in it or on the backup medium speciﬁed in the command line (if the ––medium option is speciﬁed). To avoid potential data loss, HP also suggests that you periodically check condition of tape media in the backup FSE media pool.

THE BACKUP PROCESS If all prerequisites are fulﬁlled, the backup process can begin. The process is executed by a backup job. The ﬁle backup.pid prevents two backup jobs from being run in parallel in the same FSE implementation.

The backup process performs the following steps. Each step starts only if all previous steps were successful:

1. FSE server is internally suspended. Operation of all running Partition Managers is temporarily blocked, in order to achievea consistent state of all File System Catalogs (FSCs) and other entities that will be backed up.

2. Data from transaction log ﬁles of Hierarchical Storage Management Databases (HSMDBs) on the FSE clients are committed to the main

HP StorageWorksFileSystemExtenderSoftware CLI reference

2.2 NAME 17

databases, and then the transaction log ﬁles are removed. This action achieves the required consistency of HSMDBs.

3. Transaction log ﬁles of File System Catalogs (FSCs) are committed to the main databases. This action achieves the required consistency of FSCs.

4. Snapshots of the volumes with FSE databases and system ﬁles are created.

5. FSE server is resumed. Operation of all running Partition Managers is unblocked so that Partition Managers can process existing job requests and accept new ones.

6. Backup data is collected, archived, and compressed into a single backup image ﬁle, which is temporarily stored in the FSE disk buffer storage space. On all supported platforms, backup image ﬁles use the .tar.bz2 ﬁle format.

7. According to the speciﬁed backup destination, the backup image is copied to disk (local or remote disk volume or share), tape (FSE medium in the backup FSE media pool), or both.

8. Transaction log ﬁles of File System Catalogs (FSCs), which were committed in step 3, are removed.

9. Snapshots of disk volumes are removed.

Note:

You can conﬁgure a regular cron job (on Linux systems) or schedule a task (on Windows systems) to periodically run FSE backup.

ACTIVITYLOGGING fsebackup reports its progress to the FSE backup log. To ﬁgure out the required backup window, consult the FSE event log. You can determine the backup start and stop times from a previously run backup session. Errors encountered during backup process are reported to the FSE error log. For location and names of log ﬁles, see section FILES.

BACKUP CONFIGURATION On Linux systems, before starting backup, you must check parameters in the backup conﬁguration ﬁle and modify them, if needed. Backup conﬁguration ﬁle is named backup.cfg and located on the FSE server (see section FILES). Conﬁgurable parameters and their default values are the following:

HP StorageWorksFileSystemExtenderSoftware CLI reference

2.2 NAME 18

• HSM_LV_VAR = hsm_vg/var

This parameter is obsolete in the current FSE product. It is ignored by the backup process.

• HSM_LV_PART = hsm_vg/part

This parameter is obsolete in the current FSE product. It is ignored by the backup process.

• SNAPSHOT_PCT = 10

Size of the LVM logical volume snapshot, expressed in percentage of the original LVM logical volume size.

If the /etc/opt/fse/backup.cfg ﬁle is not found, default values are used for the current FSE backup session.

On Windows systems, the backup conﬁguration ﬁle backup.cfg is obsolete and ignored by the backup process.

ABORTING THE BACKUP To abort an ongoing FSE backup process, you need to abort the backup job. In certain cases, aborting the fsebackup command itself is also required. Perform the steps:

1. Run the fsejob ––abort command to abort the FSE backup job. At the command line, you must specify the backup job ID. For details, see the fsejob man page.

2. In the window where fsebackup was invoked, press CTRL+C to abort fse-

backup.

Note:

This step is not required if tape was speciﬁed as the only backup destination, and the FSE backup job was waiting for resources at the moment you aborted it.

HP StorageWorksFileSystemExtenderSoftware CLI reference

2.2 NAME 19

2.2.3 OPTIONS

• –f, – –ﬁle

Perform FSE backup and copy the backup image to disk or both backup destinations: disk and tape. With disk destination, location and ﬁlename of the backup image ﬁle are deﬁned by the argument BackupFileName. With tape destination, the backup image is written to a medium that belongs to the backup FSE media pool:

– if the ––medium option is not speciﬁed, the backup image is written

to the ﬁrst available medium;

– if the ––medium option is speciﬁed, the backup image is written to

the medium with barcode Barcode.

If this medium already contains backup images from previous FSE backup sessions, the new backup image is appended to the existing backup image set. If – –ﬁle and BackupFileName are omitted from the fsebackup invoca- tion, the backup image is copied to tape only.

IMPORTANT: If both backup destinations are selected (the – –ﬁle option is speciﬁed without the additional – –nomedia option), and the backup image cannot be copied to tape for some reason (FSE media pool is not conﬁgured, all backup FSE media are full, the backup FSE medium speciﬁed by the options ––media Barcode is full), the backup session as a whole will fail. However, the actual backup process will partially succeed and the backup image will be copied to disk. In the opposite case, when the backup image cannot be copied to disk for some reason, the backup process will fail completely and the backup image will neither be copied to tape.

• BackupFileName Name of the ﬁle in which FSE backup image will be stored. The name can

contain absolute or relative path. On Windows systems, paths to shares in the UNC format are also supported. If the character "." (a dot) is speciﬁed at the end of BackupFileName, the ﬁlename is automatically constructed from name of the host on which fsebackup is run and the current timestamp. The following template is used for automatic generation: <HostName>– <YYYY><MM><DD>–<hh><mm><ss>.tar.bz2. The .tar.bz2 extension is also appended to the ﬁlename if the speciﬁed ﬁlename does not already include it.

HP StorageWorksFileSystemExtenderSoftware CLI reference

2.2 NAME 20

• ––nomedia Do not copy the backup image to tape, but only create backup image ﬁle on

disk. This option can only be used in combination with the – –ﬁle option, and cannot be used in combination with the – –medium option.

• –m, – –medium Perform FSE backup and copy the backup image to tape medium with bar-

code Barcode. Copying will fail if any of the following conditions are true:

– medium does not belong to the backup FSE media pool or does not

exist,

– medium is marked as unreliable or unusable, – medium does not have enough free storage space for the backup image

(the additional option ––init was not speciﬁed),

– medium does not have enough free storage space for the backup im-

age, but could not be initialized for some reason (the additional option ––init was speciﬁed).

If ––medium and Barcode are omitted from the fsebackup invocation, and the ––nomedia option is not speciﬁed, the backup image is copied to the ﬁrst available backup FSE medium. This option cannot be used in combination with the ––nomedia option.

• Barcode The alphanumeric string that identiﬁes the FSE medium to which the

backup image will be copied.

• –i, – –init If there is not enough free storage space, initialize the medium with barcode

Barcode before copying the backup image to it. This option can only be used in combination with the – –medium option.

• –h, – –help Print the usage information for this FSE command.

• –v, – –version Print the copyright and version information for this FSE command.

HP StorageWorksFileSystemExtenderSoftware CLI reference

2.2 NAME 21

2.2.4 EXAMPLES

• Perform backup and copy the backup image to tape medium in the backup FSE media pool:

fsebackup

• Perform backup and copy the backup image to the ﬁle backup_image_ﬁle.tar.bz2 in the current directory on a local disk volume and to tape

medium in the backup FSE media pool:

fsebackup –f backup_image_ﬁle.tar.bz2

• Perform backup and copy the backup image to a ﬁle in the current directory on the local disk volume. Name of the backup image ﬁle is automatically constructed according to the template:

fsebackup ––ﬁle . – –nomedia

• Perform backup and copy the backup image to the ﬁle backup_image_ﬁle.tar.bz2 in the directory /mnt/backup/ on a disk volume, which may be

located on a local or remote disk, depending on NFS conﬁguration on the FSE server (on Linux systems):

fsebackup –f /mnt/backup/backup_image_ﬁle.tar.bz2 ––nomedia

• Perform backup and copy the backup image to the ﬁle on a local or remote disk share, speciﬁed by UNC string \\backup–server\backup_- share\backup_image.tar.bz2, and to tape medium in the backup FSE media pool (on Windows systems):

fsebackup ––ﬁle \\backup–server\backup_share\backup_image.tar.bz2

• Perform backup and copy the backup image to tape medium with barcode bkp_med_02 in the backup FSE media pool. Initialize the medium before copying, if there is not enough storage space left on the medium:

fsebackup ––medium bkp_med_02 –i

• Perform backup and copy the backup image to the ﬁle backup_image_ﬁle.tar.bz2 in the current directory on a local disk volume and to tape medium with barcode bkp_med_10 in the backup FSE media pool:

fsebackup –f backup_image_ﬁle.tar.bz2 –m bkp_med_10

HP StorageWorksFileSystemExtenderSoftware CLI reference

2.2 NAME 22

2.2.5 FILES

• /opt/fse/newconﬁg/backup.cfg (on Linux systems) Template for FSE backup conﬁguration ﬁle.

• /etc/opt/fse/backup.cfg (on Linux systems) FSE backup conﬁguration ﬁle.

• /var/opt/fse/log/backup.log (on Linux systems), %InstallPath%\var\log\backup.log (on Windows systems) Log ﬁle with information about activity of the FSE backup process.

• /var/opt/fse/log/fse.log (on Linux systems), %InstallPath%\var\log\fse.log (on Windows systems) FSE event log ﬁle. You can use it to determine the required backup window.

• /var/opt/fse/log/error.log (on Linux systems), %InstallPath%\var\log\error.log (on Windows systems) FSE error log ﬁle.

• backup/var/opt/fse/lock/backup.pid (on Linux systems), %InstallPath%\var\lock\backup.pid (on Windows systems) FSE backup lock ﬁle.

2.2.6 COPYRIGHT

2.2.7 SEE ALSO

fserestore(8), fserecover(8), fseintro(7).

HP StorageWorksFileSystemExtenderSoftware CLI reference

2.3 NAME 23

2.3 NAME

fsebak:

Suspend all HSMDBs and FSCs to achieve a consistent state of these FSE databases to allow eventual copying.

2.3.1 SYNOPSIS

fsebak ––suspend fsebak ––continue StatusCode fsebak {–h | ––help} fsebak {–v | ––version}

2.3.2 DESCRIPTION

COMMON USAGE The fsebak command affects core FSE components. It

should be used with a maximum care as its usage can lead to improper FSE system operation or no operation at all. FSE administrator has to know exactly what he is doing when using this command. fsebak is primarily meant to be used by the FSE support personnel.

INTERNAL COMMAND OPERATION fsebak prepares Hierarchical Storage Management Databases (HSMDBs) and File System Catalogs (FSCs) of all conﬁgured FSE partitions for an eventual copying. To achieve database consistency, operation of all currently running Partition Managers has to be temporarily suspended. Duplicate copies of HSMDBs and FSCs can then be created using other system commands. After copying Partition Managers are unblocked using fsebak once again. This action restores the normal FSE system operation.

Each FSE command communicates with the FSE system components through the Management Interface (fse–mif). To execute an FSE command, the Management Interface must be running. If the connection to the Management Interface fails, check its status by running the fse status command. In case the Management Interface is not running, start it with the fse start command. Additionally, the

HP StorageWorksFileSystemExtenderSoftware CLI reference

2.3 NAME 24

Partition Manager processes (fse–pm) for all conﬁgured FSE partitions must be running. This can be checked with the fsesystem command.

After successful command execution, fsebak notiﬁes the FSE administrator with a suitable message, which is printed to the standard output stream (stdout). If there was an error during command execution, an appropriate error message is printed to the standard error stream (stderr).

ACHIEVING THE FSE DATABASE CONSISTENCY fsebak – –suspend

follows for each running Partition Manager the following procedure:

• block the incoming job requests in Partition Manager;

• make the corresponding HSMDB and FSC incorporate all changes from their transaction logs into the main database ﬁles;

• write temporary ﬁles hsm.ref and fsc.ref with references to HSMDBs and FSCs for use with the – –continue option;

• report action success or failure.

Note:

Contents of hsm.ref and fsc.ref ﬁles should not be directly altered in any way.

If all these steps are successfully completed, duplicate copies of HSMDBs and FSCs can be made.

RESUMING NORMAL FSE SYSTEM OPERATION fsebak ––continue

StatusCode follows for each running Partition Manager the following procedure:

• read references to HSMDBs and FSCs from ﬁles hsm.ref and fsc.ref) and delete these two ﬁles;

• start accepting incoming job requests in Partition Manager and resume normal operation.

If the value 0 (zero) is used in place of the StatusCode argument, all old transaction log ﬁles of HSMDBs and FSCs are removed, as the assumption is they will not be needed any more. If any other value is used as the StatusCode, these transaction logs are preserved for a potential future use.

HP StorageWorksFileSystemExtenderSoftware CLI reference

2.3 NAME 25

2.3.3 OPTIONS

• ––suspend Prepare each HSMDB and FSC for copying to another location. This ac-

tion temporarily suspends the normal FSE system operation in all running Partition Managers. See DESCRIPTION for details of this operation.

• ––continue Unblock the FSE system operation using the value StatusCode. This en-

ables the incoming job requests in all running Partition Managers and restores the normal FSE system operation.

• StatusCode The status code, which is used with the option – –continue. See section

DESCRIPTION for an explanation of the meaning and proper usage of this value.

• –h, – –help Print the usage information for this FSE command.

• –v, – –version Print the copyright and version information for this FSE command.

2.3.4 EXAMPLES

• Suspend the normal FSE system operation, including HSMDBs and FSCs:

fsebak ––suspend

• Resume the normal FSE system operation after HSMDBs and FSCs were suspended:

fsebak ––continue 0

• Resume the normal FSE operation after HSMDBs and FSCs were suspended, but preserve the HSMDB and FSC transaction log ﬁles for an optional future use:

fsebak ––continue 1

HP StorageWorksFileSystemExtenderSoftware CLI reference

2.3 NAME 26

2.3.5 COPYRIGHT

2.3.6 SEE ALSO

fse(8), fsesystem(8), fseintro(7).

HP StorageWorksFileSystemExtenderSoftware CLI reference

2.4 NAME 27

2.4 NAME

fsecheck:

Perform an HSM ﬁle system consistency check against the File System Catalog or a File System Catalog consistency check against the FSE media.

2.4.1 SYNOPSIS

fsecheck {–i | ––fsc–hsmfs} PartitionName fsecheck {–m | – –fsc–media} {PartitionName | {–B | – –barcode} Barcode...

[{–V | – –volume} VolumeNumber...]} [– –autocorrect [––match–media]] fsecheck {–h | ––help} fsecheck {–v | ––version}

2.4.2 DESCRIPTION

After a successful command execution fsecheck notiﬁes the FSE administrator with a suitable message, which is printed to the standard output stream (stdout). If there was an error during the command execution, an appropriate error message is printed to the standard error stream (stderr).

CHECKING FILE SYSTEM CATALOG CONSISTENCY fsecheck command creates a maintenance job on the speciﬁed FSE partition. The maintenance job is executed by the corresponding Partition Manager and performs a File System Catalog consistency check. The process can perform two types of consistency checks: it can either compare ﬁle entries which are present in File System Catalog with Fast Recovery Information (FRI) on the corresponding FSE media, or compare ﬁles on an HSM ﬁle system with entries in the corresponding File System Catalog. It detects the situations, where:

HP StorageWorksFileSystemExtenderSoftware CLI reference

2.4 NAME 28

• some ﬁles that are present on the HSM ﬁle system or on the FSE media are missing from File System Catalog,

• it is uncertain for some recently created ﬁles on the HSM ﬁle system, if they are missing from File System Catalog or are too new to have their ﬁle ID recorded in File System Catalog yet.

fsecheck reports the consistency check ﬁndings to the shell output. These ﬁndings are also recorded in the FSE check log (see section FILES).

Note:

The maintenance job for the consistency check of an HSM ﬁle system against the corresponding File System Catalog keeps track of its progress. If it is aborted with the fsejob command and later re–run with fsecheck, it resumes its operation from the interruption point on.

fsecheck command also offers automatic correction, which can be enabled as an addition to the comparison of File System Catalog against FSE media. The correction procedure updates File System Catalog with missing information about ﬁle splits that has been found in Fast Recovery Information on FSE media. It can also remove the File System Catalog entries that have not been found in the belonging Fast Recovery Information blocks on FSE media. An entry in this context means information about the location on the FSE media of any of the following: ﬁle generation, ﬁle copy, ﬁle split.

2.4.3 OPTIONS

• –i, – –fsc–hsmfs Perform a consistency check on the FSE partition PartitionName compar-

ing an HSM ﬁle system against the corresponding File System Catalog. For details on this process, see section CHECKING FILE SYSTEM CATA- LOG CONSISTENCY.

• PartitionName The name of the FSE partition to perform consistency check for.

HP StorageWorksFileSystemExtenderSoftware CLI reference

2.4 NAME 29

• –m, – –fsc–media Perform a consistency check on the FSE partition PartitionName comparing

the corresponding File System Catalog against the associated FSE media. For details on this process, see section CHECKING FILE SYSTEM CAT- ALOG CONSISTENCY.

• ––autocorrect Automatically correct errors discovered by the consistency check of File

System Catalog against corresponding FSE media. For details on this process, see section CHECKING FILE SYSTEM CATALOG CONSIS-

TENCY. This option can only be used in combination with the ––fsc– media option.

• ––match–media Correct the errors by removing the entries that have been found only in the

File System Catalog and not in the Fast Recovery Information blocks on the FSE media. This type of correction further synchronizes the FSC content with the data actually present on the media. For details on this process, see section CHECKING FILE SYSTEM CATALOG CONSISTENCY. This option can only be used in combination with the ––autocorrectoption.

• –B, – –barcode Perform a consistency check on the FSE partition PartitionName comparing

corresponding File System Catalog against the FSE media speciﬁed in the

Barcode argument. For details on this process, see section CHECKING FILE SYSTEM CATALOG CONSISTENCY. This option can only be

used in combination with the – –fsc–media option.

• Barcode... A sequence of identiﬁers of the FSE media that are being checked. In most

cases, identiﬁers are numerical barcodes. With disk media, identiﬁers are relative parts of the disk media mount points (for example: dm_001, dm_-

002). Note that the following limitations apply:

– media that are unavailable will not be processed. – media that are speciﬁed in the command line must belong to the same

FSE partition. In the opposite case, the fsecheck command will fail.

HP StorageWorksFileSystemExtenderSoftware CLI reference

2.4 NAME 30

• –V, – –volume Limit the consistency check to the FSE medium volumes listed in the

VolumeNumber argument. This option can only be used in combination with the ––barcode option, and cannot be used if more than one medium is

speciﬁed in Barcode....

• VolumeNumber... A non–negative integer value or a sequence of such values which repre-

sent(s) the position(s) of FSE medium volume(s) on the medium layout. Note that the following limitation applies:

– medium volumes that are unavailable will not be processed.

• –h, – –help Print the usage information for this FSE command.

• –v, – –version Print the copyright and version information for this FSE command.

2.4.4 EXAMPLES

• Trigger a File System Catalog consistency check against HSM ﬁle system of the FSE partition daily_reports:

fsecheck ––fsc–hsmfs daily_reports

• Trigger a File System Catalog consistency check against FSE media assigned to the FSE partition archive_part_32:

fsecheck ––fsc–media archive_part_32

• Trigger a File System Catalog consistency check against FSE media assigned to the FSE partition archive_part_45. Enable automatic correction:

fsecheck ––fsc–media – –autocorrect archive_part_45

• Trigger a File System Catalog consistency check against FSE media assigned to the FSE partition temp_partition. Enable extended automatic correction:

fsecheck ––fsc–media – –autocorrect – –match–media temp_partition

HP StorageWorksFileSystemExtenderSoftware CLI reference

+ 85 hidden pages