Using the Content Management Tool

(1)

Juniper Networks, Inc.

1194 North Mathilda Avenue Sunnyvale, CA 94089 USA

408-745-2000

www.juniper.net

Published: 2013-03-15

Security Threat Response Manager

Using the Content Management Tool

(2)

2

Copyright Notice

Juniper Networks, Junos, Steel-Belted Radius, NetScreen, and ScreenOS are registered trademarks of Juniper Networks, Inc. in the United States and other countries. The Juniper Networks Logo, the Junos logo, and JunosE are trademarks of Juniper Networks, Inc.

The following terms are trademarks or registered trademarks of other companies:

JavaTM and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle and/or its affiliates.

All other trademarks, service marks, registered trademarks, or registered service marks are the property of their respective owners.

All specifications are subject to change without notice. Juniper Networks assumes no responsibility for any inaccuracies in this document or for any obligation to update information in this document. Juniper Networks reserves the right to change, modify, transfer, or otherwise revise this publication without notice.

FCC Statement

The following information is for FCC compliance of Class A devices: This equipment has been tested and found to comply with the limits for a Class A digital device, pursuant to part 15 of the FCC rules. These limits are designed to provide reasonable protection against harmful interference when the equipment is operated in a commercial environment. The equipment generates, uses, and can radiate radio-frequency energy and, if not installed and used in accordance with the instruction manual, may cause harmful interference to radio communications. Operation of this equipment in a residential area is likely to cause harmful interference, in which case users will be required to correct the interference at their own expense. The following information is for FCC compliance of Class B devices: The equipment described in this manual generates and may radiate radio-frequency energy. If it is not installed in accordance with Juniper Networks’ installation instructions, it may cause interference with radio and television reception. This equipment has been tested and found to comply with the limits for a Class B digital device in accordance with the specifications in part 15 of the FCC rules. These specifications are designed to provide reasonable protection against such interference in a residential installation. However, there is no guarantee that interference will not occur in a particular installation. If this equipment does cause harmful interference to radio or television reception, which can be determined by turning the equipment off and on, the user is encouraged to try to correct the interference by one or more of the following measures: Reorient or relocate the receiving antenna. Increase the separation between the equipment and receiver. Consult the dealer or an experienced radio/TV technician for help. Connect the equipment to an outlet on a circuit different from that to which the receiver is connected. Caution: Changes or modifications to this product could void the user's warranty and authority to operate this device.

Disclaimer

THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT, SUBJECT TO THE MODIFICTAIONS SET FORTH BELOW ON THIS PAGE, ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR JUNIPER NETWORKS REPRESENTATIVE FOR A COPY.

Using the Content Management Tool

Release 2013.1

March 2013—Using the Content Management Tool

The information in this document is current as of the date listed in the revision history.

END USER LICENSE AGREEMENT

The Juniper Networks product that is the subject of this technical documentation consists of (or is intended for use with) Juniper Networks software. Use of such software is subject to the terms and conditions of the End User License Agreement (“EULA”) posted at http://www.juniper.net/support/eula.html, as modified by the following text, which shall be treated under the EULA as an Entitlement Document taking precedence over any conflicting provisions of such EULA as regards such software:

As regards software accompanying the STRM products (the “Program”), such software contains software licensed by Q1 Labs and is further accompanied by third-party software that is described in the applicable documentation or materials provided by Juniper Networks.

(3)

3 For the convenience of Licensee, the Program may be accompanied by a third party operating system. The operating system is not part of the Program,

and is licensed directly by the operating system provider (e.g., Red Hat Inc., Novell Inc., etc.) to Licensee. Neither Juniper Networks nor Q1 Labs is a party to the license between Licensee and the third party operating system provider, and the Program includes the third party operating system “AS IS”, without representation or warranty, express or implied, including any implied warranty of merchantability, fitness for a particular purpose or

non-infringement. For an installed Red Hat operating system, see the license file: /usr/share/doc/redhat-release-server-6Server/EULA. By downloading, installing or using such software, you agree to the terms and conditions of that EULA as so modified.

(4)

(5)

C

ONTENTS

1 U

SINGTHE

C

ONTENT

M

ANAGEMENT

T

OOL

CMT Overview . . . 7

Exporting All Custom Content . . . 8

Exporting All Custom Content of a Specific Type. . . 8

Exporting Single Custom Content Item . . . 9

(6)

(7)

1

U

SING

THE

C

ONTENT

M

ANAGEMENT

T

OOL

Using the Content Management Tool (CMT), you can export security and configuration content into an external, portable format. You can import the exported content into the same system you exported from or into another STRM system.

This technical note includes the following topics:

• CMT Overview

• Exporting All Custom Content

• Exporting All Custom Content of a Specific Type

• Exporting Single Custom Content Item

• Importing Content

CMT Overview

This technical note is intended for use by Juniper Customer Support, Professional Services, and select customers who have advanced STRM knowledge and experience working with PostgreSQL databases.

Using the CMT, you can export and import the following content:

• Dashboards

• Reports

• Saved Searches

• Reference Sets

• Custom and Calculated Properties

• Custom Rules and Building Blocks

• Groups

• Log Sources

When importing and exporting custom content, the CMT considers content dependencies, and then includes associated content in the import or export. For example, when the CMT detects that a custom report is associated with custom saved searches, the custom saved searches are also exported.

(8)

8 USINGTHE CONTENT MANAGEMENT TOOL

Exporting All

