emc diskxtender file system manager for unix/linux release 3.4

EMC CorporationCorporate Headquarters:

Hopkinton, MA 01748-9103

1-508-435-1000www.EMC.com

EMC® DiskXtender®

File System Manager for UNIX/LinuxRelease 3.5

Administrator’s GuideP/N 300-009-573

REV. A01

EMC DiskXtender File System Manager for UNIX/Linux Release 3.5 Administrator’s Guide2

Copyright © 2004-2009 EMC Corporation. All rights reserved.

Published October 2009

EMC believes the information in this publication is accurate as of its publication date. The information issubject to change without notice.

THE INFORMATION IN THIS PUBLICATION IS PROVIDED “AS IS.” EMC CORPORATION MAKES NOREPRESENTATIONS OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION IN THISPUBLICATION, AND SPECIFICALLY DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY ORFITNESS FOR A PARTICULAR PURPOSE.

Use, copying, and distribution of any EMC software described in this publication requires an applicablesoftware license.

For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com.

All other trademarks used herein are the property of their respective owners.

EMC DiskXtender File System Manager for UNIX/Linux Release 3.5 Administrator’s Guide 3

Tables...................................................................................................................................7

Preface................................................................................................................................9

Chapter 1 IntroductionFile system-based storage management ........................................ 14

Files always available to applications......................................14Data management...................................................................... 14

Console-based administration ........................................................ 16Console Client ............................................................................ 16

Flexible topology............................................................................... 17Minimum topology ................................................................... 17Complex topology ..................................................................... 17Topology guidelines.................................................................. 18

Chapter 2 Console overviewConsole software............................................................................... 20

Console Server............................................................................ 20Console Agent ............................................................................ 20Console Client ............................................................................ 21

Management domain ....................................................................... 22Single computer domain............................................................22Multiple computer domain .......................................................23

Console Client ................................................................................... 24How to start Console Client ......................................................24

Administration .................................................................................. 26How to add a user ..................................................................... 26How to remove a user................................................................28

Contents


How to change your password ................................................ 28How to change a user's password............................................ 29

Monitoring......................................................................................... 30Clearing the events window ..................................................... 30Domain events ........................................................................... 31Domain activities ....................................................................... 32Host events ................................................................................. 34File system events...................................................................... 35File system activities ................................................................. 37File system state ......................................................................... 38

Chapter 3 File System ConfigurationPreliminary tasks .............................................................................. 44

Back-end module types ............................................................. 44Centera module preliminary tasks .......................................... 45FTP module preliminary tasks ................................................. 52NFS module preliminary tasks................................................. 54

Configuring a file system ................................................................ 57Overriding configuration for file system subsets .................. 57How to configure a file system................................................. 57Centera module ......................................................................... 64FTP module ................................................................................ 67NFS module................................................................................ 68

Viewing a file system configuration .............................................. 70Editing a file system configuration ................................................ 71Deleting a file system configuration .............................................. 72

Chapter 4 Extended RulesCreating an extended rule ............................................................... 74

Match string................................................................................ 74How to create an extended rule ............................................... 80

Viewing extended rules ................................................................... 86Editing an extended rule ................................................................. 87

How to edit an extended rule ................................................... 87Deleting an extended rule ............................................................... 88

How to delete an extended rule ............................................... 88Copying extended rules................................................................... 89

How to copy extended rules ..................................................... 89

Chapter 5 Scheduled JobsScheduled jobs overview ................................................................. 92

5EMC DiskXtender File System Manager for UNIX/Linux Release 3.5 Administrator’s Guide

Effect on existing file system settings ......................................93Delete Old Files job.................................................................... 94Prune job...................................................................................... 95

Creating a scheduled job.................................................................. 96How to create a scheduled job ..................................................96Viewing a scheduled job ............................................................98Editing a schedule...................................................................... 99Deleting a schedule.................................................................. 100

Time elements.................................................................................. 102Create a new time element ......................................................102Editing a time element .............................................................107Deleting a time element ...........................................................107

Chapter 6 Advanced UTDM Mount OptionsEMC Centera data retention .......................................................... 110

Performance impact..................................................................110Requirements............................................................................ 111Enabling EMC Centera data retention...................................111Setting retention for a file system ...........................................113Setting retention for a group of files ......................................114Restoring incremental backups...............................................115

Read-only ......................................................................................... 117Mounting read-only................................................................. 118

Direct-read........................................................................................ 120Memory-mapping.................................................................... 120Mounting direct-read ...............................................................121

Chapter 7 Backup and RecoveryWhat to back up............................................................................... 124

FSM-related files outside of UTDM file systems..................124Files and data in UTDM file systems .....................................125

Backup software .............................................................................. 126FSM-aware backup software...................................................127Other backup software.............................................................127Snapshot software.................................................................... 127

Recovering a lost file system ......................................................... 128Recovering an FTP module file system........................................ 130

How to recover an FTP module file system..........................130EMC NetWorker.............................................................................. 132

Requirements............................................................................ 132Backup with NetWorker software..........................................132


Recovery with NetWorker software ...................................... 133NetWorker 64-bit Linux version................................................... 136

Requirements ............................................................................ 136Backup........................................................................................ 137Recovery .................................................................................... 137

NetBackup software ....................................................................... 139NetBackup requirements......................................................... 139Backup with NetBackup software ......................................... 141Recovery with NetBackup software ...................................... 142

FSM tools.......................................................................................... 143Backup with FSM tools ............................................................ 143Recovery with FSM tools......................................................... 144

Snapshots with SnapView............................................................. 147Quiescing a UTDM file system............................................... 147Resuming UTDM file system activity ................................... 149Recovering a UTDM file system snapshot............................ 149

Import data from SM to FSM........................................................ 151

Chapter 8 MaintenanceProcesses .......................................................................................... 156

Core processes.......................................................................... 156Console processes.................................................................... 162

File administration.......................................................................... 164Manual migration, purge, and retrieval................................ 164

Periodic back-end system cleanup............................................... 167EMC Centera ............................................................................ 168Cleanup on FTP or NFS module back-end systems ............ 170

Appendix A Command referenceCommand quick reference ............................................................ 174Command usage ............................................................................. 177

Setting the DMAP_ROOT_PATH......................................... 177Setting the FSM environment ................................................ 177Administrative commands..................................................... 178File management commands ................................................. 191Backup and recovery commands .......................................... 196

Index............................................................................................................................... 207


Title Page

1 Tasks permitted for operators and administrators .................................... 272 Columns on the Events for All Hosts window ........................................... 323 Columns on the All FSM Activities window .............................................. 334 Columns on the Events windows ................................................................. 355 Columns on the Events windows ................................................................. 366 Columns on the Activities window.............................................................. 387 File System State window .............................................................................. 398 Purge tab on the File System State window ................................................ 409 Migrate tab on the File System State window............................................. 4010 Staging tab on the File System State window ............................................. 4011 Destroy tab on the File System State window............................................. 4112 Recover tab on the File System State window ............................................ 4113 Available back-end module types ................................................................ 4514 Choices for the Authentication Type field................................................... 5315 Determining path of back-end mount point when using Solaris zones.. 5516 Determining full path when using Solaris zones ....................................... 5817 Checksum setting choices .............................................................................. 5918 Retention Period settings ............................................................................... 6419 Descriptions of Collision Avoidance settings ............................................. 6620 Possible Keyword values in match string expressions .............................. 7521 Possible Operator values in match string expressions .............................. 7522 Possible Variable values in match string expressions................................ 7723 Possible Filesize-Units values in match string expressions ...................... 7824 Operator precedence in a match string ........................................................ 7825 Descriptions of Checksum settings............................................................... 8326 Descriptions of Retention Period settings.................................................... 8427 Scheduled job comparison ............................................................................. 9228 Components of a schedule............................................................................. 9329 Effect of a scheduled job on file system settings......................................... 9430 Delete Old Files job differences..................................................................... 95

Tables


Tables

31 Components of a time element ................................................................... 10232 Recurrence options ....................................................................................... 10333 Mounting with EMC Centera data retention ............................................ 11234 Mounting read-only...................................................................................... 11835 Mounting direct-read ................................................................................... 12236 Supported backup software ........................................................................ 12637 FSM recovery commands............................................................................. 14438 Mounting a file system for utdm_recdmattrf ........................................... 15039 Administrative commands .......................................................................... 17440 File management commands....................................................................... 17541 Backup and restore commands................................................................... 17542 Options for deldmsession ............................................................................ 17943 Options for dx_read_log .............................................................................. 18044 Severity levels ................................................................................................ 18145 Brevity levels.................................................................................................. 18246 Options for dxuldmclip................................................................................ 18347 Options for dxuldmdelclips ........................................................................ 18548 Options for expand_dmattrf........................................................................ 18649 Options for getdmattr................................................................................... 18850 Options for getfileattr ................................................................................... 18851 Options for dxstat ......................................................................................... 18952 Options for dxprstat ..................................................................................... 18953 Options for dxhardlink................................................................................. 19054 Options for getmiglist................................................................................... 19155 Options for getmiglist................................................................................... 19256 getmiglist file list columns........................................................................... 19357 Options for getpurgelist ............................................................................... 19458 getpurgelist file list columns headings ...................................................... 19559 Options for dxbuildtar ................................................................................. 19760 Options for dxcliplink .................................................................................. 19861 Options for dxdmload .................................................................................. 19962 Options for dxuldm_tar ............................................................................... 20063 Options for dmattrrecoverfs........................................................................ 20164 Options for getrecoverlist ............................................................................ 20265 getrecoverlist file list columns..................................................................... 20266 Options for utdm_fs_freeze......................................................................... 203


Preface

As part of an effort to improve and enhance the performance and capabilitiesof its product lines, EMC periodically releases revisions of its hardware andsoftware. Therefore, some functions described in this document may not besupported by all versions of the software or hardware currently in use. Forthe most up-to-date information on product features, refer to your productrelease notes.

If a product does not function properly or does not function as described inthis document, please contact your EMC representative.

Audience This guide is part of the EMC DiskXtender File System Manager forUNIX/Linux, release 3.5 documentation set, and is intended for useby system administrators.

Readers of this guide are expected to be familiar with the followingtopics:

◆ Their organization’s data archiving strategy, in particular:

• Average archived file size.

• Anticipated total number of files and total bytes to bearchived.

• File access norms: frequency of access during creation, edit,and archive phases.

• Special file requirements, such as for shorter access times,multiple fail-safe copies, and optimal file stub size.

• Backup strategies for data in the file systems.

10 EMC DiskXtender File System Manager for UNIX/Linux Release 3.5 Administrator’s Guide

Preface

◆ The network details of all computer systems and hardwaredevices to be used, including:

• IP addresses

• TCP/IP routing information

• Switch, router, firewall, and network-attached deviceconfigurations

◆ The administration details of all involved storage targets.

RelatedDocumentation

Related documents include:

◆ Release notes

◆ Installation guides:

• AIX

• HP-UX

• Linux

• Solaris

• Console Client for Microsoft Windows

• EMC AutoStart Module for EMC DiskXtender File SystemManager for UNIX/Linux

The release notes contain a complete list of all related EMC productdocumentation.

Conventions Used inThis Guide

EMC uses the following conventions for notes and cautions.

Note: A note presents information that is important, but not hazard-related.

IMPORTANT!An important notice contains information essential to operation ofthe software.


Preface

Typographical conventionsEMC uses the following type style conventions in this document:

Normal Used in running (nonprocedural) text for:• Names of interface elements (such as names of windows,

dialog boxes, buttons, fields, and menus)• Names of resources, attributes, pools, Boolean expressions,

buttons, DQL statements, keywords, clauses, environmentvariables, functions, utilities

• URLs, pathnames, filenames, directory names, computernames, filenames, links, groups, service keys, file systems,notifications

Bold Used in running (nonprocedural) text for:• Names of commands, daemons, options, programs,

processes, services, applications, utilities, kernels,notifications, system calls, man pages

Used in procedures for:• Names of interface elements (such as names of windows,

dialog boxes, buttons, fields, and menus)• What user specifically selects, clicks, presses, or types

Italic Used in all text (including procedures) for:• Full titles of publications referenced in text• Emphasis (for example a new term)• Variables

Courier Used for:• System output, such as an error message or script• URLs, complete paths, filenames, prompts, and syntax when

shown outside of running text

Courier bold Used for:• Specific user input (such as commands)

Courier italic Used in procedures for:• Variables on command line• User input variables

< > Angle brackets enclose parameter or variable values supplied bythe user

[ ] Square brackets enclose optional values

| Vertical bar indicates alternate selections - the bar means “or”

{ } Braces indicate content that you must specify (that is, x or y or z)

... Ellipses indicate nonessential information omitted from theexample


Preface

Where to get help EMC support, product, and licensing information can be obtained asfollows.

Product information — For documentation, release notes, softwareupdates, or for information about EMC products, licensing, andservice, go to the EMC Powerlink website (registration required) at:

http://Powerlink.EMC.com

Technical support — For technical support, go to EMC CustomerService on Powerlink. To open a service request through Powerlink,you must have a valid support agreement. Please contact your EMCsales representative for details about obtaining a valid supportagreement or to answer any questions about your account.

Your comments Your suggestions will help us continue to improve the accuracy,organization, and overall quality of the user publications. Please sendyour opinion of this document to:

[email protected]

http://powerlink.emc.com

Introduction 13

1

This chapter covers the following topics:

◆ File system-based storage management ......................................... 14◆ Console-based administration ......................................................... 16◆ Flexible topology................................................................................ 17

Introduction


Introduction

File system-based storage managementEMC® DiskXtender® File System Manager for UNIX/Linux (FSM),release 3.5 is a data management solution that uses DMAPI-enabled(UTDM) file systems to transparently archive data on the followingback-end storage systems:

◆ EMC Centera® Content Addressed Storage System (EMCCentera)

◆ Locally accessible disk resources

FSM transparently manages multiple local UTDM file systems. Whennecessary, it migrates and purges data from the file systems based onuser-defined rules.

FSM frees up space by transferring the actual data associated with afile system object to a back-end system, while retaining the object’smetadata in the file system. This means that a migrated and purgedfile is fully available through the file system, but uses very little of thefile system’s space.

Files always available to applicationsWhen an application starts a read or write operation on data that hasbeen migrated and purged, FSM invisibly triggers a retrieval of thatdata. The data is returned to the file system and the operation iscompleted. The user is not required to initiate operations to import orexport data. Data written to an FSM file system is fully available forall read and write operations without user intervention.

Access to migrated and purged data is the same as access to locallystored data, except for the possibility of a slight delay during theretrieval of data that has been purged from the file system.

Information that can be provided from the file’s metadata, or fromdata contained in the locally retained stub file, is available withouttriggering a retrieval from the back-end system. This enables manyqueries to be completed at local disk speed, even for large files whichhave been migrated and purged.

Data management FSM creates a transparent management layer on top of the native filesystem. The management layer uses a Data Management ApplicationProgramming Interface (DMAPI) to do the following:

File system-based storage management 15

Introduction

◆ Interact with the file system.

◆ Manage extended file attribute information.

◆ Handle requests for migration, purging, and retrieval operations.

FSM migrates data to one or more back-end systems and managesdata protection, retention, and replication on those systems. To fulfillrequests for purged data, FSM retrieves the data from the appropriateback-end system.


Introduction

Console-based administrationFSM provides a console-style administrative tool to perform mostadministrative tasks. The tool, the FSM Console, permits theadministration of multiple UTDM file systems, UTDM file systemhosts, and management domains. A management domain is a logicalgrouping of UTDM file system hosts controlled by the same FSMConsole Server.

Console Client FSM Console Client can be run on any supported host to administer amanagement domain, as long as it has TCP/IP access to the followingmanagement domain components:

◆ Console Server

◆ All UTDM file system hosts

Console Client can be run simultaneously on multiple hosts.

You can use Console Client to perform tasks in the followingcategories:

◆ Administration◆ Configuration◆ Extended Rules◆ Monitoring

Flexible topology 17

Introduction

Flexible topologyFSM can be set up with many different combinations of hosts, filesystems, protocols, and back-end systems.

An FSM host is a computer where:

◆ Core processes are installed and running.

◆ Console Agent is installed and running.

◆ At least one UTDM file system is available.

Minimum topology A minimal FSM installation involves the following:

◆ FSM host with Console Server installed and running.

◆ One UTDM file system.

◆ One back-end system.

Complex topology A complex management domain might involve all of the following:

◆ One FSM host with Console Server installed and running.

◆ Multiple FSM hosts, including all of the supported operatingsystems.

◆ Multiple UTDM file systems on each FSM host, including allsupported file system types.

◆ Multiple back-end systems, including EMC Centeras, and locallyaccessible disk resources.

◆ Additional EMC Centeras that act as replication servers.

◆ Console Client administration from multiple hosts.


Introduction

Topology guidelines To successfully set up a management domain, the followingguidelines must be met:

◆ Only one Console Server may run in the management domain.

◆ All FSM hosts must have Console Agent installed and running.

◆ All FSM hosts must have TCP/IP communication with theConsole Server host system.

◆ All Console Client hosts must have TCP/IP communication withthe Console Server host and all FSM hosts.

Console overview 19

2


◆ Console software................................................................................ 20◆ Management domain......................................................................... 22◆ Console Client..................................................................................... 24◆ Administration ................................................................................... 26◆ Monitoring .......................................................................................... 30

Console overview


Console overview

Console softwareThe Console software provides the interface to work with FSM hostsand UTDM file systems. An administrator can perform the followingtasks by using the Console software:

◆ Configure new UTDM file systems.

◆ Edit the configuration of existing UTDM file systems.

◆ Delete the configuration information for existing UTDM filesystems.

◆ Copy rule sets between UTDM file systems.

◆ Import and export rule sets.

◆ Create and manage extended rules.

The Console software consists of the following applications:

◆ Console Server

◆ Console Agent

◆ Console Client

Console Server Console Server provides authentication services to a managementdomain. All FSM hosts in a management domain are controlled bythe same Console Server.

Console Server must be installed on only one computer in amanagement domain. That computer must have TCP/IP access to allFSM hosts in its domain. Normally the computer on which it isinstalled also has Console Agent installed.

The computer on which Console Server is installed may also haveConsole Client installed.

Console Agent Console Agent interacts with the processes and UTDM file systemson an FSM host. It acts as an intermediary between an FSM host andConsole Client. It must be installed on each FSM host being managed.

Console software 21

Console overview

Console Client Console Client may be installed on any computer with TCP/IP accessto the management domain. It provides an administrative interface tothe management domain.

Console Client may be active on several computers simultaneouslyand should be installed on every computer that is used to administerfile systems.

Console Client may run on a computer with or without ConsoleServer and Console Agent.


Console overview

Management domainA management domain can exist entirely on a single computer or itcan include multiple computers. A management domain consists ofthe following essential components:

◆ One Console Server.

◆ At least one Console Client.

◆ At least one FSM host.

Each FSM host must have the following:

• One set of FSM core processes (core processes)

• One FSM Console Agent (Console Agent)

• At least one UTDM file system

A UTDM file system is one that is first formatted as a native filesystem and then initialized to create a DMAPI attributes file in itsroot directory. The installation guides provide more informationabout this.

Single computer domainThe following tasks must be completed to set up a managementdomain on a single computer:

1. Ensure the computer meets the installation requirements.

2. Install the core processes.

3. Install the Console Server.

4. Install a Console Agent.

5. Install the Console Client.

6. Prepare at least one UTDM file system.

7. Configure each UTDM file system.

Management domain 23

Console overview

Multiple computer domainA management domain can consist of many computers. All of thecomputers in the management domain must have TCP/IPcommunication with the following:

◆ Computer that is running Console Server

◆ Each computer that is running Console Client.

A multiple computer management domain might consist of thefollowing separate computers:

◆ Console Server running on a single FSM host computer.

◆ Console Agent running on multiple FSM host computers.

◆ Console Client running on several computers.


Console overview

Console ClientConsole Client is an interface application for working with FSM hostsand UTDM file systems. An encrypted username/passwordcombination (account) is used to authenticate Console Client usersand determine permissions.

A default administrative account is provided with Console Client.This default account has the username "system" and the password"system". To increase the security of the management domain, thepassword for this account should be changed right after the softwareis installed. “How to change a user's password” on page 29 providesinformation about how to do this.

You can install Console Client on several supported operatingsystems. The release notes provide a complete list of the operatingsystems supported by Console Client.

How to start Console ClientTo start Console Client:

◆ On UNIX and Linux hosts:

1. Allow X window connections:

xhost +

2. Set the DISPLAY environment variable.

setenv DISPLAY local_host:0.0

where local_host is the hostname of the local system or its IPaddress.

Whether you use the local system’s hostname or its IP addressdepends upon the configuration of the network. The IPaddress can be either an IPv4 or IPv6 format IP address tomatch the protocol used by your network.

3. Run the Console Client application:

/opt/fsm/client/File_System_Manager_Console_Client &

where /opt/fsm is the full path to the FSM installation directory.

The Login to FSM Console window appears.

4. In Username, type a valid username.

5. In Password, type the password.

Console Client 25

Console overview

6. In FSM Server, type the hostname or IP address for themanagement domain’s Console Server.

You can use either an IPv4 or IPv6 format IP address to matchthe protocol used by your network.

7. Click OK.

The main Console Client window appears.

◆ On Windows:

1. Click:

Start > Programs > File System Manager Console Client >File System Manager Console Client

The Login to FSM Console window appears.

2. In Username, type a valid username.

3. In Password, type the password.

4. In FSM Server, type the hostname or IP address for themanagement domain’s Console Server.

You can use either an IPv4 or IPv6 format IP address to matchthe protocol used by your network.

5. Click OK.

The main Console Client window appears.

Security time-out Console Client is configured to close down its connection withConsole Server after 20 minutes of inactivity. This security featurecannot be configured.

Online help The online help provides convenient descriptions of Console Client’smenus, shortcuts, windows, and wizards.

To access the online help from the main Console Client window, onthe Help menu, click Contents and Index (or press F1).

To access the online help from a wizard, click the Help button (orpress Alt+F1).


Console overview

AdministrationYou can use the Console Client Administration menu to manage alluser accounts in a management domain. The specific managementdomain is determined by the name of the Console Server host enteredduring login.

Use the Administration menu to manage user accounts through thefollowing commands:

◆ Manage User Accounts

◆ Change User Password

CAUTION!The Console Client application installs with a default account thathas the username "system" and the password "system". The role ofthis default account is Administrator.This account cannot be deleted. To maintain the security of themanagement domain, change the default password for the "system"as soon as the software is installed. “How to change a user'spassword” on page 29 provides more information.

How to add a user To add a user:

1. On the Administration menu, select Manage User Accounts.

2. In Username, type the new username.

A valid username is five to eight characters with at least onealphabetic character. A new username cannot match thefollowing:

• Any other username in the management domain.

• The password of the currently logged-in user.

3. In Password, type the new password.

A valid password is five to eight characters with at least onealphabetic character. It cannot match the password of the currentlogged-in user.

4. In Confirm Password, retype the new password.

The value in Confirm Password must match the value inPassword.

Administration 27

Console overview

5. In Role, select a role for the new user account.

Choose either Operator or Administrator. Refer to Table 1 onpage 27 to view the functions available for each role.

6. Click Add.

7. Click OK.

Note: Use Clear on the Manage User Accounts window to clear thefollowing fields: Username, Password, and Confirm Password.

Table 1 Tasks permitted for operators and administrators

Task Operator Administrator

View all activities Yes Yes

View all events Yes Yes

Monitor file system Yes Yes

View file system configuration Yes Yes

View file system events Yes Yes

Change own password Yes Yes

View Help Yes Yes

View About Yes Yes

Manage user accounts No Yes

Create new file system configuration No Yes

Edit file system configuration No Yes

Export rule set No Yes

Import rule set No Yes

Commit changes No Yes

Delete file system configuration No Yes

Copy extended rule No Yes


Console overview

How to remove a userTo remove a user account:


The Manage User Accounts window appears.

2. From the Username list, select the username of the account to beremoved.

Note: The "system" account cannot be removed. Delete is not availablewhen this account is selected.

3. Click Delete.

The Delete User prompt appears.

4. Click Yes.

The account is removed.

5. Click OK.

How to change your passwordTo change your password:

1. On the Administration menu, select Change User Password.

The Change Password window appears.

2. In Password, type your new password.

3. In Confirm Password, type the new password again.

4. Click OK.

Administration 29

Console overview

How to change a user's passwordAn administrator may change a user's password:


The Manage User Accounts window appears.

2. From the Username list, select a username.

3. In Password, type the new password.

4. In Confirm Password, type the new password.

5. Click Update.

6. Click OK.


Console overview

MonitoringTo view events, activities, and status in a management domain, usethe monitoring windows.

The following regions may be monitored:

◆ Domain Events

◆ Domain Activities

◆ Host Events

◆ File System Events

◆ File System Activities

◆ File System State

Note: Events and state information for file systems on an FSM host arecleared when that FSM host is restarted. Restarting an FSM host also clearsthat host’s events from the Events for All Hosts window.

Clearing the events windowAn administrator can clear all events, or select events to clear fromany of the Events windows.

All EventsTo clear all events, click Clear All Events.

All events clear, including events that are not displayed under thecurrently selected event type.

Select EventsTo clear a group of events:

1. In the Filter field, select an event type to display.

2. Select each event to be cleared.

3. Click Clear Checked Events.

Monitoring 31

Console overview

Domain events The events for all file systems in a management domain may beviewed. The displayed events do not include the following:

◆ Events that were cleared.

◆ Events that occurred before the host computer was last restarted.

How to view domain eventsTo display the events for a management domain:

1. On the View menu, select All Events.

The Events for All Hosts window appears.

2. (Optional) On the View menu, select Refresh to refresh thedisplay.

The Last Refreshed value changes and the Events for All Hostswindow updates.

3. (Optional) In the Filter field, select a severity level to display asubset of the events.

The following severity levels may be selected:

• All

• None

• Low

• Medium

• High

• Extreme

The filtered events appear.

Table 2 on page 32 provides a description of the columns on theEvents for All Hosts window.


Console overview

Domain activities The activities for all file systems in a management domain may beviewed.

To display all activities in a management domain:

1. On the View menu, select All Activities.

The All FSM Activities window appears at the top of theworkspace pane.

