docs

Netpump Service Administrator Page

This guide describes details of the Netpump Service Configuration page contained within the Netpump Service Virtual Machine and Local Instances.

Accessing the Administrator Page

The Netpump Service Configuration page is available if the following requirements are met, based on the services hosting environment.

Cloud Hosted Service

1. Public IP Address assigned to the Virtual Machine instance created during the Netpump Service Marketplace Offer Configuration Guide.

2. DNS A Record pointing to the Public IP Address. The public URI that will be used to access the Netpump Service Configuration page.

3. The public URI added to the App Registration Authentication Redirect URIs. See Configure Redirect URLs and Token Authentication for Configuration Page for details.

Locally Hosted Service

1. Updated hosts file containing reference to the local URI that will be used to access the Netpump Service Configuration page.

127.0.0.1   path.to.my.domain

1. The local URI added to the App Registration Authentication Redirect URIs. See Configure Redirect URLs and Token Authentication for Configuration Page for details.

NOTE: Ensure the attached Key Vault Certificate from Netpump Service Marketplace Offer Configuration Guide prerequisites includes the chosen public URI.

Once the above settings are configured the page can be accessed via the configured public URI. Once loaded you will see a page similar to the image below.

Administrator Page Settings

The Netpump Service Configuration page consists of 6 sections.

Service Endpoint/Port Number Configuration

Enter a valid URI host for the Netpump Service. Update this value to change the default port number and/or URI the service runs under. Please note for Cloud Hosted instances is should be a wildcard URI http://*:443. Locally Hosted instances should be a fully qualified URI https://pathto.my.domain:443.

The port number can be any valid port number provided it is allowed access to the Virtual Machine Instance (Cloud Hosted Instances) and it not currently in use by any local services (Locally Hosted instances).

Azure Authentication

Enter the Azure Authentication credentials from the App Registration of the Netpump server set up in Netpump Service App Registration Configuration Guide.

Key Vault SSL Certificate

A link to the SSL Certificate within Azure Key Vault of the custom domain you wish to host the Netpump Server Application on. Link to peer certificate(s) in the Azure Key Vault. These certificates will be used to authenticate to the peer service(s). The certificate(s) must be in the same Azure AD tenant as the application and the service principal must have access to the certificate(s).

Server Message Block File Share(s)

Add/Remove SMB File Shares the service has access to. At least one SMB File Share must be configured. Enter valid UNC Path, Username and Password linking to the network SMB locations. The Netpump Service accesses the configured SMB File Shares for file transfer between instances.

Netpump Service Log File(s)

Click on displayed links to download service logs recorded by the Netpump Service. New logs are created on a daily basis named service_[YYYYmmdd].log and are displayed oldest to newest.

Netpump Service Usage Data

Administrators are required as per their agreed EULA to provide usage logs upon request. The `` button will download the current usage logs linked to the running service.

Restart Netpump Service

Administrators may manually restart the service via the Netpump Service Configuration page. This option is available if Netpump Server is running as a service.