Administrator Guide

10.5
- 10.4.1
- 10.4.0

Back Next

Data Integration Hub Security Keytool Command Line API Command Syntax

Data Integration Hub
Security Keytool Command Line API Command Syntax

The

Data Integration Hub

Security Keytool Command Line API uses the following syntax:

dx-keytool
<-c|--command> rollKey|rollPassphrases|rollConfig|testConfig
<-u|--user> userID
<-p|--password> password
[--server "<hostname:port>"]
[-old_ksp|--oldKeystorePassphrase <current keystore passphrase>]
[-old_kp|--oldKeyPassphrase  <current key passphrase>]
[-ksp|--keystorePassphrase <keystore passphrase>]
[-kp|--keyPassphrase <key passphrase>]
[--keygenPassphrase <keygen passphrase>]
[-sp|--securityProvider <Java Security Provider>]  
[-kst|--keystoreType <keystore type>]
[-cp|--cipherProvider <cipher provider>
[-ksl|--keystoreLocation <keystore location>]
[-kl|--keyLength <key length>]

The command line API is in the following location:

DIH

InstallationDir>/dx-tools

To run the command use the following syntax:

On a Windows operating system:

dx-keytool.bat -c <command> -u <user> -p <password> <additional options as applicable>

On a UNIX operating system:

dx-keytool.sh -c <command> -u <user> -p <password> <additional options as applicable>

The following table describes the

Data Integration Hub

Security Keytool command line API options and arguments:

Option	Argument	Description
-c --command	command	Required. Command to run. Enter one of following commands: rollKey. Rolls the master key. rollPassphrases. Rolls the keystore passphrase and key passphrase. rollConfig. Rolls the configuration. generateKey. Generates a master key. testConfig. Tests the current security configuration.
-u --user	user ID	Optional. User ID of User ID of a Data Integration Hub Administrator user account. If you use Informatica domain authentication or Informatica domain with Kerberos authentication, the user ID must specify the Informatica security domain, separated by the @ symbol. For example: Administrator@SecurityDomain
-U	environment variable	Optional. Environment variable that contains the value of userID. User ID of a Data Integration Hub Administrator user account. If you use Informatica domain authentication or Informatica domain with Kerberos authentication, the user name must specify the Informatica security domain, separated by the @ symbol. For example: Administrator@SecurityDomain You must specify at least one of the user ID options, -u or -U.
-p --password	password	Optional. Password of the Data Integration Hub Administrator user account. Enter a clear text password.
-P	environment variable	Optional. Environment variable that contains the value of password. Password of the Data Integration Hub Administrator user account. The password that you specify as a value of this environment variable must be encrypted. You must specify at least one of the password options, -p or -P.
--server	hostname:port	Optional. Host name and port number of the Data Integration Hub server. If you do not enter a value, the API connects to the localhost server with the default port 18095. You must enclose the value in quotation marks. For example: dx-keytool --server "localhost:18095"
-old_ksp --oldKeystorePassphrase	current keystore passphrase in commands where -ksp is used for the new keystore password	Required for the rollPassphrases command. Optional for all other commands. Current passphrase to access the keystore. By default: default .
-old_kp -- oldKeyPassphrase	current key passphrase in commands where -kp is used for the new key password	Required for the rollPassphrases command. Optional for all other commands. Current passphrase to access the encryption key. By default: default
-ksp --keystorePassphrase	keystore passphrase	Required for the rollPassphrases and rollKey commands. Optional for all other commands. Passphrase to access the keystore. By default: default
-kp --keyPassphrase	key passphrase	Required for the rollPassphrases and rollKey commands. Optional for all other commands. Passphrase to use to access the encryption key. By default: default
--keygenPassphrase	key generator passphrase	Required for the rollKey command. Optional for all other commands. New passphrase to use to generate the master key.
-sp --securityProvider	security provider	Required for the rollKey command when you change the security provider. Optional for all other commands. Java security provider. The following conditions must exist before you run the command: The provider must exist in the Java security configuration. For details, see https://docs.oracle.com/cd/E19830-01/819-4712/ablsc/index.html. A custom provider JAR file must be part of the DX server classpath.
-kst --keystoreType	keystore type	Required for the rollConfig command when you change the keystore type. Optional for all other commands. Keystore type. The name of the keystore type must be compatible with the security provider that you want to use.
-cp --cipherProvider	cipher provider	Required for the rollConfig command when you change the cipher provider. Optional for all other commands. Cipher provider. The provider must exist in the Java security configuration.
-ksl --keystoreLocation	keystore location	Optional. Keystore location.
-kl --keyLength	key length	Optional. Can be used with the rollKey command. Key length in bits. Supported values: 128, 192, 256 Default value: 128

Rename Saved Search

Table of Contents

Administrator Guide

Administrator Guide

Data Integration Hub Security Keytool Command Line API Command Syntax

Data Integration Hub Security Keytool Command Line API Command Syntax

Data Integration Hub
Security Keytool Command Line API Command Syntax