set-token-prop

Syntax

tadm set-token-prop common_options --config=config_name --token=name ([--set-password] | (property_name=property_value)*)

Description

Use this command to enable or disable the SSL tokens for the server. You can also use this command to save the token pin in the server.xml file, which will facilitate unsupervised server startup.

Options

For information about common_options, run the help command.

--config|-c: Specify the name of the configuration to set the token properties.

--token|-t: Specify the name of the PKCS #11 token that contains the certificates.

--set-password|-r: If you specify this option, it can only be saved in server.xml file if there is already a (Personal Identification Number) PIN set on the token.

To reset a property to its default value, do not provide a property value.
For example, property-name=<empty_string>

Operands

property-name=property-value

Specify name=value pairs for one or more properties that you want to define. The name=value pairs should be separated by spaces.

You can set the following token property:

enabled: Specifies whether the server initializes this token, prompting for a personal identification number (PIN) if necessary.
Values: true, false. Default: true.

Example

tadm set-token-prop --user=admin --password-file=../admin.pwd 
--host=admin.example.com --port=8989 --config=www.example.org --token=internal  enabled=true

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.