SAFR Support Scripts

The SAFR Platform installation includes several scripts to manage and monitor your server. They are located in the bin folder under the SAFR Platform installation location.

Note: Some of the scripts below may not work if you're accessing the SAFR Platform through the NVIDIA Metropolis Application Framework (MAF).

check Script

The check script checks the status of SAFR Server services.

configure-ports Script

The configure-ports script customizes the ports SAFR services listen on. This is typically done only if there is a conflict with existing software on the same server.

If port conflicts are detected during SAFR Platform installation, the following occurs:

  1. The ports in conflict are reported.
  2. Notepad is launched to edit safrports.conf
  3. The SAFR Platform installer is automatically relaunched after new non-conflicting ports are chosen.

This script is executed as part of the installation when appropriate, so it doesn't need to be executed manually unless you are changing the port settings after installation.

This script takes no arguments but relies on the safrports.conf file to determine what ports are to be used.

safrports.conf is located at the following locations:

get-license Script

The get-license script is used as part of the process of getting an on-premises license when the SAFR system doesn't have Internet connectivity. See the On-Premises Licensing topic for detailed information on how to use this script.

get-license-request Script

The get-license-request script is used as part of the process of getting an on-premises license when the SAFR system doesn't have Internet connectivity. See the On-Premises Licensing topic for detailed information on how to use this script.

insert-license Script

The insert-license script is used as part of the process of getting an on-premises license when the SAFR system doesn't have Internet connectivity. See the On-Premises Licensing topic for detailed information on how to use this script.

portcheck Script

Lists all the ports that SAFR services are using.

reconfigure Script

The reconfigure script configures the hostname used by the SAFR Server. Run this command when configuring the server to use a DNS hostname with an SSL certificate.

This script can be run with arguments specifying the hostname and whether an SSL certificate chain is used by your SSL certificate. If no arguments are passed, you will be prompted for those values.

This script requires administrator privileges. It automatically asks for admin privileges on Windows and requires sudo on macOS and Linux.

Examples: macOS:

Linux:

Windows:

configure-ssl Script

The configure-ssl script is used to manage the SAFR Server's self-signed SSL certificate. The exact functionality of the script depends on which arguments are passed into it:

Possible arguments

safr-worker Script

The safr-worker script is used to join secondary SAFR Servers to the SAFR server cluster. See the Add Secondary Servers topic for information on how to use this script

start Script

The start script starts all SAFR Server services on the current machine.

stop Script

The stop script stops all SAFR Server services on the current machine.

syscollect Script

The syscollect script collects all the necessary logs, stats, and configuration files into a single archive file that can be easily emailed to SAFR sales support engineers.

The script accepts the following optional arguments:

uninstaller.exe

The uninstaller executable removes the SAFR Platform entirely. This closes all SAFR applications, stops all SAFR services, and then removes all SAFR services and data.

On Windows, you must select the optional ProgramData component to remove the config files, logs, and database files.

Internal Use Only

The following scripts appear in the SAFR\bin folder, but are intended for internal use only.

See Also