SoftLayer Network TippingPointReporting::getSubnetReportForEntireAccount
From SoftLayer Development Network Wiki
getSubnetReportForEntireAccount is a member of the SoftLayer_Network_TippingPointReporting service.
Contents |
Overview
This method returns specific attacks by name for all subnets on the current user's account.
The data returned is stored in SoftLayer_Container_Network_IntrusionProtection_SubnetReport objects, with the "subnet" value set to "All Subnets"
The data is separated into "Inbound" and "Outbound" traffic. A significant amount of outbound attack traffic could indicate that your servers have been compromised.
The data returned includes Attack Count, attack name, extended attack description, and IDs that correspond with the BugTraq or CVE databases. BugTraq can be accessed at [1] The CVE database is located at [2]
For more detailed information, use the getReportForIpAddressOrSubnet method
User Access
Users wishing to execute getSubnetReportForEntireAccount service must have the Network IDS permission assigned to their account.
Return Type
getSubnetReportForEntireAccount returns the SoftLayer_Container_Network_IntrusionProtection_SubnetReportArray data type.
Headers
Required Headers
getSubnetReportForEntireAccount requires the following headers:
Optional Headers
getSubnetReportForEntireAccount may use the following headers:
Parameters
getSubnetReportForEntireAccount takes the following parameters:
timeFrame
(optional) number of minutes back to search from the present (default 60)
- Type: integer
- Default Value:60
orderBy
(optional) valid values are AttackName, SourceIp, AttackCount, Classification, Protocol, Platform (default AttackCount)
- Type: string
- Default Value:AttackCount
orderDirection
(optional) either ASC or DESC (Default DESC)
- Type: string
- Default Value:DESC
returnSubnetGroups
(optional) Set to true if you want individual subnet groups in addition to the "all subnets" group.
- Type: boolean
Error Handling
getSubnetReportForEntireAccount throws the following exceptions:
- SoftLayer_Exception_Public
- Throw the exception "Could not retrieve Account ID in SoftLayer_Network_TippingPointReporting getSubnetReportForEntireAccount" if the current user's account ID could not be retrieved.
