McAfee Content Security Reporter Installation Guide. (McAfee epolicy Orchestrator)

Transcription

1 McAfee Content Security Reporter Installation Guide (McAfee epolicy Orchestrator)

2 COPYRIGHT Copyright 2018 McAfee, LLC TRADEMARK ATTRIBUTIONS McAfee and the McAfee logo, McAfee Active Protection, epolicy Orchestrator, McAfee epo, McAfee EMM, Foundstone, McAfee LiveSafe, McAfee QuickClean, Safe Eyes, McAfee SECURE, SecureOS, McAfee Shredder, SiteAdvisor, McAfee Stinger, True Key, TrustedSource, VirusScan are trademarks or registered trademarks of McAfee, LLC or its subsidiaries in the US and other countries. Other marks and brands may be claimed as the property of others. LICENSE INFORMATION License Agreement NOTICE TO ALL USERS: CAREFULLY READ THE APPROPRIATE LEGAL AGREEMENT CORRESPONDING TO THE LICENSE YOU PURCHASED, WHICH SETS FORTH THE GENERAL TERMS AND CONDITIONS FOR THE USE OF THE LICENSED SOFTWARE. IF YOU DO NOT KNOW WHICH TYPE OF LICENSE YOU HAVE ACQUIRED, PLEASE CONSULT THE SALES AND OTHER RELATED LICENSE GRANT OR PURCHASE ORDER DOCUMENTS THAT ACCOMPANY YOUR SOFTWARE PACKAGING OR THAT YOU HAVE RECEIVED SEPARATELY AS PART OF THE PURCHASE (AS A BOOKLET, A FILE ON THE PRODUCT CD, OR A FILE AVAILABLE ON THE WEBSITE FROM WHICH YOU DOWNLOADED THE SOFTWARE PACKAGE). IF YOU DO NOT AGREE TO ALL OF THE TERMS SET FORTH IN THE AGREEMENT, DO NOT INSTALL THE SOFTWARE. IF APPLICABLE, YOU MAY RETURN THE PRODUCT TO MCAFEE OR THE PLACE OF PURCHASE FOR A FULL REFUND. 2 McAfee Content Security Reporter Installation Guide

3 Contents 1 About this guide 5 Download the files Install the software Register the report server Select a database Configure a log source Configure a query Run a report Setup 9 Requirements Download and install the product files Install the extension Register the report server Upgrade Content Security Reporter 13 Back up the current configuration Upgrade the software Update the database schema Uninstall Content Security Reporter 15 Remove the report server Remove the extensions Remove the software Index 17 McAfee Content Security Reporter Installation Guide 3

4 Contents 4 McAfee Content Security Reporter Installation Guide

5 1 About 1 this guide This guide provides high-level instructions for setting up McAfee Content Security Reporter (Content Security Reporter). For detailed instructions, refer to the Content Security Reporter Product Guide. Contents Download the files Install the software Register the report server Select a database Configure a log source Configure a query Run a report Download the files To download the Content Security Reporter documentation and installation files, go to the McAfee Security site. 1 Go to the McAfee Security ServicePortal. 2 Download the documentation. a Click Knowledge Center. b c d In the Product field, enter Content Security Reporter. From the Version drop-down list, select the version, then click Search. Open the Content Security Reporter Product Guide. 3 Download the product files. a Click the Downloads tab, then click Product Downloads. b c d Under Product Downloads, click Download. Enter your grant number, the letters or numbers displayed, then click Submit. Locate and download these Content Security Reporter files: Installation executable file for your operating system Content Security Reporter Help extension.zip file McAfee Content Security Reporter Installation Guide 5

6 1 About this guide Install the software Install the software Install the Content Security Reporter software on your computer. 1 As an administrator, log on to the operating system. 2 Run the installation executable file you downloaded, then follow the on-screen prompts. Register the report server Register the report server with McAfee epo. 1 Select Menu Configuration Registered Servers, then click New Server. 2 From the Server type drop-down list, select Report Server. 3 Enter the server name, then click Next. 4 Configure the remaining available options, then click Test Connection. 5 If the connection is successful, click Save. Select a database Use the configured internal database, or configure Content Security Reporter to use a supported external database. 1 Select Menu Configuration Report Server Settings. 2 From the Setting Categories menu, select Database, then click Edit. 3 In the Configuration section, choose one of these options: Select Default internal database. Select This external database, select the database type from the drop-down list, then configure the database settings. 4 Click Save. Configure a log source To collect your network data, configure a log source. 1 Select Menu Configuration Report Server Settings. 2 From the Setting Categories menu, select Log Sources. 6 McAfee Content Security Reporter Installation Guide

