Skip to main content
Interania

Interana CLI reference

0votes
121updates
540views
This applies tov2.24

 

About the Interana CLI

The Interana CLI (command line interface) allows you to manage Interana clusters remotely after installation. The CLI is automatically installed when you install Interana on a node. However, you can also choose to install the Interana CLI on a separate system so you can manage multiple clusters remotely from one location. See the Admin Guide for more information.

Generally speaking, the ia command syntax follows an English object - verb pattern.  Some subcommands such as table also have verb options with associated parameters. For example,ia table list --type eventshows a list of all tables of the type Event is shown.

To view a list of all Interana CLI commands, type ia --help in a terminal window type. For help on a specific command, ia <command> --help in a terminal window.

If you don't have a valid certificate, you can use the --unsafe option with CLI commands until a valid cert is acquired. For more information on how to acquire a valid certificate, see How to replace a self-signed certificate.

Autocompletion

There is a built-in autocompletion feature (similar to bash autocompletion) that provides suggestions for names that you enter. For example, if you have tables called fashion and fashion2 and you press tab after entering f, the following suggestions automatically appear: fashion fashion2

Autocompletion only provides suggestions acceptable for the current command. For example, ia table delete accepts all types of tables, while ia table delete-time-range accepts event tables, but not lookup tables.

"Dry run" mode

Most Interana CLI commands that are destructive to the cluster (like deletion of data or metadata) default to a "dry run" mode which previews but does not actually execute the command. When you are ready to actually perform the command, add the--run flag. 

Access control 

Most Interana CLI commands can only be run by users who are members of the "admin" role. This role is automatically available to the initial user created during Interana install, and can be granted to other users via the ia user command.

Quick links

Click a link in the following list to jump directly to the topic.

ia command options

The following table lists the ia command options that are explained in this reference. Click an option to jump to a detailed description with examples.

ia    
  column Manage columns
  config Configure credentials for Interana CLI.
  email-domain Manage email domains.
  -help, --help Print help for this command and then exits.
  job Manage ingest jobs.
  node Manage cluster topology.
  pipeline Create and manage ingest pipelines.
  settings Manage application settings.
  table Manage event tables.
  tier Perform cross-tier tasks.
  user Manage users and user roles.

ia column

You can list all columns in a given table, change the data type of a column, delete data for a given column, and delete specified columns.

ia column {delete, exclude-import,hide,include-import,unhide,list,update,help}

The following table explains the ia column arguments. Click an argument to jump to a detailed description with examples.

ia column    
  Positional arguments  
  delete Deletes all data for a specified column, and removes the column from the table schema, unless otherwise specified. The default is dry-run mode. 
  exclude-import Excludes column from import.
  hide Hides a specified column.
  include-import Include a column in an import.
  list Lists all columns in a selected table. 
  unhide Show a column that has been hidden from the UI.
  update Changes the data type of a column. The default is dry-run mode.
  Optional arguments  
  --version Show's the program's version number and exits.
  -h, --help Shows help for this command.

ia column delete

You can delete the data for a specified column. The default is dry-run mode. Use the -r option to actually delete the column. When running the delete, metadata will be preserved by default, so the column will still exist in the UI and data for the column may be ingested in the future. Use the --delete-metadata option to remove the column from the UI and prevent further data for the column from being ingested.

