Command-line reference
The command-line commands are listed alphabetically here.
Refer to Configuration and administration commands by function for an easily reviewed functional command grouping, and Configuration using the command line for information on using the Spotfire command line.
In this reference we use the following symbols:
- Angle brackets (< >) indicate mandatory arguments.
- Square brackets ([ ]) indicate optional arguments.
- Curly brackets ({ }) indicate flags that can be specified multiple times.
max cache size
argument may be entered as
--max-cache-size=<value>
or
-m <value>
.
A negative value must be preceded by a backslash in the second argument format, for example
-m \-7
.
- add-code-trust
Adds users or certificates as trusted signers for a principal (user or group). - add-ds-template
Adds a new data source template. - add-member
Adds a user or group as a member of a specified group. - block-code-trust
Blocks a code trust entity, Spotfire user or code signing certificate from being trusted. - bootstrap
This command is used to bootstrap the server by creating a new bootstrap configuration file, and a corresponding server node in the database. - check-external-library
Checks for inconsistencies between external storage and the Spotfire database. - clear-join-db
Clears the default join database configuration. - clear-preference
Clears a preference for a group. - config-action-log-database-logger
Configures the user action database logger. - config-action-logger
Configures the user action logger. - config-action-log-web-service
Configures the action log web service. - config-anonymous-auth
Configures the anonymous authentication method. - config-attachment-manager
Configures the attachment manager. - config-auth
Configures authentication mode and default domain. - config-auth-filter
Configures the authentication filter. - config-client-cert-auth
Configures the CLIENT_CERT authentication method. - config-cluster
Configures clustering. - config-csrf-protection
Configures the CSRF protection. - config-custom-web-auth
Configures custom web authentication. - config-encryption
Configures the encryption of sensitive information such as service account passwords. - config-external-auth
Configures the external authentication method. - config-external-ignite-process
Configures memory settings and JVM options for the external Ignite process. - config-external-information-services-process
Configures the port, memory settings, init-timeout, JVM options and extensions-folder for the external Information Services process. - config-external-scheduled-updates
Configures external scheduled updates. - config-import-export-directory
Configures the library import/export directory. - config-jmx
Configures the JMX RMI connector. - config-kerberos-auth
Configures the authentication service used with the Kerberos authentication method. - config-ldap-group-sync
Configures group synchronization for an LDAP configuration. - config-ldap-userdir
Configures the LDAP user directory mode. - config-library-external-azure-blob-storage
Configures Azure Blob storage of library item data. - config-library-external-data-storage
Configures the external library data storage. - config-library-external-file-storage
Configures the file system storage of library item data. - config-library-external-google-cloud-storage
Configures the Google Cloud Storage of library item data. - config-library-external-s3-storage
Configures the Amazon S3 storage of library item data. - config-login-dialog
Configures the client login dialog behavior. - config-ntlm-auth
Configures the authentication service used with the NTLM authentication method. - config-oauth-client
Configures the Spotfire Server in the role of an OAuth 2.0 client. - config-oidc
Configures authentication using OpenID Connect. - config-persistent-sessions
Configures the persistent sessions ("remember me") feature. - config-post-auth-filter
Configures the post-authentication filter. - config-public-address
This command has been replaced by set-public address. - config-scheduled-updates-retries
Configures scheduled updates retries. - config-sessions
Configures session management. - config-two-factor-auth
Configures two-factor authentication. - config-userdir
Configures the user directory. - config-username-password-database-auth
Configures the Spotfire database authentication source to use the USERNAME_PASSWORD authentication method. - config-username-password-ldap-auth
Configures the LDAP authentication source for use with the USERNAME_PASSWORD authentication method. - config-username-password-windows-auth
Configures the Windows NT authentication source to use the USERNAME_PASSWORD authentication method. - config-web-service-api
Configures the public Web Service API. - config-windows-userdir
Configures the Windows user directory mode. - copy-deployment-area
Copies the deployment area. - copy-group-membership
Copies group membership from one principal to another. - copy-library-permissions
Copy library permissions from one principal to another. - copy-rules-to-site
Copies routing rules and schedules from one site to another - create-actionlogdb
Creates the Spotfire action log database schema. - create-datadirect-datasources-update-script
Creates a script file for updating Information Services data sources that use TIBCO-branded Progress DataDirect JDBC drivers. - create-db
Creates the Spotfire database schema. - create-default-config
Creates a new server configuration file containing the default configuration. - create-deployment-area
Creates a deployment area. - create-group
Creates a new group. - create-jmx-user
Creates a new JMX user account. - create-join-db
Configures the default join database. - create-ldap-config
Creates a new LDAP configuration for authentication and/or the user directory LDAP provider. - create-scheduled-jobs
Creates scheduled Automation Services jobs from a JSON file created by the user. - create-site
Creates a new site. - create-user
Creates a new user account. - delete-analysis-states
Deletes analysis states, also known as "personalized views for each web client user". - delete-config
Deletes a server configuration from the server database. - delete-disabled-users
Deletes disabled user accounts. - delete-disconnected-groups
Deletes disconnected groups. - delete-jmx-user
Deletes a JMX user. - delete-library-content
Deletes library content. - delete-library-items
Deletes library items that are specified by path and item type. - delete-library-versions
Deletes versions of library items. - delete-node
Deletes a specified node. - delete-oauth2-client
Deletes a specified OAuth2 client. - delete-service-config
Deletes a service configuration. - delete-site
Deletes a site. - delete-user
Deletes a user account. - demote-admin
Revokes full administrator privileges for a user. - download-troubleshooting-bundle
Downloads the troubleshooting bundle. - enable-user
Enables or disables a user account in the Spotfire database. - export-code-signing-root-certificate
Exports the internal root certificate for code signing. - export-config
Exports a server configuration from the server database to the current working directory as a configuration.xml file. - export-deployment-area
Exports the deployment area to a file with the extension .sdn. - export-ds-template
Exports the definition of a data source template. - export-groups
Exports groups from the user directory. - export-library-content
Exports content from the library. - export-rules
Exports routing rules and schedules, including scheduled Automation Services jobs, from the server. - export-service-config
Exports a service configuration. - export-users
Exports users from the user directory. - external-download
Downloads library items from external storage. - find-analysis-scripts
Finds scripts, data functions, and custom queries in files in the library. - find-analysis-urls
Finds URL references in analysis (.dxp) files in the library. - help
Displays the help overview or a specific help topic. - import-code-signing-certificate
Imports a code signing certificate. - import-config
Imports a server configuration from a file to the server database. - import-groups
Imports groups to the user directory. - import-jaas-config
Imports new JAAS application configurations into the server configuration. - import-library-content
Imports content into the library. - import-rules
Imports routing rules and schedules to the server. - import-service-config
Imports a service configuration. - import-users
Imports users to the user directory. - invalidate-persistent-sessions
Invalidates all persistent sessions. - issue-access-token
Issues an access token to an API client. - list-active-service-configs
Lists active (configured) service configurations. - list-addresses
Lists the addresses of a node. - list-admins
Lists the server administrators. - list-auth-config
Displays the current authentication configuration. - list-certificates
Lists the certificates that establish the trust between components within the Spotfire collective. - list-code-entities
Lists code entities known to the system. - list-code-signing-certificates
Lists certificates issued to a specific user, to all users on the system, or, lists external code signing certificates. - list-code-signing-root-certificates
Lists code signing root certificates, both those issued and imported to the Spotfire Server. - list-configs
Lists all available server configurations. - list-deployment-areas
Lists the deployment areas. - list-ds-template
Lists the data source templates. - list-groups
Lists all groups. - list-jaas-config
Lists the JAAS application configurations. - list-jmx-users
Lists all JMX users. - list-ldap-config
Displays LDAP configurations. - list-ldap-userdir-config
Lists the configuration for the user directory LDAP mode. - list-licenses
Lists the currently known licenses and license functions. - list-logging
Lists logging templates for a specified node. - list-nodes
Lists the nodes in the collective. - list-ntlm-auth
Displays the NTLM authentication service configuration. - list-oauth2-clients
Lists registered OAuth2 clients. - list-online-servers
Lists all online servers. - list-post-auth-filter
Displays the current post-authentication filter configuration. - list-service-configs
Lists available service configurations. - list-service-instances
Lists the service instances in the collective. - list-services
Lists the installed services in the collective. - list-sites
Lists the sites in the collective. - list-userdir-config
List the current user directory configuration. - list-users
Lists all users. - list-windows-userdir-config
Lists the configuration for the user directory Windows NT mode. - manage-deployment-areas
Manages the deployment areas. - migrate-action-db
Migrates an action database from one database to another. - migrate-db
Migrates a Spotfire Server database from one database to another. - modify-db-config
Modifies the common database connection configuration. - modify-ds-template
Modifies a data source template. - promote-admin
Assigns full administrator privileges to a user. - register-api-client
Registers a new API client. - register-as-tibco-cloud-client
Registers the Spotfire Web Player as a TIBCO Cloud API client. - register-oidc-client
Registers the Spotfire Server as an OpenID Connect client. - register-job-sender-client
Registers a new Automation Services Client Job Sender client. - remove-code-signing-root-certificate
Removes previously imported root certificate, issued by a certificate authority (CA), from the Spotfire Server. - remove-code-trust
Removes trust for a principal (user or group). - remove-config-prop
Removes the values of a specific configuration property. - remove-ds-template
Removes a data source template. - remove-jaas-config
Removes the specified JAAS application configurations from the server configuration. - remove-ldap-config
Removes LDAP configurations. - remove-license
Removes a license from a group. - remove-member
Removes a user or group as a member of a specified group. - reset-code-trust
Resets code trust for the current cluster, in the sense that a new Certificate Authority (CA) will be generated and all the current certificates will be deleted. - reset-trust
Resets the trust within the Spotfire collective. - revoke-code-signing-certificate
Revokes either a specific code signing certificate or all certificates for the specified user from a start date and up until now. - revoke-consent
Revokes consent that a specific user has given an OAuth2 client (or all such clients). - revoke-token
Revokes a given access or refresh token that was previously issued to an OAuth2 client. - run
Runs a configuration script. - s3-download
Downloads the data of library items in Amazon S3 storage. - set-addresses
Sets the addresses for a Spotfire Server node. - set-config
Sets the current server configuration. - set-config-list-prop
Sets one or more values of a specific configuration list property. - set-config-map-prop
Sets one or more values of a specific configuration map property. - set-config-prop
Sets the value of a specific configuration property. - set-db-config
Sets the common database connection configuration. - set-license
Sets a license and license functions for a group. To see the currently available licenses and license functions, use thelist-licenses
command. - set-logging
Set logging for a specified node. - set-preference
Sets a preference for a group. - set-public-address
Configures the public address. - set-sensitive-config-prop
Sets the value of a specific sensitive configuration property. - set-server-service-config
Sets the configuration for a service running in Spotfire Server (typically the Spotfire Web Player front-end). - set-service-config
Sets the configuration for a service running on a remote node. - set-site
Sets the site to which a node should belong. - set-user-password
Sets a new password for a given user. - show-code-trust
Generate code trust reports. - show-config-history
Shows the configuration history. - show-deployment
Shows the current deployment. - show-import-export-directory
Shows the library import/export directory. - show-join-database
Shows the configured default join database. - show-library-permissions
Shows permissions set in the library. - show-licenses
Shows licenses set on the server. - show-oauth2-client
Shows the configuration of a specified OAuth2 client. - show-named-user-licenses
Shows named-user licenses set on the server. - show-username-password-ldap-auth
Shows the LDAP authentication source for use with the USERNAME_PASSWORD authentication method. - show-preference
Shows a preference for a group. - sqlserver-datasource-update-script
Use this command to run a scan of all Information Services data sources that use the JDBC Driver for Microsoft SQL Server, to identify ones that are not configured with either of the settingsencrypt=true
ortrustServerCertificate=true
. The scan helps you find data sources that might have stopped working due to changes to encryption, which were introduced in the version of the JDBC Driver for Microsoft SQL Server included in Spotfire 12.3 and later. - switch-domain-name-style
Switches the domain names for all users and groups from one style (DNS or NetBIOS) to the other (for all configured domains). - test-jaas-config
Tests a JAAS application configuration. - trust
Trusts scripts, data functions, or custom queries in a file in the library. - trust-node
Trusts a specified node. - untrust
Untrusts scripts, data functions, or custom queries in a file (or all files) in the library. - untrust-node
Untrusts a specified node. - update-bootstrap
Updates an existing bootstrap configuration file. - update-datasource
Updates an Information Services data source with new settings. - update-deployment
Updates the current deployment. - update-ldap-config
Updates LDAP configurations. - update-oidc-provider
Updates the configuration of an OpenID Connect provider. - update-site
Updates a site. - validate-data-source
Facilitates testing and troubleshooting of data source templates for Information Services data sources. - version
Displays the current version of the server.
Parent topic: Reference