2. In the Filter field, select the type of activities to display.

The activities are filtered to show only the type of activitiesselected.

Table 2 Columns on the Events for All Hosts window

Column Description

Host Name of the host on which the event occurred.

File System Name of the file system that generated the event.

Severity Severity level of the event.Severity is one of the following:• None• Low• Medium• High• Extreme

Timestamp Date and time that the event occurred.

Event Type Type of event.Event type is one of the following:• Debug• Info• Notice• Warning• Error• Critical• Alert• Emergency

Message Description of the event.

Monitoring 33

Console overview

The following activities types may be selected:

• All

• Purge

• Migrate

• Staging

• Destroy

• Recover

The filtered domain activities appear.

Table 3 on page 33 provides a description of the columns on theAll FSM Activities window.

Table 3 Columns on the All FSM Activities window

Column Description

Host Name of the host for the activity.

File System Name of the file system for the activity.

File System ID File system ID for the activity.

Backend Level Priority of the back-end system.Either Level 1 (primary) or Level 2 (secondary).

Backend Type Back-end module type, which is one of the following:• Centera• FTP• NFS

Activity Type Activity type, which is one of the following:• Purge• Migrate• Stage• Destroy• Recover

Filename Name of the file that is the subject of the activity.

Bytes to Move Target amount of data (in bytes) to be moved by the activity.

Bytes Moved Current amount of data (in bytes) that was moved by the activity.

Progress Graphical progress bar.


Console overview

Host events The events for an individual host may be viewed. The displayedevents do not include the following:



How to view events for a hostTo display all events for a host:

1. On the tree pane, select the host.

2. On the View menu, select Events.

The Events window appears.


The Last Refreshed value changes and the Events windowupdates.


The events are filtered to show only the selected severity level.


• All

• None

• Low

• Medium

• High

• Extreme

The filtered events appear.

Table 4 on page 35 provides a description of the columns on theEvents window.

Monitoring 35

Console overview

File system events The events for an individual file system may be viewed. Thedisplayed events do not include the following:



How to view events for a file systemTo display all events for a file system:

1. On the tree pane, select the file system.

2. On the View menu, select Events.

The Events window appears at the top of the workspace pane.

Table 4 Columns on the Events windows

Column Description

Host Name of the host.



Timestamp The date and time that the event occurred.




Console overview


The Last Refreshed value changes and the Events windowupdates.


The events are filtered to show only the severity level selected.


• All

• None

• Low

• Medium

• High

• Extreme

The filtered events appear. Table 5 on page 36 provides adescription of the columns on the Events window.

Table 5 Columns on the Events windows (page 1 of 2)

Column Description

Host Name of the host.



Monitoring 37

Console overview

File system activities You can use Console Client to view the activities for a file system.

To display all activities for a file system:


2. On the View menu, select Monitoring.

The Activities window appears at the bottom of the workspacepane.

3. In the Filter field, select the type of activities to display.

The activities are filtered to show only the type of activitiesselected.

The following activities types may be selected:

• All

• Purge

• Migrate

• Staging

• Destroy

• Recover

The filtered activities appear. Table 6 on page 38 provides adescription of the columns on the Activities window.

Timestamp Date and time that the event occurred.



Table 5 Columns on the Events windows (page 2 of 2)

Column Description


Console overview

File system state You can use Console Client to view information about the state of amanaged file system.

To display the state of a file system:


2. On the View menu, select Monitoring.

The File System State window appears at the top of theworkspace pane. General state information appears on the leftside of the window. Table 7 on page 39 provides a description ofthe available information.

Table 6 Columns on the Activities window

Column Description

Activity Type Type of activity. Type is one of the following:• Purge• Migrate• Stage• Destroy• Recover

Backend Level Priority of the back-end system.Either Level 1 (primary) or Level 2 (secondary).

Backend Type Back-end module type, which is one of the following:• Centera• FTP• NFS

Filename Name of the file that is the subject of the activity.

Bytes to Move Target amount of data (in bytes) to be moved by the activity.

Bytes Moved Current amount of data (in bytes) moved by the activity.

Progress Graphical progress bar.

Monitoring 39

Console overview

3. (Optional) From the View menu, select Refresh to refresh thedisplay.

The Last Refreshed value changes, and the File System Statewindow and the Activities window update.

4. On the File System State window, select a tab to displayinformation for a specific activity type.

The following tabs are available:

• Purge, described in Table 8 on page 40.

• Migrate, described in Table 9 on page 40.

• Staging, described in Table 10 on page 40.

• Destroy, described in Table 11 on page 41.

• Recover, described in Table 12 on page 41.

Table 7 File System State window

Field Name Description

File System Name Name of the file system.

File System ID File system ID.

Module Module type for the file system.

File System Path Full path to the mount point for the file system.

Total Size Total size of the file system.

Used Space Number of megabytes of data in the file system.

High Watermark Value set for the file system's high-water mark.

Used Space(graphical display)

Graphical display showing the percentage of file system space used.

Maximum Inodes Total number of inodes allowed in the file system.

Used Inodes Total number of file system inodes used.

Used Inodes(graphical display)

Graphical display showing the percentage of file system inodes used.


Console overview

Table 8 Purge tab on the File System State window

Field Description

Purge Attempts Number of attempts to purge files from the file system.

Purge Errors Number of errors during all of the file system's purge attempts.

Purge Attempts onPurged Files

Number of purge attempts on previously purged files.

Bytes PurgedSince Last Reboot

Total bytes purged since the last time the file system's host wasstarted.

Table 9 Migrate tab on the File System State window

Field Description

MigrationAttempts

Number of attempts to migrate files from the file system.

Migration Errors Number of errors during all of the file system's migration attempts.

MigrationAttempts onMigrated Files

Number of migration attempts on previously migrated files.

Bytes MigratedSince LastReboot

Total bytes migrated since the last time the file system's host wasstarted.

Table 10 Staging tab on the File System State window

Field Description

Staging Attempts Number of attempts to stage files into the file system.

Staging Errors Number of errors during all of the file system's staging attempts.

StagingAttemptson Staged Files

Number of staging attempts on previously staged files.

Bytes StagedSince LastReboot

Total bytes staged since the last time the file system's host was started.

Monitoring 41

Console overview

Table 11 Destroy tab on the File System State window

Field Description

Files Destroyed Total number of files reclassified on the back-end system as destroyed,after being deleted from the file system.

Files NotRenamed

Total number of files that could not be renamed on the back-end system.“Periodic back-end system cleanup” on page 167 provides moreinformation about renaming deleted files on the back-end system.

Table 12 Recover tab on the File System State window

Field Description

RecoveryAttempts

Number of attempts to recover file data from the back-end system, aftera recovery from backup is completed in the file system.

Recovery Errors Number of errors during file data recovery attempts.


Console overview

File System Configuration 43

3


◆ Preliminary tasks................................................................................ 44◆ Configuring a file system.................................................................. 57◆ Viewing a file system configuration................................................ 70◆ Editing a file system configuration.................................................. 71◆ Deleting a file system configuration ............................................... 72

File SystemConfiguration


File System Configuration

Preliminary tasksA UTDM file system’s configuration is a set of attributes that defineshow it is managed. Each file system has its own set of required andoptional attributes.

Console Client simplifies file system configuration tasks bydisplaying all relevant attributes, checking all entered values, andapplying configuration changes to the file system.

Before you can configure a file system, you must complete thefollowing:

◆ Create a native file system, initialize the file system for UTDM,and mount the file system on an FSM host.

These tasks are described in the installation guides.

◆ Decide on a Level 1 back-end type and optionally, a Level 2back-end type to use with the file system.

◆ Perform any preliminary setup steps required for each selectedback-end system.

Back-end module typesThis release allows you to designate either one or two back-endsystems for a file system. When two back-end systems are selected,migrated file data is written to both. Data is retrieved from the Level1 (primary) back-end system unless it is unavailable. If the Level 1back-end system is unavailable, then data is retrieved from the Level2 (secondary) back-end system.

The steps required to configure a file system differ slightly based onwhich back-end type is selected as primary and, optionally, which isselected as secondary.

For both primary and secondary, an administrator may choose fromthe back-end module types shown in Table 13 on page 45.

Preliminary tasks 45


A mixture of back-end module types can be used for a file system, forthe file systems on a host, and for all file systems in a managementdomain.

Each back-end module type has preliminary tasks that must becompleted before you configure a file system to use it. Those tasks aredescribed in the following sections:

◆ “Centera module preliminary tasks” on page 45

◆ “FTP module preliminary tasks” on page 52

◆ “NFS module preliminary tasks” on page 54

Centera module preliminary tasksThe Centera module requires the following preliminary tasks:

◆ Ensure that the FSM host can establish a connection with theEMC Centera’s interface addresses. If replication is used, alsoconfirm that there is a connection with the replication server’sinterface addresses.

◆ Create a EMC Centera pool to use with FSM file systems.

◆ Configure the EMC Centera to grant the appropriate permissionsto FSM. If replication is used, also configure the replication server.

◆ If Pool Entry Authorization (PEA) is used, create and install avalid PEA file on the FSM host. If replication is used, create a PEAfile that authenticates FSM with both the primary EMC Centeraand the replication server.

◆ Enable EMC Centera data retention.

Table 13 Available back-end module types

Back-end module types Description

Centera EMC Centera

FTP Standards-compliant FTP or FTPS servera

NFS Standards-compliant NFS accessible disk resources

a. In order to facilitate recovery on an FTP or FTPS server, the server must be capable of providing FSM withlocal disk-like access to the back-end data. This may be provided using NFS or any other protocol thatprovides FSM with such access. “Recovering an FTP module file system” on page 130 describes the recoveryprocedure in this configuration.



Check connectivity FSM uses TCP/IP to communicate with EMC Centeras. Beforeconfiguring a UTDM file system to use a EMC Centera, andoptionally a EMC Centera replication server, confirm that there is aconnection between the FSM host and the IP addresses of the EMCCenteras.

EMC Centeras do not respond to ping packets. A tool to confirm thatthere is a connection with a EMC Centera is provided with the FSMsoftware.

To confirm connectivity:

1. Log in as root on the FSM host system.

2. Set the FSM environment.

To set the environment, refer to “Setting the FSM environment”on page 177.

3. For each EMC Centera IP address, run the dxuldmcenterapingcommand:

dxuldmcenteraping -a emc-address [emc-address...]

where emc-address is an IP address for a network interface on theEMC Centera, in IPv4 format. Additional IP addresses, separatedby spaces, may be specified.

For more information about this command, see“dxuldmcenteraping” on page 182.

Failure to connect to the IP addresses for a EMC Centera indicates anetwork problem that should be corrected before the file system isconfigured.

Create a EMC Centera pool for FSMFSM file systems can use the default EMC Centera pool but it isrecommended that you create a pool that is used only by FSM filesystems. An FSM-only pool simplifies EMC Centera to EMC Centeramigrations, such as when you move the back-end data to a newergeneration EMC Centera.

Configure EMC Centera permissionsFSM requires read, write, and query permissions on a EMC Centera.This set of permissions can be provided in one of the following ways:

◆ Configure the EMC Centera’s Anonymous profile to grant thesepermissions.



Use of the Anonymous profile eliminates the PEA filerequirement. However, the Anonymous profile constitutes apotential security hazard since it does not authenticateapplications during the PEA process. It should be disabled.

◆ Use the PEA process to create an application profile for FSM thatgrants the necessary permissions.

For more information on this choice, see the next section: “Createand install a PEA file” on page 47.

Create and install a PEA fileThe PEA process is used by a EMC Centera to grant access rights toapplications. The specific access rights that are granted aredetermined by application profiles created on the EMC Centera.

The application profile that is used by FSM must have the followingaccess rights:

◆ Read (r)

◆ Write (w)

◆ Exist (e)

In order to be authorized to use an application profile, FSM mustprovide the EMC Centera with the profile’s name and key. FSM readsthe information from a PEA file located on the FSM host and passes itto the EMC Centera during the PEA process.

To create and install a PEA file:

1. On the EMC Centera, create an application profile that grantsRead, Write, and Exist rights.

Application profiles are created by using the EMC Centera’s CLIcommands profile create or profile update.

In order to have the profile create or profile update commandsoutput a PEA file, type yes when asked if a Pool EntryAuthorization should be created.

For more information about application profile creation, refer tothe EMC Centera’s documentation.

2. Copy the resultant PEA file from the CLI host to the FSM host.

3. As root, limit access to the PEA file:

chmod 600 /path/my.pea

where /path/my.pea is the full path of the PEA file.



4. For each file system that uses the Centera module, type the fullpath of the PEA file in the Authentication Path option.

Authentication Path is described in “Centera module” onpage 64.

Verify PEA accessTo verify that a PEA file can be used to access a EMC Centera:

1. Log in as root on the host system.


For information on setting the FSM environment, see “Setting theFSM environment” on page 177.

3. Run dxuldmcenteraping:

dxuldmcenteraping -a centeraIP?pathtopea

where:

• centeraIP is one of the IP addresses on the EMC Centera, inIPv4 format.

• pathtopea is the full path to the PEA file.

Note: This command verifies that the PEA file may be used to access theEMC Centera. It does not check whether the correct permissions areprovided by the PEA file.

For more information about dxuldmcenteraping, see“dxuldmcenteraping” on page 182.

Centera pool entry authorization for replicationThe PEA process may be used with Centera replication as a way toauthenticate FSM on both the primary and replication EMC Centeras.

The PEA file used in a replication environment must provideauthentication information for each of the EMC Centeras.

The composition of a PEA file used in a replication environmentdepends on whether you provide the path to a random-bit file whenyou run the profile create or profile update commands. Therandom-bit file can be used as additional input during keygeneration.

The following methods may be used:

◆ Generate the key by providing a random-bit file.



The same file must be used on each EMC Centera. This methodcreates a PEA file with a single key that is accepted on each EMCCentera.

◆ Generate the key without providing a random-bit file.

A different key is created on each EMC Centera based on variousmachine-based values. Each key must be copied into the PEA file.This creates a PEA file with several keys, one for each EMCCentera.

Replication PEA file created with a random-bit file

To use a replication PEA file created with a random-bit file:

1. On the primary EMC Centera, create an application profile byusing a random-bit file.

The application profile must grant Read, Write, and Exist rights.In order to have the profile create or profile update commandsoutput a PEA file, type yes when asked if a Pool EntryAuthorization should be created.

For more information about application profile creation, refer tothe EMC Centera’s documentation.

2. On each replication system, create an application profile by usingthe same random-bit file.

The application profile on each replication system should use thesame name as the one on the primary system. The profile should,at a minimum, grant Read and Exist rights.

3. Copy the PEA file created with the primary system from the CLIhost to the FSM host.





This is described in “Configuring a file system” on page 57.

6. For each file system that uses the Centera module, type the IPaddress, in IPv4 format, for each available interface on eachreplication server in the Replication Server Addresses option.




7. Verify access using the PEA file.

This task is described in “Verify PEA access” on page 48.

Replication PEA file created without the use of a random-bit file

To use a replication PEA file created without the use of a random-bitfile:

1. On the primary EMC Centera, create an application profilewithout using a random-bit file.

The application profile must grant Read, Write, and Exist rights.In order to have the profile create or profile update commandsoutput a PEA file, type yes when asked if a Pool EntryAuthorization should be created.

The EMC Centera’s documentation provides more informationabout application profile creation.

2. On each replication system, create an application profile withoutusing a random-bit file.

The application profile on each replication system should use thesame name as the one on the primary system. The profile should,at a minimum, grant Read and Exist rights.

3. Copy the key portion of the PEA file created with each replicationsystem into the PEA file created with the primary system, asshown in Example 1 on page 50.

Example 1 Replication environment PEA file created without a random-bit file

The primary EMC Centera PEA file without the key from areplication server looks like this:

<pea version="1.0.0"><defaultkey name="FSM1"><credential id="csp1.secret"enc="base64">TXlQYXNzd29yZA==</credential></defaultkey><key type="cluster"id="74cf2446-1dd2-11b2-bee7-9e82e41faa5c" name="FSM1"><credential id="csp1.secret"enc="base64">TXlQYXNzd29yZA==</credential></key></pea>

The primary EMC Centera PEA file after adding the key from areplication server looks like this (added key is in bold font):



<pea version="1.0.0"><defaultkey name="FSM1"><credential id="csp1.secret"enc="base64">TXlQYXNzd29yZA==</credential></defaultkey><key type="cluster"id="74cf2446-1dd2-11b2-bee7-9e82e41faa5c" name="FSM1"><credential id="csp1.secret"enc="base64">TXlQYXNzd29yZA==</credential></key><key type="cluster"id="d76d509c-1dd1-11b2-b10d-bd6b5ed0b4e6" name="FSM1"><credential id="csp1.secret" enc="base64">YqgqywOqJ9nsKC7uQFeztUyFcM</credential></key></pea>

4. Copy the resulting PEA file from the CLI host to the FSM host.






7. For each file system that uses the Centera module, type the IPaddress, in IPv4 format, for each available interface on eachreplication server in the Replication Server Addresses option.


8. Verify access using the PEA file.

This task is described in “Verify PEA access” on page 48.

Enable EMC Centera data retentionRetention of data from a UTDM file system that is migrated to aEMC Centera is enabled by using the Retention Period or theRetention Class settings. However, unless EMC Centera dataretention is enabled for the file system, these retention settings donot protect data in the file system.

To provide retention both on the back-end system and in the filesystem, mount the file system with the bckendreten mountoption. For more information, see “EMC Centera data retention”on page 110.



FTP module preliminary tasksUse of the FTP module requires the following preliminary tasks:

◆ Ensure that the FSM host can establish a connection to theback-end server:

• FTP server (FTP Protocol set to Native FTP)

• FTPS server (FTP Protocol set to Native FTP)

◆ Create a username/password combination on the back-endserver for the file system.

◆ Obtain the full path to the target directory.

◆ Ensure that the file system host can obtain local disk-like access tothe back-end server.

Check connectivity Connectivity between the FSM host and the back-end server can beconfirmed by using ping. Use the ping command with the sameinterface address or hostname that you will use in FTP Host.

To confirm connectivity:


2. Run ping:

ping backendIP

where backendIP is the value to be used in FTP Host. This isnormally the IP address of the back-end server, in either IPv4 orIPv6 as dictated by the network. Alternatively, if the back-endserver’s hostname is to be used, replace backendIP with thehostname in the above command.

Failure to connect to the IP address indicates a network problem thatshould be corrected before the file system is configured. Failure toconnect to the hostname usually indicates a name service problem.

FTP username and passwordFSM authenticates itself with the back-end server by using ausername and password. This combination of values must be createdon the back-end server before it can be used by a UTDM file system.Documentation for other FTP/FTPS servers provides information oncreating FTP usernames and passwords.



A single username/password combination can be used by all UTDMfile systems, or individual combinations can be used by each FSMhost or each UTDM file system.

Target Path Before configuring a file system, determine the full path of thedirectory on the back-end server that is to be the top-level migrationtarget. Enter this path as the Target Path value for the file system. TheTarget Path value is described in “FTP module” on page 67.

The path is in UNIX format and is relative to the root of the FTPserver.

Another commonly used target path naming convention is/FSM/file_system, where:

◆ / is the root of the FTP directory structure on the FTP server.

◆ file_system is the name of the file system.

Choose an authentication typeThis release provides a choice between a standard FTP connection ora secure FTP connection for native FTP servers.

IMPORTANT!The FTP module supports only active mode. When deciding on anauthentication type be aware that using an encrypted controlchannel can prevent a firewall from opening a port for the datachannel.

Table 14 provides information about these choices.

To successfully use either TLS or SSL the back-end server mustprovide a public key certificate.

Table 14 Choices for the Authentication Type field

Authentication Type Control channel encrypted Data channel encrypted Cryptographic protocol

None No No None

TLS Yes No Transport layer security

SSL Yes No Secure socket layers



Local disk-like accessLocal disk-like access is normally established by using the NFSprotocol but other protocols are allowed, as long as the directoryspecified in the target path can be mounted locally by the FSM host.

NFS module preliminary tasksUse of the NFS module requires the following preliminary tasks:

◆ Determine the mount point of the back-end system.

◆ Create an NFS check directory on the back-end system.

Back-end mount point The module can be used with a disk resource that acts as a back-endsystem, such as any of the following:

◆ Local secondary disk

◆ Network Attached Storage (NAS) disk

◆ Storage Area Network (SAN) disk

When the NFS module is used, determine the full path to the localmount point of the back-end system. Enter this path as the TargetPath value for the file system. Configuring a file system’s Target Pathvalue is described in “NFS module” on page 68.

◆ To mount a disk resource as a back-end system, refer to theinstructions provided with the hardware.

Once the back-end system is mounted, the mount point can easily bedetermined by using mount.

To determine the mount point:


2. On the command line, type mount without any options:

mountAll mounted file systems are listed, with their mount point.

Determining back-end mount point when using Solaris zonesFor Solaris zones the expression of the full path to the mount point ofthe back-end system depends upon the zone in which FSM isinstalled and the zone in which the back-end system is mounted.Table 15 on page 55 describes how to determine the full path whenusing Solaris zones.



Create an NFS check directoryThe NFS check directory is an empty subdirectory at the top level ofthe back-end mount point. The NFS check directory must be namedUTDMNFS, and be all uppercase. No specific permissions arerequired for the check directory.

FSM uses the NFS check directory to ensure that the exporteddirectory is properly mounted on the FSM Host. The NFS checkdirectory can be seen by FSM only when the exported directory isproperly mounted on the FSM host. FSM will not migrate files until itsees the NFS check directory.

Note: Although a disk resource back-end system may not use the NFSprotocol, the core processes will not migrate data unless the NFS checkdirectory is found at the top level of the mount point.

To create an NFS check directory:


2. To ensure the back-end system is mounted, type mount withoutany options:

mount

If the back-end system is not listed as one of the mounted filesystems, then do the following:

• For a disk resource back-end system, mount the resource asdescribed in the instructions provided with the hardware.

Table 15 Determining path of back-end mount point when using Solaris zones

Configuration Path

• FSM installed in global zone• Back-end system is mounted in

global zone

Use the global zone full path of the mount point.

• FSM installed in global zone• Back-end system is mounted in local

zone

Use global representation of the local mount point.Example: Local zone is mounted at /export/zone01 and the back-end system’s localmount point is /mnt/backend01, then the full path to the mount point is/export/zone01/mnt/backend01.

• FSM installed in local zone• Back-end system is mounted in same

local zone

Use local representation of the local mount point.Example: Local zone is mounted at /export/zone01 and the back-end system’s localmount point is /mnt/backend01, then the full path to the mount point is /mnt/backend01.



3. Change the current working directory to the top level of theback-end system.

4. Create the NFS check directory:

mkdir UTDMNFS

Configuring a file system 57


Configuring a file systemConfiguring a file system is the final step in the process of preparingto manage a UTDM file system.

With this release you can configure a Level 1 and a Level 2 back-endsystem. When you configure both, migrated data is written to both.

The Level 1 back-end system is the file system’s primary back-endsystem. Data is always retrieved from the Level 1 back-end systemunless that back-end system is unavailable to the file system. If theLevel 1 back-end system is unavailable, then data is retrieved fromthe Level 2 back-end system.

When you configure two back-end systems for a file system you canselect from any of the module types for each. Normally you shouldconfigure the back-end type that stages data fastest as the Level 1back-end system.

Overriding configuration for file system subsetsWhen you configure a file system you create settings that tell FSMhow to manage the files in that file system. You can override thosesettings for subsets of the files using extended rules. “ExtendedRules” on page 73 provides information about:

◆ Defining a file system subset

◆ Creating an extended rule

◆ Working with extended rules

How to configure a file systemConfiguring a file system:

1. Create, initialize, and mount a UTDM file system.

The installation guides describe these procedures.

2. Start Console Client and log in to the management domain thatcontrols the file system’s FSM host.

“How to start Console Client” on page 24 describes how to startConsole Client and how to log in to a management domain.

3. On the tree pane, select the file system’s host computer.



4. Select File > New > File System Configuration.

5. Select the Level 1 (primary) back-end type from the followingchoices: Centera, FTP, or NFS.

6. (Optional) Check the Level 2 box.

7. (Optional) Select the Level 2 (secondary) back-end type.

8. Click OK.

9. In File System Name, type a reference name for the file system.

The name may be any combination of ASCII characters, from 1 to64 characters in length. The name cannot match the name of anyother file system on the host.

10. In File System Path, type the path for the UTDM file system.

Use the full path to the UTDM file system's mount point.

For Solaris zones the expression of a file system’s full pathdepends upon the zone in which FSM is installed and the zone ofthe file system. Table 16 on page 58 describes how to determinethe full path when using Solaris zones.

Table 16 Determining full path when using Solaris zones

Configuration Path

• FSM installed in global zone• File system installed in global zone

Use the global zone full path of the file system.

• FSM installed in global zone• File system installed in local zone

Use global representation of the local file system's path.Example: Local zone is mounted at /export/zone01 and the file system's local path is/mnt/filesystem01, then the path required is /export/zone01/mnt/filesystem01.

• FSM installed in local zone• File system installed in same local

zone

Use local representation of the file system's path.Example: Local zone is mounted at /export/zone01 and the file system's local path is/mnt/filesystem01, then the path required is /mnt/filesystem01.



11. In Checksum, select a checksum setting as described in Table 17on page 59.

When the value of Checksum is changed to either ChecksumDuring Migration or Checksum During Migration and Staging,a checksum is not calculated for files that were migrated while thevalue of Checksum was No Checksumming. Checksums arecalculated only for files that are migrated after the change.

Note: Checksumming is disabled for back-end systems that use theCentera module and have Enable Multiple Streams Per File Stageselected.

12. Click Next.

13. (Optional) In Delay Until Purge Candidacy, set the number ofminutes after a migrated file is last accessed before it can bepurged.

The range is 1 to 2,147,483,647 minutes. The default is 10 minutes.

14. (Optional) In Minimum File Size to Purge, set the minimum sizea file must be before it can be purged.

The range is 0 to 2,147,483,647 bytes (2 GB). The default is 0.

15. (Optional) In Sleep Interval Until Next Purge, set the number ofminutes, after a system-initiated purge run completes, before thefile system is again checked for files that can be purged.

