SoftLayer Network TippingPointReporting::getReportForIpAddressOrSubnet
From SoftLayer Development Network Wiki
getReportForIpAddressOrSubnet is a member of the SoftLayer_Network_TippingPointReporting service.
Contents |
Overview
This method expands on the getSubnetReportForEntireAccount method by offering the ability to filter by subnet or IP address. This method is identical to getSubnetReportForEntireAccount, but allows filtering by subnet. Like in the getSubnetReportForEntireAccount method, CVE and BugTraq IDs are provided, if available.
This method should be called once an attack has been identified using getSubnetReportForEntireAccount (in which case "All Subnets" is the subnet) or getReportForIpAddressOrSubnet.
User Access
Users wishing to execute getReportForIpAddressOrSubnet service must have the Network IDS permission assigned to their account.
Return Type
getReportForIpAddressOrSubnet returns the SoftLayer_Container_Network_IntrusionProtection_SubnetReportArray data type.
Headers
Required Headers
getReportForIpAddressOrSubnet requires the following headers:
Optional Headers
getReportForIpAddressOrSubnet may use the following headers:
Parameters
getReportForIpAddressOrSubnet takes the following parameters:
IpAddress
the IP address you wish to search on. Passed as a dotted decimal string ("All Subnets" is also accepted).
- Type: string
subnetMask
(optional) the number of bits that are set to 1 in the subnet mask. If your subnet is 192.168.1.1/24, enter 24 here. Default: 32
- Type: integer
- Default Value:32
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
Error Handling
getReportForIpAddressOrSubnet throws the following exceptions:
- SoftLayer_Exception_Public
- Throw the exception "Parameter 'OrderBy' not valid in SoftLayer_Network_TippingPointReporting getReportForIpAddressOrSubnet. Valid values are AttackName, SourceIp, AttackCount, Classification, Protocol, Platform" If an invalid argument was passed for the "OrderBy" value
- SoftLayer_Exception_Public
- Throw the exception "Parameter 'OrderDirection' not valid in SoftLayer_Network_TippingPointReporting getReportForIpAddressOrSubnet. Valid values are ASC, DESC" If an invalid argument was passed for the "OrderDirection" value
- SoftLayer_Exception_Public
- Throw the exception "Parameter 'timeFrame' not valid in SoftLayer_Network_TippingPointReporting getReportForIpAddressOrSubnet. Valid values are positive integers less than or equal to 1440" If an invalid argument was passed for the "timeFrame" value
- SoftLayer_Exception_Public
- Throw the exception "IP address not assigned to this account: {Address}" If the supplied IP or subnet does not belong to this account
- SoftLayer_Exception_Public
- Throw the exception "Invalid IP Address: {Address}" If the supplied IP or subnet was not formatted correctly.
- SoftLayer_Exception_Public
- Throw the exception "There was a problem with the IP address you entered {Address}. Make sure the IP entered belongs to the current account." If there was an unrecoverable error with the passed IP Address
