HP StorageWorks File System Extender Command Reference Guide

HP StorageWorks

File System Extender 3.2

Command Line Reference

First Edition (December 2005)

Part Number: T3648-96003

CONTENTS 1

Contents

1 FSE command index 1

2 FSE command documentation 2

1 FSE command index

1.1 List of FSE commands

FSE command-line interface includes the following commands:

fse 2 fsebackup 11 fsebak 17 fsecheck 22 fsedrive 26 fseﬁle 32 fsejob 41 fselibrary 47 fsemedium 54 fsepartition 66 fsepool 77 fserecover 84 fserestore 88

File System Extender 3.2 Command Line Reference

2 FSE command documentation 2

fsesystem 91

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. Prepare FSE system for the restore process. Conﬁgure mount points for HSM ﬁle systems (on Windowssystems only). Enable or disable Limited Access Mode for a particular HSM ﬁle system (on Windows systems only).

2.1.1 SYNOPSIS

fse ––start fse ––stop fse ––restart fse ––status fse ––startrestore fse ––mount MountPoint VolumeName fse ––umount MountPoint VolumeName fse ––dismount–ntfs VolumeName fse ––limit–access VolumeName fse ––full–access VolumeName

2.1.2 DESCRIPTION

The fse command (startup script on Linux, 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 all. FSE administrator has to know exactly what he is doing when using this command.

File System Extender 3.2 Command Line Reference

2.1 NAME 3

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

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

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

• print status information for the conﬁguration–independent FSE processes (FSE daemons) running on FSE system (FSE server, FSE client),

• prepare the FSE system for the restore process,

• 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.

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, 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.

STAND–ALONE AND DISTRIBUTED FSE SYSTEMS It is possible to either set up an FSE system on a stand–alone machine 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 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 are:

File System Extender 3.2 Command Line Reference

2.1 NAME 4

• 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 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. The daemon binary names are listed in the following table.

-------------------------------------------| PROCESS | FSE DAEMON |

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

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

POST–START AND PRE–STOP SCRIPTS FSE administrator can set up two helper scripts which perform certain automated tasks at the FSE system’s (FSE server’s, FSE client’s) start–up 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 Windowssystems) on a local machine, and have to be named as speciﬁed below:

File System Extender 3.2 Command Line Reference

2.1 NAME 5

• 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 FSE ﬁle systems with an entry in the /etc/fstab ﬁle (on Linux systems) or all existing FSE ﬁle systems with a deﬁned mount point (on Windows systems) have been mounted, i.e. right after the FSE system 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 system 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.

2.1.3 OPTIONS

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

executed on a stand–alone FSE system or in a distributed FSE system on FSE server or FSE client.

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

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

2. initiates the FSE system 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),

File System Extender 3.2 Command Line Reference

2.1 NAME 6

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 system, 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 system, 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.

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

command is executed. If used on a stand–alone 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 system 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).

File System Extender 3.2 Command Line Reference

2.1 NAME 7

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 invocation of the fse stop

and fse start commands.

Note:

In a distributed FSE system, 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.

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

independent FSE (server, client) process. See FSE PROCESSES for FSE daemon status info details.

• ––startrestore Prepare the FSE system for the restore process. This option puts the FSE

system in the special "restore" mode in order to disable usage of the HSM ﬁle systems; the way it achieves this is different according to the operating system.

Linux systems: on a Linux system, the fse – –startrestore command starts up all local FSE processes except the HSM File System Event Manager. Also the HSM ﬁle systems are not mounted in this mode.

Windows systems: on a Windows system, the fse ––startrestore command starts up all local FSE processes, but mounts the HSM ﬁle systems as ordinary NTFS ﬁle systems.

Note that you should invoke the fse ––startrestorecommand only when the local FSE processes are stopped. You must invoke it on each component of the FSE system that you want to restore, that is before running fserestore.

• ––mount

File System Extender 3.2 Command Line Reference

2.1 NAME 8

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

used by the FSE administrator directly. It is called by fse–svc daemon during recovery of FSE ﬁle system.

Windows systems: 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 Ac- cess Mode to Limited Access Mode. See description of the – –limit–access option for information on Limited Access Mode.

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

