VirtServer Web Interface

1. To access the VirtServer web interface, open the following URL in your browser:

   https://virtserver-address:port/virtserver/

   For example:

   https://10.0.81.128:9090/virtserver/

2. Log in to the web interface using the VirtServer user credentials, for example, using the user name and password you created when you ran VirtServer for the first time. If VirtServer is configured for OIDC, users will be given the option to log in via OIDC Provider, and authentication will follow a PKCE flow.

3. Important: When you open the VirtServer web interface for the first time, most browsers will report about an insecure connection. The fact is that VirtServer comes with a self-signed security certificate, which the browsers do not consider secure enough. You can ignore this warning and continue working. If needed, you can install a trusted security certificate.

Notes:

• In the URL:

  • virtserver-address can be the computer name or IP address of the VirtServer machine.

  • The default port number is 9090. You can change it in VirtServer settings.

  • The protocol must be https, and the page path must be /virtserver.

• All the users you added to VirtServer have access to the web interface and can start and stop virtual services.

  Only administrator users can access the Admin page and manage users and configure VirtServer settings.

Here is a sample view of the VirtServer web UI:

Click the image to enlarge it.

• The Overview section at the top of the page provides general information about virtual services. You can see the number of currently running virtual services, the maximum number of running services supported by your VirtServer license and the number of services deployed on VirtServer.

  • On the Virtual API Summary page, you can view the virtual services deployed to VirtServer, you can start and stop them, change the port number (it is impossible to run two services that use the same port number) and perform other actions. For example, you may assign tags to virtual services to find them faster.You can also add response delay in Ms to a virtual service. Please note that this will be overwritten if the virtual service is downloaded/replaced from ReadyAPI.

  • To view the activity of some virtual service for the last 24 or 48 hours, click the service on the Virtual API Summary page. This will open the Virtual API Details page with information about the selected service.

    Example

    ExampleHide example

    

    Click the image to enlarge it.

    You can also filter the contents of the VirtServer Audit Log and view only the events related to the select virtual service.

  • On the VirtServer Audit Log page, you can see the Audit Log that contains the history of events that occurred on VirtServer like starting or stopping a virtual server, or updating the VirtServer settings.

  • You can view the request and response data for the last 1000 activities on certain virtual services. To do this, simply click on the specific service within the Virtual API Summary page. This action opens the Virtual API Details page, where you can navigate to the Virtual API Transaction Log and follow on-screen prompts to view request and response data. Alternatively, you can opt to click on "Generate Log" to retrieve the transaction log in JSON format. Initially, this feature supports REST and SOAP Services, with plans to extend it to other protocols in upcoming releases.

    

    Click the image to enlarge it.

• The Admin section at the top of the page is only shown when you log in as an administrator. You can change settings of your VirtServer, manage users and see the license information.

  

  Click the image to enlarge it.

  • On the Settings page, you can configure VirtServer settings: change the number of stored log items, enable HAR logs for your virtual services, and configure session timeout. Admins can download HAR logs from the web page. This will always return a ZIP file with all files found from the selected list. If files are not available or deleted, these will not be returned.

  • On the Users page, you can manage users: add and delete them, edit their details and give and revoke administrator rights.

  • On the Groups page, you can configure user groups.

  • On the License information page, you can see the details of your license.

  • On the LDAP page, you can set up a connection with your LDAP server.

  • VirtServer can also be configured to work with your OIDC (Okta) environment. All user and session management is controlled through OIDC configuration and settings. These options are disabled in VirtServer if OIDC is configured.

• To view and change your user information, click the user profile icon in the top-right corner and select Profile. After you finish working with VirtServer, log out by clicking the user profile icon in the top-right corner and selecting Sign Out.

  

  Click the image to enlarge it.

  Note:

  When VirtServer is configured to work with your OIDC or Okta environment, the user profile is controlled and managed in the OIDC or Okta environment.