Page Comparison

setSecureProperty

This action sets or overwrites a secure property in the key store.
If a property name already exists, you are prompted to confirm that you wish to overwrite the value.
Use --replace to skip the confirmation prompt.

Example: Set Secure Property

$ acli system -a setSecureProperty --name my-jira.token --secret
Enter secure properties password: <password prompt>
Value for key 'my-jira.token' set in secure properties file.

clearSecureProperties

This action clears the entire secure properties key store file.
To ensure that a value is not accidentally removed, you are prompted for confirmation.
If you add the --force parameter, the secure property file is removed without confirmation.
To complete the action, you are prompted to insert the key store password.
If you have forgotten the password, you must manually delete the key store file in your home directory.

Example: Clear all secure properties

$ acli system -a clearSecureProperties
Enter secure properties password: <password prompt>
Enter CONFIRM to permanently clear all secure properties (CANNOT be undone): CONFIRM
Secure properties cleared.

getSecureProperty

This action only retrieves a secure property from the key store.
To retrieve the property value, use:

--outputFormat 2.

Example: Get Secure Property

$ acli system -a getSecureProperty --name my-jira.token
Enter secure properties password: <password prompt>
Secure property 'foo' exists in the secure properties file.

Example: Get Secure Property with value

$ acli system -a getSecureProperty --name foo --outputFormat 2
Enter secure properties password: <password prompt>
Value of secure property 'my-jira.token': <your token value>

importSecureProperties

This action allows you to import secure properties from another key store file to your default key store.
To do so, you need the password for both the source and destination key stores.
OPTIONS

• Use the --replace parameter to avoid being asked to confirm overwriting properties during import.

• Use the --include and --exclude parameters to filter the properties being imported.

Note that each of the imported properties, take a regular expression value that is evaluated against the list of keys in the source key store.

This can be useful for sharing selected secure properties, just ensure to not store or transmit the password with the data!

Example: Import secure properties

$ acli system -a importSecureProperties -f import.keystore
Enter secure properties password: <destination password prompt>
Enter inbound secure properties password: <source password prompt>
Imported 0 secure properties.
Ignored: buz,foo. Use --replace to overwrite existing values.

Example: Import select secure properties (via inclusion) with overwrite

$ acli system -a importSecureProperties -f import.keystore --include '(?i)^F' --replace
Enter secure properties password: <destination password prompt>
Enter inbound secure properties password: <source password prompt>
Imported 1 secure property: foo.

removeSecureProperty

This action removes a secure property from the key store.
To ensure that a value is not accidentally removed, you are prompted for confirmation.

If you add the --force parameter, the secure property is removed without confirmation.

If after this operation the key store is empty, it is automatically removed.

Example: Remove a secure property

$ acli system -a removeSecureProperty --name my-jira.token
Enter secure properties password: <password prompt>
Enter CONFIRM to permanently remove the secure property 'my-jira.token': CONFIRM
Removed value for key 'my-jira.token' from secure properties file.
Deleted empty keystore file.

exportSecureProperties

This action allows you to export secure properties from your default key store to another key store file.
To do so, you need the password for both the source and destination key stores.

OPTIONS

• Use the --replace parameter to avoid being asked to confirm overwriting properties during export.

• Use the --include and --exclude parameters to filter the properties being exported.

Note that each of the exported properties, take a regular expression value that is evaluated against the list of keys in the source key store.

Example: Export select secure properties (via exclusion) with overwrite

$ acli system -a exportSecureProperties -f export.keystore --exclude '(?i)^F' --replace
Enter secure properties password: <source password prompt>
Enter outbound secure properties password: <destination password prompt>
Exported 1 secure property: buz.

getSecurePropertyList

This action only returns all secure properties from the key store.
To retrieve the list of property valuevalues, use:

--outputFormat 2.

Example

Get secure property list with values

$ acli system -a getSecurePropertyList --outputFormat 2
Enter secure properties password:
2 secure properties in list
"Name","Value"
"buz","qux"
"foo","foo"

Locating your Secure Properties key store

Your key store is normally located in your home directory and is named .acli.keystore. ACLI will display the file path as part of the detailed getClientInfo output (if it exists).

Example

Display key store file path

$ acli -a getClientInfo --outputFormat 2
Client information

Client name . . . . . . . . . : cli
Client version  . . . . . . . : 11.0.0
...
Secure properties . . . . . . :
  File  . . . . . . . . . . . : /Users/me/.acli.keystore