Home
Administration Utility
Use the Administration Utility Command Line Interface (CLI) to manage Spectrum components and data.
Search Indexes
index list

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.
- 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.

index list

The index list command returns a list of all Spectrum Advanced Matching search indexes in a tabular format. The details include index name, index type, and the number of records. Indexes can be of two types: Legacy or Clustered. You can back up and restore clustered indexes. You can export both legacy and clustered indexes to *.txt files using the export utility.

You can also write the index list to a CSV (.csv) file at any specified location.

Usage

index list --c checkSchema --f filePath

Required	Argument	Description
No	--f `filePath`	File path to write index list. Note: The output is a comma delimited text file.
No	--c `checkSchema`	Compares repository schema with Elasticsearch schema.

Example 1

This example writes the search index list to the file listOutput.csv at the location: c:/exportLocation.

index list --f c:/exportLocation/listOutput.csv

Example 2

This example lists all search indexes.

index list

Example 3

This example checks the schema for all the search indexes and validates the schema to return the output as True or False, and writes the output to the file listOutput.csv at the location: c:/exportLocation.

index list --c true --f c:/exportLocation/listOutput.csv