Scan Server Dialog
Before a user can assign project codebases to a Scan Server in order to scan them, the Scan Server must first be installed either on the same instance as the Code Insight Core Server or on a separate instance, as described in the Code Insight Installation and Configuration Guide. (The Scan Server must have the same version as the Core Server.) As Code Insight System Administrator, you must then use the Scan Server dialog to “add”—that is, identify—the server to the Code Insight system to make it available for scanning purposes.
In addition to adding a new Scan Server, you use the Scan Server dialog to edit an existing Scan Server’s properties. For detailed instructions on adding or editing a Scan Server, see “Adding or Editing Scan Servers” in the Code Insight Installation and Configuration Guide.
Multiple Scan Servers
If multiple Scan Servers have been installed, you can identify more than one of these servers to the system, thus enabling users to distribute codebase scans. Keep in mind that, when multiple Scan Servers are installed, each should be installed on a different instance with a unique host ID and port. The codebase for a given project can be assigned to only one of the Scan Servers (but multiple project codebases can be assigned to a single Scan Server). All codebases assigned to a given Scan Server are stored on that server in a location that you specify.
Prerequisite for Adding or Editing a Scan Server
Ensure that the Scan Server that you are adding or editing is currently running and that the Scan Server you are adding has the same version as the Core Server.
Dialog Fields
The Scan Server dialog contains the following fields:
|
Column/Field |
Description |
|||||||||
|
Alias |
Enter a common name for the Scan Server. |
|||||||||
|
Host |
Provide the hostname (such as krl.eng.companyA.com) or IP address of the instance hosting the Scan Server. If the Scan Server is on the same instance as the Core Server, enter localhost. The same host-and-port combination must be unique among the enabled Scan Servers. (See Status is this table for a description of enabled Scan Servers.) |
|||||||||
|
Port |
Specify the port used by the Scan Server on the host instance. By default, the port is 8888. The same host-and-port combination must be unique among the enabled Scan Servers. (See Status is this table for a description of enabled Scan Servers.) |
|||||||||
|
CL Path |
Provide the path for the Code Insight Compliance Library (CL), downloaded from the Product and License Center. The CL is a database used by the Scan Server to perform exact-file and source-code fingerprint (snippet) matching. Code Insight compares elements of scanned codebase files with information contained in the CL to generate file-level evidence on which you can take action. The validity of the entered path is checked when you click Save. Alternatively, leave this field blank to scan your codebase without using the CL. (Code Insight provides the scan profile “Basic Scan Profile (without CL)” to perform the scan.) This type of scan generates inventory from Code Insight’s Automated Analysis feature but has limitations, as described in “About Scanning without the Compliance Library” in the Code Insight Installation and Configuration Guide. Keep in mind that, when you run a scan using the CL (that is, by specifying a valid CL path), you obtain a deeper, more comprehensive scan on your codebase. For additional information, see the following:
|
|||||||||
|
Codebase Path |
Provide the path on the Scan Server where Code Insight will store and manage all uploaded code for projects that use this Scan Server. Ensure you have adequate disk space to store the codebases. The recommended starting size for this directory is 500GB. The directory must already exist. The validity of the entered path is checked when you click Save. Once the Scan Server to added to the Code Insight system, this field cannot be edited. |
|||||||||
|
Status |
By default, the Scan Server is enabled for scanning. However, if necessary for an existing Scan Server, select Disabled to make the Scan Server unavailable for further scans. Once disabled, the server is no longer displayed in the Scan Server dropdown list during project creation or when setting global project defaults. Additionally, this field becomes read-only on the Edit Project window. Note the following about disabling a Scan Server:
If you attempt to re-enable a disabled Scan Server when another currently enabled Scan Server has the same host-and-port combination or alias, you receive an error when you click Save. |
|||||||||
|
Save |
Click this button to save any changes you made to the Scan Server properties. Errors are generated when the following conditions exist:
|
|||||||||
|
Cancel |
Click this button to cancel any changes you made to the fields on the Scan Server dialog. |
See Also