Home
Administration Utility
Use the Administration Utility Command Line Interface (CLI) to manage Spectrum components and data.
Getting Started with the Administration Utility
The Administration Utility provides command line access to administrative functions. You can execute the commands interactively or in scripts. Some administrative functions are not available in the Administration Utility. For these functions you can use the Spectrum Management Console.
Install the Administration Utility
Download and install the Administration Utility from the Spectrum Technology Platform Home page. This topic also describes how to connect to the Spectrum Technology Platform server.

Welcome
Perform administrative tasks required to manage the operation of Spectrum Technology Platform on your system.
Getting Started
Configure and run a new installation of Spectrum Technology Platform.
Approval Flows
Define approval flows that data stewards use to review and accept records generated in a job by Exception Monitor.
Security
Perform tasks to secure your data on the Spectrum Technology Platform2022.1.0.
Data Sources
Configure data sources from which to load and process data in Spectrum Technology Platform2022.1.0.
Spectrum Databases
Manage databases that contain data from trusted data providers. These include databases used by Enterprise Tax, Geocoding, Global Sentry, Universal Addressing, Spatial and Routing.
Services
Access Spectrum Services through a REST or SOAP web service interface.
Flows
Schedule and manage job execution, options, and defaults.
Performance
Perform tasks to get optimal performance from your Spectrum Technology Platform environment.
Monitoring
Monitor system performance and configure notification and use system and audit logs.
Backup and Restore
Schedule or create backups and restore the Spectrum Technology Platform server.
Settings
View and configure Data Stewardship and Context Graph settings.
Administration Utility
Use the Administration Utility Command Line Interface (CLI) to manage Spectrum components and data.
- Getting Started with the Administration Utility
  The Administration Utility provides command line access to administrative functions. You can execute the commands interactively or in scripts. Some administrative functions are not available in the Administration Utility. For these functions you can use the Spectrum Management Console.
  - Install the Administration Utility
    Download and install the Administration Utility from the Spectrum Technology Platform Home page. This topic also describes how to connect to the Spectrum Technology Platform server.
  - Setting up Command Line Interface (CLI) properties in an HTTPS-enabled server environment
    If using self-signed certificates , make sure to import them to your local machine.
  - Using a Script with the Administration Utility
    The Administration Utility can execute a series of commands from a script file. This is useful if you want to automate or standardize administrative actions through the use of a script instead of manually executing commands through the Administration Utility or by using Spectrum Management Console.
  - Constraints and Limitations
    The following constraints or limitations should be accounted for when using the Administration Utility or Command Line Interface.
- Audit Log Information
  Audit Log Information CLI commands adds JSON activity and count information to the audit log files.
- Spectrum Business Glossary
  Spectrum Business Glossary CLI commands list, import and export glossary entities.
- Data Stewardship
  The Data Stewardship CLI command deletes exception records from the repository.
- Context Graph
  The Administration Utility Command Line Interface (CLI) provides Context Graph (contextgraph) commands to manage models, view jobs and job status, and manage model schemas, queries, and metadata.
- Data Sources
  Data source CLI commands manage connection between the Spectrum Technology Platform and data sources.
- Dataflows
- Entities
- Folders
- Information Extraction
- Jobs
- Spectrum Lineage & Impact Analysis
- Spectrum Machine Learning
- Match Keys
- Match Rules
- Best of Breed Rules
- Metadata Connections
- Notification
- Open Parser Cultures
- Open Parser Domains
- Performance Monitor
- Permissions
- Physical and Logical Models
- Process Flows
- Product Data
- Profiles
- Roles
- Scorecard
- Search Indexes
- Services
- Spectrum Databases
- Service pool size
- System
- Tables
- Tokens
- User Accounts
Spectrum properties
Reference information for spectrum-container.properties properties and proxy server settings.
About Spectrum Technology Platform
An overview of Spectrum, its data management architecture, its platform architecture, and its modules and components.

Install the Administration Utility

Download and install the Administration Utility from the Spectrum Technology Platform Home page. This topic also describes how to connect to the Spectrum Technology Platform server.

Note: The Administration Utility requires Java 11 or later. Verify that Java 11 is in the system PATH variable before running the Administration Utility.

If you are reinstalling an existing installation of the Administration Utility, first back up the cli.properties file if it exists and any other CLI configurations. These are located in the same folder in which the CLI files are located. Add the backed up file and other configurations to the updated CLI after you reinstall the Administration Utility.

On the Spectrum Technology Platform Home page, click Platform Client Tools.
Click Command Line.
Under Administration Utility, click Download and download the zip file to the computer where you want to use the Administration Utility.
Extract the contents of the zip file.
To launch the command line interface, do one of the following:
- If you are running the server on a Linux system, execute cli.sh.
- If you are running the server on a Windows system, execute cli.cmd.
Note: If necessary, modify the .sh or .cmd file to use the path to your Java installation.
Connect to the Spectrum Technology Platform server by typing this command:

connect --h servername:port --u username --p password --s SSLTrueOrFalse

For example,

connect --h myserver:8080 --u admin --p myPassword1 --s true
Once you are connected you can run commands. Some tips:
- For a list of available commands, type help or press the tab key.
- To auto-complete a command, type the first few characters then press the tab key. For example, typing us then pressing the tab key automatically completes the command user. Pressing the tab key again will display a list of all the user commands.
- If you specify an option value that contains a space, enclose the value in double quotes.
When you are done, type exit to exit the Administration Utility.