Command Line Interface

backup

Backup Infoworks configuration (specify the target location of the config file using the -target <path-to-directory> option.)

build

Build entity (specify the entity using the -pipeline <pipeline-name> or -cube <cube-name> option)

workflow-execute

Execute an action on a workflow (Pass an action using -workflow-action, -workflow <name of the workflow> , -domain <name of the domain where the workflow is present>)

delete

Delete entity (specify the entity using the (–group <table-group-name> –source-for-group <source-name>), –source <source-name>, –pipeline <pipeline-name> or –cube <cube-name> option. To also purge the metadata, use the option –purge-metadata.)

ingest

Ingest table groups for a source (specify the source and group using the –source <source-name> –group <group-name> options. To only perform a certain type of ingestion, use the –ingest-type option.)

ingest-segment

Ingest table segment for a source (specify the source and segment group ID using the –source <source-name> –segment-group <segment-group-id> options.)

export

Export a table group or a pipeline target to an external database

list

List entities (specify the entity type using the –type <entity-type> option)

restore

Restore Infoworks configuration (specify the location of the config file using the –target <path-to-file> option)

status

List jobs in the job queue (running or blocked)

validate

Validate a license key for DF pro feature

reorganize-data

Reorganize table data for a source (specify the source using –source <source-name> –table <table-name> options.)

data-reconciliation

Reconcile table group data for a source (specify the source using –source <source-name> –source-for-group <group-name> options.)

get-auth-token

Get authentication token for an Infoworks user (specify the username using –username <iw-username> –password <iw-password> options.)

-h, -help

Show this help message and exit.

-debug

Toggle debug output

-quiet

Suppress all output

-u <username>, –username <username>

Username of Infoworks user

-p <password>, –password <password>

Password of Infoworks user

-at <auth_token>, –auth-token <auth_token>

Authentication Token (generated using iw-keygen).

-t <sources,domains,pipelines,cubes,groups>, –type <sources,domains,pipelines,cubes,groups>

Type of entities

-it <cdc,merge,truncate-reload,cdc-merge,switch,all>, –ingest-type <cdc,merge,truncate-reload,cdc-merge,switch,all>

Type of ingestion

-s <source_name>, –source <source_name>

Name of the source

-dom <domain>, –domain <domain>

Name of the domain

-pl <pipeline>, –pipeline <pipeline>

Name of the pipeline

-wa, –workflow-action [run|pause|resume|cancel|restart|get-metrics]

Choose one of the actions from the list to apply it on the workflow

-c <cube>, –cube <cube>

Name of the cube

-tb <table name>, –table <table name>

Name of the table

-g <table_group>, –group <table_group>

Name of the table group

-sg <segment_group_id>, –segment-group <segment_group_id>

Table segment group id

-sfg <source_name_for_table_group>, –source-for-group <source_name_for_table_group>

Source name for table group

-lkey <license_key>, –license-key <license_key>

License key validator for DF Pro

-j <job_id>, –jobid <job_id>

IW job id

-tgt <target>, –target <target>

Target directory where the mongo backup should be stored

-pm, -purge-metadata

Delete the metadata of the entity

-hu, -humanize

Return a human readable output