Quick Start Guide. This Quick Start Guide applies to the following editions:

Transcription

1 NTP Software QFS for NAS, NetApp Edition Quick Start Guide This Quick Start Guide applies to the following editions: NTP Software QFS for NAS, NetApp Edition NetApp FAS250 Edition, NetApp FAS270 Edition, NetApp FAS920 Edition, NetApp FAS940 Edition, NetApp FAS960 Edition, NetApp FAS980 Edition, NetApp FAS3020 Edition, NetApp FAS3050 Edition Abstract This guide details the method for installing NTP Software QFS for NAS, NetApp Edition from an Administrator perspective. Upon completion of the steps within this document, QFS for NAS, NetApp Edition will be installed within your enterprise community. Rev 2.4, April 2006 Copyright by NTP Software. All rights reserved. Doc #6020EF.

2 NTP Software QFS for NAS, NetApp Edition Quick Start Guide The information contained in this document is believed to be accurate as of the date of publication. Because NTP Software must constantly respond to changing market conditions, the following should not be interpreted as a commitment on the part of NTP Software, and NTP Software cannot guarantee the accuracy of any information presented after the date of publication. This Technical Note is for informational purposes only. NTP SOFTWARE MAKES NO WARRANTIES, EXPRESS OR IMPLIED, IN THIS DOCUMENT. NTP Software, Modeling & Analysis, and Quota & File Sentinel are either registered trademarks or trademarks of NTP Software in the United States and/or other countries. Other product and company s mentioned herein may be the trademarks of their respective owners. NTP Software, 20A Northwest Blvd. #136, Nashua, NH 03063, USA Copyright by NTP Software. All rights reserved. Doc #6020EF

3 NTP Software QFS for NAS, NetApp Edition Quick Start Guide Table of Contents Before You Begin...1 Preparing the NetApp Server...2 Installing QFS for NAS, NetApp Edition...3 Adding Your Filer to the QFS Policy Hierarchy...5 Policy Creation...7 Creating Disk Quota Policies...7 Creating File Screening Policies...8 Creating File Removal Policies...9 NTP Deep Scan Technology...10 Zip Scan...10 End User Support Infrastructure Installation...11 About End User Support Infrastructure...11 Installing End User Support Infrastructure...11 QFS Templates...13 QFS Help Site...17 End User Support Infrastructure Web Site...17 Storage Investigator...17 Command Line Interface...19 Introduction...19 Usage...19 Index of Policy Manipulation Commands...20 Appendix 1: Installing QFS in Clustered Environments...37 Installing NTP Software QFS in a Clustered Environment...37 Installing NTP Software QFS onto a Node Server...39 About NTP Software...42 NTP Software Professional Services...42 Copyright by NTP Software. All rights reserved. Doc #6020EF

4 NTP Software QFS for NAS, NetApp Edition Quick Start Guide Before You Begin Thank you for your interest in NTP Software QFS for NAS, NetApp Edition. NTP Software QFS controls storage for millions of users worldwide. NTP Software QFS for NAS, NetApp Edition extends our best-of-breed technology to include the NetApp family of products and allows you to manage Windows and NAS-hosted storage as a seamless whole. Given the architecture of your Filer, NTP Software QFS for NAS, NetApp Edition does its job remotely. It s part of the QFS family of products and uses a connector service to create a bridge and include Filers as full participants in storage environments controlled by QFS. In light of this approach, you ll need to install the NetApp connector on one of the Windows, 2000, or 2003 machines in your environment. This may be an existing server or workstation, or a standalone system. To be managed by QFS, your Filer must be running version 6.5 or greater of the OnTap operating system. QFS for NetApp can be used to manage NetApp Filers, vfilers, and NetApp clusters, or any combination of these systems. QFS imposes no restrictions on how you organize or manage your storage. You can impose policies on individual directories, users, and/or groups of users. If you want to use -based messaging and notifications, you will need access to an server as well. To install QFS on Windows, you need to log in with an ID that has Administrator rights on the machine. You will be installing three different services: the EASE System Manager, the Quota & File Sentinel Service, and the NetApp Connector. The EASE System Manager service should be installed with a domain user account as its service account so that it can communicate with your mail system and other storage servers with which it may share policies. The QFS service requires a domain user account with local administrative rights on the NetApp Filer. The NetApp Connector service uses this account as well. Your hardware should be appropriate for the services running on each machine. NOTE: With this version of QFS for NAS, NetApp Edition the old default fpolicy previously created on the Filer has been changed to NTPSoftware_QFS. For versions and earlier use default in place of NTPSoftware_QFS for fpolicy creation as shown below. Copyright by NTP Software. All rights reserved. Page 1

5 NTP Software QFS for NAS, NetApp Edition Quick Start Guide Preparing the NetApp Server NTP Software QFS for NAS, NetApp Edition requires NetApp Filer to be running OnTap version 6.5 or later. If your filer is not running a version prior to 6.5, you must upgrade your OS before you proceed. (Please refer to your Network Appliance documentation for how to upgrade.) Although QFS doesn t install any components on the NetApp server, you ll need to enable the OnTap fpolicy management service. NOTE: With this version of QFS for NAS, NetApp Edition the old default fpolicy previously created on the Filer has been changed to NTPSoftware_QFS. For versions and earlier use default in place of NTPSoftware_QFS for fpolicy creation as shown below. Follow these steps: 1. Log into the NetApp server with an account that has administrative privileges. 2. At the prompt, execute the following command: fpolicy create NTPSoftware_QFS screen 3. Execute the following command: fpolicy enable NTPSoftware_QFS 4. Verify that CIFS file policies are now enabled by executing the following command: fpolicy These steps create the configuration that allows QFS to register with and manage your Filer. They must be completed before you try to configure QFS. Later in this document, we ll show you how to register a file policy server with the Filer. This is all the Filer administration that s required; you re now ready to install QFS on your Windows system. Copyright by NTP Software. All rights reserved. Page 2