NTFS volume will be mounted.

• VolumeName An NTFS volume that stores an HSM ﬁle system on a Windows client.

• ––dismount–ntfs Windows systems only: This option dismounts the newly formatted

NTFS volume VolumeName. It sends 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 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: This option switches the HSM FS ﬁlter operation

for managing 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

File System Extender 3.2 Command Line Reference

2.1 NAME 9

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, refer to File System Extender User146s Guide.

• ––full–access Windows systems only: This option switches the HSM FS ﬁlter operation

for managing 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, refer to File System Extender User146s Guide.

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}

File System Extender 3.2 Command Line Reference

2.1 NAME 10

2.1.5 FILES

On Linux systems:

• /opt/fse/sbin/post_start.sh The post–start helper script.

• /opt/fse/sbin/pre_stop.sh The pre–stop helper script.

On Windows systems:

• %InstallPath%\bin\post_start.cmd The post–start helper script.

• %InstallPath%\bin\pre_stop.cmd The pre–stop helper script.

2.1.6 COPYRIGHT

2.1.7 SEE ALSO

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

File System Extender 3.2 Command Line Reference

2.2 NAME 11

2.2 NAME

fsebackup – Back up FSE system state to the backup media.

2.2.1 SYNOPSIS

fsebackup {–m | – –media} Barcode... [{–c | – –client} [Client...]] [– –skip– hsmfs] [{–l | ––log–ﬁle} LogFileName]

fsebackup {–h | ––help}

2.2.2 DESCRIPTION

Backup of the FSE system is performed in such a way that it preserves a consistent state of information stored in FSE databases, FSE system ﬁles and user data on HSM ﬁle systems. Its operation was designed to obstruct normal FSE system operation to as little extent as possible.

There are three levels of backup:

• Server backup It will backup all the required databases stored on FSE server, but will not

backup any data on FSE clients (HSM ﬁle system and Hierarchical Storage Management Database (HSMDB)). HSM ﬁle system can be recovered from File System Catalog (FSC) with fserecover command. This is the fastest and preferred way of doing backup.

• Full backup It will backup all the required databases stored on FSE server and all FSE

clients. It is possible to recover the whole FSE system (server & clients) by doing restore.

• Single client backup It will backup all the required databases stored on FSE server and speciﬁc

FSE client. It is possible to recover the FSE server and speciﬁc client by doing restore, while other clients would require running fserecover command to recover HSM ﬁle system.

File System Extender 3.2 Command Line Reference

2.2 NAME 12

PREREQUISITES FSE backup uses logical volume snapshot technology to

keep FSE system’s operation almost unobstructed during the backup window. To be able for the FSE backup to use this technology, HSM ﬁle systems, FSE conﬁguration and all FSE databases and system ﬁles have to reside on LVM logical volumes (on Linux systems) or special snapshot software needs to be installed (on Windows systems). This is an essential prerequisite.

FSE backup uses FSE backup media – FSE media that are assigned to a special media pool, distinguished by its BACKUP type. A backup pool should be conﬁgured with only one volume in order to use all the space on medium. Backup media in this pool should be formatted, but not initialized. If the backup encounters an initialized FSE medium, it will return an error. This is applied to prevent loss of data. For details on conﬁguring an FSE backup media pool, see the fsepool man page.

IMPORTANT: It is an FSE administrator’s responsibility to dedicate correct backup media for each backup session. fsebackup does not keep record of which backup media had already been used for backup and when. It will only check if media with the speciﬁed barcodes are assigned to FSE backup media pool before proceeding. It is also suggested to keep at least two backup sets in order to ensure that you have always at least one valid backup.

THE BACKUP PROCEDURE After the prerequisites are checked and fulﬁlled, fsebackup ﬁrst suspends the FSE system and achieves a consistent state of all File System Catalogs (FSCs) and Hierarchical Storage Management Databases (HSMDBs). It then creates snapshots of all required disk volumes (/var/opt/fse and /var/opt/fse/part on Linux and appropriate disk on Windows) before resuming the FSE system operation. Suspend and resume operations are performed using the fsebak command. Once the snapshots are successfully created the backup can continue.

