JavaScript is not currently enabled, but is required for full CodeSonar manual search and browse functionality.
If you are viewing this file in your hub's Web GUI, enable JavaScript in your browser: you will also need it for GUI functionality.
If you opened this file directly from disk, your browser may be directly suppressing JavaScript functionality: certain browsers perform this suppression on local files (but not files delivered by web servers) for security reasons.
| CodeSonar® 9.2p0 | CONFIDENTIAL | CodeSecure Inc |
CodeSonar provides access to various hub commands through the Web interface.
The command pages do not have the standard Web GUI layout: they have plain content only.
| Summary | Instruct the analysis daemon associated with the specified analysis to disconnect from the hub and exit. If the analysis is not running in daemon mode it will be disconnected, but will then try to reconnect. |
|---|---|
| URL | http://hub_location/command/close/analysis_id/ |
| RBAC Permissions Required | ANALYSIS_TERMINATE |
A blank page, on success.
| Summary | Instruct all daemons (launch daemons and analyses
running in daemon mode) to disconnect from the hub and
exit. Any analysis that is not running in daemon mode will also be disconnected by this command, but will then try to reconnect. |
|---|---|
| URL | http://hub_location/command/close_all/ |
| RBAC Permissions Required | G_HUB_DEBUG |
A blank page, on success.
| Summary | Instruct the analysis daemon associated with the specified analysis to disconnect from the hub and exit. If the analysis is not running in daemon mode this command has no effect. |
|---|---|
| URL | http://hub_location/command/close_daemon/analysis_id/ |
| RBAC Permissions Required | ANALYSIS_TERMINATE |
A blank page, on success.
| Summary | Display basic information about the hub. |
|---|---|
| URL | http://hub_location/command/info/ |
| RBAC Permissions Required | G_HUB_INFO |
This set of information can also be obtained through other hub information request mechanisms.
| Hub Process Information | ||
|---|---|---|
| Machine | The name of the machine on which the hub is running. | |
| User | The user on Machine who started the hub. | |
| Interface | The network interface on which the hub is listening. | |
| Port | The port on Interface on which the hub is listening. | |
| Directory | The full path to the hub directory. | |
| Install | The full path to the CodeSonar installation used by the hub. | |
| Database | The URL used by the hub to connect to the hub database. | |
| Started | The date and time (UTC) at which the hub was started. | |
| Version | The version of CodeSonar that the hub is using. | |
| PID | The pid for the hub process. | |
| Slave PID | The pid for the process that serviced this information request. | |
| Satellite | Where or not this is a satellite hub. | |
| Allow Satellites | For a primary hub, whether or not satellite hubs are permitted. | |
| License Information | ||
| Licensed | Whether or not the CodeSonar installation is licensed. | |
| Debug | Whether or not the debug license feature is enabled. | |
| Company | The company the license was issued to. | |
| Project | The project(s) licensed. | |
| Lines | The number of per-file units licensed. | |
| Lines Correction | The correction units included in the license to cover the charges from standard library files. | |
| Effective Lines | The sum of License Units and Units Correction. | |
| Users | The number of active users licensed. | |
| Anonymous Sessions | The number of anonymous sessions licensed. | |
| User Sessions | The number of user sessions licensed. | |
| License Error | If your license has stopped working, this line will contain a message explaining why. | |
| License Warning | If your license is going to stop working soon, this line will contain a message explaining why. | |
| Used Lines | The number of license units that have been charged to date. | |
| Lines of Java | The number of per-file units licensed for Java analysis. | |
| Java Lines Correction | The correction units included in the license to cover the charges from standard Java library files. | |
| CodeSonar Product Information | ||
| Information about the CodeSonar installation that the hub is using: for use in problem reports. | ||
| Summary | Display the hub log (non-streaming). |
|---|---|
| URL | http://hub_location/command/log/ |
| RBAC Permissions Required | G_HUB_LOGS |
A chronologically-ordered list of hub exceptions and other major
events.
Timestamps in hub-generated messages are UTC-based. Timestamps
occurring in stdout from CodeSonar analysis, PostgreSQL, or other
third-party components may be based on your system time zone.
| Summary | Display the hub processes log. |
|---|---|
| URL | http://hub_location/command/processes.txt |
| RBAC Permissions Required | G_HUB_LOGS |
A chronologically-ordered list of hub process state counts, updated each time a hub process changes state. Also records license key heartbeats.
| Summary | Shut down the hub. |
|---|---|
| URL | http://hub_location/command/shutdown/ |
| RBAC Permissions Required | G_HUB_SHUTDOWN |
A Shutdown Server button. Click the button to shut down the hub web server.
| Summary | Display the HTTP request log. |
|---|---|
| URL | http://hub_location/command/traffic.txt |
| RBAC Permissions Required | G_HUB_LOGS |
A chronologically-ordered list of the HTTP requests issued.
| Summary | Denormalize the database tables that manage RBAC elements. Visit this URL every time you use SQL to manually adjust elements. |
|---|---|
| URL | http://hub_location/command/update_denorm_tables/ |
| RBAC Permissions Required | G_SQL_CONSOLE |
"ok" on successful denormalization.
| Summary | Display the user event log. |
|---|---|
| URL | http://hub_location/command/userlog.txt |
| RBAC Permissions Required | G_HUB_LOGS |
A chronologically-ordered list of user session events (sign in/out).
To report problems with this documentation, please visit https://support.codesecure.com/.