Administration commands
To perform one of these basic administration tasks, use the related command.
All administration commands connect directly to the Spotfire database and require that the server has been bootstrapped and that an initial configuration has been imported (by using the import-config command).
For instructions on using the commands, see Executing commands on the command line.
| Task | Command |
|---|---|
| Add a user or group as a member of a specified group. | add-member |
| Copy group membership from one principal to another. | copy-group-membership |
| Copy routing rules and schedules from one site to another. | copy-rules-to-site |
| Create a new user account. | create-user |
| Delete disabled users. | delete-disabled-users |
| Delete disconnected groups. | delete-disconnected-groups |
| Delete a specified OAuth2 client. | delete-oauth2-client |
| Delete a user account. | delete-user |
| Revoke full administrator privileges from a user. | demote-admin |
| Enable or disables a user in the Spotfire database. | enable-user |
| Export groups from the user directory. | export-groups |
| Export content from the library. | export-library-content |
| Export routing rules and schedules from the server. | export-rules |
| Export users from the user directory. | export-users |
| Finds scripts, data functions, and custom queries in files in the library. | find-analysis-scripts |
| Find URL references in analysis files (.dxp) in the library. | find-analysis-urls |
| Import groups to the user directory. | import-groups |
| Import content into the library. | import-library-content |
| Import routing rules and schedules to the server. | import-rules |
| Import scheduled updates from Web Player 7.0 and older. | import-scheduled updates |
| Import users to the user directory. | import-users |
| Invalidate all persistent sessions. | invalidate-persistent-sessions |
| List the server administrators. | list-admins |
| List the deployment areas. | list-deployment-areas |
| List all groups. | list-groups |
| List the currently known licenses and
license functions.
Note: You must
deploy before getting licenses.
|
list-licenses |
| List registered OAuth2 clients. | list-oauth2-clients |
| List all online servers. | list-online-servers |
| List all users. | list-users |
| Manage the deployment areas. | manage-deployment-areas |
| Assign full administrator privileges to a user. | promote-admin |
| Register a new API client. | register-api-client |
| Register a new Automation Services Client Job Sender client. | register-job-sender-client |
| Remove a license from a group. | remove-license |
| Revokes consent that a specific user has given an OAuth2 client (or all such clients). | revoke-consent |
| Set a license and license functions for a group. | set-license |
| Set a new password for a given user. | set-user-password |
| Show the current deployment. | show-deployment |
| Show permissions for a specific directory in the library. | show-library-permissions |
| Show licenses set on the server. | show-licenses |
| Show the configuration of a specified OAuth2 client. | show-oauth2-client |
| Switch the domain names for all users and groups from one style (DNS or NetBIOS) to the other (for all configured domains). | switch-domain-name-style |
| Update the current deployment. | update-deployment |