Trend Micro TippingPoint
TM

TM

Security Management System (SMS)Web API Guide

Privacy and Personal Data Collection Disclosure
Certain features available in Trend Micro products collect and send feedback regarding product usage and detection information to Trend Micro.
Some of this data is considered personal in certain jurisdictions and under certain regulations. If you do not want Trend Micro to collect personaldata, you must ensure that you disable the related features.
The following link outlines the types of data that the Security Management System collects and provides detailed instructions on how to disable thespecific features that feedback the information.
https://success.trendmicro.com/data-collection-disclosure
Data collected by Trend Micro is subject to the conditions stated in the Trend Micro Privacy Policy:
https://www.trendmicro.com/en_us/about/legal/privacy-policy-product.html

Legal Notice© Copyright 2021 Trend Micro Incorporated. All rights reserved.
Trend Micro, the Trend Micro t-ball logo, TippingPoint, and Digital Vaccine are trademarks or registered trademarks of Trend Micro Incorporated.
All other product or company names may be trademarks or registered trademarks of their owners.
Publication: July 2021

SMS Web API
The Trend Micro™ TippingPoint™ Security Management System (SMS) Web API provides access to thefollowing set of SMS features:•

Profile management•

Device administration•

SMS administration•

Virtual segment management•

Reputation database management•

Packet trace•

Responder•Enterprise Vulnerability Remediation (eVR)•

STIX/TAXII•

Database access•

External database•

MIB files for the SMS•

Event Taxonomy

API
Trend provides two types of APIs for use with the SMS.
•The SMS Web API Guide describes HTTP APIs you can use to access multiple SMS features if you have
HTTPS service to the SMS. To ensure that you have the latest versions of product documentation, visit
the Online Help Center.

Authentication
Access to the SMS Web API requires that you authenticate by using HTTP authentication or the API key.
•

HTTP authentication: –u {username}:{password}
curl -k -u {username}:{password} "https://<sms_server>/ipsProfileMgmt/
exportProfile?profileName=MyProfile"•

API key: authentication mechanism that does not require a username and password. Use the API key aspart of the header for HTTP requests. X-SMS-API-KEY: <string>
curl -k --header "X-SMS-API-KEY: <string>" "https://<sms_server>/ipsProfileMgmt/
exportProfile?profileName=MyProfile"
Note
HTTP authentication is supported; however this authentication mechanism is deprecated and not recommended.
We recommend that you authenticate by using the API key.

1

SMS Web API Guide

Keep in mind the following considerations:•

To view the API key on the SMS, go to Admin > Authentication and Authorization > Users > Edit >Authentication > API Key.

•To customize or replace the default SMS SSL X509 certificate on the SMS, go to Admin > Certificate
Management.

•

Only superusers should have web access for full authorization. On the SMS, go to Admin >Authentication and Authorization > Roles.

•

HTTPS service is required to send API requests to the SMS. On the SMS, go to Admin > Server Properties> Services.

ErrorsThe SMS web API returns one of the following HTTP status codes if the request is unsuccessful.
Code

Description

400

Bad request – malformed parameter or request.

401

Unauthorized – missing or incorrect credentials.

403

No web access capability.
If you receive this message, check the user role capabilities, and enable the Access SMS Web Services capability.
On the SMS, go to Admin > Authentication and Authorization > Roles > Edit > Capabilities > Admin > Access SMS Web
Services.

404

Not found – invalid or nonexistent requested source.

412

Preconditioned fail – unexpected error. Check the SMS System Log.
On the SMS, go to Admin > General > SMS System Log.

500

Internal server error – server-side exception. Check the SMS System Log.
On the SMS, go to Admin > General > SMS System Log.

Profile management
Use this API to export, import, and distribute an SMS profile, and to create and update filters. In addition, you
can retrieve profile distribution status and data about the TippingPoint Digital Vaccine (DV) on the SMS.
This API includes:

2•

Export a profile•

Import a profile•

Distribute a profile•

Get distribution status•

Create a traffic management filter•

Delete a traffic management filter•

Get current filter settings•

Update filter settings

SMS Web API Guide•

Get Digital Vaccine information

Export a profile
Get and export a profile package from the SMS.
•

Profile packages typically remain unchanged.

•

If you want to change the files within a profile package, update the md5sum in the sms-securitymanifest file before you import the profile back to the SMS.

Definition
ipsProfileMgmt/exportProfile

Parameters
Parameter
exportMethodTypestringDescription
Optional. Export destination.
•

SMS HTTPS server (default)

•

SMB

•

NFS

profileNamestringRequired. Profile name to export.

profileVersion

stringOptional. Profile version to export. The latest version of the profile is used if thisparameter is not specified.

remoteDirectorystringRequired.
•

SMB

•

NFS

remoteDirectory/SMB/userid

string

SMB user ID.

remoteDirectory/SMB/
password

string

SMB password.

remoteDirectory/SMB/domain

string

SMB domain.

remoteFilename

stringOptional. Remote filename (default: "profile_name.pkg")

remoteServer

string

SMB or NFS server.

Examplecurl -k --header "X-SMS-API-KEY: <string>""https://<sms_server>/ipsProfileMgmt/exportProfile?
exportMethod=SMB&profileName=Default&remoteDirectory=MyExportDirectory&remoteServer=MyRemoteServer&userid=guest&password=guestpass&domain=Domain"

Import a profile
Post and import an exported profile package to the SMS. Profiles include shared settings such as action sets,
notification contacts, and services.
•

If the imported profile includes policies or category settings that use a particular action set, the action
set is added to the SMS. The SMS does not overwrite an existing action set with the same name. Instead,3

SMS Web API Guide

the SMS renames the new action set by appending a number to the end of the file name, for example,“My Quarantine_2”.
•

A notification contact that is used by an action set is also imported and renamed, if necessary.

•

Existing port definitions for services on the SMS remain the same. If an imported profile includes aservice with a port definition that differs from the existing service on the SMS, the service is added to the
SMS service list. Review services any time a profile is imported from a different user or from a different
environment.

Definition
ipsProfileMgmt/importProfile

Parameters
Type

Parameter
importAction

targetProfileName

replacedProfileNamestringstringstringDescription
Required.
•

add: Adds a completely new profile; must have an unused name or import
fails.

•

combine_add: Adds new settings and merges non-conflicting changes into
an existing profile.

•combine_change: Adds new settings to and overwrites existing settings ofan existing profile with settings of the new profile.

•replace: Overwrites contents of SMS profile with those of the profile being
imported; name and UUID remain the same; snapshot of replaced profile
occurs and updated profile gets new version.

Name of the existing profile on the SMS. Required for all replace and combine
actions.
•

The profile must exist on the SMS.

•

If the specified profile does not exist or is not specified in the request, theoperation fails and updates the audit log.

Name of the imported profile that will have its contents applied to the existing
profile on the SMS.
•

Required for all replace and combine actions.

•

The profile must be specified in the request.

•

If the specified profile does not exist or is not specified in the request, theoperation fails and updates the audit log.

Examplecurl -k --header "X-SMS-API-KEY: <string>"-F "file=@</path/to/import.pkg>""https://<sms_server>/ipsProfileMgmt/importProfile?importAction=replace&targetProfileName=<name>&replacedProfileName=<name>"

Distribute a profile
Get and initiate a profile distribution to a single segment target or to a segment group.
Definition
ipsProfileMgmt/distributeProfile

4

SMS Web API Guide

Parameters
ParameterTypeprofilepriority

stringDescription
•

id

•

name

•

versionDistribution priority.
•

high

•

low

segmentGroupstringSegment group.

virtualSegment

stringVirtual segment.

device/id

stringInternal ID assigned to the device.

device/shortID

integerInternal number assigned to the device.

device/namestringDevice name.

device/ipAddress

stringDevice IP address.

device/virtualSegment

stringVirtual segment on the device.

Examplecurl -k --header "X-SMS-API-KEY: <string>""https://<sms_server>/ipsProfileMgmt/distributeProfile?"