6 NTP Software QFS for NAS, NetApp Edition Quick Start Guide Installing QFS for NAS, NetApp Edition The installation process is a standard set of questions that will be very familiar to existing QFS users. 1. Log into your Windows XP, 2000, or 2003 computer, using an account with local administrator privileges. 2. Place the QFS CD into the server s CD-ROM drive. After a few moments, the installation wizard s start window should appear. If the window does not appear, start the installation manually by launching Setup.exe from your CD-ROM drive. 3. You will be prompted to install EASE, which will create a database to store all of your QFS policies. Click Yes. 4. At the EASE Welcome screen, click Next. 5. Read the license agreement. If you agree to the terms, click Accept and then click Next. If you do not agree to the terms, click Cancel to exit the installation. 6. At the Choose Destination Location screen, click Next. 7. At the Select Components screen, click Next. 8. At the Service Account screen, enter an account with domain user privileges and the password. Click Next. 9. At the EASE Database Location screen, click Next. 10. At the Setup Type screen, if you re not already using a QFS enterprise solution, select First time installation in the enterprise. Otherwise, if you want to join your Filer to an existing QFS installation and policy set, select Adding to an enterprise installation. Click Next. 11. If you selected Adding to an enterprise installation in the preceding step, enter the server and click Next. If you selected First time installation in the enterprise, enter your organization and location and click Next. 12. At the Start Copying Files screen, click Next. 13. At the completion screen, click Finish and read the README file. At this point, Quota & File Sentinel setup will automatically begin. 1. At the Welcome screen, click Next. 2. Read the license agreement. If you agree to the terms, click Accept and then click Next. If you do not agree to the terms, click Cancel to exit the installation. 3. At the Choose Destination Location screen, change the destination folder as needed and click Next. 4. At the Select Components screen, click Next. 5. At the User Information screen, enter your company and QFS serial number and click Next. Copyright by NTP Software. All rights reserved. Page 3

7 NTP Software QFS for NAS, NetApp Edition Quick Start Guide Note: If you re installing an evaluation version, you won t be prompted for a serial number. 6. At the Account Type screen, select either Specify an account to use or Use the built-in system account and click Next. 7. If you chose Specify an account to use, you ll be prompted for a service account and password. Enter an account with domain user privileges that also has local administrative rights on the NetApp filer. Enter the password and click Next. 8. At the next User information screen, enter your company and your NetApp connector serial number and click Next. 9. At the Select Program Folder screen, click Next. 10. At the Start Copying Files screen, click Next. 11. At the completion screen, click Finish and read the README file. To verify that the installation has been completed, look at the list of installed services. The following services should be running, as shown in the figure: Ease System Manager QFS NetApp Connector Quota & File Sentinel Copyright by NTP Software. All rights reserved. Page 4

8 NTP Software QFS for NAS, NetApp Edition Quick Start Guide Adding Your Filer to the QFS Policy Hierarchy Now we need to add your NetApp Filer to the collection of servers being managed by QFS. 1. Run QFS Admin by clicking Start > Programs > NTP Software QFS > Admin. 2. Right-click My Site and choose New > NetApp Filer. 3. You will be prompted to enter a. The you enter here must match the of a Filer on your NetApp server. Alternatively, you can click Browse and browse the Windows network to the NetApp Filer you want to add. 4. Now that you ve added your NetApp Filer to the collection of servers recognized by QFS, right-click the NetApp Filer you just added and select New > Quota File & Sentinel Application. Entries will appear under the NetApp filer for Disk Quota and File Control policies. Next, we need to associate the policies you ll create here with a NetApp filer. 5. In the EASE hierarchy view (the left pane), click the plus sign (+) adjacent to the of the Windows-based server on which you installed QFS. 6. Right-click Quota & File Sentinel under that entry and select Properties to open the QFS Configuration screen. 7. Click the NetApp Connector tab. 8. Click the Add button. 9. Enter the of your NetApp filer and click OK. 10. Click OK in the QFS Configuration screen. Copyright by NTP Software. All rights reserved. Page 5

9 NTP Software QFS for NAS, NetApp Edition Quick Start Guide QFS has now registered itself as a file policy server with the NetApp Filer. You can verify this fact by executing an fpolicy command on the NetApp console. In the following figure, the QFS server WINSYS has registered itself as a file policy server. You re ready to move on and create some policies. Copyright by NTP Software. All rights reserved. Page 6

10 NTP Software QFS for NAS, NetApp Edition Quick Start Guide Policy Creation This section outlines standard Quota & File Sentinel procedures for creating policies. (More information about policy creation and administration is available in the QFS Quick Start Guide, available from NTP Software.) Note: When testing policies you ve created, perform the tests from an independent machine that is not running QFS. Let s walk through creating a few typical policies. For NetApp, two policy types are available: disk quota policies and file control policies. We ll show an example of each. Creating Disk Quota Policies This section walks you through creating a typical disk quota policy. We ll create a quota policy for all your user home directories in a typical server configuration. This quota policy will be applied to all users in your Users directory. Each user will get a quota limit of 50MB. 1. In the EASE hierarchy view, locate the NetApp Filer you added earlier. If necessary, click the plus sign (+) adjacent to this entry to expand the tree. Then click the plus sign next to Quota & File Sentinel to expand the policy types. 2. Right-click Disk Quota Policies and select New > Folder Policy Using Directories. 3. In the New Policy dialog box, click the General tab. Enter a and a description for your new policy. 4. Click the Quota tab, select Absolute Quota Limit, enter 50 MB as the limit, click Deny Writes at 100% of quota, and leave Overdraft unchecked for this example. Note: In a production environment, it s a best practice to implement a 10% overdraft. 5. Click the Thresholds tab to view the thresholds for this quota policy. Notice that one threshold is already set up: At Quota 100%. Adding more thresholds is as simple as clicking New and filling in the percentage information for that threshold. As space is consumed, these thresholds serve as triggers for various actions. Each threshold can send or pop-up messages to the triggering user, the NTFS owner of the file, and/or to any other group or individual (network administrators, the Help Desk, and so on). A threshold can also run a third-party process; for example, running a virus scan on the file in question, or starting an archive to tape. Quota & File Sentinel lets you create up to 200 threshold levels for each policy. Common choices for additional levels are 75%, 85%, and 95%. As users hit each of these levels, you can customize your messages to suggest that users delete some files or contact the Help Desk and request a quota increase before their ability to save new documents runs out. It s also possible to integrate QFS with your intranet or automated workflow and process the limit increase automatically. 6. Double-click the At Quota 100% threshold. The Threshold Properties dialog box for that threshold level appears. If you configured QFS for earlier, select the checkbox for to the triggering user. The Messages tabs let you customize the text of the messages that will be sent. Copyright by NTP Software. All rights reserved. Page 7