All relevant data is gathered together and archived using tar tape archiving utility on Linux and proprietary FSE tool on Windows (fse–arch). It is then written to the FSE backup media in form of severalarchive ﬁles, separated with ﬁle marks. First archives on the medium are client speciﬁc data (HSM ﬁle system and HSMDB). This is followed by File System Catalog archives for each FSE partition, then the Conﬁguration Database (conﬁguration information for FSE system, FSE libraries, FSE drives, FSE media pools and FSE partitions, the Resource Management Database, Fast Recovery Information (FRI) in temporary disk ﬁles and

File System Extender 3.2 Command Line Reference

2.2 NAME 13

global conﬁguration (backup, trace and CORBA/omniORB conﬁguration ﬁles). Ofﬂine ﬁles on HSM ﬁle system are backed up as sparse ﬁles. These ﬁles practically do not occupy any space on backup medium.

FSE backup usually runs in background, started automatically by cron or similar utilities. A special lock ﬁle backup.pid is used to preventstarting multiple backup processes in parallel.

ACTIVITY LOGGING FSE administrator usually consults the fse.log ﬁle to ﬁgure out backup start and stop times. These times are used to estimate the required backup window. Additionally, fsebackup records its progress report to the backup.log ﬁle (see section FILES). When backup successfully ﬁnishes, it reports barcodes of the FSE backup media the backup data had been written to.

CONFIGURATION On Linux, administrator needs to conﬁgure some parameters in backup.cfg conﬁguration ﬁle. The conﬁgurable parameters and their default values are the following:

• HSM_LV_VAR = hsm_vg/var Name of the LVM volume group and the LVM logical volume used to store

ﬁle system for the /var/opt/fse mount point.

• HSM_LV_PART = hsm_vg/part Name of the LVM volume group and the LVM logical volume used to store

ﬁle system for the /var/opt/fse/part mount point.

• 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 FSE backup process.

2.2.3 OPTIONS

• –m, – –media

File System Extender 3.2 Command Line Reference

2.2 NAME 14

Perform backup of the FSE server. Record the backup image data on one or

more FSE media with barcode(s) Barcode....

• Barcode... A sequence of barcodes of the FSE media which are used to store backup

image data. The media barcodes have to be separated by spaces.

• –c, – –client Perform a backup of FSE clients or if speciﬁc client hostname is speciﬁed

by the Client... argument just speciﬁc client. This option may only be used together with the ––media option.

• Client... A sequence of fully–qualiﬁed domain names (FQDN) of the FSE clients

which are backed up. FQDNs have to be separated by spaces.

• ––skip–hsmfs Do not perform a backup of HSM ﬁle system. This option may only be used

together with the ––media option.

• –l, – –log–ﬁle Log FSE backup activity into ﬁle LogFileName. FSE backup activity is

normally logged into the default FSE backup log ﬁle. This option may only be used together with the – –media option.

• LogFileName File name (with optional path) of the additional backup activity log which

will record the progress of the FSE backup process.

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

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

File System Extender 3.2 Command Line Reference

2.2 NAME 15

2.2.4 EXAMPLES

• Backup current FSE server state to FSE media with barcodes 000123, 000124 and 000125:

fsebackup ––media 000123 000124 000125

• Backup current FSE server state and all FSE clients to FSE media with barcodes 000123, 000124 and 000125:

fsebackup ––media 000123 000124 000125 – –client

• Backup current FSE server state to FSE medium with barcode 000202. Write additional backup log to ﬁle /tmp/backup_000202.log:

fsebackup ––media 000202 –l /tmp/backup_000202.log

• Backup current state of an FSE server and FSE clients fseclient_98.hp.com, fseclient_99.hp.com to FSE medium with barcode 000300:

fsebackup –m 000300 –c fseclient_98.hp.com fseclient_99.hp.com

2.2.5 FILES

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

• /etc/opt/fse/backup.cfg (Linux systems–speciﬁc) 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 recorded information about activity of the FSE backup pro-

cess.

• /var/opt/fse/log/fse.log (on Linux systems), %InstallPath%\var\log\fse.log (on Windows systems) FSE event log ﬁle. It is used for measuring the required backup window.

File System Extender 3.2 Command Line Reference

2.2 NAME 16

• /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), fsebak(8), fserecover(8), fseintro(7).

