This document outlines the WebAdmin service from the operational and administrative context, looking at how the service operates, and how to ensure it is functioning correctly.

The WebAdmin Service

WebAdmin Inputs

Inbound WebAdmin Ports

WebAdmin functionality can be accessed on inbound TCP ports 80, 8080, and 443.

Database

The Netsweeper NSMySQL database runs on the MariaDB database platform and is segmented into several separate databases (config, log, and reporter).  You can modify the database settings for the WebAdmin through the WebAdmin, by navigating to Administration > WebAdmin Settings.

See the WebAdmin Settings: Database Configuration documentation for more information.

WebAPI

The Netsweeper Web API is a web service that allows for Policy management to occur without the use of the WebAdmin interface. There are two specific variants of the API that are available: Direct API and SOAP API.

Direct API

This API is conducted with specific URL requests using CGI arguments that can be GET or POST arguments.  Example:

https://ServerName/webadmin/api/APINAME.php?argument=value&arg2=value2

Direct API Authentication

If you are using the Direct API with authentication, you must first log in. The authentication for the Direct API requires the client to save and use cookies between requests. To log in you must call the Direct API login. Example GET request:

https://ServerName/webadmin/api/login.php?login=USERNAME&password=PASS

It is recommended to use a POST for this request since it contains password information.

Example POST request:

POST /webadmin/api/login.php HTTP/1.1
Host: ServerName
Content-Type: application/x-www-form-urlencoded

login=USERNAME&password=PASS

For detailed information on Access Tokens, please refer to our Access Token Authentication documentation.

SOAP API

The SOAP API contains general documentation for functions using the WSDL file. This WSDL file can be downloaded from any Netsweeper server using the following request example:

https://ServerName/webadmin/api/?wsdl

You should always use the WSDL file from the server you are making SOAP requests to. Netsweeper also provides a simple SOAP test tool that can be used for example and demonstration purposes:

https://ServerName/webadmin/tools/webapitest.php

Currently the SOAP API specification does not include features for handling large datasets.

SOAP API Authentication

The SOAP API uses HTTP Authentication and the SOAP client must be able to transmit the username and password via HTTP username headers.

WebAdmin Outputs

Outbound WebAdmin Ports

The WebAdmin uses the following outbound ports.

For the complete list of Netsweeper ports, see Inbound and Outbound Ports.

WebAdmin Monitoring

Services Page Monitoring

The Administration > Services page allows for a quick, at-a-glance, view of the services running on your Netsweeper deployment. 

The ‘Services’ page lets you view and control local and remote services you have running.  Use this page to Disable / Enable, Start / Stop services, and Restart a local or remote service. 

Status Window

The nsd.conf (policy service configuration file) contains settings for remote administration and is used for authentication and monitoring of system status in the WebAdmin.  You must list the servers by IP address or subnets that can connect.  If you add the IP address of 0.0.0.0, all Policy Servers will be allowed to connect.

In the WebAdmin, to view the status and statistics for the remote systems and services, navigate to Administration > Status.

Home Page / Dashboard

The Home page provides quick access to frequently used tools, Real-Time graphs, Monitoring Graphs, reports, as well as the ‘Status’ and ‘Service Status’ displays.  Use the side panel navigation bar to scroll vertically to the different displays. Real-Time graphs and Quick Reports show at the top of the window.  They use a scrollable ‘carousel’ function.  Select the arrow buttons to the right and left of the graphs to scroll horizontally across the window.  Use the Select Servers button to choose the servers you wish to monitor.  The localhost server is displayed by default; other servers can be selected if available.  Select the Lock icon to show the current panel when the dashboard loads.  The Customize Reports button lets you add or remove Reports from the carousel display.  In addition, you can add List entries or search URLs, Groups, and Clients.

WebAdmin Log

The WebAdmin Log is a record of events generated by the WebAdmin.  You can access the WebAdmin Logs through Administration > Services or at Logs > WebAdmin Log. 

WebAdmin Log Types are: Policy, WebAdmin, Auth, Default, Database, and Security