11 NTP Software QFS for NAS, NetApp Edition Quick Start Guide The Commands tab allows you to specify a program, script, or batch (.BAT) file that will run when the threshold is reached. 7. After you ve chosen the appropriate settings for and messages, click OK to return to the New Policy dialog box. 8. Click the Directories tab. Click the Add button and either type \vol\users\* or type the appropriate directory followed by a backslash and asterisk (\*). 9. By default, this quota applies to all users. You can verify this fact by clicking the Managed Users and Groups tab. Administrators, Backup Operators, Replicator, and the System account are exempt from quotas. You can verify this fact by clicking the Exempt Users and Groups tab. To change this setting, select the appropriate entry and click Remove. 10. Click OK to close the New Policy dialog box. QFS will create the new quota directory policy, which will be inherited by all systems from this point down in your hierarchy. Creating File Screening Policies This section shows you how to create a file screening policy. Perhaps your company has a corporate policy that forbids your employees to download music files from the Internet. To help the staff comply with this policy, let s create a file screening policy that prohibits creating music files on the server. 1. In the EASE hierarchy view, locate the NetApp Filer you added earlier. If necessary, click the plus sign (+) adjacent to this entry to expand the tree. Then click the plus sign (+) next to Quota & File Sentinel to expand the policy types. 2. Right-click File Control Policies and select New > Folder Policy Using Directories. 3. The New File Policy dialog box opens. Give your policy a and description. 4. Click the Criteria tab. Then click Add and enter the file patterns you want to block (for example: *.AVI, *.MP3, *.MPG, *.MP2, and *.VBS). Note: Be sure to include the asterisk and period (*.) when you specify a file type. QFS follows the normal Windows rules for wildcard file specifications. For example, enter *.MP? to include.mp3,.mp2,.mpg, etc. all music files. This tab also includes two options, Block Zip file containing prohibited content and Enable NTP Deep Scan Technology, which enable the administrator to decide how thoroughly files are scanned for the policy. See the next section of this document for more detailed information on these features. 5. Click OK to return to the New File Policy dialog box. 6. Click the Directories tab. Click the Add button and either type \vol\users\* or type the appropriate directory followed by a backslash and asterisk (\*). 7. Click the Control Options tab. Since our policy is to prevent the creation of these files, select the radio button labeled Always Deny under the options Open for Read, Open for Write, and Create New. Copyright by NTP Software. All rights reserved. Page 8

12 NTP Software QFS for NAS, NetApp Edition Quick Start Guide By default, user accounts with Administrator privileges are exempt from any policy you create. If you want to change this setting, click the Exempt User and Groups tab, select the Administrators entry, and click Remove. 8. Click OK to save this policy. Creating File Removal Policies This section shows you how to create a file removal policy. Your company may have a corporate policy that allows your employees to store files in a central or shared location. As an administrator, you re responsible for maintaining the data stored in this location, which includes deleting old or obsolete data. Let s create a file removal policy that automatically removes aged files. 1. In the EASE hierarchy view, locate the NetApp Filer you added earlier. If necessary, click the plus sign (+) adjacent to this entry to expand the tree. Then click the plus sign (+) next to Quota & File Sentinel to expand the policy types. 2. Right-click File Removal Policy and select New > File Policy Using Directories. 3. The New File Policy dialog box opens. Give your policy a and description. 4. Click the Criteria tab. Set the aspects of the policy: file patterns to remove, age of the files, size, and archive status. You can also select a specific action to take for the files; for example, allowing audit, quarantine, or removal when the policy is triggered. Specify when to enforce the policy and whether it will be applied retroactively to files created before the policy. 5. Click the Alerts tab. As desired, turn on alerts for the quarantine and deletion of files. Once the alert is enabled, you have the option of enabling (if the server has been configured). QFS for NAS, NetApp Edition 3.1 introduces a new variable for Alerts. The variable %FL can be used to create a text report of files that will be deleted. For version 3.1 the file is created in C:\Windows\System32, and this report can be viewed before taking the delete action or after if a restore is needed. 6. Click OK to save the policy. Copyright by NTP Software. All rights reserved. Page 9