Custom Content

To export all custom content:

Step 1 Using SSH, log in to STRM as the root user: Username: root

Password: <password>

Step 2 To access the /opt/qradar/bin directory, type the following command:

cd /opt/qradar/bin

Step 3 Choose one of the following options:

• To export all content that excludes accumulated data, type the following command:

./content_management.sh <directory_path> export all

• To export saved searches that includes accumulated data, type the following command:

./content_management.sh <directory_path> export all gv

Where <directory_path> is the directory to which you want to export content. This parameter is optional, but recommended. If you omit the <directory_path>

parameter, the content is exported to the default directory, which is

/store/tmp/cmt/out. The /store/tmp/cmt/out directory is deleted nightly during scheduled maintenance.

The exported content is compressed to a .tar.gz file and exported to the specified directory. The following is an example of a .tar.gz file name:

report-ContentExport-20120419101803.tar.gz. You can manually change

the name of the exported file, if required.

Exporting All

Custom Content of

a Specific Type

To export all custom content of a specific type:

• To export specific content that excludes accumulated data, type the following command:

./content_management.sh <directory_path> export <content_type> all

(9)

Exporting Single Custom Content Item 9

• To export specific content that includes accumulated data, type the following command:

./content_management.sh <directory_path> export <content_type> all gv

Where:

• <directory_path> - Specifies the directory to which you want to export content. This parameter is optional, but recommended. If you omit the

<directory_path> parameter, the content is exported to the default directory, which is /store/tmp/cmt/out. The /store/tmp/cmt/out directory is deleted nightly during scheduled maintenance.

• <content_type> - Specifies the type of content you want to import or export. You can type the content type as a text string or type the corresponding numeric identifier. Use the following table as a guide:

The exported content is compressed to a .tar.gz file and exported to the specified directory. You can manually change the name of the exported file, if required.

Exporting Single

Custom Content

Item

You can export a single custom content item, such as a custom rule or a custom search criteria.

To export a single custom content item:

Table 1-1 Content Types Custom Content

Type Text String Numeric Identifier

Dashboard dashboard 4

Reports report 10

Saved Searches search 1

FGroup fgroup 12

FGroup Type fgrouptype 13

Custom Rules customrule 3

Reference Sets referenceset 5

Custom Properties customproperty 6

Log Source sensordevice 17

Log Source Type sensordevicetype 24

(10)

10 USINGTHE CONTENT MANAGEMENT TOOL

• To export single custom content that excludes accumulated data, type the following command:

./content_management.sh <directory_path> export <content_type> <string_ID_value>

• To export single custom content that includes accumulated data, type the following command:

./content_management.sh <directory_path> export <content_type> <string_ID_value> gv

Where:

• <directory_path> - Specifies the directory to which you want to export content. This parameter is optional, but recommended. If you omit the

<directory_path> parameter, the content is exported to the default directory, which is /store/tmp/cmt/out. The /store/tmp/cmt/out directory is deleted nightly during scheduled maintenance.

• <import | export> - Specifies whether you want to import or export the specified custom content.

• <content_type> - Specifies the type of content you want to import or export. You can type the content type as a text string or type the corresponding numeric identifier. Use Table 1-1 as a guide.

• <string_ID_value> - Specifies the identifier for the specific instance of custom content, such as a single report or a single reference set. You can locate the string_ID_value by querying the PostgreSQL database. This technical note assumes that you have experience with PostgreSQL and does not provide instructions for how to query the database.

The exported content is compressed to a .tar.gz file and exported to the specified directory. You can manually change the name of the exported file, if required.

Importing Content

After you export custom content, you can import the exported content into the same STRM system you exported from or another STRM system. If you want to import the content into another STRM system, you must transfer the output file to the other system before proceeding with this procedure.

To import previously exported content:

(11)

Importing Content 11

Step 3 Access the directory where you exported the content file to. Type the following commands:

cd <directory_name>

Where <directory_name> is the name of the directory you specified when exporting the content or the default /store/tmp/cmt/out if you did not specify a directory.

Step 4 To list the files located in the directory, type the following command:

ls

The output of this command may resemble the following:

drwxr-xr-x 2 root root 24576 Apr 18 16:39 fgroup-ContentExport-20120418163707

-rw-r-r- 1 root root 324596 Apr 18 16:39 fgroup-ContentExport-20120418163707.tar.gz drwxr-xr-x 2 root root 4096 Apr 18 16:56 report-ContentExport-20120418165529

-rw-r-r- 1 root root 42438 Apr 18 16:56 report-ContentExport-20120418165529.tar.gz drwxr-xr-x 2 root root 4096 Apr 19 10:18 report-ContentExport-20120419101803

-rw-r-r- 1 root root 3295 Apr 19 10:18

report-ContentExport-20120419101803.tar.gz

In this example, report-ContentExport-20120419101803.tar.gz is an export file name.

CAUTION

If you manually uncompressed the .tar.gz file while the file is located in the default or custom export directory, you must move the extracted files and directories to another location before importing the tar.gz file.

Step 5 Type the following command:

/opt/qradar/bin/content_management.sh <directory_name> import <export_file_name>

Where:

• <directory_name> - Specifies the name of the directory you specified when exporting the content or the default /store/tmp/cmt/out if you did not specify a directory.

(12)

Importing Content 12

For example:

./content_management.sh import

report-ContentExport-20120419101803.tar.gz

The content you imported is now uncompressed and available on your STRM system.