Table 17 Checksum setting choices

Choice Description

No checksumming Checksums will not be generated.Use this setting to decrease the CPU requirements caused by data movement. This isthe default setting because of its lower CPU requirements.

Checksum during migration Checksum is generated for each file as it is migrated.This is the recommended setting. It creates a checksum for each migrated file withoutthe additional CPU impact caused by creating a checksum during staging.

Checksum during migration and staging Checksum is generated for each file as it is migrated. The checksum is regenerated andcompared to the original as the file is staged.Use this setting if increased CPU impact is not an issue, if file integrity is critical, orto troubleshoot migration and staging problems.This setting is overridden by the staging setting of Partial Read Size. When that settingis enabled, a checksum is calculated only during migration.



The range is 1 to 5,256,000 minutes. The default is 10 minutes.

Note: When the sleep interval elapses, the file system is checked againstits high-water mark. If the high-water mark is met or exceeded, a purgeeligibility check is conducted.

16. (Optional) In Concurrent Files Purged, set the number of purgethreads that can be started.

The range is 1 to 128 files. The default is 1.

Note: When the maximum number of threads is reached, files are queueduntil a thread becomes free.

17. (Optional) In File Stub Size, set the number of kilobytes of a filethat are left in the file system when the file is purged.

The range is 0 to 131,072 KB (128 MB). The default is 0.

Note: The data is measured in kilobytes from the head of the file.

18. (Optional) In High Watermark, set the percent of file systemcapacity that is reached before automatic purging is started.

The range is 1 to 100 percent, but must be higher than the value oflow-water mark. The default is 90 percent.

19. (Optional) In Low Watermark, set the percent of file systemcapacity that is reached before automatic purging is stopped.

The range is 1 to 100 percent, and must be less than thehigh-water mark. The default is 80 percent.

20. In the File Time Purge Policy section, select either Purge on LastModification Time or Purge on Last Access Time.

This setting determines the starting point for the Delay UntilPurge Candidacy period:

• Purge on Last Modification Time starts the period after thelast modification of a file.

• Purge on Last Access Time starts the period after the last timethe file was accessed.

21. Click Next.



22. (Optional) In Delay Until Migrate Candidacy, set the number ofminutes after a file is last modified before it can be migrated.


23. (Optional) In Minimum File Size to Migrate, set the minimumnumber of bytes a file must be before it can be migrated.

The range is 0 to 2,147,483,647 bytes (2 GB). The default is 0.

24. (Optional) In Sleep Interval Until Next Migration, set thenumber of minutes after a system-initiated migration runcompletes before the file system is again checked for files tomigrate.

The range is 1 to 5,256,000 minutes. The default is 30 minutes.

25. (Optional) In Concurrent Files Migrated, set the number ofmigration threads that can be started.



26. (Optional) Set the Purge After Migrate:

• Select to enable immediate purging of migrated files.

• Clear it to enable purging only after the number of minutes setin Delay Until Purge Candidacy.

27. (Optional) Select Enable Data Compression and set a datacompression level.

When you enable this setting file system data is compressedbefore it is migrated.

The compression level range is 0 to 9. Level 1 gives the fastestthroughput, level 9 gives the greatest compression, and level 0gives no compression at all (the input data is simply copied ablock at a time).

Level 6 represents a good compromise between speed andcompression.

The higher the compression you set the more the file systemhost's CPU will be utilized.



Note: Selecting Enable Data Compression prevents the use of thestaging settings: Partial Read Size and Full File Staging.

28. In the File Time Migration Policy section, select either Migrateon Last Modification Time or Migrate on Last Access Time.

This setting determines the starting point for the Delay UntilMigrate Candidacy period:

• Migrate on Last Modification Time starts the period after thelast modification of a file.

• Migrate on Last Access Time starts the period after the lasttime the file was accessed.

29. Click Next.

30. (Optional) Clear Full File Staging, to set a partial read size.

The default is full file staging, which means that all data for a fileis returned to the file system when the file is staged.

Full File Staging is disabled if Enable Data Compression isselected in the migration settings.

31. (Optional) In Partial Read Size, set the size in megabytes of filedata chunks to return to the file system when a file is staged.

Partial Read Size is disabled if Enable Data Compression isselected in the migration settings, or if Full File Staging isselected on the staging settings.

The Checksum during Migration and Staging setting isoverridden when Partial Read Size is enabled. A checksum iscalculated only on files when they are migrated because partialstaging prevents checksum calculations during staging.

The range is 1 to 2048 MB (2 GB). The range of data staged spansthe offset of the data requested.

Data is retrieved in chunks from the highest "partial read sizeboundary" immediately before the requested data to the lowest"partial read size boundary" immediately after the requesteddata.

Example 2 on page 63 provides further information about this.



Example 2 Partial read size

A file is 1,073,741,824 bytes (1 GB). The file system’s Partial ReadSize is set to 2,097,152 bytes (2 MB). The data requested is 4 MB insize and is located at offset 104,857,601 bytes (1 byte past the 100MB block boundary).

The data staged is the data from offset 104,857,600 bytes (100 MBis the highest "partial read size boundary" immediately before therequested data) to 111,149,056 bytes (106 MB is the lowest "partialread size boundary" immediately after the requested data).

Note: Partial Read Size does not apply when the FTP module is usedwith the Native FTP protocol.

32. (Optional) In Concurrent Files Staged, set the number of stagingthreads that can be started.



33. Click Next.

34. (Optional) In Concurrent Files Destroyed, set the number ofthreads that can be started to flag back-end data as deleted, forfiles that have been deleted from the file system.

Deletion flags are described in “Periodic back-end systemcleanup” on page 167.



35. Click Next.

36. Complete the module-specific configuration for the selected Level1 back-end system.



Procedures for module-specific configurations appear in thefollowing sections:

• “Centera module” on page 64

• “FTP module” on page 67

• “NFS module” on page 68

Centera module To complete the Centera module portion of a configuration:

1. In Connect Addresses, type the IP address or hostname of eachavailable network interface on the EMC Centera.

Use the standard IPv4 "dotted quad" format for each IP address(nnn.nnn.nnn.nnn) and separate each address by using a commawithout a space.

2. (Optional) In Retention Period, select Do Not Set, None,Default, Infinite, or Days as described in Table 18 on page 64.

If valid retention classes exist on the EMC Centera, RetentionPeriod should be left at its default value, and Retention Classshould be used to specify an appropriate retention class for thefile system.

3. (Optional) In Retention Class, type the name of a valid EMCCentera retention class.

If valid retention classes exist on the EMC Centera, you can useRetention Class to enable retention of the file system’s data onthe EMC Centera. This setting overrides the value of RetentionPeriod.

Table 18 Retention Period settings

Setting Description

Do not set Deleted data is retained for the period specified by the EMC Centera. This isthe default and has the same result as selecting Default.

None Deleted data is immediately available for purging from the EMC Centera.

Default Deleted data is retained for the period specified by the EMC Centera.

Infinite Deleted data is never available for purging from the EMC Centera.

Days Deleted data is not available for purging from the EMC Centera until after thespecified number of days.If you select Days, then set the number of days. The range is 1 to 36,500 days.



4. (Optional) In Replication Server Addresses, type the IP addressof each of the replication server's available network interfaces.

Use the standard, IPv4 "dotted quad" format for each IP address(nnn.nnn.nnn.nnn) and separate each address by using a commawithout a space.

5. (Optional) In Centera Profile Path, type the full local path to thePEA file.

“Create and install a PEA file” on page 47 provides moreinformation about PEA files.

6. (Optional) In Buffer Size, clear Use Default and type a buffersize.

The range is 1 to 10,240 KB (10 MB). The default value is 1 KB.

Note: Buffer Size is the amount of memory allocated by the EMC Centerafor temporary storage of data that requires further processing.

7. (Optional) In Timeout, clear Use Default and type the number ofseconds before a file system operation times out.

The range is 10 to 600 seconds (10 minutes). The default value is10 seconds.

Note: Timeout is the number of seconds the EMC Centera waits for anoperation to finish before a timeout failure occurs.

8. (Optional) In Retry Count, clear Use Default and type a limit onthe number of retries.

The range is 0 to 99 retries. The default is the retry count set by theEMC Centera administrator.

Note: Retry Count is the number of times to retry unsuccessful EMCCentera operations.

9. (Optional) In Retry Sleep, clear Use Default and type the numberof seconds between retries.

The range is 0 and 100 seconds.

Note: Retry Sleep is the number of seconds the EMC Centera waitsbefore retrying an unsuccessful operation.



10. (Optional) In Embedded Data Size, clear Use Default and typethe size of data that may be embedded in a C-Clip.

The range is 0 to 65536 bytes (64 KB). The default is the size set bythe EMC Centera administrator.

Note: Embedded Data Size is the limit on the size of data BLOBs that areembedded in the EMC Centera C-Clip. Data BLOBs over the limit arereferenced in the C-Clip, but stored elsewhere.

11. (Optional) In Prefetch Size, clear Use Default and type the size ofmemory on the EMC Centera to allocate for data transfers.

The range is 1 to 1024 KB (1 MB).

12. (Optional) In Collision Avoidance, set how the EMC Centerashould handle identical data BLOBs, as described in Table 19 onpage 66.

13. (Optional) Select Enable Multiple Streams Per File Stage, and setStreams Per File and Minimum Stream File Size.

When Enable Multiple Streams Per File Stage is selected itallows multiple threads to be started for each staging request.This can enhance staging performance from an EMC Centera.Checksumming is fully disabled when this setting is selected.

Set the number of threads in Streams Per File. The range is 1 to32, however in this release no significant improvement has beenshown for settings above 8.

Set the minimum file size for which multiple threads are used inMinimum Stream File Size. Files that are less than this size willbe staged using only one thread. The minimum size for thissetting is 100 MB. The default value is 1024 MB.

Table 19 Descriptions of Collision Avoidance settings

Setting Description

Default Identical data BLOBs are handled according to the EMC Centera default setting.

On Identical data BLOBs are handled separately, with unique ID numbers.

Off Identical data BLOBs are handled as a single BLOB, with one ID number.



Note: Enable Multiple Streams Per File Stage is disabled for EMCCentera back-end systems that have Partial Read Size enabled, andwhen the file system has been mounted with the readthru option(direct-read capability).

14. Click Next.

15. (Optional) If you selected a Level 2 back-end system, completethe module-specific configuration related to it.

Procedures for additional module-specific configurations appearin the following sections:



16. On the Finish and Commit panel, click Finish.

The configuration is validated, saved, and committed. The filesystem is ready to use and extended rules may be created.

FTP module To complete the FTP module portion of a configuration:

1. In Target Path, type the full path of the target directory on theback-end system.

“Target Path” on page 53 provides more information about thetarget directory.

2. In FTP Host, type the hostname or IP address of the back-end FTPserver.

The hostname must be 64 characters or less. The IP address can beeither an IPv4 or IPv6 format IP address to match the protocolused by your network.

3. In FTP User ID, type the user ID to log in to the back-end FTPserver.

The user ID must be 64 characters or less.

4. In FTP Password, type the password to log in to the back-endFTP server.

The password must be unencrypted, and must be 64 characters orless.

5. (Optional) In FTP Port, type the port that the back-end FTP serverlistens on.



The range is 1 to 65000. The default is port 21, the standard FTPand FTPS port.

6. (Optional) In Local Host IP Address, type a hostname, or IPaddress, for the file system host.

This setting is available for hosts with multiple networkinterfaces. Use a hostname, or an IP address, for the selectednetwork interface.

The hostname must be 64 characters or less. The IP address can beeither an IPv4 or IPv6 format IP address to match the protocolused by your network. The default uses the host's primaryhostname and IP address.

7. In FTP Protocol, select Native FTP.

Note: For Native FTP option, the following fields are unavailable: DXULFamily, Number of Instances, and Use Managed Disk Cache.

8. In Authentication Type, choose None, TLS, or SSL.

“Choose an authentication type” on page 53 providesinformation about this choice.

9. Click Next.







NFS module To complete the NFS module portion of a configuration:

1. In Target Path, type the full path for the local mount point of thetarget directory on the back-end system.

“Back-end mount point” on page 54 provides more information.



CAUTION!The directory specified in Target Path must contain the NFS CheckDirectory or migration will not occur. “Create an NFS checkdirectory” on page 55 provides more information about the NFSCheck Directory.

2. Click Next.









Viewing a file system configurationTo view an existing file system’s configuration:


The procedure to start Console Client and log in to a managementdomain is described in “How to start Console Client” on page 24.


3. On the View menu, select Configuration.

The View File System Configuration window appears at the topof the workspace pane.

All attributes for the file system appear on the View File SystemConfiguration window. The procedure “Configuring a file system”on page 57 describes each of the attributes.

Editing a file system configuration 71


Editing a file system configurationTo edit a file system configuration:




3. On the Edit menu, select File System Configuration.

The File System Configuration wizard opens in edit mode.Attributes that cannot be edited are dimmed.

4. Make changes as needed and click Next to go to the next panel.

The procedure “Configuring a file system” on page 57 describeseach of the attributes.


The edited configuration is validated, saved, and committed.



Deleting a file system configurationTo delete a file system configuration along with all of the extendedrules assigned to the file system:




3. On the Edit menu, select Delete File System.

The Delete File System prompt appears.

4. Click Yes.

The file system configuration and all extended rules are deleted.

Note: Deleting a file system configuration does not affect any of thefollowing: the UTDM file system, data in the file system, or data migrated tothe back-end system.

Extended Rules 73

4


◆ Creating an extended rule ................................................................ 74◆ Viewing extended rules .................................................................... 86◆ Editing an extended rule................................................................... 87◆ Deleting an extended rule................................................................. 88◆ Copying extended rules .................................................................... 89

Extended Rules


Extended Rules

Creating an extended ruleExtended rules enable you to modify the data management policiesfor a select group of files in a file system. An extended rule overridesthe file system’s configuration for the selected files.

Affected files are determined by the match strings that you specify.The metadata for each file in the file system is compared to the matchstring to form the group of files affected by the extended rule.

An extended rule is created by specifying the following:

◆ Criteria for selecting a set of files.

◆ Data management settings to apply to a set of files.

Match string Every extended rule uses a match string to define the set of filescovered by the rule. A match string is one or more expressions usedto select a group of files.

A match string can consist of several expressions separated by theAND operator and the OR operator. When the match string containsseveral operators, use parentheses to control the effects of operatorprecedence and associativity, as described in “Operator precedence andassociativity” on page 78.

A match string cannot exceed 127 characters, including spacecharacters.

Parentheses Parentheses are used in match strings to control the order in whichoperators are applied and expressions are evaluated.

Parenthesis may be used with any of the following:

◆ One expression

◆ Several expressions

◆ Nested groups

One or more left-parenthesis can be added to the beginning of amatch string, and after the AND and OR operators. You must addone or more right-parenthesis after an expression or expression groupto close each open left-parentheses.

Expressions Match string expressions have the following format:

KeywordOperatorVariable[Filesize-Units]

Creating an extended rule 75

Extended Rules

KeywordKeyword is described in Table 20 on page 75.

OperatorOperator is described in Table 21 on page 75.

Table 20 Possible Keyword values in match string expressions

Keyword value Description

FILENAME Relative or full pathnameTo specify a particular directory use the full pathname including themount point of the file system.After you enter this value it is placed in quotes by the software.

UID User IDYou can enter this value in quotes (string value) or without quotes(numeric value).

GID Group IDYou can enter this value in quotes (string value) or without quotes(numeric value).

FILESIZE File size

Table 21 Possible Operator values in match string expressions (page 1 of 2)

Operatorvalue Description

== Keyword is equal to Variable.

<> Keyword is not equal to Variable.

> Used only when the value of Keyword is FILESIZE, or when Keyword is UID orGID, and Variable is numeric.File size is greater than the Variable number of Filesize-Units, or UID or GID isgreater than Variable.


Extended Rules

VariableThe characteristics of Variable differ depending upon the context, asfollows:

◆ String value when used with FILENAME (value you enter isplaced in quotes by the software)

◆ String value when used with UID or GID and in quotes

◆ Integer value when used with UID or GID and not in quotes

◆ Integer when used with FILESIZE

The uses of Variable are described in Table 22 on page 77.

>= Used only when the value of Keyword is FILESIZE, or when Keyword is UID orGID, and Variable is numeric.File size is greater than, or equal to, the Variable number of Filesize-Units; orUID or GID is greater than, or equal to, Variable.

< Used only when the value of Keyword is FILESIZE, or when Keyword is UID orGID, and Variable is numeric.File size is less than the Variable number of Filesize-Units; or UID or GID is lessthan Variable.

<= Used only when the value of Keyword is FILESIZE, or when Keyword is UID orGID, and Variable is numeric.File size is less than, or equal to, the Variable number of Filesize-Units; or UIDor GID is less than, or equal to, Variable.

Table 21 Possible Operator values in match string expressions (page 2 of 2)

Operatorvalue Description


Extended Rules

Example 3 Matching files in several directories by filename

You need an extended rule to apply to all files in a file system whosename starts with the letters "imp". The file system consists of manydirectories and subdirectories.

In the extended rule wizard you select the FILENAME keyword andtype the string "imp", without the quotes. The following appears:

IF FILENAME=="imp*"

This string does not match the entire set.

You select FILENAME and type the string */imp*. The followingappears:

IF FILENAME=="*/imp*"

This string matches the entire set.

Table 22 Possible Variable values in match string expressions

Variable type Description

String When Keyword is FILENAME, UID, or GID.For UID or GID, a value is an integer unless it is in quotes. ForFILENAME all values are strings and are placed in quotes by thesoftware.Variable is a text string of 120 characters or less, representing aregular expression. Parentheses are not permitted. Wildcards may beused. However, the directory path symbol (/) must be included whencreating a wildcard string expression that matches the beginning of thename of files that exist in more than one directory. This is describedfurther in Example 3 on page 77.

Integer When Keyword is FILESIZE, UID, or GIDFor UID or GID a value is an integer unless it is in quotes.When used with FILESIZE, it is an integer that represents the numberof Filesize-Units. A FILESIZE comparison is formed by using theinteger entered in Variable and the units selected in Filesize-Units.When not in quotes and used with UID or GID, it is an integer thatrepresents a numeric user ID or group ID. The value of Variable mustbe numeric in this usage or the evaluation will fail.


Extended Rules

Filesize-UnitsThe Filesize-Units value is only used when the value of Keyword isFILESIZE. The possible values for Filesize-Units are described inTable 23 on page 78.

Operator precedence and associativityWhen several operators exist in a match string, the operators areapplied in the order of their precedence. If operators of equalprecedence exist in the match string, they are applied by using theassociativity rule.

Placing an expression in parentheses causes that expression to beevaluated before the operator precedence and associativity rules areapplied.

Operator precedence and associativity are shown in Example 4 onpage 79.

PrecedenceTable 24 shows the precedence of match string operators.

AssociativityOperators of equal precedence are applied left-to-right.

Table 23 Possible Filesize-Units values in match string expressions

Filesize-Units value Description

bytes Bytes

KB Kilobytes

MB Megabytes

GB Gigabytes

Table 24 Operator precedence in a match string

Precedence order Operator

First < and <=

Second > and >=

Third == and <>

Fourth AND

Fifth OR


Extended Rules

Example 4 Operator precedence and associativity

Match String 1 (displayed):

(FILENAME=="*data*" OR FILENAME=="*info*") AND UID<>123

The group of files defined by this match string contains both of thefollowing:

◆ All files in the file system that do not have the user ID 123, andhave the string "data" in their pathname.

Note: This includes files whose pathname includes a directory with"data" in its name. The matching logic views a pathname as a singlestring expression. The character (/), normally consider a directory pathcharacter, is treated the same as any other character.

◆ All files in the file system that do not have the user ID 123, andhave the string "info" in their pathname.

In Match String 1 the OR operator is applied before the ANDoperator because of the parentheses around the first two expressions.The expression "UID not equal to 123" ("UID<>123") is applied to theresulting two sets of files.

Match String 2 (displayed):

FILENAME=="*data*" OR FILENAME=="*info*" AND UID<>123

The group of files defined by this match string is different from thegroup defined by Match String 1.

The Match String 2 group contains both of the following:

◆ All files in the file system that have the string "data" in theirpathname.

◆ All files in the file system that do not have the user ID 123, and dohave the string "info" in their pathname.

In Match String 2 the AND operator is applied before the ORoperator. The expression "UID not equal to 123" ("UID<>123") isapplied only to the set of files generated by the expression:

FILENAME=="info"


Extended Rules

How to create an extended ruleTo create an extended rule:



2. On the tree pane, select the file system that will use the extendedrule.

Note: Only a file system that is managed by FSM can use extended rules.

3. On the View menu, select Extended Rules.

The file system's Extended Rules tab appears.

4. On the Extended Rules tab, click Create New Rule.

The Extended Rule wizard appears.

5. In Rule Name, type a name for the new rule.

The name may be any combination of ASCII characters, from 1 to32 characters in length. The name cannot match the name of anyother extended rule in the file system.

6. (Optional) In Migrate Candidacy Delay, specify a number ofminutes after a matched file is last accessed before it can bemigrated.


7. (Optional) In Purge Candidacy Delay, specify a number ofminutes after a matched and migrated file is last accessed beforeit can be purged.


8. Form a match string:

a. (Optional) Click the left-parenthesis to type one or moreleft-parenthesis.

Parentheses are used to control operator precedence andassociativity.

b. Select one of the following keywords: FILENAME, UID, GID,FILESIZE.


Extended Rules

The keyword defines the type of metadata used to define thematched set of files.

Select one of the following operators:

== , <> , > , >= , < , or <=.

c. Type a value in the text box, as follows:

– For the FILENAME keyword, type a string.– For the UID keyword, type a quoted string, or an integer.– For the GID keyword, type a quoted string, or an integer.– For the FILESIZE keyword, type an integer.

Note: Wildcard characters may be used for keyword FILENAME,and for keywords UID and GID when a quoted string is used. Thescale of the integer entered for keyword FILESIZE is determined bythe size units.

d. (For keyword FILESIZE only) Select the size units: bytes, KB,MB, or GB.

e. Click Add.

The expression is added to the Match String.

f. (Optional) Type one or more right-parenthesis to enclose anexpression or expression group.

The parentheses appear in the Match String.

g. (Optional) Click AND or OR.

The operator appears in the Match String.

h. (Optional) Click NOT to modify an AND or OR operator.

An exclamation mark appears following the AND or ORoperator, changing them to AND NOT and OR NOT.

i. (Optional) Repeat step a through step h to add anotherexpression to the Match String.

j. Click the right-parenthesis to close all open left-parentheses.

The number of right-parentheses in the Match String mustequal the number of left-parentheses.


Extended Rules

Note: Click Undo to remove the latest element added to the MatchString (an expression is considered a single element). Click Clear toremove all elements from the Match String.

9. Click Next.

The Actions and Checksum panel appears.

10. (Optional) Select Do Not Migrate to prevent migration ofmatched files.

11. (Optional) Select Do Not Purge to prevent purging of matchedfiles.

12. (Optional) Select Purge After Migrate to allow immediatepurging of matched and migrated files.

The default is to use the file system's Delay Until PurgeCandidacy setting.

13. (Optional) Select Enable Data Compression and set a datacompression level.

When you enable this setting, file system data is compressedbefore it is migrated. Data compression level 1 is the least amountof compression and level 9 is the highest.

The higher the compression you set the more the file systemhost's CPU will be utilized.

Note: Selecting Enable Data Compression prevents the use of the stagingsetting Partial Read Size.

14. (Optional) In Stub Size, set the number of kilobytes retained inthe file system for matched files.

The range is 0 to 131,072 KB (128 MB). The default is 0.

15. In Checksum, select a checksum setting, as described in Table 25on page 83.


Extended Rules

16. In File Time Purge Policy, select either Purge on LastModification Time or Purge on Last Access Time.

This setting determines the starting point for the Delay UntilPurge Candidacy period:

• Purge on Last Modification Time starts the period after thelast modification of a file.

• Purge on Last Access Time starts the period after the last timethe file was accessed.

17. In File Time Migration Policy, select either Migrate on LastModification Time or Migrate on Last Access Time.

This setting determines the starting point for the Delay UntilMigrate Candidacy period:

• Migrate on Last Modification Time starts the period after thelast modification of a file.

• Migrate on Last Access Time starts the period after the lasttime the file was accessed.

18. Click Next.

19. Complete the module-specific extended rule actions for theLevel 1 back-end system.

Table 25 Descriptions of Checksum settings

Setting Description

Use file system checksum value Checksums are generated as specified in the filesystem's Checksum setting.This is the default.

No checksumming Checksums will not be generated for matchedfiles.

Checksum during migration A checksum is generated for each matched filewhen it is migrated.

Checksum during migration and staging A checksum is generated for each matched filewhen it is migrated. The checksum isregenerated and compared to the original whenthe file is staged.


Extended Rules

Procedures for module-specific configurations appear in thefollowing sections:

• “Centera module actions” on page 84

• “NFS actions” on page 85

• “FTP actions” on page 85

20. (Optional) If you selected a Level 2 back-end system, completethe module-specific extended rule actions related to it.

21. Click Finish.

The extended rule is validated, saved, and committed.

Centera module actionsTo configure extended rule actions for a Centera module back-endsystem:

1. In Retention Period, select one of the settings described inTable 26.

If you select Days, then set the number of days. The range is 1 to36,500 days.

2. In Retention Class, type the name of a valid EMC Centeraretention family to apply to matched files.

3. Click Next.

Table 26 Descriptions of Retention Period settings

Setting Description

Do Not Set Deleted data for matched files is retained for the period specified by the EMCCentera.This is the default and has the same result as selecting Default.

None Deleted data for matched files is immediately available for purging from theEMC Centera.

Default Deleted data for matched files is retained for the period specified by the EMCCentera.

Infinite Deleted data for matched files is never available for purging from the EMCCentera.

Days Deleted data for matched files is not available for purging from the EMCCentera until after the specified number of days.


Extended Rules


5. Click Finish.


NFS actions There are no extended rule actions specific to an NFS back-endsystem. All general actions are applied.

To finish creating the extended rule:

1. Click Next.


3. Click Finish.


FTP actions There are no extended rule actions specific to an FTP back-endsystem. All general actions are applied.

