Executing commands on the command line

The command line offers more experienced administrators quick access to a wider variety of options than the configuration tool.

Before you begin

You must have administrative credentials for Spotfire Server. If Spotfire Server is set up to authenticate with the Spotfire database using Windows Integrated Authentication, you must run commands as the same user that Spotfire Server authenticates as. Otherwise, the commands cannot authenticate with the database.

About this task

Note: If you run commands using Windows PowerShell or similar, then you must make sure to place any command options containing special characters, such as the '@' character in email addresses, within single quotation marks. For example, '-Cinfo@example.com'.

Procedure

On the computer running Spotfire Server, open a command line as an administrator.
- If you are using Windows Integrated Authentication, open a command line as the Spotfire Server database user.
- If you are using Linux, open a command line and run as root. Otherwise, to use the command line, you must be in the Linux file system permissions group "Owner".
Change the directory to the location of the config.bat file (config.sh on Linux).
The default location is <server installation dir>/tomcat/spotfire-bin.
This is where you execute commands.
Note: You can also execute commands on a local computer rather than the server computer; for details, see Executing commands on a local computer.
Export the active server configuration (the configuration.xml file) by using the export-config command.
Example:
```
config export-config --tool-password=mypassword
```
On the command line, enter config (config.sh on Linux) followed by the command and any required parameters.
After you have finished running commands, upload the modified configuration back to the Spotfire database by using the import-config command. The configuration that you import becomes the active configuration for that server or cluster.
Example:
```
config import-config --tool-password=mypassword --comment=what was changed
```
Restart Spotfire Server; for instructions, see Start or stop Spotfire Server.

Note: Because the configuration.xml file contains confidential information, you might want to restrict access to it.