This reference section lists all arguments available for import, removal, and task management modes. Use it as a quick lookup for command syntax.

Arguments that can be specified for the import and remove modes are listed in the table below.

NOTE: Forget mode doesn’t use any additional arguments.

Argument(s)

Details

Help

-h

OR

--help

Displays a help message with general usage information for the importer application, including a summary of all available arguments and their purpose.

Server & Authentication

-s [server and port]

OR

--server [server and port]

Specifies the server and port for POST requests to iManage Threat Manager. Port 8090 is used for data in most deployments.

NOTE: This corresponds to the URL, IP address, or hostname you use to access your iManage Threat Manager appliance.

(On-premises) The connection can use either HTTP or HTTPS, depending on server configuration.

(On-premises) If the Threat Manager server uses a self-signed SSL certificate, you must provide the certificate file so the importer can validate the secure connection. (For more information, refer to the entry for --certificate file path/to/.pem in this table.) This isn’t required when using a certificate from a trusted authority.

--token TOKEN

Specifies the application token to authenticate with iManage Threat Manager. Optional if the token was stored during initial setup.

--secret

Specifies the application secret for authentication. Not required if a stored token is available from the optional initial setup step.

(On-premises) --certificate file path/to/.pem

OR

(On-premises) -c file path/to/.pem

Specifies the path to an SSL certificate file. If not provided and SSL is enabled, iManage Threat Manager uses the certificate in the operating system’s certificate store.

(On-premises) --disable-ssl

Disables SSL (enabled by default). Overrides any previously specified certificate path.

File Inputs

-f path/to/.csv --file path/to/.csv

OR

-f path/to/.sql --file path/to/.sql

Specifies the path to the CSV or SQL file(s) used to generate POST requests. Wildcards are supported to process multiple files (for example, path/to/*.csv).

-e OR
--encrypted-password

Indicates that the SQL connection string in the input data source file contains an encrypted database password generated using the encrypt-password mode. When this option is specified, the importer decrypts the password locally before connecting to the database. This argument applies only in SQL mode for import or remove operations.

Logging

-l file.log

OR

--logfile file.log

Specifies a custom log file name. If not provided, the importer uses the default format logging-<date>. Logs rotate daily.

Import/Remove Behavior Modifiers

-b [number of rows] 

OR

--batch [number of rows] 

Specifies how many rows from the CSV or SQL file should be batched into a single request. The default is 1000. There's no maximum limit. It is generally recommended not to increase the batch size on slow network connections.

--remove-properties [PROP1 PROP2 PROP3]

Specifies the metadata fields to remove from iManage Threat Manager users listed in the input data file or returned by the SQL query. This option is supported in remove mode only. Fields with spaces must be enclosed in quotation marks (for example, “Practice Area”).

--task-identifier

Adds a task identifier in import mode, or removes the task identifier when used in remove mode.