To finish creating the extended rule:

1. Click Next.


3. Click Finish.



Extended Rules

Viewing extended rulesTo view the extended rules for a file system:





The file system's Extended Rules tab appears.

The Extended Rules tab displays all rules for the file system.

For each rule, the columns on the Extended Rules tab list the rule'sgeneral actions. The columns correspond to the actions described in“Creating an extended rule” on page 74.

For each rule, the Extended Rules tab also displays any back-endsystem specific actions. The actions listed correspond to the actionsdescribed in:

◆ “Centera module actions” on page 84

Editing an extended rule 87

Extended Rules

Editing an extended ruleAn administrator may edit an extended rule.

How to edit an extended ruleTo edit an extended rule:




3. On the View menu, select Extended Rule.

The Extended Rules tab appears.

4. Select an extended rule to edit.

5. Click Edit Rule.

The Extended Rule wizard opens in edit mode. Attributes thatcannot be edited are dimmed.

6. Make changes as needed and click Next to go to the next panel.

“Creating an extended rule” on page 74 provides moreinformation about individual settings.

Note: The Extended Rule wizard in edit mode is identical to theExtended Rule wizard, except that the match string Undo button isunavailable. The match string may not be edited by using Undo. To editthe match string, click Clear. This clears the existing match string so thata new match string can be created.


The edited extended rule is validated, saved, and committed.


Extended Rules

Deleting an extended ruleAn administrator may delete an extended rule. After deletion, theextended rule is no longer applied to the file system.

Deleting an extended rule does not affect the following:

◆ The file system’s configuration information

◆ The file system’s data

How to delete an extended ruleTo delete an extended rule:




3. On the View menu, select Extended Rule.

The Extended Rules tab appears.

4. Select an extended rule to delete.

5. Click Delete Rule.

A confirmation prompt appears.

6. Click Yes.

The extended rule is deleted.

Copying extended rules 89

Extended Rules

Copying extended rulesAn administrator may copy extended rules between file systems inthe same management domain. This copies only the selectedextended rules. File system configuration information and file systemdata are not copied.

How to copy extended rulesTo copy extended rules:

1. Start Console Client and log in to the management domain thatcontrols the FSM hosts for the file systems.


2. From the Edit menu, select Copy Extended Rule.

The Copy Extended Rule window appears.

3. In Copy From File System, select an FSM host and file system tocopy from.

4. In Copy To File System, select an FSM Host and file system tocopy to.

Note: The file system selected in Copy To File System must use the sameback-end module as the file system selected in Copy From File System.

5. In Extended Rule, select an extended rule to copy, or select CopyEntire Rule Set.

Selecting Copy Entire Rule Set copies all of the extended rules forthe selected file system.

6. Click OK to perform the copy operation.

The selected extended rules are copied.


Extended Rules

Scheduled Jobs 91

5

This chapter describes schedules in the following topics:

◆ Scheduled jobs overview .................................................................. 92◆ Creating a scheduled job................................................................... 96◆ Time elements................................................................................... 102

Scheduled Jobs


Scheduled Jobs

Scheduled jobs overviewScheduled jobs allow you to define automatic run periods andblackout periods for the following file system jobs:

◆ Migrate

◆ Purge

◆ Delete Old Files

◆ Prune

For each managed file system, you can create one Migrate job andone Purge job. You can also create one Delete Old Files job and onePrune job for each of the file system’s back-end systems.

Table 27 on page 92 compares each job before and after a scheduledjob is created for it.

Table 27 Scheduled job comparison

Job type Without a scheduled job With a scheduled job

Migrate Runs automatically. Checks for migrationcandidates on the interval defined by the filesystem's Sleep Interval Until Next Migrationsetting.

Runs automatically during defined runtimes. Checks formigration candidates on the interval defined by the runtimeelement. Stops running during defined blackout times.

Purge Runs automatically. Checks for purge candidateson the interval defined by the file system’s SleepInterval Until Next Purge setting.

Runs automatically during defined runtimes. Checks forpurge candidates on the interval defined by the runtimeelement. Stops running during defined blackout times.

Delete OldFiles

Must be run manually as described in “Periodicback-end system cleanup” on page 167.

Runs automatically during defined runtimes. Deletesorphaned files on the back-end system (as described in“Delete Old Files job” on page 94) on the interval defined bythe runtime element. Stops running during defined blackouttimes.

Prune Will not run. Runs automatically during defined runtimes. Only runs onthe Level 1 back-end system, and only if the file system alsohas a Level 2 back-end system. Stops running duringdefined blackout times.Files on the Level 1 back-end system are “pruned” (markedas deleted) when the number of days since their migrationexceeds the number of days set in the expiration period.Pruned files become available for removal by back-endsystem cleanup or Delete Old Files jobs.File system data is not affected by pruning and files are notremoved from the Level 2 back-end system.

Scheduled jobs overview 93

Scheduled Jobs

A scheduled job consists of a standard file system job with anassigned schedule. The assigned schedule consists of the componentsdescribed in Table 28 on page 93.

Effect on existing file system settingsA scheduled job can honor some file system settings and overruleothers.

Which settings are honored and which are overruled depends on thetype of job scheduled, as described in Table 29 on page 94.

Table 28 Components of a schedule

Component Description

Name Descriptive label for the schedule. The Name value must be unique foreach schedule created for a file system.

Description Information about the schedule's purpose.

Run Time Time perioda during which the task is started regularly on the wake-upinterval. More than one Run Time may be assigned to a schedule.

Note: Blackout times have priority over runtimes. Jobs do not run duringtime periods in which blackout time segments coincide with runtimesegments.

Black Out Time Time period that the task cannot be run. More than one Black Out Timevalue may be assigned to a schedule.

a. Time periods are defined by the assigned time elements. Time elements are described in“Creating a scheduled job” on page 96.


Scheduled Jobs

Delete Old Files job The Delete Old Files job removes files on a back-end system that havebecome orphaned because the files have been deleted from the filesystem. Those files are marked for deletion by FSM but are notautomatically removed. Delete Old Files jobs have the same effect asthe manual maintenance procedures described in “Periodic back-endsystem cleanup” on page 167.

If a file system has two back-end systems, the Delete Old Files jobonly runs for the back-end system that is selected. The behavior of ascheduled Delete Old Files job changes depending on the type ofback-end target. The differences are described in Table 30 on page 95.

Table 29 Effect of a scheduled job on file system settings

Job type Honored settings Overruled settings Effect

Migrate • Delay Until MigrateCandidacy

• Minimum File Size toMigrate

• Extended Rules

Sleep Interval Until NextMigration

Once a migrate job is scheduled, migrationof eligible files is only started during the job'sruntimes. No files are migrated during thejob's blackout times.During runtimes the eligibility logic specifiedby the file system settings is applied.Extended rules are only applied duringscheduled runtimes.

Purge • Delay Until PurgeCandidacy

• Minimum File Size toPurge

• Concurrent Files Purged• File Stub Size• High Watermark• Low Watermark• Concurrent Files Migrated• Extended Rules

• Sleep Interval Until NextPurge

• Purge After Migrate

Once a purge job is scheduled, purge ofeligible files is only started during the job'sruntimes. No files are purged during the job'sblackout times.A scheduled purge job can also overrule anenabled Purge After Migrate setting bypreventing the immediate purging of files thatare migrated during the purge job's blackouttimes.During runtimes the eligibility logic specifiedby the file system settings is applied.Extended rules are only applied duringscheduled runtimes.

Delete Old Files Concurrent Files Destroyed None None

Prune None None None

Scheduled jobs overview 95

Scheduled Jobs

Prune job The Prune job removes files from a Level 1 back-end system after aset number of days (expiration period). This clears the Level 1back-end system of older files, but the availability of all files is notaffected. When files that have been pruned are needed they areretrieved from the Level 2 back-end system.

Prune jobs have the following characteristics:

◆ Run only on Level 1 back-end systems

◆ Run only when the file system has both Level 1 and Level 2back-end systems

◆ Cannot be run manually

◆ Files must be migrated before they are eligible for pruning

◆ Files do not need to be purged to be eligible for pruning

Table 30 Delete Old Files job differences

Module type Description

Centera The Delete Old Files job applies to all eligible file data from all UTDM filesystems that share the same virtual pool on an EMC Centera.

Note: To avoid performance issues on the EMC Centera, only schedule aDelete Old Files job on one UTDM file system in any virtual pool. Since thejob runs for all UTDM file systems in the virtual pool, scheduling more thanone job wastes resources on the EMC Centera.

FTP The Delete Old Files job is not available for an FTP module back-endsystem. This task must be performed on the back-end host. “Periodicback-end system cleanup” on page 167 describes how to do this.

NFS The Delete Old Files job applies to the selected file system only.


Scheduled Jobs

Creating a scheduled jobIn overview, creating a scheduled job involves the following tasks:

1. Select a file system.

2. Select a job type: Migrate, Purge, Delete Old Files, or Prune.

3. If creating a Delete Old Files or Prune job, select a back-endsystem.

4. If creating a Delete Old Files and Prune job, set the Age orExpiration Period.

5. Create a named schedule.

6. Create time elements.

7. Add time elements to the Run Times and Black Out Times of theschedule.

8. Assign the schedule to the job.

For each managed file system you can create the following jobs:

◆ One Migrate job

◆ One Purge job

◆ One Delete Old Files job for the Level 1 back-end system and onefor the optional Level 2 back-end system

◆ One Prune job for the Level 1 back-end system only

Schedules that you create may be assigned to more than onescheduled job and may be used on more than one file system.

How to create a scheduled jobTo create a scheduled job:

1. On the tree pane, select the file system that will use the scheduledjob.

2. On the View menu, select Schedules.

The Schedules window is displayed with the file system listed inFile System.

3. Select the Jobs tab, and in Job Type select a job type to assign tothe schedule.

Creating a scheduled job 97

Scheduled Jobs

4. (For Delete Old Files and Prune jobs only) In Backend, select theLevel 1 or Level 2 back-end system.

This setting only effects Delete Old Files and Prune jobs.

Note: To schedule a Prune job the Level 1 back-end system must beselected. The Assigned Schedule section is not available, and a Prune jobcannot be scheduled, if the Level 2 back-end system is selected (or if thefile system only has a Level 1 back-end system).

5. (For Delete Old Files and Prune jobs only) Set a number of days:

• Delete Old Files job—in Age (days), set the number of daysthat must pass, after the deletion of a file from the file system,before the file's data is eligible to be deleted from the selectedback-end system.

The default is 365 days. The range is 0 to 999,999 days.

Note: Back-end system data can be used to restore files that aremistakenly deleted from the file system. To maximize this safeguard,set the Age value high to retain back-end data as long as possible.

• For a Prune job, in Expiration Period, set the number of daysthat must pass, after migration, before a file is pruned.

The default is 365 days. The range is 1 to 999,999 days.

6. Select the Schedules tab, and in the Configured Schedulessection click the Create a New Schedule icon.

7. On the Create a New Schedule box, enter a name for the scheduleand click OK.

Note: The schedule's name must be unique among all schedules on thefile system's host. Use a descriptive name to make the schedule easier torecognize.

8. On the Schedules tab, in the Time Elements section, click theAdd a New Time Element icon to open the Create a New TimeElement wizard.

9. Use the Create a New Time Element wizard to create and savethe time elements required for the new schedule.

“Create a new time element” on page 102 describe how to usethis wizard.


Scheduled Jobs

10. Select a time element to add as a runtime for the schedule, andclick the Add the Selected Time Elements to the Current RunTimes icon.

Repeat this process to add any other time elements to Run Times.

Note: Blackout times have priority over runtimes. Jobs do not run duringtime periods in which blackout time segments coincide with runtimesegments.

11. Select a time element to add as a blackout time for the schedule,and click the Add the Selected Time Elements to the CurrentBlack Out Times icon.

Repeat this process to add any other time elements to Black OutTimes.

12. Click Save.

The new schedule is added to Configured Schedules.

13. In the Assigned Schedule section, click the Select a Schedule toUse icon.

14. On the Choose a Schedule box, select the name of the scheduleyou created, and click OK.

The scheduled job is created and is assigned to the file system. It isgraphically displayed in the monthly and daily calendars.

Viewing a scheduled jobScheduled jobs are graphically and textually displayed on the Jobstab.

To view the Jobs tab for a file system:



The Schedules window is displayed.

3. Select the Jobs tab.

The Jobs tab displays the schedules for each job type in thecalendar month section.


Scheduled Jobs

4. In Month and Year, select the month and year that you wish toview.

The calendar month displays the selected month.

5. In the calendar month section, click on a day of the month.

The job schedules for that day are graphically portrayed in the dayview, and textually displayed in the Time Spans view.

Editing a schedule Editing a schedule involves the following tasks:

◆ Remove all assigned tasks from the schedule.

◆ Remove time elements that need to be changed from theschedule's Run Times and Black Out Times.

◆ Edit time elements and create new time elements.

◆ Add time elements to the schedule's Run Times and Black OutTimes.

◆ Save the schedule.

To edit a schedule:

1. On the tree pane, select the file system that uses the schedule.


The Schedules window appears.

3. On the Jobs tab, in the Selected Jobs section, select a Job Typethat is assigned to the schedule.

4. In the Assigned Schedule section, click the Revert Back icon.

Repeat steps 3 and 4 for each Job Type that is assigned to theschedule.

5. On the Schedules tab, in the Configured Schedules section,select the schedule.

6. In the schedule's Run Times section, select a time element toremove or edit and click Remove.

Repeat this for each time element that you wish to remove or edit.

7. In the schedule's Black Out Times section, select a time elementto remove or edit and click Remove.

Repeat this step for each time element to remove or edit.


Scheduled Jobs

8. In the Time Elements section, click the Add a New Time Elementicon to create a new time element, or select an existing timeelement and click Edit the Selected Time Element to edit it.

Both actions open the Create a New Time Element wizard. Usethe wizard to configure and save the time element as described in“Create a new time element” on page 102.

Repeat this for each time element to add to the edited schedule.

9. Select a time element to add as a runtime for the schedule, andclick the Add the Selected Time Element to the Current RunTimes icon.

Repeat this process to add any other time elements to Run Times.

10. Select a time element to add as a blackout time for the schedule,and click the Add the Selected Time Element to the CurrentBlack Out Times icon.

Repeat this process to add any other time elements to Black OutTimes.

11. Click Save.

The new schedule is added to Configured Schedules and is ready touse.

To complete the schedule a task must be assigned. This is described in“How to create a scheduled job” on page 96.

Deleting a schedule Deleting a schedule involves the following tasks:

◆ Removing all assigned tasks from the schedule

◆ Deleting the schedule

To delete a schedule:

1. On the tree pane, select the file system that uses the schedule.


The Schedules window appears.

3. On the Jobs tab, in the Selected Jobs section, select a job type thatis assigned to the schedule.


Scheduled Jobs


Repeat steps 3 and 4 for each job type that is assigned to theschedule.

5. On the Schedules tab, in the Configured Schedules section,select the schedule and click the Delete the Selected Scheduleicon.

The schedule is deleted.


Scheduled Jobs

Time elementsTime elements are the building blocks of a schedule. Before you cancreate a scheduled job you must create at least one time element.Table 31 on page 102 describes the components of a time element.

“Creating a scheduled job” on page 96 describes how to create ascheduled job by using the available time elements.

Create a new time elementTo create a new time element:

1. On the Schedules tab, in the Time Elements section, click theAdd a New Time Element icon.

The Create a New Time Element wizard launches.

2. Select one of the recurrence options.

Table 32 on page 103 describes the options.

Table 31 Components of a time element

Component Description

Recurrence The calendar cycle that provides the framework for the schedule. Thiscan be daily, weekly, monthly, yearly, weekends, or weekdays.

Wake-up interval Time interval on which the task is started. The task is started at eachwake-up interval during the runtime. However, if the task is alreadyrunning from a previous wake-up, additional processes are notstarted.

Note: The wake-up interval is determined based on the host’s internalclock, not the last start or finish of the job. For example, a 15 minutewake-up interval with a daily recurrence would check if the job isrunning and start it if is not at: midnight, 12:15 A.M., 12:30 A.M., 12:45A.M., and so forth.

Start time Beginning of the time period included in a time element.

End time End of the time period included in a time element.

Time elements 103

Scheduled Jobs

3. Click Next.

The fields on the wizard's second screen change depending uponthe recurrence option selected.

To complete the creation of a time element go to the relevantsection:

• “One Specific Time” on page 104

• “Daily” on page 104

• “Monthly” on page 105

• “Weekends” on page 105

• “Weekly” on page 105

• “Yearly” on page 106

• “Weekdays” on page 106

Table 32 Recurrence options

Name Description

One Specific Time Starts a job on a specific date and time and does not recur.

Daily Starts a job every day at a specific time.

Monthly Starts a job on a specific day of the month at a specific time andrecurs each month.

Weekends Starts a job at a specific time on Saturday and Sunday and recursevery Saturday and Sunday.

Weekly Starts a job on a specific day of the week at a specific time and recursevery week.

Yearly Starts a job on a specific month, day of the month, and time andrecurs every year.

Weekdays Starts a job at a specific time on each weekday (Monday-Friday) andrecurs every weekday.


Scheduled Jobs

One Specific Time To complete a time element that uses the One Specific Timerecurrence option:

1. In Wake Up Interval, specify the number of minutes that shouldpass between checks to see if the job is running and, if it is not,start the job.

During specified runtime, the job is checked on the wake-upinterval to see if it is running. If the check shows that the job hasfinished, it is started again. The wake-up interval is determinedfrom the host’s internal clock, not from when the job last startedor finished.

2. In Year, specify the year for the time element.

3. In From, specify the month, day, and time to start.

This is the one time at which the time element starts the jobrunning.

4. In Until, specify the month, day, and time that the time elementstops running, or select Do not stop.

A Do not stop selection configures the time element to start at thestart time and run until the end of the year.

5. Click Finished.

Daily To complete a time element that uses the Daily recurrence option:


2. In From, specify a start time.

This is the time every day at which the time element starts the jobrunning.

3. In Until, specify the time that the time element stops running, orselect Do not stop.

A Do not stop selection configures the time element to start at thestart time and run until the end of the day.

4. Click Finished.

Time elements 105

Scheduled Jobs

Monthly To complete a time element that uses the Monthly recurrence option:


2. In From, specify the day of the month and time to start.

This is the time every month at which the time element starts thejob running.

3. In Until, specify the day of the month and time that the timeelement stops running, or select Do not stop.

A Do not stop selection configures the time element to start at thestart time and run until the end of the month.

4. Click Finished.

Weekends To complete a time element that uses the Weekends recurrenceoption:



This is the time every Saturday and Sunday at which the timeelement starts the job running.


A Do not stop selection configures the time element to start at thestart time and run until the end of the day.

4. Click Finished.

Weekly To complete a time element that uses the Weekly recurrence option:


2. In From, specify the day of the week and time to start.

This is the time every week at which the time element starts thejob running.


Scheduled Jobs

3. In Until, specify the day of the week and time that the timeelement stops running, or select Do not stop.

A Do not stop selection configures the time element to start at thestart time and run until the end of the week.

4. Click Finished.

Yearly To complete a time element that uses the Yearly recurrence option:


2. In From, specify the month, day, and time to start.

This is the time every year at which the time element starts the jobrunning.

3. In Until, specify the month, day, and time that the time elementstops running, or select Do not stop.

A Do not stop selection configures the time element to start at thestart time and run until the end of the year.

4. Click Finished.

Weekdays To complete a time element that uses the Weekdays recurrenceoption:



This is the time every weekday at which the time element startsthe job running.


A Do not stop selection configures the time element to start at thestart time and run until the end of day.

4. Click Finished.

Time elements 107

Scheduled Jobs

Editing a time elementTo edit a time element:

1. On the Schedules tab, in the Time Elements section, select thetime element.

2. Click the Add a New Time Element icon.

The Create a New Time Element wizard launches with selectedtime element’s settings.

3. Use the wizard to edit the time element settings and clickFinished.

Deleting a time elementDeleting a time element involves the following tasks:

◆ Removing the time element from each schedule in a file system.

◆ Deleting the time element.

To delete a time element:

1. On the tree pane, select the file system that uses the time element.


The Schedules window is displayed.

3. On the Jobs tab, in the Selected Jobs section, select a Job Typethat is assigned to a schedule that uses the time element.


5. Repeat steps 3 and 4 for each job type that is assigned to aschedule that uses the time element.

6. Repeat steps 3, 4, and 5 for each schedule that uses the timeelement.

7. On the Schedules tab, in the Configured Schedules section,select the schedule.

8. If the time element is in the schedule's Run Times section, select itand click Remove.

9. If the time element is in the schedule's Black Out Times section,select it and click Remove.


Scheduled Jobs

10. Repeat steps 7, 8, and 9 for each schedule that uses the timeelement.

11. On the Schedules tab, in the Time Elements section, select thetime element and click the Delete the Selected Time Elementicon.

Advanced UTDM Mount Options 109

6

This chapter describes the following mount options:

◆ EMC Centera data retention........................................................... 110◆ Read-only .......................................................................................... 117◆ Direct-read ........................................................................................ 120

Advanced UTDMMount Options


Advanced UTDM Mount Options

EMC Centera data retentionEMC Centera data retention uses the bckendreten mount option toprovide a mechanism to prevent the following data operations in thefile system and on the back-end system:

◆ Overwrite

◆ Truncation

◆ Removal

◆ Modification of its metadata

◆ Modification of its retention period

These operations cannot be initiated in the file system or on the EMCCentera by any process, including non-FSM processes, for files thathave been migrated or that are eligible for migration. A file is eligiblefor migration if it has not been modified for at least the periodspecified in the file system’s Delay Until Migrate Candidacy value.

When a file is subject to EMC Centera data retention, the file’s datacannot be changed during the retention period, in the file system oron the EMC Centera. Data on a secondary back-end system is notprotected by this data retention mechanism.

Performance impactUTDM file systems that are mounted with the bckendreten mountoption generate a retention event to the core processes when a filemodification operation is attempted. This event determines whetherthe modification is allowed.

The core processes instruct the UTDM file system to deny the attemptif either of the following is true for a file:

◆ The file is migrated and there is an unexpired retention period forits data on the EMC Centera.

◆ The file is not migrated and has not been modified within theperiod specified in the file system’s Delay Until MigrateCandidacy value. There is also a Centera Retention Period orCentera Retention Class associated with the file.

The retention events can have a performance impact on filemodification operations. A slight impact can occur because the core

EMC Centera data retention 111


processes must query the EMC Centera for the applicable retentionperiod.

Retention events will not adversely impact normal file creationoperations. UTDM file systems do not generate a retention eventduring the first minute after a file is created or modified.

Requirements EMC Centera data retention requires the following:

◆ The EMC Centera must use one of the following license models:

• Basic Compliance

• Compliance Plus

◆ The UTDM file system must use the EMC Centera as its primaryback-end system.

◆ The UTDM file system configuration must specify at least one ofthe following:

• A value in Retention Class

• A value in Retention Period other than None

• An extended rule that sets a retention period or retention class

◆ The file system must be mounted with the bckendreten mountoption.

◆ The FSM host system and the Centera should be in the sametimezone for retention to be in sync.

Enabling EMC Centera data retentionTo set EMC Centera data retention periods, first enable retention forthe file system. Retention is specified by using the bckendretenoption when mounting the file system.

To enable EMC Centera data retention for a file system:

1. Log in to the file system’s host as root.


“Setting the FSM environment” on page 177 for moreinformation.

3. Stop all FSM processes:

kill.fsm



4. If the file system is mounted, unmount it:

umount [-f] /file-system

where /file-system is the full path to the file system’s mount point.

Note: On Linux systems, the -f option must be used when you unmounta UTDM type file system. This is because the file system is viewed asbusy by the operating system.

5. Mount the file system by using one of the methods shown inTable 33 on page 112.

The variables for the procedures shown in Table 33 are as follows:

• fstype is the native type of the file system.

• blkdev is the full path to the block special device.

• mntpnt is the full path to the mount point.

• chardev is the full path to the character special device.

• log is the log file that is generated for the logical volume.

Table 33 Mounting with EMC Centera data retention (page 1 of 2)

Mounting method Procedure

Command line(All operating systems,except Linux and AIX)

As root, run the following mount command:mount-F utdm -o fstype=fstype,bckendreten /blkdev/mntpnt

Command line(Linux only)

As root, run the following mount command:mount-t utdm -o fstype=fstype,bckendreten /blkdev/mntpnt

Command line(AIX only)

As root, run the following mount command:mount-V utdm -o fstype=fstype,bckendreten /blkdev/mntpnt



6. Restart the FSM processes:

rc.fsm

EMC Centera data retention is enabled for the file system.

Setting retention for a file systemTo set EMC Centera data retention for all files in a file system:

1. Mount the file system by using the bckendreten mount option.

“Enabling EMC Centera data retention” on page 111 providesmore information.


“How to start Console Client” on page 24 describes how to startConsole Client and log in to a management domain.



The File System Configuration wizard opens in edit mode.

5. Click Next until the Level 1 - Centera Backend panel appears.

File system table(Solaris only)

As root, edit the /etc/vfstab file so that the entry for the file system uses thebckendreten option, as shown here:/blkdev /chardev /mntpnt utdm 2 yesfstype=fstype,bckendreten

Save the file and mount the file system:mount /mntpnt

File system table(Linux and HP-UX only)

As root, edit the /etc/fstab file so that the entry for the file system uses thebckendreten option, as shown here:/blkdev /mntpnt utdm fstype=fstype,bckendreten 0 2


File system table(AIX only)

As root, edit the /etc/filesystems file so that the options line of the file system’sentry includes the bckendreten option:options=rw,fstype=fstype,log=/dev/log,bckendreten


Table 33 Mounting with EMC Centera data retention (page 2 of 2)




6. In Retention Class, type the name of an EMC Centera retentionclass.

Note: If a suitable retention class does not exist on the EMC Centera, youcan specify a retention period. However, Retention Period cannot beNone if Retention Class is empty.

7. Click Next until the Finish and Commit panel appears.

8. Click Finish.

The configuration is validated, saved, and committed. The filesystem is ready to use and EMC Centera data retention is active.

