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.

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]

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

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

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

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

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

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>

ia data list-delete-jobs

You can display a list of all selective data deletion jobs with the ia data list-delete-jobs command, along with information on each job.

ia data list-delete-jobs

  Job ID  Start time    End time        Filters                                                                            Status    Create Time              Update Time
--------  -----------   ------------  -------------------------------------------------------------------------------     ---------  -----------------------  -----------------------      
       1    ---           ---          [{"column": "model", "table": "query_usage", "values": [9], "column_id": 2}]         Done     2017/12/14 05:08:01 UTC  2017/12/14 10:33:20 UTC
       2    ---           ---          [{"column": "model", "table": "query_usage", "values": [9], "column_id": 2}]         Done     2017/12/14 05:12:18 UTC  2017/12/14 10:33:20 UTC
       3    ---           ---          [{"column": "model", "table": "query_usage", "values": [9], "column_id": 2}]         Done     2017/12/14 05:14:38 UTC  2017/12/14 10:33:20 UTC
       4    ---           ---          [{"column": "model", "table": "query_usage", "values": [9], "column_id": 2}]         Done     2017/12/14 05:16:10 UTC  2017/12/14 10:33:20 UTC
       5    ---           ---          [{"column": "model", "table": "query_usage", "values": [9], "column_id": 2}]         Done     2017/12/14 05:17:33 UTC  2017/12/14 10:33:20 UTC     

You create a selective data deletion job with the ia data create-delete-job command that references a config file. The following table lists the command arguments.

A selective data deletion job uses the details of a specified config file. 

If you are unsure about how to structure a config file for a selective delete job, you can view an example config file with the following command.

ia data create-delete-job --example-config

-------- Sample Data Delete Create Config --------

{
    "table_name": "music",
    "start_time": 0,
    "end_time": 1510016107744,
    "filters": {
        "user_id": ["eccbc87e-cfcd2084-45c48cce-45c48cce", "66e7dff9-28308fd9-66e7dff9-ea1afc51"],
        "anonymous_id": ["6505913639713474836", "8143414483406512381"]
    }
}

NOTE: Filters are AND'd together, meaning an event will only be deleted if user_id is one of
["eccbc87e-cfcd2084-45c48cce-45c48cce", "66e7dff9-28308fd9-66e7dff9-ea1afc51"] AND anonymous_id is
one of ["6505913639713474836", "8143414483406512381"].

To create a selective delete job, use the following command: 

ia data create-delete-job [path/to/config_file]

ia data preview-delete-job

You can use the ia data preview-delete-job command to view how many events match the filters specified by a selective data deletion config file. The query is sampled by default, and returns a close approximation of the event count.

For an unsampled query that returns an exact event count, use the --exact option with the ia data preview-delete-jobcommand.

You can use this command to see how many events would be deleted using the config file. Results with no matching events is a confirmation of the successful completion of the job associated with the config file.

ia data preview-delete-job [path/to/config_file]

ia data run-delete-job

You can use the ia data run-delete-job command to do the following:

• Show the INACTIVE jobs waiting to be scheduled for deletion.
• Use the --run option to mark all INACTIVE jobs as ACTIVE, thereby scheduling the jobs for deletion.

Selective data deletion jobs are INACTIVE by default. You must use the --run option to set the jobs to ACTIVE.

To show a list of INACTIVE selective delete jobs, use the following command: 

ia data run-delete-jobs

Currently inactive job IDs: 3. Use -r/--run to activate them.

To mark all INACTIVE selective delete jobs as ACTIVE, use the following command: 

ia data run-delete-jobs --run

ia data interrupt-delete-jobs

Use the ia data interrupt-delete-jobs stops all active delete jobs.

ia data reactivate-interrupted-jobs

Use the ia data reactivate-interrupted-jobs command to mark interrupted jobs as active. You can specify particular jobs to be reactivated. If no specific jobs are specified, then all interrupted jobs will be reactivated. Jobs must have an INTERRUPTED status to be reactivated..

ia data remove-delete-job

Use the ia data remove-delete-job command to remove a data deletion job associated with the specified job ID.

ia data remove-delete-job <job_ID>

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

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

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}]

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

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

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.

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

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

ia job pause 1 2 3

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

ia job resume --table import_stats

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

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.

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

The following example displays all jobs.

ia job list

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

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

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.

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. 

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

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.

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

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.

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

ia pipeline create --config-file <config_file_path>

{
   "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"]
   ]
}

ia pipeline create --config-file import_stats_pipeline_configs.txt

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

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]

Example:

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

ia pipeline list --table 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

Example:

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

ia pipeline show music-azure-pipeline

ia pipeline update

You can update a pipeline in the following ways:

• with the CLI
• with a config file

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

ia pipeline update --config-file <config_file_path>

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

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

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 configDB. For a list of available settings that can be added and modified, see the ConfigDB reference.

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

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

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

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 event <table_name> <time_column> <time_column_format>  
[-s <shard_key> <shard_key_type>] [--shards-per-node <shards per data node>]

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

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

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

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.

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

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. 

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

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.

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

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

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

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

User, example@ interana.com, successfully created.

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

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

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]

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

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

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.