Professional Documents
Culture Documents
Cta Cli
Cta Cli
NAME
rffm - EMC Cloud Tiering Appliance Command-line Tool
VERSION
Version 9.0.x 2011-2012
USAGE
rffm [OPTION] COMMAND [OPTIONS] [ARGUMENTS]
Commands
addTask [--Type=TYPE] [--Policy=POLICY] [--Schedule=SCHEDULE]
[--Source=SOURCE] [--Destination=DESTINATION]
[--DestinationType=DESTINATIONTYPE] [--force]
[--MoveOrphanFiles=yes|no]
[--Encryption=yes|no] [--Compression=yes|no]
[--ProviderName=PROVIDERNAME] [--TaskName=TASKNAME]
[--DelayPeriod=DELAYPERIOD] [--NetworkBandwidth=NETWORKBANDWIDTH]
[--RecursiveFileThreshold=RECURSIVEFILETHRESHOLD]
[--SIDTranslationFile=SIDTRANSLATIONFILE]
getTasks [--Enable=0|1] [--Format=list|detail] [--TaskID=TASKID]
[--TaskName=TASKNAME] [--Type=TYPE]
deleteTask [--TaskID=TASKID] [--TaskName=TASKNAME]
enableTask [--Enable=0|1] [--TaskID=TASKID] [--TaskName=TASKNAME]
getTaskProgress [--EndDate=ENDDATE] [--StartDate=STARTDATE]
[--TaskID=TASKID] [--TaskName=TASKNAME]
stopTask [--Queue=all|active|pending] [--TaskID=TASKID] [--TaskName=TASKNAME]
runTaskNow [--Simulation=summary|detailed] [--TaskID=TASKID] [--TaskName=TASKNAME]
editTask [--TaskID=TASKID] [--TaskName=TASKNAME] [--Schedule=SCHEDULE]
[--Policy=POLICY] [--RecursiveFileThreshold=RECURSIVEFILETHRESHOLD]
getTaskQueue [--Queue=QUEUETYPE] [--Type=TYPE]
getTaskQueueLimits
setTaskQueueLimits [--All=ALLQ] [--ArchiverThreads=ARCHIVERQ]
[--PendingTasks=PENDINGQ] [--StubScannerThreads=STUBSCANNERQ]
celerraFMSettings [--action=get|set]
[--callback-username=CALLBACKUSERNAME]
[--callback-password=CALLBACKPASSWORD]
addServer [--acd-dnsname=ACDDNSNAME]
[--ccd-dnsname=CCDDNSNAME]
[--control-station-ip=CTRLSTATIONIP]
[--DNSName=DNSNAME]
[--domainname=DOMAIN] [--fqdn=FQDN] [--exclude-dir=DIRLIST]
[--fpolicy-secondary-ip=IPLIST] [--is_source=yes/no]
[--is_vdm=yes/no] [--netapppassword=PASSWORD]
[--netappusername=USERNAME] [--password=PASSWORD] [--pea=PEA]
[--profile-password=PROFILEPASSWORD]
[--profile-username=PROFILEUSERNAME]
[--shared_secret=SHAREDSECRET] [--uid=UID] [--username=USERNAME]
[--NDMPUsername=NDMPUSERNAME] [--NDMPPassword=NDMPPASSWORD]
[--NDMPPort=NDMPPORT]
[--URL=AMAZON_BUCKET_URL]
[--access_key_id=AMAZON_ACCESS_KEY_ID]
[--secret_access_key=AMAZON_SECRET_ACCESS_KEY]
[--bucketname=AMAZON_BUCKET_NAME]
[--vfiler-host-ip=VFILERHOSTIP] NAME TYPE [IP ...]
editServer [--acd-dnsname=ACDDNSNAME]
[--ccd-dnsname=CCDDNSNAME]
[--control-station-ip=CTRLSTATIONIP]
[--domainname=DOMAIN] [--fqdn=FQDN] [--exclude-dir=DIRLIST]
[--fpolicy-secondary-ip=IPLIST] [--is_source=yes/no]
[--is_vdm=yes/no] [--netapppassword=PASSWORD]
[--netappusername=USERNAME] [--password=PASSWORD]
[--port=http|https[:PORT]] [--shared_secret=SHAREDSECRET] [--uid=UID]
[--username=USERNAME] [--vfiler-host-ip=VFILERHOSTIP]
[--NDMPUsername=NDMPUSERNAME] [--NDMPPassword=NDMPPASSWORD]
[--NDMPPort=NDMPPORT]
NAME [IP ...]
deleteServer NAME
authServer [--cloud-target=CLOUD-TARGET]
[--centera-target=CENTERA-TARGET] [--nas-repository=NAS-REPOSITORY]
[--primary-source=PRIMARY-SOURCE] SERVERNAME
editFpolicyExclusionIP IP [IP ...]
editFpolicyBlockIP IP [IP ...]
archivedList [--StartTime=yyyy-mm-dd,HH:MM] [--EndTime=yyyy-mm-dd,HH:MM]
[--exact-match] [--limit=LIMIT] [--offset=OFFSET]
[--format=list|detail|simple] UNCPATH
orphanList [--expiredretention] [-limit=LIMIT] [--missing=DAYSMISSING] UNCPATH
stubRecovery [--makewritable] [--modtime=MODTIME] [--restoreall] UNCPATH
deleteOrphan [--deleteall] [--force] [--limit=LIMIT] [--missing=DAYSMISSING] [--noCheckPrimary]
[--modtime=MODTIME] UNCPATH
dxConversion [--CenteraMappingFile=CENTERAMAPPINGFILE] [--ExportName=EXPORTNAME]
[--ShareName=SHARENAME] [--Simulation=summary] [--SanityTest=FULL_PATH_TO_FILE]
SERVER
updateArchivedFilesCount
doDBMaintenance
backupSettings [--action=get|set] [--Destination=DESTINATION]
[--DestinationType=nas|centera] [--DRDestination=DRDESTINATION]
[--DRStartDir=DRSTARTDIR] [--NoOfBackups=NOOFBACKUPS]
restoreBackup
minFileOverride [--Enable=0|1]
addNASRepository [--Source=SOURCE] [--MaxDiskUsagePercent=DISKUSEPERCENT]
listNASRepositories [--RepositoryName=REPOSITORYNAME]
deleteNASRepository [--RepositoryName=REPOSITORYNAME]
editNASRepository [--MaxDiskUsagePercent=DISKUSEPERCENT]
[--RepositoryName=REPOSITORYNAME]
listNASGroups
listPolicies [--Format=list|detail|simple] [--Type=POLICYTYPE] [POLICYNAME ...]
version [--daemon]
listServers [--SourceOnly] [--Type=TYPE] [--Format=list|detail|simple] [SERVERNAME ...]
getFileSystems [--Protocol=cifs|nfs] SERVERNAME
importPEACentera [--FileServer=FILESERVER] [--pea=PEA]
multiTierRepoMigUpdate [--action=get|set|runnow] [--StartTime=STARTTIME]
delayedStubUpdate [--action=get|set|runnow] [--StartTime=STARTTIME]
setNetAppPassthrough [--FileServer=FILESERVER] enable|disable
listNetAppPassthrough
addNetAppPassthroughExcludedExtension EXTENSION
deleteNetAppPassthroughExcludedExtension EXTENSION
addNetAppPassthroughExcludedExpression REG_EX
deleteNetAppPassthroughExcludedExpression REG_EX
listNetAppPassthroughExcludedExpressions
addSIDTranslationFile [--SIDFilePath=SIDFILEPATH]
deleteSIDTranslationFile [--SIDFileNameToDelete=SIDFileNameToDelete]
listSIDTranslationFiles
archiveReportSettings [--action=get|set]
[--AddServerGroup=SERVERGROUP:SVR1,SVR2...]
[--EditServerGroup=SERVERGROUP:SVR1,SVR2...]
[--DeleteServerGroup=SERVERGROUPNAME]
[--FileTypes=FILETYPES] [--FileSizeUnit=kb|mb|gb|tb|pb]
[--GroupA=GROUPA] [--GroupB=GROUPB] [--GroupC=GROUPC] [--GroupD=GROUPD]
[--ReportCleanupDays=REPORTCLEANUPDAYS] [--TimeRange-
Months=TIMERANGE_MONTHS]
[--TimeRangeStartDate=TIMERANGE_STARTDATE] [--TimeRangeEnd-
Date=TIMERANGE_ENDDATE]
listImportProviders
addImportProvider [--username=USERNAME] PROVIDERNAME PASSWORD
editImportProvider [--Password=PASSWORD]
[--PublicKeyPath=PUBLICKEYPATH] PROVIDERNAME
deleteImportProvider PROVIDERNAME
importFromXmlFile [--background] IMPORTFILEPATH
getImportFileHistory [--EndTime=yyyy-mm-dd,HH:MM] [--ImportID=IMPORTID]
[--ProviderName=PROVIDERNAME] [--StartTime=yyyy-mm-dd,HH:MM]
[--TaskID=TASKID] [--TaskName=TASKNAME]
getPendingImportedFiles [--ErrorOnly] [--ExportName=EXPORTNAME]
[--FileServer=FILESERVER] [--Format=count|list|detail|xml]
[--ImportID=IMPORTID] [--ImportDateOlderThan=IMPORTDATE]
[--MinNumErrors=MINNUMERRORS] [--Path=PATH]
[--ShareName=SHARENAME] TASKNAME
deletePendingImportedFiles [--ErrorOnly] [--ExportName=EXPORTNAME]
[--FileServer=FILESERVER] [--ForceDelete] [--ImportID=IMPORTID]
[--ImportDateOlderThan=IMPORTDATE] [--MinNumErrors=MINNUMERRORS]
[--Path=PATH] [--ShareName=SHARENAME] TASKNAME
scheduleVacuumTask [--VacuumStartTime] [--VacuumWeekRepetition]
deleteVacuumSchedule
setFileMigrationTotalBandwidthMBs [--FileMigrationTaskID=FILEMIGRATIONTASKID]
[--TBBandWidthMB=TBBANDWIDTHMB]
getTaskExitThreshold
setTaskExitThreshold [--ThresholdPercent=THRESHOLDPERCENT]
setFileMigrationErrorThreshold [--ErrorThreshold=ERRORTHRESHOLD]
getFileMigrationErrorThreshold
fullyQualifiedDomain [--action=get|set|clear] [--Name=KERBEROS_FQDN] [--DCIP=DCIP]
generateEncryptionKey [--KeyName=ENCRYPTIONKEYNAME]
getEncryptionKey
getEmcSerialNumber
setEmcSerialNumber [EMCSERIALNUMBER]
getFileMigrationJournalingEnable
setFileMigrationJournalingEnable [enable|disable]
DESCRIPTION
rffm is used to configure and manage the features and functionality available within EMC Cloud Tiering
Appliance.
rffm can be used to add, edit and delete file servers configured in Cloud Tiering Appliance. These file
servers contain the servers in the primary and secondary storage tiers, specifically NetApp, Celerra, Centera
and ATMOS. For CTA/VE, only the Celerra and Centera server types are supported. When configuring a
NetApp file server, Cloud Tiering Appliance will automatically register with NetApps Fpolicy, using the IP
address of Cloud Tiering Appliance as the primary callback agent. Multiple primary and secondary call-
back agents can be added to the NetApp configuration to register with FPolicy to provide high availability
for recalling files. When configuring a Celerra file server, secondary connections must be created manually
on the Celerra DART 5.5. The secondary connections can be created automatically for DART 5.6 and above
by the archiver task. Secondary connections are necessary to perform any archiving and recalling opera-
tions. When configuring Centera, a connection string is provided, using a comma separated list of the IP
addresses of the Centera access nodes. A username/password credentials or PEA (Pool Entry Authoriza-
tion) file can be used to authenticate with the Centera. When configuring an ATMOS service, an ATMOS
user ID (uid) and shared secret must be provided. To archive to another NAS platform, the target server
must be configured within Cloud Tiering Appliance to create a NAS repository.
rffm can also be used to add, delete, edit, run, and monitor tasks in the Cloud Tiering Appliance configura-
tion. Tasks can be configured for archive, multi-tier, multi-tier-stub, delete orphans and stubs with expired
retention or repository migration. Tasks can be scheduled to run immediately, run on a scheduled interval,
run at a specific date and time in the future or run based on a disk usage threshold. Once a task has been
configured and submitted, the task schedule can be edited to modify the repeat interval (daily, X-weeks,
Y-months), the repeat time at each interval or set to run immediately. Cloud Tiering Appliance provides
reporting for each archiving task run as well as a summary of the total data archived and space saved per
share/export and file server.
Each task utilizes the FileWalker process to perform simulation, perform file level archiving, multi-tiering,
orphan deletion, repository migration and stub scanning for orphan management and stub recovery. The
archiver task walks the specified CIFS share or NFS export to perform policy-based archiving operations.
Files found by the FileWalker to match policy criteria will be archived to the secondary storage tier and
replaced by stub files. The stub file written to the primary storage contains all necessary metadata to recall
the data from secondary storage and write back the primary tier. The multi-tier task is similar to archive
task with the difference that it operates on stubs in addition to normal files. If the stub matches the policy
criteria it will copy the data from the secondary storage to the tertiary storage and update the stub to refer-
ence the new location. The multi-tier-stub task will operate on stubs only.
The delete orphan task selects orphan files from the database and utilizes the FileWalker process to perform
the file deletion from the secondary storage. The delete stub task selects files with expired retention from
the database and utilizes FileWalker to perform the stub deletion and the associated file on the secondary
storage.
The Repository Migration task is a specialized task used to move all files from the specified secondary stor-
age to a new secondary storage and update the stubs to reference the new file location. A list of NAS secon-
daries can be specified. The task will iterate through the list of NAS secondaries and will use them in
ascending order until it reaches the disk usage limit before moving to the next repository in the list.
The stub scanner is a specialized task used to discover stub files on the primary storage for orphan manage-
ment and stub recovery. It is automatically scheduled during archive task schedule but can also be manually
scheduled. It scans the source share/export looking for stub files and updates the stub timestamp in the local
database. Orphan management and stub recovery utilize the stub scanner to identify stub files on the pri-
mary storage. If the Stub Scanner did not update the file timestamp in the local database for at least 30 days
the file is considered orphan. Stub recovery can be used to recreate stubs for archived files that were
deleted from the primary storage tier as well as provide versioning for archived files.
TERMINOLOGY
Stub file
A small file created by an archiving application that references data on secondary storage.
Orphan
A file that has been archived to secondary storage but does not have a corresponding stub file on
the primary storage.
Policy
Collection of one or more file matching criteria, a secondary storage destinations, data retention
period and policy type.
Task
A definition of a source dataset, a recurring or non-recurring schedule, and a task type.
NAS Repository
A share/export on a Celerra, NetApp, Isilon, Windows (CIFS) or DataDomain (NFS) file server
that can be used as an archiving destination. A NAS repository is defined with a maximum disk
usage percentage.
NAS Group
A NAS Group is a collection of NAS repositories used for archiving or multi-tier tasks. The task
will archive to the first repository in the NAS group until is reaches the specified maximum disk
usage limit. It will continue to iterate through all the repositories in the group until the task is com-
plete.
OPTIONS
-h, --help
Show basic help.
--verbose
Show extra information.
--veryverbose
Show a lot of extra information
--usage
COMMANDS
rffm supports the following commands. Individual commands may have their own set of supported
options. Any such options are described below each command.
Add a recurring or non recurring task for archiving., multitier, delete tasks, or filemigration tasks
or add a recurring task for stub scanner or backup, or run-once repositorymigration task. You can-
not add a non recurring task for stub scanner and backup tasks. The task can be scheduled to start
immediately, start at some time in the future, or repeat at a particular interval.
--Type=importarchive|stubscanner|backup|repositorymigration|filemigration
Task type. For non-importarchive policy tasks there is no need to give this option as
--Policy has a task type associated with it. Specify filemigration type only for Windows
as migration source.
--Policy=POLICY
Define the policy to be used for a policy task. Needed for archiver, multitier, multitier-
stub, deletestub, deleteorphan and filemigration tasks. Policy is not applicable for Win-
dows as migration source. Specify filemigration in the --Type field. No need to specify
--Type if this option is specified, but for an importarchive task --Type is a must.
--Schedule=SCHEDULE
Scheduling option associated with the task. The scheduling options are
--Compression=yes|no
Optional. Cloud destination option for repository migration. If omitted the default value
is ’no’. If specified, option is applied on data that is not currently compressed.
--Encryption=yes|no
Optional. Cloud destination option for repository migration. If omitted the default value
is ’no’. If specified, option is applied on data that is not currently encrypted.
--Destination=DESTINATION
Destination for repositorymigration task. Can be the name of a Centera or Cloud (Atmos,
Amazon S3) or it can be the names of one or more NAS repositories separated by com-
mas. In case of NAS repository the protocol type of each must be the same as that of
--Source
--DestinationType=DESTINATIONTYPE
Optional. DestinationType for repositorymigration task. Valid values are centera, Cloud
(Atmos, Amazon S3) and nas. If omitted it will automatically detect from --Destination.
--ProviderName=PROVIDERNAME
Provider Name configured on the CTA. Valid only for importarchive task.
--TaskName=TASKNAME
Unique name of the task (case in-sensitive). Valid only for importarchive task.
--DelayPeriod=DELAYPERIOD
Delay period in number of days for repositorymigration task. This is an optional parame-
ter. If it is not specified it is taken as 0.
--NetworkBandwidth=NETWORKBANDWIDTH
The total network bandwidth for the FileMigration task in MB/s. The default is 0
(unbounded)
--RecursiveFileThreshold=RECURSIVEFILETHRESHOLD
Recursive File Threshold value for automatic recursive file migration. Indicates total
number of files. After a file migration task is completed if the total number of files
migrated is more than the file threshold value the task is spawned again. This step is
repeated until the total files migrated becomes less than the file threshold. A value of zero
disables recursive file migration. If this option is specified only run-now or run-once
scheduling option is made available.
--SIDTranslationFile=SIDTRANSLATIONFILE
The CIFS SID Translation File name already added through GUI or through addSID-
TranslationFile cli command for a FileMigration task. To see the list of translation files
run rffm listSIDTranslationFiles
Return the submitted tasks matching the type and enabled criteria, or return a specific task based
on the task ID. Note that the --Enable option and --TaskID can be provided to optionally filter the
results, --Type is a required parameter. Specifying --TaskID and --Enable will only return the
specified task if both fields match, ex: rffm gettasks --Enable=1 --TaskID=5 --Type=stubscan-
ner will only returnstub scanner task 5 if it is actually enabled.
--Enable=0|1
Return disabled or enabled tasks.
[--Format=list|detail]
Display format of the tasks. If it is not provided the default value is list if --TaskID is not
specified (or) detail if --TaskID is specified. The user can change this default behavior by
forcefully setting the other format.
* list displays the task information in one line for each task.
* detail displays all the details of the task in multiple lines.
--TaskID=TASKID
If specified, only that TASKID’s information is displayed. Alternatively the user can use
--TaskName=TASKNAME
--TaskName=TASKNAME
If specified, only that task name’s information is displayed. Alternatively the user can use
--TaskID=TASKID
--Type=all|archiver|multitier|multitierstub|deletestub|deleteorphan|stubscan-
ner|importarchive|backup|filemigration|repositorymigration|filemigration|archiver-
group,delete-group
Task type or task group to be returned
Delete specified task. Only tasks which have not executed successfully can be deleted. Use the
rffm getTaskProgress command to verify whether the task has run successfully at least once. Once
the command has been run once successfully it can only be disabled using the rffm enableTask
command.
Return the progress results of a submitted task. To get the task results from a previous date, the
start and end date of the task can be specified. Note, only the date of a particular task can be spec-
ified. If the task has run multiple times in the same day, only the progress of the first run can be
returned.
--EndDate=ENDDATE
YYYY-MM-DD format for the timestamp when the task completed.
--StartDate=STARTDATE
YYYY-MM-DD format for the timestamp when the task started.
--TaskID=TASKID
TaskID for which the action is requested. Alternatively the user can use
--TaskName=TASKNAME
--TaskName=TASKNAME
Task name for which the action is requested. Alternatively the user can use
--TaskID=TASKID
Start a submitted task immediately. The --Simulation argument allows you to run the task as a
simulation. Using this command will not affect the schedule originally configured for the task.
Running this command on a task that is already running will cause the task to be run additional
times concurrently. This will typically not have any adverse effect on the dataset unless files have
been recalled between tasks causing multiple archiving events.
Edit the existing schedule for a submitted task. Use the rffm getTasks TaskID=TASKID com-
mand to get the current schedule configuration. The StartTime field cannot be set to now, only a
time in the future. To have a scheduled task run immediately use the rffm runTaskNow com-
mand.
--TaskID=TASKID
TaskID for which the action is requested. Alternatively the user can use
--TaskName=TASKNAME
--TaskName=TASKNAME
Task name for which the action is requested. Alternatively the user can use
--TaskID=TASKID
--Schedule=SCHEDULE
Scheduling option associated with the task. The scheduling options are
Used to configure or retrieve the backup settings. The backup settings are stored in the rain.xml
and this configuration is used to do backup when a backup task is scheduled.
--action=get|set
Action to be performed. Valid actions are
* set is used for setting the backup settings. Used as both add and edit. When running
this command for the first time after installation, it works as add. Running it after the first
successful --action=set, it works as edit.
* get displays the backup settings.
--Destination=DESTINATION
A configured Centera Name or a NAS Destination Name. Run rffm listNASRepositories
to view all the NAS repositories. rffm listServers lists all the servers from which a Cen-
tera can be selected.
--DestinationType=nas|centera
Represents the type of destination.
--DRDestination=DRDESTINATION
Disaster Recovery NAS Destination Server Name. Currently supports an already config-
ured Celerra and NetApp servers only. rffm listServers lists all the servers from which a
Celerra or NetApp can be selected.
--DRStartDir=DRSTARTDIR
Disaster Recovery Start Directory relative to DRDESTINATION. Must be an NFS path.
To find the list of NFS exports run rffm getFileSystems --Protocol=nfs DRDESTINA-
TION. Note: The cli checks only the export name and not the entire path. (If /fs1 is a
valid export and if you specify /fs1/subfolder1/subfolder2, the cli checks only for /fs1.
2) For making changes to the existing settings it is not necessary to give all the parame-
ters. To change number of backups to 8:
restoreBackup
restoreBackup command is used to restore a Backup file. It will list all the backups available and
will promt the user to enter which file he wants to restore from the list. Once the user gives the
filename, the command will do the restore and will return the location of the restored file to the
user.
Get the tasks in the scheduler’s active and pending queues. Pending queue includes all the run-now
tasks and the task scheduled by the scheduler in the pending queue.
--Queue=all|active|pending|pending-run-now|pending-schedule
The queue type of interest.
--Type=all|archiver|multitier|multitierstub|deletestub|deleteorphan|stubscan-
ner|importarchive|backup|repositorymigration|filemigration|archiver-group|delete-
group|simulation
The task type or task group for which task queue is required.
getTaskQueueLimits
--PendingTasks=PENDINGQ
Maximum size of the pending queue. Valid values are
* default
* any value from 1 to 1000
default sets the daemon’s default value for this option. This option overrides --All for the
size of pending queue.
--ArchiverThreads=ARCHIVERQ
Maximum number of archiver threads that can run simultaneously. Valid values are
* default
* any value from 1 to 5
default sets the daemon’s default value for this option. This option overrides --All for the
maximum number of archiver threads.
--StubScannerThreads=STUBSCANNERQ
Maximum number of stub scanner threads that can run simultaneously. Valid values are
* default
* any value from 1 to 5
default sets the daemon’s default value for this option. This option overrides --All for the
maximum number of stub scanner threads.
celerraFMSettings [--action=get|set]
[--callback-username=CALLBACKUSERNAME]
[--callback-password=CALLBACKPASSWORD]
Global celerra FileMover settings. The credentials provided here are used for both FileMover and
callback credentials for CCD and ACD.
--action=get|set
Action to be performed. Valid actions are
* set is used for setting the callback credentials.
* get displays the callback credentials (masks the password).
--callback-username=CALLBACKUSERNAME
Username used for filemover and ccd/acd callbacks.
--callback-password=CALLBACKPASSWORD
Password used for filemover and ccd/acd callbacks.
addServer [--acd-dnsname=ACDDNSNAME]
[--ccd-dnsname=CCDDNSNAME]
[--control-station-ip=CTRLSTATIONIP]
[--DNSName=DNSNAME]
[--domainname=DOMAIN] [--fqdn=FQDN] [--exclude-dir=DIRLIST]
[--fpolicy-secondary-ip=IPLIST] [--is_source=yes/no]
[--is_vdm=yes/no] [--netapppassword=PASSWORD]
[--netappusername=USERNAME] [--password=PASSWORD] [--pea=PEA]
[--port=http|https[:PORT]] [--profile-password=PROFILEPASSWORD]
[--profile-username=PROFILEUSERNAME]
[--shared_secret=SHAREDSECRET] [--uid=UID] [--username=USERNAME]
[--NDMPUsername=NDMPUSERNAME] [--NDMPPassword=NDMPPASSWORD]
[--NDMPPort=NDMPPORT]
[--URL=AMAZON_BUCKET_URL]
[--access_key_id=AMAZON_ACCESS_KEY_ID]
[--secret_access_key=AMAZON_SECRET_ACCESS_KEY]
[--bucketname=AMAZON_BUCKET_NAME]
[--vfiler-host-ip=VFILERHOSTIP]
Add a server to the CTA configuration. The server can be of type Celerra, NetApp, Centera, Win-
dows, DataDomain, Isilon (or) Cloud (Atmos, Amazon S3). A file server must be configured
within CTA if it will be used as an archiving source or a NAS repository target. To authenticate
with a NetApp file server, the local administrator credentials must be provided, as well as CIFS
specific authentication. If the administrator login or CIFS authentication information is incorrect,
an error will be returned indicating CTA could not register with the NetApp. To authenticate with
a Celerra file server, CIFS authentication information is required. If the Celerra will be used as a
source, the CCD and FileMover credentials are required as well. For archiving and recalling
between Celerra and Centera, the CCD username and password are required for authentication to
use the secondary HTTP connection configured on Celerra. If there are any errors in the CIFS or
FileMover authentication, no error will be reported until an archiving task is run and reports an
error. If a PEA file or profile username and password are needed for Centera authentication but
none is specified no error will be reported until an archive task attempts to write to the Centera and
is unsuccessful. Isilon file server supports both NFS and CIFS, but providing CIFS credentials is
optional.
--acd-dnsname=ACDDNSNAME
The Fully Qualified DNS name for the Cloud callback daemon that is used in the HTTP
connection for recalling from Cloud (Atmos, Amazon S3) to Celerra or VNX. Ex: If the
secondary connection uses the HTTP path, http://acd.domain.prv to resolve the Cloud
callback daemon, acd.domain.prv should be entered here.
--ccd-dnsname=CCDDNSNAME
The Fully Qualified DNS name for the Celerra callback daemon that is used in the HTTP
connection for recalling from Centera to Celerra or VNX. Ex: If the secondary connec-
tion uses the HTTP path, http://ccd.domain.prv to resolve the Celerra callback daemon,
ccd.domain.prv should be entered here.
--control-station-ip=CTRLSTATIONIP
IP address of the control station for Celerra/VNX/VNXe. Required for DART version >=
5.6. Not required for DART version <= 5.5
--DNSName=DNSNAME
DNS Name of ATMOS cloud.
--domainname=DOMAIN
NetBIOS or FQDN format of the domain that the NetApp belongs to, ex: domain or
domain.prv are both acceptable.
--fqdn=FQDN
Fully qualified Kerberos domain name. Used instead of --domainname.
--exclude-dir=DIRLIST
Directory(s) that will be excluded from any tasks (except StubScanner, Delete_Stub, and
Delete_Orphan) run by CTA. Note that system directories such as .etc, lost+found, will
be ignored by design and do not need to be entered here.
--filemover-username=FILEMOVERUSERNAME
--filemover-password=FILEMOVERPASSWORD
Celerra username and password that can be authenticated to use the Filemover API used
for archiving on Celerra. If the Celerra will be used as a source for archiving, the File-
mover username and password are required fields.
--fpolicy-secondary-ip=IPLIST
Host machine IP addresses to register with FPolicy as secondary callback daemon(s). By
design FPolicy will always try to reach each of the primary agents for recalls before try-
ing secondary agents. By default, all available agents will be registered as primary unless
--vfiler-host-ip=VFILERHOSTIP
If the file server is a NetApp vfiler, the IP address of the host filer must be specified with
this field.
--is_vdm=yes|no
If the file server is a Celerra VDM, the flag needs to be specified, and CIFS only can be
supported.
NAME
NetBIOS name for Celerra and NetApp file servers. Logical name for Centera servers.
TYPE=Celerra|NetApp|Centera|Windows|DataDomain|Isilon|Cloud (Atmos, Amazon S3)
Server type.
editServer [--acd-dnsname=ACDDNSNAME]
[--ccd-dnsname=CCDDNSNAME]
[--control-station-ip=CTRLSTATIONIP]
[--domainname=DOMAIN] [--fqdn=FQDN] [--exclude-dir=DIRLIST]
[--fpolicy-secondary-ip=IPLIST] [--is_source=yes/no]
[--is_vdm=yes/no] [--netapppassword=PASSWORD]
[--netappusername=USERNAME] [--password=PASSWORD]
[--port=http|https[:PORT]] [--shared_secret=SHAREDSECRET] [--uid=UID]
[--username=USERNAME] [--vfiler-host-ip=VFILERHOSTIP]
[--NDMPUsername=NDMPUSERNAME] [--NDMPPassword=NDMPPASSWORD]
[--NDMPPort=NDMPPORT]
NAME [IP ...]
Edit an existing server, other than a Centera, in the CTA configuration. Any changes made to the
existing NetApp authentication information will not trigger an error to be generated if a mistake is
made. However authentication errors will be printed to the debug log when CTA attempts to
reregister with the NetApp after 30 seconds. Changes made to the primary FPolicy IP will not be
valid if the target machine is not running the FPolicy callback daemon. Changes made to the
existing Celerra authentication information will not trigger an error if a mistake is made. How-
ever, errors will be generated once an archiving task is run if there is a problem with the CIFS,
FileMover or CCD authentication information. You are not allowed to edit a Centera. The only
way to do it is to delete an existing Centera and create a new one.
--acd-dnsname=ACDDNSNAME
The Fully Qualified DNS name for the Cloud callback daemon that is used in the HTTP
connection for recalling from Cloud (Atmos, Amazon S3) to Celerra or VNX. Ex: If the
secondary connection uses the HTTP path, http://acd.domain.prv to resolve the Cloud
callback daemon, acd.domain.prv should be entered here.
--ccd-dnsname=CCDDNSNAME
The DNS name for the Celerra callback daemon that is used in the HTTP connection for
recalling from Centera to Celerra or VNX. Ex: If the secondary connection uses the
HTTP path, http://ccd.domain.prv to resolve the Celerra callback daemon,
ccd.domain.prv should be entered here.
--control-station-ip=CTRLSTATIONIP
IP address of the control station for Celerra/VNX/VNXe. Required for DART version >=
5.6. Not required for DART version <= 5.5
--domainname=DOMAINNAME
NetBIOS or FQDN format of the domain that the NetApp belongs to, ex: domain or
domain.prv are both acceptable.
--fqdn=FQDN
Fully qualified Kerberos domain name. Used instead of --domainname.
--exclude-dir=DIRLIST
Directory(s) that will be excluded from any tasks (except StubScanner, Delete_Stub, and
Delete_Orphan) run by CTA. Note that system directories such as .etc, lost+found, will
be ignored by design and do not need to be entered here.
--filemover-username=FILEMOVERUSERNAME
--filemover-password=FILEMOVERPASSWORD
Celerra username and password that can be authenticated to use the Filemover API used
for archiving on Celerra. If the Celerra will be used as a source for archiving, the File-
mover username and password are required fields.
--fpolicy-secondary-ip=IPLIST
Host machine IP addresses to register with FPolicy as secondary callback daemon(s). By
design FPolicy will always try to reach the primary agent for recalls before trying sec-
ondary agents.
--is_source=yes|no
Specify whether the file server will be used as a source for archiving. If this is set to no,
the file server can only be used as a NAS repository.
--netappusername=NETAPPUSERNAME
--netapppassword=NETAPPPASSWORD
The local NetApp administrator username and password with root privileges for
ONTAPI.
--username=USERNAME
--password=PASSWORD
CIFS administrative username and password.
--port=http|https[:PORT]
Port for ATMOS cloud. (See description under the addServer command.)
--shared_secret=SHAREDSECRET
ATMOS shared secret.
--uid=UID
ATMOS uid.
--vfiler-host-ip=VFILERHOSTIP
If the file server is a NetApp vfiler, the IP address of the host filer must be specified with
this field.
--NDMPUsername=NDMPUSERNAME
NDMP Username for Celerra
--NDMPPassword=NDMPPASSWORD
NDMP Password for Celerra
--NDMPPort=NDMPPORT
NDMP Port Number for Celerra. For default, it defaults to 10000, otherwise it must be a
numberic value between 1 and 65536
--is_vdm=yes|no
If the file server is a Celerra VDM, the flag needs to be specified, and CIFS only can be
supported.
NAME
NetBIOS name for preconfigured Celerra or NetApp file server.
deleteServer NAME
Remove the specified server from the CTA configuration. Servers containing NAS repositories
cannot be deleted unless the repository is deleted first from the CTA configuration.
When this command is run to remove a NetApp, the CTA Fpolicy configuration will be removed
from the file server. Recall/FPolicy events will not longer be sent to the CTA after running this
command, making archived files inaccessible to CIFS and NFS clients.
When this command is run to remove a Celerra, CTA will no longer authorize HTTP recall
requests received from the file server. After running this command archived data stored on Cen-
tera is inaccessible to the Celerra server through the CTA.
When this command is run to remove a Centera, CTA will no longer be able to access archived
data stored on the server. Recall requests sent to the CTA for data stored on the Centera from
NetApp or Celerra file servers will not complete successfully. Once an archiving task has been run
to write data to Centera, it should never be removed from the configuration for this reason. Recall
can be restored if the same Centera is added back to the configuration with the same logical name.
authServer [--cloud-target=CLOUD-TARGET]
[--centera-target=CENTERA-TARGET] [--nas-repository=NAS-REPOSITORY]
[--primary-source=PRIMARY-SOURCE] SERVERNAME
Authenticate server credentials. The user the perform authentication on any of the servers available
in rffm listServers. Celerra server configured as as source requires one or more of the following
parameters for performing filemover, CCD or ACD authentication.
[--cloud-target=CLOUD-TARGET]
Atmos or Amazon S3 name. Should be already available in the server list. Required if
you want to perform ACD authentication if SERVERNAME is a Celerra server.
[--centera-target=CENTERA-TARGET]
Centera name. Should be already available in the server list. Required if you want to per-
form CCD authentication if SERVERNAME is a Celerra server.
[--nas-repository=NAS-REPOSITORY]
Secondary NAS repository name (from rffm listNASRepositories). Required for verify-
ing filemover authentication if SERVERNAME is a Celerra server with an empty Cel-
erra Control StationIP. Not needed if Celerra Control StationIP is specified for the Celerra
or if CENTERA-TARGET or CLOUD-TARGET is specified.
[--primary-source=PRIMARY-SOURCE]
SERVERNAME’s export or share of the form /fs1 for an NFS export and \fs1 for a CIFS
share. Required if SERVERNAME is a Celerra server for performing ACD/CCD authen-
tication and for filemover authentication if Celrra Control StationIP is empty.
SERVERNAME
Name of the server whose credentials are to be authenticated.
Configure an IP address(s) that will be excluded from recalling on NetApp for backup purposes.
The specified client IPs will not trigger a recall and will have access to read the stub file content.
Each time this command is run the existing list will be replaced by the new IPs.
Configure an IP address(s) that will be excluded from recalling on NetApp for backup purposes.
The specified client IPs will not trigger a recall and will have not access to read the stub file con-
tent. When the client attempts to access the stub file, they will get an ’Access Denied’ message.
Each time this command is run the existing list will be replaced by the new IPs specified.
archivedList takes <UNCPATH> and returns the list of files that have been archived for
that particular share/export. Entering a share or export will cause all the files archived
under that share/export to be displayed. In order to show just the files under a particular
directory, you must end the path with a directory delimiter. If no stubs are found for a
particular directory, only a blank line will be returned.
[--StartTime=yyyy-mm-dd,HH:MM]
Archived start time. Used to restrict the search results starting from this time.
[--EndTime=yyyy-mm-dd,HH:MM]
Archived end time. Used to restrict the search results until this time.
[--exact-match]
Perform an exact match on the UNCPATH. If this option is omitted it searches
for UNCPATH*.
[--limit=LIMIT]
Limit the number of orphans with the --limit value and supply the desired num-
ber to show as <LIMIT>. If omitted it defaults to 1000.
[--offset=OFFSET]
Start displaying the result starting from the given OFFSET. If omitted the OFF-
SET is 0.
[--format=list|detail|simple]
Display format of the files. If omitted, the default value is list. The user can
change this default behavior by forcefully setting the other format.
* list displays the results in a formatted fashion with header and footer.
* detail displays all the details in multiple lines.
* simple displays the results in a tab-separated fashion. It is formatted in such a
way the scripts can easily parse them.
UNCPATH
UNCPATH is of the form \\SERVER\SHARE[\PATH] or
//SERVER/SHARE[/PATH] for CIFS OR SERVER:/EXPORT[//PATH] for
NFS. It can also contain path with wildcard characters * or ?. To specify a
directory, the path must end with a directory delimiter character.
orphanList takes <UNCPATH> and returns the list of orphaned stubs that have been dis-
covered for that particular share/export. If no orphans are found for a particular directory
or --missing value, only a blank line will be returned. With the --missing option, you can
view only the orphans seen longer than DAYSMISSING days ago. However, an orphan
will not be "found" until the stub scanner has been run. Thus, if you delete a stub, it
won’t immediately show up in the orphan file list. You can force the stub scanner to run
with rffm runTaskNow --TaskID with the task ID of the stub scanner. As long as it has
been at least 1 day since the stub was deleted it will show up in the list.
[--expiredretention]
Only show orphans whose retention period has expired
[--limit=LIMIT]
Limit the number of orphans with the --limit value and supply the desired num-
ber to show as <LIMIT>
[--missing=DAYSMISSING]
Limit the number of orphans to only ones "missing" after <DAYSMISSING>
Without the --missing option, only orphans not seen for 30 days or more will be
shown.
UNCPATH
UNCPATH is of the form \\SERVER\SHARE[\PATH] or
//SERVER/SHARE[/PATH] for CIFS OR SERVER:/EXPORT[//PATH] for
NFS. It can also contain path with wildcard characters * or ?. To specify a
directory, the path must end with a directory delimiter character.
stubRecovery will take a <UNCPATH> and attempt to restore or recover that file’s stub.
You must specify a full UNC path, in the form of \\SERVER\SHARE[\PATH] or
//SERVER/SHARE[/PATH] for CIFS OR SERVER:/EXPORT[//PATH] for NFS. Option-
ally, a <MODTIME> can be supplied to specify which particular version of a file you
would like to restore the stub of. If you have archived multiple instances of the same file,
you can specify which one to restore by its modified time as listed in the archived files
list. The format for <MODTIME> is: "YYYY-MM-DD HH:MM:SS".
[--makewritable]
Create the file with write permission
[--modtime=MODTIME]
Recover a specific version of FILEPATH specified by last modified time at
MODTIME
[--restoreall]
Recover all stub files matching the specified FILENAME or DIRECTORY path.
i.e. a path like ’/export/dir0/file’ will match the files file1.txt and file2 in dir0 and
the sub-directory filesFromMarketing in dir0. Note: if you only want to match a
particular directory then add a directory divider at the end of the path, like
’.../dir0/filesFromMarketing/’
UNCPATH
UNCPATH is of the form \\SERVER\SHARE[\PATH] or
//SERVER/SHARE[/PATH] for CIFS OR SERVER:/EXPORT[//PATH] for
NFS. It can also contain path with wildcard characters * or ?. To specify a
directory, the path must end with a directory delimiter character.
added to the CTA configuration. It is also important to use the <SanityTest> option to
try to convert a file on each destination to verify that you have correctly added all needed
destination servers to the CTA configuration. If there is a network or server failure during
the conversion, the conversion must be run for the entire file system again, but any suc-
cessfully converted stubs from previous runs of the conversion will be skipped. The DX
NAS Conversion will verify that the secondary data file exists on secondary storage. For
Centera secondary data, no modification is done to the Centera Clip or metadata. For
NAS secondary files, the secondary repository file is copied to the CTA repository. If no
de-duplication was using in the DX NAS repository, then the file is removed from the DX
NAS repository after the copy is successful. If the DX NAS repository uses de-dup, the
repository file is not deleted and the user is responsible to delete the de-dup repository
files after the conversion is completed.
[--CenteraMappingFile=CENTERAMAPPINGFILE]
This file must be specified if archiving to Centera was performed with the DX
NAS product. The Format is, one Centera server mapping on each line with the
DX NAS server Netbios name followed by a colon followed by the Centera
internal ID then spaces followed by the CTA Centera name. The Centera inter-
nal ID is shown in the DX NAS GUI in the Details for the Centera configured on
the Destination tab. i.e. dxserver:centera4 labCentera dxserver:centera5 eng-
Centera
[--ExportName=EXPORTNAME]
Nfs export on the server.
[--ShareName=SHARENAME]
Cifs share on the server.
[--Simulation=summary]
This option can be specified to just count the number of DX NAS stubs to be
converted on the file system, but this option must scan the entire file system and
detect the DX stubs so this is not much faster than running the conversion on the
file system.
[--SanityTest=FULL_PATH_TO_FILE]
This option is used to convert a single file to test the CTA configuration and Cel-
erra DHSM configuration. The path specified should be a full path relative to the
share or export specified. -TP SERVER The net bios name of the Celerra pri-
mary server to run the stub conversion against.
The deleteOrphan command can delete the file data for a single orphan file or all orphans
under the specified file path. The deleteOrphan command defaults to deleting data from
secondary storage for a single orphan file. To delete all orphan data located in the
<UNCPATH> location, the [--deleteall] option must be specified. The <UNCPATH>
must specify the last location, on primary storage, of the stub file that was deleted (creat-
ing an orphan file). This command only deletes the data stored on secondary tier storage.
This can be either a NAS repository on a Celerra or NetApp file server or Centera. If the
secondary storage is Centera, It will only succeed if the retention period for that particu-
lar file on the Centera has expired. You must specify a full path, in the form ’\\SHARE-
NAME\DIR\FILENAME’ in the case of CIFS and /EXPORT/FILENAME for NFS.
Optionally, a <MODTIME> can be supplied to specify which particular version of a file
you would like to delete (when deleting a single orphan). If you have archived multiple
instances of the same file, you can specify which one to delete by its modified time as
listed in the orphan list. The format for <MODTIME> is: "YYYY-MM-DD
HH:MM:SS".
NOTE:
The orphanList command or deleteOrphan --deleteall command use the CTA database to
find orphan files. It is possible that the stub file may have been recreated or copied from
backup tape and exist on the primary storage. If deleteOrphan finds that the primary stub
file exists, it will not delete the data for this file and it will update the CTA database so it
is no longer marked as an orphan file.
[--deleteall]
Removes all orphan files under the specified FILEPATH
[--force]
Only applies to deleteall, will not prompt the user to continue; automatically
deletes all orphan data
[--limit=LIMIT]
Only applies to deleteall, LIMIT is the maximum number of orphans that will be
process (10,000 is the maximum and default)
[--missing=DAYSMISSING]
Only applies to deleteall, Only stubs missing for this many days will be removed
from secondary storage (30 days is the minimum and default)
[--noCheckPrimary]
This option will remove orphans without checking to see if the primary stub file
exists. IMPORTANT: This option exists to remove orphan files when the
primary share, export, or even server has be removed from the user envi-
ronment. It should not be used normally because it can delete orphan files
when the original stub file still exists and create data lose.
[--modtime=MODTIME]
Recover a specific version of FILEPATH specified by last modified time at
MODTIME
UNCPATH
UNCPATH is of the form \\SERVER\SHARE[\PATH] or
//SERVER/SHARE[/PATH] for CIFS OR SERVER:/EXPORT[//PATH] for
NFS. It can also contain path with wildcard characters * or ?. To specify a
directory path, the path must end with a directory delimiter character.
updateArchivedFilesCount
Used to update the Archived Files Count in the Database. This command can be used
when the archived files limit is exceeded. It updates the current number of archived files
incase orphan deletion is run to make room in the database to archive more files.
doDBMaintenance
doDBMaintenance command will do Database maintenance task. This will stop the file-
management daemon and gui before executing these maintenance tasks and restarts them
back once it is done.
minFileOverride [--Enable=0|1]
When this option is enabled, files smaller than 4k on NetApp and less than or equal to 8k
on Celerra can be archived by the policy engine. By default this option is disabled, caus-
ing files smaller than the minimum block size to be ignored during archiving. This option
Create a new NAS repository that can be used as an archiving destination. To create a
new NAS repository, the file server must be added to the CTA configuration beforehand.
The repository name will be created automatically in the format "Repository at
//SERVER/SHARE" or "Repository at SERVER:/EXPORT".
[--Source=SOURCE]
The location on NAS to create the CIFS or NFS repository where:
SOURCE is \\SERVER\SHARE or //SERVER/SHARE for CIFS share or
SERVER:/EXPORT for NFS export
SERVER is a NetApp or Celerra/VNX/VNXe or DataDomain or Windows or
Isilon file server configured in CTA
SHARE is the name of a CIFS share
EXPORT is the name of an NFS export
[--MaxDiskUsagePercent=DISKUSEPERCENT]
Set the maximum disk usage percentage of the NAS repository. The default
value is 90%. CTA will not archive data to a NAS repository which has passed
the specified disk usage.
listNASRepositories [--RepositoryName=REPOSITORYNAME]
deleteNASRepository [--RepositoryName=REPOSITORYNAME]
Remove a NAS repository from the CTA configuration. Deleting a NAS repository will
invalidate any policy that uses it as an archiving destination. After running this com-
mand, the CTA will not service NetApp recall requests for files stored in the deleted
repository. Care should be taken when removing a repository to ensure that recall ability
is not affected.
[--RepositoryName=REPOSITORYNAME]
Specify the repository to be deleted.
editNASRepository [--MaxDiskUsagePercent=DISKUSEPERCENT]
[--RepositoryName=REPOSITORYNAME]
listNASGroups
List all or the specified policies that are defined in the configuration.
[--Format=list|detail|simple]
Display format of the policies. If it is not provided the default value is list if no
POLICYNAME is specified (or) detail if one or more POLICYNAME is
specified. The user can change this default behavior by forcefully setting the
other format.
* list displays the policy tasktype and the policy name in one line for each policy
in a formatted fashion with header and footer.
* detail displays all the details of the policy in multiple lines.
* simple displays the policy tasktype and name in one line for each policy. It is
formatted in such a way the scripts can easily parse them.
[--Type=POLICYTYPE]
Filter the output by policy type. Must be one of all, archive, multi_tier,
multi_tier_stub, delete_stubs, delete_orphans, migrate_file
POLICYNAME
Name of the policy as provided at the time of creation. You can get the list of all
the policies by calling rffm listPolicies
version [--daemon]
Display the current version of the CTA software. --daemon can be specified to show the
version of the running daemon.
--Protocol=cifs|nfs
Optional. Filesystem protocol. If omitted it list both cifs and nfs filesystems.
SERVERNAME
Logical name of the server as provided at the time of creation. You can get the
list of all the server names by calling rffm listServers
listNetAppPassthrough
Lists the status of NetApp passthrough recall, which can be enabled or disabled.
addNetAppPassthroughExcludedExtension EXTENSION
Add a CIFS file extension for which NetApp passthrough recall is disabled. CTA will
always perform a full recall of files with this extension.
deleteNetAppPassthroughExcludedExtension EXTENSION
Delete a CIFS file extension for which NetApp passthrough recall is disabled. CTA will
support passthrough recall for files with this extension. (See listNetAppPassthrough to
review NetApp passthrough support for configured file servers.)
addNetAppPassthroughExcludedExpression REG_EX
Add a regular expression for CIFS file names (not full paths) for which NetApp
passthrough recall is disabled. See the regex man page, REGEX(7), for regular expres-
sion syntax. CTA always performs a full recall of CIFS files with matching names.
deleteNetAppPassthroughExcludedExpression REG_EX
Delete a regular expression for CIFS file names for which NetApp passthrough recall is
disabled.
listNetAppPassthroughExcludedExpressions
List the CIFS file extensions and regular expressions for which NetApp passthrough
recall is disabled. CTA always performs a full recall of CIFS files with matching file
names or extensions.
addSIDTranslationFile [--SIDPath=SIDPATH]
Adds the CIFS SID Translation file to the Database and copies the specified SID Transla-
tion file to /opt/rainfinity/filemanagement/SID
--SIDPath=SIDPATH
Full Path to the SID Translation File
deleteSIDTranslationFile [--SIDFileNameToDelete=SIDFILENAMETODELETE]
Deletes the CIFS SID Translation file from /opt/rainfinity/filemanagement/SID and also
deletes it from Database
--SIDFileNameToDelete=SIDFILENAMETODELETE
The name of the SID Translation File to be deleted
listSIDTranslationFiles
Lists all the SID Translation Files added to the CTA
archiveReportSettings [--action=get|set]
[--AddServerGroup=SERVERGROUP:SVR1,SVR2...]
[--EditServerGroup=SERVERGROUP:SVR1,SVR2...]
[--DeleteServerGroup=SERVERGROUPNAME]
[--FileTypes=FILETYPES] [--FileSizeUnit=kb|mb|gb|tb|pb]
[--GroupA=GROUPA] [--GroupB=GROUPB] [--GroupC=GROUPC ]
[--GroupD=GROUPD]
[--ReportCleanupDays=REPORTCLEANUPDAYS] [--TimeRange-
Months=TIMERANGE_MONTHS]
[--TimeRangeStartDate=TIMERANGE_STARTDATE] [--TimeRangeEnd-
Date=TIMERANGE_ENDDATE]
listImportProviders
Lists all import providers configured in the CTA.
PASSWORD
Password for provider system user
editImportProvider [--Password=PASSWORD]
[--PublicKeyPath=PUBLICKEYPATH] PROVIDERNAME
Edit the import provider password in the CTA configuration or install ssh/scp public key.
--Password=PASSWORD
Password for provider system user
--PublicKeyPath=PUBLICKEYPATH
Absolute path to public key file
PROVIDERNAME
Case in-sensitive name of the provider name to edit.
deleteImportProvider PROVIDERNAME
Delete the import provider from the CTA configuration.
PROVIDERNAME
Case in-sensitive name of the provider name to delete.
--FileServer=FILESERVER
File Server name.
--ImportID=IMPORTID
XML import file ID as mentioned in the <ID> tag of the import file.
--ImportDateOlderThan=IMPORTDATE
Used for selecting files imported on or before this date.
--MinNumErrors=MINNUMERRORS
Used for selecting files with MINNUMERRORS or more archive failures.
--Path=PATH
Filepath relative to SHARENAME or EXPORTNAME. CIFS path can have
either / or \ as directory delimiter.
--ForceDelete
Suppress confirmation of delete. If unspecified the CLI asks for confirmation to
the user for deleting.
TASKNAME
Name of the import task.
deleteVacuumSchedule
Delete a Vacuum Task that had been scheduled before
getTaskExitThreshold
Returns the current minimum success threshold percent for the filewalker for Archiver,
Repository Migration and StubScanner tasks.
setTaskExitThreshold [--ThresholdPercent]
Sets the minimum success threshold percent below which the filewalker would exit for
Archiver, Repository Migration and StubScanner tasks. If this is set to a high value on a
failed migration we will have to manually copy files to the destination. This value is
applicable only as long as fmd is running. If it is restarted, this value is lost. Currently
this feature is not being used
--ThresholdPercent
The minimum success threshold percentage below which rfwalker would exit.
setFileMigrationErrorThreshold [--ErrorThreshold]
Sets the threshold for the number of errors for FileMigration task
--ErrorThreshold
Specifies the error threshold
getFileMigrationErrorThreshold
Get the FileMigration Error Threshold
generateEncryptionKey [--KeyName=ENCRYPTIONKEYNAME]
Generate new global encryption key
--KeyName=ENCRYPTIONKEYNAME
Name or reason for new encryption key.
getEncryptionKey
Get Global Encryption Key
getEmcSerialNumber
Get EMC serial number
setEmcSerialNumber [EMCSERIALNUMBER]
Set EMC serial number
EMCSERIALNUMBER
EMC serial number
getFileMigrationJournalingEnable
Get the current global state of File Migration Journaling
setFileMigrationJournalingEnable [enable|disable]
Set the state of File Migration Journaling globally
enable|disable
State of File Migration Journaling
FILES
/opt/Rainfinity/filemanagement/log/deleteorphan.log
Log file for all orphan deletion attempts using Orphan Management
/opt/Rainfinity/filemanagement/log/recall.log
Log file for NetApp file recall attempts by CTA
/opt/Rainfinity/filemanagement/log/stubrecovery.log
Log file for all stub file recreation attempts using Stub recovery
/opt/Rainfinity/filemanagement/log/stubscanner.log
Log file for stub files detected on primary storage by the stub scanner
/opt/rainfinity/filemanagement/log/filemanagement.log
Status log for CTA and FPolicyCallback processes
EXAMPLES
* To define a non-recurring CIFS stub scanner task scheduled to start 10/10/2006 at
12:00PM:
rffm addTask --Source=//server/share --Schedule=once:2006-10-10@12:00
--Type=stubscanner
* To define a recurring NFS stub scanner task scheduled to run every week on Mon-
day at 12:00PM:
rffm addTask --Source=server:/export --Schedule=1-week:Mon@12:00
--Type=stubscanner
* To define a recurring CIFS archiving task with policy largefiles scheduled to run
every 2 months on the 1st at 12:00PM:
rffm addTask --Source=//server/share --Schedule=2-months:01@12:00
--Type=archiver --Policy=largefiles
* To return all disabled stub scanner tasks:
rffm getTasks --Enable=0 --Type=stubscanner
* To return all orphan files within //server/share that have been missing for 90 days
and have expired retention:
rffm orphanList --expiredretention --missing=90 --ShareName=//share server
* To create a new NAS repository using the CIFS share //server/share with a maxi-
mum disk usage of 75%:
rffm addNASRepository --Source=//server/share --MaxDiskUsagePercent=75
* To authenticate a NetApp server’s credentials:
rffm authServer NetAppsvr1
* To authenticate an ATMOS server’s credentials:
rffm authServer atmossvr1
* To authenticate a Celerra server’s filemover credentials when Celerra Control Sta-
tionIP is empty:
rffm authServer --primary-source=/fs1 --nas-repository="Repository at
server:/export1" celerra55
* To authenticate a Celerra server’s CCD and ACD credentials (any DART version):
rffm authServer --primary-source=/fs1 --centera-target=centera1 --cloud-tar-
get=atmossvr1 celerra55
* To add an import provider with (1) the default system user (provider name
becomes the system user name) and (2) a different system user
(1) rffm addImportProvider kazeon password
(2) rffm addImportProvider --username=usrkazeon kazeon password
* To add an import xml file (1) in the foreground and (2) in the background - the
GUI behavior
(1) rffm importFromXmlFile /home/user/xml/import_file_1.xml
(2) rffm importFromXmlFile --background /home/user/xml/import_file_1.xml
* To get view the import file history of all files by provider
rffm getImportFileHistory --ProviderName=kazeon
* To get the pending imported files on the NFS share bball-ns702a:/intel for the task
name kazeon-task
rffm getPendingImportedFiles --FileServer=bball-ns702a --Export=/intel
kazeon-task
* To add a File Migration task
rffm addTask --Source=//CIFSGORILLA1/fs1/dir1 --Destination=//CIFSGO-
RILLA1/fs2/dir2 --Type=filemigration --Policy=file_migration_policy --SID-
TranslationFile=sidfile --NetworkBandwidth=1000 --Schedule=now
* To add a SID Translation File
rffm addSIDTranslationFile --SIDFilePath=/var/dir1/sidfile
COPYRIGHT
Copyright EMC, 2006-2008
AUTHOR
EMC
1-800-SVC-EMC
http://powerlink.emc.com
SEE ALSO
rffm(1), rfpolicy(1), fmsupportdump(1), rssystat(1)
NAME
Policy Document Syntax for EMC Cloud Tiering Appliance
VERSION
Version 7.x 2009-2010
OVERVIEW
This document describes the syntax of the policy definitions as they are stored and processed internally by
the EMC CTA application. When a policy is defined through the CTA graphical user interface (GUI), a
policy document of the format described here is generated and stored for use. The CTA CLI (rffm com-
mand) does not currently provide a way to create or edit policies. For a quick start, jump ahead to the
EXAMPLES.
The policy definition language was designed with simplicity in mind. Most of the constructs are borrowed
from other languages and basic familiarity with, say, shell scripting will go a long way. Some of the overar-
ching language properties are:
* Whitespace (spaces, tabs and newline characters) is ignored and does not affect the semantics of any
statement unless it appears inside a string literal or needed to separate adjacent tokens.
* Keywords are case-insensitive but identifiers are case-sensitive. This means the statement
is equivalent to
* The body of the document is assumed to be UTF-8 encoded text. However, non-ASCII characters are
not generally recognized outside of string literals.
DOCUMENT TYPES
There are two distinct types of documents that can be written in this language, end policies (or just policies)
and the global symbols document. The two differ in the types of statements that they may contain, however,
both types obey the same basic syntax.
End Policies
For the most part, this document type is the one that you will need to be concerned with. A document of
this type defines a “policy” as it is known throughout the rest of the product. A document is considered to
be an end policy document if the following are true:
* There is at least one action definition
* There are no file matching expression definitions
The Global Symbols Document
There are two documents of type and they define what are refered to as “file matching expressions” and
“action definition” in the GUI. To change any of these definitions you must export the symbols document
with the rffm exportSymbols command, editing the resulting document and reimport it with the rffm
importSymbols command (see rffm(1) for details). The following must be true for the global symbols
document:
* The document may not have any rules.
These restrictions may loosen in future releases.
COMMENTS
Comments in the policy document begin with a pound sign (#) and extend to the end of the line. Any text
may safely appear in a comment and will be ignored by the policy document parser.
STRING LITERALS
There are several places in a policy document where arbitrary string values may appear, on the righthand
side of a filename primary expression being the most common. Like many other languages, a string literal
is a sequence of characters enclosed in double quotes (ASCII 34). Also, as is typical in other languages,
several escape sequences are recognized to represent special characters in the string:
\n A UNIX newline character (ASCII 10)
\t A horizontal tab character (ASCII 9)
\’ A single quote character (ASCII 39)
\" A double quote character (ASCII 34)
\\ A backslash character (ASCII 92)
Putting a bare backslash in front of any character other than those described above is considered a parse
error and will cause the policy import to fail. Otherwise, string literals may contain arbitrary UTF-8 char-
acters.
IDENTIFIERS
Certain values can be bound to identifiers using definition statements. Unlike keywords identifiers are
always treated case-sensitively. Unquoted identifiers may contain any sequence of alphanumeric charac-
ters, periods (.), hyphens (-) and underscores (_) but must begin with a non-numeric character. In order to
include any characters beyond those mentioned here an identifier must be “quoted”. A quoted identifier is a
string literal. An unquoted and a quoted identifier that contain the exact same characters are the same iden-
tifier and may be used interchangeably,
However, the quoted form gives you the flexibility to, say, embed spaces or use non-ASCII UTF-8 charac-
ters in the identifier,
There are two legal types: file_expr and action. File matching expression definitions (file_expr) may only
appear in the global symbols document. See DOCUMENT TYPES for more information. What consti-
tutes a legal identifier and value depends upon type.
(The brackets around the clauses indicate that it is optional and they should not appear literally in the
document.) Currently, there are two kinds of action, archive and delete action; and it could be more in
future. The target is a string literal and must be the name of a Centera cluster, Atmos, NAS Reposi-
tory, and NAS group as it has been configured with the CTA application. See rffm(1) for details. The
try and then is for recursive action definition, and the action expression is the value of another action
defintion. The referenced identifier is the name of action defintion in global symbols document, which
accepts archive action definition only in global symbols document now, and the identifier name in
global symbols document does not limited to start from “my_action”, see more in the References sec-
tion below. The delay_stub clause, if provided, specifies the minimum number of days to delay stub
the files archived by this action. The delay stub time allows the Centera Replication to safely backup
the files before converting the archived files into stub files. The retention clause, if provided, specifies
the minimum retention time to be given to any files archived by this action. The stub_retention clause
is to set stub file on Celerra under retention or not. The policy_type clause specifies the type of policy,
it could be “archive”, “multi_tier” and “multi_tier_stub” for archive action, “delete_stubs” and
“delete_orphans“ for delete action. The delete_all clause is to decide to delete stub file under retention
or not, it is for “delete_stubs” type. The days_missing clause specifies the missing days for orphan
file, it is for “delete_orphans“ type. For details about the clauses syntax, see the age values in the
Rules section below.
Rules
Rules form the bulk of an end policy document. Rule evaluation proceeds as a filter against files. For each
file, the rules are evaluated in the order in which they appear in the document. The first rule whose expres-
sion matches the file takes effect and the rest of the rules are ignored for that particular file. In this way
complex archiving policies can be constructed by designing rules to archive files with specific traits and
proceeding them with other rules designed to catch and filter out the exceptions. Any file that is not
matched by any rule is left untouched. See the EXAMPLES section.
A rule has the general form
It should be emphasized that this is NOT a looping construct despite syntactic similarity to loops in other
languages.
Expressions
An expression may appear in a rule or in a file matching expression definition. Each expression con-
sists of a sequence of pieces logically “anded” together,
The operator && may be used interchangeably with the and operator. Each piece can be either a file
matching primative or a reference to an expression defined in the global symbols document.
Primatives
All primatives have the form
Size Values
The size attribute takes values that consist of a non-negative integer followed by a size unit.
NOTE: It is very important that the number and unit are separated by some whitespace. “7kilo-
bytes” is not a valid size value; “7 kilobytes” is. The size units are standard (base 1024) prefixes
on the keyword byte. As with all other keywords, case is ignored. Furthermore, several varia-
tions are accepted for each keyword:
Unit Acceptable alternatives
bytes byte, b
kilobytes kilobyte, kb, k
megabytes megabyte, mb, m
gigabytes gigabyte, gb, g
terabytes terabyte, tb, t
Age Values
The last_accessed and last_modified primatives and the retention clauses (see Action defini-
tions) take values that consist of a non-negative integer followed by an age unit. NOTE: It is
very important that the number and unit are separated by some whitspace. “7years” is not a valid
size value; “7 years” is. The legal units are:
Unit Acceptable alternatives
seconds second, secs, sec, s
minutes minute, mins, min
hours hour, hrs, hr, h
days day, d
weeks week, wks, wk
months month, mos, mo
years year, yrs, yr, y
One note about the months unit. A month is considered to be exactly 1/12th of a year (specifi-
cally, 2629744 seconds). No attempt is made to compensate for the varying number of days in
each month of the Gregorian calendar.
References
In addition to primatives, a piece may consist of a reference to a file matching expression that has
been bound to an identifier using a file matching expression definition statement in the global
symbols document (see Definitions and DOCUMENT TYPES above). A reference has the
form
$identifier
where identifier follows the same rules as outlined in IDENTIFIERS. In particular, identifier
may be quoted or unquoted as necessary. identifier must have been defined by a definition state-
ment prior to this point in the document. For rules containing references, this is trivially accom-
plished since all rules must come after all definitions. For file matching expression definitions
containing references, this implies that the definition may not create any explicit or implicit self-
references.
Actions
In a rule, only two values are legal for action: the no-op action, nothing, and a reference to the action
bound to “my_action#”.
nothing A file that matches a rule with this action is left alone (no more rules are evaluated) and
the next file is processed.
$my_action# A file that matches a rule with this action is archived according to the parameters speci-
fied in the action definition statement for “my_action#”.
EXAMPLES
First, here’s a sample global symbols document:
NAME
fmsupportdump - EMC CTA Support Diagnostic Command-line Tool
VERSION
Version 7.x 2009-2010
USAGE
fmsupportdump [-h] [-v] [-b] [-nosys] [-capture-binaries] [-mail <address>]
DESCRIPTION
fmsupportdump is the command line tool that is used to gather data for support and diagnostic purposes.
It gathers a complete view of the EMC CTA installation including configuration and running state, operat-
ing system CPU/memory/network state, and all log and diagnostic files. It also proactively seeks problems
that might otherwise be missed and alerts IT support. This greatly accelerates the support process by avoid-
ing repeated requests for information. In most cases the support dump is the only piece of information that
will be requested.
OPTIONS
[-h] Show basic help.
[-v] Show version number.
[-b] Be brief. Do not package up log or other files.
[-nosys]
Skip OS and system checks
[-capture-binaries]
Capture binary and cores.
[-mail <address>]
Send support dump output as e-mail to <address>. This option requires sendmail to be running. To
start sendmail, enter the command: /etc/init.d/sendmail start
COPYRIGHT
Copyright EMC, 2007
AUTHOR
EMC
1-800-SVC-EMC
http://powerlink.emc.com
SEE ALSO
rffm(1), rfpolicy(1), fmsupportdump(1), rssystat(1)
fmsupportdump 7.x 1
RSSYSTAT(1) RSSYSTAT(1)
NAME
rssystat - EMC Cloud Tiering Appliance
VERSION
Version 7.x 2009-2010
USAGE
rssystat [-h] [-v]
rssystat [command [options]]
DESCRIPTION
rssystat is used to provide information on the running system. This includes both live monitoring and his-
torical system load. The historical information is sampled periodically by a running daemon called rssys-
tatd. Historical information is recorded in /var/log/rainfinity/histogram. rssystat is a user interface to this
information. rssystatd, the daemon, is not run by the user, but is started and stopped as part of the normal
CTA init scripts.
rssystat can be used on it’s own for live network monitoring, or as a front-end to the historical information
gathered by rssystatd. It can give information on the log files gathered, extract and average information
from the log files, and control various aspects of the running rssystatd process.
This facility is largely focused on the historical gathering of load information. In addition to being of gen-
eral interest, this historical load information can be used by users, engineers, and support in diagnosing
load-related problems. This information is also gathered by the fmsupportdump tool, when run.
OPTIONS
[-h] Show basic help.
[-v] Show version.
rssystat 7.x 1
RSSYSTAT(1) RSSYSTAT(1)
-list List all log files available in /var/log/rainfinity/histogram. The names as given here are the names
used later when an option <file.log> is required. These logs are rotated monthly, and the backups
are not listed with this command. However, you can use the rotated file name (such as sys1.log.1)
in any of the processing commands below, if you wish to analyze older logs.
-info <file.log>
Show column field information for the given log file. This output describes and numbers each col-
umn in the file, which can be used later by -cols and -avg to specify the columns in which you are
interested.
-d <logfile_dir>
Work on log files in the given directory. This would be used for analysing data offline, using a col-
lection of log files most likely collected by an rssupportdump.
rssystat 7.x 2
RSSYSTAT(1) RSSYSTAT(1)
-ctl show
Show current rssystatd daemon runtime options.
-ctl reset
Reset any rssystatd daemon runtime options to system defaults.
-ctl clearlogs
Clear ALL logs in /var/log/rainfinity/histogram. You will be prompted for confirmation before this
proceeds.
EXAMPLES
Watch network activity on all interfaces:
rssystat -net -a
Get a report on system activity for the given time range and the current day:
Get a report on network activity for eth2 and eth 3, for the given time range and the current day:
Get a process for the archiver, for the given time range and the current day:
rssystat -list
Extract date, time, cpu, cpu0, and cpu1 columns for the given date and time range:
Extract average cpu, cpu0, and cpu1 columns for the given time range and the current day:
rssystat 7.x 3
RSSYSTAT(1) RSSYSTAT(1)
Average eth2 rx_Bps, rx_pps, rx_err, txBps, tx_pps, and tx_err columns for the given date and time range:
rssystat -avg eth2.log 4-8 -from 2004-06-04 00:00:00 -to 2004-06-05 00:00:00
FILES
/opt/rainfinity/conf/histogram.cfg
Optional config file for controlling rssystatd.
/var/log/rainfinity/histogram
Directory containing rssystatd log files.
/var/log/rainfinity/histogram/sys1.log
Main system log file. This contains information on CPU usage, memory, and other items. This is the
main file in which users will be interested.
/var/log/rainfinity/histogram/eth*.log
Per-interface log files. All interface statistics for an interface can be found here.
/var/log/rainfinity/histogram/proc_*.log
Per-process log files. This includes statistics for each monitored process, including fmd, fcd, and
rfwalker as archiver, datacollector, and stubscanner.
/var/log/rainfinity/histogram/rssystatd.std
Any standard output/error from rssystatd. Use this to diagnose runtime problems with rssystatd. This
file will typically be empty.
COPYRIGHT
Copyright EMC, 2007
AUTHOR
EMC
1-800-SVC-EMC
http://powerlink.emc.com
SEE ALSO
rffm(1), rfpolicy(1), fmsupportdump(1), rssystat(1)
rssystat 7.x 4
RFNET(1) RFNET(1)
NAME
rfnet - EMC Cloud Tiering Appliance Network Configuration Command-line Tool
VERSION
Version 7.2.x 2009-2010
USAGE
rfnet [-h] <command>
Commands
show [-]
show <interfacename>
show <firstname>-[lastname]
mtu [-]
mtu <interfacename>
mtu <firstname>-[lastname]
mtu - <mtu>
mtu <interfacename> <mtu>
mtu <firstname>-[lastname] <mtu>
hostname
hostname <hostname>
domain
domain <domain>
dns
dns <dns>
delete dns <dns>
duplex [-]
duplex - <Full/Half>
duplex <interfacename>
duplex <interfacename> <Full/Half>
duplex <firstname>-[lastname]
duplex <firstname>-[lastname] <Full/Half>
rfnet 7.x 1
RFNET(1) RFNET(1)
loadEths
bond <bondname> slaves <interfacename> mode <mode> ip <ip> netmask <netmask> gw <gateway>
bond <bondname> slaves <interfacename> mode <mode>
route
route add <gateway> <interfacename>
route del <gateway> <interfacename>
route add net <ipaddr> <netmask> dev <interfacename>
route del net <ipaddr> <netmask> dev <interfacename>
route add host <ipaddr> dev <interfacename>
route del host <ipaddr> dev <interfacename>
route default gw
route add default gw <gateway>
route del default gw <gateway>
DESCRIPTION
rfnet is used to configure network.
OPTIONS
[-h] Show basic help.
COMMANDS
show [-]
Show the configuration of all interfaces
show <interfacename>
Show the configuration of one interface
show <firstname>-[lastname]
Show the configuration of the interfaces which belong to the range
mtu <interfacename>
Show the mtu of one interface
mtu <firstname>-[lastname]
Show the mtu of the interfaces which belong to the range
mtu - <mtu>
set mtu for all interfaces
rfnet 7.x 2
RFNET(1) RFNET(1)
hostname
show hostname
hostname <hostname>
configure the hostname
domain
show domain
domain <domain>
configure the domain
dns <dns>
configure the dns
duplex [-]
show duplex of all physical or VLAN interfaces
duplex - <Half/Full>
configure duplex for all physical or VLAN interface
duplex <interfacename>
show duplex of one interface
duplex <firstname>-[lastname]
show duplex of the interfaces whose name is in the range from firstname (to lastname)
rfnet 7.x 3
RFNET(1) RFNET(1)
delete <firstname>-<lastname>
delete multiple vlans
loadEths
load all the physical interface info into rain.xml
bond <bondname> slaves <interfacename> mode <mode> ip <ip> netmask <netmask> gw <gateway>
add/modify one bond
route default gw
show default gateway
rfnet 7.x 4
RFNET(1) RFNET(1)
EXAMPLES
Show the configuration of one interface:
COPYRIGHT
Copyright EMC, 2008
AUTHOR
EMC
1-800-SVC-4EMC
http://powerlink.emc.com
SEE ALSO
rffm(1), rfpolicy(1), fmsupportdump(1), rssystat(1)
rfnet 7.x 5
RSLOG(1) RSLOG(1)
NAME
rslog - Manage logging configuration
VERSION
Version 7.4.x 2010-2011
USAGE
rslog [-h]
rslog [-f] [-n] <command>
Commands
config
addoutput <type> <dest> [ <key> ] [ --filter <type> <value> ... ] [ --supression <type> <length> ]
deleteoutput <type> <dest>
enableoutput <type> <dest>
disableoutput <type> <dest>
DESCRIPTION
rslog is used to manage logging configuration.
OPTIONS
[-h] Show basic help.
COMMANDS
config Show logging configuration
addoutput <type> <dest> [ <key> ] [ --filter <type> <value> ... ] [ --supression <type> <length> ]
Add or change an output Multiple filters and an optional supression may be specified.
rslog 7.x 1
RSLOG(1) RSLOG(1)
Note: Clearing logging levels does not immediately set that logging level back
to the default level. It only removes it from the configuration so that the
next time the relevant program is run, it will not have this logging level
configured. Similarly, changes to logging configuration will not take effect
until the FMD daemon is not running.
COPYRIGHT
Copyright EMC, 2009
AUTHOR
EMC
1-800-SVC-4EMC
http://powerlink.emc.com
SEE ALSO
rffm(1), rfpolicy(1), fmsupportdump(1), rssystat(1)
rslog 7.x 2