Note: Steps 1 through 8 describe how to edit an existing file systemconfiguration to set EMC Centera data retention. You may edit other filesystem configuration parameters when performing these steps. You can alsoset EMC Centera data retention when a file system is first configured.

Setting retention for a group of filesTo set EMC Centera data retention for a group of files in a file system:

1. Mount the file system by using the bckendreten mount option.

“Enabling EMC Centera data retention” on page 111 providesmore information.





5. On the Extended Rules tab, click Create New Rule.

The Extended Rule wizard appears.

6. In Rule Name, type a name for the new rule.

The name may be any combination of ASCII characters, from 1 to32 characters in length. The name cannot match the name of anyother extended rule in the file system.



7. Form a match string that identifies the group of files.

“Creating an extended rule” on page 74 provides informationabout forming a match string.

8. Click Next until the Centera Actions panel for the primaryback-end system appears.

9. In Retention Class, type the name of a valid EMC Centeraretention class.

Note: If a suitable retention class does not exist on the EMC Centera, youcan specify a retention period. However, Retention Period cannot beNone if Retention Class is empty.


11. Click Finish.

The extended rule is validated, saved, and committed. The filesystem is ready to use and EMC Centera data retention is active forthe specified group of files.

Note: Steps 1 through 11 describe how to create an extended rule to set EMCCentera data retention for a group of files. You may specify other extendedrule parameters when performing these steps. You can also edit an existingextended rule to add EMC Centera data retention.

Restoring incremental backupsEMC Centera data retention can prevent the use of incrementalbackups to restore some files to a UTDM file system. The affected filesare those that have all of the following characteristics:

◆ The file is not a migration candidate when the full backup iscreated.

◆ The file is modified after the full backup is created and beforeincremental backup is created.

◆ The time between the creation of the full backup and the restoringof the incremental backup is greater than the value of the DelayUntil Migrate Candidacy value.

When all of these characteristics are true for a file, the UTDM filesystem allows the restore of the file from the full backup, but rejectsthe restore of the file from the incremental backup.



To restore incremental backups while using EMC Centera dataretention:





The File System Configuration wizard opens in edit mode.Attributes that cannot be edited are unavailable.

4. Click Next until the Optional Migration Settings panel appears.

5. Increase the value of Delay Until Migrate Candidacy.

The value of Delay Until Migrate Candidacy is expressed inminutes. It must be increased to be greater than the number ofminutes from the time of the full backup to the time of the restore.


7. Click Finish.

The edited configuration is validated, saved, and committed.

8. Perform a restore by using the incremental backup.

9. Change Delay Until Migrate Candidacy back to its originalvalue.

Restore of the incremental backup is complete.

Read-only 117


Read-onlyThis release provides the utdmro mount option to permit a UTDMfile system to be mounted read-only.

A read-only mounted UTDM file system functions the same as astandard read-only mounted file system, with one exception: whenthe UTDM read-only mount option is used, the .DMATTR file isallowed to function normally.

This exception is required to permit the file system to exchange datawith the back-end system and perform DMAPI processing.

A read-only, mounted UTDM file system permits the following filesystem activity:

◆ Reading files

◆ Reading files by using direct-read

◆ Directory traversals

◆ Migration

Files that are ready to migrate after the file system is mountedread-only will not be migrated.

◆ Purge

◆ Staging

◆ Backup

◆ Recovery processing

To perform a recovery, mount the file system normally withRead/Write permissions and perform the complete recovery ofthe file system before the file system is remounted in read-onlymode.

IMPORTANT!A UTDM file system must be mounted read-write before a recoverycan be performed.

A read-only mounted UTDM file system does not allow:

◆ File deletions

◆ File permissions or attribute changes

◆ File data modification or truncations



Mounting read-only To mount a UTDM file system read-only:





kill.fsm






The variables for the procedures shown in Table 34 on page 118are as follows:






Table 34 Mounting read-only (page 1 of 2)



As root, run the following mount command:mount-F utdm -o fstype=fstype,utdmro /blkdev /mntpnt


As root, run the following mount command:mount-t utdm -o fstype=fstype,utdmro /blkdev /mntpnt


As root, run the following mount command:mount-V utdm -o fstype=fstype,utdmro /blkdev /mntpnt

Read-only 119



As root, edit the /etc/vfstab file so that the entry for the file system uses thebckendreten option, as shown here:/blkdev /chardev /mntpnt utdm 2 yes fstype=fstype,utdmro



As root, edit the /etc/fstab file so that the entry for the file system uses thebckendreten option, as shown here:/blkdev /mntpnt utdm fstype=fstype,utdmro 0 2



As root, edit the /etc/filesystems file so that the options line of the file system’sentry includes the bckendreten option:options=rw,fstype=fstype,log=/dev/log,utdmro


Table 34 Mounting read-only (page 2 of 2)




Direct-readThis release provides the readthru mount option to enable direct-readon a UTDM file system. Direct-read enhances file systemperformance by delivering file data from the back-end systemdirectly to a requesting application’s buffers without first writing thedata into the file system.

Direct-read works with multiple back-end systems. If the primaryback-end system cannot be read, the direct-read request is made ofthe secondary back-end system.

Note: Direct-read does not work if NFS is configured as Level 1 and Centeraas the Level 2 back-end system.

The direct-read mount option can be used on any UTDM file system.However, only the following back-end modules support it:

◆ NFS

◆ Centera

When a file system that is mounted with direct-read requests datafrom an unsupported back-end system the data is staged into the filesystem and then transferred to the application’s buffers.

Direct-read applies only to reading a file. If the file’s data is altered inany way, then the file is staged into the file system as it would bewithout direct-read.

Note: The readthru mount option does not work for pruned and compressedfiles.

Memory-mapping Applications that use the mmap function call to perform memorymapping of file data cannot benefit from direct-read. When aapplication uses this function the back-end data is staged into the filesystem as it would be without direct-read.

In particular, Solaris uses the mmap function call in many of itssystem utilities, such as cat and cp. The GNU versions of theseutilities do not use the mmap function and allow direct-read to work.

Direct-read 121


Mounting direct-readTo mount a UTDM file system direct-read:





kill.fsm






The variables for the procedures shown in Table 35 are as follows:








Table 35 Mounting direct-read



As root, run the following mount command:mount-F utdm -o fstype=fstype,readthru /blkdev /mntpnt


As root, run the following mount command:mount-t utdm -o fstype=fstype,readthru /blkdev /mntpnt


As root, run the following mount command:mount-V utdm -o fstype=fstype,readthru /blkdev /mntpnt


As root, edit the /etc/vfstab file so that the entry for the file system uses thereadthru option, as shown here:/blkdev /chardev /mntpnt utdm 2 yesfstype=fstype,readthru



As root, edit the /etc/fstab file so that the entry for the file system uses thereadthru option, as shown here:/blkdev /mntpnt utdm fstype=fstype,readthru 0 2



As root, edit the /etc/filesystems file so that the options line of the file system’sentry includes the readthru option:options=rw,fstype=fstype,log=/dev/log,readthru


Backup and Recovery 123

7

This chapter describes backup and recovery of UTDM file systems inthe following sections:

◆ What to back up ............................................................................... 124◆ Recovering a lost file system .......................................................... 128◆ Recovering an FTP module file system ........................................ 130◆ EMC NetWorker .............................................................................. 132◆ NetWorker 64-bit Linux version.................................................... 136◆ NetBackup software ........................................................................ 139◆ FSM tools........................................................................................... 143◆ Snapshots with SnapView .............................................................. 147◆ Import data from SM to FSM ......................................................... 151

Backup and Recovery


Backup and Recovery

What to back upData that exists solely in UTDM file systems should be backed upregularly to guard against loss caused by inadvertent data deletionsor hardware failure. However, migrated data is protected by theback-end system and does not need to be backed up through the filesystem.

When you create a backup strategy for FSM, consider the types offiles and data that make up the management domain. These can begenerally grouped into the following types:

◆ FSM-related files outside of UTDM file systems

◆ Files and data in UTDM file systems

FSM-related files outside of UTDM file systemsAt a minimum, the following FSM-related files and directories shouldbe backed up and recovered by using normal backup and recoverymethods:

◆ All of /opt/fsm/etc and its subdirectories

◆ /etc/dxuldm.path

◆ /etc/fsm.path

An existing FSM installation can be recovered by reinstalling thesoftware and restoring these files and directories from backup sets.

CAUTION!If the FSM software must be reinstalled, complete the reinstallbefore restoring the FSM-related files from backups. This preventsthe reinstalled software from overwriting the backup versions offiles.

What to back up 125

Backup and Recovery

Files and data in UTDM file systemsInclude the following data in backups of UTDM file systems:

◆ Unmigrated file data.

◆ Stub data for migrated files.

◆ Metadata for all files in the file system.

The backup software described in this chapter automatically includesthese entities and excludes unnecessary data from backup sets.


Backup and Recovery

Backup softwareThe backup software described in Table 36 on page 126 may be usedwhen backing up and recovering data in FSM file systems.

IMPORTANT!Centera data retention can prevent the use of incremental backupsto restore some files to a UTDM file system. “Restoringincremental backups” on page 115 explains how to work aroundthis expected limitation.

Table 36 Supported backup software

Backup software Usage notes

EMC NetWorker®, release 7.3.2,UNIX version, 64-bit

All FSM-supported 64-bit platforms, except Linux.EMC NetWorker, release 7.3.2, 64-bit Linux version is notFSM-aware. “NetWorker 64-bit Linux version” on page 136describes how to use it to backup and recover FSM file systems.

EMC NetWorker, release 7.4 SP2UNIX version, 64-bit

All FSM-supported 64-bit platforms, except Linux. EMCNetWorke release 7.4 sp2, 64-bit Linux version is notFSM-aware. “NetWorker 64-bit Linux version” on page 136describes how to use it to backup and recover FSM file systems.

EMC NetWorker, release 7.5 SP1UNIX version, 64-bit

All FSM-supported 64-bit platforms, except Linux.EMCNetWorker, release 7.5 sp1, 64-bit Linux version is notFSM-aware. “NetWorker 64-bit Linux version” on page 136describes how to use it to backup and recover FSM file systems.

Veritas NetBackup Server version 5.1 All FSM-supported platforms, except SuSE 10.Standard backups only.

Veritas NetBackup Server version 6.0 All FSM-supported platforms.Standard backups only.

Veritas NetBackup Server version 6.5 All FSM-supported platforms.Standard backups only.

FSM backup tools All FSM-supported platforms.

EMC SnapView™ Snapshots on all FSM-supported versions of HP-UX and Solaris.

Backup software 127

Backup and Recovery

FSM-aware backup softwareEMC NetWorker (except for NetWorker, 64-bit Linux version) andFSM backup tools are FSM-aware, and do not cause migrated data tobe included in the backup set. Excluding migrated data results in thefollowing advantages:

◆ Shorter backup sessions

◆ Smaller backup sets

◆ Significantly less network traffic

Other backup softwareAs described in Table 36 on page 126, FSM works with the followingbackup software that is not FSM-aware:

◆ NetWorker, 64-bit Linux version

◆ Veritas NetBackup

When these products are used to back up a UTDM file system, FSMuses its integrated third-party backup support to transparentlyexclude migrated data from the backup set.

Snapshot software UTDM file systems can be backed up by using SnapView software.Since only the UTDM file system is included in a snapshot, SnapViewdoes not back up purged data.


Backup and Recovery

Recovering a lost file systemA backup set for a UTDM file system is restored into the existing filesystem. However, when the file system is lost this cannot be done.The UTDM file system must be replaced. After the file system isreplaced, the backup set can be restored into it and the UTDM filesystem recovered.

Note: Since a snapshot is a complete copy of the disk partition, it is notnecessary to perform the steps listed in this section when you use a SnapViewsnapshot to restore a lost file system. The lost UTDM file system is replacedwhen the snapshot is restored.

To replace a lost UTDM file system:

1. Create a native file system of the same type and same capacity (orgreater) as the lost file system, initialize it for UTDM, and mountit on the lost file system’s FSM host.

The new file system must be large enough to contain all of theobjects that are being restored. To ensure this, the new file systemshould be at least as large as the lost file system.

The installation guides provide more information on these tasks.

Note: If the file system’s FSM host has been lost and a new host is beingused, the new host must use the name and IP address of the lost host.

2. If any of the following are lost, restore them from normal backupsets:

• All of /opt/fsm/etc and its subdirectories

• /etc/dxuldm.path

• /etc/fsm.path

Note: A restored UTDM file system must use the same back-endinformation as the lost file system. This information is contained in filesthat exist in /opt/fsm/etc and its subdirectories. By restoring these filesyou ensure that the recovered UTDM file system can access its back-enddata.

Recovering a lost file system 129

Backup and Recovery

3. Complete the appropriate procedure to restore the file systemfrom its backup sets:

• “Recovery with NetWorker software” on page 133

• “Recovery with NetBackup software” on page 142

• “Recovery with FSM tools” on page 144


Backup and Recovery

Recovering an FTP module file systemA file system that uses the FTP module with the Native FTP protocolcannot create hard links to the data on the back-end system afterrecovery. This is because the standard FTP command set does notprovide the necessary control over the back-end file system.

Instead, after the file system has been restored from backup, the filesystem recovery is completed by mounting the back-end system byusing NFS or a similar protocol that provides local disk-like access.

How to recover an FTP module file systemTo recover a file system that uses the FTP module with the NativeFTP protocol:

1. Restore the file system using the appropriate recovery method forthe software that created the backup.

2. Using NFS, or a similar protocol, mount the back-end file systemon the FSM host.

3. Use Console Client to edit the file system configuration:

• Change the Backend Type to NFS.

• Change the Target Path to the local mount point of theback-end file system.

4. Log into the FSM host as root.


“Setting the FSM environment” on page 177 describes how to dothis.

Recovering an FTP module file system 131

Backup and Recovery

6. Run the dmattrrecoverfs tool:

dmattrrecoverfs -p dirpath [-i threads]

where:

• dirpath is full path of the managed file system.

• threads is the number of parallel forked threadsdmattrrecoverfs can start.

Appendix A, “Command reference,” provides more informationon the dmattrrecoverfs tool.

7. After dmattrrecoverfs has finished the synchronization, useConsole Client to edit the file system and return it to its originalconfiguration.

The recovery is complete.


Backup and Recovery

EMC NetWorkerEMC NetWorker is FSM-aware. This sophisticated backup tooldetects an FSM file system and performs an intelligent backup of alldata and metadata in the file system. These backups do not triggerany staging of data from the back-end system.

In the event that data recovery is required, this software restores thebacked-up data and initiates a background process that reestablishesall links between restored metadata and data existing on the filesystem’s back-end system. This background process is calledsynchronization.

IMPORTANT!EMC NetWorker, 64-bit Linux version is not FSM-aware.“NetWorker 64-bit Linux version” on page 136 describes how toback up an FSM file system on this platform.

Requirements To use NetWorker for backup and recovery of FSM file systems, therequired path information and permissions must be available.

Path information To back up an FSM file system by using this software, the file/etc/fsm.path must exist on the file system’s host. This file isautomatically created during FSM installation and should not beremoved.

Permissions The nsrexecd daemon controls automated backup and recoveryoperations of file systems. It is configured with permission to set itsuser ID as root (suid root). This permission is required for backup andrecovery of FSM file systems and should not be changed.

Note: Manual NetWorker backup and recovery operations must beperformed with root permissions.

Backup with NetWorker softwareNetWorker backups of FSM file systems are performed just likeNetWorker backups of any other file system. The softwareautomatically detects FSM file systems and performs automatic andmanual backups without triggering data retrieval from the back-endsystem.

EMC NetWorker 133

Backup and Recovery

A full backup set for a FSM file system consists of the following:

◆ Unmigrated file data.

◆ Stub data for migrated files.

◆ Metadata for all files in the file system.

The size of backup sets is significantly reduced. Only the metadatafor successfully migrated files is backed up.

Note: Migrated file data is recovered by using the metadata backup and thedata objects stored on the back-end system.

The .DMATTR file is normally included in the save set created by theNetWorker software. This file can become quite large and does notneed to be backed up. It is a volatile file and is completely re-createdduring recovery.

To prevent this file from being backed up:

1. Use the Application Specific Module (ASM) called Skip to create adirective that excludes the .DMATTR file from the save set.

2. During creation of the save set, select the directive in theDirectives attribute of the Create Client window.

Note: The NetWorker documentation provides more information on creatingNetWorker directives and applying directives to save sets.

Recovery with NetWorker softwareNetWorker recovery of an FSM file system is performed just likeNetWorker recovery of any other file system. The entire file system,or just one or more files, may be recovered.

When the software restores file data to an FSM file system, the filesystem’s metadata is automatically synchronized with the data on theback-end system. This synchronization process ensures full access tofiles that are purged at the time of the backup.


Backup and Recovery

The following steps describe the synchronization process:

1. A partial or complete recovery of a FSM file system is performed.

After the recovery, the following data is immediately available:

• Unmigrated file data

• Stub data

• Metadata

Note: Migrated data becomes available as it is synchronized by the cronjob described in step 3.

2. As the NetWorker software performs the file system recovery, itautomatically lists each recovered file’s pathname in a file calledrec.date.pid, where:

• date is the current date.

• pid is the process ID associated with the NetWorker clientprocess.

The rec.date.pid file exists on the FSM host system in the/opt/fsm/adm/recdir directory.

3. A cron job periodically checks the rec.date.pid file for recoveredfiles, and synchronizes each file it finds.

During installation of FSM, a cron job is installed in root’scrontab. This job checks the rec.date.pid file for recovered fileentries. When a recovered file entry is found, a backgroundsynchronization process starts to synchronize the file’s metadataand data.

After the file is synchronized, the file entry is removed from therec.date.pid file and the file’s data is accessible through the filesystem.

Note: After a NetWorker recovery, the file system is immediately available tobe used. However, the full data for a file that has been migrated is notavailable until synchronization of the file is complete.

EMC NetWorker 135

Backup and Recovery

You can shorten the time required to synchronize and access arecovered file by performing a manual synchronization that uses thedxuldmrecover command. Appendix A, “Command reference,”provides more information on this command.

Note: Backups must be restored into a file system that uses the sameback-end system as the original file system. This provides access to the datastored on the back-end system.


Backup and Recovery

NetWorker 64-bit Linux versionNetWorker 64-bit Linux version software is not FSM-aware.However, new technology in this release enables FSM to detect thatthis software is being used and to transparently exclude migrateddata from the backup set.

RequirementsTo use NetWorker 64-bit Linux version software to backup UTDM filesystems the following requirements must be met:

◆ The file /opt/fsm/etc/backupcmds must exist.

◆ The file /opt/fsm/etc/restorecmds must exist.

PreparationTo prepare to use NetWorker 64-bit Linux version software:

1. Install the NetWorker software.

2. Log in to the FSM host as root.



4. Change the working directory:

cd /opt/fsm/etc

5. Create the backupcmds file:

cp backupcmds.default.Linux-emt64 backupcmds

6. Create the restorecmds file:

cp restorecmds.default.Linux-emt64 restorecmds

7. Use the NetWorker Application Specific Module (ASM) "Skip" tocreate a directive that excludes the .DMATTR file from the saveset.

8. During creation of the save set, select the directive in theDirectives attribute of the Create Client window.

NetWorker 64-bit Linux version 137

Backup and Recovery

9. Load backupcmds and restorecmds into the kernel:

kill.fsmrc.fsm

The core processes are stopped and restarted with the newinformation.

BackupAfter the requirements described in “Requirements” on page 136 and“Preparation” on page 136 are met, a backup of a UTDM file systemby using NetWorker software is the same as a backup of any other filesystem that uses a standard backup.

During a backup, FSM creates one or more DMAPI sessions andassociates files with those sessions. A cron job is run every 10 minutesto start the utility utdm_backupcleanup to clean up those sessions.This cron job is installed in root’s crontab when FSM is installed. Thisactivity is transparent to file system operations.

Backup sessions may be viewed by using the FSM tool prtdmsession.The output for a backup session takes the following form:

BACKUP filesystem PID ParentPID NWCommand

where:

◆ filesystem is the name of the UTDM file system.

◆ PID is the process ID for the session.

◆ ParentPID is the parent process ID.

◆ NWCommand is the name of the NetWorker command.

For more information about using prtdmsession, see “prtdmsession”on page 188.

RecoveryAfter the requirements described in “Requirements” on page 136 and“Preparation” on page 136 are met, recovery of a UTDM file systemby using NetWorker software is the same as the recovery of any otherfile system.

The FSM metadata for each recovered file has the recover bit set.When a file with the recover bit set is accessed it is automaticallysynchronized.


Backup and Recovery

The dmattrrecoverfs tool is also started by an hourly cron job that isinstalled in root’s crontab. When dmattrrecoverfs is started it scansthe file system for files with the recover bit set and synchronizes anyit finds.

During a recovery, FSM creates one or more DMAPI sessions andassociates files with those sessions. A cron job is run every 10 minutesto start the utility utdm_backupcleanup to clean up those sessions.

Recovery sessions may be viewed by using the FSM toolprtdmsession. The output for a recovery session takes the followingform:

RESTORE filesystem PID ParentPID NWCommand

where:




◆ NWCommand is the name of the NetWorker command.


NetBackup software 139

Backup and Recovery

NetBackup softwareNetBackup software is not FSM-aware. However, new technology inthis release enables FSM to detect that NetBackup software is beingused and to transparently exclude migrated data and the .DMATTRfile from the backup set.

FSM detects a NetBackup backup or restore operation by comparingthe NetBackup commands accessing FSM files to command nameswritten in the files backupcmds and restorecmds. FSM installationplaces default versions of these files in the /opt/fsm/etc directory(where /opt/fsm is the full path to the FSM installation directory).These default versions can be used to create the files backupcmds andrestorecmds for use with NetBackup.

NetBackup requirementsTo use NetBackup software to backup UTDM file systems thefollowing requirements must be met:

◆ One of the following software versions must be used:

• The Veritas NetBackup Server version 5.1 (standard backupsonly; not on SuSE 10)

• Veritas NetBackup Server version 6.0 (standard backups only)

• Veritas NetBackup Server version 6.5 (standard backups only)

◆ Only standard backups may be run.

For example, the FlashBackup package is not supported.

◆ The file /opt/fsm/etc/backupcmds must contain the names of theNetBackup backup commands.

◆ The file /opt/fsm/etc/restorecmds must contain the names of theNetBackup restore commands.

◆ Each NetBackup client machine must have its .DMATTR fileslisted in the file /opt/openv/netbackup/exclude_list.

The .DMATTR file is not needed to restore files from a NetBackupbackup.

Preparing to use NetBackup softwareTo prepare to use NetBackup software:

1. Install the NetBackup software.


Backup and Recovery

2. Log in to the FSM host as root.



4. Add the full path for each .DMATTR file on the FSM host to theNetBackup exclude_list file:

echo "/dmattrpath" >> /opt/openv/netbackup/exclude_list

where /dmattrpath is the full path to one of the .DMATTR files onthe FSM host.

Repeat this command for each .DMATTR file on the FSM host.

Example 5 on page 140 provides more information.

5. Change the working directory:

cd /opt/fsm/etc

6. Copy backupcmds.default to backupcmds:

cp backupcmds.default backupcmds

7. Copy the appropriate restorecmds.default file to restorecmds:

cp restorecmds.default.platform restorecmds

where platform is one of the following operating systems for theFSM host:

• aix_solaris for AIX and Solaris

• hp_linux for HP-UX and Linux

8. Restart FSM to load the contents of backupcmds and restorecmdsinto the kernel:

kill.fsmrc.fsm

The core processes are stopped and restarted, and the names ofthe NetBackup commands are loaded into the kernel.

Example 5 Adding files to the exclude_list file

An FSM host has two UTDM file systems with the followingpathnames:

◆ /mnt/utdm_fs1

◆ /mnt/utdm_fs2

NetBackup software 141

Backup and Recovery

Example 5 (continued) Adding files to the exclude_list file

Run the following commands to add the two .DMATTR files to theexclude_list:

echo "/mnt/utdm_fs1/.DMATTR" >> /opt/openv/netbackup/exclude_listecho "/mnt/utdm_fs2/.DMATTR" >> /opt/openv/netbackup/exclude_list

User-initiated backup and restoreUser-initiated backups and restores are those that are started on aclient node. These backups and restores do not check the exclude_listfile. The .DMATTR files can be manually excluded from thesebackups. The NetBackup documentation provides more informationabout user-initiated backups and restores.

Note: A user-initiated restore of a .DMATTR file will fail with an errormessage. If the .DMATTR files are not excluded from a user-initiated backup,they must be excluded from a user-initiated restore. To do this, refer to theNetBackup documentation.

Backup with NetBackup softwareAfter the requirements described in “NetBackup requirements” onpage 139 and “Preparing to use NetBackup software” on page 139are met, a backup of a UTDM file system by using NetBackupsoftware is the same as a backup of any other file system that uses astandard backup.

During a backup, FSM creates one or more DMAPI sessions andassociates files with those sessions. A cron job is run every 10 minutesto start the utility utdm_backupcleanup to clean up those sessions.This cron job is installed in root’s crontab when FSM is installed. Thisactivity is transparent to file system operations.

Backup sessions may be viewed by using the FSM tool prtdmsession.The output for a backup session takes the following form:

BACKUP filesystem PID ParentPID NBCommand

where:





Backup and Recovery

◆ NBCommand is the name of the NetBackup command.


Recovery with NetBackup softwareAfter the requirements described in “NetBackup requirements” onpage 139 and “Preparing to use NetBackup software” on page 139are met, recovery of a UTDM file system by using NetBackupsoftware is the same as the recovery of any other file system.

The FSM metadata for each recovered file has the recover bit set.When a file with the recover bit set is accessed it is automaticallysynchronized.

The dmattrrecoverfs tool is also started by an hourly cron job that isinstalled in root’s crontab. When dmattrrecoverfs is started it scansthe file system for files with the recover bit set and synchronizes anyit finds.

During a recovery, FSM creates one or more DMAPI sessions andassociates files with those sessions. A cron job is run every 10 minutesto start the utility utdm_backupcleanup to clean up those sessions.

Recovery sessions may be viewed by using the FSM toolprtdmsession. The output for a recovery session takes the followingform:

RESTORE filesystem PID ParentPID NBCommand

where:




◆ NBCommand is the name of the NetBackup command.


FSM tools 143

Backup and Recovery

FSM toolsThis release includes tools that perform basic backup and recoveryoperations for FSM file systems. These tools can be used to:

◆ Back up a file system, without triggering data retrieval.

◆ Partially or completely recover a file system’s data.

◆ Synchronize recovered metadata with data on the back-endsystem.

The tools are located in the /opt/fsm/adm/bin directory.

Backup with FSM toolsTo manually back up an FSM file system, use dxuldm_tar. This tool isbased on tar and includes the ability to back up data in an FSM filesystem without triggering data retrieval.

When using dxuldm_tar, the .DMATTR file should be excluded fromthe backup by using the --exclude option. The .DMATTR file isrebuilt during recovery so backing it up is unnecessary.

Note: The .DMATTR can become quite large. Excluding it can significantlydecrease the time required to back up a file system.

How to back up a file system with FSM toolsTo manually create a full backup of a file system:



“Setting the FSM environment” on page 177 provides moreinformation.

3. Change the current working directory to the root of the filesystem that is being backed up.


Backup and Recovery

4. Run dxuldm_tar:

dxuldm_tar --exclude=.DMATTR -cvf tarfile .

where tarfile is the full pathname of the backup archive file.

The period at the end of the command indicates that the backupshould include all files in the current working directory and allsubdirectories.

Recovery with FSM toolsRecovery of a file system consists of the following tasks:

◆ Restore the data to the file system.

◆ Synchronize the file system’s metadata with the data stored onthe back-end system.

Table 37 on page 144 shows the task performed by each FSM toolduring recovery.

Users may access a file system as soon as dxuldm_tar finishes arecovery. The FSM metadata for each recovered file has the recoverbit set. When a file with the recover bit set is accessed it isautomatically synchronized.

The dmattrrecoverfs tool is also started by an hourly cron job that isinstalled in root’s crontab. When dmattrrecoverfs is started, it scansthe file system for files with the recover bit set and synchronizes anyit finds.

Table 37 FSM recovery commands

Task Command

Recovery of a file system, directory, or individual file. dxuldm_tar

Scan file system for files with the recover bit set and synchronizeall of the data for those files with the data on the back-endsystem.

dmattrrecoverfs

FSM tools 145

Backup and Recovery

How to recover a file system with FSM toolsTo recover a file system:



“Setting the FSM environment” on page 177 provides moreinformation.

3. Change the current working directory to the root of the filesystem that is being restored.

4. Run dxuldm_tar:

dxuldm_tar -xvf tarfile

where tarfile represents the full path of the file system’s backupfile.

The dxuldm_tar command extracts the entire backup archive intothe current directory, maintaining the original file systemstructure.

The file system is recovered. Data for files is synchronizedautomatically by dmattrrecoverfs which is started by the scriptdxuldmhourlycronscript. The script dxuldmhourlycronscript isstarted by an hourly cron job that is installed in root’s crontab whenFSM is installed.

Recovered files may be accessed immediately. When a recovered filethat has not been synchronized is accessed, it is automaticallysynchronized.

How to recover individual files with FSM commandsTo recover a file:




3. Change the current working directory to the root of the filesystem that was backed up.


Backup and Recovery

4. Run dxuldm_tar:

dxuldm_tar -xvf tarfile rel-filepath

where:

• tarfile represents the full path of the backup file.

• rel-filepath represents the relative path of the file being restored(relative to the root of the file system that was backed up).

The file is recovered and may be accessed immediately. A recoveredfile that has not been synchronized is automatically synchronizedwhen it is accessed.

Snapshots with SnapView 147

Backup and Recovery

Snapshots with SnapViewThis release provides three tools to support snapshots of UTDM filesystems with SnapView. The tools do the following:

◆ Quiesce a mounted UTDM file system to permit a snapshot to becreated.

◆ Resume the UTDM file system activity after a snapshot is created.

◆ Set the recover bit on all migrated files in a restored snapshot.

For information on creating and restoring a snapshot, see yourSnapView documentation.

Note: The ability to produce SnapView snapshots of UTDM file systems isnot available on all of the operating systems that are supported by thisrelease. The release notes provide an up-to-date list of the operating systemson which it is available.

“Setting the FSM environment” on page 177 describes how to set theFSM environment.

Quiescing a UTDM file systemThe FSM tool, utdm_fs_freeze, quiesces mounted UTDM file systemsfor a specified number of seconds. This causes the following:

◆ Any thread waiting to access the file system is suspended.

◆ All current operations are concluded.

◆ A flush of any dirty buffers in the file system.

◆ A stable image on the disk.

Use utdm_fs_freeze to prepare a mounted file system for a snapshot.This tool is not required when the file system is not mounted.

To quiesce a UTDM file system:




Backup and Recovery

IMPORTANT!A snapshot must be completed before the file system resumesactivity or it may be corrupt. Use the -t option for utdm_fs_freeze tospecify sufficient time to complete the snapshot.

3. Run utdm_fs_freeze:

utdm_fs_freeze -t sec mountpoint

where:

• sec is the number of seconds to quiesce the file system.

This can be from 1 to the maximum time-out value. Thedefault for the maximum time-out value is 300 seconds.

Note: The maximum time-out value can be changed by using theFSM tool, set_freeze_timeout.

• mountpoint is the full path of the directory on which the filesystem is mounted.

The SnapView snapshot may now be created.

File system activity automatically resumes after the number ofseconds specified by the -t option. To resume file system activitybefore that time, use utdm_fs_thaw.

Determining maximum time-out valueTo determine the current maximum time-out value:



3. Run get_freeze_timeout:

get_freeze_timeout

The current maximum time-out value is displayed.

Setting the maximum time-out valueTo set the maximum time-out value:



Snapshots with SnapView 149

Backup and Recovery

3. Run set_freeze_timeout:

set_freeze_timeout newtimeout

where newtimeout is the number of seconds of the new time-outvalue.

The maximum time-out value is changed to the new value.

Resuming UTDM file system activityThe FSM tool, utdm_fs_thaw, resumes activity for UTDM filesystems that have been quiesced by using utdm_fs_freeze. Afterutdm_fs_thaw is run, all suspended threads are allowed to complete.This tool is used after a snapshot is created by using SnapView.

To resume activity on a UTDM file system:




3. Run utdm_fs_thaw:

utdm_fs_thaw mountpoint

where mountpoint is the full path of the directory on which the filesystem is mounted.

Recovering a UTDM file system snapshotThe FSM tool, utdm_recdmattrf, processes UTDM file systems thatare restored from SnapView snapshots. The tool sets the recover biton all migrated files in the recovered file system. When these files areaccessed the core processes create a new namespace for the files andresets the recover bits.

A new namespace for migrated files prevents conflicts that wouldoccur if both the original and the restored file system accessed theback-end data from the same namespace.

To recover a UTDM file system snapshot:




Backup and Recovery

3. Mount the file system that was recovered from a snapshot byusing the file system’s native type, as shown in Table 38 onpage 150.

The variables for the mount procedures are as follows:

• fstype is the native type of the file system (not utdm).

• blkdev is the full path to the file system’s block special device.

• mntpnt is the full path to the file system’s mount point.

4. Run utdm_recdmattrf:

utdm_recdmattrf /dmattrpath

where /dmattrpath is the full path to the .DMATTR file of therestored snapshot.

When the command prompt is returned (exit status 0) therestored UTDM file system snapshot is recovered.

5. Unmount the file system:

umount /mntpnt

6. Mount the file system as type utdm.

The appropriate operating system version of the installationguide provides more information on mounting the file system.

Table 38 Mounting a file system for utdm_recdmattrf

Operating system Procedure

All operating systems,except Linux and AIX

As root, run the following mount command:mount-F fstype /blkdev /mntpnt

Linux As root, run the following mount command:mount-t fstype /blkdev /mntpnt

AIX As root, run the following mount command:mount-V fstype /blkdev /mntpnt

Import data from SM to FSM 151

Backup and Recovery

Import data from SM to FSMEMC DIskXtender for Unix/Linux Store Manager which was acomponent of DiskXtender, provided a central data storagerepository that utilizes a unified namespace and delivers shared fileaccess using FTP or NFS.

To import data from SM to FSM:

1. Install FSM with Centera as a backend. For more information oninstalling FSM, see EMC DiskXtender File System Manager forUNIX/Linux, Release 3.5 Installation Guides.

2. Mount SM through NFS using the following command:

mount -o intr,port=2050 137.69.XX.XX:/DISKXTENDER//tmp/IMPORT_DIR

3. To ensure the SM file system is mounted, type:

mount | grep DISKXTENDER

The following output is displayed:

137.69.XX.XXX:/DISKXTENDER/ on /tmp/IMPORT_DIR typenfs (rw,intr,port=2050,addr=137.69.44.XXX)

4. In the FSM system with SM mounted through NFS, change thedirectory to point to the SM mount point and perform thefollowing to populate the UTDM file system with SM data:

a. Run the dxprtstat utility for all the files in SM. The outputgenerated to a file in the local file system displays theDXUL-SM object attributes information that are necessary toload objects into a FSM file system.

Example:

dxprtstat -i {} \; > /tmp/dxprtstat.out

The output looks like:

PATH: /tmp/IMPORT_DIR/temp/100_100_R_001TYPE: FILEMODE: 0750SIZE: 1UID: 0GID: 0ATIME: 0x494128d4MTIME: 0x494128d4CTIME: 0x494128d4


Backup and Recovery

FILETARGET:./c5/93/abcdefab00004f5254f88da156fdd293@54f88da1@IMPORTPATH: /tmp/IMPORT_DIR/temp/100_100_R_002

b. Run the dxhardlink utility to create hard links in the SMdirectory HARDLINKSDIR for SM data that are imported toFSM.

Example:

dxhardlink -t /tmp/IMPORT_DIR/HARDLINKDIR </tmp/dxprtstat.out

c. Run the dxbuildtar utility to generate a .tar file in the local filesystem .

Example:

dxbuildtar -f /tmp/dxbuildtar.tar -p/tmp/IMPORT_DIR/ < /tmp/dxprtstat.out

The output of the .tar file looks like the SM file systemdirectory structure as below:

…-rwxr-x--- root/root 1024 2008-12-11 14:51:00./temp/100_100_R_004-rwxr-x--- root/root 1024 2008-12-11 14:51:00./temp/100_100_R_005-rwxr-x--- root/root 1024 2008-12-11 14:51:00./temp/100_100_R_006-rwxr-x--- root/root 1024 2008-12-11 14:51:00./temp/100_100_R_007-rwxr-x--- root/root 1024 2008-12-11 14:51:00./temp/100_100_R_008

d. Change the working directory to FSM File directory. Run thedxdmimport utility to load objects to an FSM file system froma tar file.

/opt/fsm/adm/smtodm/dxdmimport -xUvf/tmp/dxbuildtar.tar

Imported files in FSM will not look the same as normal files inFSM. A getfileattr on a file that is just imported will look like:

getfileattr ./100_100_R_001dt_path: /mnt/utdm/2SMRESTORZE/temp/./100_100_R_001dt_handle:32-F9C57356476C4F4823380000000000007AC1C380000000000102000000000000

Import data from SM to FSM 153

Backup and Recovery

dt_ino: 14371dt_mode: FILE 750dt_nlink: 1dt_uid: 0dt_gid: 0dt_size: 1dt_atime: 1425659730 Fri 06 Mar 2015 04:35:30 PM UTCdt_mtime: 1229007060 Thu 11 Dec 2008 02:51:00 PM UTCdt_ctime: 1425659730 Fri 06 Mar 2015 04:35:30 PM UTCdt_blksize: 4096dt_blocks: 0dmattr0: usiversn (UVDM 1.1)dmattr1: usiismig (1)dmattr2: usiispur (1)dmattr3: usifilev (1)dmattr4: usiopath(./c5/93/abcdefab00004f5254f88da156fdd293@54f88da1@IMPORT)dmattr5: usimtime (494128d4)dmattr6: usimigct (494128d4)dmattr7: usipurtm (494128d4)numregions: 1regoff0: 0 regsz0: 0 regflg0: rwtApplFlags: MIGRATED|PURGED|IMPORT_PENDINGRevPath: 2SMRESTORZE/temp/100_100_R_001

5. Stop the FSM services and edit the DXULDM.conf file.

For FTP, add the following:

IMP_0_MODULE:1:FTPIMP_0_FTPHOST:1:137.69.44.XXXIMP_0_FTPPORT:1:1021IMP_0_FTPUSER:1:rootIMP_0_FTPPASSWORD:1:foobarIMP_0_FTPDIRECT:1:OnIMP_0_TARGET:1:<path where the hardlinks are created inSM in step b>

For NFS, add the following:

IMP_0_MODULE:1:NFSIMP_0_TARGET: <path where the SM NFS is mounted>

6. Restart the FSM services.

The file system is imported. Attempt to read data withimport_pending flag will automatically move the whole data fromSM to FSM by dxuldmimportfs which is started by the scriptdxuldmhourlycronscript. The script dxuldmhourlycronscript isstarted by an hourly cron job that is installed in root’s crontab whenFSM is installed.


Backup and Recovery

Note: Do not use the FSM GUI for any FSM configuration changes until allSM data is migrated to FSM or Centera. FSM GUI does not understand thenew parameters entered in the DXULDM.conf file and any trigger to rewriteor update will result in loss of information in the DXULDM.conf file.

Maintenance 155

8


◆ Processes............................................................................................ 156◆ File administration........................................................................... 164◆ Periodic back-end system cleanup ................................................ 167

Maintenance


Maintenance

ProcessesFSM consists of the following general categories of processes:

◆ “Core processes” on page 156

◆ “Console processes” on page 162

Core processes The FSM core processes do the following:

◆ Monitor the status of file systems.

◆ Migrate file data to the back-end system.

◆ Purge file data from file systems.

◆ Retrieve data from the back-end system.

◆ Provide file system information to Console Agent.

◆ Perform task requested by Console Agent.

For each managed file system the following core processes arestarted:

◆ Two migpurged processes

◆ Two uvdmigd processes

The migpurged processA migpurged process monitors each file system to determine when todo the following:

◆ Migrate file data

◆ Purge file data

The parameters of the monitoring that migpurged performs varybased on the file system’s configuration.

Two migpurged processes start for each file system:

◆ The first process is a persistence daemon, and restarts the primarydaemon as needed.

◆ The second process is the primary daemon and performs the filesystem management tasks.

Processes 157

Maintenance

The uvdmigd process The uvdmigd process ensures that migrated and purged file data isavailable as needed. When a request is made for file data that resideson the EMC Centera, the uvdmigd process:

◆ Calls the migin process to retrieve the data.

◆ Monitors the retrieval.

◆ Notifies the system that the data is available.

Two uvdmigd processes are started for each file system:

◆ The first process is a persistence daemon, and restarts the primarydaemon as needed.

◆ The second process is the primary daemon and performs the filesystem management tasks.

During a data retrieval, the requesting process waits until sufficientdata is retrieved for its operation to complete. Other processesseeking access to the same data also wait. Processes initiatingoperations that require data already in the file system proceedwithout delay.

Deleted FilesThe uvdmigd process monitors the file system for files which areremoved by users. When a migrated file is deleted from the filesystem, uvdmigd calls the migdestroy process. The migdestroyprocess sets a flag on the back-end system to indicate that the file hasbeen deleted from the file system. The indicator that is used variesdepending upon the type of back-end system.

EMC CenteraWhen a file is deleted from a file system that uses an EMC Centeraback-end system, a flag is set in each of the C-Clips for the file. Theflag is used to indicate that the file has been deleted from the filesystem.

The file’s data and C-Clips remain on the EMC Centera untilremoved by an administrator. “EMC Centera” on page 168 providesmore information.

FTP or NFS module back-end systemWhen a file is deleted from a file system that uses either an FTP orNFS module back-end system, the migdestroy process renames thefile on the back-end system by appending the extension .deleted tothe filename.


Maintenance

These renamed files remain on the back-end system until removed byan administrator. “Cleanup on FTP or NFS module back-endsystems” on page 170 provides more information.

Starting and stopping core processesFSM is designed to start when the host system boots up, and to stopwhen the host system shuts down.

During installation, the rc.fsm script is placed in the host system’sstartup directory to provide for an orderly startup when the host isbooted. The rc.fsm script can also be used to start the FSM processesmanually as described in “Manually starting core processes” onpage 158.

Commands contained in the rc.fsm script perform initialization tasksand start the processes. The script does the following:

◆ Parses the configuration file to determine the following:

• File systems to manage.

• Configuration settings for each file system.

◆ Starts the core processes for each file system.

◆ Starts Console Agent and, if present on the host, Console Server.

During installation the kill.fsm script is placed in the host system’sshutdown directory to provide for an orderly shutdown of the coreprocesses when the host is shutdown. The kill.fsm script can also beused to stop the FSM processes manually as described in “StoppingFSM processes” on page 159.

Setting the FSM environmentMost FSM command-line tasks require that you set the FSMenvironment before running the command. “Setting the FSMenvironment” on page 177 provides more information.

Manually starting core processesAn administrator may start the core processes manually by using therc.fsm script.

When installed as recommended, FSM starts automatically each timethe system boots up. This is the preferred method of starting the coreprocesses. It ensures that the environment is set up properly, and therequired processes are started for every file system.

Processes 159

Maintenance

IMPORTANT!All UTDM file systems must be mounted before running rc.fsm.Normally these file systems are mounted using the file systemtable file during boot up.

How to manually start the core processesTo manually start the core processes:




3. Run the rc.fsm script:

/opt/fsm/etc/rc.fsm

The core processes start for each file system.

Stopping FSM processesWhen installed as recommended, FSM stops automatically each timethe system shuts down. This is the preferred method of stopping theFSM processes. It ensures that for every file system that is beingmanaged, all pending tasks are completed before shutdown occurs.

Manually stopping processesAn administrator can manually stop the core processes by using thekill.fsm script.

Effect of manually stopping processes

The core processes should rarely be stopped. Stopping the processesresults in an inability to migrate data to, retrieve data from, andmanage data on the back-end system. Requests that involve any ofthese tasks remain pending until the required process is restarted.Once the process is restarted, pending requests complete.

Note: When it is necessary to stop the core processes, such as when a filesystem must be unmounted, use the kill.fsm script. This script terminates allcore processes for all file systems. Restart those processes as soon as possible,either by rebooting the system or by manually running the rc.fsm script.

How to manually stop the core processes

To manually stop the core processes:


Maintenance




3. Run the kill.fsm script:

/opt/fsm/etc/kill.fsm

All core processes on the host stop.

Note: The kill.fsm script does not unmount file systems. If the core processesfor a file system will not be restarted, be sure to manually unmount that filesystem.

Monitoring core processesThe performance of each process can be monitored through its log.All logs for core processes are located in /opt/fsm/adm/log. When a logreaches 10 MB it is archived by appending a timestamp to its filename and creating a new log.

The timestamp that is appended to an archived log is in the format:

.YYYYMMDDhhmmss

where:

◆ YYYY is the four-digit year.

◆ MM is the two-digit month.

◆ DD is the two-digit day.

◆ hh is the two-digit hour.

◆ mm is the two-digit minute.

◆ ss is the two-digit second.

Processes 161

Maintenance

Each file system has the following logs for its core processes:

◆ migpurged_fsid.t (current log)

◆ uvdmigd_fsid.t (current log)

◆ migpurged_fsid.t.timestamp (archived log)

◆ uvdmigd_fsid.t.timestamp (archived log)

where:

◆ fsid is the file system ID

◆ .timestamp is the timestamp of an archived log.

The logs are recorded in a tokenized text format to reduce their size.To view a log’s contents in a meaningful fashion, use the log viewingcommand, dx_read_log.

Note: An administrator may provide localized, custom log results by usingthe dx_read_log command. The command replaces tokens in a log withmessages from the Common Message File (CMF) and the optional SiteMessage File (SMF). The SMF, if it exists, is searched first. The messages inthe SMF file can be changed to provide users with custom log results.

How to view a logTo use dx_read_log to view a log:




3. Run dx_read_log:

dx_read_log option -l /opt/fsm/adm/log/log-file

where:

• option is a viewing option.

• log-file is the name of the log.

Note: A detailed description of the options available for dx_read_log isavailable in “dx_read_log” on page 179.


Maintenance

Console processes The FSM Console processes consist of the Console Server and theConsole Agent.

The Console Server runs on one host in the management domain. Itdoes the following:

◆ Maintains user accounts and roles.

◆ Negotiates authentication between Console Client and ConsoleAgents.

The Console Agent runs on each FSM host. It provides the following:

◆ Initial authentication

◆ File system monitoring

◆ File system configuration

Starting and stopping Console processesThe Console processes start and stop automatically when the host’score processes are started and stopped. You should not start or stopthe Console processes any other way unless you are instructed to byCustomer Support.

Monitoring Console processesThe performance of all Console Server and Console Agent processesis recorded in a log on the computer that hosts the process. The logsare located in the following directory:

/opt/fsm/logs

Console Server logThe Console Server log is named:

FSMConsoleServer.log

This log grows until it reaches the number of kilobytes specified bythe value of the fsm.log.size parameter in the following file:

/opt/fsm/etc/FsmConsoleServer.properties

This value can be changed by editing the file to uncomment theparameter and change its value. The default is 5,000,000 KB.

When the maximum size is reached the log is archived and a new logis started. Archived logs have a timestamp appended to theirfilename.

To reclaim space you can manually remove the archived logs.

Processes 163

Maintenance

Console Agent logThe Console Agent log is named:

FSMConsoleAgent.log

This log grows until it reaches the number of kilobytes specified bythe value of the fsm.log.size parameter in the following file:

/opt/fsm/etc/FsmConsoleAgent.properties

This value can be changed by editing the file to uncomment theparameter and change its value. The default is 5,000,000 KB.

When the maximum size is reached the log is archived and a new logis started. Archived logs have a timestamp appended to theirfilename.

To reclaim space you can manually remove the archived logs.

Command output logsBoth Console processes produce a second set of logs. These are thecommand output logs, which contain the messages that are normallydisplayed on a console.

The Console Server command output log is named:

FSMConsoleServer_log

The Console Agent command output log is named:

FSMConsoleAgent_log

These logs grow at a much slower rate, but their size is controlled bythe same parameter as the Console Server log and the Console Agentlog. To reclaim space you can manually remove the archived versionsof these logs.


Maintenance

File administrationFSM provides tools to perform administrative tasks on individualfiles.

Manual migration, purge, and retrievalAn administrator can manually migrate, purge, and retrieveindividual files as needed.

How to manually migrate a fileTo manually migrate a file:




3. Change the working directory to the directory that contains thefile.

4. Run migout:

migout filename

where filename is the name of the file.

Upon successful migration, migout displays the message:

Successfully migrated file filename

Note: If this message does not appear, the file was not migrated.

How to manually purge filesTo manually purge files:




3. Change the working directory to the directory that contains thefile.

4. Run purge:

File administration 165

Maintenance

purge filename


Upon successful purging, purge displays the message:

Successfully purged file filename.

Note: If this message does not appear, the file was not purged. Manualpurging fails if the file’s Purge attribute has been set to NEVER, or if thefile has not been migrated.For files which have not been migrated, the purge command displays themessage: "File filename has not been migrated."

The successful completion of the purge operation can be verifiedby using the list command, ls -ls, on the file both before and afterpurging. The number of data blocks occupied by the file on thefile system is less after successful purging.

Note: Only files that are eligible for purging can be manually purged. To beeligible for purging, a file must have been successfully migrated and must beunchanged since the migration. As expected, an attempt to purge a file thatcontains data that has not been migrated will fail.

How to manually retrieve filesThe uvdmigd process automatically retrieves a purged file whenneeded. Very large files can cause a noticeable time delay while thefile data is retrieved. To manage this time delay, the large file can beretrieved in advance.

To manually retrieve files:




3. Change the working directory to the directory containing the file.


Maintenance

4. Run the list command, ls -ls:

ls -ls filename


The number of blocks that the file occupies in the file system aredisplayed.

5. Run migin:

migin filename


6. Run the list command:

ls -ls filename


The number of blocks occupied by the file on the file systemincreases after the file’s data is successfully retrieved.

Periodic back-end system cleanup 167

Maintenance

Periodic back-end system cleanupFiles which have been deleted from a file system are notautomatically removed from the back-end system. This permits therecovery of inadvertently removed files. Chapter 7, “Backup andRecovery,” provides more information on recovery.

When a user deletes or removes a file from a file system, thefollowing occurs:

1. The uvdmigd process reads the file’s DMAPI attributes todetermine if the file has been migrated.

2. If the file has been migrated, uvdmigd calls the migdestroyprocess.

3. The migdestroy process sets a flag on the back-end system toindicate that the file has been deleted from the file system.

The indicator used varies depending upon the type of back-endsystem.

Periodically, an administrator should make available for purging thedeleted file data that is stored on the back-end system. This is calledcleanup.

For the following back-end module types, cleanup may be scheduledto run automatically by using Console Client:

◆ Centera

◆ NFS

Chapter 5, “Scheduled Jobs,” and the online help describe this.Back-end systems that use the FTP module require manual cleanup.

On all back-end system types you may perform manual cleanup. Thisis described in the following sections:

◆ “EMC Centera” on page 168

◆ “Cleanup on FTP or NFS module back-end systems” on page 170

IMPORTANT!Only perform cleanup of data on the back-end system when youare sure that it is not needed. Purging data from the back-endsystem permanently removes it. This data cannot be recovered.


Maintenance

EMC Centera For file systems that use the Centera module, cleanup on the EMCCentera is performed from the FSM host by using thedxuldmdelclips command to identify and mark a range of files.Cleanup is performed simultaneously for all Centera module filesystems on a host.

The dxuldmdelclips command must have query permission on theEMC Centera to perform its tasks. If the default permissions arechanged to deny query permission for anonymous profiles, thispermission must be provided through a PEA file.

The file system’s PEA file is identified through its Centera ProfilePath value. “Centera module preliminary tasks” on page 45 providesmore information.

How to clean up an EMC CenteraTo clean up an EMC Centera:




3. Run dxuldmdelclips:

dxuldmdelclips -a emc-address[?/PEA-file] -v

where:

• emc-address is one of the IP addresses listed in the ConnectAddresses value.