7 About this guide Configure a query 1 3 From the Actions menu, select New. 4 Enter the log source name, configure the remaining options, then click OK. Configure a query To select the data that appears in your reports, configure a query. 1 Select Queries & Reports Query. 2 Click New Query. 3 From the Database Type drop-down list, select Content Security Reporter. 4 Select the feature group and result type, then click Next. 5 Configure the remaining options, then click Run. 6 To save the query, click Save. Run a report To view your organization's data, run a report. 1 Select Queries & Reports Report. 2 Click New Report. 3 From the Toolbox menu, click and drag the Query type to the Report Layout configuration area. 4 Configure the remaining options, click OK, then click Run. McAfee Content Security Reporter Installation Guide 7

8 1 About this guide Run a report 8 McAfee Content Security Reporter Installation Guide

9 2 Setup 2 To set up Content Security Reporter, download the Content Security Reporter installation files, then install the extension and register the report server using McAfee epolicy Orchestrator (McAfee epo ). Contents Requirements Download and install the product files Install the extension Register the report server Requirements Verify that your computer and software meet the minimum requirements. There are no license restrictions to install Content Security Reporter. Download and install the product files Download the Content Security Reporterproduct files from the McAfee Security Downloads page, then install them on your computer and McAfee epo. 1 As an administrator, log on to your computer. 2 Make sure that McAfee epo is installed and running correctly. 3 Download the product files. a Go to the McAfee Security Downloads page. b c Enter your Grant Number, the letters or numbers displayed, then click Submit. Select and save these Content Security Reporter files for your operating system: Installation executable file appropriate for your computer Extension.zip file for McAfee epo 4 Install the software on the same computer as McAfee epo or on a separate computer that can communicate with McAfee epo. During installation, McAfee epo can be active. McAfee Content Security Reporter Installation Guide 9

10 2 Setup Install the extension If you use two computers, additional configuration might be necessary to ensure that the computers can communicate through any firewall. a Run the installation executable file. b c Follow the on-screen prompts. When prompted, enter a passkey. Best practice: Use a strong passkey: Minimum of eight characters No spaces Case sensitive Mix of uppercase, lowercase, numeric, and special characters 5 Install the McAfee epo extension.zip file. a Log on to McAfee epo. b c Select Menu Software Extensions, then click Install Extension. Browse to the extension.zip file, then click OK. Install the extension Install the Content Security Reporter extension.zip file so it is available in McAfee epolicy Orchestrator (McAfee epo ). 1 Log on to the McAfee epo server as an administrator. 2 Select Menu Software Extensions, then click Install Extension. 3 Browse to the extension.zip file, then click OK. Register the report server Register the report server with Content Security Reporter. 1 Log on to McAfee epo, then select Menu Configuration Registered Servers. 2 Click New Server. 3 From the Server type drop-down list, select Report Server. 4 Type a name for the server, or the IP address of the computer Content Security Reporter is installed on, then click Next. 5 Enter the server port, then enter the passkey you used during installation. 10 McAfee Content Security Reporter Installation Guide

11 Setup Register the report server 2 6 Click Test Settings. 7 Click Save. The report and database servers appear on the Registered Servers list. McAfee Content Security Reporter Installation Guide 11

12 2 Setup Register the report server 12 McAfee Content Security Reporter Installation Guide

13 3 Upgrade 3 Content Security Reporter Upgrade to the latest version of the software. Contents Back up the current configuration Upgrade the software Update the database schema Back up the current configuration Back up the system settings so you can restore them after upgrading the software. 1 Select Menu Configuration Reporter Server Settings System Backup. 2 From the Setting Categories menu, select System Backup. 3 From the Actions menu, select Backup Now. 4 When the System Backup message appears, click OK. The backup process can take several minutes. A backup folder is created where is the time stamp. By default this folder is created in C:\Program Files\McAfee\Content Security Reporter\reporter \conf\. A backup.xml file is saved in the backup folder. To create a backup file, wait until the file is created, then continue working without restoring it. Content Security Reporter includes the following settings in the backup file. Settings Database connection settings Description Saves the configuration settings that allow Content Security Reporter to communicate with the database. Database maintenance settings Saves scheduled database maintenance job settings and status messages. General settings Performance settings System status message Saves log source configuration and browse time settings. Saves database and system performance settings. Saves log parsing job history and database maintenance settings. If you plan to use the backup file after you uninstall and re-install Content Security Reporter, save the backup file to a location other than the Content Security Reporter installation directory. McAfee Content Security Reporter Installation Guide 13

