jks-credentialstore Command

The stagelib-cli jks-credentialstore command provides subcommands to add, list, and delete secrets in the Java keystore credential store.

Any changes made to the Java keystore file take effect immediately. For example, if you change the value of an existing secret in the file, running pipelines that require a new connection to the external system use the updated secret.

Note: In previous releases, the jks-cs command provided the same subcommands to add, list, and delete secrets in the Java keystore credential store. However, the jks-cs command is now deprecated and will be removed in a future release.

You can use the following subcommands with the

stagelib-cli
                jks-credentialstore

command:

add

Adds a secret to the Java keystore credential store.

Use the command from the $SDC_DISTData Collector installation directory as follows:

bin/streamsets stagelib-cli jks-credentialstore add \
(-i <cstore ID> | --id <cstore ID>) \
(-n <secret name> | --name <secret name>) \
(-c <secret value> | --credential <secret value>)


Add Option	Description
-i <cstore ID> or --id <cstore ID>	Required. Unique ID for the credential store. The default ID for a Java keystore is `jks`.
-n <secret name> or --name <secret name>	Required. Name of the secret to add to the Java keystore credential store. If the name includes non-alphanumeric characters, use single quotation marks around the name.
-c <secret value> or --credential <secret value>	Required. Value to add to the Java keystore credential store. If the value includes non-alphanumeric characters, use single quotation marks around the value.

For example, the following command adds a secret named OracleDBPassword with the value df35yT_&5 to the devjks Java keystore credential store:

bin/streamsets stagelib-cli jks-credentialstore add -i devjks -n OracleDBPassword -c 'df35yT_&5'

delete

Deletes a secret from the Java keystore credential store.

Use the command from the $SDC_DISTData Collector installation directory as follows:

bin/streamsets stagelib-cli jks-credentialstore delete \
(-i <cstore ID> | --id <cstore ID>) \
(-n <secret name> | --name <secret name>)


Delete Option	Description
-i <cstore ID> or --id <cstore ID>	Required. Unique ID for the credential store. The default ID for a Java keystore is `jks`.
-n <secret name> or --name <secret name>	Required. Name of the secret to delete from the Java keystore credential store. If the name includes non-alphanumeric characters, use single quotation marks around the name.

For example, the following command deletes a secret named SQLServerDBPassword from the devjks Java keystore credential store:

bin/streamsets stagelib-cli jks-credentialstore delete -i devjks -n SQLServerDBPassword

list

Lists the names of all secrets defined in the Java keystore credential store. The command does not list the values.

Use the command from the $SDC_DISTData Collector installation directory as follows:

bin/streamsets stagelib-cli jks-credentialstore list \
(-i <cstore ID> | --id <cstore ID>)


List Option	Description
-i <cstore ID> or --id <cstore ID>	Required. Unique ID for the credential store. The default ID for a Java keystore is `jks`.

For example, the following command lists the names of all secrets defined in the devjks Java keystore credential store:

bin/streamsets stagelib-cli jks-credentialstore list -i devjks