“Centera module” on page 64 provides more information.

• /PEA-file is the full path to a PEA file which provides read,write, exist, and query permissions.

Note: The ?/PEA-file portion of the command is included ifauthentication is required by the EMC Centera.

For all file systems, the file data that was deleted more than oneyear before the current date is marked for purging. All C-Clips,linked to the deleted files, are also marked.

This procedure is demonstrated in Example 6 on page 169.


Maintenance

Note: To mark the data for a specific range of files follow the proceduredescribed in “dxuldmdelclips” on page 184.

Example 6 Periodic Centera system cleanup

In this example the following parameters are assumed:

◆ The EMC Centera has an IP address of 137.69.44.212

◆ The EMC Centera administrator has provided a PEA file whichprovides read, write, exist, and query permissions.

◆ The PEA file is located at /etc/rweq.pea.

To clean up all files deleted more than a year ago, set the FSMenvironment and run the command:

dxuldmdelclips -a 137.69.44.212?/etc/rweq.pea -v

Restarting the task The -v option to dxuldmdelclips causes the command to displaystatus information after every 100 C-Clip deletions. This informationmay be used to restart the task if it stops prior to completion.

To restart an incomplete dxuldmdelclips task:

1. Note the last displayed timestamp from the incompletedxuldmdelclips run.

The timestamp is displayed as seconds since the epoch.



“Setting the FSM environment” on page 177 describes how to dothis.

4. Use dxuldmdelclips with the -t option:

dxuldmdelclips -a emc-address?/PEA-file -v -t starttime

where:

• emc-address is one of the IP addresses listed in the ConnectAddresses value.

For more information on this value, refer to “Centera module”on page 64.

• /PEA-file is the full path to a PEA file which provides read,write, exist, and query permissions.


Maintenance

• starttime is the last displayed timestamp from the incompletedxuldmdelclips run.

The cleanup task starts and marks data as available for purging.Only data that was deleted during the time range specified ismarked as available for purging.

The default values for dxuldmdelclips marks files that weredeleted in the time range between the following two dates:

• The time specified by starttime.

• The date that is one year before when the command is run.

Cleanup on FTP or NFS module back-end systemsCleanup for back-end systems that use the NFS or FTP modules isperformed on the back-end host. This cleanup is performed on adirectory by directory basis.

How to clean up a back-end system that uses either the FTP or NFS moduleTo clean up a back-end system that uses either the FTP or NFSmodule:

1. Log in as root on the back-end host.

2. Change the working directory to the directory that contains thedeleted file data.

3. Run find with the -atime option:

find . -name *.deleted -atime +n -print > list-file &

where:

• n is an integer that represents the number of days since lastaccess.

• list-file is the name of a temporary file to hold the results of thefind command.

4. Review list-file. If it includes files which should be kept repeat thecommand with a greater value for the number of days since lastaccess.

5. If every file listed in list-file can be removed, type the findcommand with the -exec switch that calls the rm command:

find . -name *.deleted -atime +n -exec rm {} \; &


Maintenance

where n is an integer representing the number of days since lastaccess.

The files listed in list-file are removed.


Maintenance

Command reference 173

AInvisible Body Tag

This appendix covers the following topics:

◆ Command quick reference.............................................................. 174◆ Command usage .............................................................................. 177

Command reference


Command reference

Command quick referenceThe tables in this appendix list the commands used with this softwarerelease:

◆ Administrative Commands, refer to Table 39.

◆ File Management Commands, refer to Table 40 on page 175.

◆ Backup and Restore Commands, refer to Table 41 on page 175.

“Command usage” on page 177 provides detailed information abouteach command.

Except where otherwise specified, all commands are located in/opt/fsm/adm/bin. and the commands are described in man pageslocated in /opt/fsm/man, where /opt/fsm is the full path to the FSMinstallation directory.

To access the man pages, set the FSM environment, and type manfollowed by the name of one of the commands. For information onsetting the FSM environment, refer to “Setting the FSM environment”on page 177.

Table 39 Administrative commands (page 1 of 2)

Command Description

deldmsession Deletes abandoned DMAPI sessions.

dx_read_log Preprocesses logs by replacing tokens with messages, and displays the result.

dxuldmcenteraping Tests connectivity with network interfaces on an EMC Centera and displays the result.When a connection is successfully made, the hardware and firmware values for theEMC Centera are displayed.

dxuldmcheckconf Checks the configuration file for inconsistent and insufficient entries.

dxuldmclip Displays the C-Clip associated with a given address and C-Clip ID.

dxuldmdelclips Searches a range of C-Clips and marks those for deleted files as available for purgingfrom the EMC Centera.

expand_dmattrf Expands a file system’s .DMATTR file.

getdmattr Reports the value of a specific FSM attribute for one or more files.

getfileattr Reports all FSM and DMAPI debugging information for a file.

prtdmsession Prints information that describes all the DMAPI sessions that run on the local computer.

175

Command reference

dxstat Prints DXUL-FSM migrate, purge, stage, delete, recover and import statistics.

dxprtstat Generate output that describes the attribute information necessary to load a new objectinto an FSM file system that is a mirror image of what the object looks like through theDXUL-SM interface.

dxhardlink Generates hardlinks within the DXUL-SM system.

dxdmimport Loads objects into an FSM managed file system.

Table 40 File management commands

Command Description

getimplist Retrieves a list of files in an FSM managed file system which need to beimported.

getmiglist Displays a list of files that need to be migrated.

getpurgelist Displays a list of files that need to be purged.

migin Retrieves data from the back-end system.

migout Migrates data to the back-end system.

migpurgestate Displays the migration and purge status of files.

purge Purges file data from a file system.

Table 41 Backup and restore commands (page 1 of 2)

Command Description

dxbuildtar Generates a tar-formatted file that is used to load objectsinto a UTDM file system.

dxcliplink Create a link to a C-Clip and print out the C-Clip attributes required tocreate a UTDM file system’s stub file linked to the data represented by theC-Clip.

dxdmload Load objects into a UTDM file system from a file generated by dxbuildtar.

dxuldm_tar Backs up and restores file systems, without triggering a retrieval ofmigrated and purged data.

dmattrrecoverfs Synchronizes all file system metadata with data stored on the back-endsystem.

Table 39 Administrative commands (page 2 of 2)

Command Description


Command reference

get_freeze_timeout Displays the current maximum time a UTDM file system can be frozen.

getrecoverlist Returns a list of files that need to be recovered into a UTDM file system.

set_freeze_timeout Sets the maximum time a UTDM file system can be frozen.

utdm_fs_freeze Temporarily suspends access to a UTDM file system.

utdm_fs_thaw Permits access to a UTDM file system that was put in a suspended stateby utdm_fs_freeze.

utdm_recdmattrf Finalizes recovery of a UTDM file system from a snapshot.

Table 41 Backup and restore commands (page 2 of 2)

Command Description

177

Command reference

Command usageThe commands are described in the following sections:

◆ “Administrative commands” on page 178

◆ “File management commands” on page 191

◆ “Backup and recovery commands” on page 196

Setting the DMAP_ROOT_PATHBefore using any of the FSM commands, the environment variableDMAP_ROOT_PATH must be set to the full path of the FSMinstallation directory. The FSM installation directory is the top-levelFSM directory (the directory which contains the adm, bin, etc, andman subdirectories). The default path to this directory is /opt/fsm.

The DMAP_ROOT_PATH is set by setting the FSM environment,refer to “Setting the FSM environment” on page 177.

Setting the FSM environmentMost FSM command-line tasks require that you set the FSMenvironment before you run the command.

To set the FSM environment, type the correct source command foryour current shell.

◆ C shell (csh) and Turbo C shell (tcsh), type:

source /opt/fsm/etc/fsm.login


◆ Bourne shell (sh), Bourne Again shell (bash), and Korn shell(ksh), type:

. /opt/fsm/etc/fsm.profile



Command reference

Administrative commandsThe administrative commands are described in the followingsections:

◆ “deldmsession” on page 178

◆ “dx_read_log” on page 179

◆ “dxuldmcenteraping” on page 182

◆ “dxuldmcheckconf” on page 183

◆ “dxuldmclip” on page 183

◆ “dxuldmdelclips” on page 184

◆ “expand_dmattrf” on page 186

◆ “getdmattr” on page 187

◆ “getfileattr” on page 188

◆ “prtdmsession” on page 188

◆ “dxstat” on page 188

◆ “dxprtstat” on page 189

◆ “dxhardlink” on page 190

◆ “dxdmimport” on page 190

deldmsession Use the deldmsession command to remove abandoned DMAPIsessions.

DMAPI sessions become abandoned due to unexpected terminationof a process. These sessions normally cause no problems and areremoved when the system is rebooted. However, in some instances, afile system cannot be successfully unmounted if an abandonedDMAPI session is left active.

When using this command, avoid accidental removal of activeDMAPI sessions. If active sessions are removed, FSM processesterminate and file system activity is blocked until those processes arerestarted.

Syntaxdeldmsession [[-s session-string]|[-i session-id]] -n

OptionsThe options for deldmsession are described in Table 42 on page 179.

179

Command reference

dx_read_log The dx_read_log command starts a log preprocessor that expandstoken logs into plain text format. It replaces the tokens with messagesfrom the Common Message File (CMF) and the optional Site MessageFile (SMF). If the SMF exists, it is searched first. After all replacementsare made, the requested portion of the processed log is displayed.

Syntaxdx_read_log -l /log-file [-s [-|=|+] severity] [-T begintime][-E endtime] [-d begindate] [-D enddate] [-p] [-h]

OptionsThe options for dx_read_log are described in Table 43 on page 180.

Table 42 Options for deldmsession

Option Description

-s session-string The -s option takes the argument session-string which is the label ofthe session to be removed.

-i session-id The -i option takes the argument session-id which is the integeridentification number for the session being removed.

-n The -n option prevents deldmsession from responding to systemevents.


Command reference

Table 43 Options for dx_read_log (page 1 of 2)

Option Description

-l /log-file The -l option takes the argument /log-file, that represents the full path tothe log to be read. This option is required.

-s severity The -s option takes the argument severity, which is an integer thatrepresents a severity level, 0-9, and returns messages related to that level.When severity is preceded by:• A minus sign (-), then all messages equal to or less than the level

specified by severity are returned.• An equal sign (=), then all messages equal to the level specified by

severity are returned. This is the default.• A plus sign (+), then all messages equal to or greater than the level

specified by severity are returned.Table 44 on page 181 describes the severity levels.

-b brevity The -b option takes the argument brevity, which is an integer thatrepresents a brevity level, 0-3, and displays information within that level ofdetail.Table 45 on page 182 shows the brevity levels that are available.

-t number The -t option takes the argument number, which is an integer thatrepresents the number of messages to display from the end of the log. Thisargument is similar to the tail command.

-c number The -c option takes the argument number, which is an integer thatrepresents the number of messages to display from the end of the log. Thedisplay is continuous.

-T begintime The -T option takes the argument begintime which is a time value, in theformat hh:mm:ss. All messages, generated after the specified time, aredisplayed. When this option is used with the -E option, a time segment canbe specified.

-E endtime The -E option takes the argument endtime which is a time value in theformat hh:mm:ss. All messages generated before the specified time aredisplayed. When this option is used with the -T option, a time segment canbe specified.

-d begindate The -d option takes the argument begindate which is a date value in theformat yy/mm/dd. All messages generated after the specified date aredisplayed. When this option is used with the -D option, a date segment canbe specified.

181

Command reference

Severity levels

The -s option accepts an integer argument that is used to filtermessages based on a severity level. The severity levels described byeach integer argument (0-9) are shown in Table 44 on page 181.

-D enddate The -D option takes the argument enddate which is a date value in theformat yy/mm/dd. All messages generated before the specified date aredisplayed. When this option is used with the -d option, a date segment canbe specified.

-p The -p option displays the current dx_read_log program parameters. Nolog messages are returned.

-h The -h option returns dx_read_log help. No log messages are returned.

Table 43 Options for dx_read_log (page 2 of 2)

Option Description

Table 44 Severity levels

Level Name Description

9 Panic Problems that are not recoverable. The process terminated.

8 Severe Major problems that require administrative action.

7 Warning Potential problems detected by system.

6 Recover Problems encountered by processes, from which the processessuccessfully recovered.

5 Info General process information.

4 Debug4 Debug messages with the highest level of detail.

3 Debug3 Debug messages with a level of detail lower than level 4.



0 Debug0 Debug messages with the lowest level of detail.


Command reference

Brevity levels

The -b option takes an integer (0-3) that determines the amount ofdetail displayed. The brevity levels are shown in Table 45 onpage 182.

dxuldmcenteraping The dxuldmcenteraping command checks connectivity with thenetwork interfaces on a EMC Centera. A EMC Centera does notrespond to packets sent by the ping command.

When a specified IP address is available, dxuldmcenterapingdisplays the following for that address:

Address: IP-addressInfo Version: infoversionCapacity: capacityFree Space: freeCluster ID: cluster-idCluster Name: cluster-nameVersion: versionReplica Address: replica-address

When dxuldmcenteraping encounters an unavailable IP address itdisplays the following:

Unable to open cluster at address (IP-address). Error(FP_NO_POOL_ERR)

Syntaxdxuldmcenteraping -a emc-address [emc-address...]

OptionThe dxuldmcenteraping command takes the option emc-addresswhich is an IP address for a network interface on an EMC Centera.Optionally, additional IP addresses, separated by spaces, may bespecified.

Table 45 Brevity levels

Level Description

0 Message arguments only

1 Normal

2 Detailed messages

3 Further explanation

183

Command reference

dxuldmcheckconf Use the dxuldmcheckconf command to check the configuration filefor inconsistencies. The configuration file contains necessaryconfiguration information for all FSM file systems. Thedxuldmcheckconf command stops on the first inconsistency it findsand returns the inconsistent attribute’s name, and information aboutthe inconsistency.

Optionally, the command can be called through the rc.fsm startupscript to prevent FSM from starting with configuration errors.

Syntaxdxuldmcheckconf [-v]

OptionThe -v option toggles on verbose mode. In this mode, when no erroris detected, a summary of the configuration settings for each filesystem that is specified in the configuration file is returned. Whenverbose mode is off, and no error is detected, the command prompt isreturned.

dxuldmclip The dxuldmclip command retrieves and displays the informationcontained in a file’s associated C-Clip. The C-Clips are metadata fileslocated on an EMC Centera back-end system. Example 7 on page 184shows the C-Clip information displayed by dxuldmclip.

Syntaxdxuldmclip -a emc-address -c clipid

OptionsThe options for dxuldmclip are described in Table 46 on page 183.

Table 46 Options for dxuldmclip

Option Description

-a emc-address The -a option takes the argument emc-address which is one of the IPaddresses specified for the Connect Addresses attribute.

-c clipid The -c option takes the argument clipid which is the ID string for a file’sassociated C-Clip.To obtain clipid, type the command:getdmattr -a usiopath filepath

where filepath is the full path to the file. The value returned is clipid.


Command reference

Example 7 Using dxuldmclip to obtain C-Clip information for a file

# getdmattr -a usiopath /utdm.1/file01usiopath value for file /utdm.1/file01 is:743NEV737O694e23DFUNDMBPT20# dxuldmclip -a 137.69.44.247 -c743NEV737O694e23DFUNDMBPT20Clip name: FSM_utdm.1Clip ID: 743NEV737O694e23DFUNDMBPT20

Created on: 2002.12.04 21:22:42 GMTNumber of Blobs: 1Number of Bytes in Blobs: 104857600Tag: FILE_ATTRIBUTES

(META_VERSION) = (Version 1.0)(TARGET) = (utdm.1)(UID) = (0)(GID) = (1)(MIGRATE_TIME) = (1039036962)(PATH_NAME) = (/utdm.1/file01)

Tag: VERSION_1(VERSION_TIME) = (1039036962)(VERSION_SIZE) = (104857600)

Tag: OLD_CCLIPSNo Attributes for this tag

dxuldmdelclips The dxuldmdelclips command examines a range of C-Clips for thoserepresenting deleted files and marks them as available for purgingfrom the EMC Centera. The C-Clips marked as available for purgingare not automatically purged. “Centera module” on page 64provides more information about purging.

Only C-Clips linked to files that have been deleted from the filesystem are marked by this command. When the C-Clips are marked,the data storage space associated with C-Clip can be reclaimed by theEMC Centera’s purging routine.

The FSM file system must have query permission on the EMCCentera to use the dxuldmdelclips command. If the defaultpermissions are changed to deny query permission for anonymousprofiles, this permission must be provided through a PEA file.

The file system’s PEA file is identified through its Centera ProfilePath value. “Centera module preliminary tasks” on page 45 providesmore information.

“How to clean up an EMC Centera” on page 168 shows an exampleof the dxuldmdelclips command.

185

Command reference

Syntaxdxuldmdelclips -a emc-address[?/PEA-file] [-t starttime] [-e endtime][-m age] [-n num-to-del] [-v]

OptionsThe options for dxuldmdelclips are described in Table 47 onpage 185.

Table 47 Options for dxuldmdelclips

Option Description

-a emc-address[?/PEA-file]

The -a option takes the argument emc-address which is one of the IP addressesspecified for the file system’s Connect Addresses attribute.For more information on the Connect Addresses attribute, refer to “Centeramodule” on page 64.An optional (but required, in most cases) argument is /PEA-file, the full path to aPEA file. This argument follows a question mark that is appended to theemc-address argument. The PEA file must provide read, write, exist, and querypermissions.

-t starttime The -t option takes the argument starttime which is an integer value thatrepresents a number of seconds since the epoch.The time represented by starttime is used as the starting point for the range ofC-Clips evaluated for marking. The default is 0, which means the starting point isthe oldest C-Clip for the file system.“Restarting the task” on page 169 provides an example showing how to use thisoption to restart a dxuldmdelclips run.

-e endtime The -e option takes the argument endtime which is an integer value thatrepresents a number of seconds since the epoch.The time represented by endtime is used as the ending point for the range ofC-Clips evaluated for marking. The default is -1, which means the end point is themost recent C-Clip for the file system.

-m age The -m option takes the argument age which is an integer value that representsthe number of days old a C-Clip must be before it is evaluated for marking.The default value is 365, which means only C-Clips older than one year will bemarked as available for purging.

-n num-to-del The -n option takes the argument num-to-del which is an integer that representsthe number of C-Clips that can be marked in the current dxuldmdelclips run.When the range of C-Clips available for marking exceeds num-to-del, the oldestC-Clips are marked first. The default value is -1, which means all eligible C-Clipswill be marked.

-v The -v option toggles on verbose output.When verbose output is on, a message is sent to stdout after every 100 C-Clipdeletions, and the final tally of deletions is sent to stdout at the end of the run.


Command reference

expand_dmattrf The expand_dmattrf command is used to make changes to a filesystem’s .DMATTR file. The following changes can be made by usingthis tool:

◆ Increase the number of files handled.

◆ Increase the number of attribute blocks handled.

◆ Add space at the end of the file.

◆ Change the file system’s aggregate information.

Before using this command the file system on which the .DMATTRfile resides must be mounted using its native format.

IMPORTANT!Before using this command, make a backup of the original.DMATTR file to permit recovery if errors occur with the new.DMATTR file.

Syntaxexpand_dmattrf [-f files] [-a blocks] [-z size] [-g agginfo] [-oelements] [-h heads] [-t fs] [-v|-q] path newpath

OptionsAt lease one of the action options must be used: -f, -a, -z, -g, -o, or -h.The file system type, -t, option is only required when the attribute fileis converted from a version 1 header format to a version 2 headerformat. Specifying both the quiet, -q, and verbose, -v, options causesan error.

The options for expand_dmattr are described in Table 48 on page 186.

Table 48 Options for expand_dmattrf (page 1 of 2)

Option Description

-f files The -f option takes the argument files which is an integer that represents the new number ofsupported files.

-a blocks The -a option takes the argument blocks which is an integer that represents the new number ofsupported attribute blocks.

-z size The -z option takes the argument size which is an integer that represents the new size of the.DMATTR file in bytes.

187

Command reference

getdmattr The getdmattr command displays the value of one of the FSM fileattributes for one or more files.

Syntaxgetdmattr -a attribute-name filelist

-g agginfo The -g option takes the argument agginfo, which is a colon-separated triple that consists of thefollowing aggregate information values:• Number of aggregates• Number of inodes per aggregate• Initial inode offset for each aggregateFor example, the triple 4:4194304:128 sets the new aggregate information to be 4 aggregates,each one with 4,194,304 inodes and an initial 128 inode offset.

-o elements The -o option takes the argument elements which is an integer that represents the new numberof hash table elements in the overflow area.

-h heads The -h option takes the argument heads which is an integer that represents the new number ofhash table list heads in the overflow area. Increase this number to create more list heads andthereby shorten the lists that are traversed when searching for a hash table element in theoverflow area.

Note: An increase in this value causes more space to be allocated to the list heads in the.DMATTR file.

-t fs The -t option takes the argument fs which is the native (underlying) file system type on whichthe .DMATTR file resides. This option should only be used, and is required, when the attributefile must be converted from a version 1 header format to a version 2 header format.

-v The -v option turns on verbose mode. This causes the display of messages that describe thechanges being made.

-q The -q option turns on quiet mode. This significantly reduces the display of messages.

path The variable path represents the full path of the .DMATTR file on the native file system.

newpath The variable newpath represents the output path, that is, the full path of the .DMATTR filegenerated by this command.

Table 48 Options for expand_dmattrf (page 2 of 2)

Option Description


Command reference

OptionsThe options for getdmattr are described in Table 49 on page 188.

getfileattr Use the getfileattr command to display all FSM and DMAPIdebugging information for a file.

Syntaxgetfileattr [-u] filepath

OptionsThe options for getfileattr are described in Table 50 on page 188.

prtdmsession The prtdmsession command displays information for all currentDMAPI sessions.

Syntaxprtdmsession

dxstat Use the dxstat command to print DXUL-FSM migrate, purge, stage,delete, recover and import statistics. It also prints information onactivities that are inprogress. If no options are passed, all statistics areprinted.

Table 49 Options for getdmattr

Option Description

-a attribute-name The -a option takes the argument attribute-name, which is one of the FSM fileattributes.

filelist The getdmattr command takes the argument filelist, which is the full pathdescription of one or more files. For multiple files, separate each pathdescription by a space.

Table 50 Options for getfileattr

Option Description

-u The -u option toggles on streamed output. When this option is toggled on, the output of thecommand is one continuous, unstructured stream.

filepath The getfileattr command takes the argument filepath, which is the full path to the file aboutwhich information is sought.

189

Command reference

Syntaxdxstat [-f pathname] [-m] [-p] [-s] [-d] [-r] [-i]

OptionsThe options for dxstat are described in Table 51 on page 189.

dxprtstat Use the dxprtstat command to generate output that describes theattribute information necessary to load a new object into an FSM filesystem that is a mirror image of what the object looks like through theDXUL-SM interface.

Syntaxdxprtstat [-i] pathname

OptionsThe options for dxprstat are described in Table 52 on page 189.

Table 51 Options for dxstat

Option Description

-f pathname The path to the file system being managed whose statistics are to be printed.

-m Print migrate statistics.

-p Print purge statistics.

-s Print stage statistics.

-d Print delete statistics.

-r Print recover statistics.

-i Print import statistics.

Table 52 Options for dxprstat

Option Description

-i Import files into FSM.

pathname Pathname to the object.


Command reference

Note: dxprtstat should be used in conjunction with the system find commandwhen mirroring objects under a particular directory tree. -i option should bepassed when files are being imported from DXUL-SM to FSM.

dxhardlink The dxhardlink command is used to generate hardlinks within theDXUL-SM system. These hardlinks are generated in such a way thatthey can be used by the FSM system to access file data.

If the dxhardlink command fails part way through for any reason, itcan be retried with no ill effects (it simply skips over work alreadydone).

The DXUL-SM file system to be loaded with hardlinks must be NFSaccessible.

Syntaxdxhardlink -t target_DXSM_directory [-v]

OptionsThe options for dxhardlink are described in Table 53 on page 190.

dxdmimport The dxdimport command is used to load objects into an FSMmanaged file system. These objects should mirror those objectsprocessed during the find/dxprtstat step of the conversion process.

Syntaxdxdmimport [Same as GNU tar(1)]

OptionsThe only options that should be used are xUf and possibly v. The Uoption should always be used to guarantee clean loads if objectsalready exist in the file system.

Table 53 Options for dxhardlink

Option Description

-t target_DXSM_directory The path within the DXUL-SM file system which is a target of the FSM managed filesystem to be loaded with mirrored objects.

-v Generate output for every hard link attempt.

191

Command reference

File management commandsThe file commands are described in the following sections:

◆ “getimplist” on page 191

◆ “getmiglist” on page 192

◆ “getpurgelist” on page 193

◆ “migin” on page 195

◆ “migout” on page 195

◆ “migpurgestate” on page 195

◆ “purge” on page 196

getimplist The getimplist command is used to retrieve a list of files in an FSMmanaged file system which need to be imported. This utility isdependent on UTDM specific file system commands that are onlyavailable on certain platforms. UTDM allows for migrationalgorithms that scale.

Syntaxgetimplist -p pathname [-a age] [-c cookie] [-n number][-s size] [-k]

OptionsThe options for getmiglist are described in Table 55 on page 192.

Table 54 Options for getmiglist (page 1 of 2)

Option Description

-p pathname The path to the file system being managed

-a age The age in minutes since the import candidates were created. Any files createdwithin the last "age" in minutes will not be a import candidate. This is an optionalparameter and if not supplied all import candidates will be returned.

-c cookie The -c option takes the argument cookie that identifies a location to start thesearch. This allows for retrievals of only partial import lists, and the ability to start anew import list where the last import list left off. This will allow for import algorithmsto be written which do not require an entire list of all import candidates beforeimport can be started. This is an optional parameter and if not supplied the searchwill start at the beginning of the file system.


Command reference

getmiglist The getmiglist command retrieves a list of files that need to bemigrated.

Syntaxgetmiglist -p fspath [-a age] [-c cookie] [-n num] [-s size] [-k]

OptionsThe options for getmiglist are described in Table 55 on page 192.

-n number The -n option takes the argument number which is the maximum number ofcandidates to return in the import list. If this parameter is not supplied then allimport candidates will be returned.

