b Tga Getting Started Guide
b Tga Getting Started Guide
Version 2.19
First Published: 2020-12-15
Last Modified: 2024-09-06
Americas Headquarters
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
USA
http://www.cisco.com
Tel: 408 526-4000
800 553-NETS (6387)
Fax: 408 527-0883
THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS,
INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.
THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT 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 CISCO REPRESENTATIVE FOR A COPY.
The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB's public domain version of
the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California.
NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS" WITH ALL FAULTS.
CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE.
IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT
LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS
HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network
topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional
and coincidental.
All printed copies and duplicate soft copies of this document are considered uncontrolled. See the current online version for the latest version.
Cisco has more than 200 offices worldwide. Addresses and phone numbers are listed on the Cisco website at www.cisco.com/go/offices.
Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL:
https://www.cisco.com/c/en/us/about/legal/trademarks.html. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a
partnership relationship between Cisco and any other company. (1721R)
© 2020 –2024 Cisco Systems, Inc. All rights reserved.
CONTENTS
CHAPTER 1 Introduction 1
About Cisco Secure Malware Analytics Appliance 1
Audience 2
Assumptions 2
Product Documentation 2
What's New In This Release 3
Supported Browsers 3
Updates 3
Support 3
Setup and Configuration Overview 6
Introduction 11
Log In to the Admin UI 12
Change Admin Password 13
Review End User License Agreement 13
Configuration Wizard 14
Home 15
Configure Network Settings 15
Configure NFS 16
Configure Clustering 17
Configuring First Cluster Node 18
Cisco Secure Malware Analytics Appliance Getting Started Guide Version 2.19
iii
Contents
Cisco Secure Malware Analytics Appliance Getting Started Guide Version 2.19
iv
CHAPTER 1
Introduction
This chapter provides a brief description of the Cisco Secure Malware Analytics Appliance, the intended
audience and how to access relevant product documentation. It includes the following:
• About Cisco Secure Malware Analytics Appliance, on page 1
• Audience, on page 2
• Assumptions, on page 2
• Product Documentation, on page 2
• What's New In This Release, on page 3
• Supported Browsers, on page 3
• Updates, on page 3
• Support, on page 3
• Setup and Configuration Overview, on page 6
Note Cisco UCS C220 M4 (TG5400) servers are still supported for Secure Malware Analytics Appliance but the
servers are end of life. See the Server Setup chapter in the Cisco Secure Malware Analytics Appliance Setup
and Configuration Guide (v2.7 and earlier) for instructions.
Many organizations that handle sensitive data, such as banks and health services, must follow various regulatory
rules and guidelines that do not allow certain types of files, such as malware artifacts, to be sent outside of
the network for malware analysis. By maintaining a Cisco Secure Malware Analytics Appliance on-premises,
organizations can send suspicious documents and files to it to be analyzed without leaving the network.
With a Secure Malware Analytics Appliance, security teams can analyze all samples using proprietary and
highly secure static and dynamic analysis techniques. The appliance correlates the analysis results with
hundreds of millions of previously analyzed malware artifacts, to provide a global view of malware attacks
and campaigns, and their distributions. A single sample of observed activity and characteristics can quickly
Cisco Secure Malware Analytics Appliance Getting Started Guide Version 2.19
1
Introduction
Audience
be correlated against millions of other samples to fully understand its behaviors within an historical and global
context. This ability helps security teams to effectively defend the organization against threats and attacks
from advanced malware.
Audience
Before a new appliance can be used for malware analysis, it must be set up and configured for the organization's
network. This guide is intended for the security team IT staff tasked with setting up and configuring a new
Secure Malware Analytics Appliance.
This document describes how to complete the initial setup and configuration for a new Secure Malware
Analytics Appliance, up to the point where malware samples can be submitted to it for analysis.
Assumptions
It is assumed that you have gathered the necessary information and completed the planning steps as described
in the Cisco Secure Malware Analytics Appliance Administration Guide.
It is also assumed that you have already set up the Secure Malware Analytics Appliance based on the instructions
in the Cisco Secure Malware Analytics M5 Hardware Installation Guide.
If you have not yet completed these two tasks, do so before you begin the steps described in this Getting
Started Guide.
Product Documentation
The latest versions of Cisco Secure Malware Analytics Appliance product documentation is found on Cisco.com:
• Cisco Secure Malware Analytics Appliance Release Notes
• Cisco Secure Malware Analytics Version Lookup Table
• Cisco Secure Malware Analytics Appliance Administration Guide
• Cisco Secure Malware Analytics M5 Hardware Installation Guide
Note Prior versions of Cisco Secure Malware Analytics Appliance product documentation is found at Secure
Malware Analytics Install and Upgrade.
Cisco Secure Malware Analytics Appliance Getting Started Guide Version 2.19
2
Introduction
What's New In This Release
Supported Browsers
Secure Malware Analytics supports the following browsers:
• Google Chrome™
• Mozilla Firefox®
• Apple Safari®
Updates
The initial Secure Malware Analytics Appliance setup and configuration steps must be completed before
installing any Secure Malware Analytics Appliance updates. We recommend that you check for updates
immediately after completing the initial configuration (see Install Secure Malware Analytics Appliance
Updates).
Secure Malware Analytics Appliance updates cannot be downloaded until the license is installed, and the
update process requires that the initial appliance configuration is completed. Updates must be done in sequence.
Support
If you have questions or require assistance with Secure Malware Analytics, open a Support Case at
https://mycase.cloudapps.cisco.com/case.
Cisco Secure Malware Analytics Appliance Getting Started Guide Version 2.19
3
Introduction
Support
Step 1 In Support Case Manager, click Open New Case > Open Case.
Figure 1: Open New Case
Step 2 Click the Ask a Question radio button and search for your Cisco Security Product Serial Number or Product Service
Contract. This should be the serial number or service contract for Secure Malware Analytics.
Figure 2: Check Entitlement
Step 3 On the Describe Problem page, enter a Title and Description of the problem (mention Secure Malware Analytics
Appliance in the title).
Cisco Secure Malware Analytics Appliance Getting Started Guide Version 2.19
4
Introduction
Support
Step 4 Click Manually select a Technology and search for Secure Malware Analytics.
Figure 3: Select Technology
Step 5 Choose Cisco Secure Malware Analytics Appliance from the list and click Select.
Step 6 Complete the remainder of the form and click Submit.
If you are unable to open a case online, contact Cisco Support:
• US and Canada: 1-800-553-2447
• Worldwide Contacts: https://www.cisco.com/c/en/us/support/web/tsd-cisco-worldwide-contacts.html
Cisco Secure Malware Analytics Appliance Getting Started Guide Version 2.19
5
Introduction
Setup and Configuration Overview
• See the main Cisco Support & Downloads page at: https://www.cisco.com/c/en/us/support/index.html
Additional tasks that require administrator configuration (such as license installation, email server, and SSL
certificates) are documented in the Cisco Secure Malware Analytics Appliance Administration Guide.
Cisco Secure Malware Analytics Appliance Getting Started Guide Version 2.19
6
CHAPTER 2
Initial Network Configuration
This chapter provides instructions for completing the initial network configuration using the Admin TUI
(Text-mode UI). It includes the following topics:
• Power On and Boot Up Appliance, on page 7
• Configure Network Using Admin TUI, on page 8
The Admin TUI is displayed on the console when the server has successfully booted up and connected.
Cisco Secure Malware Analytics Appliance Getting Started Guide Version 2.19
7
Initial Network Configuration
Configure Network Using Admin TUI
The Admin URL shows as unavailable because the network interface connections are not yet configured and
the Admin UI cannot be reached yet to perform this task.
Important The Admin TUI displays the initial administrator Password, which will be needed to access and configure
the Admin UI later in the configuration. Make a note of the Password in a separate text file (copy and paste).
Note For DHCP users, the following steps assume that you are using static IP addresses. If you are using DHCP
to obtain your IP addresses, see the Cisco Secure Malware Analytics Appliance Administration Guide.
Step 1 On the Admin TUI, select NETWORK. The Status: configuration current screen appears.
Cisco Secure Malware Analytics Appliance Getting Started Guide Version 2.19
8
Initial Network Configuration
Configure Network Using Admin TUI
Step 2 Select Clean. The Network Config - CLEAN Interface screen appears.
Step 3 Complete the blank fields according to the settings provided by your network administrator.
Step 4 Select Save.
Step 5 Select Dirty. The Network Config - Dirty Interface Interface screen appears.
Step 6 Complete the blank fields according to the settings provided by your network administrator.
Step 7 Select Save.
Step 8 Select Admin. The Network Config - ADMIN Interface Interface screen appears.
Step 9 Complete the blank fields according to the settings provided by your network administrator.
Step 10 Select Save.
Step 11 Select Activate. To activate the configuration.
What to do next
The next step in the Secure Malware Analytics Appliance setup is to complete the remaining configuration
tasks using the Admin UI, as described in Admin UI Configuration.
Cisco Secure Malware Analytics Appliance Getting Started Guide Version 2.19
9
Initial Network Configuration
Configure Network Using Admin TUI
Cisco Secure Malware Analytics Appliance Getting Started Guide Version 2.19
10
CHAPTER 3
Admin UI Configuration
This chapter provides instructions for configuring your appliance using the Admin UI. It includes the following
topics:
• Introduction, on page 11
• Configuration Wizard, on page 14
• Install Secure Malware Analytics Appliance Updates, on page 27
• Test the Appliance Setup, on page 28
Introduction
The Admin UI is the recommended tool for administrators to use to configure the Secure Malware Analytics
Appliance. It is a Web user interface that can be used once an IP address has been configured on the Admin
interface.
The configuration includes the following steps:
• Change Admin UI Admin Password
• Review End User License Agreement
• Configure Network Settings
• Install License
• Configure NFS
• Configure Clustering
• Configure Email
• Configure Notifications
• Configure Date and Time
• Configure System Log
• Review and Install Configuration Settings
Cisco Secure Malware Analytics Appliance Getting Started Guide Version 2.19
11
Admin UI Configuration
Log In to the Admin UI
Note Not all configuration steps are completed using the configuration wizard. See the Cisco Secure Malware
Analytics Appliance Administration Guide for configuring settings not included in the wizard, such as SSL
Certificates and Backups.
Important The steps in the following sections should be completed in one session to reduce the chance of an interruption
to the IP address during configuration.
Step 1 In a browser, enter the URL for the Admin UI (https://<adminIP>/ or https://<adminHostname>/) to open the Secure
Malware Analytics Admin UI login screen.
Note The Hostname is the appliance serial number.
Step 2 Enter the initial Admin Password that you copied from the Admin TUI and click Log In.
Cisco Secure Malware Analytics Appliance Getting Started Guide Version 2.19
12
Admin UI Configuration
Change Admin Password
What to do next
Proceed to Change Admin Password.
Step 1 Enter the old password from the Admin TUI in the Current Password field. (You should have this password saved in
a text file.)
Step 2 Enter a New Password and re-enter it in the Confirm New Password field.
The new password must contain the following: 8 characters minimum, one number, one special character, at least one
uppercase and one lowercase character.
What to do next
Proceed to Review End User License Agreement.
Cisco Secure Malware Analytics Appliance Getting Started Guide Version 2.19
13
Admin UI Configuration
Configuration Wizard
What to do next
Proceed to Configure Network Settings.
Configuration Wizard
The Configuration wizard takes you through configuring your Secure Malware Analytics Appliance.
If you need to make changes after you have completed the wizard configuration, you can access the settings
from the Configuration tab in the Admin UI.
Cisco Secure Malware Analytics Appliance Getting Started Guide Version 2.19
14
Admin UI Configuration
Home
Home
Figure 9: Home
Cisco Secure Malware Analytics Appliance Getting Started Guide Version 2.19
15
Admin UI Configuration
Configure NFS
What to do next
Proceed to Configure NFS, on page 16.
Configure NFS
The next step in the workflow is NFS configuration. This task is required for backups and for clustering. See
the NFS Requirements section in the Cisco Secure Malware Analytics Appliance Administration Guide for
more information.
The configuration process includes mounting the NFS store, mounting the encrypted data, and initializing the
Secure Malware Analytics Appliance local datastores from the contents of the NFS store.
If you would like to skip this step or continue and return later, click Continue without NFS.
Step 1 Click NFS in the navigation pane to open the NFS Configuration page.
Step 2 Enter the following information. Appliances in a cluster should share the same Host and Path as those set in the first
cluster node.
• Host - The NFSv4 host server. We recommend using the IP address.
• Path - The absolute path to the location on the NFS host server under which files will be stored. This does not
include the Key ID suffix, which will be added automatically.
• Options - NFS mount options to be used, if this server requires any deviations from standard Linux defaults for
NFSv4. The default is rw.
Cisco Secure Malware Analytics Appliance Getting Started Guide Version 2.19
16
Admin UI Configuration
Configure Clustering
• FS Encryption Key Hash - Click Generate Key to generate a new encryption key. You will need this key to restore
backups later. (At that time, click Upload and upload the key required for the backup.)
Step 3 Click Save. The page refreshes and the Generate Key and Activate buttons become available.
Note If the key correctly matches the one used to create a backup, the Key ID displayed in Admin UI after upload will
match the name of a directory in the configured path. Backups cannot be restored without the encryption key.
The configuration process includes the process of mounting the NFS store, mounting the encrypted data, and
initializing the appliance's local datastores from the NFS store's contents.
Step 8 ClickActivate.
The Status changes to Active after a few seconds (lower left corner).
What to do next
Proceed to Configuring First Cluster Node.
Configure Clustering
The next step in the wizard workflow is to configure clustering. If the appliance being configured is not going
to be part of a cluster, then skip to the next configuration step, Install License, on page 19.
The main goal of clustering is to increase the sample analysis capacity of a single system. Each appliance in
a cluster saves data in the shared file system, and has the same data as the other nodes in the cluster. Clustering
does not increase storage capacity, and it does not increase the speed of sample analysis. Instead, clustering
makes it possible to analyze more samples in the same amount of time that you can achieve with a single
appliance. Because the data is the same on all nodes, sample analysis can be passed from the submitting node
to another cluster node that is not as busy. Clusters can include 2-7 appliances.
Clustering also helps support recovery from failure of one or more appliances in the cluster, depending on
the cluster size.
You can create a cluster with new appliances, with appliances that have had their data removed (not Wiped),
or a combination of new and existing appliances. When joining a Secure Malware Analytics Appliance to a
cluster, it's convenient if the NFS and clustering are configured during the initial setup. You can start a cluster
Cisco Secure Malware Analytics Appliance Getting Started Guide Version 2.19
17
Admin UI Configuration
Configuring First Cluster Node
post-installation from the Cluster Configuration page, but you can't join an installed appliance into an existing
cluster.
For more information about clustering, see the Secure Malware Analytics Appliance Administrator Guide
v2.17.
If you have questions about installing or reconfiguring clusters, contact Support for assistance.
Note If you are joining an existing appliance to a cluster, remove existing data with the destroy-datacommand,
as documented in Reset Appliance as Backup Restore Target section in the Secure Malware Analytics Appliance
Administrator Guide v2.17. Do not use the Wipe Appliance feature.
Step 1 Click Clustering in the navigation pane to open the Cluster Configuration page.
Step 2 Click Start Cluster and then click OK on the confirmation dialog.
The Clustering State changes to Clustered.
Step 3 Complete the remaining steps in the wizard and click Start Installation. This initiates a restore of the data in cluster
mode.
Step 4 Check the health of the newcluster on the Clustering page.
What to do next
Proceed to Joining Additional Cluster Nodes
Step 1 Click the Configuration tab and choose NFS to open the NFS Configuration page.
Step 2 Specify the Host and Path to match what was set in the first node in the cluster.
Step 3 Click Save. The page refreshes and the Upload button becomes available.
Step 4 In the Configuration menu, choose Clustering to open the Cluster Configuration page.
Step 5 Click Join Cluster and then click OK on the confirmation dialog.
Cisco Secure Malware Analytics Appliance Getting Started Guide Version 2.19
18
Admin UI Configuration
Install License
Step 6 Finish the installation. This will initiate a restore of the data in cluster mode.
Step 7 Repeat the procedure for each node you want to join to the cluster.
What to do next
Proceed to Install License, on page 19.
Install License
After the clustering, you are ready to install the Secure Malware Analytics license.
Step 1 Click Upload License and select the license file from your file manager.
Alternatively, you can retrieve the license from the server. If the appliance has network access when being installed, click
Retrieve License From Server to get the license over the network.
Step 3 Click Save to install the license. The page refreshes and your license information is displayed.
Cisco Secure Malware Analytics Appliance Getting Started Guide Version 2.19
19
Admin UI Configuration
Configure Email
What to do next
Proceed to Configure Email, on page 20.
Configure Email
The next step in the workflow is to configure the email host in the SMTP Configuration page.
Cisco Secure Malware Analytics Appliance Getting Started Guide Version 2.19
20
Admin UI Configuration
Configure Notifications
What to do next
Proceed to Configure Notifications.
Configure Notifications
The next step in the workflow is to configure notifications that can be delivered periodically to one or more
email addresses. System notifications are displayed in the Secure Malware Analytics portal interface, but this
page allows you to set up Notifications that are also sent via email.
Step 1 Under Recipients, enter the Email Address for at least one notifications recipient. If you need to add multiple email
addresses, click the + icon to add another field; repeat as needed.
Cisco Secure Malware Analytics Appliance Getting Started Guide Version 2.19
21
Admin UI Configuration
Configure Date and Time
Step 2 Under Notification Frequency, choose the settings for Critical and Non-critical from the drop-down lists.
Step 3 Click Save.
Step 4 Click Continue to move to the next step in the workflow.
What to do next
Proceed to Configure Date and Time.
Cisco Secure Malware Analytics Appliance Getting Started Guide Version 2.19
22
Admin UI Configuration
Configure System Log
If there are multiple NTP servers, click the + icon to add another field; repeat as needed.
What to do next
Proceed to Configure System Log.
Step 1 Complete the Host URL, Host Port, and Protocol fields and click Save.
Cisco Secure Malware Analytics Appliance Getting Started Guide Version 2.19
23
Admin UI Configuration
Review and Install Configuration Settings
What to do next
Proceed to Review and Install Configuration Settings.
Step 1 Click Review and Install in the navigation pane and then click Begin Installation to begin installing the configuration
scripts.
Cisco Secure Malware Analytics Appliance Getting Started Guide Version 2.19
24
Admin UI Configuration
Review and Install Configuration Settings
After successful installation, the State changes from Running to Successful, and the Reboot button becomes enabled
(green). The configuration output is also displayed.
Cisco Secure Malware Analytics Appliance Getting Started Guide Version 2.19
25
Admin UI Configuration
Review and Install Configuration Settings
Cisco Secure Malware Analytics Appliance Getting Started Guide Version 2.19
26
Admin UI Configuration
Install Secure Malware Analytics Appliance Updates
After reboot, the appliance opens to the Admin UI Home page. This completes the configuration process.
Note For more information about installing updates, see the Cisco Secure Malware Analytics Appliance
Administration Guide.
Step 1 Click the Operations tab and choose Update to open theAppliance Updates page.
Figure 21: Appliance Updates Page
The current release version is displayed in the upper portion of the page. It also informs you if there is an update available
to install. For information about the release versions, see the Cisco Secure Malware Analytics Appliance Version Lookup
Table.
Step 3 Once the update has been downloaded, click Apply Update to install it.
Cisco Secure Malware Analytics Appliance Getting Started Guide Version 2.19
27
Admin UI Configuration
Test the Appliance Setup
Step 1 In a browser, open Secure Malware Analytics using the address you configured as the Clean interface.
The Secure Malware Analytics login page opens.
Figure 22: Secure Malware Analytics Login
Step 3 Click Log In to open the main Secure Malware Analytics dashboard. There will be no sample data available yet.
Cisco Secure Malware Analytics Appliance Getting Started Guide Version 2.19
28
Admin UI Configuration
Test the Appliance Setup
Cisco Secure Malware Analytics Appliance Getting Started Guide Version 2.19
29
Admin UI Configuration
Test the Appliance Setup
Note There is help available at the bottom of this form, describing sample submission file types, size, and other
information. You can also click the ? icon located in the upper-right corner to view the Secure Malware Analytics
Release Notes and online help, including complete documentation on how to submit a sample and review the
analysis results.
Step 5 Upload a file or enter a URL to submit for malware analysis. Leave the other options set at the defaults if you are not yet
sure what they mean.
Cisco Secure Malware Analytics Appliance Getting Started Guide Version 2.19
30
Admin UI Configuration
Test the Appliance Setup
What to do next
Once the Secure Malware Analytics Appliance has been set up and initial configuration is completed, additional
tasks can be performed by the appliance administrator, such as managing SSL certificates and adding users.
See the Cisco Secure Malware Analytics Appliance Administration Guide for information about administrator
tasks.
Cisco Secure Malware Analytics Appliance Getting Started Guide Version 2.19
31
Admin UI Configuration
Test the Appliance Setup
Cisco Secure Malware Analytics Appliance Getting Started Guide Version 2.19
32