13 Deep Scan and Block Zip Options NTP Deep Scan Technology NTP Software QFS for NAS, NetApp Edition 3.1 introduces NTP Deep Scan Technology. This technology allows the Administrator to select whether they would like to use the default scan for file extensions or scan deeper for header information to determine the true nature of a file. When selecting Enable Deep Scan Technology in the Criteria tab it is important to understand how this function will affect your data and user community. Deep Scan will use the file header information to determine what type of file it is. If Sunshine on My Shoulder.mp3 file is red to Sunshine on My Shoulder.txt it will be seen and controlled as an audio (.mp3) file. Likewise Lion.jpg file red to Lion.txt will be seen and controlled as a.jpg file. We do this by looking at the file type. A.jpg file is jpeg image format so it won t matter if the file is.jpg,.jpeg or.txt, we will see it the same. Some notable items regarding the Deep Scan operation: Windows Media Video (.wmv) Due to proprietary information unreleased by Microsoft, QFS for NAS 3.1 is unable to determine this type of file with Deep Scan. It is not included when selecting the Common Video Files option. With Deep Scan disabled we will continue to manage.wmv format files by extension. Microsoft Office files Microsoft Office applications store documents as OLE structured storage files (known as compound files ). Office recognizes that regardless of.pst,.doc or.xls extension it is an Office file and treats it as the same file type. This characteristic prevents us from being able to block.pst files while allowing.doc files, as an example, when Deep Scan is enabled. The.doc file is seen as the same file type as the blocked.pst and is also blocked. If the Administrator adds.doc to managed files we will also manage other Office files in the same manner. Text files When forming your File Control strategy bear in mind that a.vbs or.bat file is a text format file. With Deep Scan enabled we will manage those (and similar text file extensions) as we would.txt. Zip Scan NTP Software QFS for NAS, NetApp Edition 3.1 also introduces the Block Zip File option. If this option is selected we will look inside.zip files for managed file types. For example, entering the.mp3 file type and selecting Block Zip files containing prohibited content will block zipped files that are d.mp3. The Block Zip File function is performed by examining the list of contents for the.zip file. With current technology adding a 3 rd level of scanning could negatively impact file operations. When polling the industry we found that most customers were not overly concerned with red files within.zip files because they felt users will find doing so is more cumbersome to use the files than any benefits they would gain. Copyright by NTP Software. All rights reserved. Page 10

14 EUSI Installation End User Support Infrastructure Installation About End User Support Infrastructure End User Support Infrastructure is an integrated component to NTP Software s QFS application. End User Support Infrastructure contains several utilities to aid network administrators inform users what exactly a quota violation is and assist in fixing the problem. Installing End User Support Infrastructure To install End User Support Infrastructure, insert the CD and select this option from the install interface. Follow the prompts to install the various components. QFS Templates Install these components on the same server as NTP Software QFS. QFS Help Site This is a collection of web pages describing what each quota policy violation means. The purpose is to help users understand why they were notified about a quota violation to cut back on the amount of time administrators are answering these simple questions. End User Support Infrastructure Web Site A web site that allows users to see what policy they violated, request a change in their policy and clean-up their drive. Storage Investigator Storage Investigator is a CAB file that users can download from the End User Support Infrastructure Web site. In order to download the CAB file, users must be an admin on their local machine. If users are not administrators on their machines, then the installation and registration of the Storage Investigator must be done by the administrator using the included MSI file. QFS Help Site and End User Support Infrastructure Web Site and Storage Investigator should be installed on an intranet web server. QFS Templates should be installed on the server where NTP Software QFS is installed. Virtual Directory Dialog When QFS Help Site and End User Support Infrastructure are installed on a web server, the installation creates virtual directories. By default, the virtual directories are HelpSite and NTPSCustomerServiceSite. You may change the s of the virtual directories here. Hosting URL Dialog Use this dialog to specify the URL of the web server hosting the NTP Help Site and End User Support Infrastructure web site. Examples are or This address is used by the QFS templates to access the web sites. Options Dialog Copyright by NTP Software. All rights reserved. Page 11

15 EUSI Installation In this dialog, the Recipient is the mailbox that quota change requests should be sent to. Part of the End User Support Infrastructure Web Site is the ability for users to requests for quota policy changes. The SMTP Server is the address of the server to use. Copyright by NTP Software. All rights reserved. Page 12

16 EUSI Installation QFS Templates QFS Templates are pre-formatted HTML messages that can easily be imported into NTP Software QFS. The following templates are provided with End User Support Infrastructure: BelowThreshold An message indicating that the user has gone below their quota and are now allowed to save things to the share again. FileBlocked An message indicating that a particular file was blocked from being stored on a network share. This might indicate an invalid extension (MP3) or some other blocking reason specified in the QFS policy. OverQuota An message indicating that a user s action has caused their storage to exceed their quota. This particular message contains links to both QFS Help Site and the End User Support Infrastructure Web Site. The OverQuota message is formatted to pass the Server and Share of the drive on which the quota was violated. To change this, please review the NTP Software QFS documentation for valid keys. FileRemoval An message indicating that a particular file of a user has been removed by File Removal Policy. When installing the QFS Templates, it is very important that you specify the URL of the QFS Help Site and the End User Support Infrastructure Web Site. The default web pages have placeholders in them for these URLs. If you do not specify these URLs, the templates will not function as designed. Adding an template to QFS Open up NTP Software QFS Admin tool. Select the policy you wish to add to and from the File menu select properties. Copyright by NTP Software. All rights reserved. Page 13

17 EUSI Installation Disk Quota Policies and File Removal Directory Policy Click on the Thresholds Tab and you should see this screen Select HTML as the Message Format and click on the Properties button. From this new dialog you are allowed to customize messages for each different recipient. For this example, we are only sending to the user who triggered the quota. In the Send to Triggering User group, select as the notification method. On triggering User Messages tab, in the section for Above or Write Denied Threshold Message click on the Edit Text button. This will bring up a text editor. From the File menu, select New to remove all existing text. Then from the Insert menu, select File. Browse to the directory where End User Support Infrastructure was installed and select OverQuota.HTM. Copyright by NTP Software. All rights reserved. Page 14

18 EUSI Installation Click OK to exit out from the dialog boxes. Now, when a user goes over their quota they will receive an message explaining them that they have reached their quota limit on server. Copyright by NTP Software. All rights reserved. Page 15

