| importsslfipskey |
Use this method to imports a FIPS key into the Hardware Security Module (HSM) of the FIPS card. Can import an existing FIPS key, or can import, as a FIPS key, an external private key, such as a key that was created on an Apache or IIS external Web server. |
Syntax |
Parameters |
fipskeyname |
Name for the FIPS key to be imported. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after the FIPS key is created.
The following requirement applies only to the Citrix ADC CLI:
If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my fipskey" or 'my fipskey'). This is mandatory parameter. |
key |
Name of and, optionally, path to the key file to be imported.
/nsconfig/ssl/ is the default path. This is mandatory parameter. |
inform |
Input format of the key file. Available formats are:
SIM - Secure Information Management; select when importing a FIPS key. If the external FIPS key is encrypted, first decrypt it, and then import it.
PEM - Privacy Enhanced Mail; select when importing a non-FIPS key.
Default value = FORMAT_SIM. |
wrapkeyname |
Name of the wrap key to use for importing the key. Required for importing a non-FIPS key. |
iv |
Initialization Vector (IV) to use for importing the key. Required for importing a non-FIPS key. |
exponent |
Exponent value for the FIPS key to be created. Available values function as follows:
3=3 (hexadecimal)
F4=10001 (hexadecimal) Default value = 3. |
Return Value |
Returns simpleResult |
See Also |