editKeyLabelMapping CLI command

Edit online

Use the editKeyLabelMapping command to edit a key label mapping. First, run the viewKeyLabelMapping command to obtain the index number of a specific key label mapping.

Syntax

editKeyLabelMapping <index>,<keyLabelFrom>,<keyModeFrom>,<keyLabelTo> -ssl

Parameters

<index>

(Required.) The index number of a key label mapping. Run the viewKeyLabelMapping command to obtain the index number.

<keyLabelFrom>

(Required.) A text string; maximum 50 characters. It cannot be repeated in the list of key labels.

<keyModeFrom>

(Required.) A parameter with the following possible values:

  • Wrapped-Hash
  • Wrapped-Default (Specifying this value for <keyModeFrom> disables <keyLabelTo>, so it is not necessary to specify a value for <keyLabelTo>.)
  • Wrapped-Clear
  • Direct-Default-Set
  • Direct-Specific
<keyLabelTo>

(Required.) A text string; maximum 50 characters.

-ssl
Required if SSL (HTTPS) is enabled.

Example command

editKeyLabelMapping 1,START,Wrapped-Hash,END
This example edits the key label mapping for index 1. The revised mapping is from the key label START to the key label END, and the wrapped-hash key mode is used.

Example output

The Key Label Mapping was edited successfully