19 EUSI Installation File Control Policies After bringing up the properties dialog, select the Control Options tab. In the Messages section, select HTML and click on the Message Text and Actions button. In this dialog on the General tab, under Send to Triggering User select as the notification method. On the Triggering User Messages tab, under File Control Deny Message, select the Edit Text button. This will bring up a text editor. From the File menu, select New to remove all existing text. From the Insert menu, select File. Browse to the directory where End User Support Infrastructure was installed and select FileBlocked.HTM. Copyright by NTP Software. All rights reserved. Page 16

20 EUSI Installation Click OK to exit out from the dialog boxes. Now, when a user tries to copy a blocked file they will receive an message. QFS Help Site QFS Help Site provides web pages that answer the most basic questions about QFS policies and violations. The idea is to take this burden away from the network administrator and put the information in one central place. QFS Help Site should be installed on a local web server. The installation process takes care of creating the virtual directory within IIS. The QFS Templates contain links to the QFS Help Site so when a user triggers a QFS policy, they can quickly obtain information about the policy and how to fix the problem. End User Support Infrastructure Web Site This web site contains the pages that allow the user to: Download Storage Investigator for cleaning up their directories. the network administrator requesting a change to their policy. The web site is accessible from the QFS Template files. During installation of End User Support Infrastructure, you will be prompted for the of the virtual directory that should be created. This component should be installed on a web server. Storage Investigator Storage Investigator is an ActiveX control that is setup to download from CleanupFiles.Asp in the End User Support Infrastructure web site. Due to the nature of ActiveX controls, users must be an administrator on the local machine in order to download and register the ActiveX control. For environments where users are not administrators on their local machines, an MSI file is provided. This file can be used with Active Directory or other tools to push an installation of Storage Investigator to each machine. Once installed and registered, users will be able to run the Storage Investigator ActiveX control. Copyright by NTP Software. All rights reserved. Page 17

21 EUSI Installation Storage Investigator is a tool that helps users in the cleanup of their shares and directories. Storage Investigator shows all files sorted by different criteria such as: Largest Files Oldest Files Duplicate Files Aged Files Extensions Using these various filters, users can quickly and easily cleanup their directories so quota policies are no longer violated. Copyright by NTP Software. All rights reserved. Page 18

22 Command Line Interface Command Line Interface Introduction The true value-add of the command line interface is to enable administrators to automate routine tasks within NTP Software QFS for Windows. Utilizing the command line interface, an administrator can write a series of commands in a batch file, which can be scheduled to run at regular intervals. The command line interface functions in the same way, as if commands were being entered manually. Usage QFSCMD <command> <EASE hierarchy path> <command parameters> EASE hierarchy path: An optional parameter that defines where in the EASE hierarchy the command will apply. By default, all commands apply to the local machine as it appears in the EASE hierarchy. Example: "EASE://My Organization\My Site\W2KCONN\Quota & File Sentinel" Command: Specifies the of the command. The following is a list of the commands supported and their parameters: Command : A variable number of command specific parameters. See the reference section for details of the command parameters for each command. Example: C:\QFS_CLI\QfsCmd.exe AddQuotaPolicy "EASE://My Organization\My Site\W2KCONN\Quota & File Sentinel" cli_aqp_03 DIR * Note: When using the Command Line Console with batch files (.bat), the percent sign (%) if used, must be doubled (E.g. 90%%). Batch files handle the percent (%) sign differently. Copyright by NTP Software. All rights reserved. Page 19

23 Command Line Interface Index of Policy Manipulation Commands AddQuotaPolicy <> <> <type> Adds a new quota policy. AddFileControlPolicy <> <> <type> Adds a new file control policy. AddFileRemovalPolicy <> <> Adds a new file removal policy. RemovePolicy <> <> Removes a policy. AddPolicyDescription <> <policy> <description> Adds description for a policy. AddTargetUsers <> <policy> <users> Adds a specific user or group to the list of users governed by the policy. RemoveTargetUsers <> <policy> <users> Removes a specific user or group from the list of users governed by the policy. AddExemptUsers <> <policy> <account> Adds a specific user to the list of users exempt from the policy. RemoveExemptUsers <> <policy> <account> Adds a specific user to the list of users exempt from the policy. AddTargetPath <> <policy> <path> Adds a specific directory or share path to the list paths governed by this policy. RemoveTargetPath <> <policy> <path> Adds a specific user to the list of users governed by the policy. SetAlwaysEnforce <> <policy> <True/False> Sets the flag indicating if this policy is to be enforced always or not. SetQuotaLimit <> <policy> <quotavalue> Sets the quota limit for the policy. AddUserThreshold <> <policy> <thresholdvalue> <thresholdtype> <abovesubject> <abovemessage> <above > <belowsubject> <belowmessage> <below > Adds a user threshold. AddOwnerThreshold <> <policy> <thresholdvalue> <thresholdtype> <abovesubject> <abovemessage> <above > <belowsubject> <belowmessage> <below > Adds a quota threshold for owner of file. Copyright by NTP Software. All rights reserved. Page 20

24 Command Line Interface AddOtherRecipientThreshold <> <policy> <thresholdvalue> <thresholdtype> <abovesubject> <abovemessage> <above > <belowsubject> <belowmessage> <below > Adds a quota threshold for other recipient. AddThresholdCommand <> <policy> <thresholdvalue> <abovecommand> <belowcommand> Adds a threshold command. RemoveThreshold <> <policy> <thresholdvalue> Removes a threshold from the policy. AddOtherRecipients <> <policy> <recipients> Add other recipient to the list. RemoveOtherRecipients <> <policy> <recipients> Removes other recipient from the list. AddFilePatterns <> <policy> <patterns> Adds file patterns for file blocking policy. RemoveFilePatterns <> <policy> <patterns> Removes file pattern(s) from the file blocking policy. SetFileControlOptions <> <policy> <rwoption> <croption> Sets the control option for file blocking policy. Set MessageFormat <> <policy> <messagetype> Sets the option if threshold message should be sent plain text or HTML format. SetSmtpConfiguration < targetfqdn > <smtpserver> <serverdomain> <senderaddress> <senderpassword> Sets SMTP configuration parameters. SetFileRemovalCriteria <> <policy> <durationtype> <duration> <deletepreexisitngfiles> Sets the lifetime for file removal policy. SetQuotaDenyWriteLevel <> <> <level> Sets the Deny Writes at the Quota Limit Property. AddRecipientThreshold <> <policy> <thresholdvalue> <thresholdtype> <abovesubject> <abovemessage> <above > <belowsubject> <belowmessage> <below > Adds a quota threshold for other recipient. AddQuotaPolicy <> <> <type> AddQuotaPolicy creates a new quota policy and adds it to the QFS configuration. Copyright by NTP Software. All rights reserved. Page 21