File System Extender 3.2 Command Line Reference

2.3 NAME 17

2.3 NAME

fsebak – Achieve a consistent state of all HSMDBs and FSCs to allow an eventual

back–up creation.

2.3.1 SYNOPSIS

fsebak ––suspend fsebak ––continue StatusCode fsebak ––reserve–medium Barcode fsebak ––change–medium Barcode JobIOR fsebak ––complete–job JobIOR fsebak {–h | ––help} fsebak {–v | ––version}

2.3.2 DESCRIPTION

COMMON USAGE fsebak command affects the core FSE components. Its

primary usage is from inside the fsebackup command and not as a stand–alone tool, except on request of the FSE support personnel. In case of the latter, it should be used with a maximum care as its usage can lead to improper FSE system operation or no operation at all.

INTERNAL COMMAND OPERATION fsebak prepares Hierarchical Storage Management Databases (HSMDB) and File System Catalogs (FSC) of all conﬁgured FSE partitions for an eventual back–up procedure. To achieve such a database consistency, operation of all currently running Partition Managers has to be temporarily suspended. Duplicate copies of HSMDBs and FSCs may then be created using other system commands. After a successful back–up creation 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

File System Extender 3.2 Command Line Reference

2.3 NAME 18

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 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’s 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 HSMDB and FSC for use with the – –continue option;

• report action success or failure.

Note:

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

If all these steps were successfully completed, duplicate copies of HSMDB and FSC can be made. Usually they are created with the fsebackup command. See the fsebackup man page for details.

RESUMING A NORMAL FSE SYSTEM OPERATION fsebak––continue

StatusCode follows for each running Partition Manager the following procedure:

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

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

File System Extender 3.2 Command Line Reference

2.3 NAME 19

If the FSE administrator made sure that the HSMDB and FSC back–ups are stored on a safe medium, (s)he is advised to use value 0 (zero) in place of the StatusCode argument. This value means that all old transaction log ﬁles of HSMDBs and FSCs will be removed, as they are not needed any more. If any other value is used as the StatusCode, these transaction logs will be preserved and optionally used again, if needed.

2.3.3 OPTIONS

• ––suspend Prepare each HSMDB and FSC for backing up. This action temporarily sus-

pends 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 DESCRIP-

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

• ––reserve–medium Create a new administrative job for a backup purpose, print the interopera-

ble object reference of the job and the name of the devicewhere the back–up archive will be written. The administrative job is a dummy job: it only allocates an FSE medium with the speciﬁed barcode Barcode from an FSE backup media pool and loads it into a free FSE drive. It then prints the device name of this FSE drive.

• Barcode Barcode of the FSE medium, which will be used to store the back–up

archive. This medium has to be assigned to an FSE backup media pool.

• ––change–medium

File System Extender 3.2 Command Line Reference

2.3 NAME 20

Allocate a new FSE medium to store the back–up archive. Usage of this option causes the job with the interoperable object reference JobIOR to unload the currently allocated FSE medium from the FSE drive, release it, allocate the FSE medium with the speciﬁed barcode Barcode from an FSE backup media pool and load it into the same FSE drive. Usage of this option is necessary if the previously reserved medium has not enough free space to store the whole back–up archive.

• JobIOR The interoperable job reference, which is used as an "address" of the job in

the CORBA Naming Service daemon. It is represented as a 160–byte text string, beginning with the preﬁx IOR:.

• ––complete–job Complete the administrativejob with the interoperable object reference Job-

IOR and release the currently allocated FSE medium.

• –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 and prepare HSMDBs and FSCs for backing up:

fsebak ––suspend

• Resume the normal FSE system operation after back–ups of the FSE databases and system ﬁles were successfully created:

fsebak ––continue 0

• Resume the normal FSE operation after back–ups of all FSE databases and system ﬁles were created, but preserve the HSMDB and FSC transaction log ﬁles for an optional future use:

fsebak ––continue 1

File System Extender 3.2 Command Line Reference

2.3 NAME 21