14 3 Upgrade Content Security Reporter Upgrade the software Upgrade the software Upgrade Content Security Reporter to the latest version. 1 Download the product files. a Start McAfee epo. b c d Go to the McAfee Product Downloads page. Under Download My Products, enter your grant number and click Go. Download the Content Security Reporter installation executable and extension.zip files. 2 Upgrade the Content Security Reporter server. McAfee epo can be active during this installation. a b c Log on to the operating system as an administrator. Run the installation executable file you downloaded. Follow the on-screen prompts to complete the installation. 3 Upgrade the extension. a In McAfee epo, select Menu Software Extensions. b c Click Install Extension. Browse to the Content Security Reporter Help.zip file, then click OK. A message appears with the extensions installed or upgraded as part of the Content Security Reporter extension pack. Update the database schema Update the database schema after upgrading the software. The database schema is the definition of tables and fields used in the Content Security Reporter database. When Content Security Reporter detects that the database schema is out of date (such as after an upgrade), the database status is set to Offline. Schema is out of date. and an Update Schema button is provided. Depending on the size of your database, the database schema update can take a long time. 1 Select Menu Configuration Report Server Settings Database. 2 Click Update Schema. The database status appears as Connected. 14 McAfee Content Security Reporter Installation Guide

15 4 Uninstall 4 Content Security Reporter Use McAfee epo to uninstall the Content Security Reporter extensions. Use the Microsoft Windows Control Panel to remove the report server software. To remove Content Security Reporter, you must have administrator access rights. Contents Remove the report server Remove the extensions Remove the software Remove the report server Remove the Content Security Reporter report server from epolicy Orchestrator. 1 Select Menu Configuration Registered Servers. 2 Click Report Server, and select your configured server. 3 From the Action drop-down list, and select Delete. The configured report server is removed from the Registered Servers list. Remove the extensions Uninstall the Content Security Reporter extensions from epolicy Orchestrator. The Catalog Framework and Core catalog extensions are installed with Content Security Reporter, but might be in use by other products. You can choose to remove these extensions from McAfee Common Catalog. 1 Select Menu Software Extensions McAfee. 2 Select Help Content, then remove these extensions: mcc_help csr_help 3 Select Reporting, then remove the McAfee Content Security Reporter extension. McAfee Content Security Reporter Installation Guide 15

16 4 Uninstall Content Security Reporter Remove the software 4 Select Shared Components, then remove these extensions: Analytics Common Catalog Plugin Remove the software Uninstall the Content Security Reporter report server software. Before you begin To remove Content Security Reporter, you must have administrator access rights. 1 In the Microsoft Windows Control Panel, select Programs and Features. You do not need to log off McAfee epo to remove the Content Security Reporter software. 2 Select McAfee Content Security Reporter, and click Remove. 16 McAfee Content Security Reporter Installation Guide

17 Index A analytics extension install 9, 10 I installation software 9 B backup current configuration 13 backup folder 13 C Common Catalog plugin install 9, 10 Content Security Reporter backup configuration 13 download product files 9 install extensions 9, 10 install software 9 register 10 remove extensions 15 remove software 16 report server 15 system backup 13 update database schema 14 upgrade software 14 D database schema update 14 E extensions install 9, 10 remove 15 H help content extension install 9, 10 Help Content extension remove 15 P permissions remove extensions 15 remove software 16 R Registered Server Builder 10 remove Content Security Reporter 15 overview 15 extensions 15 report server 15 software 16 report server register 10 remove 15, 16 remove extensions 15 reporting extension install 9, 10 Reporting extension remove 15 S saved configuration settings system backup 13 software remove 16 upgrade 14 system backup Content Security Reporter 13 system settings backup 13 T troubleshooting back up configuration 13 McAfee Content Security Reporter Installation Guide 17

18 Index U uninstall Content Security Reporter overview 15 extensions 15 software 16 update Content Security Reporter 14 update (continued) database schema 14 upgrade Content Security Reporter 13, 14 overview 13 software McAfee Content Security Reporter Installation Guide

19 0-00