25 Command Line Interface The of the quota policy to add. type Either DIR for directory policy or SHARE for a share policy. Quota policy <> successfully added or a text message describing the error encountered. The new policy is created at the level specified by the first parameter. If <> is left blank, then the policy is created under the local server s NTP Software QFS application level. The policy must be surrounded by double quotes if it contains a space. AddFileControlPolicy <> <> <type> AddFileControlPolicy creates a new file control policy and adds it to the QFS configuration. The of the file control policy to add. type Either DIR for directory policy or SHARE for share policy. File control policy <> successfully added or a text message describing the error encountered. The new policy is created at the level specified by the first parameter. If <> is left blank, then the policy is created under the local server s NTP Software QFS application level. The policy must be surrounded by double quotes if it contains a space. AddFileRemovalPolicy <> <> <type> AddFileRemovalPolicy creates a new file removal policy and adds it to the QFS configuration. Copyright by NTP Software. All rights reserved. Page 22

26 Command Line Interface type The of the file removal policy to add. Either DIR for directory or SHARE for share policy. File removal policy <> successfully added or a text message describing the error encountered. The new policy is created at the level specified by the first parameter. If is left blank, then the policy is created under the local server s NTP Software QFS application level. The policy must be surrounded by double quotes if it contains a space. RemovePolicy <> <> RemovalPolicy removes a policy from QFS configuration. The of the policy to remove. Policy <> successfully removed or a text message describing the error encountered. The policy must be surrounded by double quotes if it contains a space. AddPolicyDescription <> <> <description> AddPolicyDescription adds description to a given policy. The of the file removal policy to add. description The description that needs to be assigned to a given policy. Policy description <description> successfully added to policy <> or a text message describing the error encountered. Copyright by NTP Software. All rights reserved. Page 23

27 Command Line Interface The policy must be surrounded by double quotes if it contains a space. AddTargetUsers <> <> <users> AddTargetUsers adds list of users to whom the given policy applies. The of the policy. users Semicolon separated list of user or group accounts to which the policy applies. Target users <users> successfully added to the policy <> or a text message describing the error encountered. The policy must be surrounded by double quotes if it contains a space. It is really important that you specify the list enclosed in double quotes. If you only have user in the list, you don t have to put a semicolon at the end. RemoveTargetUsers <> <> <users> RemoveTargetUsers removes user(s) from the list of users to whom the policy applies. The of the policy. users Semicolon separated list of user or group accounts to which the policy applies. Target Users <users> successfully removed from the policy <> or a text message describing the error encountered. The policy must be surrounded by double quotes if it contains a space. It is really important that you specify the list enclosed in double quotes. If you only have a single user in the list, you don t have to put a semicolon at the end. Copyright by NTP Software. All rights reserved. Page 24

28 Command Line Interface AddExemptUsers <> <> <users> AddExemptUsers adds list of users to the policy s exempt user list. The of the policy. users Semicolon separated list of user or group accounts to which the policy applies. Exempt users <users> successfully added to the policy <> or a text message describing the error encountered. The policy must be surrounded by double quotes if it contains a space. It is really important that you specify the list enclosed in double quotes. If you only have user in the list, you don t have to put a semicolon at the end. RemoveExemptUsers <> <> <users> RemoveExemptUsers removes user(s) from the policy s exempt user list. The of the policy. users Semicolon separated list of user or group accounts to which the policy applies. Exempt users <users> successfully removed from the policy <> or a text message describing the error encountered. The policy must be surrounded by double quotes if it contains a space. It is really important that you specify the list enclosed in double quotes. If you only have user in the list, you don t have to put a semicolon at the end. Copyright by NTP Software. All rights reserved. Page 25

29 Command Line Interface AddTargetPath <> <> <path(s)> AddTargetPath adds path(s) to on which the given policy applies. The of the policy. path(s) Semicolon separated list of folders paths. Users <users> successfully added to the target path <path(s)> or a text message describing the error encountered. The target path(s) must be surrounded by double quotes if it contains a space. RemoveTargetPath <> <> <path(s)> RemoveTargetPath removes path(s) from list of policy paths. The of policy. path Semicolon separated list folder paths. Users <users> successfully removed from the target path <path(s)> or a text message describing the error encountered. The target path must be surrounded by double quotes if it contains a space. SetAlwaysEnforce <> <> <flag> RemoveTargetPath removes path(s) from list of policy paths. Copyright by NTP Software. All rights reserved. Page 26

30 Command Line Interface flag The of the file removal policy to add. 0 Policy not be enforced always 1 Policy will be always enforced Always Enforce Flag successfully set for the policy <> or a text message describing the error encountered. The policy must be surrounded by double quotes if it contains a space. SetQuotaLimit <> <> <limit> SetQuotaLimit sets the quota limit for the given policy. The of the file removal policy to add. limit Quota limit value in MB. This value should be greater than 0. Quota limit successfully set for the policy <> or a text message describing the error encountered. The policy must be surrounded by double quotes if it contains a space. AddUserThreshold <> <> <thresholdvalue> <thresholdtype> <abovesubject> <abovemessage> <above > <belowsubject> <belowmessage> <below > AddUserThreshold adds threshold for the given policy. The of the policy. thresholdvalue Threshold value when the threshold is triggered. thresholdltype 1 notification 2 User pop-up 3 Computer pop-up Copyright by NTP Software. All rights reserved. Page 27

