SoftLayer Network Security Scanner Request

From SoftLayer Development Network Wiki

Jump to: navigation, search

This page refers to the SoftLayer_Network_Security_Scanner_Request service. For information on the SoftLayer_Network_Security_Scanner_Request data type please see SoftLayer_Network_Security_Scanner_Request (type).

Contents

Overview

SoftLayer gives customers the ability to manage vulnerability scans for each of their servers. This service provides the ability to create a new scan request, view the status of a current request, and finally view the report of a finished scan.

A vulnerability scan attempts to find potential security problems on a server by first searching for open ports and the services that run on them. If any services are found the scanner will then check for version and patch information of each service found. Lastly, the scanner will use the information gathered to search its database of known vulnerabilities and generate a report. Reports typically take five to ten minutes to run but allow for up to thirty minutes in rare cases.

A vulnerability report will typically include the following information:

  • Number of security holes and warnings.
  • The hosts that were scanned.
  • The port/service and the corresponding issue.
  • Detailed information about the issue, risk factor, and possible fixes.


If you have a firewall, SoftLayer's administrative networks need to be allowed for the vulnerability scan to be effective. If a firewall is blocking all ports, the report may not show any problems even if some exist. In addition you may have some indication in your firewall logs of the scan taking place as ports on your system are investigated.

Endpoints

SOAP WSDL http://api.service.softlayer.com/soap/v3/SoftLayer_Network_Security_Scanner_Request?wsdl
XML-RPC http://api.service.softlayer.com/xmlrpc/v3/SoftLayer_Network_Security_Scanner_Request

User Access

Users wishing to access the SoftLayer_Network_Security_Scanner_Request service must have the Vulnerability Scanning permission assigned to their account.

Methods

createObject

Create a new vulnerability scan request.

  • returns
boolean
  • parameters
SoftLayer_Network_Security_Scanner_Request templateObject


getAccount

Retrieve the account associated with a security scan request.

  • returns
SoftLayer_Account
  • parameters
None


getHardware

Retrieve the hardware item a security scan is run on.

  • returns
SoftLayer_Hardware
  • parameters
None


getObject

Retrieve a SoftLayer_Network_Security_Scanner_Request record.

  • returns
SoftLayer_Network_Security_Scanner_Request
  • parameters
None


getReport

Get the vulnerability report for a scan request.

  • returns
string
  • parameters
None


getStatus

Retrieve a security scan request's status.

  • returns
SoftLayer_Network_Security_Scanner_Request_Status
  • parameters
None

See Also

External Links

Retrieved from "http://sldn.softlayer.com/wiki/index.php/SoftLayer_Network_Security_Scanner_Request"
Personal tools