-s size The -s option takes the argument size which represents the bytes size of a file.Only files whose size is greater than or equal to the size are returned. If size if notsupplies then the default size is 0 bytes.

-k The -k option does not print out the file list. At end of processing just print out thenumber of files to import plus the number of bytes included in all importcandidates.


Option Description


Option Description

-p fspath The -p option takes the argument fspath which is the full path of the managed filesystem.This value is required.

-a age The -a option takes the argument age which is the age in minutes since a file waslast modified. All files modified within the time specified by age are excluded fromthe list.This is an optional value. The default is 0 which ignores when a file was lastmodified.

-c cookie The -c option takes the argument cookie which is an integer representing alocation in a previously returned list of files. This value allows you to start a newgetmiglist request from a particular point in a previously returned list. Only fileswith cookies greater than or equal to cookie are included in the new list.This is an optional value. The default returns all files regardless of their cookie.

193

Command reference

List formatThe getmiglist file list is in the following format:

Migration Weight-Blocks-Cookie-Handle-Path

The meaning of each column is described in Table 56 on page 193.

getpurgelist The getpurgelist command retrieves a list of files that need to bepurged.

Syntaxgetpurgelist -p fspath [-a age] [-c cookie] [-n num] [-s size] [-k]

-n num The -n option takes the argument num which is the maximum number of files toinclude on the list.This is an optional value. The default returns all files.

-s size The -s option takes the argument size which is the size of a file in bytes. Only filesbigger than or the same as size are included on the list.This is an optional value. The default returns all files.

-k The -k option causes getmiglist to return a summary only. The summary includesthe total number of files that need to be migrated and the total combined size of themigration candidates, in bytes.This is an optional value. The default returns the file list.


Option Description

Table 56 getmiglist file list columns

Option Description

Migration Weight Represents how likely a file is to be migrated relative to the other migrationcandidates.

Blocks Number of file system blocks used to hold the file.

Cookie Integer that represents a file’s location on the file list.

Handle Unique identifier for a file.

Path Full path of the file relative to the mount point of the file system. If this cannot bedetermined, the list displays the string "UNKNOWN".


Command reference

OptionsThe options for getpurgelist are described in Table 57 on page 194.

List formatThe getpurgelist file list is in the following format:

Purge Weight-Blocks-Cookie-Handle-Path

The meaning of each column Heading is described in Table 58 onpage 195.

Table 57 Options for getpurgelist

Option Description


-a age The -a option takes the argument age which is the age in minutes since a file waslast accessed or modified. All files accessed or modified within the time specifiedby age are excluded from the list.This is an optional value. The default is 0 which ignores when a file was lastaccessed or modified.

-c cookie The -c option takes the argument cookie which is an integer representing alocation in a previously returned list of files. This value allows you to start a newgetpurgelist request from a particular point in a previously returned list. Only fileswith cookies greater than or equal to cookie are included in the new list.This is an optional value. The default returns all files regardless of their cookie.

-n num The -n option takes the argument num which is the maximum number of files toinclude on the list.This is an optional value. The default returns all files.

-s size The -s option takes the argument size which is the size of a file in bytes. Only filesbigger than or the same as size are included on the list.This is an optional value. The default returns all files.

-k The -k option causes getpurgelist to return a summary only. The summaryincludes the total number of files that need to be purged and the total combinedsize of the purge candidates, in bytes.This is an optional value. The default returns the file list.

195

Command reference

migin Use the migin command to retrieve purged file data from theback-end system.

The migin command takes the argument filelist, which is the full pathdescription of one or more files. For multiple files, separate each pathdescription by a space.

For migin examples, refer to “How to manually retrieve files” onpage 165.

Syntaxmigin filelist

migout Use the migout command to migrate file data to the back-end system.

The migout command takes the argument filelist, which is the fullpath description of one or more files. For multiple files, separate eachpath description by a space.

For migout examples, refer to “How to manually migrate a file” onpage 164.

Syntaxmigout filelist

migpurgestate Use the migpurgestate command to display the migration and purgestatus of a file. For each file specified, migpurgestate displays one ofthe following messages:

◆ file is not a file.

◆ file is not migrated and not purged.

Table 58 getpurgelist file list columns headings

Heading Description

Purge Weight Represents how likely a file is to be purged relative to the other purge candidates.

Blocks Number of file system blocks used to hold the file.

Cookie Integer representing a file’s location on the file list.


Path Full path of the file relative to the mount point of the file system. If this cannot bedetermined the list displays the string "UNKNOWN".


Command reference

◆ file is migrated and not purged.

◆ file is migrated and purged.

where file is the full path of the specified file.

The migpurgestate command takes the argument filelist, which is thefull path description of one or more files. For multiple files, separateeach path description with a space.

Syntaxmigpurgestate filelist

purge Use the purge command to remove file data from a file system. Onlyfiles which have been successfully migrated are eligible to be purged.Purging a file removes all of a file’s data except for a portion from thehead of the file equal to the value of the Stub Size attribute. For moreinformation about Stub Size, refer to “Configuring a file system” onpage 57.

The space occupied by the purged data is available for use by otherfiles.

The purge command takes the argument filelist, which is the full pathdescription of one or more files. For multiple files, separate each pathdescription with a space.

For purge examples, refer to “How to manually purge files” onpage 164.

Syntaxpurge filelist

Backup and recovery commandsThe backup and recovery commands are described in the followingsections:

◆ “dxcliplink” on page 197

◆ “dxuldm_tar” on page 199

◆ “dxbuildtar” on page 197

◆ “dmattrrecoverfs” on page 200

◆ “get_freeze_timeout” on page 201

◆ “getrecoverlist” on page 201

197

Command reference

◆ “set_freeze_timeout” on page 202

◆ “utdm_fs_freeze” on page 203

◆ “utdm_fs_thaw” on page 204

◆ “utdm_recdmattrf” on page 204

dxbuildtar The dxbuildar command is used to create an archive file, in tarformat, that can be used to load objects into a UTDM file system. Thiscommand takes the output of dxcliplink (for a Centera module EMCCentera back-end) and creates a tar format file. The resulting file isused with dxdmload to create stub files that point to the back-enddata.

This command is located at:

/opt/fsm/adm/smtodm/dxbuildtar


Syntaxdxbuildar -f output_file -p prefix

OptionsThe options for dxbuildtar are described in Table 59 on page 197.

Example 8 on page 198 provides an example of this command.

dxcliplink The dxcliplink command parses an EMC Centera C-Clip andproduces a file containing the attribute information that is needed toestablish a UTDM file system link to the data represented by theC-Clip.

Syntaxdxcliplink -p pathname -o outputfile

Table 59 Options for dxbuildtar

Option Description

-f output_file The -f option takes the argument output_file, which is the full pathname of the resultingarchive file.

-p prefix The -p option takes the argument prefix, which is the segment of the pathnamesproduced by dxcliplink that is not part of the path for the objects in the UTDM filesystem.


Command reference

OptionsThe options for dxcliplink are described in Table 60 on page 198.

Example 8 Recovering data from an EMC Centera back-end

In this example a connection to the data represented by two C-Clipfiles, ABC and DEF, must be restored to a UTDM file system mountedat /mnt/utdm.1. The pathname contains the segment /mnt/utdm.1which is the segment of the full pathnames for ABC and DEF that isnot needed in the pathname relative to the UTDM file system.



2. Create the file /tmp/dxclips.in that contains each C-Clip ID, oneper line separated by a line feed (LF) character.

3. Run dxcliplink to obtain the necessary C-Clip attributeinformation:

dxcliplink -p /mnt/utdm.1 -o /tmp/dxclipinfo.out < /tmp/dxclips.in

4. Run dxbuildtar to generate a tar-format file containing theattribute information from the C-Clips:

dxbuildtar -p /mnt/utdm.1 -f file.tar < /tmp/dxclipinfo.out

5. Run dxdmload to load the attribute information into the UTDMfile system:

dxdmload -xUfv file.tar

dxdmload Use the dxdmload command to load the information in a file createdby dxbuildtar into a UTDM file system.

This command is located at:

/opt/fsm/adm/smtodm/dxdmload

Table 60 Options for dxcliplink

Option Description

-p pathname The -p option takes the argument pathname, which is the full path to the mountpoint of aUTDM file system that is configured with an EMC Centera back-end.

-o outputfile The -o option takes the argument outputfile, which is the full path of the output file.

199

Command reference


Syntaxdxdmload -xUfv dxtarfile

OptionsThe options for dxdmload are described in Table 61 on page 199.

Example 8 on page 198 provides an example of this command.

dxuldm_tar Use the dxuldm_tar command to back up and recover data in filesystems. Data that exists on the back-end system is not backed up bythis command. Only data resident in a file system, and not migrated,is backed up.

Always exclude the .DMATTR files from backup by using the--exclude option.

The dxuldm_tar command is based on the GNU version of tar.However, the command is enhanced so that it determines the filesystem objects required for backup.

For step-by-step instructions on the use of dxuldm_tar, refer to “FSMtools” on page 143.

Syntaxdxuldm_tar --exclude=.DMATTR -cvf tarfile [dir|.]

dxuldm_tar -xvf tarfile [filelist]

OptionsThe options for dxuldm_tar are described in Table 62 on page 200.

Table 61 Options for dxdmload

Option Description

-x The -x option causes dxdmload to extract the information in the file specified by the -foption into the UTDM file system specified by the same file.

-U The -U option ensures that files that exist in the UTDM file system are unlinked andrecreated rather than being overwritten.

-f dxtarfile The -f option takes the argument dxtarfile, which is a tar-formatted file created bydxbuildtar.

-v The -v option produces verbose output.


Command reference

dmattrrecoverfs The dmattrrecoverfs command synchronizes the metadata forrecovered migrated files with the corresponding data on the back-endsystem. Use this command after a file system is recovered by usingNetWorker software. The dmattrrecoverfs command reestablishesthe link between each recovered migrated file and the file’s data onthe back-end system.

For NetBackup and FSM backup tools, recovered migrated files havethe recover bit set. When a file with the recover bit set is accessed,dmattrrecoverfs is automatically called to synchronize the file’s data.

The dmattrrecoverfs command is also started by an hourly cronjobthat is installed in root’s crontab. When dmattrrecoverfs is started itscans the file system for files with the recover bit set andsynchronizes any it finds.

The dmattrrecoverfs command can be run while the file system is inuse.

Table 62 Options for dxuldm_tar

Option Description

-cvf tarfile The -c option instructs the dxuldm_tar command to create an archive.The -v option displays filenames as they are added to the archive file.The -f option takes two arguments:The first argument is tarfile, which is the full path description for the location where thearchive should be created.The second argument is dir, which is a the full path description of the top-level directoryto be archived.When dir is a directory, dxuldm_tar recursively archives all subdirectories and filesbeneath the given directory.Optionally, a period character at the end of the command can be used to indicate thecurrent working directory.

-xvf tarfile The -x option instructs the command to extract an archive.The -v option displays filenames as they are extracted.The -f option takes the argument tarfile, which is the full path description for an archiveto extract. The archive is extracted into the current working directory.

filelist The dxuldm_tar command takes the argument filelist, which is the full path descriptionof one or more files.For multiple files, separate each path description by a space. When filelist is provided,dxuldm_tar only extracts the specified files. If filelist includes a full path to a directorywhich matches a directory path in the archive, then the directory is recursively extracted.

201

Command reference

Syntaxdmattrrecoverfs -p dirpath [-i threads]

OptionsThe options for dmattrrecoverfs are described in Table 63 onpage 201.

get_freeze_timeout The get_freeze_timeout command retrieves the maximum number ofseconds that a file system may be frozen by using utdm_fs_freeze.This number is called the maximum freeze timeout.

The maximum freeze timeout default value is 300 seconds, but it maybe changed on a host-by-host basis by using set_freeze_timeout.

Syntaxget_freeze_timeout

getrecoverlist The getrecoverlist command retrieves a list of files that need to berecovered.

Syntaxgetrecoverlist -p fspath [-k]

OptionsThe options for getrecoverlist are described in Table 64 on page 202.

Table 63 Options for dmattrrecoverfs

Option Description

-p dirpath The -p option takes the argument dirpath, which is the full path to the top-level directoryto be scanned. This parameter is required.

-i threads The -i option takes the argument threads, which is the number of parallel forked threadsdmattrrecoverfs can start. The range is between 1 and 64. The default is 1.


Command reference

List formatThe getrecoverlist file list is in the following format:

Cookie-Handle-Path

The meaning of each column heading is described in Table 65 onpage 202.

set_freeze_timeout The set_freeze_timeout command sets the maximum number ofseconds that a file system may be frozen by using utdm_fs_freeze.This number is called the maximum freeze timeout.

The maximum freeze timeout default value is 300 seconds, the rangeof permissible values is 0 seconds to 600 seconds.

Syntaxset_freeze_timeout maxtime

OptionThe set_freeze_timeout command takes one required argument,maxtime, which is the new maximum freeze timeout in seconds.

Table 64 Options for getrecoverlist

Option Description


-k The -k option causes getrecoverlist to return a summary only. The summaryincludes the total number of files that need to be recovered and the total combinedsize of the recovery candidates, in bytes.This is an optional value. The default returns the file list.

Table 65 getrecoverlist file list columns

Heading Description

Cookie Integer representing a file’s location on the file list.


Path Full path of the file relative to the mount point of the file system. If this cannot bedetermined the list displays the string "UNKNOWN".

203

Command reference

utdm_fs_freeze The utdm_fs_freeze command quiesces, suspends access to, amounted UTDM file system, for a specified number of seconds. Thisallows you to generate a snapshot of a mounted file system withoutthe possibility of file system activity causing a corrupted snapshot.

At the end of the specified time period activity on the file system isautomatically resumed, that is, made available for normal use. Thesnapshot must be completed before the file system is thawed to avoida corrupted snapshot.

You can resume file system activity before the expiration of thesuspension period by using utdm_fs_thaw.

Note: The utdm_fs_freeze command should only be used on mounted filesystems.

Syntaxutdm_fs_freeze [-t timeout] mountpoint

OptionsThe options for utdm_fs_freeze are described in Table 66 onpage 203.

Table 66 Options for utdm_fs_freeze

Option Description

-t timeout The -t option takes the argument timeout which is the number of seconds the filesystem remains frozen. At the expiration of timeout seconds, the file system isautomatically thawed.This parameter is optional. The default is the maximum freeze timeout. If specifiedit must be less than that value. The default maximum freeze timeout is 300seconds.For more information about the maximum freeze timeout, refer to“get_freeze_timeout” on page 201 and “set_freeze_timeout” on page 202.

mountpoint The utdm_fs_freeze command takes the argument mount point which is the fullpath to the mount point for the file system.This value is required.


Command reference

Freeze describedWhen you run utdm_fs_freeze, the following actions are taken forthe specified file system:

◆ Current operations are allowed to finish.

◆ Any thread attempting to access the file system is suspended.

◆ Dirty buffers are flushed.

◆ A stable image of the file system is created on the disk.

Any thread that was suspended by utdm_fs_freeze remainssuspended until the file system is thawed, either by the expiration ofthe specified time period or by running utdm_fs_thaw.

utdm_fs_thaw The utdm_fs_thaw command resumes activity on a mounted UTDMfile system that was quiesced with utdm_fs_freeze.

This command resumes all threads that were suspended when thefile system was quiesced.

Syntaxutdm_fs_thaw mountpoint

OptionThe utdm_fs_thaw command takes one required argument,mountpoint, which is the full path to the mount point for the filesystem.

utdm_recdmattrf The utdm_recdmattrf command recovers a file system that isrestored from a snapshot. This command initiates the process ofcreating a valid namespace for each migrated file in the recoveredsnapshot.

IMPORTANT!The utdm_recdmattrf command must be run on the file systembefore it is used in read/write mode.

The utdm_recdmattrf command processes the restored file system’s.DMATTR file and sets the Recover attribute for each migrated file.The core processes detect the Recover attribute on a file and create anew namespace for the file during the first operation on it. TheRecover attribute is then unset.

205

Command reference

Syntaxutdm_recdmattrf pathname

OptionThe utdm_recdmattrf command takes one required argument,pathname, which is the full path of the recovered file system’s.DMATTR file.


Command reference


Symbols.deleted extension

disk resource 157.DMATTR file

backup 139, 143dxuldm_tar 199expand_dmattrf 186NetBackup exclude_list 141NetBackup recovery 141NetWorker 133utdm_recdmattrf 205

Aactions

Centera 84disk resource 85NFS 85

activitiesdomain 32file system 37

adding, user 26administration

Console 26files 164

administrativecommands 178

Agent, Console 20associativity 78audience 9

Bbackend

Centera 64clean-up 167deleted files 157FTP 67IDM 64module 44mount point 54NFS 54, 68types 44

backup 123.DMATTR file 133, 139, 143commands 196FSM tools 143FSM-related files 124FTP module file system 130general 123NetBackup 137, 141NetWorker 132NetWorker, 64-bit Linux version 136recommendations 124software 126UTDM file systems 125utilities 196

CCentera

actions 84backend 64module 45See also EMC Centera

changing password, user 28, 29

Index


Index

check directory, NFS 55clean-up

backend 167disk resource 170EMC Centera 168find 170periodic 167storage target 170

clearing events 30Client, Console 24command reference

administrative 178backup 196dx_read_log 179dxbuildtar 197dxcliplink 197dxdmload 198dxuldm_tar 197dxuldmcenteraping 182dxuldmcheckconf 183dxuldmclip 183dxuldmdelclips 184dxuldmrecover 135expand_dmattrf 186file management 191get_freeze_timeout 201getdmattr 187getfileattr 188getmiglist 192getpurgelist 193getrecoverlist 201migin 195migout 195migpurgestate 195prtdmsession 188purge 196quick reference 174set_freeze_timeout 202utdm_fs_freeze 203utdm_fs_thaw 204utdm_recdmattrf 204

commandsadministrative 178backup 196internal 158quick reference 174recovery 196

usage 177completion message, purge 165compression

levels 61partial read size 62

configurationdeleting 72disk resource 68editing 71file system 43, 57NFS 68viewing 70

configuring file system 57connect addresses, dxuldmdelclips 185connectivity

EMC Centera 46FTP 52

Consoleadministration 26overview 21starting Client 24

consoleprocesses 162

Console Agent 20Console Client 24

IPv6 24, 25monitoring 30starting 24

console processeslogs 162monitoring 162stopping 162

console processes , starting 162Console Server 20conventions 10copy, extended rules 89core processes

general 156monitoring 160

create, extended rules 80

Ddata management utilities 191data retention

EMC Centera 51, 111EMC Centera requirements 111


Index

general 91, 109deldmsession 178deleted files

backend 157general 157migdestroy 167

deletingconfiguration 72extended rules 88

determiningmaximum time-out 148

direct-read 120memory-mapping 120mounting 121

disk resourceactions 85clean-up 170configuration 68preliminary tasks 54

dmap_root_path, setting 177DMAPI 14DMAPI attributes file, snapshot 204dmattrrecoverfs 200domain

activities 32events 31

dx_read_logcommand reference 179monitoring processes 161options 181severity levels 181

dxbuildtar 197dxcliplink 197dxdmload 198dxuldm_tar

command reference 197options 200using 143

dxuldmcenteraping, command reference 182dxuldmcheckconf, command reference 183dxuldmclip 183dxuldmdelclips

command reference 184connect addresses 185EMC Centera 168purge 184restart 169

dxuldmrecover 135

Eediting

configuration 71extended rules 87

effect of manually stopping, processes 159EMC Centera

clean-up 168connectivity 46data retention 51, 111data retention requirements 111dxcliplink 197dxuldmdelclips 168IPv4 64PEA file 47PEA file permissions 168, 185permissions 46preliminary tasks 45purge 167

EMC Centera data retentionenabling 111performance 110setting for a file system 113setting for files 114

EMC Centera, IPv4 46, 48enable data compression 61, 62events

clearing 30domain 31file system 35host 34

examplemigin 166migout 164

expand_dmattrf, command reference 186exporting, extended rules 89expressions 74extended rules 73

copy 89copying 89create 80creating 74deleting 88editing 87exporting 89


Index

viewing 86

Ffile deletion, uvdmigd 167file management, command reference 191file system

activities 37configuration 43, 57configuring 57events 35recovery 128retention 113state 38

filesadministration 164deleted 157management commands 191manually migrate 164manually purge 164manually retrieve 165retention 114

find, clean-up 170freeze 147

maximum time-out 148snapshot 147SnapView 147UTDM file systems 147

FSMinternal commands 158migpurged 156monitoring 160starting 158stopping 159uvdmigd 157

FSM environment, setting 177FSM tools

backup 143recover 145

FSM-aware software 127FSM-related files, backup 124FTP

backend 67connectivity 52IPv6 52, 67preliminary tasks 52username and password 52

Gget_freeze_timeout

command reference 201snapshot 201SnapView 201

getdmattr, command reference 187getfileattr, command reference 188getmiglist, command reference 192getpurgelist, command reference 193getrecoverlist, command reference 201

Hhost, events 34hostname database 45hosts 45

IIDM

backend 64preliminary tasks 45

incremental backups, recovery 115individual filesystems, monitoring 164internal commands, FSM 158internal, commands 158IPv4 24, 25, 46, 48, 64, 67IPv6 52, 67

Console Client 24, 25

Llogs

console processes 162core processes 161

Mmaintenance 155management commands, files 191management domain 22management utilities 191manual

migrate 164purge 164retrieve 165starting FSM processes 158stopping FSM processes 159


Index

manual data retrieval, uvdmigd 165manually migrate, files 164manually purge, files 164manually retrieve, files 165manually starting, processes 158manually stopping, processes 159match string 74maximum time-out

determining 148freeze 148setting 148snapshot 148

migdestroydeleted files 167process 157

migincommand reference 195example 166uvdmigd 157

migoutcommand reference 195example 164

migpurgedFSM 156process information 156

migpurgestate, command reference 195migrate, manual 164minimum topology 17module

backend 44Centera 45

monitoringConsole Client 30console processes 162core processes 160FSM 160individual filesystems 164

monitoring processes, dx_read_log 161mount options 109

direct-read 120memory-mapping 120mounting 121

EMC Centera data retentionenabling 111performance 110setting for a file system 113setting for files 114

read-only 117mounting 118

readthru 120utdmro 117

mount point, backend 54

NNetBackup

.DMATTR file 141backup 137, 141exclude_list 141recovery 137, 142requirements 139user-initiated backup 141user-initiated restore 141

NetWorker.DMATTR file 133backup 132path information 132permissions 132recovery 133required file 132requirements 132

NFSactions 85check directory 55configuration 68preliminary tasks 54

NFS module 54, 68

Oonline help 25options

dx_read_log 181dxuldm_tar 200

overview, Console 21

Pparentheses 74path information, NetWorker 132PEA file 47performance 110periodic cleanup 167periodic, clean-up 167permissions


Index

EMC Centera 46EMC Centera PEA file 168, 185NetWorker 132

precedence 78preliminary tasks 44

AVALOMidm 45disk resource 54EMC Centera 45FTP 52IDM 45NFS 54

process informationmigpurged 156uvdmigd 157

processes 156console 162effect of manually stopping 159manually starting 158manually stopping 159uvdmigd 157

prtdmsession, command reference 188prune job 95purge

command reference 196completion message 165dxuldmdelclips 184EMC Centera 167manual 164

Qquick reference

commands 174utilities 174

quick reference, utilities 174quiesce. See freeze

Rread-only 117

mounting 118recommendations, backup 124recover, FSM tools 145recovery 123

commands 196file system 128FTP module file system 130general 123

incremental backups 115native FTP 130NetBackup 137, 142NetWorker 133NetWorker, 64-bit Linux version 136single file 145snapshot 149software 126

removing, user 28required file, NetWorker 132requirements

NetBackup 139NetWorker 132

restart, dxuldmdelclips 169restoring incremental backups 115retention

file system 113files 114

retrieve, manual 165

Sscheduled jobs

comparison 92delete old files 92, 97delete old files job, backend differences 94deleting 100editing 99effect on existing settings 93job types 92migrate 92overview 92prune 92, 95, 97purge 92reoccurrence options 102

daily 104monthly 105one specific time 104weekdays 106weekends 105weekly 105yearly 106

schedule components 93time element

creating 102deleting 107editing 107


Index

overview 102viewing 98

Server, Console 20set_freeze_timeout

command reference 202snapshot 202SnapView 202

settingdmap_root_path 177FSM environment 177maximum time-out 148stub size 166

severity levels, dx_read_log 181single file, recovery 145snapshot 127

DMAPI attributes file 204freeze 147get_freeze_timeout 201maximum time-out 148recovery 149set_freeze_timeout 202SnapView 147thaw 149utdm_fs_freeze 203utdm_fs_thaw 204utdm_recdmattrf 204

SnapViewfreeze 147get_freeze_timeout 201set_freeze_timeout 202snapshot 147thaw 149utdm_fs_freeze 203utdm_fs_thaw 204utdm_recdmattrf 204

softwarebackup 126recovery 126

Solariszones 54

back-end mount point 55starting

Console Client 24console processes 162FSM 158

starting Client, Console 24starting FSM processes, manual 158

state, file system 38stopping

console processes 162FSM 159

stopping FSM processes, manual 159storage target, clean-up 170stub size

setting 166

Tthaw

snapshot 149SnapView 149utdm file system 149

time elements 102creating 102

topology 17topology guidelines 18types, backend 44

Uusage, commands 177user

adding 26changing password 28, 29removing 28

user-initiated backup, NetBackup 141user-initiated restore, NetBackup 141username and password, FTP 52utdm file system, thaw 149UTDM file systems

backup 125freeze 147

utdm_fs_freezecommand reference 203snapshot 203SnapView 203

utdm_fs_thawcommand reference 204snapshot 204SnapView 204

utdm_recdmattrf.DMATTR file 205command reference 204snapshot 204SnapView 204


Index

utilitiesadministrative 178backup 196backup and recovery 196file management 191quick reference 174

uvdmigdfile deletion 167FSM 157manual data retrieval 165migin 157process information 157processes 157

Vviewing

configuration 70extended rules 86logs 161

Zzones, Solaris 54

emc diskxtender file system manager for unix/linux release 3.4

Documents