31 Command Line Interface abovesubject Subject of notification message shows user has reached threshold. abovemessage Body of notification message shows user has reached threshold. above Body of notification message shows user has reached threshold. belowsubject Subject of notification message shows user has gone below threshold. belowmessage Body of notification message shows user has gone below threshold. below Body of notification message shows user has gone below threshold. User threshold successfully added to the policy <> or a text message describing the error encountered. The policy must be surrounded by double quotes if it contains a space. The threshold value should be greater than 0. Enclose all messaging parameters in double quotes. It is very important that you specify all the parameters for messages. If you don t want to set any particular message, specify an empty value enclosed in double quotes. AddOwnerThreshold <> <> <thresholdvalue> <thresholdtype> <abovesubject> <abovemessage> <above > <belowsubject> <belowmessage> <below > AddOwnerUserThreshold adds file owner threshold for the given policy. The of the policy. thresholdvalue Threshold value when the threshold is triggered. thresholdltype 1 notification 2 User pop-up abovesubject Subject of notification message shows user has reached threshold. Copyright by NTP Software. All rights reserved. Page 28

32 Command Line Interface abovemessage Body of notification message shows user has reached threshold. above Body of notification message shows user has reached threshold. belowsubject Subject of notification message shows user has gone below threshold. belowmessage Body of notification message shows user has gone below threshold. below Body of notification message shows user has gone below threshold. Owner threshold successfully added to the policy <> or a text message describing the error encountered. The policy must be surrounded by double quotes if it contains a space. The threshold value should be greater than 0. Enclose all messaging parameters in double quotes. It is very important that you specify all the parameters for messages. If you don t want to set any particular message, specify an empty value enclosed in double quotes. AddOtherRecipientThreshold <> <> <thresholdvalue> <thresholdtype> <abovesubject> <abovemessage> <above > <belowsubject> <belowmessage> <below > AddOtherRecipientThreshold adds other recipient threshold for the given policy. The of the policy. thresholdvalue Threshold value when the threshold gets triggered. thresholdltype 1 notification 2 User pop-up abovesubject Subject of notification message shows user has reached threshold. abovemessage Body of notification message shows user has reached threshold. Copyright by NTP Software. All rights reserved. Page 29

33 Command Line Interface above Body of notification message shows user has reached threshold. belowsubject Subject of notification message shows user has gone below threshold. belowmessage Body of notification message shows user has gone below threshold. below Body of notification message shows user has gone below threshold. Other recipient threshold added to the policy <> or a text message describing the error encountered. The policy must be surrounded by double quotes if it contains a space. The threshold value should be greater than 0. Enclose all messaging parameters in double quotes. It is very important that you specify all the parameters for messages. If you don t want to set any particular message, specify an empty value enclosed in double quotes. AddThresholdCommand <> <> <thresholdvalue> <abovecommand> <belowcommand> AddThresholdCommand adds commands to be executed when user goes above or below threshold value. The of the policy. thresholdvalue Threshold value when the threshold gets triggered. abovecommand Command to be executed when user goes above quota. belowcommand Command to be executed when user goes below threshold. Threshold command successfully added to the policy <> or a text message describing the error encountered. Copyright by NTP Software. All rights reserved. Page 30

34 Command Line Interface The policy must be surrounded by double quotes if it contains a space. The threshold value should be greater than 0. Enclose all messaging parameters in double quotes. It is very important that you specify all the parameters for messages. If you don t want to set any particular message, specify an empty value enclosed in double quotes. RemoveThreshold <> <> <thresholdvalue> RemoveThreshold removes given threshold from policy. The of the policy. thresholdvalue Threshold value when the threshold is triggered. Threshold successfully removed from the policy <> or a text message describing the error encountered. The policy must be surrounded by double quotes if it contains a space. The threshold value should be greater than 0. AddOtherRecipients <> <> <users> AddOtherRecipients adds list of users to recipient list. The of the policy. users User or group accounts separated by semicolons. Recipients <users> successfully added to the policy <> or a text message describing the error encountered. The policy must be surrounded by double quotes if it contains a space. It is really important that you specify the list enclosed in double quotes. If you only have user in the list, you don t have to put semicolon at the end. Copyright by NTP Software. All rights reserved. Page 31

35 Command Line Interface RemoveOtherRecipients <> <> <users> RemoveOtherRecipients adds list of users to recipient list. The of the policy. users User or group accounts separated by semicolons. Other recipients <users> successfully removed from the policy <> or a text message describing the error encountered. The policy must be surrounded by double quotes if it contains a space. It is really important that you specify the list enclosed in double quotes. If you only have user in the list, you don t have to put semicolon at the end. AddFilePatterns <> <> <patterns> AddFilePatterns adds file patterns for file control policy. The of the policy. patterns List of file patterns separated by semicolons. File patterns <patterns> successfully added to the policy <> or a text message describing the error encountered. The policy must be surrounded by double quotes if it contains a space. It is really important that you specify the list enclosed in double quotes. RemoveFilePatterns <> <> <patterns> RemoveFilePatterns removes file patterns from file control policy. Copyright by NTP Software. All rights reserved. Page 32

36 Command Line Interface The of the policy. patterns Semicolon separated list of file patterns. File patterns <patterns> successfully removed from the policy <> or a text message describing the error encountered. The policy must be surrounded by double quotes if it contains a space. It is really important that you specify the list enclosed in double quotes. SetFileControlOptions <> <> <rwoption> <croption> SetFileControlOptions set control options for file control policy. The of the policy. rwoption 0 Allow read/write 1 Log event for read/write 2 Deny read/write croption Option for file creation flag. 0 Allow create, 1 Log event for create, 2 Deny file creation File control options successfully set for the policy <> or a text message describing the error encountered. The policy must be surrounded by double quotes if it contains a space. Set MessageFormat <> <> <format> Set MessageFormat sets format for messages. Copyright by NTP Software. All rights reserved. Page 33

