DESCRIPTIONrffm is used to configure and manage the features and functionality available within EMC Cloud TieringAppliance.
rffm can be used to add, edit and delete file servers configured in Cloud Tiering Appliance. These fileservers contain the servers in the primary and secondary storage tiers, specifically NetApp, Celerra, Centera
EMC CTA 9.0.x 3
heffem2
Text Box
RFFM(1) RFFM(1)
and ATMOS. For CTA/VE, only the Celerra and Centera server types are supported. When configuring aNetApp file server, Cloud Tiering Appliance will automatically register with NetApps Fpolicy, using the IPaddress 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 availabilityfor recalling files.When configuring a Celerra file server, secondary connections must be created manuallyon the Celerra DART 5.5. The secondary connections can be created automatically for DART 5.6 and aboveby 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 IPaddresses 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 ATMOSuser ID (uid) and shared secret must be provided. To archive to another NAS platform, the target servermust 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 expiredretention 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 beenconfigured 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 providesreporting for each archiving task run as well as a summary of the total data archived and space saved pershare/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. Thearchiver 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 andreplaced by stub files. The stub file written to the primary storage contains all necessary metadata to recallthe data from secondary storage and write back the primary tier. The multi-tier task is similar to archivetask with the difference that it operates on stubs in addition to normal files. If the stub matches the policycriteria 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 performthe file deletion from the secondary storage. The delete stub task selects files with expired retention fromthe database and utilizes FileWalker to perform the stub deletion and the associated file on the secondarystorage.
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 inascending 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 manuallyscheduled. It scans the source share/export looking for stub files and updates the stub timestamp in the localdatabase. Orphanmanagement 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 daysthe file is considered orphan. Stub recovery can be used to recreate stubs for archived files that weredeleted from the primary storage tier as well as provide versioning for archived files.
TERMINOLOGY
EMC CTA 9.0.x 4
heffem2
Text Box
RFFM(1) RFFM(1)
Stub fileA small file created by an archiving application that references data on secondary storage.
OrphanA file that has been archived to secondary storage but does not have a corresponding stub file onthe primary storage.
PolicyCollection of one or more file matching criteria, a secondary storage destinations, data retentionperiod and policy type.
TaskA definition of a source dataset, a recurring or non-recurring schedule, and a task type.
NAS RepositoryA share/export on a Celerra, NetApp, Isilon, Windows (CIFS) or DataDomain (NFS) file serverthat can be used as an archiving destination.A NAS repository is defined with a maximum diskusage percentage.
NAS GroupA NAS Group is a collection of NAS repositories used for archiving or multi-tier tasks. The taskwill archive to the first repository in the NAS group until is reaches the specified maximum diskusage 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.
--verboseShow extra information.
--veryverboseShow a lot of extra information
--usage
COMMANDSrffm supports the following commands.Individual commands may have their own set of supportedoptions. Any such options are described below each command.
Add a recurring or non recurring task for archiving., multitier, delete tasks, or filemigration tasksor 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 startimmediately, start at some time in the future, or repeat at a particular interval.
EMC CTA 9.0.x 5
heffem2
Text Box
RFFM(1) RFFM(1)
--Type=importarchi ve|stubscanner|backup|repositorymigration|filemigrationTask type. For non-importarchive policy tasks there is no need to give this option as--Policy has a task type associated with it. Specifyfilemigration type only for Windowsas migration source.
--Policy=POLICYDefine 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. Specifyfilemigration in the --Type field. No need to specify--Type if this option is specified, but for animportarchi ve task--Type is a must.
--Schedule=SCHEDULEScheduling option associated with the task. The scheduling options are
* For a run-now task,--Schedule=now
* For a simulation run task,--Schedule=simulation:SIMULATIONTYPEExample: --Schedule=simulation:detailed, --Schedule=simulation:summary
* For a run-once task,--Schedule=once:DATE@TIMEExample: --Schedule=once:2012-07-25@18:45
* For a recursive daily task,--Schedule=daily@TIMEExample: --Schedule=daily@22:30
* For a recursive weekly task,--Schedule=x-weeks:DAY OFWEEK@TIMEwhere, x can be from 1 to 4 (weeks), DAY OFWEEK must be Mon, Tue, Wed, Thu, Fri,
Sat, Sun.Example: --Schedule=weekly:Mon@11:00 or --Schedule=1-week:Mon@11:00,
--Schedule=3-weeks:Sun@06:30
* For a recursive monthly task,--Schedule=y-months:DAY OFMONTH@TIMEwhere, y can be 1 to 12 (months), DAY OFMONTH must be from 1 to 31Example: --Schedule=monthly:10@23:15 or --Schedule=1-month:10@23:15, --Sched-
ule=4-months:07@01:30
* For capacity-based archive task, --Schedule=archive@ARCHIVETHRESH-OLD%[:warning@WARNINGTHRESHOLD]%Example: --Schedule=archive@90%, --Schedule=archive@85%:warning@75%
* For a run-on-import importarchive task,--Schedule=onimport
--Source=SOURCEFull UNC path to the data set the task will be run against. Enteredin the format: //server-name/sharename/dirname or \servername\sharename\dirname for CIFS shares and server-name:/exportname/dirname for NFS export. For a repositorymigration task this will be aNAS repository or a Centera or Cloud (Atmos, Amazon S3). Source should not be speci-fied for a backup task.
--force Force adding the task without asking a confirmation question. Valid for deleteorphan anddeletestub tasks. Has no effect for other types of tasks.
--MoveOrphanFiles=yes|noTo force or not to force moving orphan files for repository migration. If omitted thedefault value isno
EMC CTA 9.0.x 6
heffem2
Text Box
RFFM(1) RFFM(1)
--Compression=yes|noOptional. Cloud destination option for repository migration. If omitted the default valueis ’no’. If specified, option is applied on data that is not currently compressed.
--Encryption=yes|noOptional. Cloud destination option for repository migration. If omitted the default valueis ’no’. If specified, option is applied on data that is not currently encrypted.
--Destination=DESTINATIONDestination 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=DESTINATIONTYPEOptional. DestinationType for repositorymigration task. Valid values arecentera, Cloud(Atmos, Amazon S3)andnas. If omitted it will automatically detect from --Destination.
--ProviderName=PROVIDERNAMEProvider Name configured on the CTA. Valid only forimportarchi ve task.
--TaskName=TASKNAMEUnique name of the task (case in-sensitive). Valid only for importarchi ve task.
--DelayPeriod=DELAYPERIODDelay 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=NETWORKBANDWIDTHThe total network bandwidth for the FileMigration task in MB/s. The default is 0(unbounded)
--RecursiveFileThreshold=RECURSIVEFILETHRESHOLDRecursive File Threshold value for automatic recursive file migration. Indicates totalnumber of files. After a file migration task is completed if the total number of filesmigrated is more than the file threshold value the task is spawned again. This step isrepeated until the total files migrated becomes less than the file threshold. A value of zerodisables recursive file migration. If this option is specified only run-now or run-oncescheduling option is made available.
--SIDTranslationFile=SIDTRANSLATIONFILEThe 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 filesrun rffm listSIDTranslationFiles
Return the submitted tasks matching the type and enabled criteria, or return a specific task basedon the task ID. Note that the --Enable option and --TaskID can be provided to optionally filter theresults, --Type is a required parameter. Specifying --TaskID and --Enable will only return thespecified 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|1Return disabled or enabled tasks.
[--Format=list|detail]Display format of the tasks. If it is not provided the default value islist if --TaskID is notspecified (or)detail if --TaskID is specified. The user can change this default behavior byforcefully setting the other format.
EMC CTA 9.0.x 7
heffem2
Text Box
RFFM(1) RFFM(1)
* list displays the task information in one line for each task.* detail displays all the details of the task in multiple lines.
--TaskID=TASKIDIf specified, only that TASKID’s information is displayed. Alternatively the user can use--TaskName=TASKNAME
--TaskName=TASKNAMEIf specified, only that task name’s information is displayed. Alternatively the user can use--TaskID=TASKID
Delete specified task.Only tasks which have not executed successfully can be deleted. Use therffm getTaskProgress command to verify whether the task has run successfully at least once.Oncethe command has been run once successfully it can only be disabled using therffm enableTaskcommand.
Return the progress results of a submitted task.To get the task results from a previous date, thestart 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 bereturned.
--EndDate=ENDDATEYYYY-MM-DD format for the timestamp when the task completed.
--StartDate=STARTDATEYYYY-MM-DD format for the timestamp when the task started.
--TaskID=TASKIDTaskID for which the action is requested. Alternatively the user can use--TaskName=TASKNAME
--TaskName=TASKNAMETask name for which the action is requested. Alternatively the user can use--TaskID=TASKID
EMC CTA 9.0.x 8
heffem2
Text Box
RFFM(1) RFFM(1)
stopTask [--Queue=all|active|pending] [--TaskID=TASKID] [--TaskName=TASKNAME]Abort running task by TaskID or Task Queue type.Any remaining progress for the tasks will bediscarded and the effects of the task will not be rolled back.
--Queue=all|active|pendingTask queue type. If this is specified all the tasks in the specified queue is stopped.
--TaskID=TASKIDTaskID that needs to be stopped. This TaskID must be running. Alternatively the user canuse--TaskName=TASKNAME
--TaskName=TASKNAMETask name for that needs to be stopped. This task must be running. Alternatively the usercan use--TaskID=TASKID
Start a submitted task immediately. The --Simulation argument allows you to run the task as asimulation. Usingthis 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 additionaltimes concurrently. This will typically not have any adverse effect on the dataset unless files havebeen recalled between tasks causing multiple archiving events.
Edit the existing schedule for a submitted task. Use therffm getTasks TaskID=TASKID com-mand to get the current schedule configuration. The StartTime field cannot be set to now, only atime in the future.To hav ea scheduled task run immediately use therffm runT askNow com-mand.
--TaskID=TASKIDTaskID for which the action is requested. Alternatively the user can use--TaskName=TASKNAME
--TaskName=TASKNAMETask name for which the action is requested. Alternatively the user can use--TaskID=TASKID
--Schedule=SCHEDULEScheduling option associated with the task. The scheduling options are
* For a run-now task,--Schedule=now
* For a simulation run task,--Schedule=simulation:SIMULATIONTYPEExample: --Schedule=simulation:detailed, --Schedule=simulation:summary
* For a run-once task,--Schedule=once:DATE@TIMEExample: --Schedule=once:2012-07-25@18:45
* For a recursive daily task,--Schedule=daily@TIMEExample: --Schedule=daily@22:30
* For a recursive weekly task,--Schedule=x-weeks:DAY OFWEEK@TIMEwhere, x can be from 1 to 4 (weeks), DAY OFWEEK must be Mon, Tue, Wed, Thu, Fri,
Sat, Sun.
EMC CTA 9.0.x 9
heffem2
Text Box
RFFM(1) RFFM(1)
Example: --Schedule=weekly:Mon@11:00 or --Schedule=1-week:Mon@11:00,--Schedule=3-weeks:Sun@06:30
* For a recursive monthly task,--Schedule=y-months:DAY OFMONTH@TIMEwhere, y can be 1 to 12 (months), DAY OFMONTH must be from 1 to 31Example: --Schedule=monthly:10@23:15 or --Schedule=1-month:10@23:15, --Sched-
ule=4-months:07@01:30
* For capacity-based archive task, --Schedule=archive@ARCHIVETHRESH-OLD%[:warning@WARNINGTHRESHOLD]%Example: --Schedule=archive@90%, --Schedule=archive@85%:warning@75%
* For a run-on-import importarchive task,--Schedule=onimport
--Policy=POLICYChange the policy assiciated with animportarchi ve task only. This option cannot beused with any other task type.
--RecursiveFileThreshold=RECURSIVEFILETHRESHOLDRecursive File Threshold value for automatic recursive file migration. Indicates totalnumber of files. After a file migration task is completed if the total number of filesmigrated is more than the file threshold value the task is spawned again. This step isrepeated until the total files migrated becomes less than the file threshold. A value of zerodisables recursive file migration. If this option is specified only run-now or run-oncescheduling option is made available.
Used to configure or retrieve the backup settings. The backup settings are stored in the rain.xmland this configuration is used to do backup when a backup task is scheduled.
--action=get|setAction to be performed. Valid actions are* set is used for setting the backup settings. Used as both add and edit. When runningthis command for the first time after installation, it works as add. Running it after the firstsuccessful --action=set, it works as edit.* getdisplays the backup settings.
--Destination=DESTINATIONA configured Centera Name or a NAS Destination Name. Runrffm listN ASRepositoriesto view all the NAS repositories.rffm listServers lists all the servers from which a Cen-tera can be selected.
--DestinationType=nas|centeraRepresents the type of destination.
--DRDestination=DRDESTINATIONDisaster Recovery NAS Destination Server Name. Currently supports an already config-ured Celerraand NetApp servers only. rffm listServers lists all the servers from which aCelerra or NetApp can be selected.
--DRStartDir=DRSTARTDIRDisaster Recovery Start Directory relative to DRDESTINATION . Must be an NFS path.To find the list of NFS exports runrffm getFileSystems --Protocol=nfs DRDESTINA-TION . Note: The cli checks only the export name and not the entire path. (If /fs1 is avalid export and if you specify /fs1/subfolder1/subfolder2, the cli checks only for /fs1.
EMC CTA 9.0.x 10
heffem2
Text Box
RFFM(1) RFFM(1)
The user must ensure subfolder1/subfolder2 exists under /fs1)
--NoOfBackups=NOOFBACKUPSThe Number of Backups to be saved. Valid values are from 5 to 15. If this parameter isomitted at the time of setting for the first time it defaults to 5.
Examples:1) While setting it for the first time after installation of CTA, all but --NoOfBackups aremandatory.
rffm backupSettings --action=set --Destination=’Repository at cifsgorilla1:/fs1’--DestinationType=nas --DRDestination=cifsgorilla1 --DRStartDir=/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:
rffm backupSettings --action=set --NoOfBackups=8
3) To list the backup settings:rffm backupSettings --action=get
restoreBackup
restoreBackup command is used to restore a Backup file. It will list all the backups available andwill promt the user to enter which file he wants to restore from the list. Once the user gives thefilename, the command will do the restore and will return the location of the restored file to theuser.
getTaskQueue [--Queue=QUEUETYPE] [--Type=TYPE]
Get the tasks in the scheduler’s active and pending queues. Pending queue includes all the run-nowtasks and the task scheduled by the scheduler in the pending queue.
--Queue=all|active|pending|pending-run-now|pending-scheduleThe queue type of interest.
Sets queue size limits of various tasks in the scheduler.
--All=ALLQShortcut for setting the queue size of all the options. Valid values are* default* any value from 1 to 5default sets the daemon’s default value for each of the queue sizes.
EMC CTA 9.0.x 11
heffem2
Text Box
RFFM(1) RFFM(1)
--PendingTasks=PENDINGQMaximum size of the pending queue. Valid values are* default* any value from 1 to 1000default sets the daemon’s default value for this option. This option overrides --All for thesize of pending queue.
--Archi verThreads=ARCHIVERQMaximum number of archiver threads that can run simultaneously. Valid values are* default* any value from 1 to 5default sets the daemon’s default value for this option. This option overrides --All for themaximum number of archiver threads.
--StubScannerThreads=STUBSCANNERQMaximum number of stub scanner threads that can run simultaneously. Valid values are* default* any value from 1 to 5default sets the daemon’s default value for this option. This option overrides --All for themaximum number of stub scanner threads.
Global celerra FileMover settings. The credentials provided here are used for both FileMover andcallback credentials for CCD and ACD.
--action=get|setAction to be performed. Valid actions are* set is used for setting the callback credentials.* getdisplays the callback credentials (masks the password).
--callback-username=CALLBACKUSERNAMEUsername used for filemover and ccd/acd callbacks.
--callback-password=CALLBACKPASSWORDPassword used for filemover and ccd/acd callbacks.
Add a server to the CTA configuration. Theserver can be of type Celerra, NetApp, Centera, Win-dows, DataDomain, Isilon (or) Cloud (Atmos, Amazon S3).A fi le server must be configuredwithin CTA if i t will be used as an archiving source or a NAS repository target. To authenticatewith a NetApp file server, the local administrator credentials must be provided, as well as CIFSspecific 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 witha Celerra file server, CIFS authentication information is required.If the Celerra will be used as asource, the CCD and FileMover credentials are required as well.For archiving and recallingbetween Celerra and Centera, the CCD username and password are required for authentication touse the secondary HTTP connection configured on Celerra.If there are any errors in the CIFS orFileMover authentication, no error will be reported until an archiving task is run and reports anerror. If a PEA file or profile username and password are needed for Centera authentication butnone is specified no error will be reported until an archive task attempts to write to the Centera andis unsuccessful. Isilon file server supports both NFS and CIFS, but providing CIFS credentials isoptional.
--acd-dnsname=ACDDNSNAMEThe Fully Qualified DNS name for the Cloud callback daemon that is used in the HTTPconnection for recalling from Cloud (Atmos, Amazon S3) to Celerra or VNX.Ex: If thesecondary connection uses the HTTP path, http://acd.domain.prv to resolve the Cloudcallback daemon, acd.domain.prv should be entered here.
--ccd-dnsname=CCDDNSNAMEThe Fully Qualified DNS name for the Celerra callback daemon that is used in the HTTPconnection 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=CTRLSTATIONIPIP address of the control station for Celerra/VNX/VNXe. Required for DART version >=5.6. Not required for DART version <= 5.5
--DNSName=DNSNAMEDNS Name of ATMOS cloud.
--domainname=DOMAINNetBIOS or FQDN format of the domain that the NetApp belongs to, ex: domain ordomain.prv are both acceptable.
--fqdn=FQDNFully qualified Kerberos domain name. Used instead of --domainname.
--exclude-dir=DIRLISTDirectory(s) that will be excluded from any tasks (except StubScanner, Delete_Stub, andDelete_Orphan) run by CTA. Note that system directories such as .etc, lost+found, willbe ignored by design and do not need to be entered here.
--filemover-username=FILEMOVERUSERNAME
--filemover-password=FILEMOVERPASSWORDCelerra username and password that can be authenticated to use the Filemover API usedfor 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=IPLISTHost machine IP addresses to register with FPolicy as secondary callback daemon(s).Bydesign 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
EMC CTA 9.0.x 13
heffem2
Text Box
RFFM(1) RFFM(1)
user specifies agent IPs as secondary.
--is_source=yes|noSpecify 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=NETAPPPASSWORDThe local NetApp administrator username and password with root privileges forONTAPI.
--username=USERNAME
--password=PASSWORDCIFS administrative username and password.
--profile-username=PROFILEUSERNAME
--profile-password=PROFILEPASSWORDUsername and Passwrod for authentication with a Centera
--pea=PEAPath on the local machine to a PEA (Pool Entry Authorization) file for authenticationwith a Centera
--port=http|https[:PORT]Port for ATMOS cloud: http maps to 80, https to 10080.To override the port append":PORT". For example, to select HTTPS port 443 use "https:443".If not provided thedefault is HTTPS port 10080.
--shared_secret=SHAREDSECRETATMOS shared secret.
--uid=UIDATMOS uid.
--NDMPUsername=NDMPUSERNAMENDMP Username for Celerra
--NDMPPassword=NDMPPASSWORDNDMP Password for Celerra
--NDMPPort=NDMPPORTNDMP Port Number for Celerra. If this argument is not provided or if the argumentvalue is default, it defaults to 10000, otherwise it must be a numberic value between 1and 65536
--URL=AMAZON_BUCKET_URLURL corresponding to the Amazon S3 bucket as displayed in the AWS ManagementConsole.
--access_key_id=AMAZON_ACCESS_KEY_IDThe key that CTA uses to gain REST access to the Amazon S3 bucket. The Amazon S3account manager generates the key.
--secret_access_key=AMAZON_SECRET_ACCESS_KEYThe secret credential used with the Access Key ID. The Secret Access Key is generatedwith the Access Key ID.
--bucketname=AMAZON_BUCKET_NAMEThe Amazon S3 bucket destination where CTA adds, deletes, or edits objects. The Ama-zon S3 account manager configures the Amazon S3 bucket.
EMC CTA 9.0.x 14
heffem2
Text Box
RFFM(1) RFFM(1)
--vfiler-host-ip=VFILERHOSTIPIf the file server is a NetApp vfiler, the IP address of the host filer must be specified withthis field.
--is_vdm=yes|noIf the file server is a Celerra VDM, the flag needs to be specified, and CIFS only can besupported.
NAMENetBIOS name for Celerra and NetApp file servers. Logicalname for Centera servers.
Edit an existing server, other than a Centera, in the CTA configuration. Any changes made to theexisting NetApp authentication information will not trigger an error to be generated if a mistake ismade. However authentication errors will be printed to the debug log when CTA attempts toreregister with the NetApp after 30 seconds. Changes made to the primary FPolicy IP will not bevalid if the target machine is not running the FPolicy callback daemon. Changes made to theexisting Celerra authentication information will not trigger an error if a mistake is made. How-ev er, 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 onlyway to do it is to delete an existing Centera and create a new one.
--acd-dnsname=ACDDNSNAMEThe Fully Qualified DNS name for the Cloud callback daemon that is used in the HTTPconnection for recalling from Cloud (Atmos, Amazon S3) to Celerra or VNX.Ex: If thesecondary connection uses the HTTP path, http://acd.domain.prv to resolve the Cloudcallback daemon, acd.domain.prv should be entered here.
--ccd-dnsname=CCDDNSNAMEThe DNS name for the Celerra callback daemon that is used in the HTTP connection forrecalling from Centera to Celerra or VNX.Ex: If the secondary connection uses theHTTP path, http://ccd.domain.prvto resolve the Celerra callback daemon,ccd.domain.prv should be entered here.
--control-station-ip=CTRLSTATIONIPIP address of the control station for Celerra/VNX/VNXe. Required for DART version >=5.6. Not required for DART version <= 5.5
--domainname=DOMAINNAMENetBIOS or FQDN format of the domain that the NetApp belongs to, ex: domain ordomain.prv are both acceptable.
EMC CTA 9.0.x 15
heffem2
Text Box
RFFM(1) RFFM(1)
--fqdn=FQDNFully qualified Kerberos domain name. Used instead of --domainname.
--exclude-dir=DIRLISTDirectory(s) that will be excluded from any tasks (except StubScanner, Delete_Stub, andDelete_Orphan) run by CTA. Note that system directories such as .etc, lost+found, willbe ignored by design and do not need to be entered here.
--filemover-username=FILEMOVERUSERNAME
--filemover-password=FILEMOVERPASSWORDCelerra username and password that can be authenticated to use the Filemover API usedfor 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=IPLISTHost machine IP addresses to register with FPolicy as secondary callback daemon(s).Bydesign FPolicy will always try to reach the primary agent for recalls before trying sec-ondary agents.
--is_source=yes|noSpecify whether the file server will be used as a source for archiving. If this is set to no,the file server can onlybe used as a NAS repository.
--netappusername=NETAPPUSERNAME
--netapppassword=NETAPPPASSWORDThe local NetApp administrator username and password with root privileges forONTAPI.
--username=USERNAME
--password=PASSWORDCIFS administrative username and password.
--port=http|https[:PORT]Port for ATMOS cloud. (See description under the addServer command.)
--shared_secret=SHAREDSECRETATMOS shared secret.
--uid=UIDATMOS uid.
--vfiler-host-ip=VFILERHOSTIPIf the file server is a NetApp vfiler, the IP address of the host filer must be specified withthis field.
--NDMPUsername=NDMPUSERNAMENDMP Username for Celerra
--NDMPPassword=NDMPPASSWORDNDMP Password for Celerra
--NDMPPort=NDMPPORTNDMP Port Number for Celerra. For default, it defaults to 10000, otherwise it must be anumberic value between 1 and 65536
--is_vdm=yes|noIf the file server is a Celerra VDM, the flag needs to be specified, and CIFS only can besupported.
NAMENetBIOS name for preconfigured Celerra or NetApp file server.
EMC CTA 9.0.x 16
heffem2
Text Box
RFFM(1) RFFM(1)
deleteServer NAME
Remove the specified server from the CTA configuration. Servers containing NAS repositoriescannot 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 removedfrom the file server. Recall/FPolicy events will not longer be sent to the CTA after running thiscommand, making archived files inaccessible to CIFS and NFS clients.
When this command is run to remove a Celerra, CTA will no longer authorize HTTP recallrequests 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 archiveddata stored on the server. Recall requests sent to the CTA for data stored on the Centera fromNetApp or Celerra file servers will not complete successfully. Once an archiving task has been runto write data to Centera, it should never be removed from the configuration for this reason.Recallcan be restored if the same Centera is added back to the configuration with the same logical name.
Authenticate server credentials. The user the perform authentication on any of the servers availablein rffm listServers. Celerra server configured as as source requires one or more of the followingparameters 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 ifyou want to perform ACD authentication ifSERVERNAME 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 ifSERVERNAME is a Celerra server.
[--nas-repository=NAS-REPOSITORY]Secondary NAS repository name (fromrffm listN ASRepositories). Required for verify-ing filemover authentication ifSERVERNAME is a Celerra server with an empty Cel-erra Control StationIP. Not needed if Celerra Control StationIP is specified for the Celerraor if CENTERA-TARGET or CLOUD-TARGET is specified.
[--primary-source=PRIMAR Y-SOURCE]SERVERNAME ’s export or share of the form /fs1 for an NFS export and \fs1 for a CIFSshare. Required ifSERVERNAME is a Celerra server for performing ACD/CCD authen-tication and for filemover authentication if Celrra Control StationIP is empty.
SERVERNAMEName of the server whose credentials are to be authenticated.
editFpolicyExclusionIP IP [IP ...]
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.
EMC CTA 9.0.x 17
heffem2
Text Box
RFFM(1) RFFM(1)
editFpolicyBlockIP IP [IP ...]
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. Whenthe 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 forthat particular share/export. Enteringa share or export will cause all the files archivedunder that share/export to be displayed. In order to show just the files under a particulardirectory, you must end the path with a directory delimiter. If no stubs are found for aparticular 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 searchesfor 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 islist. The user canchange 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 away the scripts can easily parse them.
UNCPATHUNCPATH is of the form \\SERVER\SHARE[\PATH] or//SERVER/SHARE[/PATH] for CIFS OR SERVER:/EXPORT[//PATH] forNFS. It can also contain path with wildcard characters * or ?.To specify adirectory, 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 directoryor --missing value, only a blank line will be returned.With the --missing option, you canview only the orphans seen longer than DAYSMISSING days ago.However, an orphanwill not be "found" until the stub scanner has been run. Thus, if you delete a stub, itwon’t immediately show up in the orphan file list.You can force the stub scanner to run
EMC CTA 9.0.x 18
heffem2
Text Box
RFFM(1) RFFM(1)
with rffm runTaskNow --TaskID with the task ID of the stub scanner. As long as it hasbeen 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 beshown.
UNCPATHUNCPATH is of the form \\SERVER\SHARE[\PATH] or//SERVER/SHARE[/PATH] for CIFS OR SERVER:/EXPORT[//PATH] forNFS. It can also contain path with wildcard characters * or ?.To specify adirectory, the path must end with a directory delimiter character.
stubRecovery [--makewritable] [--modtime=MODTIME] [--restoreall] UNCP ATH
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 youwould 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 fileslist. 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 atMODTIME
[--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 andthe sub-directory filesFromMarketing in dir0.Note: if you only want to match aparticular directory then add a directory divider at the end of the path, like’.../dir0/filesFromMarketing/’
UNCPATHUNCPATH is of the form \\SERVER\SHARE[\PATH] or//SERVER/SHARE[/PATH] for CIFS OR SERVER:/EXPORT[//PATH] forNFS. It can also contain path with wildcard characters * or ?.To specify adirectory, the path must end with a directory delimiter character.
dxConversion [--CenteraMappingFile=CENTERAMAPPINGFILE] [--Export-Name=EXPORTNAME] [--Shar eName=SHARENAME] [--Simulation=summary] [--Sani-tyTest=FULL_PATH_TO_FILE] SERVER
dxConversion will take a <SERVER> and a <ExportName> or <ShareName> (one ofthese must be specified) and convert all DX NAS stubs to CTA stub files. IMPORTANTNOTE: before running the conversion. The source and destination servers must be
EMC CTA 9.0.x 19
heffem2
Text Box
RFFM(1) RFFM(1)
added to the CTA configuration. It is also important to use the <SanityTest> option totry to convert a file on each destination to verify that you have correctly added all neededdestination servers to the CTA configuration. Ifthere is a network or server failure duringthe 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 DXNAS Conversion will verify that the secondary data file exists on secondary storage.ForCentera secondary data, no modification is done to the Centera Clip or metadata.ForNAS secondary files, the secondary repository file is copied to the CTA repository. If node-duplication was using in the DX NAS repository, then the file is removed from the DXNAS repository after the copy is successful. Ifthe DX NAS repository uses de-dup, therepository file is not deleted and the user is responsible to delete the de-dup repositoryfiles after the conversion is completed.
[--CenteraMappingFile=CENTERAMAPPINGFILE]This file must be specified if archiving to Centera was performed with the DXNAS product. TheFormat is, one Centera server mapping on each line with theDX NAS server Netbios name followed by a colon followed by the Centerainternal 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 onthe Destination tab. i.e. dxserver:centera4 labCenteradxserver: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 beconverted on the file system, but this option must scan the entire file system anddetect the DX stubs so this is not much faster than running the conversion on thefile 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 theshare or export specified.-TP SERVER The net bios name of the Celerra pri-mary server to run the stub conversion against.
deleteOrphan [--deleteall] [--force] [--limit=LIMIT] [--missing=D AYSMISSING] [--noCheck-Primary] [--modtime=MODTIME] UNCP ATH
The deleteOrphan command can delete the file data for a single orphan file or all orphansunder the specified file path. The deleteOrphan command defaults to deleting data fromsecondary 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 thesecondary 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 fileyou would like to delete (when deleting a single orphan). If you have archived multipleinstances of the same file, you can specify which one to delete by its modified time aslisted in the orphan list. The format for <MODTIME> is: "YYYY-MM-DD
EMC CTA 9.0.x 20
heffem2
Text Box
RFFM(1) RFFM(1)
HH:MM:SS".
NOTE:The orphanList command or deleteOrphan --deleteall command use the CTA database tofind orphan files. It is possible that the stub file may have been recreated or copied frombackup tape and exist on the primary storage.If deleteOrphan finds that the primary stubfile exists, it will not delete the data for this file and it will update the CTA database so itis 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; automaticallydeletes all orphan data
[--limit=LIMIT]Only applies to deleteall, LIMIT is the maximum number of orphans that will beprocess (10,000 is the maximum and default)
[--missing=DAYSMISSING]Only applies to deleteall, Only stubs missing for this many days will be removedfrom secondary storage (30 days is the minimum and default)
[--noCheckPrimary]This option will remove orphans without checking to see if the primary stub fileexists. IMPORTANT: This option exists to remove orphan files when theprimary share, export, or even server has be removed from the user envi-ronment. It should not be used normally because it can delete orphan fileswhen the original stub file still exists and create data lose.
[--modtime=MODTIME]Recover a specific version of FILEPATH specified by last modified time atMODTIME
UNCPATHUNCPATH is of the form \\SERVER\SHARE[\PATH] or//SERVER/SHARE[/PATH] for CIFS OR SERVER:/EXPORT[//PATH] forNFS. It can also contain path with wildcard characters * or ?.To specify adirectory 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 usedwhen the archived files limit is exceeded. Itupdates the current number of archived filesincase 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 themback 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 8kon Celerra can be archived by the policy engine. Bydefault this option is disabled, caus-ing files smaller than the minimum block size to be ignored during archiving. Thisoption
EMC CTA 9.0.x 21
heffem2
Text Box
RFFM(1) RFFM(1)
is only available through the CTA command line.
--Enable=0|1Disable or enable the minimum file size override option.
Create a new NAS repository that can be used as an archiving destination.To create anew 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 orSERVER:/EXPORT for NFS exportSERVER is a NetApp or Celerra/VNX/VNXe or DataDomain or Windows orIsilon file server configured in CTASHARE is the name of a CIFS shareEXPORT is the name of an NFS export
[--MaxDiskUsagePercent=DISKUSEPERCENT]Set the maximum disk usage percentage of the NAS repository. The defaultvalue is 90%.CTA will not archive data to a NAS repository which has passedthe specified disk usage.
Remove a NAS repository from the CTA configuration. Deletinga NAS repository willinvalidate 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 deletedrepository. Care should be taken when removing a repository to ensure that recall abilityis not affected.
[--RepositoryName=REPOSITORYNAME]Specify the repository to be deleted.
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 islist if noPOLICYNAME is specified (or)detail if one or morePOLICYNAME isspecified. The user can change this default behavior by forcefully setting theother format.* list displays the policy tasktype and the policy name in one line for each policyin 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 isformatted in such a way the scripts can easily parse them.
[--Type=POLICYTYPE]Filter the output by policy type. Must be one ofall, archive, multi_tier ,multi_tier_stub , delete_stubs, delete_orphans, migrate_file
POLICYNAMEName of the policy as provided at the time of creation. You can get the list of allthe policies by callingrffm listPolicies
version [--daemon]
Display the current version of the CTA software. --daemon can be specified to show theversion of the running daemon.
listServers [--SourceOnly] [--Type=TYPE] [--Format=list|detail] [SERVERNAME ...]Lists all or the specified servers that are currently configured in CTA
[--Format=list|detail]Display format of the servers. If it is not provided the default value islist if noSERVERNAME is specified (or)detail if one or moreSERVERNAME isspecified. The user can change this default behavior by forcefully setting theother format.* list displays the server type and the server name in one line for each server.* detail displays all the details of the server in multiple lines.
--SourceOnlyDisplays only the file servers that are enabled as source.
--Type=TYPEDisplays only the file servers that are of the given type. TYPE can be Celerra,NetApp, Windows, DataDomain, Isilon, Centera, Cloud (Atmos, Amazon S3)
SERVERNAMELogical name of the server as provided at the time of creation. You can get thelist of all the server names by callingrffm listServers
getFileSystems [--Protocol=cifs|nfs] SERVERNAMELists the CIFS/NFS filesystems available on the given server.
EMC CTA 9.0.x 23
heffem2
Text Box
RFFM(1) RFFM(1)
--Protocol=cifs|nfsOptional. Filesystem protocol. If omitted it list both cifs and nfs filesystems.
SERVERNAMELogical name of the server as provided at the time of creation. You can get thelist of all the server names by callingrffm listServers
importPEACentera [--FileServer=FILESERVER] [--pea=PEA]Imports a Centera PEA file, replacing any existing PEA file for that Centera.
--FileServer=FILESERVERLogical name of the Centera.
--pea=PEAPath to the new PEA file. Do not overwrite any existing PEA file imported toCTA - that is, do not put the new PEA file under /opt/rainfinity/filemanage-ment/conf/centera. Theimport will copy the file to the correct location.
multiTierRepoMigUpdate [--action=get|set|runnow] [--StartTime=STARTTIME]Used for getting/setting the start time or run the multitier/repositorymigration update task.
--action=get|set|runnowAction to be performed. Valid actions are* get displays the starttime of the multitier/repositorymigration update task andtells whether it is running or not.* set is used for setting starttime of the multitier/repositorymigration updatetask. The default time is 20:00 every day.* runnow forces the multiter/repositorymigration update task to run right away.
--StartTime=STARTTIMEStartTime of the task in HH-MM format. Applicable only if--action=set
delayedStubUpdate [--action=get|set|runnow] [--StartTime=STARTTIME]Used for getting/setting the start time or run the delayedstub update task.
--action=get|set|runnowAction to be performed. Valid actions are* get displays the starttime of the delayedstub update task and tells whether it isrunning or not.* set is used for setting starttime of the delayedstub update task. The defaulttime is 23:00 every day.* runnow forces the delayedstub update task to run right away.
--StartTime=STARTTIMEStartTime of the task in HH-MM format. Applicable only if--action=set
setNetAppPassthrough [--FileServer=FILESERVER] enable|disableEnables or disables NetApp passthrough recall either globally or for individual fileservers.
--FileServer=FILESERVERFile server to be enabled or disabled.UseALL to enable or disable all config-ured file servers. Passthrough must be globally enabled before individual fileservers can be enabled or disabled.
EMC CTA 9.0.x 24
heffem2
Text Box
RFFM(1) RFFM(1)
listNetAppPassthroughLists the status of NetApp passthrough recall, which can be enabled or disabled.
addNetAppPassthroughExcludedExtension EXTENSIONAdd a CIFS file extension for which NetApp passthrough recall is disabled.CTA willalways perform a full recall of files with this extension.
deleteNetAppPassthroughExcludedExtension EXTENSIONDelete a CIFS file extension for which NetApp passthrough recall is disabled.CTA willsupport passthrough recall for files with this extension. (SeelistNetAppPassthrough toreview NetApp passthrough support for configured file servers.)
addNetAppPassthroughExcludedExpression REG_EXAdd a regular expression for CIFS file names (not full paths) for which NetApppassthrough 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_EXDelete a regular expression for CIFS file names for which NetApp passthrough recall isdisabled.
listNetAppPassthroughExcludedExpressionsList the CIFS file extensions and regular expressions for which NetApp passthroughrecall is disabled.CTA always performs a full recall of CIFS files with matching filenames 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=SIDPATHFull Path to the SID Translation File
deleteSIDTranslationFile [--SIDFileNameToDelete=SIDFILENAMETODELETE]Deletes the CIFS SID Translation file from /opt/rainfinity/filemanagement/SID and alsodeletes it from Database
--SIDFileNameToDelete=SIDFILENAMETODELETEThe name of the SID Translation File to be deleted
listSIDTranslationFilesLists all the SID Translation Files added to the CTA
--action=get|setAction to be performed. Valid actions are* getdisplays the archive report settings in a detailed format.* set is used for setting the one or more of the following parameters.
--AddServerGroup=SERVERGROUP:SVR1,SVR2...Add a new file server group.SERVERGROUP should be a unique name. Theremust be atleast one server defined in a server group.SVR<n> must be sourceserver. You can get a list of all valid source servers using the commandrffm list-Servers --SourceOnly
--EditServerGroup=SERVERGROUP:SVR1,SVR2...Redefine an existing file server group with source servers
--DeleteServerGroup=SERVERGROUPNAMEFile server group that needs to be deleted
--FileTypes=FILETYPESFile types to be enabled. Must be of the formBMP,PST,TIF.... default is a spe-cial value that defaults toBMP,JMP,LOG,PDF,PPT,PST,SVD,TIF,XLS,ZIP
--FileSizeUnit=kb|mb|gb|tb|pbFilesize unit for the file size buckets defined below.
File size buckets. They must be in increasing order of numeric values.
--ReportCleanupDays=REPORTCLEANUPDAYSNumber of days to wait to perform the next report cleanup. The value must bebetween 1 and 730.default is a special value that defaults to 365 days.
--TimeRangeMonths=TIMERANGE_MONTHSArchive report time range in months. The value must be between 1 and 12.default is a special value the defaults to 12. Cannot be combined with--TimeRangeStartDate/ --TimeRangeEndDate.
Archive report time range by start and end date. Date must be of the formYYYY-MM-DD. Cannot be combined with--TimeRangeMonths.
listImportPr ovidersLists all import providers configured in the CTA.
addImportPr ovider [--username=USERNAME] PROVIDERNAME PASSWORDAdd an import provider to the CTA configuration.
--username=USERNAMEOptional system username for the provider. If omitted PROVIDERNAME istaken as the system username
PROVIDERNAMECase in-sensitive name of the provider name to add. (The system username cre-ated is case-sensitive)
EMC CTA 9.0.x 26
heffem2
Text Box
RFFM(1) RFFM(1)
PASSWORDPassword for provider system user
editImportPr ovider [--Password=PASSWORD][--PublicKeyPath=PUBLICKEYP ATH] PROVIDERNAMEEdit the import provider password in the CTA configuration or install ssh/scp public key.
--Password=PASSWORDPassword for provider system user
--PublicKeyPath=PUBLICKEYPATHAbsolute path to public key file
PROVIDERNAMECase in-sensitive name of the provider name to edit.
deleteImportProvider PROVIDERNAMEDelete the import provider from the CTA configuration.
PROVIDERNAMECase in-sensitive name of the provider name to delete.
importFromXmlFile [--background] IMPORTFILEP ATHLoad an import XML file containing paths of files to be archived.
--backgroundInstructs the daemon to process the import file in the background and return thiscommand immediately. If not given the daemon imports the file in the fore-ground and returns the complete import status of the command.
IMPORTFILEP ATHFull path to the import XML file. Must be of the form import_file_<n>.xml,where <n> must be the same as the <ID> tag inside the XML file.
getImportFileHistory [--ImportID=IMPORTID] [--Pr oviderName=PROVIDERNAME][--StartTime=yyyy-mm-dd,HH:MM] [--EndTime=yyyy-mm-dd,HH:MM][--TaskID=TASKID] [--TaskName=TASKNAME]Returns the history of all imports for the task or provider.
--ImportID=IMPORTIDXML import file ID as mentioned in the <ID> tag of the import file.
--ProviderName=PROVIDERNAMEProvider Name configured on the CTA.
--StartTime=yyyy-mm-dd,HH:MMImport files that was started after this time.
--EndTime=yyyy-mm-dd,HH:MMImport files that ended before this time.
--TaskID=TASKIDTask ID as returned bygetTasks command. Alternatively the user can use--TaskName=TASKNAME
--TaskName=TASKNAMEName of the import task. Alternatively the user can use--TaskID=TASKID
EMC CTA 9.0.x 27
heffem2
Text Box
RFFM(1) RFFM(1)
getPendingImportedFiles [--ErrorOnly] [--ExportName=EXPORTNAME][--ShareName=SHARENAME] [--FileServer=FILESERVER][--ImportID=IMPORTID] [--ImportDateOlderThan=IMPORTD ATE][--MinNumErrors=MINNUMERRORS] [--Path=P ATH][--Format=count|list|detail|xml] TASKNAMEDumps a list of files pending archive for the task
--ErrorOnlyUsed to dump records for only those files that have failed archive.
--ExportName=EXPORTNAMEMust be just a top level export name no subdirectories or nested exports. (Eg:/fs1). Must be accompanied by--FileServer=FILESERVER . To get the list ofNFS exports runrffm getFileSystems --Protocol=nfs FILESERVER.
--ShareName=SHARENAMEMust be just a top level share name only. (Eg: HOME). Must be accompanied by--FileServer=FILESERVER . To get the list of CIFS shares runrffm get-FileSystems --Protocol=cifs FILESERVER.
--FileServer=FILESERVERFile Server name.
--ImportID=IMPORTIDXML import file ID as mentioned in the <ID> tag of the import file.
--ImportDateOlderThan=IMPORTD ATEUsed for selecting files imported on or before this date.
--MinNumErrors=MINNUMERRORSUsed for selecting files with MINNUMERRORS or more archive failures.
--Path=PATHFilepath relative to SHARENAME or EXPORTNAME . CIFS path can haveeither / or \ as directory delimiter.
--Format=count|list|detail|xmlDisplay format. If omitted the default islist.
TASKNAMEName of the import task.
deletePendingImportedFiles [--ErrorOnly] [--ExportName=EXPORTNAME][--ShareName=SHARENAME] [--FileServer=FILESERVER][--ImportID=IMPORTID] [--ImportDateOlderThan=IMPORTD ATE][--MinNumErrors=MINNUMERRORS] [--Path=P ATH][--ForceDelete] TASKNAMEDeletes pending imported files by the given critera.
--ErrorOnlyUsed to dump records for only those files that have failed archive.
--ExportName=EXPORTNAMEMust be just a top level export name no subdirectories or nested exports. (Eg:/fs1). Must be accompanied by--FileServer=FILESERVER . To get the list ofNFS exports runrffm getFileSystems --Protocol=nfs FILESERVER.
--ShareName=SHARENAMEMust be just a top level share name only. (Eg: HOME). Must be accompanied by--FileServer=FILESERVER . To get the list of CIFS shares runrffm get-FileSystems --Protocol=cifs FILESERVER.
EMC CTA 9.0.x 28
heffem2
Text Box
RFFM(1) RFFM(1)
--FileServer=FILESERVERFile Server name.
--ImportID=IMPORTIDXML import file ID as mentioned in the <ID> tag of the import file.
--ImportDateOlderThan=IMPORTD ATEUsed for selecting files imported on or before this date.
--MinNumErrors=MINNUMERRORSUsed for selecting files with MINNUMERRORS or more archive failures.
--Path=PATHFilepath relative to SHARENAME or EXPORTNAME . CIFS path can haveeither / or \ as directory delimiter.
--ForceDeleteSuppress confirmation of delete. If unspecified the CLI asks for confirmation tothe user for deleting.
TASKNAMEName of the import task.
scheduleVacuumTask [--VacuumStartTime] [--VacuumWeekRepetition]Schedules a Vacuum Task to be run every (VacuumWeekRepetition) weeks. The fileman-agement daemon will be shutdown and all archiver/stubscanner and other processes willbe killed before the vacuum starts.
--VacuumStartTimeSpecifies the start time in future at which the first vacuum task will run.Syntaxwill be "YYYY-MM-DD HH:MM:SS" . The VacuumStartTime should be spec-ified as a future time value.
--VacuumWeekRepetitionSpecifies the weeek repetition for the configured vacuum task.This defaults to8, which means vacuum task will run every 8 weeks by default. Vacu-umWeekRepetition value can range currently from 4 to 24
deleteVacuumScheduleDelete a Vacuum Task that had been scheduled before
setFileMigrationTotalBandwidthMBs [--FileMigrationTaskID] [--TBBandWidthMB]Sets the total bandwidth for the specified FileMigration task
--FileMigrationTaskIDSpecifies the task id of the file migration task
--TBBandWidthMBSpecifies the total bandwidth in MB
getTaskExitThresholdReturns 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 forArchiver, Repository Migration and StubScanner tasks.If this is set to a high value on afailed migration we will have to manually copy files to the destination. This value is
EMC CTA 9.0.x 29
heffem2
Text Box
RFFM(1) RFFM(1)
applicable only as long asfmd is running. If it is restarted, this value is lost. Currentlythis feature is not being used
--ThresholdPercentThe minimum success threshold percentage below which rfwalker would exit.
setFileMigrationErrorThreshold [--ErrorThreshold]Sets the threshold for the number of errors for FileMigration task
--ErrorThresholdSpecifies the error threshold
getFileMigrationErrorThresholdGet the FileMigration Error Threshold
fullyQualifiedDomain [--action=get|set|clear] [--Name=KERBEROS_FQDN] [--DCIP=DCIP]Get, set or clear Kerberos Fully Aualified Domain from CTA configuration.
--action=get|set|clearAction to be performed. Valid actions are* set is used for setting Kerberos Fully Qualified Domain to CTA configuration.Used as both add and edit. When running this command for the first time afterinstallation, it works as add. Running it after the first successful --action=set, itworks as edit.* getdisplays the settings from configuration, if it exists.* clear clears the settings from configuration, if it exists.
* 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 namebecomes the system user name) and (2) a different system user
* To add a File Migration taskrffm 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 Filerffm addSIDTranslationFile --SIDFilePath=/var/dir1/sidfile
COPYRIGHTCopyright EMC, 2006-2008
AUTHOREMC1-800-SVC-EMChttp://powerlink.emc.com
SEE ALSOrffm(1), rfpolicy(1), fmsupportdump(1), rssystat(1)
EMC CTA 9.0.x 32
heffem2
Text Box
RFFM(1) RFFM(1)
EMC CTA 9.0.x 33
heffem2
Text Box
RFPOLICY(1) RFPOLICY(1)
NAMEPolicy Document Syntax for EMC Cloud Tiering Appliance
VERSIONVersion 7.x 2009-2010
OVERVIEWThis document describes the syntax of the policy definitions as they are stored and processed internally bythe EMC CTA application. Whena policy is defined through the CTA graphical user interface (GUI), apolicy 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 theEXAMPLES .
The policy definition language was designed with simplicity in mind.Most of the constructs are borrowedfrom 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 anystatement unless it appears inside a string literal or needed to separate adjacent tokens.
* K eywords are case-insensitive but identifiersare case-sensitive. This means the statement
for $old_files do $my_action
is equivalent to
FOR $old_files DO $my_action
but different from
for $OLD_FILES do $my_action
* The body of the document is assumed to be UTF-8 encoded text. However, non-ASCII characters arenot generally recognized outside ofstring literals.
DOCUMENT TYPESThere are two distinct types of documents that can be written in this language,end policies(or just policies)andthe global symbols document. The two differ in the types of statements that they may contain, however,both types obey the same basic syntax.
End PoliciesFor the most part, this document type is the one that you will need to be concerned with.A document ofthis type defines a “policy” as it is known throughout the rest of the product.A document is considered tobe an end policy document if the following are true:
* There is at least oneaction definition
* There are nofile matching expression definitions
The Global Symbols DocumentThere 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 documentwith the rffm exportSymbols command, editing the resulting document and reimport it with therffmimportSymbols command (seerffm (1) for details). The following must be true for the global symbolsdocument:
* The document may not have any rules.
These restrictions may loosen in future releases.
EMC Cloud Tiering Appliance 7.x 1
heffem2
Text Box
RFPOLICY(1) RFPOLICY(1)
COMMENTSComments in the policy document begin with a pound sign (#) and extend to the end of the line.Any textmay safely appear in a comment and will be ignored by the policy document parser.
STRING LITERALSThere are several places in a policy document where arbitrary string values may appear, on the righthandside of afilenameprimary expression being the most common.Like many other languages, a string literalis 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 parseerror and will cause the policy import to fail. Otherwise,string literals may contain arbitrary UTF-8 char-acters.
IDENTIFIERSCertain values can be bound to identifiers usingdefinition statements. Unlike keywords identifiers arealways 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 toinclude any characters beyond those mentioned here an identifier must be “quoted”.A quoted identifier is astring literal. An unquoted and a quoted identifier that contain the exact same characters are the same iden-tifier and may be used interchangeably,
# These two statements are identicaldefine file_expr very_large_files = size > 30 gbdefine file_expr "very_large_files" = size > 30 gb
However, the quoted form gives you the flexibility to, say, embed spaces or use non-ASCII UTF-8 charac-ters in the identifier,
define file_expr "very large files" = size > 30 gb
In policy documents generated by the GUI, all identifiers are quoted.
STATEMENTSThere are two basic types of statements in a policy document:definition statementsandrules. A definitionbinds a value to an identifier so that it may be used later. A rule associates an expression that matches a setof files with an action to be taken out on those files. In a given policy document all definition statementsmust appear before the rules. Refer to the sectionDOCUMENT TYPES for limitations on where eachtype of statement may appear.
DefinitionsDefinition statements take the general form
definetype identifier= value
There are two leg al types: file_expr andaction. File matching expression definitions (file_expr) may onlyappear in the global symbols document. SeeDOCUMENT TYPES for more information. What consti-tutes a legal identifierandvaluedepends upontype.
EMC Cloud Tiering Appliance 7.x 2
heffem2
Text Box
RFPOLICY(1) RFPOLICY(1)
File matching expression definitionsA file matching expression definition binds an arbitrary expression,value, to an arbitrary identifier.For details about the expression syntax, see theExpressionsin theRulessection below.
Action definitionsAction definitions are special in that there may be at least one with the specificidentifier “my_action”as prefix, if there are more action definitions, they will have a sequence number following the prefix,like “my_action#”. Presently, rules may only use one of two actions: the no-op action,nothing and thestandard action bound to “my_action#”. Thevalueof an action definition must take the form
archive to target [ delay_stub value days ] [ retain retention ][ policy_type value ] [ stub_retention value ]
try action expressionthen action expression[ delay_stub value days ][ policy_type value ] [ stub_retention value ] [ retain retention ]
$identifier [ delay_stub value days ] [ retain retention ][ policy_type value ] [ stub_retention value ]
delete [ delete_all value ] [ days_missing value ] [ policy_type value ]
(The brackets around the clauses indicate that it is optional and they should not appear literally in thedocument.) Currently, there are two kinds of action, archive and delete action; and it could be more infuture. Thetarget 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. Seerffm (1) for details.Thetry andthen is for recursive action definition, and theaction expressionis the value of another actiondefintion. Thereferenced identifier is the name of action defintion in global symbols document, whichaccepts archive action definition only in global symbols document now, and the identifier name inglobal symbols document does not limited to start from “my_action”,see more in theReferencessec-tion below. The delay_stub clause, if provided, specifies the minimum number of days to delay stubthe files archived by this action. The delay stub time allows the Centera Replication to safely backupthe files before converting the archived files into stub files. The retention clause, if provided, specifiesthe minimum retention time to be given to any files archived by this action. The stub_retention clauseis 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 retentionor not, it is for “delete_stubs” type. The days_missing clause specifies the missing days for orphanfile, it is for “delete_orphans“ type.For details about the clauses syntax, see the age values in theRulessection below.
RulesRules form the bulk of an end policy document. Ruleevaluation proceeds as a filter against files.For eachfile, 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 waycomplex archiving policies can be constructed by designing rules to archive files with specific traits andproceeding them with other rules designed to catch and filter out the exceptions. Any file that is notmatched by any rule is left untouched. See theEXAMPLES section.
A rule has the general form
for expression do action
It should be emphasized that this isNOT a looping construct despite syntactic similarity to loops in otherlanguages.
EMC Cloud Tiering Appliance 7.x 3
heffem2
Text Box
RFPOLICY(1) RFPOLICY(1)
ExpressionsAn expression may appear in a rule or in a file matching expression definition. Each expression con-sists of a sequence ofpieceslogically “anded” together,
piece [ and piece ... ]
The operator&& may be used interchangeably with theand operator. Each piece can be either afilematching primativeor areferenceto an expression defined in the global symbols document.
Primati vesAll primatives hav ethe form
attribute operator value
Note that the order is important.
size > 100 mb
is a legal primative, howev er,
100 mb < size
is not. The legal attributesare:
size Matches based upon the file’s sizeValid operators: <, <=, ==, >=, >Valid values: SeeSize Values
last_accessed Matches based upon the file’s atimeValid operators: <, <=, ==, >=, >Valid values: SeeAge Values
last_modified Matches based upon the file’s mtimeValid operators: <, <=, ==, >=, >Valid values: SeeAge Values
filename Matches based upon the filename, not including the path of the parent direc-toryValid operators: ==, matches regexValid values: any string literal
dirname Matches based upon the directory path.Valid operators: ==, matches regex, matches singlefileValid values: any string literal with forward slash as directory separator.
Note that in the proceeding the operator== (two equals signs) indicatesexact equality. Fornumerical values (size and age) this will very rarely be desirable.
Thematches regexoperator matches the filename or directory path against the regular expressionin the string literalvalue. The policy engine implements a superset of POSIX regular expression(seeregex(7)). For examples of how to use regular expressions in policies see the documentCTA Expression Matching.
Thematches singlefileoperator compares the concatenation of directory path and file name withthe string value.
Both operators for thefilenameanddirname attribute are conditionally case sensitive dependingon the case sensitivity of the protocol used for the policy evaluation. NFSgenerally respects dif-ferences of case while CIFS generally ignores them.
EMC Cloud Tiering Appliance 7.x 4
heffem2
Text Box
RFPOLICY(1) RFPOLICY(1)
Size ValuesThe 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) prefixeson the keyword byte. As with all other keywords, case is ignored. Furthermore, several varia-tions are accepted for each keyword:
Unit Acceptablealternatives
bytes byte, b
kilobytes kilobyte, kb, k
megabytes megabyte, mb, m
gigabytes gigabyte, gb, g
terabytes terabyte, tb, t
Age ValuesThe last_accessedand last_modified primatives and the retention clauses (seeAction defini-tions) take values that consist of a non-negative integer followed by an age unit.NOTE: It isvery important that the number and unit are separated by some whitspace.“7years” is not a validsize value; “7 years” is. The legal units are:
Unit Acceptablealternatives
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 themonths 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 ineach month of the Gregorian calendar.
ReferencesIn addition to primatives, apiecemay consist of a reference to a file matching expression that hasbeen bound to an identifier using a file matching expression definition statement in the globalsymbols document (seeDefinitions and DOCUMENT TYPES above). A reference has theform
$identifier
where identifier follows the same rules as outlined inIDENTIFIERS . In particular, identifiermay be quoted or unquoted as necessary. identifiermust 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 definitionscontaining references, this implies that the definition may not create any explicit or implicit self-references.
ActionsIn a rule, only two values are legal for action: the no-op action,nothing, and a reference to the actionbound to “my_action#”.
nothing A file that matches a rule with this action is left alone (no more rules are evaluated) andthe next file is processed.
EMC Cloud Tiering Appliance 7.x 5
heffem2
Text Box
RFPOLICY(1) RFPOLICY(1)
$my_action# Afile that matches a rule with this action is archived according to the parameters speci-fied in the action definition statement for “my_action#”.
EXAMPLESFirst, here’s a sample global symbols document:
define file_expr "Slightly Old Documents"= $slightly_old and $doc_file
define action "dest_cifs" =archive to "Repository at \\\\celerra55\\cifs2"
define action "dest-multi" =try archive to "Repository at \\\\win2k3-fs\\share_1"then archive to "Repository at \\\\netapp7-2x\\cifs1"
Some things to take note of in the preceding example:
* Whitespace, even line breaks, may appear anywhere and it does not effect the meaning of the defini-tions.
* When using regular expressions be mindful of backslashes.Regular expressions often require a singlebackslash to treat a metacharacter (such as a period) as a normal character. Howev er, because regularexpressions are represented as string literals, those backslashes will need to be doubled.In theextreme case, to write a regular expression that matches the backslash character, you will need fourbackslashes: two for the regular expression and two more for the string literal.
* The correct way to use regular expressions to match a file extension is \.ext$ or, inside a string literal,“\\.ext$” whereext is the extension in question.“*.ext” is not a legal regular expression and will causea parse error. Regular expressions are not file globs!
* Bound file matching expressions may refer to other file matching expressions so long as they appearbeforehand in the document. “Slightly Old Documents” demonstrates this.
* A ction definition in global symbols document has no clause.
Now here’s a sample policy that uses some of those symbols:
# This is a sample end policy
# Define our destination for this policydefine action my_action =archive to "my_first_centera" delay_stub 0 dayspolicy_type "archive" retain 7 years stub_retention "false"
define action "my_action1" =archive to "Repository at \\\\celerra56\\cifs1" delay_stub 0 dayspolicy_type "archive" retain 0 years stub_retention "false"
EMC Cloud Tiering Appliance 7.x 6
heffem2
Text Box
RFPOLICY(1) RFPOLICY(1)
# Never archive Windows binaries under any circumstancesfor $bin_file do nothing
# Archive slightly old documents to destination with high performancefor $"Slightly Old Documents" do $my_action1
# Archive anything else that’s really old and large to CASfor $very_old and size > 100 mb do $my_action
Here you should note that:
* The action definition statement must come before all of the rules.
* The order of the rules is very important.The first, “do nothing” rule effectively acts as a filter, rulingout files with the extensions “.exe”, “.dll” and “.bin” before they encounter the subsequent rules.As aresult, no file with one of those extensions will ever be archived reg ardless of its size or age. If thatrule were to come after another rule, it would not have that effect.
* M ultiple “$my_action” rules in sequence has the effect of a logical “or” operator. In this case (assum-ing it has not been caught by the first rule) a file that is either a “Slightly Old Document” or is very oldand large will be archived.
COPYRIGHTCopyright EMC, 2009
AUTHOREMC1-800-SVC-EMChttp://powerlink.emc.com
SEE ALSOrffm(1), rfpolicy(1), fmsupportdump(1), rssystat(1)
EMC Cloud Tiering Appliance 7.x 7
heffem2
Text Box
FMSUPPORTDUMP(1) FMSUPPORTDUMP(1)
NAMEfmsupportdump - EMC CTA Support Diagnostic Command-line Tool
DESCRIPTIONfmsupportdump 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 problemsthat 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 thatwill 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. Tostart sendmail, enter the command: /etc/init.d/sendmail start
COPYRIGHTCopyright EMC, 2007
AUTHOREMC1-800-SVC-EMChttp://powerlink.emc.com
SEE ALSOrffm(1), rfpolicy(1), fmsupportdump(1), rssystat(1)
Li ve Status Commands-net [-a] [-nc] [-s <sample_secs>]
Log File Processing Commands and Options-report sys-report net < all | <iface list> >-list-info <file.log>-cols <file.log> [col list]-avg <file.log> [col list]-d <logfile_dir>-from [YYYY-MM-DD] HH:MM:SS-to [YYYY-MM-DD] HH:MM:SS
Daemon Control Commands-ctl < <opt> <val> | show | reset | clearlogs >
DESCRIPTIONrssystat 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 calledrssys-tatd. Historical information is recorded in /var/log/rainfinity/histogram. rssystat is a user interface to thisinformation. rssystatd, the daemon, is not run by the user, but is started and stopped as part of the normalCTA init scripts.
rssystat can be used on it’s own for live network monitoring, or as a front-end to the historical informationgathered by rssystatd. It can give information on the log files gathered, extract and average informationfrom 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 diagnosingload-related problems. This information is also gathered by the fmsupportdump tool, when run.
OPTIONS[-h] Show basic help.
[-v] Show version.
LIVE STATUS COMMANDS-net [-a] [-nc] [-s <sample_secs>]
Watch live network activity, sampling the system by default every 2 seconds.With "-a", all net-work interfaces are displayed, not just those that are part of bridges. With "-nc", the screen is notcleared between updates, creating suitable output for sending to log files. With "-s <sam-ple_secs>", the sampling interval is set.
rssystat 7.x 1
heffem2
Text Box
RSSYSTAT(1) RSSYSTAT(1)
LOG FILE PROCESSING COMMANDS AND OPTIONS-report sys
Prepare a report summarizing system information. This includes CPU usage, memory usage, num-ber of proxied connections, and ops per second. The "-from" and "-to" options can be used to con-trol what range of times should be reported on.
-report net < all | <iface list> >Prepare a report on network interface statistics. This includes throughput and packets per second.With "all", all interfaces are displayed. Alternately, specific interfaces can be listed for analysis.The "-from" and "-to" options can be used to control what range of times should be reported on.
-report proc < all | <proc name list> >Prepare a report on monitored processes. This includes cpu, threads, and memory usage.Moni-tored processes include fmd, fcd, archiver, datacollector, and stubscanner. The "-from" and "-to"options can be used to control what range of times should be reported on.
-list List all log files available in /var/log/rainfinity/histogram. The names as given here are the namesused later when an option <file.log> is required.These logs are rotated monthly, and the backupsare 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 areinterested.
-cols <file.log> [col list]Extract the given columns from the given log file. "col list" is the list of columns to be processed.The format is a space separated list of columns or column ranges, such as "5 6 8" or "5 6 8-12".Column numbers for a log file can be found with the "-info" command listed above. The "-from"and "-to" options can be used to control what range of times should be extracted.
-avg <file.log> [col list]Calculate statistics for the given columns and for the given log file. "col list" is the list of columnsto be processed.The format is a space separated list of columns or column ranges, such as "5 6 8"or "5 6 8-12". Column numbers for a log file can be found with the "-info" command listed above.The "-from" and "-to" options can be used to control what range of times should be extracted.
-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.
-from [YYYY-MM-DD] HH:MM:SSRestrict log file processing to entries starting from this date and time. If the date is omitted, thecurrent day is used.
-to [YYYY-MM-DD] HH:MM:SSRestrict log file processing to entries before this date and time.If the date is omitted, the currentday is used.
rssystat 7.x 2
heffem2
Text Box
RSSYSTAT(1) RSSYSTAT(1)
DAEMON CONTROL COMMANDS-ctl <opt> <val>
Set rssystatd daemon runtime options. The only supported option is currently "sample_secs",which changes the frequency with which system load measurements are taken. Use "-ctl help" tosee available options. Note: if changing the sample_secs option or any other option, the changewill be picked up at the next sample time.For example, if the current sample period is set to 60seconds, changing the sample period to 10 seconds will take up to 60 seconds to take effect.
-ctl showShow current rssystatd daemon runtime options.
-ctl resetReset any rssystatd daemon runtime options to system defaults.
-ctl clearlogsClear ALL logs in /var/log/rainfinity/histogram. You will be prompted for confirmation before thisproceeds.
EXAMPLESWatch network activity on all interfaces:
rssystat -net -a
Get a report on system activity for the given time range and the current day:
rssystat -report sys -from 00:00:00 -to 04:00:00
Get a report on network activity for eth2 and eth 3, for the given time range and the current day:
rssystat -report net eth2 eth3 -from 00:00:00 -to 04:00:00
Get a process for the archiver, for the given time range and the current day:
/var/log/rainfinity/histogram/sys1.logMain system log file. This contains information on CPU usage, memory, and other items. This is themain file in which users will be interested.
/var/log/rainfinity/histogram/eth*.logPer-interface log files. All interface statistics for an interface can be found here.
/var/log/rainfinity/histogram/proc_*.logPer-process log files. This includes statistics for each monitored process, including fmd, fcd, andrfwalker as archiver, datacollector, and stubscanner.
/var/log/rainfinity/histogram/rssystatd.stdAny standard output/error from rssystatd. Use this to diagnose runtime problems with rssystatd. Thisfile will typically be empty.
COPYRIGHTCopyright EMC, 2007
AUTHOREMC1-800-SVC-EMChttp://powerlink.emc.com
SEE ALSOrffm(1), rfpolicy(1), fmsupportdump(1), rssystat(1)
bond <bondname> slaves <interfacename> mode <mode> ip <ip> netmask <netmask> gw <gateway>bond <bondname> slaves <interfacename> mode <mode>
routeroute 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 gwroute add default gw <gateway>route del default gw <gateway>
DESCRIPTIONrfnet is used to configure network.
OPTIONS[-h] Show basic help.
COMMANDSshow [-]
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 [-] Show the mtu of all interfaces
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
mtu <interfacename> <mtu>set mtu for one interface
rfnet 7.x 2
heffem2
Text Box
RFNET(1) RFNET(1)
mtu <firstname>-[lastname] <mtu>set mtu for the interfaces whose name is in the range from firstname (to lastname)
hostnameshow hostname
hostname <hostname>configure the hostname
domainshow domain
domain <domain>configure the domain
dns show dns
dns <dns>configure the dns
delete dns <dns>delete one 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 <interfacename> <Full/Half>configure duplex for one interfac
duplex <firstname>-[lastname]show duplex of the interfaces whose name is in the range from firstname (to lastname)
duplex <firstname>-[lastname] <Full/Half>configure duplex for the interfaces whose name is in the range from firstname (to lastname)
ipaddr <interfacename> <ipaddr> <netmask>set ipaddr and netmask for one interface
DESCRIPTIONrslog is used to manage logging configuration.
OPTIONS[-h] Show basic help.
COMMANDSconfig 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.
deleteoutput <type> <dest>Delete an output
enableoutput <type> <dest>Enable an output
disableoutput <type> <dest>Disable an output
setgrouplevel <program> <metagroup> <level>Set logging level for meta group
rslog 7.x 1
heffem2
Text Box
RSLOG(1) RSLOG(1)
cleargrouplevel <program> <metagroup>Clear logging level for meta group
setlidlevel <program> <logid> <level>Set logging level for a log id
clearlidlevel <program> <logid>Clear logging level for a log id
Note: Clearing logging levels does not immediately set that logging level backto the default level. It only removes it from the configuration so that thenext time the relevant program is run, it will not have this logging levelconfigured. Similarly, changes to logging configuration will not take effectuntil the FMD daemon is not running.
COPYRIGHTCopyright EMC, 2009
AUTHOREMC1-800-SVC-4EMChttp://powerlink.emc.com
SEE ALSOrffm(1), rfpolicy(1), fmsupportdump(1), rssystat(1)