Response<?xml version="1.0" encoding="utf-8"?><xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"><xs:simpleType name="uuid"><xs:restriction base="xs:string"><xs:pattern value="[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"/></xs:restriction></xs:simpleType><xs:complexType name="idname"><xs:choice><xs:element name="id" type="uuid"/><xs:element name="name" type="xs:string"/></xs:choice></xs:complexType><xs:element name="distribution"><xs:complexType><xs:sequence><xs:element name="profile" minOccurs="1"maxOccurs="1"><xs:complexType><xs:attribute name="id" type="uuid"/><xs:attribute name="name" type="xs:string"/><xs:attribute name="version" type="xs:string" use="required"/></xs:complexType></xs:element>

5

SMS Web API Guide<xs:element name="priority" minOccurs="0"><xs:simpleType><xs:restriction base="xs:string"><xs:enumeration value="high"/><xs:enumeration value="low"/></xs:restriction></xs:simpleType></xs:element><xs:element name="segmentGroup" type="idname" minOccurs="0"
maxOccurs="unbounded"/><xs:element name="virtualSegment" minOccurs="0"
maxOccurs="unbounded"><xs:complexType><xs:sequence><xs:element name="id" type="uuid"/></xs:sequence></xs:complexType></xs:element><xs:element name="device" minOccurs="0" maxOccurs="unbounded"><xs:complexType><xs:sequence><xs:choice><xs:element name="id" type="uuid"/><xs:element name="shortID" type="xs:positiveInteger"/><xs:element name="name" type="xs:string"/><xs:element name="ipAddress" type="xs:string"/></xs:choice><xs:element name="virtualSegment" type="idname"maxOccurs="unbounded"/></xs:sequence></xs:complexType></xs:element></xs:sequence></xs:complexType></xs:element></xs:schema>

Get distribution status
Get distribution status. Actual percent-complete progress and predicted end-time are not available.
Definition
ipsProfileMgmt/distributionStatus

Parameters
Type

Parameter

6

Description

distribution/id

stringInternal ID assigned to the distribution session.

device/id

stringInternal ID assigned to the device.

device/shortID

integerInternal number assigned to the device.

device/namestringDevice name.

SMS Web API Guide

Parameter
device/ipAddressTypestringDescription
Device IP address.

Examplecurl -k --header "X-SMS-API-KEY: <string>" "https://<sms_server>/ipsProfileMgmt/
distributionStatus?"

Response<?xml version="1.0" encoding="utf-8"?><xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"><xs:simpleType name="uuid"><xs:restriction base="xs:string"><xs:pattern value="[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"/></xs:restriction></xs:simpleType><xs:element name="distributions"><xs:complexType><xs:sequence><xs:element name="distribution" minOccurs="1"
maxOccurs="unbounded"><xs:complexType><xs:sequence><xs:element name="device" minOccurs="0" maxOccurs="unbounded"><xs:complexType><xs:choice><xs:element name="name" type="xs:string"/><xs:element name="id" type="uuid"/><xs:element name="shortID" type="xs:positiveInteger"/><xs:element name="ipAddress" type="xs:string"/></xs:choice></xs:complexType></xs:element></xs:sequence><xs:attribute name="id" type="uuid"/></xs:complexType></xs:element></xs:sequence></xs:complexType></xs:element></xs:schema>

Create a traffic management filter
Create a traffic management filter.
Definition
ipsProfileMgmt/createTrafficMgmt

7

SMS Web API Guide

Parameters
Parameter

Type

Description

namestringRequired. Name of the traffic management filter; must be unique for eachprofile.

profilestringRequired. Name of the profile that contains the traffic management filter; theprofile must already exist on the SMS.

srcAddr

IP address

Required. Source address for the filter. Valid values: any or IP address.

destAddr

IP address

Required. Destination address for the filter. Valid values: any or an IP address.

direction

stringOptional. Filter direction. If a parameter is not specified, the default value isused.

actionstring•AtoB (default)

•

BtoA

•

both

Optional. Filter action set. For rate limiting, use the rate-limit parameter.
•

block (default)

•

allow

•

trust

rate-limit

stringOptional. Filter rate-limit action set; the action set must already be definedand set to rate-limit.

protocolstringOptional. Filter protocol.

protocol/ip/ipFragments

protocol/icmp/icmptype

booleaninteger•

ip (default)

•

ipv6

•

tcp

•

tcpv6

•

udp

•

udpv6

•

icmp

•

icmpv6

Optional. Applies only to IP fragments; valid only when protocol is IP.
•

false (default)

•

true

Optional. ICMP type; valid only when protocol is ICMP.
•

protocol/icmp/icmpcode

integer

Optional. ICMP code; valid only when protocol is ICMP.
•

protocol/tcp or udp/srcPort

8integer

0-255 (default is 0)0-255 (0 is default)

Optional. Source port; valid only when protocol is TCP or UDP.
•

any

•

0-65535 (default is 0, and all ports)

SMS Web API Guide

ParameterType

protocol/tcp or udp/destPort

integerposition

Description
Optional. Destination port; valid only when protocol is TCP or UDP.

integer•any•0-65535 (default is 0, and all ports)

Optional. Filter precedence.
•

0-200 (default is 0, which uses the lowest unused value)comment

stringOptional. Filter comments.

stateboolean

Optional. Filter state.
•

enable (default)•

disableExamplecurl -k --header "X-SMS-API-KEY: <string>" "https://<sms_server>/ipsProfileMgmt/
createTrafficMgmt?name=<name>&profile=<p_name>&srcAddr=<ip_address>&destAddr=<ip_address>"

Delete a traffic management filter
Delete a traffic management filter.
Definition
ipsProfileMgmt/deleteTrafficMgmt

Parameters
Parameter

Type

Description

namestringRequired. Name of the traffic management filter to be deleted; must be unique for eachprofile.

profilestringRequired. Name of the profile that contains the traffic management filter; the profile
must already exist on the SMS.

Examplecurl -k --header "X-SMS-API-KEY: <string>" "https://<sms_server>/ipsProfileMgmt/
deleteTrafficMgmt?name=<name_1>,<name_2>,<name_3>&profile=<p_name>"

Get current filter settings
Retrieve current filter settings for a profile. The Current Filter Settings Request is a POST request, andrequires you to provide an XML file that identifies the profile and the filter(s). When the SMS receives acurrent filter settings service request, it:•

Validates the filter ID using the DV metadata.

•

Finds the category the filter ID belongs to.

•

Finds the setting of the category from the profile specified by the Profile ID and version.

•

Sets the filter ID in the response XML.
9

SMS Web API Guide

The setting of a given filter might be changed by IPS administrators. The changes are defined in the POLICY
response XML defined by the existing service interface.
Definition
ipsProfileMgmt/getFilters

SchemaThe Remote Profile Management API uses the following XML schema for current filter settings status
requests.
<?xml version="1.0" encoding="UTF-8"?><xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"><xs:simpleType name="uuid"><xs:restriction base="xs:string"><xs:pattern value="[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"/></xs:restriction></xs:simpleType><xs:element name="getFilters"><xs:complexType><xs:sequence><xs:element name="profile"><xs:complexType><xs:attribute name="id" type="uuid"/><xs:attribute name="name" type="xs:string"/></xs:complexType></xs:element><xs:element name="filter" maxOccurs="unbounded"><xs:complexType><xs:sequence><xs:element name="number" type="xs:positiveInteger"minOccurs="0"/><xs:element name="name" type="xs:string" minOccurs="0"/><xs:element name="signature-id" type="uuid" minOccurs="0"/><xs:element name="policy-id" type="uuid" minOccurs="0"/></xs:sequence></xs:complexType></xs:element></xs:sequence></xs:complexType></xs:element></xs:schema>

Parameters
Type

Parameter
profile10

stringDescription
Empty element with these attributes:
•

id

•

name

•

versionnumberinteger

Unique filter number.

namestringFilter name.

signature-id

stringInternally assigned filter ID.

SMS Web API Guide

Parameter

Type

Description

policy-id

stringInternally assigned policy ID.

versioninteger

IPS TOS version for the filter.

lockedbooleanIndicates whether the filter is locked.
You cannot remotely change a locked filter.

useParentbooleanIndicates whether the action set on the filter is inherited from a parent profile.

comment

stringUser comments.

description

stringFilter description.

severity

stringFilter severity.

enabledactionset

controlafc

booleanstringstringboolean

•

Low

•

Minor

•

Major

•

Critical•enabled•disabled

•

refid

•

name

Controlling element of the filter actionset setting.
•category: controlled by the category action set.

•filter: controlled by the overriding default action set.

Indicates whether the filter is managed by the Adaptive Filter Configuration(AFC). If a filter is managed by AFC, then the filter is automatically disabled whenthe IPS device is under heavy load and the given filter is triggered without anactual filter match.

policyGroup

Profile group identified by a refid, expressed in UUID format. This parameter isnever used by a filter.

trigger

Trigger frequency detection parameter for the filter. Used only for scan/sweep
filters.

capability•

threshold: specify the number of filter triggers.

•

timeout: specify the time period under which the number of triggers arebeing counted (in seconds).

Element with a device name attribute having these child elements:•

enabled•actionset: specifies the filter setting.

•refid: maps to the action set ID for the capability.

Examplecurl -X POST -k --header "X-SMS-API-KEY: <string>" --form name=@getFilters.xml
https://<sms_server>/ipsProfileMgmt/getFilters

11

SMS Web API Guide

The following sample shows how the getFilters XML file is composed according to the schema. You must
provide values for the profile name and at least one of the filter search terms: number, signature ID, policy
ID, or name.
<?xml version="1.0"?><getFilters><profile name="Default"/><filter><number>3295</number></filter><filter><signature-id>00000001-0001-0001-0001-000000000027</signature-id></filter><filter><policy-id>00000002-0002-0002-0002-000000000051</policy-id></filter><filter><name>0050: IP Options: Unknown Code</name></filter></getFilters>

Response<?xml version="1.0" encoding="utf-8"?><xs:schema xmlns:xs"http://www.w3.org/2001/XMLSchema"><xs:simpleType name="uuid"><xs:restriction base="xs:string"><xs:patternvalue="[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"/><xs:restriction><xs:simpleType><xs:element name="filters"><xs:complexType><xs:sequence><xs:element name="profile"><xs:compleType><xs:attribute name="name" type="xs:string"/><xs:attribute name="id" type="xs:string"/><xs:attribute name="version" type="xs:string"/></xs:complexType></xs:element><xs:element name="filter" maxOccurs="unbounded"><xs:complexType><xs:sequence><xs:element name="name" type="xs:string"/><xs:element name="policy-id" type="uuid"/><xs:element name="version" type="xs:string"/><xs:element name="locked" type="xs:boolean"/><xs:element name="useParent" type="xs:boolean"/><xs:element name="comment" type="xs:string" minOccurs="0"/><xs:element name="description" type="xs:string" minOccurs="0"/><xs:element name="severity" minOccurs="0"><xs:simpleType><xs:restriction base="xs:string"><xs:enumeration value="Low"/><xs:enumeration value="Minor"/><xs:enumeration value="Major"/><xs:enumeration value="Critical"/></xs:restriction></xs:simpleType>

12

SMS Web API Guide</xs:element><xs:element name="enabled" type="xs:boolean"/><xs:element name="actionset" minOccurs="0"><xs:complexType><xs:attribute name="refid" type="uuid"/><xs:attribute name="name" type="xs:string"/></xs:complexType></xs:element><xs:element name="control"><xs:simpleType><xs:restriction base="xs:string"><xs:enumeration value="Category"/><xs:enumeration value="Filter"/></xs:restriction></xs:simpleType></xs:element><xs:element name="afc" type="xs:boolean"/><xs:element name="policyGroup" minOccurs="0"><xs:complexType><xs:attribute name="refid" type="uuid"/></xs:complexType></xs:element><xs:element name="trigger" minOccurs="0"><xs:complexType><xs:attribute name="threshold"><xs:simpleType><xs:restriction base="xs:integer"><xs:minInclusive value="2"/><xs:maxInclusive value="10000"/></xs:restriction></xs:simpleType></xs:attribute><xs:attribute name="timeout"><xs:simpleType><xs:restriction base="xs:long"><xs:minInclusive value="0"/><xs:maxInclusive value="999999"/></xs:restriction></xs:simpleType></xs:attribute></xs:complexType></xs:element><xs:element name="capability" minOccurs="0" maxOccurs="unbounded"><xs:complexType><xs:sequence><xs:element name="enabled" type="xs:boolean"/><xs:element name="actionset" minOccurs="0"><xs:complexType><xs:attribute name="refid" type="uuid"/><xs:attribute name="name" type="xs:string"/></xs:complexType></xs:element></xs:sequence><xs:attribute name="name" type="xs:string"/></xs:complexType></xs:element></xs:sequence></xs:complexType></xs:element></xs:sequence>

13

SMS Web API Guide</xs:complexType></xs:element></xs:schema>

Update filter settings
Apply policy changes, such as profile and filter details, to a profile.
Definition
ipsProfileMgmt/setFilters

Parameters
Type

Parameteractionset

string

•

refid

•

name

afc

booleanIndicates whether the filter is managed by the IPS Adaptive
Filter Configuration (AFC)If a filter is managed by AFC, then the filter will be automaticallydisabled when the device is under heavy load and the given
filter is being triggered without actual filter match.

comment

stringFilter comments.

control

string•category: action set is controlled by the category action set.

•filter: action set is controlled by overriding the default
action set.

•

enabled•disabled

enabledbooleanfilterRead-only parent element.

lockedbooleanBoolean variable indicating if the filter is locked. Locked filters
cannot be remotely changed.

numberinteger

Read-only internal assigned number for the filter.

namestringRead-only filter name.

policy-id

stringRead-only internal ID assigned to the policy, expressed in UUID
format.

profilestring

•

id

•

name

signature-id
trigger

14

Description

stringRead-only internal ID assigned to the filter, expressed in UUID
format.
Trigger frequency detection parameter for the filter. Used only
for scan/sweep filters.
•

threshold: specify the number of filter triggers.

•

timeout: specify the time period under which the numberof triggers are being counted (in seconds).

SMS Web API Guide

Parameter
useParentTypebooleanDescription
Indicates whether the action set setting for the filter is inheritedfrom a parent profile.

Examplecurl -k --header "X-SMS-API-KEY: <string>" "https://<sms_server>/ipsProfileMgmt/setFilters?"

Response<?xml version="1.0" encoding="utf-8"?><xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"><xs:simpleType name="uuid"><xs:restriction base="xs:string"><xs:pattern value="[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"/></xs:restriction></xs:simpleType><xs:element name="setFilters"><xs:complexType><xs:sequence><xs:element name="profile"><xs:complexType><xs:attribute name="name" type="xs:string"/><xs:attribute name="id" type="uuid"/></xs:complexType></xs:element><xs:element name="filter" maxOccurs="unbounded"><xs:complexType><xs:sequence><xs:choice><xs:element name="policy-id" type="uuid"/><xs:element name="signature-id" type="uuid"/><xs:element name="number" type="xs:positiveInteger"/><xs:element name="name" type="xs:string"/></xs:choice><xs:element name="locked" type="xs:boolean" minOccurs="0"/><xs:element name="comment" type="xs:string" minOccurs="0"/><xs:element name="control" minOccurs="0"><xs:simpleType><xs:restriction base="xs:string"><xs:enumeration value="Category"/><xs:enumeration value="Filter"/></xs:restriction></xs:simpleType></xs:element><xs:element name="actionset" minOccurs="0"><xs:complexType><xs:attribute name="refid" type="uuid"/><xs:attribute name="name" type="xs:string"/></xs:complexType></xs:element><xs:element name="enabled" type="xs:boolean" minOccurs="0"/><xs:element name="afc" type="xs:boolean" minOccurs="0"/><xs:element name="useParent" type="xs:boolean" minOccurs="0"/><xs:element name="trigger" minOccurs="0"><xs:complexType><xs:attribute name="threshold"><xs:simpleType><xs:restriction base="xs:integer">

15

SMS Web API Guide<xs:minInclusive value="2"/><xs:maxInclusive value="10000"/></xs:restriction></xs:simpleType></xs:attribute><xs:attribute name="timeout"><xs:simpleType><xs:restriction base="xs:long"><xs:minInclusive value="0"/><xs:maxInclusive value="999999"/></xs:restriction></xs:simpleType></xs:attribute></xs:complexType></xs:element></xs:sequence></xs:complexType></xs:element></xs:sequence></xs:complexType></xs:element></xs:schema>

Get Digital Vaccine information
Get the active Digital Vaccine and all Digital Vaccines on the SMS.
Definition
ipsProfileMgmt/dvInfo

Parameters
Type

Parameter
requeststringDescription
Required.
•

active•all

Examplecurl -k --header "X-SMS-API-KEY: <string>" "https://<sms_server>/ipsProfileMgmt/dvInfo?"

Device administration
Use this API to retrieve the Layer-2 Fallback status, and to place a device or device group into or out of Layer-2
Fallback.
This API includes:

16•

Get fallback status•

Set fallback status

SMS Web API Guide

Get fallback status
Retrieve the Layer-2 Fallback status for any current device or device group on the SMS.
Definition
deviceAdmin/getFallback

Parameters
Parameter

Type

Description

deviceNamestringRequired. Device that will return the Layer-2 Fallback status.

deviceGroupName

stringOptional. Device group name that will return a comma-delimitatedlist that shows the Layer-2 Fallback status for each device in thedevice group.

Examplecurl -k --header "X-SMS-API-KEY: <string>" "https://<sms_server>/deviceAdmin/
getFallback?deviceGroupName=exampleDeviceGroupName"

Set fallback status
Place a device or device group into or out of Layer-2 Fallback.
Definition
deviceAdmin/setFallback

Parameters
Type

Parameter

Description

deviceNamestringRequired. Name of the device that will be put into or out of Layer-2
Fallback status.

deviceGroupName

stringOptional. Comma-delimitated list that contains the names of thedevices within the device group that will be put into or out of Layer-2
Fallback.

L2FB

booleanRequired. Represents the Layer-2 Fallback status that the device or
device group will be set to.
•

true

•

false

Examplecurl -X POST -k --header "X-SMS-API-KEY: <string>" "https://<sms_server>/deviceAdmin/setFallback?
deviceName=exampleTpsDevice&L2FB=true"

SMS administration
Use this API to create a backup the SMS database, and to retrieve SMS software version information.
This API includes:
17

SMS Web API Guide•

Backup SMS database•

SMS software version•

Restore backup file

Backup SMS database
Create a backup of the SMS database.
Definition
smsAdmin/backup

Parameters
Parameter
type

stringDescription
Destination type.
•

smb

•

nfs

•

scp

•

sftp

•

sms (Stored locally on the SMS. Only one backup allowed at a time.)

locationstringDestination path for backup file. Does not apply for type/sms.

username

stringType-specific username. Required for type/smb, scp, or sftp.

password

stringType-specific password. Required for type/smb, scp, or sftp .

domainstringType-specific domain; only used for destination type smb

tosintegerNumber of most recent TOS packages to include. Default is 0.

dv

integerNumber of most recent DV packages to include. Default is 1.

eventsbooleanWhether to include events data.

sslPrivateKeys

notifytimestamp

encryptionPass

18

Type

booleanbooleanbooleanstring•true•

false (default)

Whether to include SSL private key.
•

true

•

false (default)

Whether to send email notifications when a backup has completed or failed.
•true (default)

•

false

Whether to include the timestamp.
•

true (default)

•

false

Encrypt backup using supplied password. Default is null, do not encrypt.

SMS Web API Guide

Examplecurl -k --header "X-SMS-API-KEY: <string>""https://<sms_server>/smsAdmin/backup?
type=<smb>&location=<//198.51.100.100/backups/sms.bak>&username=<smb_user>&password=<smb_pwd>&domain=<dom00>&tos=<1>&dv=<1>&events=<false>&notify=<false>&
timestampName=<true>"

SMS software version
Retrieve the SMS software version.
Definition
smsAdmin/infoParameters
Type

Parameter
requestDescription

stringReturns a version number.

Examplecurl -k --header "X-SMS-API-KEY: <string>" "https://<sms_server>/smsAdmin/info?request=version"

Restore backup file
Restore the backup file.
Definition
smsAdmin/restore

Parameters
Type

Parameter

Description

encryptionPassword

stringPassword. Default is null.

restoreAdminSetting

booleanWhether to restore the backup file.
•

true

•

false (default)

Examplecurl -k --header "X-SMS-API-KEY: <string>" "https://<sms_server>/smsAdmin/restore?
encryptionPassword=<password>&restoreAdminSetting=true"

Virtual segment management
Use this API to create, update, and delete virtual segments. You can retrieve a list of virtual segments from adevice.
•

You can create a virtual segment that does not initially contain a physical segment.
19

SMS Web API Guide•

IPS devices with virtual segments that were configured locally on an IPS device and then added to the
SMS are merged to the global virtual segment listing.

•A virtual segment must include at least one VLAN ID, source IP address, or destination IP address.

•

Named resources must already exist on the SMS.

This API includes:•

Create a virtual segment•

Update a virtual segment•

Delete a virtual segment•

Get list of virtual segments

Response codes
The API captures a response code for virtual segment operations.
HTTP response code

Web API response code

Description

0200

Successful completion.

100

401

Authentication error.

200

400

Missing parameter error.

205

400

Operation error.

300

400

Input XML file error.

305

500

Output result file error.

310

400

Validation error.

320

400

Resource error.

500

500

Unexpected error.

Create a virtual segment
Add a virtual segment to the SMS database by using a file.
Definition
virtualSegment/create

Parameters
Parameter
file

Type

Description
Name of the file that contains the virtual segment XML.

Examplecurl -v -k --header "X-SMS-API-KEY: <string>" -F "file=@Name.xml""https://<sms_server>/virtualSegment/create?"

20

SMS Web API Guide

Update a virtual segment
Update a virtual segment on the SMS by using a file.
Definition
virtualSegment/update

Parameters
Parameter

Type

Description

file

Name of the file that contains the virtual segment XML.

vsstringVirtual segment name.

Examplecurl -v -k --header "X-SMS-API-KEY: <string>" -F "file=@update.xml""https://<sms_server>/virtualSegment/update?&vs=<name>"

Delete a virtual segment
Delete a virtual segment.
Definition
virtualSegment/delete

Parameters
Parameter

Type

Description
Name of the virtual segment to be deleted from the device and from the SMS.

vsExamplecurl -v -k --header "X-SMS-API-KEY: <string>" "https://<sms_server>/virtualsegment/delete?
&vs="NamedResourceExample"

Get list of virtual segments
Retrieve a list of all of the virtual segments on the SMS in XML format. The request also returns the device
NAME from the DEVICE table. See DEVICE table.
Note
Use the following links to download the XML schema from the SMS: https://<sms_ip_or_hostname>/xsds/
VirtualSegment.xsd or https://<sms_ip_or_hostname>/xsds/sms/response/xsd.

Definition
virtualsegment/get

21

SMS Web API Guide

Parameters
Parameter

Type

name

stringName of the virtual segment

description (optional)

stringDescription for the virtual segment

virtualSegPosition

Indicates where in the list virtual segment isplaced. You define the priority order for a virtual
segment so that any overlapping definitions areresolved. Attempting to define an overlapping
virtual segment on a device which does not allow
it will produce an error.

virtualSegPosition/positionType

ORDINAL_POSITION,FIRST, LAST

Attribute; must be one of the three values

virtualSegPosition/ordinalPosition

positive integer

Must be provided when positionType is
ORDINAL_POSITION

vlanIdList (optional)

Used to assign a list of VLAN IDs, and/or VLAN
ranges or a named object referencing a named
VLAN groupvlanIdList/vlanList

Used when assigning a list of VLAN IDs and/or
VLAN ranges to the virtual segment

vlanIdList/vlanList/vlan

Single element for either a VLAN ID or VLAN range

vlanIdList/vlanList/vlan/vlanID

integer (1 to 4094)

vlanIdList/vlanList/vlan/vlanID/vlanRange

VLAN ID
Element containing a VLAN range

vlanIdList/vlanList/vlan/vlanID/vlanRange/start

integer (1 to 4094)

VLAN ID start of the range

vlanIdList/vlanList/vlan/vlanID/vlanRange/end

integer (1 to 4094)

VLAN ID end of the range

vlanIdList/namedVlanGroupstringNamed VLAN group identifier

sourceAddressList (optional)

Used to assign a list of IP addresses and/or IP
address blocks or a named object referencing a
named address group for the source address

sourceAddressList/cidrList

Used when providing a list of IP addresses and/or
IP address blocks

sourceAddressList/cidrList/cidr

IP address or IP address blocksourceAddressList/namedAddrGroupstringNamed address group identifier

destinationAddressList (optional)

Used to assign a list of IP addresses, and/or IP
address blocks or a named object referencing a
named address group for the destination address

destinationAddressList/cidrList

Used when providing a list of IP addresses and/or
IP address blocks

destinationAddressList/cidrList/cidr

IP address or IP address block

destinationAddressList/namedAddrGroup22

Description

stringNamed address group identifier

segmentGroup

Used when assigning a virtual segment to asegment groupsegmentGroup/segmentGroupID

Identifier element for the segment group

SMS Web API Guide

Parameter

Type

Description

segmentGroup/segmentGroupID/namestringName of the segment groupsegmentGroup/segmentGroupID/id

stringID of the segment group

physicalSegments (optional)

Used for assigning the virtual segment to one ormore segments on one or more devices

physicalSegments/physicalSegment

Identifies the device and the segments to assign
the virtual segment tophysicalSegments/physicalSegment/device

Identifies the device

physicalSegments/physicalSegment/device/uuid

stringUUID of the device

physicalSegments/physicalSegment/device/shortID

positive integer

Short ID of the device

physicalSegments/physicalSegment/device/namestringName of the device

physicalSegments/physicalSegment/device/ipAddress

stringIP Address of the device

physicalSegments/physicalSegment/
segmentNameList
physicalSegments/physicalSegment/
segmentNameList/segmentNames

Element containing a list of the segment names
stringName of the segment

Examplecurl -v -k --header "X-SMS-API-KEY: <string>" "https://<sms_server>/virtualsegment/
get?"

Response<?xml version="1.0" encoding="UTF-8"?><xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"
xmlns:xs="http://www.w3.org/2001/XMLSchema" ><xs:simpleType name="uuid"><xs:restriction base="xs:string"><xs:pattern value="[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"/></xs:restriction></xs:simpleType><xs:simpleType name="vs_name"><xs:restriction base="xs:string"><xs:maxLength value="127"/></xs:restriction></xs:simpleType><xs:simpleType name="vlan_Constraint"><xs:restriction base="xs:int"><xs:minInclusive value="0"/><xs:maxInclusive value="4095"/></xs:restriction></xs:simpleType><xs:simpleType name="vs_description"><xs:restriction base="xs:string"><xs:maxLength value="250"/>

23

SMS Web API Guide</xs:restriction></xs:simpleType><xs:simpleType name="positionType"><xs:restriction base="xs:string"><xs:annotation><xs:documentation>Placement of the object in the list, first, last,or somewhere in between</xs:documentation></xs:annotation><xs:enumeration value="FIRST" /><xs:enumeration value="LAST" /><xs:enumeration value="ORDINAL_POSITION" /></xs:restriction></xs:simpleType><xs:complexType name="messageList"><xs:sequence><xs:element type="xs:string" name="message"
minOccurs="1"
maxOccurs="unbounded"/></xs:sequence></xs:complexType><xs:complexType name="deviceResult"><xs:all><xs:element name="device" type="deviceType"/><xs:element name="success" type="xs:boolean"/><xs:element name="messages" type="messageList"
minOccurs="0" maxOccurs="1"/></xs:all></xs:complexType><xs:complexType name="deviceResultList"><xs:sequence><xs:element type="deviceResult" name="deviceResult"
minOccurs="1"
maxOccurs="unbounded"/></xs:sequence></xs:complexType><xs:complexType name="rangeType"><xs:all><xs:annotation><xs:documentation>Range (i.e. 5 - 90)</xs:documentation></xs:annotation><xs:element type="vlan_Constraint" name="start"/><xs:element type="vlan_Constraint" name="end"/></xs:all></xs:complexType><xs:complexType name="idName"><xs:choice><xs:element name="id"type="xs:string"/><xs:element name="name" type="xs:string"/></xs:choice></xs:complexType><xs:complexType name="cidrListType">

24

SMS Web API Guide<xs:sequence><xs:element type="xs:string" name="cidr" maxOccurs="unbounded"><xs:annotation><xs:documentation>1 or more repetitions:1
or more repetitions:</xs:documentation></xs:annotation></xs:element></xs:sequence></xs:complexType><xs:element name="virtualSegment" type="virtualSegmentType"nillable="false" /><xs:element name="virtualSegmentList" type="virtualSegmentListType"nillable="false"/><xs:complexType name="segmentGroupType"><xs:sequence><xs:element type="segmentGroupIDType" name="segmentGroupID"/></xs:sequence></xs:complexType><xs:complexType name="sourceAddressListType"><xs:choice><xs:annotation><xs:documentation>You have a CHOICE of the next
2 items at this level</xs:documentation></xs:annotation><xs:element type="cidrListType" name="cidrList"></xs:element><xs:element type="xs:string" name="namedAddrGroup"></xs:element></xs:choice></xs:complexType><xs:complexType name="vlanIdListType"><xs:sequence><xs:annotation><xs:documentation>VLAN can either be a 1 named resource
or a list of integer/ranges</xs:documentation></xs:annotation><xs:choice><xs:element type="vlanListType" name="vlanList" ></xs:element><xs:element type="xs:string" name="namedVlanGroup"></xs:element></xs:choice></xs:sequence></xs:complexType><xs:complexType name="virtualSegmentType" ><xs:annotation><xs:documentation>Definition of the virtual segment</xs:documentation><xs:documentation>Any optional fields should be omitted,
no empty elements</xs:documentation><xs:documentation>Required: Name, segmentGroup, one,
two or all of: [vlanIdList,sourceAddressList,
destinationAddressList]</xs:documentation><xs:documentation>Optional: description, and physicalSegments.
If physicalSegments is not provided no devices will be updated with thevirtual segment</xs:documentation>

25

SMS Web API Guide</xs:annotation><xs:all><xs:element type="vs_name" name="name" /><xs:element type="vs_description" name="description"nillable="false" minOccurs="0"/><xs:element type="virtualSegPositionType" name="virtualSegPosition"/><xs:element type="vlanIdListType" name="vlanIdList"
nillable="false" minOccurs="0"></xs:element><xs:element type="sourceAddressListType" name="sourceAddressList"
nillable="false" minOccurs="0"></xs:element><xs:element type="destinationAddressListType" name="destinationAddressList"
nillable="false" minOccurs="0"></xs:element><xs:element type="segmentGroupType" name="segmentGroup" /><xs:element type="physicalSegmentsType" name="physicalSegments"
nillable="false" minOccurs="0"></xs:element></xs:all></xs:complexType><xs:complexType name="virtualSegmentListType"><xs:sequence><xs:element type="virtualSegmentType" name="virtualSegment"
nillable="false" minOccurs="1" maxOccurs="unbounded"></xs:element></xs:sequence></xs:complexType><xs:complexType name="destinationAddressListType"><xs:choice><xs:annotation><xs:documentation>You have a CHOICE of the next
2 items at this level</xs:documentation></xs:annotation><xs:element type="cidrListType" name="cidrList"></xs:element><xs:element type="xs:string" name="namedAddrGroup"></xs:element></xs:choice></xs:complexType><xs:complexType name="segmentGroupIDType"><xs:choice><xs:annotation><xs:documentation>You have a CHOICE of the next
2 items at this level</xs:documentation></xs:annotation><xs:element type="xs:string" name="id"></xs:element><xs:element type="xs:string" name="name"/></xs:choice></xs:complexType><xs:complexType name="virtualSegPositionType"><xs:sequence><xs:element nillable="true" type="xs:positiveInteger"
minOccurs="0" name="ordinalPosition">

26

SMS Web API Guide</xs:element></xs:sequence><xs:attribute type="positionType" name="positionType"/></xs:complexType><xs:complexType name="deviceType"><xs:choice><xs:annotation><xs:documentation>You have a CHOICE of the next
4 items at this level</xs:documentation></xs:annotation><xs:element type="uuid" name="id"/><xs:element type="xs:positiveInteger" name="shortID"/><xs:element type="xs:string" name="name"/><xs:element type="xs:string" name="ipAddress"/></xs:choice></xs:complexType><xs:complexType name="segmentNameListType"><xs:sequence><xs:element type="xs:string" name="segmentNames"
minOccurs="1" maxOccurs="unbounded"><xs:annotation><xs:documentation>1 or more device segment names</xs:documentation></xs:annotation></xs:element></xs:sequence></xs:complexType><xs:complexType name="vlanIdRangeType" ><xs:choice><xs:element name="vlanID" type="vlan_Constraint"/><xs:element name="vlanRange" type="rangeType"/></xs:choice></xs:complexType><xs:complexType name="vlanListType" ><xs:sequence><xs:element name="vlan" type="vlanIdRangeType"minOccurs="1" maxOccurs="unbounded"/></xs:sequence></xs:complexType><xs:complexType name="physicalSegmentsType"><xs:sequence><xs:annotation><xs:documentation>1 or more repetitions:</xs:documentation></xs:annotation><xs:element type="deviceSegmentsType" name="physicalSegment"
maxOccurs="unbounded"></xs:element></xs:sequence></xs:complexType><xs:complexType name="deviceSegmentsType"><xs:sequence><xs:element type="deviceType" name="device"/><xs:element type="segmentNameListType" name="segmentNameList"/>27

SMS Web API Guide</xs:sequence></xs:complexType></xs:schema>

Reputation database management
Use this API to manage the SMS Reputation database. The following factors can affect performance levels:•

Method used for the Reputation entries submission – import or add. Use import with a large number of
entries to reduce the number of distributions.

•

Number of files to be imported into the Reputation database and the number of entries in each file.

•Number of entries on the SMS. A bigger reputation database takes longer to copy and distribute,
resulting in less frequent distributions. For improved performance, limit the entries in the Reputation
database to 6,000,000.

•

Number and type of devices that the SMS manages. Newer models load the entries faster. If you have alarge number of devices, increase the interval of entry submission so that the SMS is not overloaded withfrequent distributions.
Note
Monitor the device distribution queue to identify the appropriate time interval for submitting the Reputation
Management API requests in your environment.

This API includes:•

Import a Reputation entry•

Add a Reputation entry•

Delete a Reputation entry•

Query the Reputation database

Import a Reputation entry
Post and upload a file with one or more Reputation entries.
•

IP and DNS entries — Import file must be in a comma-separated value (CSV) format with each line
representing a Reputation entry without any blank lines. Each line is made up of one or more fields
separated by commas. The SMS can upload one file at a time, and each file can contain multiple entries.

•

URL entries — Import file must be delimited by a pipe (|) instead of a comma with each entry
representing URLs only or URLs associated with one or more tags. Each line is made up of one or more
fields separated by pipes. For more information about the URL import guidelines, see the URL Reputation
Filtering Deployment and Best Practices Guide.

•

Comment lines are discarded during import.

•

Each request results in a distribution and a sync time to the managed devices.

•

For improved performance, limit the number of entries in a file to between 1,000 and 10,000.

Definition
repEntries/import

28

SMS Web API Guide

Parameters
Parameter
type

Address

Tag category/tag value pairsTypestringstringstringDescription
Optional. Address type of the Reputation entry. Only one type is allowed within
a file.
•ipv4 (default)

•

ipv6

•

dns

•

url

Required.
•

The first field on each line must be the IPv4 address, IPv6 address, DNS
name, or URL for that entry. The remaining fields on a line are optional. If
present, remaining fields are processed as tag category/tag value pairs.

•

Only one type of address (IPv4, IPv6, DNS name, or URL) can be containedin a file.

•

A DNS entry matches any lookups that contain the specified string. For
example, foo.com matches foo.com, www.foo.com, andimages.foo.com. To specify an exact DNS entry match, enclose the DNS
name in square brackets. For example, [foo.com].

•

CIDR values are normalized. Any bits outside the portion of the address
specified by the prefix length are changed to zero. For example,
192.168.66.127/24 is stored as 192.168.66.0/24.

Optional. If the Reputation entry within the file does not have tags, theimported entry merges with the values of the existing entry. If the Reputation
entry within the file does have tags, the imported entry merges and overwrites
the values of the existing entry.
•

Any tag categories in the file must exist on the SMS prior to import.

•

Tag category/value pairs do not have to be listed in the same order on eachline. The entries in the file do not have to list all the tag categories or
specify the ones shared with other entries in the file.

•

Empty pairs of fields are ignored. If a tag category field is empty, an error
occurs and the entry is not imported. If a tag value field is empty, thecorresponding tag category is discarded and the next field of the entry is
processed; the net result is equivalent to the tag category not appearing onthat line at all.

•Except for yes/no tag categories, character case is significant in all tag
category names and tag values.

•

For yes/no tag categories, yes, true, t, and y, regardless of case, denote ayes (true) value. Other text is considered a no (false) value.

•

For list categories, the list values must be separated by ~~~.

•

A field can be enclosed in double-quotes; this is mandatory when a value
contains a comma that should not be treated as a field separator.

•

To represent a double-quote character within a quoted value, use two
double-quotes.

Examplecurl -v -k --header "X-SMS-API-KEY: <String>"-F "file=@/path/to/file.csv" "https://<sms_server>/repEntries/import?&type=ipv4"

29

SMS Web API Guide

Note
When you request back-to-back imports with files that have 10 or less Reputation entries, the SMS groups thoseentries to use the add method instead to reduce the number of distributions.

Add a Reputation entry
Create a Reputation entry.
•

Each request can result in a distribution and a sync time to the managed devices.

•

For improved performance, send requests in bursts up to 1,000 entries in time intervals that allow
distributions to complete in a timely manner.

Definition
repEntries/add

Parameters
Only one of the following parameters can be used in the request.
Type

Parameter

Descriptionip

IP address

IPv4 or IPv6 address of the Reputation entry.

dns

string

DNS address of the Reputation entry.

url

url

Reputation URL entry.

TagDatastringOptional. One or more tag categories and their values. Must be UTF-8 encoded andseparated by a comma (,).
Reputation entries with a list tag category can include multiple values only when the Allow
Multiple Values? check box is selected from the Edit Tag Category box on the SMS.
The list values must be separated by ~~~.
MalwareIpType,malwareSource~~~cncHost

Examplecurl -v -k --header "X-SMS-API-KEY: <string>""https://<sms_server>/repEntries/add?&ip=1.1.1.1&TagData=MalwareIpType,infectedHost,CreatedDate,%22Jan%2022,%202014%22"

Query the Reputation database
Search the Reputation database for one or more user Reputation entries.
•

Specify up to 10,000 entries in a single request.

•

The SMS returns all matching entries in the query in UTF-8 encoding.

•

Returned entries are ordered from lowest to highest address, regardless of the order in which they are
specified in the query.

•

Each entry is terminated by a newline character.

Definition
repEntries/query

30

SMS Web API Guide

Parameters
Only one parameter can be used in a request.
Parameter

Type

Descriptionip

IP address

IPv4 or IPv6 address of the Reputation entry.

dns

string

DNS address of the Reputation entry.

url

url

Reputation URL entry.

Examplecurl -v -k --header "X-SMS-API-KEY: <string>" "https://<sms_server>/repEntries/
query?&ip=1.1.1.1&ip=1.1.1.2"

Response
1.1.1.1,AtaHost,myata.device.com,MalwareIpType,infectedHost
1.1.1.2,AtaHost,myata.device.com,ThreatScore,28,MalwareIpType,cncHost~~~infectedHost

Delete a Reputation entry
Get and delete a Reputation entry.
•

Each request can result in a distribution and a sync time to the managed devices.

•

For optimal performance, delete Reputation entries with a file.

Definition
repEntries/delete

Parameters
Type

Parameter

Descriptionip

IP address

IPv4 or IPv6 address of the Reputation entry.

dns

string

DNS address of the Reputation entry.

url

url

Reputation URL entry.

criteria

integer

Required.
•

all: deletes all Reputation entries, including user-defined,•

user: deletes all user-defined entries.

•

repdv: deletes all RepDV entries.

•

entry: deletes specified entries.

•

threat-url: deletes the ThreatDV URL package.

RepDV, and the ThreatDV URL feed.

31

SMS Web API Guide

Parameter

Type

type

Description
Import a file with Reputation entries to delete on this SMS. This isrequired to delete a large number of Reputation entries by using a file.
Address type of the Reputation entry. Only one type is allowed within
a file.
•ipv4 (default)

•

ipv6

•

dns

•

url

Examplecurl -v -k --header "X-SMS-API-KEY: <string>""https://<sms_server>/repEntries/delete?&ip=1.1.1.1&ip=1.1.1.2&
dns=malware.source1.com&dns=malware.source2.com&criteria=entry"

Packet trace
The SMS Packet Trace feature compiles information about packets that have triggered a filter. Packet trace
encapsulates the information according to requirements set for the filter in the SMS.
Packet trace options are configured for an action set, and an action set is specified for each filter. Filters are
distributed to devices according to profiles. If a filter uses an action set for which packet trace logging isenabled, then you can view the compiled and stored packet trace information for events that triggered thefilter.
The SMS saves packet trace information to a PCAP file. Two retrieval options are available for a packet trace:•

Device-based packet trace•

Events-based packet trace

Device-based packet trace
Device-based packet trace compiles PCAP information for a particular device from the SMS database. For
more information, see DEVICE table.
Definition
pcaps/getByDevice

Parameters
Type

Parameter
device/id

stringDescription
Internal ID assigned to the device. This is the SHORT_ID for the device.

Examplecurl -k --header "X-SMS-API-KEY: <string>" "https://<sms_server>/pcaps/
getByDevice?deviceId=<SHORT_ID>"32

SMS Web API Guide

Events-based packet trace
To obtain all the PCAP information from the SMS for a group of events, you must know the event IDs. Event
IDs are included in data sent to a remote syslog server.
Definition
pcaps/getByEventIds

Set up event-based packet trace
1.

Set up a remote syslog server.

2.

Add all the event IDs to a file as a comma separated list. New line breaks are allowed. The result outputs
to STDOUT and can be redirected to a file with a '>' operator.

curl -k --header "X-SMS-API-KEY: <string>" -F "file=@<path/to/file.txt>""https://<sms_server>/pcaps/getByEventIds?"

Responder
Responder is a policy-based service in SMS that reacts to inputs to perform a set of actions. Its reactions, andthe set of actions it takes, are based on the Responder policies that have been configured.
By default, no policies can be externally triggered. To enable external triggering, configure the active
response policy to allow an SNMP trap or web service to invoke the policy.
This API includes the following:•

Quarantine•

Unquarantine

Quarantine
Quarantine an IP address and create a response.
Definition
quarantine/quarantine

Parameters
Type

Parameter

Descriptionip

IP address

IP address for the target host. Required to create or close a response.

id

integer

Response History ID that is displayed in the Response History table on the SMS.
•

To close a response, either IP or ID must be specified.

33

SMS Web API Guide

Parameter
policytimeoutTypestringDescription
Specific Active Response Policy to implement.

long

•

The policy name is case sensitive and must match an existing SMS Active Response
policy name.

•

The Allow an SNMP Trap or Web Service call to invoke this Policy initiation
setting must be enabled for this policy.

•

This argument is not necessary to close a response and, if provided, is ignored.

Optional argument to specify the duration of response.
•

The specified value overrides the default already in the policy.

•

If no parameter is specified, the timeout value from the policy is used.

•

This argument is not necessary to close a response and, if provided, is ignored.

Examplecurl -k --header "X-SMS-API-KEY: <string>" "https://<sms_server>/quarantine/
quarantine?ip=<target_ip>&policy=<policy_name>&timeout=<minutes_to_quarantine>"

Unquarantine
Unquarantine an IP address and close a response.
Definition
quarantine/unquarantine

Parameters
Type

Parameter

Descriptionip

IP address

IP address for the target host. Required to create or close a response.

id

integer

Response History ID that is displayed in the Response History table on the SMS.
•

policytimeout

34

stringlong

To close a response, either IP or ID must be specified.

Specific Active Response Policy to implement.
•

The policy name is case sensitive and must match an existing SMS Active
Response policy name.

•

The Allow an SNMP Trap or Web Service call to invoke this Policy
initiation setting must be enabled for this policy.

•

This argument is not necessary to close a response and, if provided, isignored.

Optional argument to specify the duration of response.
•

The specified value overrides the default already in the policy.

•

If no parameter is specified, the timeout value from the policy is used.

•

This argument is not necessary to close a response and, if provided, isignored.

SMS Web API Guide

Examplecurl -k --header "X-SMS-API-KEY: <string>" "https://<sms_server>/quarantine/
unquarantine?ip=<target_ip>"

Enterprise Vulnerability Remediation (eVR)
Use this API to import vulnerability scan (eVR) files to the SMS. After you import a vulnerability scan, youreview the following on the SMS:•

Vulnerabilities (listed by CVE) that have been discovered in your network.

•

Which assets impacted by those vulnerabilities.

•

Which DV filters can defend those assets from the discovered vulnerabilities.

This API includes:•

Import a vulnerability scan•

Convert a vulnerability scaneVR specifications
The minimum data required for a native SMS-standard vulnerability scan is:•

IP Address - (host IP addresses) The maximum number of host IP address and vulnerability
combinations that you can import on the SMS is 10 million. When the SMS reaches the maximum limit,
it displays an error message, and you must delete vulnerability scans on the SMS before you can import a
new scan using this API.

•CVE IDs - CVE must be in the format CVE-YYYY-NNNN where YYYY is a 4 digit year and NNNN is asequence number.

•

Severity - Vulnerabilities are assigned a severity levels to define the urgency associated with remediatingeach vulnerability. Rankings are based on a variety of industry standards including CVE.

CSV file specifications
Vulnerability scans must be in a native, comma-separated value (CSV) format before they can be used on the
SMS. If you use a supported vulnerability management product, custom converters are available for Qualys®,
Nexpose®, and Nessus®.
•

The first line in the CSV file must be the column headers for each of the columns.

•

Each row after the header must contain the same number of columns that are in the header.

•

Each column must be delimited with a comma.

•

The value within each column must be wrapped in double quotes; however, embedded double quotes are
not permitted ("This is "invalid" data").

•

Each row in a CSV file must be less than 65536 bytes.

Import a vulnerability scan
Import a vulnerability scan (eVR) file that is in native SMS-standard format.
35

SMS Web API Guide

Definition
vulnscanner/importParameters
Parameter
vendorType
stringDescription
Required. Name of the vulnerability management vendor.
•

Native SMS-standard format: Use SMS-Standard.

•

For other values, see Convert a vulnerability scan.

productstringRequired. Product name associated with the vulnerability scanner, and can be any value.

versionstringRequired. Version of the vulnerability scanning file format, and can be any value.

runtimedate

Required.
•

Scan start time and end time, and can be a single date or a date range.

•

When entering a date range, you must use a forward slash (/) to separate the scan start and scanend dates.

•

Date format must be yyyy-MM-dd'T'HH:mm:ss.SSS'Z

Examplescurl -k --header "X-SMS-API-KEY: <string>" -F "file=@ScanSample.csv""https://<sms_server>/vulnscanner/import?&vendor=Example&product=VulnScanner&version=2.2&runtime=2018-12-15T13:01:15.255Z/"

Convert a vulnerability scan
Convert a vulnerability scan (eVR) file that is not in native SMS-standard format to import to the SMS.
Definition
vulnscanner/convert

Parameters
Type

Parameter
vendor36

stringDescription
Required. Name of the vulnerability management vendor.
•

Nexpose•Qualys-CSV•

NessusproductstringRequired. Product name associated with the vulnerability scanner, and canbe any value.

versionstringRequired. Version of the vulnerability scanning file format, and can be any
value.

SMS Web API Guide

Parameter
runtimeType
date

Description
Required.
•

Scan start time and end time, and can be a single date or a date range.

•

When entering a date range, you must use a forward slash (/) to separate
the scan start and scan end dates.

•

The date format must be yyyy-MM-dd'T'HH:mm:ss.SSS'Z

ExamplesImport a vulnerability scan (eVR) in the Nexpose format:
curl -v -k --header "X-SMS-API-KEY: <string>" -F "file=@vulnScanSampleNexpose.xml""https://<sms_server>/vulnscanner/convert?&vendor=Nexpose&product=Nexpose&version=1.0&runtime=2014-01-20T13:01:15.255Z/2014-01-20T13:22:14.333Z"

Import a vulnerability scan (eVR) in the Qualys-CSV format:
curl -v -k --header "X-SMS-API-KEY: <string>" -F "file=@vulnScanSampleQualys.csv""https://<sms_server>/vulnscanner/convert?&vendor=Qualys-CSV&product=Qualys&version=1.0&runtime=2014-01-20T13:01:15.255Z/2014-01-20T13:22:14.333Z"

Import a vulnerability scan (eVR) in the Nessus format:
curl -v -k --header "X-SMS-API-KEY: <string>" -F "file=@vulnScanSampleNessus.nessus""https:<sms_server>/vulnscanner/convert?&vendor=Nessus&product=Nessus-Sample&version=1.0&runtime=2014-01-20T13:01:15.255Z/2014-01-20T13:22:14.333Z"

STIX/TAXIIThe SMS incorporates external threat intelligence. Structured Threat Information eXpression (STIX™) 2.0
data provides open source cyber threat intelligence, which can be transferred to the SMS using a Trusted
Automated eXchange of Indicator Information (TAXII) service. The advanced threat intelligence provided in
tag categories keeps the Reputation Database updated, and enables robust reputation filters for enhanced
protection of your system. You can use STIX/TAXII for IPS enforcement of IP, DNS, and URL Indicators ofCompromise (IoCs).
Reputation database
The SMS automatically includes the following predefined tag categories for STIX/TAXII data. Use thefollowing table to map STIX objects with user-provided Reputation tag categories.

37

SMS Web API Guide

Reputation tag
STIX - ID

STIX object property
id

Description
Identifies the STIX Indicator object, whichis the only STIX 2.0 Domain Object the SMS
imports.
Indicators contain a pattern that can beused to detect suspicious or malicious
cyber activity. For example, an indicator
may be used to represent a set of malicious
IP addresses, domains, or URLs.
To be imported to the Reputation
database, an indicator STIX object must:•

Only contain a single comparison
expression.

•

Object path pattern must be domain,
URL, IPv4, or IPv6.

STIX - Severity

labelsIdentifies the severity for the discovered
threat, based on rules that match severity.
This is not a standard property for STIX 2.0.

STIX - Confidence

labelsIdentifies the confidence for the discovered
threat, based on rules that match aconfidence score. This is not a standard
property for STIX 2.0.

Reputation Entries TTL

valid_until

Identifies the date SMS will remove theentry.

-

revokedThe SMS deletes the entry when it is taggedtrue.

Versions
This feature implements STIX/TAXII 2.
Import rules•

To automatically send STIX data to the SMS, enable the TAXII service. The TAXII service is enabled bydefault. For more information, see "Enable SMS Services" in the SMS User Guide.

•

Only STIX Indicator objects can be added to the Reputation database.

•

STIX Indicator objects must only contain a single comparison expression.

•

You cannot export STIX objects from the SMS.

Data format
BundleCollection of STIX objects grouped together in a single container.
Properties
Description

Parameter
type

38

Bundle type.

SMS Web API Guide

Parameter

Description

id

Bundle identifier.

spec_version

STIX specification version used to represent the content in the bundle.

objects(Optional). Specifies a set of one or more STIX Objects.

Example{}"id":"bundle--eac5fcf6-e5a4-40d9-8721-f0e79efdadf6","objects":[{"created":"2016-02-26T18:24:18.396Z","id":"indicator--a6f43caf-be25-4335-bfa1-badfc13b0bae","labels":["malicious-activity","sms-severity-high","sms-confidence-75"],"modified":"2016-02-26T18:24:18.396Z","pattern":"[domain-name:value = 'example.com']","type":"indicator","valid_from":"2016-02-26T18:24:18.396Z"}],"spec_version":"2.0","type":"bundle"

Indicators
Pattern that can be used to detect suspicious or malicious cyber activity.
Properties
Type

Parameter

Description

type

Value, must be indicator.

id

Object ID.

createdtimestamp

The time that the first version of the object was
created.

modifiedtimestamp

The time that this particular version was created.

labelsOne or multiple open vocabulary

Values that comes from the indicator-label-ov
vocabulary.

patternvalid pattern string

Detection pattern.

valid_fromtimestamp

The time when the indicator will not be valid.

valid_until

timestamp

The time when the indicator will not be valid.

revokedbooleanIndicates whether the object has been revoked.

Example{"id":"bundle--eac5fcf6-e5a4-40d9-8721-f0e79efdadf6",

39

SMS Web API Guide}"objects":[{"created":"2016-02-26T18:24:18.396Z","id":"indicator--a6f43caf-be25-4335-bfa1-badfc13b0bae","labels":["malicious-activity","sms-severity-high","sms-confidence-75"],"modified":"2016-02-26T18:24:18.396Z","pattern":"[domain-name:value = 'example.com']","type":"indicator","valid_from":"2016-02-26T18:24:18.396Z"}],"spec_version":"2.0","type":"bundle"

Pattern
STIX Patterns are composed of multiple building blocks, ranging from simple key-value comparisons to more
complex, context-sensitive expressions. The SMS only supports a pattern with a single comparison
expression.
"pattern":"[domain-name:value='example.com']"Comparsion expression
Object path
SMS only receives the following paths:•

domain-name:value•

ipv6-addr:value•

ipv4-addr:value•

url:valueComparison operator
The SMS Web API only supports the "=" comparison operator.

LabelsLabels come from the indicator-label-ov vocabulary.
Indicator label vocabulary
If an object contains a "benign" label, it is not added into the Reputation database.

40•

anomalous-activity•

anonymization•

benignSMS Web API Guide•

compromised•

malicious-activity•

attribution

STIX - Severity
The SMS tags the severity level as either low, medium, or high.
Label

Severity-severity-high-a-b-severity-low

lowseverity-low

lowseverity-LOW

lowseverity-low-aaa-

threatstream-severity-highhighthreatstream-severity-highba-

threatstream-severity-very-high

high

STIX - Confidence
The following table includes examples of how the SMS tags STIX - Confidence labels.
Confidence

Labelconfidence-99

99

aaa-confidence-99

99

confidence-50

50

confidence-101--confidence-99-

Server discovery
Provides general information about the TAXII server.
•

Common entry point for TAXII clients into the data and services provided by a TAXII server.

•

API Roots are logical groupings of TAXII channels, collections, and related functionality.

Definition
taxii

Parameters
Description

Parameter
title

Server name.

41

SMS Web API Guide

Parameter

Description

api_roots

List of URLs that identify known API roots.

default

Default API root.

Example{"title": "TippingPoint Security Management System","default": "https://1.2.3.4/taxii/feeds/","api_roots":["https://1.2.3.4/taxii/feeds/"]}

Get API root information
Provides general information about the API Root.
Definition
taxii/feeds

Parameters
Description

Parameter
title

Name.

versions

List of compatible TAXII versions.

max_content_length

Maximum size of the request body in octets (8-bit bytes).

Example{"title": "TAXII feeds","versions": ["taxii-2.0"],"max_content_length": 2097152}

Get collections
Provides information about the collections.
Requesttaxii/feeds/collections

Parameters
Description

Parameter42

idCollection ID.

title

Name used to identify the collection.

SMS Web API Guide

Parameter

Description

can_read

Indicates if you can read (GET) objects from the collection.

can_write

Indicates if you can write (POST) objects to the collection.

Response{}"collections": [{"id": "00000000-0000-0000-0000-000000000001","title": "User Reputation Entries","can_read": true,"can_write": false}]

Get objects
Retrieves objects from a collection.
Requesttaxii/feeds/collections

Add objects
Adds objects to a collection.
Definition
taxii/feeds/collections/

Example{}"id":"bundle--eac5fcf6-e5a4-40d9-8721-f0e79efdadf6","objects":[{"created":"2016-02-26T18:24:18.396Z","id":"indicator--a6f43caf-be25-4335-bfa1-badfc13b0bae","labels":["malicious-activity","sms-severity-high","sms-confidence-75"],"modified":"2016-02-26T18:24:18.396Z","pattern":"[domain-name:value = 'example.com']","type":"indicator","valid_from":"2016-02-26T18:24:18.396Z"}],"spec_version":"2.0","type":"bundle"

43

SMS Web API Guide

Get status
Provides information about the status of a previous request. In TAXII 2.0, the only request that can bemonitored is one to add objects to a Collection.
Definition
taxii/feeds/status

Parameters
Parameter

Description

idID

statusStatus of a previous POST request; the value of this property is complete or pending.

total_countTotal number of objects in the request.

success_countNumber of objects that were successfully created.

successes

List of object IDs that were successfully processed.

failure_countNumber of objects that failed to be created.

failures

List of status failures including object ID and message.

pending_countNumber of objects that have not been processed.

pendings

List of objects that have not been processed.

Response{}"id": "2d086da7-4bdc-4f91-900e-d77486753710","status": "pending","total_count": 3,"success_count": 1,"successes": ["indicator--c410e480-e42b-47d1-9476-85307c12bcbf"],"failure_count": 1,"failures": [{"id": "malware--664fa29d-bf65-4f28-a667-bdb76f29ec98","message": "Malware is an unsupported type"}],"pending_count": 1,"pendings": ["indicator--252c7c11-daf2-42bd-843b-be65edca9f61"]

Get an object
Gets an object from a Collection according to the ID.
Definition

44

SMS Web API Guidetaxii/feeds/collections/objects/<object-id>/

Get object manifests
Retrieves a manifest about objects from a collection.
Definition
taxii/feeds/collections/manifest

Database access
Used to access the SMS Web API.
Definition
dbAccess/tptDBServlet

Parameters
Description

Parameter
methodRequired.
•

DataDictionary•

GetData - Events data•

GetNewestRecord•

GetOldestRecord•

Schema•Status•VersionUsage sequence
Follow this sequence when accessing the SMS database:1.

Use the schema method to retrieve the schema definition. Apply the returned data to user-defined
database.

2.

Use the DataDictionary method to retrieve supporting data. Apply the returned data to database, andrepeat as needed to create profiles or activate Digital Vaccines.
When the SMS receives a valid request using this method, it can return an XML response. Specificresponse content depends on data you specify in the request.

3.

Use the GetData method to receive event data that you can then import into the database.

DataDictionary
Obtain SMS data dictionary information related to profiles, devices, segments, and virtual segments.
45

SMS Web API Guide

Definition
dbAcess/tptDBServlet?method=DataDictionary

Parameters
Parameter
format

mode

table

Description
Optional.
•sql (default)

•

csv

•

xml

Optional.
•

insert (default) – use with sql format.

•

update•replace – use with MySQL.

Optional. If you do not specify a table, all tables are included.
•

ACTIONSET table•

ALERT_TYPE table•

DEVICE table•

POLICY table•

PRODUCT_CATEGORY table•

PROFILE table•

PROFILE_INSTALL_INVENTORY table•

QUARANTINE_NETWORK_DEVICES table•

SEGMENT table•

SEGMENT_GROUP table•

SIGNATURE table•

TAXONOMY_MAJOR table•

TAXONOMY_MINOR table•

TAXONOMY_PLATFORM table•

TAXONOMY_PROTOCOL table•

THRESHOLD_UNITS table•

VIRTUAL_SEGMENT table

ACTIONSET table
Record defined by the user and applied to a POLICY. Used to determine the action that is taken when a
POLICY is triggered.
Definition
dbAccess/tptDBServlet?method=DataDictionary&table=ACTIONSET

46

SMS Web API Guide

Parameters
ColumnDescription

ID

Unique identifier. use this column to join from other tables.

NAME

Descriptive name.

RATE

Rate limit value applied to the action set. Has a value specifying the RATE to be applied for
rate limit action sets.

FLOW_CONTROL

Traffic flow indicator.
•

ALLOW

•

DENY

•

TRUST

•

RATE

ALERT_TYPE table
Descriptive name for alerts.
Definition
dbAccess/tptDBServlet?method=DataDictionary&table=ALERT_TYPE

Parameters
Description

ColumnID

Unique identifier.

NAME

Descriptive name.

DEVICE table
Record for each of the IPS devices managed on the SMS.
Definition
dbAccess/tptDBServlet?method=DataDictionary&table=DEVICE

Parameters
Description

ColumnID

Unique identifier.

SHORT_ID

Lookup identifier.

NAME

Descriptive name of the device provided during device installation.

MODEL

String that represents the model of the device.

SERIAL_NUMBER

Alpha-numeric TippingPoint serial number.

IP_ADDRESSIP address for the management port for the device.

LOCATION

Descriptive location text entered during device installation.

47

SMS Web API Guide

ColumnDescription

DV_VERSION

Current version of the Digital Vaccine installed on the device; if the device is a Core
Controller, this field is null.

OS_VERSION

Current version of the TOS installed on the device.

DEVICE_GROUP

Name of the group to which the device belongs.

MANAGED

Boolean to show if the device is currently managed on the SMS.

POLICY table
Holds objects that determine what actions to take for a SIGNATURE.
Definition
dbAccess/tptDBServlet?method=DataDictionary&table=POLICY

Parameters
Description

ColumnID

Unique identifier.

PROFILE_ID

Identifier of the PROFILE object that contained this POLICY.

SIGNATURE_ID

Identifier of the SIGNATURE this object is defining in a POLICY.

ACTIONSET_ID

Identifier for the ACTIONSET applied to this object.

DISPLAYNAME

Descriptive name for the POLICY, which is usually the same as the SIGNATURE referenced by
SIGNATURE_ID; however, THRESHOLDS allow you to name the POLICY.

MULTIPART_GROUP_ID

Identifier for SMS policy group.

PRODUCT_CATEGORY table
Maintains the names used for SIGNATURE categories. The SIGNATURE table contains a number that is joined
to the ID field in this PRODUCT_CATEGORY table.
Definition
dbAccess/tptDBServlet?method=DataDictionary&table=PRODUCT_CATEGORY

Parameters
Description

ColumnID

Unique identifier. Use this column to join from other tables.

NAME

Descriptive name.

PROFILE table
Container for your POLICY entries. Name the PROFILE, make changes to the POLICY objects, and thendistribute to a segment group.
48

SMS Web API Guide

Definition
dbAccess/tptDBServlet?method=DataDictionary&table=PROFILE

Parameters
ColumnDescription

ID

Unique identifier.

VERSION

Current profile version.

NAME

Profile name.

DESCRIPTION

Profile description.

PROFILE_INSTALL_INVENTORY table
Container for items associated with PROFILE entries.
Definition
dbAccess/tptDBServlet?method=DataDictionary&table=PROFILE_INSTALL_INVENTORY

Parameters
Description

ColumnVIRTUAL_SEGMENT_ID

Lookup identifier for the virtual segment where the profile was distributed.

PROFILE_ID

Lookup identifier for the profile details.

PROFILE_VERSION

Profile version.

DISTRIBUTE_ID

Lookup identifier for the distribution details.

COMPLETE_TIME

Time the profile distribution completed.
•

Value is in milliseconds since Jan. 1, 1970 00:00:00 GMT

QUARANTINE_NETWORK_DEVICES table
Contains the defined quarantine switches.
Definition
dbAccess/tptDBServlet?method=DataDictionary&table=QUARANTINE_NETWORK_DEVICES

Parameters
Description

ColumnNAME

Descriptive name for the network device switch type.

IP_ADDRESSIP address for the switch.

SEGMENT table
Represents a physical segment on a device.
49

SMS Web API Guide

Definition
dbAccess/tptDBServlet?method=DataDictionary&table=SEGMENT

Parameters
ColumnDescription

ID

Unique identifier.

DEVICE_ID

Device to which this segment belongs.

NAME

Descriptive name.

IP_ADDRESSOBSOLETE IP Address that may be given to the segment.

SLOT_INDEXInternal chassis slot number.

SEGMENT_INDEX•

Physical segments: 3•

Virtual segments: 0•

Physical segments: Physical segment number•

Virtual segments: 0

SEGMENT_GROUP table
Represents a group of physical segments.
Definition
dbAccess/tptDBServlet?method=DataDictionary&table=SEGMENT_GROUP

Parameters
Description

ColumnID

Unique identifier.

NAME

Descriptive name for the segment group when it was created.

SIGNATURE table
Details the currently active Digital Vaccine package on the SMS for use with devices. The table grows as new
Digital Vaccines are released, downloaded, and activated.
Definition
dbAccess/tptDBServlet?method=DataDictionary&table=SIGNATURE

Parameters
Description

Column50

ID

Unique identifier.

NUMBER

Integer used to reference the signature, which is assigned by Trend.

SMS Web API Guide

ColumnSEVERITY_ID

Description
Identifier for the SEVERITY of the SIGNATURE.
•

Join to SEVERITY.ID to obtain a descriptive name of the SEVERITY.

NAME

Signature name.

CLASS

Descriptive classification for the SIGNATURE.

PRODUCT_CATEGORY_ID

Category ID from PRODUCT_CATEGORY table, provided by Trend.

PROTOCOL

Signature protocol.

TAXONOMY_ID

Taxonomy classification.

CVE_ID

Comma-separated list of CVE IDs that can be used to link to the CVE database.

BUGTRAQ_ID

Comma-separated list of BugTraq IDs that can be used to link to the BugTraq database.

DESCRIPTION

Signature description, which is provided by Trend.

MESSAGE

Message that can be filled in with ALERTS.
•MESSAGE_PARMS values to create a dynamic message for this SIGNATURE.

TAXONOMY_MAJOR table
Details the TippingPoint signature taxonomy major classifications.
Definition
dbAccess/tptDBServlet?method=DataDictionary&table=TAXONOMY_MAJOR

Parameters
Description

ColumnID

Unique identifier.

NAME

Short name.

DESCRIPTION

Description.

TAXONOMY_MINOR table
Details the TippingPoint signature taxonomy minor classifications.
Definition
dbAccess/tptDBServlet?method=DataDictionary&table=TAXONOMY_MINOR

Parameters
Description

ColumnID

Unique identifier.

MAJOR_ID

Identifier of the major classification ID to which this minor classification relates.

DESCRIPTION

Description.

51

SMS Web API Guide

TAXONOMY_PLATFORM table
Details the TippingPoint signature platforms.
Definition
dbAccess/tptDBServlet?method=DataDictionary&table=TAXONOMY_PLATFORM

Parameters
ColumnDescription

ID

Unique identifier.

DESCRIPTION

Description.

TAXONOMY_PROTOCOL table
Details the TippingPoint signature protocols.
Definition
dbAccess/tptDBServlet?method=DataDictionary&table=TAXONOMY_PROTOCOLParameters
Description

ColumnID

Unique identifier.

DESCRIPTION

Description.

THRESHOLD_UNITS table
Defines the units in which thresholds can be specified.
Definition
dbAccess/tptDBServlet?method=DataDictionary&table=THRESHOLD_UNITS

Parameters
Description

ColumnID

Unique identifier.

NAME

Descriptive name for the unit entry.

VIRTUAL_SEGMENT table
Represents a virtual physical segment on a device.
Definition
dbAccess/tptDBServlet?method=DataDictionary&table=VIRTUAL_SEGMENT

52

SMS Web API Guide

Parameters
ColumnDescription

ID

Unique identifier.

DEVICE_ID

Device to which this segment belongs.

SEGMENT_GROUP_ID

Segment group to which this segment belongs.

NAME

Descriptive name.

GetData - Events data
Request data from specified tables.
Definition
dbAccess/tptDBServlet?method=GetData

Parameters
Value

Parameter
begin_time

integer

Description
Required.
•

end_time

integer

Required.
•table

Expressed as the number of milliseconds since 01-01-1970 00:00:00
GMT

Optional.

formatlimit

Expressed as the number of milliseconds since 01-01-1970 00:00:00
GMT

integer•csv (default)

•

sql

•

xml

Optional.
•

Maximum number of values returned.

•

All values are returned by default.

Required. Events data:•

ALERTS table•

DDOS_STATS table•

FIREWALL_BLOCK_ALERTS table•

FIREWALL_TRAFFIC_ALERTS table•

PORT_TRAFFIC_STATS table•

QUARANTINE_HOSTS table•

RATELIMIT_STATS table

ALERTS table

53

SMS Web API Guide

Contains information pertaining to the event that caused a POLICY to trigger.
•

When an ACTIONSET is applied to a POLICY and it has a Management Console notification selected, it isput in the ALERTS table.

•

The primary key, a unique key, is a four column index, DEVICE_ID, ALERT_TYPE_ID, SEQUENCE_NUM,
and END_TIME.

•

The table is expected to have a continuous growth pattern and contain millions of records.

Definition
dbAccess/tptDBServlet?method=GetData&table=ALERTS

Parameters
Description

ColumnSEQUENCE_NUM

DEVICE_ID

ALERT_TYPE_ID

Reference to a particular logs row entry counter.
•

The ALERT_TYPE column defines the log being referenced.

•

This sequence number is not reliable as far as counting on it behaving as an ever increasing
sequential number. It can be reset on the device and repeated for new events.

Identifier for the DEVICE entry that sent the notification.
•

Second part of the ALERTS table unique index.

•

A foreign key to the DEVICE table was left off for the purpose of performance and due to thepossibility that a DEVICE entry may not have been yet stored in the DEVICE table for this external
database.

The TYPE column is the third and final primary key constraint on the ALERTS table.
•

POLICY_ID

Identifier used to map this alert to a POLICY table entry.

SIGNATURE_ID

Identifier used to map this alert to a SIGNATURE table entry.

BEGIN_TIME

Time at which the event was first started or previously logged.

END_TIME

54

This field can be joined to the ALERT_TYPE table for a descriptive name for this column.

•

Value is in milliseconds elapsed since Jan. 1, 1970 00:00:00 GMT•

When using notification aggregation, this value and the END_TIME typically are off by the numberof minutes specified in the aggregation setting.

•

The difference between BEGIN_TIME and END_TIME may be larger if a lot of time passes between
attack events.

•

When aggregation is turned off, the BEGIN_TIME usually is the same as the END_TIME.

Time at which the notification was logged and sent to the Management Console.
•

Value is in milliseconds elapsed since Jan. 1, 1970 00:00:00 GMT•

Subtract BEGIN_TIME from END_TIME to determine the length of an attack, if aggregation is being
used.

•

Difference between BEGIN_TIME and END_TIME might be unexpectedly large if a lot of time passes
between attack events.

HIT_COUNTCounter displaying the number of times the event triggered before the notification was sent to theManagement Console.

SRC_IP_ADDR

Source IP of the packet causing the notification. Numeric value of an IPv4 address, or the low-order 64
bits for an IPv6 address if SRC_IP_ADDR_HIGH is not NULL.

SMS Web API Guide

ColumnDescription

SRC_IP_ADDR_HIGH

Source IP of the packet causing the notification. Numeric value of high-order 64 bits for an IPv6
address.

SRC_PORT

Source port of the packet causing the notification.

DST_IP_ADDR

Destination IP of the packet causing the notification. Numeric value of an IPv4 address, or the loworder 64 bits for an IPv6 address if DST_IP_ADDR_HIGH is not NULL.

DST_IP_ADDR_HIGH

Destination IP of the packet causing the notification. Numeric value of high-order 64 bits for an IPv6
address.

DST_PORT

Destination port of the packet causing the notification.

VIRTUAL_SEGMENT_INDEX

Identifier for which device segment this alert was seen on.

PHYSICAL_PORT_IN

Device port on which the event was detected.

VLAN_TAGVLAN identifier contained in the event.

SEVERITY

SEVERITY of the event. Usually corresponds to the SIGNATURE.SEVERITY column, joined by the
SIGNATURE_ID column. A foreign key constraint to the SEVERITY table has been applied here.

PACKET_TRACE

Indicates if a packet trace is available on the device.

DEVICE_TRACE_BUCKETPart of the device packet trace identifier.

DEVICE_TRACE_BEGIN_SEQ

Part of the device packet trace identifier.

DEVICE_TRACE_END_SEQ

Part of the device packet trace identifier.

MESSAGE_PARMS

Variable list of message parameters.
•

Value can be tokenized and combined with the SIGNATURE.MESSAGE data to display a dynamic
ALERT message.

•

Join SIGNATURE_ID with SIGNATURE.ID to retrieve the SIGNATURE.MESSAGE data. The
MESSAGE_PARMS string is a delimited string, the delimiter is the “|” character.

•

The SIGNATURE.MESSAGE string contains place holders for these strings, the place holders are %1,%2, ..., %n.

•

The tokenized MESSAGE_PARMS replaces the %n values based on their location in the string.

ExampleMESSAGE_PARMS=Austin|Texas SIGNATURE.MESSAGE=%1 is in %2.

The preceding parameters and message generates the following message:
Austin is in Texas.

QUARANTINE_ACTION

Quarantine action taken, either Added or Removed; used only in quarantine logs.

FLOW_CONTROL

Action taken by the action set: Permit, Rate Limit, or Trust.

ACTION_SET_UUIDAction set UUID; used only in rate limit logs.

ACTION_SET_NAME

Rate limit action; used only in rate limit logs.

RATE_LIMIT_RATE

Rate for rate limit logs; a numerical value followed by a unit. The unit can be Kbps or Mbps.

CLIENT_IP_ADDRLong value of the Client IP address (Capture Additional Event Information must be enabled).

CLIENT_IP_ADDR_HIGHLong value of the Client IP address (Capture Additional Event Information must be enabled). For IPV6
only.

55

SMS Web API Guide

ColumnDescription

XFF_IP_ADDRLong value of the X-Forwarded-For IP address (Capture Additional Event Information must be
enabled).

XFF_IP_ADDR_HIGHLong value of the X-Forwarded-For IP address (Capture Additional Event Information must be
enabled). For IPV6 only.

TCIP_IP_ADDRLong value of the True-Client-IP address (Capture Additional Event Information must be enabled).

TCIP_IP_ADDR_HIGHLong value of the True-Client-IP address (Capture Additional Event Information must be enabled).
For IPV6 only.

URI_METHOD

Method of the URI.

URI_HOST

Host of the URI.

URI_STRING

URI string.

SRC_USER_NAME

User name on the source machine.
•

User ID IP Correlation must be configured on the SMS to retrieve this information.

•

User ID IP Correlation is a feature that enables the SMS to collect user authentication data directly
and continuously from an Identity Agent device.

SRC_DOMAIN

Name of the source domain.

SRC_MACHINE

Name of the source machine.

DST_USER_NAME

User name on the destination machine.

DST_DOMAIN

Name of the destination domain

DST_MACHINE

Name of the destination machine.

DDOS_STATS table
Data accumulated from the device for Advanced DDoS policies.
Definition
dbAccess/tptDBServlet?method=GetData&table=DDOS_STATSParameters
Description

ColumnPOLICY_ID

POLICY ID.

STAT_TIME

Time the data was collected.
•

56

Time is stored in milliseconds since Jan. 1, 1970 00:00:00 GMTREJECT_SYNS

Number of rejected SYN requests for the stat period.

PROXIED_CXNS

Number of proxied connections for the stat period.

CPS_CXNS

Number of Connections Per Second over stat period.

BLOCKED_CPS_CXNS

Number of blocked CPS in stat period.

CFLOOD_CXNS

Number of Connection Flood connections in stat period.

BLOCKED_CFLOOD_CXNS

Number of blocked Connection Flood connections in stat period.

SMS Web API Guide

FIREWALL_BLOCK_ALERTS table
Contains information pertaining to logs where traffic has been permitted by firewall rules that have logging
enabled, including packets that were permitted by the content filtering configuration.
Definition
dbAccess/tptDBServlet?method=GetData&table=FIREWALL_BLOCK_ALERTS

Parameters
ColumnDescription

SEQUENCE_NUM

Reference to a particular logs row entry counter.

DEVICE_ID

Identifier for the DEVICE entry that sent the notification.

BEGIN_TIME

Time in which the event was first started.

END_TIME•

When using notification aggregation, this value and the TIME_END typically are off by
the number of minutes specified in the aggregation setting.

•

When aggregation is turned off, the BEGIN_TIME usually is the same as the TIME_END.
This value is in milliseconds since Jan. 1, 1970 00:00:00 GMT.

Time in which the notification was sent to the Management Console.
•

Subtracting BEGIN_TIME from TIME_END can determine the length of an attack if
aggregation is being used.

•

This value is in milliseconds since Jan. 1, 1970 00:00:00 GMT

HIT_COUNT

Number of times the firewall rule was applied.

SRC_IP_ADDR

Source IP of the packet causing the notification.

SRC_PORT

Source port of the packet causing the notification.

DST_IP_ADDR

Destination IP of the packet causing the notification.

DST_PORT

Destination port of the packet causing the notification.

RULE_ID

Unique identifier for rule to monitor traffic between security zones.

PROTOCOL_NAME

Packet type.

PROTOCOL_NUMBER

Number associated with the protocol in the filter.

PROTOCOL_TYPE

Protocol that was used to respond to the event.

IN_ZONE_UUIDSecurity zone from which the attack originated.

OUT_ZONE_UUIDSecurity zone from which the attack was targeted.

PHYSICAL_PORT_IN

Device port on which the attack was detected.

VLAN

Local VLAN that was targeted.

CATEGORY

Type of traffic filter that was activated.

URL

URL associated with the attack.

URL_INFO

Additional information relevant to the URL.

SEVERITY_ID

Severity of the attack.

57

SMS Web API Guide

FIREWALL_TRAFFIC_ALERTS table
Contains information pertaining to logs where traffic has been permitted by firewall rules that have logging
enabled, including packets that were permitted by the content filtering configuration.
Definition
dbAccess/tptDBServlet?method=GetData&table=FIREWALL_TRAFFIC_ALERTS

Parameters
ColumnDescription

SEQUENCE_NUM

Reference to a particular logs row entry counter.

DEVICE_ID

Identifier for the DEVICE entry that sent the notification.

END_TIME

Time in which the notification was sent to the Management Console.
•

Value is in milliseconds (since Jan. 1, 1970 00:00:00 GMT)•

Subtract BEGIN_TIME from TIME_END to determine the length of an attack, if
aggregation is being used.

SRC_IP_ADDRPacket source IP address.

SRC_PORT

Packet source port.

DST_IP_ADDRPacket destination IP address.

DST_PORT

Packet destination port.

RULE_ID

Unique identifier to monitor traffic between security zones.

PROTOCOL_NAME

Packet type.

PROTOCOL_NUMBER

Protocol number in the filter.

IN_ZONE_UUIDSecurity zone from which the attack originated.

OUT_ZONE_UUIDSecurity zone from which the attack was targeted.

CATEGORY

Type of traffic filter that was activated.

DURATION

Duration of the attack.

URL

URL that was associated with the attack.

TRANSFER_BYTES

Number of bytes transferred for the event.

MESSAGEDynamic ALERT message.

PORT_TRAFFIC_STATS table
Contains information of traffic going through each IPS port.
Definition
dbAccess/tptDBServlet?method=GetData&table=PORT_TRAFFIC_STATS

58

SMS Web API Guide

Parameters
ColumnDescription

DEVICE_ID

Identifier for the DEVICE entry that sent the notification.

PORT_ID

Identifier for the PORT entry that the traffic is going through.

SMS_TIME

SMS time in which the statistics get captured.

DEVICE_TIME

Device SMS time in which the statistics get captured.

IN_OCTETS

Device SMS time in which the statistics get captured.

OUT_OCTETS

Total traffic going out the port.

QUARANTINE_HOSTS table
Contains device and SMS quarantine actions.
Definition
dbAccess/tptDBServlet?method=GetData&table=QUARANTINE_HOSTS

Parameters
Description

ColumnID

Unique identifier for the table entry.

QUARANTINED_IP

IP address of the quarantined host.

QUARANTINED_MAC

MAC address of the quarantined host.

POLICY_NAME

Descriptive name for the policy that triggered the host quarantine.

STATE

Current state of the host.
•

UNQUARANTINED•QUARANTINED•INITIAL•ERRORAUTHORITY

Source of the quarantine state for the host.

CREATE_TIME

Time the initial quarantine state was set.

LAST_UPDATETime of the last quarantine state change.

RATELIMIT_STATS table
When using RATELIMIT ACTIONSETs, this data is accumulated from the DEVICE.
If you are using RATELIMIT ACTIONSETs, this table is expected to have a continuous growth pattern andcontain millions of records.
Definition
dbAccess/tptDBServlet?method=GetData&table=RATELIMIT_STATS

59

SMS Web API Guide

Parameters
ColumnDescription

ACTIONSET_ID

Identifier of the ACTIONSET table entry for this record.

STAT_TIME

Time this stat was recorded.
Time is milliseconds since Jan. 1, 1970 00:00:00 GMT•

DEVICE_ID

Identifier for the DEVICE.

RATE

RATE in kbps.

VALUE

Number of Bytes.

GetNewestRecord
Retrieve the newest record of a specific table.
Definition/dbAccess/tptDBServlet?method=GetNewestRecord

Parameters
Description

Parameter
table•

ALERTS table•

DDOS_STATS table•

FIREWALL_BLOCK_ALERTS table•

FIREWALL_TRAFFIC_ALERTS table•

PORT_TRAFFIC_STATS table•

QUARANTINE_HOSTS table•

RATELIMIT_STATS table

GetOldestRecord
Retrieve the oldest record of a specific table.
Definition/dbAccess/tptDBServlet?method=GetOldestRecord

60

SMS Web API Guide

Parameters
Parameter

Description

table

•

ALERTS table•

DDOS_STATS table•

FIREWALL_BLOCK_ALERTS table•

FIREWALL_TRAFFIC_ALERTS table•

PORT_TRAFFIC_STATS table•

QUARANTINE_HOSTS table•

RATELIMIT_STATS table

SchemaObtain SMS database schema information. The SMS returns the schema information in Oracle 8i or MySQL
4.0 compliant data definition language (DDL) statements.
Definition
dbAccess/tptDBServlet?method=Schema

Parameters
Description

Parameter
database

Only valid for sql format.
•

MySQL (default)•

OracleExamplecurl -k --header "X-SMS-API-KEY: <string>" "https://<sms_server>/dbAccess/tptDBServlet?method=Schema

StatusReturns the status of the SMS web API support.
Definition
dbAccess/tptDBServlet?method=Status

Response•

OK: SMS web API support is enabled and running.

•

Not Found: SMS web API support is not enabled.

VersionReturns the version number of the SMS.
61

SMS Web API Guide

Definition
dbAccess/tptDBServlet?method=Version

External database
The external database can be used for customized reporting. For custom reports, you can access the SMS
database directly or replicate the SMS to your external server. If you require data that the SMS reports do not
routinely provide, you can set up an SMS External Database with a reporting tool of your choice.
The SMS supports the following database options:•

External access - direct access to the database.

•External replication - remote replication of the database, which provides a copy of the database that canbe edited, backed up, or used for offloading report functions. Data that you access remotely is read-only
and cannot be changed.

External access•

Set up the access service to allow an external database tool to access data on the SMS. Do this before you
configure the external application.

•

Reboot the SMS to enable or disable this service.

External replication•

Set up the replication service to allow an external database server to replicate data from the SMS.

•

Reboot the SMS to enable or disable this service.

Configure the SMS for external access
Open a MariaDB read-only database for any third-party access or reporting tool. The read-only database isnamed ExternalAccess.
Procedure
1.

On the SMS, go to Admin > Database > External Database Settings > Edit.

2.

Select External Access Settings > Enable external database access.

3.

Enter the following:

4.

•

Username – Provide the user name for an account with sufficient rights to read all the desired datafrom the SMS database.

•

Password – Enter and confirm the password.

If you changed the external access settings, click Reboot to restart the SMS server and initialize theservice.
Note
Follow your company’s server downtime policies, including notification to SMS clients of a pending reboot.
Before you reboot the SMS, gracefully stop other client connections to the server.

62

SMS Web API Guide

5.

Click OK.
If verification fails:•

Verify that the username/password on the database matches the SMS.

•

Reboot the SMS before you try to access the database.

•Running a complex report against SMS server may slow down the SMS response time significantly.

ALERTS table – ExternalAccess
The database name is ExternalAccess.
Parameters
Description

ColumnSEQUENCE_NUM

Reference to a particular logs row entry counter.

DEVICE_ID

Identifier for the DEVICE entry that sent the notification.

ALERT_TYPE_ID

This field can be joined to the ALERT_TYPE table for a descriptive name for this column.

POLICY_ID

Identifier used to map this alert to a POLICY table entry.

SIGNATURE_ID

Identifier used to map this alert to a SIGNATURE table entry.

BEGIN_TIME

Time at which the event was first started or previously logged.

END_TIME

Time at which the notification was logged and sent to the Management Console.

HIT_COUNTCounter displaying the number of times the event triggered before the notification was sent to theManagement Console.

SRC_IP_ADDR

Source IP of the packet causing the notification.

SRC_IP_ADDR_2

Represents the higher 64 bit for the IPv6 source addresses. For IPv4 address, this field has a NULL value.

SRC_PORT

Source port of the packet causing the notification.

DST_IP_ADDR

Destination IP of the packet causing the notification.

DST_IP_ADDR_2

Represents the higher 64 bit for the IPv6 destination addresses. For IPv4 address, this field has a NULL
value.

DST_PORT

Destination port of the packet causing the notification.

VIRTUAL_SEGMENT_INDEX

Identifier for which device segment this alert was seen on.

PHYSICAL_PORT_IN

Device port on which the event was detected.

VLAN_TAGVLAN identifier contained in the event.

SEVERITY

SEVERITY of the event. Usually corresponds to the SIGNATURE.SEVERITY column, joined by the
SIGNATURE_ID column. A foreign key constraint to the SEVERITY table has been applied here.

PACKET_TRACE

Indicates if a packet trace is available on the device.

DEVICE_TRACE_BUCKETPart of the device packet trace identifier.

DEVICE_TRACE_BEGIN_SEQ

Part of the device packet trace identifier.

DEVICE_TRACE_END_SEQ

Part of the device packet trace identifier.

63

SMS Web API Guide

ColumnDescription

MESSAGE_PARMS

Variable list of message parameters.

QUARANTINE_ACTION

Quarantine action taken, either Added or Removed; used only in quarantine logs.

FLOW_CONTROL

Action taken by the action set: Permit, Rate Limit, or Trust.

ACTION_SET_UUIDAction set UUID; used only in rate limit logs.

ACTION_SET_NAME

Rate limit action; used only in rate limit logs.

RATE_LIMIT_RATE

Rate for rate limit logs; a numerical value followed by a unit. The unit can be Kbps or Mbps.

CLIENT_IP_ADDRLong value of the Client IP address (Capture Additional Event Information must be enabled).

CLIENT_IP_ADDR_HIGHLong value of the Client IP address (Capture Additional Event Information must be enabled). For IPV6
only.

XFF_IP_ADDRLong value of the X-Forwarded-For IP address (Capture Additional Event Information must be
enabled).

XFF_IP_ADDR_HIGHLong value of the X-Forwarded-For IP address (Capture Additional Event Information must be
enabled). For IPV6 only.

TCIP_IP_ADDRLong value of the True-Client-IP address (Capture Additional Event Information must be enabled).

TCIP_IP_ADDR_HIGHLong value of the True-Client-IP address (Capture Additional Event Information must be enabled).
For IPV6 only.

URI_METHOD

URI method.

URI_HOSTURI host.

URI_STRING

URI string.

SRC_USER_NAME

Source machine user name.

SRC_DOMAIN

Source domain name.

SRC_MACHINE

Source machine name.

DST_USER_NAME

Destination machine user name.

DST_DOMAIN

Destination domain name.

DST_MACHINE

Destination machine name.

Configure the SMS for replication
This service allows an external database server to replicate data from the SMS. Using an external database fordata replication allows you to offload report processing to an external server which can provide performancegains to your existing system. Reboot the SMS to completely enable or disable this service.
Before you begin, make sure that your replication system has sufficient disk space to accommodate thedatabase and any increase in size due to additional data or reporting.
Procedure64

1.

In the SMS, go to Admin > Database.

2.

On the External Database Settings panel, click Edit.

SMS Web API Guide

3.

In the Edit External Database Settings wizard, select External Replication Settings.
Note
To configure external database replication, you must create an SMS database snapshot, and then copy thesnapshot to the target replication system and import it into a MariaDB database before the SMS server canreplicate its data to the target system.

4.

Select Enable external database replication to enable the service. (To disable the service, clear the
check box.)

5.

Provide the following:

6.

•

Username – Provide the user name for an account with sufficient rights to read all the desired datafrom the SMS database.

•

Password – Provide the password for the user account. Retype the password in the Confirm
Password field.

If you changed the replication settings, click Reboot to restart the SMS server and initialize the service.
Note
Follow your company’s server downtime policies, including notification to SMS clients of a pending reboot.
Before you reboot the SMS, gracefully stop other client connections to the server.

7.

Click Create Snapshot, and select Include Events in Snapshot if you want the snapshot to include event
data.
Note
The snapshot is saved locally on the SMS server. You must copy the snapshot to the target replication system
and import it into a new or existing MariaDB database before the SMS server can replicate its data to the target
system.

8.

Click OK.
Note
External database replication and the SMS High Availability (HA) features both leverage the same functionality
in the underlying MariaDB database. The SMS database does not support replication to multiple destinations;
therefore, we do not recommend using SMS HA and external database replication at the same time.

Replication – database schema
Includes the following tables created when you dump the snapshot file to the replicated database server.
Some of the tables are for internal use only. The rest of tables are divided into two categories: DataDictionary
and Events Data.

Configure the SMS to enable restricted accessThis service allows access to the external database to be restricted to a set of IP addresses.
65

SMS Web API Guide

Procedure1.

In the SMS, go to Admin > Database.

2.

On the External Database Settings panel, click Edit.

3.

In the Edit External Database Settings wizard, select Access Restrictions.

4.

Select Enable restricted access to enable the service. (To disable the service, clear the check box.)

5.

Provide the following:•

6.

Named IP Address Group – To restrict a set of IP addresses, click the arrow, and either select a
Named IP Address Group or create a new one.

Click OK.

MIB files for the SMS
A management information base (MIB) is a type of database that is used to manage devices in acommunications network. Database entries are addressed through object identifiers (OIDs). MIB files aredescriptions of network objects that can be managed using the Simple Network Management Protocol(SNMP). The format of the MIB is defined as part of the SNMP.
This information includes the following topics:
SMS MIBs
Public MIB files
Health monitoring

SMS MIBs
You can download TippingPoint SMS MIB files from the TMC at https://tmc.tippingpoint.com. On the TMC
website, navigate to the Documentation area for this product release, and then select SMS MIBS.
The compressed file contains two MIB files:•

TPT-SMSMIBS defines monitoring functions•

TPT-SMS-TRAP-MIB defines the SMS traps

For more information about these MIBs, refer to the TippingPoint MIB Guide for TOS v3.9.0, available on the
TMC.

Public MIB files
Publicly available UCD-SNMP-MIB and UCD-DISKIO-MIB definitions can be used to query SMS health values.
These files can be downloaded from the following locations:66•

http://net-snmp.sourceforge.net/docs/mibs/•

http://net-snmp.sourceforge.net/docs/mibs/UCD-SNMP-MIB.txt•

http://net-snmp.sourceforge.net/docs/mibs/UCD-DISKIO-MIB.txt

SMS Web API Guide

Note that only the SMS Health Section OIDs listed in Health monitoring are supported.

Health monitoring
The following table lists the OIDs that are used to graph and display values in the SMS Health section of the
SMS client.
SectionDescription

OID

CPU_USER

1.3.6.1.4.1.2021.11.50.0

CPU_SYS

1.3.6.1.4.1.2021.11.52.0

CPU_IDLE

1.3.6.1.4.1.2021.11.53.0

FS_DSKPATH

1.3.6.1.4.1.2021.9.1.2

FS_DEVPATH

1.3.6.1.4.1.2021.9.1.3

FS_TOTAL

1.3.6.1.4.1.2021.9.1.6

FS_AVAIL

1.3.6.1.4.1.2021.9.1.7

FS_USED

1.3.6.1.4.1.2021.9.1.8

FS_PERCENT

1.3.6.1.4.1.2021.9.1.9

FS_IPERCENT

1.3.6.1.4.1.2021.9.1.10

High Availability

HA

1.3.6.1.4.1.2021.8.1.101.34

MemorySWAP_TOTAL

1.3.6.1.4.1.2021.4.3.0

SWAP_AVAIL

1.3.6.1.4.1.2021.4.4.0

REALMEM_TOTAL

1.3.6.1.4.1.2021.4.5.0

REALMEM_AVAIL

1.3.6.1.4.1.2021.4.6.0

CPU

Filesystem

67

SMS Web API Guide

SectionNetwork Traffic

Temperature

68

Description

OID

ETHO_RX_BYTES

1.3.6.1.4.1.2021.8.1.101.1

ETHO_RX_PACKETS

1.3.6.1.4.1.2021.8.1.101.2

ETHO_RX_ERRORS

1.3.6.1.4.1.2021.8.1.101.3

ETHO_RX_DROPPED

1.3.6.1.4.1.2021.8.1.101.4

ETHO_RX_FIFO_ERRORS

1.3.6.1.4.1.2021.8.1.101.5

ETHO_RX_FRAME_ERRORS

1.3.6.1.4.1.2021.8.1.101.6

ETHO_RX_COMPRESSED

1.3.6.1.4.1.2021.8.1.101.7

ETHO_TX_BYTES

1.3.6.1.4.1.2021.8.1.101.8

ETHO_TX_PACKETS

1.3.6.1.4.1.2021.8.1.101.9

ETHO_TX_ERRORS

1.3.6.1.4.1.2021.8.1.101.10

ETHO_TX_DROPPED

1.3.6.1.4.1.2021.8.1.101.11

ETHO_TX_FIFO_ERRORS

1.3.6.1.4.1.2021.8.1.101.12

ETHO_TX_CARRIER_ERRORS

1.3.6.1.4.1.2021.8.1.101.13

ETHO_TX_COMPRESSED

1.3.6.1.4.1.2021.8.1.101.14

ETHO_MULTICAST

1.3.6.1.4.1.2021.8.1.101.15

ETHO_COLLISIONS

1.3.6.1.4.1.2021.8.1.101.16

ETH1_RX_BYTES

1.3.6.1.4.1.2021.8.1.101.17

ETH1_RX_PACKETS

1.3.6.1.4.1.2021.8.1.101.18

ETH1_RX_ERRORS

1.3.6.1.4.1.2021.8.1.101.19

ETH1_RX_DROPPED

1.3.6.1.4.1.2021.8.1.101.20

ETH1_RX_FIFO_ERRORS

1.3.6.1.4.1.2021.8.1.101.21

ETH1_RX_FRAME_ERRORS

1.3.6.1.4.1.2021.8.1.101.22

ETH1_RX_COMPRESSED

1.3.6.1.4.1.2021.8.1.101.23

ETH1_TX_BYTES

1.3.6.1.4.1.2021.8.1.101.24

ETH1_TX_PACKETS

1.3.6.1.4.1.2021.8.1.101.25

ETH1_TX_ERRORS

1.3.6.1.4.1.2021.8.1.101.26

ETH1_TX_DROPPED

1.3.6.1.4.1.2021.8.1.101.27

ETH1_TX_FIFO_ERRORS

1.3.6.1.4.1.2021.8.1.101.28

ETH1_TX_CARRIER_ERRORS

1.3.6.1.4.1.2021.8.1.101.29

ETH1_TX_COMPRESSED

1.3.6.1.4.1.2021.8.1.101.30

ETH1_MULTICAST

1.3.6.1.4.1.2021.8.1.101.31

ETH1_COLLISIONS

1.3.6.1.4.1.2021.8.1.101.32

TEMPERATURE

1.3.6.1.4.1.2021.8.1.101.33

SMS Web API Guide

Event Taxonomy
The following sections help you get started with the Event Taxonomy:•

Taxonomy Event ID•

Major categories•

Minor categories•

Protocol type•

Platform type

Event Taxonomy
This information provides details about the TippingPoint event taxonomy for use with the SMS Web Services
API with SMS version 4.1 and later.
The event taxonomy provides further information for use with following taxonomy tables:•

TAXONOMY_MAJOR•

TAXONOMY_MINOR•TAXONOMY_PROTOCOL•TAXONOMY_PLATFORM

Taxonomy Event ID
The Taxonomy Event ID for a particular event is a 10-digit number constructed with the following
components:•

Major Category (0-127)•

Minor Category (0-255)•[Protocol Type optional] (0-255)•[Platform Type optional] (0-255)

The number is then calculated much like a decimal IP address conversion: (Major * 16777216) + (Minor *65536) + (Protocol * 256) + (Platform octet).
Note
The maximum value for a Taxonomy Event ID is 2,147,483,647.

Data detail examples
The following are data detail examples.
Example 1
TP ID - 17107965
Filter 2813: HTTP: HP Web Jetadmin Remote Command Injection Vulnerability
69

SMS Web API Guide

001 (Vulnerability) + 005 (Command Injection) + 011 (http protocol) + 253 (Multi-platform Server Application
or Service) = 1*16777216 + 5*65536 + 11*256 + 253 = 17107965
Example 2
TP ID - 67214080
Filter 1511: Kazaa: File Download/Upload
004 (Security Policy) + 001 (P2P) + 155 (FastTrack) + 001 (Windows Client Application) = 3*16777216 + 0*65536+ 112*256 + 252 = 4*16777216 + 1*65536 + 155*256 + 1 = 67214080
Example 3
TP ID - 84151551
Filter 164: ICMP: Echo Request (Ping)
005 (Reconnaissance/ Suspicious Access) + 004 (Host Scan) + 012 (ICMP) + 255 (Other) = 5*16777216 + 4*65536+ 12*256 + 255 = 84151551
Example 4
TP ID - 33693185
Filter 2785: POP/IMAP: Netsky-P Virus Propagation
002 (Malicious Code) + 002 (virus) + 030 (pop/imap) + 001 (Windows Client Application) = 2*16777216 +2*65536 + 30*256 + 1 = 33693185
Example 5
TP ID - 100750333
Filter 2824: SIP: From Field Anomaly
006 (Application/ Protocol Anomaly) + 001 (Protocol Anomaly) + 083 (sip) + 253 (Multi-platform Server
Application or Service) = 6*16777216 + 1*65536 + 83*256 + 253 = 100750333

Major categories
The following table gives the codes and descriptions for major categories.
Category code70

Category

Description

001

Vulnerability

This category includes events triggered by an attempt to exploit a vulnerability in
any application, operating system, or networked hardware device.

002

Malicious CodeThis includes events triggered by viruses, worms, Trojans, backdoors, and allmanner of blended malware threats.

003

Distributed Denial of Service(DDoS)

This category includes events triggered by traffic thresholds that indicate anattempt to make a resource unavailable.

004

Security Policy

This category includes events that indicate an attempt to violate an organization's
security policy. It covers P2P, IM, email attachments, IRC, and other network
communication types.

005

Reconnaissance or
Suspicious AccessThis category includes events that indicate network activity usually associated with
common information gathering techniques used by attackers to launch moresophisticated attacks.

SMS Web API Guide

Category code

Category

Description

006

Application or Protocol
Anomaly

This category includes events that indicate a violation of a protocol or application's
RFC.

007

Traffic Thresholds

This category includes events triggered by predefined thresholds for specificapplications or ports.

008

IP Filters

This category includes events triggered by predefined IP access control lists.

Minor categories
The following table gives the codes and descriptions for minor categories.
Category

Category CodeDescription

001

Vulnerability

Buffer/Heap Overflow

002

Vulnerability

Denial of Service (Crash/Reboot)003

Vulnerability

Configuration Error

004

Vulnerability

Race Condition

005

Vulnerability

Invalid Input (Command Injection, Cross-Site Scripting, SQL Injection, etc.)

006

Vulnerability

Access Validation

255

Vulnerability

Other

001

Malicious Code

Worm

002

Malicious Code

Virus

003

Malicious Code

Trojan/Backdoor

004

Malicious Code

IRC Botnet/Blended Threat

005

Malicious CodePhishing

255

Malicious Code

Other

001

DDoS

SYN Flood Attack

002

DDoS

Other Flood Attack (e.g., ACK, CPS, etc.)

003

DDoS

Iterative Application Attack (Hammer)

255

DDoS

Other

001

Security Policy

P2P

002

Security Policy

Chat and Instant Messaging

003

Security Policy

Streaming Media

004

Security Policy

Email Attachments

005

Security Policy

Forbidden Application Access or Service Request (Telnet, SMB Null Session,
etc.)

006

Security Policy

Authentication Failure (Telnet login failed, brute force, etc.)

007

Security Policy

Spyware71

SMS Web API Guide

Category Code

Category

Description

255

Security Policy

Other

001

Reconnaissance or
Suspicious AccessPort Scan

002

Reconnaissance or
Suspicious AccessSuspicious Application Access

003

Reconnaissance or
Suspicious AccessSuspicious Service Request

004

Reconnaissance or
Suspicious Access

Host Scan

255

Reconnaissance or
Suspicious Access

Other

001

Application or Protocol
Anomaly

Protocol Anomaly

002

Application or Protocol
Anomaly

Evasion Technique003

Application or Protocol
Anomaly

Application Anomaly

255

Application or Protocol
Anomaly

Other Anomaly001

Traffic Thresholds

Traffic Threshold

002

Traffic Thresholds

Application Threshold

255

Traffic Thresholds

Other

001

IP Filters

Deny

002

IP Filters

Accept255

IP Filters

Other

Protocol typeThe following table lists the type codes for protocols.
ProtocolType code72

001

appletalk

002

auth

003

bgp

004

cdp

005

clns

006

dhcp

007

dns

008

fingerSMS Web API Guide

Type code

Protocol

009

ftp

010

hsrp

011

http

012

icmp

013

igmp

014

igrp/eigrp

015

ipv6

016

ipx

017

irc

018

is-is

019

isakmp/ike

020

ldap

021

mpls

022

ms-rpc023

ms-sql

024

nat

025

netbios

026

nntp

027

ntp

028

oracle (sqlnet, etc.)

029

ospf

030

pop/imap031

portmapper

032

qos

033

rip

034

rpc services

035

smb

036

smtp

037

snmp

038

sql

039

ssh

040

ssl/tls041

tacacs73

SMS Web API Guide

Type code

74

Protocol042

tcp (generic)043

telnet045

udp (generic)

046

uucp

048

x-window

049

tftp

050

IP

051

nfs

052

wins

080

h.323 (voip)

081

megaco (voip)

082

mgcp (voip)083

sip (voip)

084

rtp/rtcp (voip)

099

voip (other)100aim (IM)101

msn (IM)

102

yahoo! (IM)103

icq (IM)119

IM (other)120

musicMatch

121

winamp122

shoutcast123

windows media

124

quicktime

125

rtsp

149

streaming media (other)150

bittorrent

151

blubster/piolet/rockitnet

152

directconnect

153

earthstation5

154

edonkey/overnet/emule/mldonkey

155

fasttrackSMS Web API Guide

Type code

Protocol156

gnutella

157

twister

158

winmx

180

p2p (other)

190

DNP3 (SCADA)191

ICCP (SCADA)

192

IEC (SCADA)

193

MODBUS (SCADA)

194

OPC (SCADA)199

SCADA (other)

254

Multi-protocol

255

Other Protocol

Platform typeThe following table lists the codes and descriptions for platforms.
Description

Category code
001

Windows Client Application

002

Mac OS Client Application

003

UNIX/Linux Client Application

004

Novell Client Application

075

Windows Server Application or Service076

Mac OS Server Application or Service

077

UNIX/Linux Server Application or Service

078

Novell Server Application or Service

150

Networked Hardware Device (router, switch, printer, etc.) Application or Service

252

Multi-Platform Client Application

253

Multi-Platform Server Application or Service

254

Other Client Application

255

Other Service or Server Application75