Skip to content

Advanced Configuration

This section includes the advanced configuration settings of Runecast Analyzer and may require console access to the virtual appliance. Runecast Analyzer runs in a virtual appliance running Ubuntu OS. For security purposes, SSH is disabled by default. You will need to use your vSphere Web Client to navigate to the Runecast Analyzer VM and open the VM console.

How to change the rcadmin password

To change the rcadmin password follow the steps below:

  1. Open the Runecast Analyzer appliance console

  2. Press F1 and login with rcadmin user (default password: admin)

  3. Navigate to User Settings and press Enter

  4. Set new password and confirm.

How to replace the self-signed SSL certificate

By default, the connection to the Runecast Analyzer web interface is encrypted using a self-signed SSL certificate. In case your company policy requires CA signed certificates, you can replace the default one following the steps below:

  1. If SSH is already Enabled on Runecast Analyzer, please continue with step 7

  2. Open the Runecast Analyzer appliance console

  3. Login with rcadmin user (default password: admin)

  4. Navigate to Remote Access and press Enter

  5. Select Enable SSH and press Enter

  6. Navigate to Logout and press Enter to return to previous menu

  7. Initiate SSH session to Runecast Analyzer

  8. Login with rcadmin user (default password: admin)

  9. In the directory /etc/runecast/cert, rename the existing certificates:

    sudo mv rc2.crt orig.rc2.crt
    sudo mv rc2.key orig.rc2.key
    
  10. Copy the new certificate and key to /etc/runecast/cert.

    • from the appliance initiate file transfer:

      sudo scp username@remoteHost:/location/your-file.crt
      /etc/runecast/cert/your-file.crt 
      
      sudo scp username@remoteHost:/location/your-file.key
      /etc/runecast/cert/your-file.key
      
    • as an alternative you can copy the certificate files to Runecast Analyzer using SCP client. Is this case, you will not be able to upload them directly to /etc/runecast/cert/ directory. Initially, they can be placed in the /tmp directory and then moved with elevated privileges.

      sudo mv /tmp/your-file.crt /etc/runecast/cert/your-file.crt
      sudo mv /tmp/your-file.key /etc/runecast/cert/your-file.key
      
  11. In the directory /etc/runecast/cert rename the new certificate and key to rc2.crt and rc2.key

    sudo mv your-file.crt rc2.crt
    sudo mv your-file.key rc2.key
    
  12. The copy process of the certificate files to Runecast Analyzer may not assign the proper permissions. Please review them by using the following command:

    ls -la /etc/runecast/cert/

  13. If the permissions on your new cerificatate files are not root:rctomcat run the commands below:

    sudo chown root:rctomcat cert-file.crt
    sudo chown root:rctomcat key-file.key
    sudo chmod 640 cert-file.crt
    sudo chmod 640 key-file.key
    
  14. If your key is password-protected (recommended) add rc2.key password into etc/rctomcat9/server.xml using following commands:

    sudo nano /etc/rctomcat9/server.xml
    SSLCertificateFile="/etc/runecast/cert/rc2.crt"
    SSLCertificateKeyFile="/etc/runecast/cert/rc2.key"
    SSLPassword="key_password"
    
  15. Restart the appliance after you install the new certificate

Warning

Runecast Analyzer supports X.509 certificates to encrypt session information sent over SSL connection.

How to configure a Proxy Server

Runecast Analyzer can be configured to use a proxy server facilitating external connectivity. To achieve this, follow one of the two methods described below.

Method 1 - Proxy configuration using Console Interface:

  1. Open the Runecast Analyzer appliance console

  2. Login with rcadmin user (default password: admin)

  3. Navigate to Proxy Settings and press Enter

  4. Provide the Proxy server and port and optional the Username and Password

  5. Press Enter to validate the configuration

  6. Navigate to Logout and press Enter to return to previous menu

Method 2 - Proxy configuration using REST API.

You can configure proxy via the Runecast REST API. One convenient way to do it is via the built-in API browser:

  • Navigate to Settings -> API Access tokens.

  • Access the Runecast API reference link and expand the Configuration list. Select the desired method (PUT, GET, DELETE) for /api/v1/config/system/proxy

  • To configure the proxy, you need to provide proxy server address, port, user and password.

    Sample:

        {
    
        "authenticated": true,
    
        "configured": true,
    
        "password": "password",
    
        "port": 3128,
    
        "server": "proxy.example.com",
    
        "user": "user"
    
        }
    

How to disable the session timeout for the web interface of Runecast Analyzer

The web interface of Runecast Analyzer has a default session timeout value of 15 minutes. For security reasons, it is advised to keep the default.

To perform the changes, navigate to Settings page then API Access tokens tab. Click on Explore API Documentation, expand the Configuration section and find the session timeout calls.

To check the timeout status the following API call can be used:

curl -X GET -H "Authorization: YOUR_API_TOKEN" -H 'Accept:
application/json;charset=UTF-8'
'http://Runecast-Analyzer/rc2/api/v1/user-settings/session-timeout'

To set the timeout use the following API call:

curl -X PUT -H "Authorization: YOUR_API_TOKEN" -H "Content-Type:
application/json;charset=UTF-8"
http://Runecast-Analyzer/rc2/api/v1/user-settings/session-timeout -d
'{"sessionTimeoutEnabled": false}'

Tip

Replace YOUR_API_TOKEN by a valid token and Runecast-Analyzer by your appliance DNS or IP. To generate a token check section API Access tokens

Reboot the appliance for the changes to have effect.

How to change Runecast Analyzer network configuration

