Home > |
Network HSM Installation/Configuration Guide > PSESH Command Reference
|
---|
This chapter describes how to access and use the PSESH shell command line tool to configure your SafeNet ProtectServer Network HSM appliances.
The commands are presented alphabetically and provide:
•a brief description of the command function
•the command syntax and parameter descriptions
•usage examples.
The top-level commands are as follows:
Command |
Description |
---|---|
exit |
Exit the PSESH shell. See exit. |
files |
Manage the files that have been transferred to the appliance’s SCP directory. See files. |
help |
Display syntax help for the specified command. You can use the ? symbol instead of the string help as an alternative way of displaying the help. See help. |
hsm |
Display the current state of the HSM, or reset the HSM if it becomes unresponsive. See hsm |
network |
View or configure the network settings for the SafeNet ProtectServer Network HSM appliance. See network. |
package |
Manage the software packages installed on the appliance. See package. |
service |
Manage the services on the appliance. See service. |
status |
Display the current status of the appliance. See status. |
sysconf |
Configure the appliance time, date, or SNMP settings, or reboot or power-off the appliance. See sysconf. |
syslog |
Display or archive the syslog. See syslog |
user |
Set or change the password of the current user. See user password. |
The PSESH shell command line tool provides access to the SafeNet ProtectServer Network HSM shell for performing basic appliance configuration tasks such as network configuration and appliance software package updates and management.
PSESH commands are not case sensitive.
Access to PSESH is via SSH or the local console.
PSESH supports the following users:
User |
Description |
---|---|
pseoperator |
The pseoperator user is responsible for configuring the appliance for client access. The pseoperator user is able to execute the PSESH commands used to configure the appliance network parameters such as IP addresses, iptables, and routes etc., as well as appliance settings such as the date/time, SNMP configuration, etc. |
admin |
The admin user is responsible for managing the appliance. The admin user is able to execute all of the PSESH commands available to the pseoperator, as well as commands used to perform package upgrades/installations, troubleshooting, viewing log files, and extracting log files. The admin user is also able to reset the password for the pseoperator user. |
PSESH provides the following features:
Feature |
Description |
---|---|
Command history |
You can scroll through the commands you have entered on the PSESH command line using the up/down arrows keys. |
Command shortcuts |
You must type sufficient letters of a command or sub-command to make the input unique in the current syntax. For example, you could invoke system syntax help with help, hel, he, but not just h (because there is also an hsm command and typing just "h" is not sufficient to indicate whether you want help or hsm). |
Command completion |
You can use the TAB key to automatically complete partially typed commands. This allows you to type only enough characters to uniquely identify the command, and then press TAB to automatically fill in the rest of the characters for the command. |
Command syntax help |
To display help information for a command, type help <command_name>, or ? <command_name>. |
You can access PSESH by connecting a keyboard and monitor to the appliance, using a serial connection, or using an SSH client (such as puTTY in Windows or the ssh command in Linux) after the network settings have been configured.
1.Connect to the appliance (monitor and keyboard, serial connection, or SSH)
When a successful connection is made, a terminal window opens and the prompt login as: appears.
You can log in as admin or pseoperator:
–pseoperator – The pseoperator user is responsible for configuring/preparing the HSM for client access by configuring network parameters such as the IP addresses, iptables, routes etc., as well as device’s date/time, snmp settings, etc.
–admin – In addition to the pseoperator commands, admin user will be responsible for package upgrades/installs. admin will also be able to reset pseoperator password and run commands for troubleshooting and viewing and extracting log files.
2.You are prompted for the password. If this is the first time you have connected, the default password is password. You will be prompted to enter a new password.
Once you have logged in, the system presents the PSESH prompt, which includes the hostname that you have assigned to the appliance:
[myPSE] psesh:>
Note: After three failed remote login attempts, the account will be locked out for 10 minutes.
You can now issue any PSESH command. For a summary, type ? or help and press Enter.