• Create an administrative job. Allocate the FSE medium with the barcode backup–003 for a back–up procedure and load it into an FSE drive:

fsebak ––reserve–medium backup–003

• Release the currently allocated FSE medium for administrative job with the interoperable object reference IOR:010000000e00... (160–byte text string), unload it, allocate the new FSE medium with the barcode backup–105 and load it into the same FSE drive:

fsebak ––change–medium backup–105 IOR:010000000e00...

• Complete the administrative job with the interoperable object reference IOR:010000000a00... (160–byte text string) and release the allocated FSE medium:

fsebak ––complete–job IOR:010000000a00...

2.3.5 COPYRIGHT

2.3.6 SEE ALSO

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

File System Extender 3.2 Command Line Reference

2.4 NAME 22

2.4 NAME

fsecheck – Perform a File System Catalog consistency check against the HSM ﬁle

system or FSE media.

2.4.1 SYNOPSIS

fsecheck {–i | ––fsc–hsmfs} PartitionName fsecheck {–m | – –fsc–media} [– –autocorrect [– –match–media]] Partition-

Name

fsecheck {–h | ––help} fsecheck {–v | ––version}

2.4.2 DESCRIPTION

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.

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 CONSISTENCY OF THE FILE SYSTEM CATALOG 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. This is a process of comparing ﬁle entries, which are present in File System Catalog, either with ﬁles on the corresponding HSM ﬁle system or with Fast Recovery Information (FRI) on the corresponding FSE media. It detects the situations, where:

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

File System Extender 3.2 Command Line Reference

2.4 NAME 23

• 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 the File System Catalog against HSM ﬁle system 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 comparing

corresponding File System Catalog against the associated FSE ﬁle system. See CHECKING FILE SYSTEM CATALOG CONSISTENCY for de- tails on this process.

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

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

corresponding File System Catalog against the associated FSE media. See CHECKING FILE SYSTEM CATALOG CONSISTENCY for details on this process.

File System Extender 3.2 Command Line Reference

2.4 NAME 24

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

System Catalog against corresponding FSE media. See CHECKING FILE SYSTEM CATALOG CONSISTENCY for details on this process. This option may only be used together 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. See CHECKING FILE SYSTEM CATALOG CONSISTENCY for details on this process. This option may only be used together with the – –autocorrect option.

• –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 autocorrection:

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 autocorrection:

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

File System Extender 3.2 Command Line Reference

2.4 NAME 25

2.4.5 FILES

• /var/opt/fse/log/check_hsmfs_fsc_<PartitionName> (on Linux systems), %InstallPath%\var\log\check_hsmfs_fsc_<PartitionName> (on Win-

dows systems) Log ﬁle with recorded ﬁndings of the consistency check of the File System

Catalog against the HSM ﬁle system.

• /var/opt/fse/log/check_media_fsc_<PartitionName>.log (on Linux sys- tems),

%InstallPath%\var\log\check_media_fsc_<PartitionName> (on Win- dows systems)

Log ﬁle with recorded ﬁndings of the consistency check of the File System Catalog against the FSE media.

2.4.6 COPYRIGHT

2.4.7 SEE ALSO

fserecover(8), fseintro(7).

File System Extender 3.2 Command Line Reference

2.5 NAME 26

2.5 NAME

fsedrive – Manage conﬁguration of the FSE drives.

2.5.1 SYNOPSIS

fsedrive {–a | – –add} ConﬁgFileName fsedrive {–r | – –remove} Name [–F | ––force] fsedrive {–s | – –show} Name [RevisionNumber | {–H | – –history}] fsedrive {–m | – –modify} Name ConﬁgFileName fsedrive {–l | – –list} [–D | – –detail] fsedrive ––disable Name [–F | ––force] fsedrive ––enable Name fsedrive {–h | – –help} fsedrive {–v | – –version}

2.5.2 DESCRIPTION

This FSE command manages conﬁguration of the FSE drives. It is used to perform these FSE administrator’s tasks:

• conﬁgure a new or remove an existing FSE drive,

• retrieve the conﬁguration of an existing FSE drive,

• reconﬁgure an existing FSE drive,

