Home >

Utilities Reference Guide > VTL > VTL Overview

VTL Overview

VTL stands for "Virtual Token Library", and is a command-line utility that is loaded onto each of your Client computers when you install the SafeNet Software.

Open a command prompt window or console, cd to the directory where you installed your SafeNet software, and run the vtl command (with the -h option, to see the available sub-commands).

These are the commands that you use to manage the relationship between your Client computer and one or more SafeNet appliances.  You must have Administrator privileges on your own computer (the computer that you are using as a client to the SafeNet Network HSM). If you do not also have authority on the SafeNet device(s), then you need the co-operation of the person who holds that authority.

root@mycomputer:~>vtl
usage: (select command -h for additional information)

Note:  Just as you need to be root or Administrator (or a user with equivalent privileges) when installing, you need to be root or Administrator (or equivalent) when running vtl commands that need to access /etc and /user (and the equivalents in Windows). LHSM-29892

Subcommands

Subcommand Description
addServer
Use this command to add a server to the client's list of trusted SafeNet Network HSM Servers (you need to have already imported the server certificate from each SafeNet Network HSM that you wish to add). See vtl addServer .
deleteServer
Use this command to remove a server/host from the client's list of trusted SafeNet Network HSM Servers. See vtl deleteServer .
replaceServer
Use this command to replace a named server/host from the client's list of trusted SafeNet Network HSM Servers with a new named server/host - requires the original server's name [-o], the replacing server's name [-n], and the path to the new server's certificate file [-c]. See vtl replaceserver.
listServers
   Use this command to display a list of the SafeNet Network HSM Servers trusted by this client. See vtl listServers .
createCert
    Use this command to create (or re-create) the client's certificate and private key that are used for NTLS (Network Trust Link Service). See vtl createCert .
listSlots

List all PKCS#11 cryptographic device slots that can be seen at this time. See vtl listSlots .
verify
Use this command to verify the SafeNet Network HSM Servers slots or partitions that are visible. See vtl verify .
haAdmin

Use these commands to create and manage HA groups of several SafeNet Network HSM appliances, providing load-sharing and redundancy for the cryptographic operations required by this client. See vtl haAdmin
fingerprint
Use this command to display the fingerprint of a specified certificate. See vtl fingerprint .
examineCert       Use this command to display the details of a specified certificate. See vtl examineCert .  
backup Administer backup/backup HSM features - used for Remote Backup (where the backup HSM is connected to a computer remote from your SafeNet Network HSM. If you connect the SafeNet Backup HSM directly to your SafeNet Network HSM, then use the SafeNet Shell command line and "token backup" commands, instead of VTL. See vtl backup.
supportInfo
Use this command to create a support information file, when one is requested by SafeNet Customer Support. See vtl supportInfo .
logging Configure logging for Windows computers. See vtl logging configure .