Parameters
Parameters
Parameters tell the CLI the specific details needed to perform an action. Some actions work without any additional details, but most require one or more parameters and accept additional optional parameters to perform the task.
The CLI requires at least one special parameter named action that tells what action to perform, without the action parameter, CLI displays help with some example actions. Parameters do not have prefixes like actions and are often specific to the app for the action.
For example, the action getServerInfo requires details about the app or server from where the information is retrieved. To obtain the required information, the server parameter is used.
The getServerInfo action also accepts optional parameters such as outputFormat, dateFormat, file, append, and encoding.
| --accending |
|
| Order history in date accending order (earliest first). | |
| --acceptType |
|
| Content type to accept for renderRequest if different than contentType. | |
| --access |
|
| Channel access setting. Valid values are: public, private | |
| --action | a |
| Requested operation to perform. Valid actions are listed separately. | |
| --afterSql |
|
| SQL to run after a successful action. Limited to specific actions at this time. | |
| --append |
|
| For some actions using the file parameter, append will append output to an existing file. | |
| --autoCorrect |
|
| Automatically correct and trim values that exceed Slack length limits or contain invalid characters. | |
| --autoSplit |
|
| Automatically attempt to split message text that exceed Slack's maximum message length. Message text with lines within the length limit qualify for auto splitting. | |
| --autoWait |
|
| Deprecated. Rate limit handling is now done by default. Slack limits the rate of requests it will handle in a period of time. Use this switch to automatically handle rate limit failures and retry. The action may take a few minutes to complete. Do not use this switch in performance critical contexts like Jira post functions or Confluence renderings. | |
| --channel |
|
| Channel name or id. | |
| --clearFileBeforeAppend |
|
| For run actions, this option will automatically clear an existing file on the first append requested. | |
| --columns |
|
| Column selection and ordering when action generates CSV output. A comma separated list of column numbers (1-based) or column names (case insensitive). Only columns provided by the selected outputFormat are available for selection. Invalid columns will be ignored. | |
| --comment |
|
| Comment text. | |
| --common |
|
| Common parameter string added to all actions in the run script. | |
| --connectionTimeout |
|
| Allow overriding environment settings for connect and read timeouts on URL connections. In milliseconds, 0 means infinite. | |
| --content |
| true | Content for sendMessage. Either plain text or block JSON. First content is added before file content and any other content is added after file content. | |
| --contentType |
|
| Content type for post data for a web request. Any suitable value can be specified. We have defines some special values for commonly used types: JSON, HTML, XML, URL_ENCODED, FORM_URL_ENCODED. | |
| --continue |
|
| Continue processing even after errors are encountered for run actions. Also used for some action to ignore certain errors like not found errors on remove actions and already exists errors on add actions. | |
| --cookies |
|
| Name of file to restore and persist cookies across invocations of ACLI actions. | |
| --data |
|
| JSON data for runFromJson. Post data for renderRequest. Action specific definition in some cases. | |
| --database |
|
| Database name or reference to a ACLI configuration entry when proceeded with an @ symbol. When referencing a configuration entry, the entry should contain appropriate parameters for for defining access to the database including url and, when necessary, dbUser and dbPassword authentication parameters. | |
| --dateFormat |
|
| Format string for dates in Java SimpleDateFormat. Default for output is client date format. Default for date parsing is lenient starting with client date format and then some other standard formats based on JSON date format. | |
| --dateFormat2 |
|
| Alternate format string for dates in Java SimpleDateFormat. Use specific (may be ignored), but normally used for date only fields to avoid longer dateFormat based output. Some uses default to yyyy-MM-dd. | |
| --dbCreateTable |
|
| Automatically create the database table before adding rows. | |
| --dbJar |
|
| ACLI has built-in support for Postgres and by default loads database drivers found in the ACLI installation's lib/jdbc directory. Otherwise you can specify a specific file or URL reference for the database driver jar. Examples /jdbcDrivers/postgresql-42.4.2.jar or https://jdbc.postgresql.org/download/postgresql-42.4.2.jar. | |
| --dbPassword |
|
| Database user password. Defaults to password. | |
| --dbTable |
|
| Database table name when creating or updating a database from list output. | |
| --dbTableKeys |
|
| Comma separated list of column names used to access existing rows for update. Normally this defines a primary key set for the table. ACLI automatically defaults unique keys specific for the action. | |
| --dbUser |
|
| Database user name. Defaults to the same as the user parameter. | |
| --debug |
|
| Requests detail debug output especially useful for Support. Optional for all actions. Recommend first using verbose logging for problem determination. |