37 Command Line Interface format The of the policy 0 Plain text format 1 Rich text format message format successfully set to <format> or a text message describing the error encountered. SetSmtpConfiguration <><inheritmailconfiguration> <enable/disable> <smtpserver> <smtpdomain> <senderaddress> <senderpassword> SetSmtpConfiguration sets SMTP Configuration for <>. The level at which the policy needs to be created within the EASE hierarchy. Inherit configuration 0 inherit configuration FALSE 1 inherit configuration TRUE enable/disable 0 enable 1 - disable smtpserver SMTP server or IP address. smtpdomain Domain for SMTP server. senderaddress address to be set in To field of message. senderpassword Password for the sender s address. (SMTP) configuration set successfully or a text message describing the error encountered. Copyright by NTP Software. All rights reserved. Page 34

38 Command Line Interface SetFileRemovalCriteria <> <> <durationtype> <duration> <deletepreexisting> SetFileRemovalCriteria sets file removal criteria for file removal policy. The of the policy. durationtype 0 Hours 1 Days 2 Weeks 3 Months duration Duration value. It should be greater than 0 and less than deletepreexisting 0 Do not delete exiting files. 1 Delete existing files. File removal criteria successfully set for the policy <> or a text message describing the error encountered. The policy must be surrounded by double quotes if it contains a space. SetQuotaDenyWriteLevel <> <> <level> SetQuotaDenyWriteLevel Sets the Deny Writes at: Quota Limit Property. The of the file removal policy to add. Level The % Level to Deny Writes. Must be between Quota Deny Write Level for policy <policy> successfully set to <level>. The policy must be surrounded by double quotes if it contains a space. Copyright by NTP Software. All rights reserved. Page 35

39 Command Line Interface AddRecipientThreshold <> <> <thresholdvalue> <thresholdtype> <abovesubject> <abovemessage> <above > <belowsubject> <belowmessage> <below > AddRecipientThreshold adds recipient threshold for the given policy. The of the policy. thresholdvalue Threshold value when the threshold is triggered. thresholdltype 1 notification 2 User pop-up abovesubject Subject of notification message shows user has reached threshold. abovemessage Body of notification message shows user has reached threshold. above Body of notification message shows user has reached threshold. belowsubject Subject of notification message shown user has gone below threshold. belowmessage Body of notification message shown user has gone below threshold. below Body of notification message shown user has gone below threshold. Recipient threshold successfully added to the policy <> or a text message describing the error encountered. The policy must be surrounded by double quotes if it contains a space. The threshold value should be greater than 0. Enclose all messaging parameters in double quotes. It is very important that you specify all the parameters for messages. If you don t want to set any particular message, specify an empty value enclosed in double quotes. Copyright by NTP Software. All rights reserved. Page 36

40 Install in Cluster Environment Appendix 1: Installing QFS in Clustered Environments Installing NTP Software QFS in a Clustered Environment 1. Install NTP Software Quota & File Sentinel on a server per NTP Software Document #5647EF Quota & File Sentinel Quick Start and Evaluation Guide. 2. After Quota & File Sentinel is successfully installed Open QFS to find a. The Global Container at the top of the hierarchy (Galactic Getaways) b. Your Site Container in the second tier of the hierarchy (New Hampshire) c. The Installation Server in the third tier (Primary Server) d. The Quota & File Sentinel Application itself, also in the third tier 3. Right click on the Site Container (New Hampshire), select New and then Container to create your Cluster container. Give the new container the of the Cluster. In our example we ve used Cluster 1. Copyright by NTP Software. All rights reserved. Page 37

41 Install in Cluster Environment 4. Right click on the Cluster Container (Cluster 1) and select Add and Quota & File Sentinel Application. 5. To initiate the push installation of NTP Software Quota & File Sentinel to the node servers right click on the Cluster Container and select Add and then Server. You will then have the ability to select or manually enter each existing node server. 6. Click on the next to the Quota & File Sentinel Application you ve just added to view the Global (Cluster) policies. Create all policies within this application that will be applied to both nodes and they will automatically be propagated down to all nodes within the container. In the following example the Global 100MB policy is propagated and the replicated policies are denoted by the green E on the icon within both nodes. Copyright by NTP Software. All rights reserved. Page 38

42 Install in Cluster Environment Installing NTP Software QFS onto a Node Server The Best Practice method of installing QFS into a Cluster environment is to perform the first installation on a stand-alone server and then push the installation onto the Cluster Nodes using the Ease technology. If the first installation must be done directly onto a Node (see image below) you can simply create a Cluster Container and then drag the Node Server into it and create your policies as noted. 1. Right click on the Site Container and select Add, then Container to create a container for the cluster. Give the new container the cluster. Copyright by NTP Software. All rights reserved. Page 39

43 Install in Cluster Environment 2. Click on the existing Server (Node) and while holding down the mouse button drag and drop it on the Cluster Container. This will move the Server into the Cluster hierarchy. 3. Right click on the Cluster Container and select Add, then Quota & File Sentinel Application. 4. To push NTP Software Quota & File Sentinel to each additional node right click on the Cluster Container and select Add, then Server. You will be asked to verify that you want to push the installation to the server. Copyright by NTP Software. All rights reserved. Page 40

44 Install in Cluster Environment 5. Click on the next to the Quota & File Sentinel Application you ve just added to view the Global (Cluster) policies. Create all policies within this application that will be applied to both nodes and they will automatically be propagated down to all nodes within the container. In the following example the Global 100MB policy is propagated and the replicated policies are denoted by the green E on the icon within both nodes Copyright by NTP Software. All rights reserved. Page 41