Network configuration can be set during .ova deployment. If later changes are needed, they can be performed following one of the next steps:

  1. From vApp Options

    • Shut down the Runecast Analyzer appliance VM

    • Using the vSphere Web Client, right click on the VM and select Edit Settings

    • From the newly opened window select vApp Options

    • Expand Networking properties and edit the DNS field to the desired value

    • Confirm the changes by clicking OK button on the Edit Settings window

    • Power On the Runecast Analyzer VM

  2. From Runecast Console Interface

    • Open the Runecast Analyzer appliance console

    • Login with rcadmin user (default password: admin)

    • Navigate to Network Settings and configure the parameters as desired. If DHCP is required set its value to true

Note

Once the network properties are reconfigured trough the Runecast Console Interface the network configuration is marked as Internally managed and further changes via vApp Options will be discarded.

How to change address of Knowledge updates repository

By default, Runecast Analyzer is downloading the definition updates from the address https://updates.runecast.com/definitions.

To perform the changes, navigate to Settings page then API Access tokens tab. Click on Explore API Documentation, expand the Configuration section and find the definitions repository calls.

To check the current repository location the following API call can be used:

curl -X GET -H "Authorization: YOUR_API_TOKEN" -H 'Accept: application/json;charset=UTF-8' Runecast-Analyzer /rc2/api/v1/user-settings/definitions-repository'

To create your own repository and use it as download location for Knowledge updates execute the following API call:

curl -X PUT -H "Authorization: YOUR_API_TOKEN" -H "Content-Type: application/json;charset=UTF-8" http:// Runecast-Analyzer/rc2/api/v1/user-settings/definitions-repository -d '{"url":"https://YOUR_REPOSITORY_IP/definitions/","versionFilename":"version.txt","updatesFilename":"kbupdates.bin"}'

Tip

Replace YOUR_API_TOKEN by a valid token, Runecast-Analyzer by your appliance DNS or IP and YOUR_REPOSITORY_IP by your repository. To generate a token please check section API Access tokens

Both files version.txt and kbupdates.bin should be placed in your repository.

  • version.txt – requires the following format (example):

    appversion=4.1.1.0

    defversion=4.1.1.1

    defdate=2020-01-16

    appdate=2020-01-14

  • kbupdates.bin – can be downloaded from your profile

Warning

If the files are not properly configured the updates will behave as in offline mode.

Reboot the appliance for the changes to have effect.

How to enforce support of TLSv1.2 protocol

By default, Runecast Analyzer supports following TLS protocols: TLSv1, TLSv1.1 and TLSv1.2

In case you require TLSv1.2 only, please verify your VMware infrastructure against the KB: https://kb.vmware.com/s/article/2148819

If your VMware infrastructure fully supports TLSv1.2, you can disable TLSv1 and TLSv1.1 in Runecast Analyzer using following steps:

  1. If SSH is already Enabled on Runecast Analyzer, please continue with step 7

  2. Open the Runecast Analyzer appliance console

  3. Login with rcadmin user (default password: admin)

  4. Navigate to Remote Access and press Enter

  5. Select Enable SSH and press Enter

  6. Navigate to Logout and press Enter to return to previous menu

  7. Initiate SSH session to Runecast Analyzer

  8. Login with rcadmin user (default password: admin)

  9. Modify /etc/rctomcat9/server.xml as follows:

    replace SSLProtocol="all" with SSLProtocol="TLSv1.2"

  10. Restart the Tomcat service:

    sudo systemctl restart rctomcat9

After these actions Runecast Analyzer will accept only TLSv1.2 connections.

How to configure remote audit logging

For security purposes you can enable Runecast Analyzer audit logging. These additional log messages contain information about the user interaction with Runecast Analyzer such as sign in, sign out, filter creation and more.

You can configure audit login via the Runecast REST API. One convenient way to do it is via the built-in API browser:

  • Navigate to Settings > API Access tokens.

  • Access the Runecast API reference link and expand the Configuration list. Select the desired method (PUT, GET, DELETE) for /api/v1/config/system/audit/syslog

  • To configure the remote audit logging, you need to provide syslog server address, port and protocol type.

    Sample:

        {
    
        "host": "10.0.0.1",
    
        "port": 514,
    
        "protocol": "UDP"
    
        }
    

Note

Once a remote syslog server is configured the logs are also available locally on the appliance.

How to extend the disks

Each hard disk drive of the Runecast Analyzer VM can be expanded following the procedure below:

  1. Power off the Runecast Analyzer VM.

  2. Locate the Runecast Analyzer VM in the vSphere Web Client and select Edit Settings.

  3. Extend the disks to the desired size:

    • Hard Drive 1 - root volume

    • Hard Drive 2 - database storage

    s- Hard Drive 3 - log storage

  4. Power on the Runecast Analyzer VM. The file system will be automatically expanded.

How to uninstall the Runecast Analyzer Plug-in

The process to uninstall the Runecast Analyzer plugin should only take a couple of minutes using the following procedure.

Step 1: Log in to the vCenter MOB interface using an administrators account.

To interact with the SOAP APIs, you need to login to the MOB interface as an administrator using the following URL:

https:// %VCSA_URL%/mob

Step 2: Select content under properties.

Step 3: Select the ExtensionManager link

Step 4: Click the more button to list all the extensions.

Step 5: You will see the Runecast plugin in the extension list.

Step 6: Scroll down and select Unregister Extension.

Step 7: Enter biz. runecast.rc2plugin into the extensionKey value and then select Invoke Method.

If you now go back to the ExtensionManager screen you will see that the plugin is no longer there.

Step 8: You will need to log out and log back into vCenter before you no longer see the Runecast plugin in vCenter.