ia column delete [-h] [-v] [--unsafe] [--instance-name handle [--version]
[--output {json,text,table}]  [--match-pattern MATCH_PATTERN] [--delete-metadata] [--run] table_name [column_name]

ia column delete    
  Positional arguments  
  column_name Column to be hidden. (This is required unless the "match-pattern" option is specified.)
  table_name Table containing the column.
  Optional parameters  
  --instance-name <name> Name of the Interana instance. Use specific stored credential instead of default.
  --output [json,text,table] Set the output format. The default is table.
  --match-pattern <match_pattern> Delete all columns in a table matching the given pattern, using SQL pattern matching.
  --delete-metadata Delete both column metadata and data.
  --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
  -v, --verbose Displays detailed imformation (verbose) for this command.
  --version Displays the version of Interana and Interana CLI currently installed.
  -h, --help Prints help for this command.

The following example uses the -r option to delete the length column.

ia column delete music length -r

Columns deleted
---------------------------------

length
The changes have been committed.

The following example uses the --match-pattern followed by the -r option, to delete all columns matching the specified SQL pattern.

ia column delete music --match-pattern l% -r
Columns deleted
---------------------------------------------
lastName
location
location.platform
location.browser
location.browser_majorver
location.browser_minorver
location.browser_patchver
location.device
level
length
The changes have been committed.

ia column exclude-import

You can exclude columns from an import pipeline.

ia column exclude import [-h] [-v] [--unsafe] [--instance-name <name>] [--version][--output {json, text, table}] table_name column_name

ia column exclude-import    
  Positional arguments  
  column_name Column to exclude from import.
  table_name Table containing the column to exclude from import.
  Optional parameters  
  --instance-name <name> Name of the Interana instance. Use specific stored credential instead of default.
  --output [json,text,table] Set the output format. The default is table.
  --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
  -v, --verbose Displays detailed imformation (verbose) for this command.
  --version Displays the version of Interana and Interana CLI currently installed.
  -h, --help Prints help for this command.

ia column hide

You can hide a specified column (in a particular table and Interana instance) from the user interface (UI).

ia column hide [-h] [-v] [--unsafe] [--instance-name <name>] [--version]
[--output {json, text, table}] table_name column_name

ia column hide    
  Positional arguments  
  column_name Column to be hidden.
  table_name Table containing the column to be hidden.
  Optional parameters  
  --instance-name <name> Name of the Interana instance. Use specific stored credential instead of default.
  --output [json,text,table] Set the output format. The default is table.
  --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
  -v, --verbose Displays detailed imformation (verbose) for this command.
  --version Displays the version of Interana and Interana CLI currently installed.
  -h, --help Prints help for this command.

ia column include-import

You can include columns in an import pipeline.

ia column include import [-h] [-v] [--unsafe] [--instance-name <name>] [--version][--output {json, text, table}] table_name column_name

ia column include-import    
  Positional arguments  
  column_name Column to be included in the import.
  table_name Table containing the column to be included in the import.
  Optional parameters  
  --instance-name <name> Name of the Interana instance. Use specific stored credential instead of default.
  --output [json,text,table] Set the output format. The default is table.
  --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
  -v, --verbose Displays detailed imformation (verbose) for this command.
  --version Displays the version of Interana and Interana CLI currently installed.
  -h, --help Prints help for this command.

ia column list

You can list all columns in a selected table and optionally specify the output to be in json, text, or table format. The default is table format.

ia column list [-h] [-v] [--unsafe] [--instance-name handle] [--version]
[--output {json,text,table}] [-t {all,deleted,hidden,import-excluded}] table_name

ia column list    
  Positional argument  
  table_name Name of the table to be shown.
  Optional arguments  
  --instance-name <name> Specify the name assigned to the cluster instance.
  --output [json,text,table] Set the output format. The default is table.
 

-t {all, deleted,hidden,import-excluded}

--type {all, deleted,hidden,import-excluded}

Show a specific type of column.
  --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
  -v, --verbose Sets verbose mode, shows crash stack trace.
  --version Displays the version of Interana and Interana CLI currently installed.
  -h, --help  Prints help for this command and then exits.

ia column unhide

You can show a column (in a particular table and Interana instance) that was previously hidden from the user interface (UI).

ia column unhide [-h] [-v] [--unsafe] [--instance-name <name>] [--version]
[--output {json, text, table}] table_name column_name

ia column unhide    
  Positional arguments  
  column_name Column to unhide.
  table_name Table containing the column to unhide.
  Optional arguments  
  --instance-name <name> Name of the Interana instance. Use specific stored credential instead of default.
  --output [json,text,table] Set the output format. The default is table.
  --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
  -v, --verbose Displays detailed imformation (verbose) for this command.
  --version Displays the version of Interana and Interana CLI currently installed.
  -h, --help Shows the help for this command, then exits.

ia column update

Use ia column update to change the data type of a column. The default is dry-run mode. Changing column type is a destructive operation which loses all previously ingested data for this column, and allows new data to be ingested with the new column type. 

ia column update [--output {json,text,table}] --type [--keep-old-column]
[--identifier-digits IDENTIFIER_DIGITS] [--run] [--datetime-format DATEETIME_FORMAT] table column

The following table lists the ia column update arguments.

ia column update    
  Positional arguments  
  column The name of the column to be updated.
  table The name of the table that contains the column to be updated.
  Optional arguments  
  --identifier-digits <IDENTIFIER_DIGITS> When changing a column to the "identifier" type, this parameter is mandatory and specifies the number of digits in the identifier (hex) data. Must be a multiple of 8.
  --datetime-format <DATETIME_FORMAT> When changing a column to the "datetime" type, this parameter is mandatory. This specifies the format of the datetime string using Python-style formatters. Example: 
%Y-%m-%d %H:%M:%S
  --instance-name <name> Specify the name assigned to the cluster instance.
  --keep-old-column Keeps the old data for the column being changed instead of deleting it. Use this option if you plan to revert the column type change in the future.
  --output {json, text, table} Sets the output format. The default is table.
  -t 
{int,identifier,decimal,dollars,int_set,string_set,string,url,ip,user_agent,seconds,milliseconds,microseconds,datetime}
Sets the data type for this column.
  -r, --run Executes the command. The default is dry-run mode.
  --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
  -v, --verbose Sets verbose mode, shows crash stack trace.
  --version Displays the version of Interana and Interana CLI currently installed.
  -h, --help  Prints help for this command and then exits.

 

In the following example, the length type is changed from decimal to string.

ia column update -t string music length
Table Column Old type New type
music length decimal string
This is a preview mode. Rerun with --run option for changes to take effect. 

 

The following example uses the -r option to apply and save the change.

ia column update -t string music length -r
Table Column Old type New type
music length decimal string
The changes have been committed.

ia config

The ia config command is the first command you issue to be able to use the Interana CLI, after having installed Interana. 

ia config [-h] [-v] [--unsafe] [--instance-name handle] url

The following table explains theia config arguments.

ia config    
  Positional argument  
  url Use the HTTPS URL with the fully qualified domain name (FQDN) of the instance to configure a connection with the cluster.
  Optional arguments  
  --instance-name <name> Specify the name assigned to the cluster instance to be configured.
  --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
  -v, verbose Sets verbose mode, shows crash stack trace.
  --version Displays the version of Interana and Interana CLI currently installed.
  -h, --help  Prints help for this command and then exits.

Configuring the CLI

If you don't configure the CLI with ia config, you receive an error similar to the following when you attempt to execute a command:

Error: Could not read credentials from .interanarc: Did you forget to run config?

This means you need to setup login credentials for the cluster you want to manage. You must have already installed and provisioned the cluster. For more information, see the Admin Guide.

ia config <url> --instance-name <name>

Configure the CLI for a default cluster

The following is an example of how to configure the login credentials for a default cluster that has already been provisioned and installed.

ia config https://<mycluster.address.com>

You receive a response similar to the following:

Visit https://mycluster.interana.com/api/create_token and supply your new API token.

The cluster endpoint looks something like the following when you go to https://mycluster.interana.com/api/create_token to generate the token. 

Enter the token value where prompted for the API Key, and then press Enter. You are notified that the credentials are configured and you can begin using the CLI.

Enter API Key: ************************************************
 
Success! Credentials stored as default config

Configure the CLI for multiple clusters

You can configure the Interana CLI to run on multiple clusters, so you can manage the clusters remotely from one system. The CLI configuration process is similar to the default cluster configuration, except you save your authentication profile under the specified cluster name.

You use the --instance-name option in conjunction with the cluster URL to specify the cluster on which the CLI is to be configured.

ia config https://<mycluster2.address.com> --instance-name <cluster2_name>

ia email-domain

Use ia email-domain to add, display, and remove email domains available for user self-registration.

ia email-domain [--version] [-h] {add,remove,list,help}

The following table explains the ia email-domain arguments.

ia email-domain    
  Positional arguments  
  add Adds email domains for user self-registration.
  list Displays all email domains available for user self-registration, sorted in alphabetical order by domain name.
  remove Removes email domains from user self-registration. Note that removing e-mail domains does not affect existing users; it only affects self-registration for new users. 
  Optional arguments  
  --instance-name <name> Specify the name assigned to the cluster instance.
  --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
  -v, --verbose Sets verbose mode, shows crash stack trace.
  --version Displays the version of Interana and Interana CLI currently installed.
  -h, --help Prints help for this command and then exits.

When you add an email domain for self-registration, any user with a valid email address within that domain may register for an account using the "Don't have an account?" link on the Interana login screen.

ia email-domain add

You can add a single email domain for self-registration, or multiple email domains at once using a comma-separated list. You can set the output to json, text, or table format. The default is table.

ia email-domain add [-h] [-v] [--unsafe] [--instance-name handle] [--version]
[--output {json,text,table}] email_domains

ia email-domain add
  Positional arguments  
  add Adds email domains for user self-registration.
  email_domains Email domains to add for self-registration. Can be a single value (i.e. "interana.com") or a comma separated list (i.e.  "interana.com,ramneedle.com")
  Optional arguments  
  --instance-name <name> Specify the name assigned to the cluster instance.
  --output {json,text,table} Set the output format. The default is table.
  --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
  -v, --verbose Sets verbose mode, shows crash stack trace.
  --version Displays the version of Interana and Interana CLI currently installed.
  -h, --help Prints help for this command and then exits.

The following example demonstrates adding multiple email domains using a comma-separated list.

ia email-domain add example.com,myexample.com

Successfully added the email domain(s), 'example.com,myexample.com',
for self-registration

ia email-domain remove

You can remove a single email domain, or multiple email domains at once using a comma separated list. You can set the output to json, text, or table format. The default is table.

ia email-domain remove [-h] [-v] [--unsafe] [--instance-name handle] [--version] [--output {json,text,table}] email_domains

ia email-domain remove    
  Positional argument  
  email_domains Email domains to add for self-registration. Can be a single value (i.e. "interana.com") or a comma separated list (i.e.  "interana.com,ramneedle.com")
  Optional arguments  
  --instance-name <name> Specify the name assigned to the cluster instance.
  --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
  -v, --verbose Sets verbose mode, shows crash stack trace.
  --version Displays the version of Interana and Interana CLI currently installed.
  -h, --help Prints help for this command and then exits.

The following example demonstrates how to remove multiple email domains using a comma-separated list.

ia email-domain remove example.com,myexample.com

Successfully removed the email domain(s), 'example.com, myexample.com', for self-registration.

ia email-domain list

You can display a list of email domains available for user self-registration. You can set the output to json, text, or table format. The default is table.

ia email-domain list [-h] [-v] [--unsafe] [--instance-name handle] [--version]
[--output {json,text,table}]

ia email-domain list    
  Optional arguments  
  --instance-name <name> Specify the name assigned to the cluster instance.
  --output {json,text,table} Set the output format. The default is table.
  --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
  -v, --verbose Sets verbose mode, shows crash stack trace.
  --version Displays the version of Interana and Interana CLI currently installed.
  -h, --help Prints help for this command and then exits.

The following example displays a list of all email domains that are available for user self-registration, sorted in alphabetical order by domain name with the following command.

ia email-domain list

Email Domain
-------------------------
doughnuts101.com
cupcakes999.com
chococakebake.com
ohmypie.com

ia -help, ia --help

The ia -help and ia --help commands print a list of all Interana CLI commands. When combined with a specified command, the help for that command is shown.

For example, ia settings --help shows the help for the ia settings command.

usage: ia settings [--version] [-h] {list,update,delete,help} ...

positional arguments:
  {list,update,delete,help}
    list                List settings. All settings listed if application is
                        not specified
    update              Update settings. Can specify table ID if updating
                        purifier setting
    delete              Delete settings. Can specify table ID if deleting
                        purifier settings
    help                Prints help. ^_^


optional arguments:
  --version             Show program's version number and exit.
  -h, --help            Show this help message and exit.

ia job

Use ia job to create an ingest job for a pipeline

  • An ingest pipeline is a shared configuration that is used to create ingest jobs. It specifies the data source, its location, and can authenticate the data source. An ingest pipeline streamlines the process of ingesting data on a frequent basis.
  • An ingest job is the execution of an ingest pipeline that runs over a set time period, ingesting data from the data source specified by the ingest pipeline.

Before you create an ingest job you must first create a table in which to store the data. 

After creating jobs, you can view a list of jobs, as well as view statistics on specific jobs. You can also modify the status of selected jobs. For more information on creating your first ingest job, see the Interana CLI Ingest Quick Start.

 

ia job [--version] [-h] {create,update,list,pause,resume,delete,stats,help}

The following table explains the ia job arguments. Click an argument to jump to more detailed information.

ia job    
  Positional arguments  
  create Create ingest jobs with a pipeline or a config file.
  delete, pause, resume Modify the status of jobs.
  list  Display a list of ingest jobs.
  stats Display statistics for a job over a given time range.
  update Update a single job with the command line, or one or more jobs with a config file.
  Optional arguments  
  --version Displays the version of Interana and Interana CLI currently installed.
  -h, --help Prints help for this command and then exits.

ia job create

Use ia job create to create ingest jobs for a pipeline.

ia job create [-h] [-v] [--unsafe] [--instance-name handle] [--version]
[--output {json,text,table}] [--paused] [--nodes NODES [NODES ...]]
[-o PARAMETER_NAME VALUE] pipeline {continuous,onetime} start end

ia job create    
  Positional arguments  
  pipeline Specify the pipeline name or ID for which to create the job.
  {continuous, onetime} Specify the type of job: continuous or one time.
  start Specify the start date for the job.
  end Specify the end date for the job.
 

-n <node> [node ...]

--nodes <node> [node ...]

Specify which import node, or nodes, on which to run the job. Specify multiple nodes using a space-separated list. Use "all" to run the job on all nodes.
 

-o <parameter> <value>

--override <parameter_name>

Pipeline parameter and value to override for the job configuration. Can be specified multiple times to update multiple parameters.
  --output {json,text,table} Specify the format. The default is table.
  -p, --paused Create a job that is initially in a paused state.
  Optional arguments  
  --instance_name <name> Specify the name assigned to the cluster instance.
  --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
  -v, --verbose Sets verbose mode, shows crash stack trace.
  --version Displays the version of Interana and Interana CLI currently installed.
  -h, --help Prints help for this command and then exits.

A pipeline is a configuration you can use for multiple jobs, streamlining the ingest process. A pipeline specifies the data source, its location, and can authenticate the data source. For a list of valid data source types and parameters, see the Interana CLI Ingest Quick Start.

In the following example, a continuous ingest job is created with the my-company1_import stats pipeline, starting yesterday and ending today.

ia job create my-company1_import_stats continuous yesterday today

In the following example, we create a onetime ingest job with the my-company1_import_stats pipeline, starting on
5-1-2017 and ending on 5-2-2017. We pause the running import node import000 and override the copy_id parameter with 123456789.

ia job create my-company1_import_stats onetime 2017-05-01 2017-05-02 --paused
--running-import-nodes import000 --override copy_id 123456789

ia job delete, pause, resume

You can pause, resume, or delete jobs, specifying multiple jobs in a space-separated list if desired. Use the --all option to perform the action on all applicable jobs. You can perform the action on the applicable jobs in a given --table or--pipeline.

Jobs with a done status cannot be deleted.

The pause, resume, and delete commands all have a similar syntax.

ia job delete

ia job delete [-h] [-v] [--unsafe] [--instance-name handle] [--version] 
[--output {json,text,table}] [-p PIPELINE [PIPELINE ...]] [-a] [-t TABLE] [--run] [job_id [job_id ...]]

ia job pause

ia job pause [-h] [-v] [--unsafe] [--instance-name handle] [--version]
[--output {json,text,table}] [-p PIPELINE [PIPELINE ...]] [-a] [-t TABLE] 
[job_id [job_id ...]]

ia job resume

ia job resume [-h] [-v] [--unsafe] [--instance-name handle] [--version]
[--output {json,text,table}] [-p PIPELINE [PIPELINE ...]] [-a] [-t TABLE] 
[job_id [job_id ...]]

Arguments

Use the following arguments to modify job delete, pause, or resume status.

Positional argument  
job_id IDs of jobs to be paused, resumed, or deleted. You can specify multiple jobs in a comma-separated list.
Optional argument  
-a, --all Modify all applicable jobs.
--instance-name <name> Specify the name assigned to the cluster instance.
--output {json,text,table} Set the output format. The default is table.

-p <pipeline> [<pipleline> ...]

--pipeline <pipeline> [<pipleline> ...]

Change the status of all jobs in the specified pipeline. You can specify multiple pipelines in a space-separated list.

-t <table_name>

--table <table_name>

Change the job status for all jobs in a specified table.
--unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
-v, --verbose Sets verbose mode, shows crash stack trace.
--version Displays the version of Interana and Interana CLI currently installed.
-h, --help Prints help for this command and then exits.

Pause a job

ia job pause <job_ID> [--table <table_name> --pipeline <pipeline_name> --all]

The following example pauses job_ID 1, 2, and 3.

ia job pause 1 2 3

Resume a paused job

ia job resume <job_ID> [--table <table_name> --pipeline <pipeline_name> --all]

The following example resumes all the paused jobs for the import_stats table.

ia job resume --table import_stats

Delete a job

ia job delete <job_ID> [--table <table_name> --pipeline <pipeline_name> --all] -r/--run

The following example deletes the pipeline my-company1_import_stats.

ia job delete --pipeline my-company1_import_stats -r

ia job list

You can display ingest jobs filtered with any combination of the following parameters:

  • Job status—running, paused, done
  • Type of job—continuous, onetime
  • Table—table name
  • Pipeline—pipeline name 
ia job list [-h] [-v] [--unsafe] [--instance-name handle] [--version] [--output {json,text,table}] 
[-p PIPELINE [PIPELINE ...]][-s {running,paused,done}] [--table TABLE] [-t {continuous,onetime}]

The following table lists optional parameters.

ia job list    
  Optional arguments  
  --instance-name <name> Specify the name assigned to the cluster instance.
  --output {json,text,table} Set the output format. The default is table.
 

-p <pipeline_name>

--pipeline <pipeline_name>

List the jobs for the specified pipeline.
 

-s {paused,running,done}

--status {paused,running,done}

List the jobs of the specified status: paused, running, or done.
 

-t {continuous,onetime}

--type {continuous,onetime}

List the jobs of the specified type. For a list of valid types, see the CLI ingest Quick Start.
  --table <table_name> List of jobs for the specified table.
  --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
  -v, --verbose Sets verbose mode, shows crash stack trace.
  --version Displays the version of Interana and Interana CLI currently installed.
  -h, --help Print help for this command and then exits.

Deleted jobs are not displayed with ia job list

All jobs are displayed when no parameters are specified, as shown in the following example. 

The following example displays all jobs.

ia job list

Job ID Pipeline ID Pipeline Name Table Type Start End Status Overrides Running Import Nodes
1 1 c1_import_stats import_stats continuous yesterday today Running   All
2 2 c2_import_stats import_stats continuous yesterday today Running   All
3 3 c3_import_stats import_stats continuous yesterday today Running   All
4 4 c4_import_stats import_stats continuous yesterday today Running   All

 

The following example displays a list of import_stats tables of type continuous that are currently paused.

ia job list --type continuous --table import_stats --status paused

Job ID Pipeline ID Pipeline Name Table Type Start End Status Overrides Running Import Nodes
5 5 my_import_pipeline import_stats continuous yesterday today Paused   All
6 6 nyc_import_pipeline import_stats continuous yesterday today Paused   All

ia job stats

Use ia job stats to display stats for a job over a specified time range. Stats are grouped by iteration_date and status, and include the number of files, total raw file size, total transformed file size, and total line count.

 

ia job stats [-h] [-v] [--unsafe] [--instance-name handle] [--version]
[--output {json,text,table}] [-s START] [-e END] job_id

ia job stats    
  Positional argument  
  job_id  Name or ID of the job for which to view the stats.
  Optional arguments  
 

-s <start_date>

--start <start_date>

Start date over which to scan data. Use either of the following formats: 

YYYY-MM-dd or
YYYY-MM-ddTHH:mm:ss

 

-e <end_date>

--end <end_date>

End date over which to scan data. Use either of the following formats:  

YYYY-MM-dd or
YYYY-MM-ddTHH:mm:ss

  --instance-name <name> Specify the name assigned to the cluster instance.
  --output {json,text,table} Set the output format. The default is table.
  --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
  -v, --verbose Sets verbose mode, shows crash stack trace.
  --version Displays the version of Interana and Interana CLI currently installed.
  -h, --help Prints help for this command and then exits.

If a job's file pattern does not include dates (year, month, day, hour), then the date field is empty, and the only grouping is for Finished and Error files.

ia job stats itsreal_pipeline
Date Status Files Raw File Size Transformed File Size Line Count
  Finished 1 18817710 62090259 83894

Date range parameters are optional.  For one-time jobs, if no date range is specified, the stats for the entire job are shown. For example, if a job imported data from 2017-03-06 to 2017-03-15, the stats for the entire range are displayed. 

ia job stats my-app_backfill
Date Status Files Raw File Size Transformed File Size Line Count
2016-10-10T00:00:00 Finished 34 2351345 5245724 635621
2016-11-10T00:00:00 Finished 23 1346136 4574635 435742
2016-12-10T00:00:00 Finished 16 1246575 4034695 309233

If you specify the start and end dates and the job pattern includes hours, you can specify hour granularity.

ia job stats my-app_hourly_backfill --start 2016-10-10T13:00:00 --end 2016-10-10T19:00:00
Date Status Files Raw File Size Transformed File Size

Line Count

2016-10-10T13:00:00 Finished 1 258 510 1
2016-10-10T14:00:00 Finished 4 1035 2041 4
2016-10-10T15:00:00 Finished 1 258 510 1

ia job update

You can update the multiple parameters for a single job or transformation config. If you update a transformation config file, it must have the standard transformer library format of a list of lists.

ia job update [-h] [-v] [--unsafe] [--instance-name handle] [--version]
[--output {json,text,table}] [-s START] [-e END] [--nodes NODES [NODES ...]]
[-o PARAMETER_NAME VALUE] [--remove-override PARAMETER_NAME] job_id

Removes an override of a pipeline parameter for the specified job. Specify the name of the parameter to be removed. You can use this parameter multiple times to remove multiple parameters at once.

ia job update    
  Positional argument  
  job_id Specify the job ID or name.
  Optional arguments  
  --instance-name <name> Specify the name assigned to the cluster instance.
 

-n <node> [<node> ...]

--nodes <node> [<node> ...]

Specify node, or nodes, on which to run the job update. Specify mulitple nodes in a space-separated list. 

Use "all" to list all nodes in the cluster.

 

-o <parameter_name> <value>

--override <parameter_name> <value>

Adds or updates an override of a pipeline parameter for a specified job. Specify the parameter name and value to override. You can use this parameter multiple times to update multiple parameters at once.
  --output {json,text,table} Set the format. The default is table.
  --remove-override <parameter_name>  
 

-s <start_date>

--start <start_date>

 

-e <end_date>

--end <end_date>

Start date for the job.

 

 

End date for the job.

  --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
  -v, --verbose Sets verbose mode, shows crash stack trace.
  --version Displays the version of Interana and Interana CLI currently installed.
  -h, --help Prints help for this command and then exits.

The following example updates multiple parameters for the my-app_import_stats job.

ia job update my-app_import_stats -p wait_seconds 50 -p concat_file_size 250000000
Successfully updated my-app_import_stats

The following example updates the transformation config file for the my-app_import_stats job.

ia job update my-app_import_stats --transformation-config my-app_transformer_config.txt
Successfully updated my-app_import_stats

ia node

Use ia node to manage a list of nodes on a cluster using a cluster map.

ia node [--version] [-h] {add,remove,list,help} 

When working with data or string nodes, you typically use this command in conjunction with ia tier rebalance which rebalances data across nodes. For more information, see How to resize a cluster.

ia node    
  Postional arguments  
  add Adds nodes to a cluster. The nodes must already exist and have Interana installed.
  list Displays a list of nodes belonging to the cluster.
  remove Removes specified nodes from the cluster. This command does not directly touch the nodes themselves, it only updates the cluster topology in the Interana config DB to no longer reference these nodes. Before removing a node from an Interana cluster, please ensure that the node has been cleared of any active data (using "ia tier rebalance") or dedicated import jobs (using "ia job update").
  Optional arguments  
  --instance-name <name> Specify the name assigned to the cluster instance.
  --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
  -v, --verbose Sets verbose mode, shows crash stack trace.
  --version Displays the version of Interana and Interana CLI currently installed.
  -h, --help Prints help for this command and then exits.

The following example adds node5 to the cluster named mycluster1.

ia node add node5 mycluster1

The following example removes node3 from the cluster named mycluster2.

ia node remove node3 mycluster2

ia pipeline

Use ia pipeline to create an ingest pipeline with the CLI, or with a config file.  An ingest pipeline is a shared configuration that is used to create ingest jobs. It specifies the data source, its location, and can authenticate the data source. An ingest pipeline streamlines the process of ingesting data on a frequent basis.

 

ia pipeline [--version] [-h] {create,clone,list,show,delete,export,update,help}

ia pipeline    
  Postional arguments  
  clone  Create a cloned copy of an existing ingest pipeline, with the ability to set new parameters for the clone.
  create Create an ingest pipeline with the CLI or a config file. You can manually specify the pipeline parameters with the CLI, or use the -i or --interactive option to be prompted for the valid parameters interactively.
  delete Delete specified pipelines. Dry-run mode is the default. Use the -r or --run option to execute the command. Specify multiple pipelines by name in a space-separated list to delete multiple pipelines at once.
  export Export a pipeline configuration to a file. If an output file is not specified, the config is exported to the current directory with the <pipeline_name...>_pipline_config.txt format. 
  list Display a list of available pipelines for a specific table.
  show View detailed information about a specific pipeline.
  update Update a pipeline with the CLI or a config file. 
  Optional arguments  
  -v, --verbose Sets verbose mode, shows crash stack trace.
  --version Displays the version of Interana and Interana CLI currently installed.
  -h, --help Prints the help for this command, and then quits.

ia pipeline clone

Use the ia pipeline clone command to create a cloned copy of an existing ingest pipeline, with the ability to set new parameters for the cloned version of the pipeline.

ia pipeline clone [-h] [-v] [--unsafe] [--instance-name handle] [--version]
[--output {json,text,table}] [-p PARAMETER NAME VALUE] pipeline_name pipeline_clone_name

ia pipeline clone    
  Positional arguments  
  pipeline_clone_name Name of the pipeline to be cloned.
  pipeline_name Name of the new pipeline.
  Optional arguments  
  --instance-name <name> Specify the name assigned to the cluster instance.
  --output {json,text,table} Set output format. The default is table.
  -p <parameter_name> <value> Specify parameters for the clone, using the parameter name followed by its value. Use this syntax for each parameter, as shown in the following example. For a list of valid parameters, see the CLI ingest Quick Start.
  --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
  -v, --verbose Sets verbose mode, shows crash stack trace.
  --version Displays the version of Interana and Interana CLI currently installed.
  -h, --help Prints help for this command and then exits.

Example:

In the following example the finance17_import_stats pipeline is cloned to finanace17_import_stats_cloned, specifying new user and hostname parameters.

ia pipeline clone finance17_import_stats finance17_import_stats_cloned -p user StarAdmin 
-p hostname BigHome

ia pipeline create

You can create an ingest pipeline with the CLI, or with a config file.

Create a pipeline with the CLI

Use the ia pipeline create command to create an ingest pipeline with the CLI. You can manually specify the pipeline parameters on the command line, or use the -i or --interactive option to be prompted for the valid parameters interactively. 

ia pipeline create [-h] [-v] [--unsafe] [--instance-name handle] [--version]
[--output {json,text,table}] [--example-config] [-t TRANSFORMATION_CONFIG] 
[-p PARAMETER NAME VALUE] [--config-file CONFIG_FILE] [pipeline_name] [table_name] [data_source_type]

ia pipeline create    
  Positional arguments  
  data_source_type Type of data source the pipeline will ingest.
  pipeline_name Name of the pipeline being created.
  table_name Name of the table into which the pipeline will import data.
  Optional arguments  
  --config-file <config_file_path> Specifies the path to the dataset configuration file.
  --example-config Displays a sample config file for creating a pipeline.
  --instance-name <name> Specify the name assigned to the cluster instance.
  --output {json,text,table} Set the output format. The default is table.
 

-p <parameter_name> <value>

--parameter <parameter_name> <value>

Parameter and value to add to the pipeline configuration.

For a list of valid data source types and parameters, see the CLI ingest Quick Start.

  -t, --transformations <transformer_config_path> Specify the transformation config path for the pipeline.
  --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
  -v, --verbose Sets verbose mode, shows crash stack trace.
  --version Displays the version of Interana and Interana CLI currently installed.
  -h, --help Prints help for this command and then exits.

 

The following example creates a my_import_stats pipeline to an import_stats table. An aws data source is used, a my_transformer_config.tx transformations is called, and s3_access_key, s3_secret_access_keys3_bucket parameters are used.

ia pipeline create my_import_stats import_stats aws --transformations my_transformer_config.txt 
-p S3_access_key XXXXXXXXXXXXXXXXX -p s3_secret_access_key XXXXXXXXXXXXXXXXX 
-p s3_bucket interana-logs
Create a pipeline with a config file

The config format is the same as that used with create table.  The config itself must be a dictionary, and the ingest configs must be a list of dictionaries under the ingest key.

The following command creates a pipeline with a config file.

ia pipeline create --config-file <config_file_path>
Sample config
{
   "name": "my-company_import_stats",
   "data_source_type": "aws",
   "table_name": "import_stats",


   "data_source_parameters": {
       "file_pattern": "my-company1/{year:04d}-{month:02d}-{day:02d}/{hour:02d}/",
       "s3_bucket": "interana-logs",
       "s3_access_key": "AKIAITNPDJ2FOP3KHFNA",
       "s3_secret_access_key": "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"
   },


 "advanced_parameters": {
       "minimum_disk_space": 6000000000,
       "concat_file_size": 500000000,
       "wait_seconds": 30,
   },


 "data_transformations": [
       ["gunzip"],
       ["decode"],
       ["json_load"],
       ["merge_keys", {"column_1": "batch_id","column_2": "query_api_id", "output_column": "transaction_id"}],
       ["merge_keys", {"column_1": "pipeline_shard_id","column_2": "user_id", "output_column": "shard_key"}],
       ["add_label", {"column": "customer", "label": "my-company"}],
       ["json_dump"]
   ]
}

 

Config example

The following example creates a pipeline using the import_stats_pipeline_configs.txt file that includes output data for the import_stats table.

ia pipeline create --config-file import_stats_pipeline_configs.txt
ID Name Table File Pattern
1 my-co1_import_stats import_stats my-co1/{year:04d}-{month:02d}-{day:02d}/import
2 my-co2_import_stats import_stats my-co2/{year:04d}-{month:02d}-{day:02d}/{hour:02d}/
3 my-co3_import_stats import_stats my-co3/{year:04d}-{month:02d}-{day:02d}/{hour:02d}/

ia pipeline delete

Use ia pipeline delete to remove specified pipelines. Dry-run mode is the default. Use the -r or --run option to execute the command. Specify multiple pipelines by name in a space-separated list to delete multiple pipelines at once.

ia pipeline delete [-h] [-v] [--unsafe] [--instance-name handle] [--version]
[--output {json,text,table}] [-t TABLE] [--run]  [pipeline_name
[pipeline_name ...]]

ia pipeline delete    
  Positional argument  
  pipeline_name Name of the pipeline to be deleted.
  Optional arguments  
  --instance-name <name> Specify the name assigned to the cluster instance.
  --output {json,text,table} Set the output format. The default is table.
 

-r, --run

Use to execute the command. 

The default is dry-run mode.

 

-t <tale_name> 

--table <table_name>

Delete pipelines for the specified table.
  -r/--run Executes the command. The default is dry-run mode.
  --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
  -v, --verbose Sets verbose mode, shows crash stack trace.
  --version Displays the version of Interana and Interana CLI currently installed.
  -h, --help Prints help for this command and then exits.
Example:

The following example deletes pipeline company1_import_stats and company2_import_stats.

ia pipeline delete company1_import_stats company2_import_stats --run
Successfully deleted pipelines: company1_import_stats, company2_import_stats.

 

ia pipeline export

Use ia pipeline export to export a pipeline configuration to a file. If an output file is not specified, the config is exported to the current directory with the <pipeline_name...>_pipeline_config.txt format. 

 

ia pipeline export [-h] [-v] [--unsafe] [--instance-name handle] [--version]
[-o OUTPUT_FILE] pipeline_name [pipeline_name ...]

 

ia pipeline export    
  Positional argument  
  pipeline_name Name of the ingest pipeline to be exported.
  Optional arguments  
  --instance-name <name> Specify the name assigned to the cluster instance.
 

-o <output_file>

--output-file <output_file>

File (path) to which to write the configuration. The default output file (and path) is <ingest-pipeline-name>_pipeline_config.txt, in the current directory.
 

 

-o <output_file>

--output-file <output_file>

The name of the configuration file to which the pipeline data is exported. 
  --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
  -v, --verbose Sets verbose mode, shows crash stack trace.
  --version Displays the version of Interana and Interana CLI currently installed.
  -help, --help Prints help for this command and then exits.

Example:

In the following example the finance17_pipeline is exported to finance17_year-end_export.txt.

ia pipeline export finance17_pipeline --output-file finance17_year-end_export.txt

ia pipeline list

Use ia pipeline list to display a list of available pipelines for a specific table. 

 

ia pipeline list [-h] [-v] [--unsafe] [--instance-name handle] [--version]
[--output {json,text,table}] [-t TABLE]

 

ia pipeline delete    
  --instance-name <name> Specify the name assigned to the cluster instance.
 

--output {json,text,table}

Set the output format. The default is table.
 

-t <table_name>

--table <table_name>

List the pipelines for the given table.
  --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
  -v, --verbose Sets verbose mode, shows crash stack trace.
  --version Displays the version of Interana and Interana CLI currently installed.
  -help, --help Prints help for this command and then exits.

 

Example:

The following example displays a list of pipelines in the import_stats table.

ia pipeline list --table import_stats

ID Name Data Source Table
1 finance_import_stats aws import_stats
2 marketing_import_stats aws import_stats
3 sales_import_stats aws import_stats

ia pipeline show

Use ia pipeline show to view detailed information about a specific pipeline.

ia pipeline show [-h] [-v] [--unsafe] [--instance-name handle] [--version]
[--output {json,text,table}] pipeline_name

ia pipeline show    
  Positional argument  
  pipeline_name Name of the pipeline with the information to be displayed.
  Optional arguments  
  --instance-name <name> Specify the name assigned to the cluster instance.
  --output {json,text,table} Set the output format. The default is table.
  --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
  -v, --verbose Sets verbose mode, shows crash stack trace.
  --version Displays the version of Interana and Interana CLI currently installed.
  -help, --help Prints help for this command and then exits.

 

Example:

The following example shows the details for the music-azure-pipeline.

ia pipeline show music-azure-pipeline

Key Value
Name music-azure-pipeline
Data Source azure-blob
Table music
Data Source Parameters

{u'storage_key': u'2poiyJ4EtGWwx+i3/DsRWUPwb8zViqEya5ZUS1o9hbaIz9UOM+XVBmEo8nIYC63v1gcPov7YCm/ITIULr6NRBw==', u'sas_key': None, u'storage_account': u'interanadevfiles', u'container': u'integration-test-files', u'file_pattern': u'Music'}

Advanced Parameters

{u'wait_seconds': 60, u'minimum_disk_space': 20000000000, u'concat_file_size': 1000000000}

Transformations  

ia pipeline update

You can update a pipeline in the following ways:

Update a pipeline with the CLI

Use the following command to automatically update pipelines with the CLI. 

ia pipeline update [-h] [-v] [--unsafe] [--instance-name handle] [--version]
[--output {json,text,table}] [--example-config] [-p PARAMETER NAME VALUE] 
[-t TRANSFORMATION_CONFIG] [--config-file CONFIG_FILE] pipeline_name

For a list of valid parameters, see the CLI ingest Quick Start.

ia pipeline update    
  Positional argument  
  pipeline_name Name of the pipeline to be updated.
  Optional arguments  
  --config-file  <config_file> Path for the config file to be updated.
  --example-config Displays a sample config file for updating a pipeline.
  --instance-name <name> Specify the name assigned to the cluster instance.
  --output {json,text,table} Set the format. The default is table.
 

-p <parameter> <value>

--parameter <parameter> <value>

Name of the parameter and its value to which the pipeline is to be updated.

For a list of valid data source types and parameters, see the CLI ingest Quick Start.

 

-t <transformer_config>

--transformation-config <transformer_config>

Path to the transformation config file with which to update the pipeline.
  --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
  -v, --verbose Sets verbose mode, shows crash stack trace.
  --version Displays the version of Interana and Interana CLI currently installed.
  -help, --help Prints help for this command and then exits.

 

Example:

The following example updates the my-company_import_stats pipeline with the wait_seconds and concat_file_size parameters, and using the my-company_transformer_config.txt transformation configuration.

ia pipeline update my-company_import_stats -p wait_seconds 50 -p concat_file_size 250000000 
--transformation-config my-company_transformer_config.txt

Successfully updated my-company_import_stats
Update a pipeline with a config file

Use the following command to automatically update the pipelines in a config file.

ia pipeline update --config-file <config_file_path>

Example:

The following example updates the import_stats_update_pipelines.txt config file and shows output for the updated pipelines.

ia pipeline update --config-file import_stats_update_pipelines.txt

Updated Pipelines
my-co1_import_stats
my-co2_import_stats
my-co3_import_stats

ia settings

Use ia settings to list, update, and delete settings, as shown in the following examples. Currently all settings that have an application other than webapp are loaded as strings, which could potentially cause issues on the cluster.  Also, only purifier_settings have a table_id field. That field is blank for other settings.

ia settings [--version] [-h] {list,update,delete,help}

The following table explains the ia settings arguments. Click an argument to jump directly to more information.

ia settings    
  Positional arguments  
  delete

Deletes settings. You can specify the table ID if deleting a purifier setting.

  list Lists settings. All settings are listed if an application is not specified.
  update Updates settings. You can specify the table ID if updating a purifier setting.
  Optional arguments  
  --version Displays the version of Interana and Interana CLI currently installed.
  -h, --help Prints help for this command and then exits.

ia settings list

Use the ia settings list command to view a list of all applications or only settings for specified applications.

ia settings list [-h] [-v] [--unsafe] [--instance-name <instance_name>][--version]
[--output {json,text,table}][--application <application_name>]

ia settings list    
  --application <application_name> Lists the settings for the specified application.
  --instance-name <name> Specify the name assigned to the cluster instance.
  --output {json,text,table} Set the output format. The default is table.
  --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
  -v, --verbose Sets verbose mode, shows crash stack trace.
  --version Displays the version of Interana and Interana CLI currently installed.
  -h, --help Prints help for this command and then exits.

The following example displays a list of all applications, with output for both webapp and purifier applications.

ia settings list
Application Table ID Key Value
webapp   landing_url "?dashboard=dashboard-amuller-0&name=Amuller%27s%20Dashboard"
webapp   isEmbedChartEnabled true
purifier 1 mi "goose-chase"

Use the following command syntax to list details for a specific application.

ia settings list --application <application_name>

ia settings update

Use the ia settings update command to update the settings in the database.

ia settings update [-h] [-v] [--unsafe] [--instance-name handle] [--version]
[--output {json,text,table}] [-t TABLE_ID] [-f] application key value

ia settings update    
  Positional arguments  
  application key value Application-key pair and it's specified value. Every application-key pair can only have one value in the database.
  Optional arguments  
  -f, --force Use to force a setting update without validation.
  --instance-name <name> Specify the name assigned to the cluster instance.
 

-t <table1,table2,...> 

--table-id <table1,table2,...>

Specify a table, or tables, for which the purifier setting is to be updated. Specify multiple tables to be updated at once using a comma-separated list. If no table-id is specified, the purifier setting is applied to all tables.
  --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
  -v, --verbose Sets verbose mode, shows crash stack trace.
  --version Displays the version of Interana and Interana CLI currently installed.
  -h, --help Prints help for this command and then exits.

Every application-key pair can only have one value in the database. The following example updates the showABTestView key for the webapp application. 

ia settings update webapp showABTestView true
Change may require restarts on query-api-server nodes/services. 
Please refer to 'ConfigDB Options' on our wiki for details.

Successfully updated with (webapp, showABTestView, true)

The optional --table-id parameter only applies to purifier. If the --table-id parameter is not specified, the purifier setting applies for all tables and appears as the value -1. In the following example, the --table-id is specified.

ia settings update purifier strict_number_detection 1 table-id 1,2

Successfully updated with (strict_number_detection, 1) for tables 1,2

In the following example, the --table-id parameter is omitted.

ia settings update purifier force_geo_to_string 1

Successfully updated with (force_geo_to_string, 1) for table(s) -1

ia settings delete

You can use the ia settings delete command to delete a setting from the database. As with ia setting update, the optional --table-id parameter only applies only to purifier settings.

ia settings delete [-h] [-v] [--unsafe] [--instance-name handle][--version]
[--output {json,text,table}][-t TABLE_ID] application key

ia settings delete    
  Positional arguments  
  application key 

Application of setting be deleted. Key of setting to be deleted

  Optional arguments  
  --instance-name <name> Specify the name assigned to the cluster instance.
  --output {json,text,table} Set the format. The default is table.
 

-t <table1,table2,...>

--table-id <table1,table2,...>

Specify a table, or tables, for which the purifier setting is to be updated. Specify multiple tables to be updated at once using a comma-separated list. If no table-id is specified, the purifier setting is applied to all tables.
  --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
  -v, --verbose Sets verbose mode, shows crash stack trace.
  --version Displays the version of Interana and Interana CLI currently installed.
  -h, --help Prints help for this command and then exits.

ia table

You can create a table using the command line or a config file. Once a table is created, you can add and delete shard keys, import data, delete a time range from a table, export the table to configuration to a config file, and view a list of all tables. For information on how to add your first file or table to a cluster, see the Interana CLI Ingest Quick Start.

ia table [--version] [-h] {create,list,delete,delete-time-range,export,
add-shard-key,remove-shard-key,add-shard-function-exception,join,
add-colocated-shard-key,remove-colocated-shard-key,
list-colocated-shard-keys,import,help}

The following table explains the ia table arguments. Click an argument to jump directly to more information. 

ia table    
  add-colocated-shard-key Adds a column as a colocated shard key; no new tablecopies are created (no new data).
  add-shard-key Adds a shard key to a table. This does not affect existing data on the cluster, but any new data ingested will honor the additional shard key.
  add-shard-function-exception Adds shard-function-exceptions (otherwise known as a whale shard) to a shard key.
  create Creates a new table by specifying the table name, time column, and shard keys, or through a configuration file.
  delete Deletes all the data and import records for a given table. Marks the table and associated column definitions as they are deleted, unless specified otherwise. The default is dry-run mode.
  delete-time-range Deletes a time range of data for a given table. Also deletes strings associated with the data, if a start-time is not specified. The default is dry-run mode.
  export Exports the table configuration to a file, this includes column info and ingest jobs.
  join Joins string columns.
  import Sets up a one-time import of data from one or more files to a table.
  list Lists all of your tables.
  list-colocated-shard-key Displays a list of columns with colocated shard keys.
  remove-colocated-shard-key Removes a column with a colocated shard key.
  remove-shard-key Removes a shard key from a table by deleting its corresponding table copy.
  Optional arguments  
  --instance-name <name> Specify the name assigned to the cluster instance.
  --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
  -v, --verbose Sets verbose mode, shows crash stack trace.
  --version Displays the version of Interana and Interana CLI currently installed.
  -h, --help Prints help for this command and then exits.

ia table add-colocated-shard-key

Use ia table add-colocated-shard-key to add a column as a colocated shard key, so no new table copies are created (no new data).

ia table add-colocated-shard-key [-h] [-v] [--unsafe] [--instance-name handle]
[--version] [--output {json,text,table}]  table_name column_name shard_key_column_name

ia table add-colocated-shard-key
  Positional arguments  
  table_name Name of the event table to which the colocated shard key is being added.
  column_name Name of the colocated column to be added.
  shard_key_name Name of the shard key to be added.
  Optional parameters  
  --instance-name <name> Name of the Interana cluster, in the event there are multiple configured clusters.
  --output

Options for output display format: json, text, table

  --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
  -v, --verbose Sets verbose mode, shows crash stack trace.
  --version Displays the version of Interana and Interana CLI currently installed.
  -h, --help Prints help for this command and then exits.

ia table add-shard-function-exception

Use ia table add-shard-function-exception add shard-function-exceptions (otherwise known as a whale shard) to a shard key.

ia table add-shard-function-exception [-help] [-v] [--unsafe] [--instance-name handle][--version] [--output {json,text,table}] table_name shard_function_exception shard_key

ia table add-shard-function-exception
  Positional arguments  
  table_name Name of the event table.
  shard_key Name of the shard key.
  shard_function_exception Value of the shard-key to exclude from the shard-function (otherwise known as a whale shard). Provide an integer for int shards, a string for string shards, or a hash for hex shards.
  Optional arguments  
  --instance-name <name> Name of the Interana cluster, in the event there are multiple configured clusters.
  --output {json,text,table}

Options for output display format: json, text, table

  --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
  -v, --verbose Sets verbose mode, shows crash stack trace.
  --version Displays the version of Interana and Interana CLI currently installed.
  -h, --help Prints help for this command and then exits.

ia table add-shard-key

Use ia table add-shard-key to add a shard_key to the specified event table and create the associated tablecopy. The shard key you add is modeled after an existing shard_key for all non-shard_key fields. 

ia table add-shard-key [-help] [-v] [--unsafe] [--instance-name handle][--version] [--output {json,text,table}] table_name shard_key_name

ia table add-shard-key    
  Positional arguements  
  table_name Name of the event table to which the colocated shard key is being added.
  shard_key_name Name of the shard key to be added.
  Optional parameters  
  --instance-name <name> Name of the Interana cluster, in the event there are multiple configured clusters.
  --output

Options for output display format: json, text, table

  --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
  -v, --verbose Sets verbose mode, shows crash stack trace.
  --version Displays the version of Interana and Interana CLI currently installed.
  -h, --help Prints help for this command and then exits.

 

Adding a shard_key to a table with existing data requires that you re-import the data to fill up the new tablecopy for the new shard_key.

In the following example, the lolz shard key is added to the fashion2 table.

ia table add-shard-key fashion2 lolz
Table Affected Shard Key Added All Shard Keys
fashion2 lolz lolz,user
Please re-import existing data to populate the new shard key (new data will be imported automatically). 

ia table create

You can use ia table create to create a table using command line parameters or through a config file. You should plan for future cluster resize growth in your shard key layout, as well as optimum functionality for the current state of the cluster. You can specify multiple shard keys.

 

ia table create [-h] {event,lookup,config-file}

ia table create    
  Modes  
  event Create an event table.
  lookup Create a lookup table.
  config-file Create a table using a config file.
Mode Parameters  
event table_name Name of the event table to be created.
event time_column Name of the time column.
event time_column_format Time and date format. For a list of valid data parameters, see the CLI ingest Quick Start.
event shard_key_name Name of the shard key to be added.
lookup table_name Name of lookup table to create.
lookup event_table_name Name of event table to join lookup table to.
lookup lookup_column_name Name of column in the lookup table to join to the event table.
lookup event_column_name Name of the event table column to join with the lookup table.
config-file table_name Path of config file to create a table and optionally, pipelines.
Mode Optional parameters  
event --shards-per-node SHARDS_PER_NODE Number of shards per data node; advanced configuration
config-file --example-config Displays a sample config file to create a table.
All --instance-name <name> Name of the Interana cluster, in the event there are multiple configured clusters.
All --output {json,text,table}

Options for output display format: json, text, table

All --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
All -v, --verbose Sets verbose mode, shows crash stack trace.
All --version Displays the version of Interana and Interana CLI currently installed.
All -h, --help Prints help for this command and then exits.
Event

Use the following syntax to create an event table. For a list of valid time column formats and see the Table configurations section of the CLI ingest Quick Start

ia table create event <table_name> <time_column> <time_column_format> <shard_key> 
[--shards-per-node <shards per data node>]

In the following example, we create an event table named my_event with a timestamp (time) column in millisecond format, and a  user_id shard key.

ia table create event my_event timestamp milliseconds user_id
ID Name Type  Time Col Shard Keys Shard Function Exceptions
8 my_event Event timestamp user_id  

Lookup

Use the following syntax to create a lookup table. Auto-complete is available for event_table_name and event_column_name. For a list of valid lookup table configuration parameters, see the Table configurations section of the CLI ingest Quick Start

ia table create lookup <table_name> <event_table_name> <lookup_column_name>
 <event_column_name>  [--force-non-sharded-lookup]

In the following example, we create a lookup table named my_lookup that references the my_event event table, and has an id lookup column that references the user_id event table column.

ia table create lookup my_lookup my_event id user_id
ID Name Type Time Col Shard Keys Shard Function Exceptions
10 my_lookup Lookup   id  
Config-file

Using a config file streamlines table creation. Use the following syntax to create a table with a config file. For a list of valid parameters, see the Table configurations section of the CLI ingest Quick Start

ia table create config-file <config file path>
ia table create config-file --example-config

Column definitions can be specified, as well as colocated columns and ingest jobs.

In the following example, we create an event table using the old_music_dataset_config.txt. This config file contains a pipeline, the results of which are shown in the second output display.

ia table create config-file old_music_dataset_config.txt 
ID Name Type Time Col Shard Keys Shard Function Exceptions
11 music Event ts userID  

 

ID Name Table  Data Source File Pattern  
4 music_import music file_system /datasets/music/music_april_2015.json

ia table delete

Use ia table delete to remove any table from your cluster, including lookup tables. Auto completion displays both types of tables (event and lookup) when applicable. 

ia table delete [-h] [-v] [--unsafe] [--instance-name handle] [--version]
[--output {json,text,table}] [-y] [--delete-metadata] [--run] table_name

ia table delete      
  Positional argument  
  table_name Name used for the table.
  Optional arguments  
  --delete-metadata Use to delete the metadata (table definitions).
  --instance-name <name> Name of the Interana cluster, in the event there are multiple configured clusters.
  --output {json,text,table} Set the output format. The default is table.
  -r, --run Use to execute the command. The default is dry-run mode.
  --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
  -v, --verbose Sets verbose mode, shows crash stack trace.
  --version Displays the version of Interana and Interana CLI currently installed.
  -h, --help Prints help for this command and then exits.

Use ia table delete default is dry-run mode, so you can verify that the specified table can be deleted. Use the -r option to execute the command. The --delete-metadata parameter removes the table definition, in addition to deleting all of the existing data (event and strings) and import records.

Lookup tables will not have a # of Events column, since they do not contain event data. 

ia table delete fashion2 --keep-metadata  -r
Initiating deletion for table fashion2, please wait...
Table Metadata Import Record # String Colums Deleted # Folders Deleted # Events Deleted
fashion2 Unchanged Success 19 11  12,025

Table fashion2 has been deleted. Use ia table list to see the status of tables.

ia table delete-time-range

Use ia table delete-time-range to delete table data within a specified time range.

The following guidelines apply:

  • The table_name and end_time arguments are required, while start_time is optional. 

  • This command can only be used for Event tables.

  • Omit the start_time if you are rolling off data.

  • Specify a start_time if you are attempting to delete a time-range of data in the middle of a data-set. 

  • Both timestamps must be in milliseconds (ms) of Epoch/Unix time, such as: 1487106411644

  • The default is dry-run mode. Use the --run or -r option to execute the command.

ia table delete-time-range [-h] [-v] [--unsafe] [--instance-name handle]
[--version] [--output {json,text,table}] [-y] [--keep-strings]
[--delete-import-records] [--im-feeling-lucky] [--run] table_name
[start_time] end_time

ia table delete-time-range
  Positional arguments  
  table_name Name given to the Event table.
  start_time The start time of the deletion is optional. If specified, strings are not deleted. Use epoch or Unix time. For a list of valid parameters, see the CLI ingest Quick Start.
  end_time The end time of the deletion is required. Use epoch or Unix time. For a list of valid parameters, see the CLI ingest Quick Start.
  Optional arguments  
  --delete-import-records Deletes all import records for this table.
  --im-feeling-lucky

Expedites data deletion by only deleting folders that are completely within the specified time range. This method typically deletes less data than may be desired, but is a good choice if you are simply rolling off old data.

  --instance-name <name> Name of the Interana cluster, in the event there are multiple configured clusters.
  --keep-strings Forces strings to be kept in the deletion process.
  -r, --run Executes the command. The default is dry-run mode.
  --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
  -v, --verbose Sets verbose mode, shows crash stack trace.
  --version Displays the version of Interana and Interana CLI currently installed.
  -h, --help Prints help for this command and then exits.

The precise delete-time-range takes longer to execute than the --im-feeling-lucky option, that deletes entire folders. The precise time-range deletion parses every folder to protect buckets that have events that fall outside the specified time range. 

The --im-feeling-lucky option is recommended for old data rolloff, as it provides faster response times.

ia table delete-time-range IAexample 1400106411644 -r
Time-range specified (IN UTC):
Start: Not specified, End: 2016-05-14 22:26:51
Note: You are doing a precise deletion, this might take up to an hour. Please do not close this prompt. To monitor the progress, tail the import -api-server logs on import -api node. # Waits 5 minutes.
Table # Folders Affected # Events Deleted String Delete Status Import Record Status
IAexample apporx. 48 4,042,839 Scheduled pruning of 2 string columns Unaffected
Table IAexample has completed time-range delete.

ia table export

Use ia table export export to export a table configuration to a file that includes columns and ingest jobs. The output config file is the same format as used by create --config-file. If you don't specify an --output-file, as is done in the following example, the file is saved in the current directory with the default name syntax, <table_name>_table_config.txt.

ia table export [-h] [-v] [--unsafe] [--instance-name handle] [--version]
[-o <output_file>]  table_name

ia table export      
  Positional arguments  
  table_name Name of dataset to export.
 

-o <output_file>

--output-file <output_file>

The file to which to write the configuration. If you don't specify the path for the file, it is saved in the current directory with the default name:   <table_name>_table_config.txt.
  Optional arguments  
  --instance-name <name> Name of the Interana cluster, in the event there are multiple configured clusters.
  --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
  -v, --verbose Sets verbose mode, shows crash stack trace.
  --version Displays the version of Interana and Interana CLI currently installed.
  -h, --help Prints help for this command and then exits.

You can clone an exported table by editing the table and ingest job names. You can also share table configurations by sharing configuration files, as shown in the following example.

ia table export import_stats

ia table import

Useia table import to upload files formatted in json-object-per-line style, each with a maximum size of 100MB. This command is optimized for uploading a small set of data (similar to the old add_to_fast_state script). The optional arguments aren't necessary, but could save some time.

If you are adding your first file or table to a cluster, it is recommended that you use the Import Wizard. To import larget amounts  of data, create a job that includes a pipeline.

When importing a single file with the CLI, the file will be saved as the full path with the period (.) removed. For example, ia table import test1 /home/ubuntu/datasets/fashion.json saves the fashion.json file as homeubuntudatasetsfashionjson.

ia table import [-h] [-v] [--unsafe] [--instance-name handle] [--version]
[--output {json,text,table}] [--delete-files] [--no-upload] [-f] 
table_name file_names [file_names ...]

ia table import    
  Positional arguments  
  table_name Name given to the table.
  file_names Files to be imported. Files are imported from the current directory, or from the Interana node if --no-upload is specified. You can specify multiple file names in a space-separated list.
  Optional arguments  
  --delete files Deletes the files from the Interana node after the data is imported, and disables --no-upload if you use 
--force on an upload with files that were previously deleted.
  -f, --force Forces re-ingesting files that have already been imported. Can be used with --no-upload.
  --instance-name <name> Name of the Interana cluster, in the event there are multiple configured clusters.
  --no-upload Imports previously uploaded files from disk instead of uploading from the local directory.
  --output {json,text,table} Set the output format. The default is table.
  --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
  -v, --verbose Sets verbose mode, shows crash stack trace.
  --version Displays the version of Interana and Interana CLI currently installed.
  -h, --help Prints help for this command and then exits.

ia table join

Use ia table join to join string columns. The default is to dry-run mode. Use the -r or --run option to execute the command. 

ia table join [-h] [-v] [--unsafe] [--instance-name handle] [--version] [--output {json,text,table}] [--run] event_table_name event_column_name lookup_table_name

The following guidelines apply:

  • Sharded lookup tables must be joined to event table shard keys.
  • When joining to a sharded lookup table, shard functions must match.
  • When joining to a sharded lookup table, shard layouts must match.
  • Event and lookup columns must have the same type.
  • Matching string_group_ids are required for joining string columns. If an event column already has data imported, the string_group_id cannot be changed. In such a case, delete all data from the event table and retry the join.
  •  Duplicate joins are not allowed.
ia table join    
  Positional arguments  
  event_table_name Sets the name of the event table to be joined with the lookup table.
  event_column_name Sets the name of the event column.
  lookup_table_name Sets the name of the looup_table to be joined with the event table.
  Optional arguments  
  --instance-name <name> Name of the Interana cluster, in the event there are multiple configured clusters.
  --output {json,text,table} Set the output format. The default is table.
  --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
  -v, --verbose Sets verbose mode, shows crash stack trace.
  --version Displays the version of Interana and Interana CLI currently installed.
  -h, --help Prints help for this command and then exits.

The following example shows a dry-run of a join of events2 and events_lookup on shard_key.

ia table join events2 shard_key events_lookup 

Join between events2 and events_lookup on shard_key can be added (dry run).

The following example shows a successful join of events4 and lookup_ns_string on shard_key.

ia table join events4 shard_key events_lookup_ns_string -r

Join between events4 and events_lookup_ns_string on shard_key was successful.

ia table list

Use ia table list to display a list of all your tables. You can choose to display a list of only event tables, only lookup tables, or all tables. Likewise you can specify the output format as json, text, or table. The default output format is table.

 

ia table list [-h] [-v] [--unsafe] [--instance-name handle] [--version] 
[--output {json,text,table}] [-t {event,lookup,all}]

ia table list    
  --instance-name <name> Name of the Interana cluster, in the event there are multiple configured clusters.
  --output {json,text,table} Sets the output format. The default is table.
 

-t {event,lookup,all}

--type {event,lookup,all}

Type of tables to be shown, event, lookup, or all. All tables are shown by default.
  --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
  -v, --verbose Sets verbose mode, shows crash stack trace.
  --version Displays the version of Interana and Interana CLI currently installed.
  -h, --help Prints help for this command and then exits.

ia table list-colocated-shard-key

Use ia table list-colocated-shard-key to view a list of all columns with colocated shard keys. 

ia table list-colocated-shard-keys [-help] [-v] [--unsafe] [--instance-name handle] [--version] [--output {json,text,table}] table_name

ia table list-colocated-shard-key
  table_name Name of the event table to which the colocated shard key is belongs.
  --instance-name <name> Name of the Interana cluster, in the event there are multiple configured clusters.
  --output {json,text,table}

Options for output display format:

  • json
  • text
  • table
  --unsafe Use this option when you do not have a valid cert installed.
  --version Displays the current installed version of Interana and the Interana CLI.
  -v, --verbose Displays verbose output for the command.
  -h, --help Displays help for this command.

ia table remove-colocated-shard-key

Use ia table remove-colated-shard-key to remove a colocated shard key. 

ia table remove-colocated-shard-key [-h] [-v] [--unsafe] 
[--instance-name handle] [--version] [--output {json,text,table}]  
table_name column_name

ia table remove-colocated-shard-key
  Positional arguments  
  table_name Name of the event table to which the colocated shard key is being added.
  column_name Name of the colocated column to be removed.
  Optional arguments  
  --instance-name <name> Name of the Interana cluster, in the event there are multiple configured clusters.
  --output {json,text,table}

Options for output display format:

  • json
  • text
  • table
  --unsafe Use this option when you do not have a valid cert installed.
  --version Displays the current installed version of Interana and the Interana CLI.
  -v, --verbose Displays verbose output for the command.
  -h, --help Displays help for this command.

ia table remove-shard-key

Use ia table remove-shard-key to remove a shard-key and delete the corresponding tablecopy data from a specified Event table (not applicable for Lookup tables). 

 

ia table remove-shard-key [-h] [-v] [--unsafe] [--instance-name handle] 
[--version] [--output {json,text,table}] [--run] table_name shard_key

ia table remove-shard-key
  Positional arguments  
  table_name Name of the table from which the shard key is to be removed.
  shard_key Name of the shard key to be removed.
  Optional arguments  
  --instance-name <name> Name of the Interana cluster, in the event there are multiple configured clusters.
  --output {json,text,table} Set the format. The default is table.
  -r,--run Executes the command. The default is dry-run mode. Use -r or --run to execute the command.
  --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
  -v, --verbose Sets verbose mode, shows crash stack trace.
  --version Displays the version of Interana and Interana CLI currently installed.
  -h, --help Prints help for this command and then exits.

 

Use ia table delete to delete a whole table. You are not allowed to remove the last remaining shard_key.

The following example is a dry-run of a command for deleting the lolz shard key from the fashion2 table. The results show that the shard key can be deleted when the command is executed with the --run option.

ia table remove-shard-key fashion2 lolz
table_name table_copy_id shard_key Result
fashion2 12 lolz Can be deleted.
This is a preview mode. Rerun with --run option for changes to take effect.

ia tier rebalance

Use ia tier rebalance to manage where data (events data, string data) is stored. You can this command in conjunction with ia node to manage the cluster as a whole. See How to resize a cluster for more in-depth information on managing clusters.

ia tier rebalance [-h] [-v] [--unsafe] [--instance-name handle] [--version]
[--output {json,text,table}] [-s | --exclude EXCLUDE] 
[--shard-layout-id SHARD_LAYOUT_ID] [--run] {data,string}

ia tier rebalance 
  Positional arguments  
  {data,string} Specifies the tier on which to operate.
  Optional arguments  
  --exclude <host>,<host> Specifies hosts (in a comma-separated list) to be excluded during a rebalance.
  --instance-name <name> Name of the Interana cluster, in the event there are multiple configured clusters.
  --output {json,text,table} Sets the output format. The default is table.
  -r, --run Executes the command. The default is dry-run mode.
  --shard-layout-id <shard_layout_id> Specifies the data shard layout on which to operate. This is only applicable for data-tier rebalancing.
  -s, --status Report the current status of any rebalance operations in progress. 
  --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
  -v, --verbose Sets verbose mode, shows crash stack trace.
  --version Displays the version of Interana and Interana CLI currently installed.
  -h, --help Prints help for this command and then exits.

ia tier stop-rebalance

Use ia tier stop-rebalance to hault a string tier rebalance that is in process. See How to resize a cluster for more in-depth information on rebalancing clusters.

ia tier stop-rebalance [-h] [-v] [--unsafe] [--instance-name handle] [--version] [--output {json,text,table}] {string}

Only applicable for string tier rebalance; a data tier rebalance cannot be haulted.

ia tier stop-rebalance 
  Positional arguments  
  {string} Specifies the string tier on which to operate.
  Optional arguments  
  --instance-name <name> Name of the Interana cluster, in the event there are multiple configured clusters.
  --output {json,text,table} Sets the format. The default is table.
  -r, --run Executes the command. The default is dry-run mode.
  --status Report the current status of any rebalance operations in progress. 
  --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
  -v, --verbose Sets verbose mode, shows crash stack trace.
  --version Displays the version of Interana and Interana CLI currently installed.
  -h, --help Prints help for this command and then exits.

ia user

Use ia user to create and manage Interana user accounts.

ia user create [-h] [-v] [--unsafe] [--instance-name handle] [--version]
[--output {json,text,table] [--base-url BASE_URL] [--no-email] 
[--role [ROLE [ROLE ...]]] username password

Click an argument to jump directly for more information.

ia user  
  create Creates a new user.
  disable Removes the ability for a user to log in to Interana and use Interana.
  enable Allows a new user to log in to their Interana account.
  list Displays registered Interana users. 
  update Add and remove roles to user accounts.

ia user create

Create a new user with login credentials. You must specify a username and password for each new account.

ia user create [-h] [-v] [--unsafe] [--instance-name handle] [--version]
[--output {json,text,table}] [--base-url BASE_URL] [--no-email] 
[--role [ROLE [ROLE ...]]] username password

For security purposes, the password used to create the account is visible in the bash history. For this reason, it's important to advise the user change their password when they initially log into their account.

ia user create   
  Positional arguments  
  username Email address of the new user account.
  password Sets the initial login password for a new user account. A password must be at least 8 characters in length.
  Optional arguments  
  --base-url <base_url> The --base-url is the hostname used in the link of the confirmation email a user must click to confirm their account. If not specified (and --no-email is not specified), the Base URL defaults to the API node's public IP address which may not be desirable. 
  --instance-name <name> Name of the Interana cluster, in the event there are multiple configured clusters.
  --no-email The --no-email option specifies that email confirmation is not required from the user to be able to login and use their account.
  --output {json,text,table} Sets the output format. The default is table.
  --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
  -v, --verbose Sets verbose mode, shows crash stack trace.
  --version Displays the version of Interana and Interana CLI currently installed.
  -h, --help Prints help for this command and then exits.
--base-url

If --base-url is not set, it defaults to the public IP of the first API node, which may not be user-friendly. For example, --base-url example.interana.com produces a confirmation URL similar to:
 https://example.interana.com/api/con...e=BLAHBLAHBLAH

If you are not using the --no-email option, it is strongly recommended that you set the --base-url

The following example creates user example@interana.com with an initial password of interanaRuleZ, and sets the --base-url to example.interana.com. Setting the the --base-url requires the user to confirm the account by clicking the email link before being allowed to use their account.

ia user create example@interana.com interanaRuleZ --base-url example.interana.com

User, example@ interana.com, successfully created.
--no-email

The following example creates user example@interana.com with an initial password of interanaRuleZ, and specifies that email confirmation is not required to be able to use the account.

ia user create example@interana.com interanaRuleZ --no-email

User, example@interana.com, successfully created. 

ia user disable

Use ia user disable to remove the ability for a user to log in and use Interana. 

 

ia user disable [-h] [-v] [--unsafe] [--instance-name handle] [--version]
[--output {json,text,table}] username

ia user disable    
  Positional argument  
  username Name of the user account to be disabled.
  Optional arguments  
  --instance-name <name> Name of the Interana cluster, in the event there are multiple configured clusters.
  --output {json,text,table} Set the output format. The default is table.
  --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
  -v, --verbose Sets verbose mode, shows crash stack trace.
  --version Displays the version of Interana and Interana CLI currently installed.
  -h, --help Prints help for this command and then exits.

If the user is already logged in, this command does not automatically log them out. However, any page they navigate to from that point on will give them an error.

The following example disables user example@interana.com.

ia user disable example@interana.com

Successfully disabled the user, example@interana.com.

ia user enable

Use ia user enable to allow a user to log in and work with Interana.

ia user enable [-h] [-v] [--unsafe] [--instance-name handle] [--version]
[--output {json,text,table}] username

ia user enable    
  Positional argument  
  username Name of the user account to be enabled.
  Optional arguments  
  --instance-name <name> Name of the Interana cluster, in the event there are multiple configured clusters.
  --output {json,text,table} Set the output format. The default is table.
  --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
  -v, --verbose Sets verbose mode, shows crash stack trace.
  --version Displays the version of Interana and Interana CLI currently installed.
  -h, --help Prints help for this command and then exits.

The following example allows the previously disabled user example@interana.com to log in and use Interana again.

ia user enable example.interana.com

Successfully enabled the user, example@interana.com.

ia user list

Use ia user list to display a list of users on an Interana instance. 

 

ia user list [-h] [-v] [--unsafe] [--instance-name handle] [--version] 
[--output {json,text,table}] [--include-disabled]

ia user list    
  Optional parameters  
  --include-disabled Displays disabled users. By default, disabled users do not appear in the list.
  --instance-name <name> Name of the Interana cluster, in the event there are multiple configured clusters.
  --output {json,text,table} Set the output format. The default is table.
  --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
  -v, --verbose Sets verbose mode, shows crash stack trace.
  --version Displays the version of Interana and Interana CLI currently installed.
  -h, --help Prints help for this command and then exits.

By default, disabled users do not appear in the list, as shown in the following example.

ia user list 
User ID Username Enabled Roles
376 example@interana.com 1 user
3 funnel@interana.com 1 admin,user
375 analyzer@interana.com 1 user
2 dashboard@interana.com 1 admin,user

Use the --include-disabled option to view disabled users, as shown in the following example. Disabled users are shown as 0 in the Enabled column.

ia user list --include-disabled
User ID Username Enabled Roles
376 example@interana.com 1 user
372 test1@interana.com 0 user
373 test2@interana.com 0 user
3 funnel@interana.com 1 admin,user
375 analyzer@interana.com 1 user
2 dashboard@interana.com 1 admin,user

ia user update

Use ia user update to add and remove user role assignments from specified users.

 

ia user update [-h] [-v] [--unsafe] [--instance-name handle] [--version]
[--output {json,text,table}] [--add-role ADD_ROLE]
[--remove-role REMOVE_ROLE] username

Interana supports the following user roles:

  • user — Log in and use Interana.
  • publisher — Perform Interana administrative tasks, along with the ability to publish named expressions.
  • admin — Manage and maintain Interana, including user accounts and data ingest. The majority of CLI commands require admin role.
ia user update    
  Positional argument  
  username Name of the user account to be updated.
  Optional arguments  
  --add-role <role> User role to be added.
  --remove-role <role> User role to be deleted.
  --instance-name <name> Name of the Interana cluster, in the event there are multiple configured clusters.
  --unsafe Use when there is not a valid certificate. To acquire a valid certificate, see How to replace a self-signed certificate.
  -v, --verbose Sets verbose mode, shows crash stack trace.
  --version Displays the version of Interana and Interana CLI currently installed.
  -help, --help Prints help for this command and then exits.

The following example adds the role of publisher to the dashboard@interana.com user.

ia user update dashboard@interana.com --add-role publisher

Successfully added dashboard@interana.com to publisher role.

The following example removes the role of admin from the funnel@interana.com user.

ia user update funnel@interana.com --remove-role admin

Successfully removed funnel@interana.com from admin role.

 

  • Was this article helpful?