dialog
Synopsis
netid.exe -dialog [about] [activate] [error <arguments>] [message <arguments>] [question <arguments>] [notify <arguments>] [enterpin <arguments>] [changepin <arguments>] [unlockpin <arguments>] [viewtoken <arguments>] [inserttoken <arguments>] [exitwindows <arguments>] [select <arguments>] [custom <arguments>]
Description
All internal dialogs can be activated from the command line. The meaning of each dialog should be easy to understand based on the naming.
Options
- about
-
Show an information dialog about the current client installation.
- activate
-
Show the active license dialog.
- error
-
Show an error dialog. To specify the content of the dialog, use the arguments:
-
text
-
For more information, see list of arguments.
- message
-
Show a message dialog. To specify the content of the dialog, use the arguments:
-
text
-
For more information, see list of arguments.
- question
-
Show a question dialog. To specify the content of the dialog, use the arguments:
-
text
-
For more information, see list of arguments.
- notify
-
Show a notify dialog. To specify the content of the dialog, use the arguments:
-
image
-
title
-
text
-
ok, or
-
cancel.
-
For more information, see list of arguments.
- enterpin
-
Show an enter PIN dialog for a specific token. To specify the token, use the arguments:
-
number and
-
index
-
certificate, or
-
thumbprint.
-
-
For more information, see list of arguments.
- changepin
-
Show a change pin dialog for a specific token. To specify the token, use the arguments:
-
number and
-
index
-
certificate, or
-
thumbprint.
-
-
For more information, see list of arguments.
- unlockpin
-
Show a unlock pin dialog for a specific token. To specify the token, use the arguments:
-
number and
-
index
-
certificate, or
-
thumbprint.
-
-
For more information, see list of arguments.
- viewtoken
-
Show a token information dialog. To specify the token, use the arguments:
-
slotid
-
slot, or
-
number.
-
For more information, see list of arguments.
- inserttoken
-
Show a token insertion dialog. To specify the token, use the arguments:
-
slotid
-
slot, or
-
number.
-
For more information, see list of arguments.
- exitwindows
-
Show the exit windows dialog. See exitwindows below for more information.
- select
-
Show a certificate selection dialog. To limit the available certificates, use the arguments:
-
match
-
mode
-
signature
-
authentication, or
-
first.
-
- custom
-
Show a custom dialog. Use argument type to specify name of the custom dialog. A custom dialog is added to configuration which will allow for customization of appearance, such as size. See Dialog for more information.
Arguments
enterpin, changepin, unlockpin
All dialogs that uses token or certificate use the same arguments.
The certificate is identified with the thumbprint of the certificate. Both thumbprint and certificate are acceptable as options, but only thumbprint as parameter value:
-thumbprint <thumbprint> -certificate <thumbprint>
viewtoken, inserttoken
If a certificate is found, the corresponding token is used. If certificate is missing, you can instead search for the token using the slotid, slot, or token number. Also use index to specify a specific PIN.
-slotid <slot ID> -slot <slot-name> -index <pin-index> -number <token-number> -index <pin-index>
- -index <pin-index>
-
-
0 = PIN1 (default)
-
1 = PIN2
-
2 = PIN3
-
etc.
-
error, message, question, notify
The error, message, and question dialogs can only use the text argument. But the notify dialog can use all arguments below to customize the appearance.
-native -image <name> -title <text> -text <text> -ok <text> -cancel <text> -size <size>
- native
-
Use native message dialog instead of web GUI. Applies only to the error, message, and question dialog on Windows.
- image
-
The available image names will depend on the current GUI package since the name is sent to GUI and translated to a specific image. For example,
error
,information
, andquestion
. - title, text
-
The title and text argument can be any strings. The strings are translated using the internal string table. For example,
{string:1234}
will use the string with ID 1234 from the string table for the current language. It is also possible to use variables.{subject:2.5.4.3}
is translated to subject common-name for the specified certificate and requires that certificate or thumbprint argument is specified. See Variables for a full list of available variables. - ok, cancel
-
The ok and cancel arguments are any strings that are shown on the OK and Cancel button.
- size
-
The size, 0xXXXXYYYY, of the dialog box. XXXX for width, YYYY for height. If both values are 100 or less the values are treated as percentage of the screen width and height. For example, 50 % of the screen, 0x00320032.
When you see the dialog, you can start an action based on the result:
-action <name> -action-ok <name> -action-cancel <name> -action-yes <name> -action-no <name>
exitwindows
The exitwindows dialog has options to control the behavior.
Synopsis
netid.exe -dialog exitwindows [-actions <action-list>] [-default <action>] [-timeout <seconds>] [-nocancel] [-force] [-active]
Options
- -actions <action-list>
-
List of action names separated with comma (
,
). For a full list of actions, see exitwindows . - -default <action>
-
Name of action that is used as default action.
- -timeout <seconds>
-
Number of seconds until default action will be used.
- -nocancel
-
Removes the possibility to cancel the dialog.
- -force
-
Tells Windows that the command should be enforced.
- -active
-
Makes the dialog visible only when logged on with the Net iD Client credentials.
netid.exe -dialog exitwindows -actions none,lock,logout -active