• list conﬁgured drives in the FSE installation,

• disable or enable operation of an FSE drive.

File System Extender 3.2 Command Line Reference

2.5 NAME 27

check its status by running the fse status command. In case the Management Interface is not running, start it with the fse start command.

After a successful command execution fsedrive 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).

2.5.3 OPTIONS

• –a, – –add Conﬁgure a new FSE drive with parameters, written in the conﬁguration ﬁle

ConﬁgFileName. This action checks the validity of the conﬁguration ﬁle, copies the ﬁle to Conﬁguration Database and inserts the parameter values into Resource Management Database. FSE drive names are unique within the FSE installation.

• ConﬁgFileName The name of the FSE drive conﬁguration ﬁle to use.

• –r, – –remove Remove an existing FSE drive from the FSE system. This includes re-

moval of all conﬁguration ﬁle revisions of this FSE drive from Conﬁguration Database. Note that unless additional option ––force is speciﬁed, the command demands FSE administrator’s conﬁrmation before performing this operation. Default answer to the conﬁrmation question is "No".

• Name The name of the FSE drive to manage conﬁguration for.

• –F, – –force Set forced mode for FSE drive remove or disable operation. In this mode,

FSE administrator’s conﬁrmation of FSE drive removal or disabling is skipped. The command treats it as if FSE administrator would have answered the conﬁrmation question with "Yes". This option may only be used together with the ––remove or ––disable option.

File System Extender 3.2 Command Line Reference

2.5 NAME 28

• –s, – –show If the RevisionNumber argument is given, print the appropriate conﬁgu-

ration revision for the FSE drive Name, otherwise print the conﬁguration revision in–use.

• RevisionNumber A non–negative integer value which represents the conﬁguration revision to

print.

• –H, – –history Print conﬁguration history depth for the FSE drive Name. Conﬁguration

history depth is the number of the conﬁguration ﬁle revisions which are stored in Conﬁguration Database for this FSE drive. This option may only be used together with the – –show option.

• –m, – –modify Modify the conﬁguration of FSE drive Name with the conﬁguration ﬁle

ConﬁgFileName. This action checks the validity of the new conﬁguration ﬁle, copies it to Conﬁguration Database as a new conﬁguration revision and triggers the FSE drive reconﬁguration.

• –l, – –list Display status information for conﬁgured FSE drives within the FSE instal-

lation. Reported information for an FSE drive includes:

1. Drive ... drive name,

2. Family ... drive family (AIT, SAIT, LTO),

3. Library ... name of the corresponding FSE library,

4. Host ... fully–qualiﬁed domain name (FQDN) of the host the drive is attached to,

5. CtrlDev ... drive control device ﬁle,

6. Status ... current drive status (online, in use, ofﬂine),

7. Medium ... barcode of the medium which is present in the drive (optional).

File System Extender 3.2 Command Line Reference

2.5 NAME 29

• –D, – –detail

Retrieve additional FSE drive information and display the retrieved data in the ParameterName: ParameterValue format with each parameter in its own line. The following additional information is reported:

1. VendorID ... ID string of the drive manufacturer,

2. ProductID ... ID string of the drive model,

3. SerialNo ... serial number of the drive,

4. FirmwareRev ... revision of the ﬁrmware the drive currently uses,

5. ScsiID ... ID string of the corresponding SCSI device,

6. Index ... index of the drive inside the FSE library,

7. UsageCount ... usage counter for the drive,

8. Capabilities ... code for the drive features,

9. Key ... internal RMDB key value assigned to the drive.

This option may only be used together with the – –list option.

• ––disable

Disable operation of FSE drive Name. Disabling the drive means putting it ofﬂine in case it needs cleaning or servicing. Note that unless additional option – –force is speciﬁed, the command demands FSE administrator’s conﬁrmation before performing this operation. Default answer to the conﬁrmation question is "No".

• ––enable

Enable operation of FSE drive Name, which is currently disabled. Enabling the drive means making it available to the FSE system again.

• –h, – –help

Print the usage information for this FSE command.

• –v, – –version

Print the copyright and version information for this FSE command.

File System Extender 3.2 Command Line Reference

+ 69 hidden pages