Service
Services are applications that work with REST API to communicate with and manipulate information for external elements like a PC connected through a network. The Service tab contains actions you may perform with the services you are using.
To perform a command:
1.Select which service you want to communicate with (NTLS, STC, etc.), or click the Services drop-down menu to send more general commands and settings.
2.Click on a command button to initiate its corresponding resource.
If the query is successful, you will see your request history and output in the Request and Response windows respectively.
If you are unsuccessful, the Response window text will turn red and return an error.
Figure 1: Service Tab
For example, if you want to restart a service on your partition:
1.Select the Services tab.
2.Click Restart. A dialog box will appear.
3.Populate the prompt in the dialog box with the service you wish to stop and click submit.
The tables below list each command button you see on the Service tab in the client. Each command has a short description of what it does as well as its corresponding resource. The resources can be input into the Custom IO tab manually if you become very familiar with them.
NOTE There are some commands that are not included as buttons on the client. They must be input manually in the Custom IO tab. A complete repository of resources you can query with REST API can be found in the REST API Command Reference documentation.
The Service tab's drop-down menus are organized by service.
NTLS
NTLS, or Network Trust Link Service, guarantees a secure connection when transferring data over a network. It encrypts your data and uses two-way digital certificate authentication to protect sensitive information so that you can ensure security in your proprietary communications.
The table below defines each command available under the NTLS menu and lists its corresponding resource.
| Command | Function | Resource |
|---|---|---|
| List Clients | Lists all NTLS clients registered with the appliance. | GET /api/lunasa/ntls/clients |
| Register Client | Registers a client with the appliance. | POST /api/lunasa/ntls/clients |
| Assign Partition | Registers a client with a partition on the HSM. | POST /api/lunasa/ntls/clients/{clientid}/partitions |
| Delete Client | Deletes a specified client from the appliance. | DELETE /api/lunasa/ntls/clients/{clientid} |
| Get Server Cert | Gets the server-side certificate used by NTLS to establish connections with clients. | GET /api/lunasa/ntls/certificate |
STC
STC, or Secure Trusted Channel, guarantees privacy and security in user-HSM communications. STC uses encryption, message authentication codes, and mutual endpoint authentication to ensure that only those authorized to use the connection can do so, and that your messages remain safely protected.
The table below defines each command available under the STC menu and lists its corresponding resource.
| Command | Function | Resource |
|---|---|---|
| Register STC Client | Registers a client identity for secure trusted communication with a partition. | POST /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/stc/clients |
| List STC Client | Lists all client identities associated with the secure trusted channel for the specified partition. | GET /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/stc/clients |
| Export Partition | Exports specified partition's public key to a file. | GET /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/stc |
Services
The Services menu sets general preferences for your use of any or all services with REST API.
The table below defines each command available under the Services menu and lists its corresponding resource.
| Command | Function | Resource |
|---|---|---|
| List Services | Lists all services associated with the appliance. | GET /api/lunasa/services |
| Get Service | Gets specific information on the specified service. | GET /api/lunasa/services/{serviceid} |
| Set onBoot | Sets specified service to be running on startup. | PATCH /api/lunasa/services/{serviceid} |
| Start | Starts named service. | POST /api/lunasa/services/{serviceid}/actions/start |
| Stop | Stops named service. | POST /api/lunasa/services/{serviceid}/actions/stop |
| Restart | Restarts named service. | POST /api/lunasa/services/{serviceid}/actions/restart |
Network
The Network tab manages all your network devices and your connectivity to them.
The table below defines each command available under the Network menu and lists its corresponding resource.
| Command | Function | GET /api/lunasa/network |
|---|---|---|
| Network Info | Gets the network information associated with the appliance. | GET /api/lunasa/network |
| Put on Network | Sets all base network configurations associated with the appliance. | GET /api/lunasa/network/devices |
| List Devices | Lists all network devices. | GET /api/lunasa/network/devices/{deviceid} |
| Get Device | Gets information on the specified network device. | GET /api/lunasa/network/devices/{deviceid}/ip4 |
| Get Device IP4 | Gets IP4 information on the specified network device. | PUT /api/lunasa/network/devices/{deviceid}/ip4 |
| Change Device | Changes network device in use. | POST /api/lunasa/network/actions/ping |
| Ping | Tests network connectivity to specified host. | GET /api/lunasa/network |
| DNS Info | Gets the DNS information associated with the network. | GET /api/lunasa/network/dns/nameServers |
| List Name Servers | Lists currently registered name servers. | POST /api/lunasa/network/dns/nameServers |
| Create Name Server | Creates a new name server. | GET /api/lunasa/network/dns/nameServers/{nameServerid} |
| Get Name Server | Gets information on specified name server. | DELETE /api/lunasa/network/dns/nameServers/{nameServerid} |
| Delete Name Server | Deletes name server entry. | GET /api/lunasa/network/dns/searchDomains |
| List Search Domain | Lists currently registered search domains. | POST /api/lunasa/network/dns/searchDomains |
| Create Search Domain | Creates a new search domain. | GET /api/lunasa/network/dns/searchDomains/{searchDomainid} |
| Get Search Domain | Gets information on specified search domain. | DELETE /api/lunasa/network/dns/searchDomains/{searchDomainid} |
| Delete Search Domain | Deletes search domain entry. | GET /api/lunasa/network/dns/nameServers |
NTP
NTP, or Network Time Protocol, provides connections to extremely accurate servers of time data so that your appliance can be correctly synchronized. All devices can undergo gradual time drifts, and it is important to use NTP to correct these for applications to run smoothly.
The table below defines each command available under the NTP menu and lists its corresponding resource.
| Command | Function | Resource |
|---|---|---|
| Get NTP | Gets NTP configuration information. | GET /api/lunasa/ntp |
| List Servers | Lists current server resources. | GET /api/lunasa/ntp/servers |
| Add Server | Adds an NTP server. | POST /api/lunasa/ntp/servers |
| Delete Server | Deletes all NTP server entries. | DELETE /api/lunasa/ntp/servers/{serverid} |
| Server Info | Gets information on specified server. | GET /api/lunasa/ntp/servers/{serverid} |
| Get Status | Returns information on ntp time, max error, estimated error, and offset. | GET /api/lunasa/ntp/status |
| Synchronize | Synchronizes date and time with NTP. | POST /api/lunasa/ntp/actions/synchronize |
SNMP
SNMP, or Simple Network Management Protocol, monitors a local HSM for changes in certain conditions that may cause problems for users. Traps can be put in place to respond to certain condition changes and notify the appropriate personnel of errors in functioning.
The table below defines each command available under the SNMP menu and lists its corresponding resource.
| Command | Function | Resource |
|---|---|---|
| Get SNMP | Gets SNMP configuration information. | GET /api/lunasa/snmp |
| Trap Info | Gets SNMP trap configuration information. | GET /api/lunasa/snmp/trap |
| Configure Trap | Configures specified SNMP trap parameters. | PUT /api/lunasa/snmp/trap |
| Delete Trap | Clears SNMP configuration. | DELETE /api/lunasa/snmp/trap |
| List Users | Lists SNMP users. | GET /api/lunasa/snmp/users |
| Create User | Creates an SNMP user. | POST /api/lunasa/snmp/users |
| User Info | Gets configuration information of specified user. | GET /api/lunasa/snmp/users/{userid} |
| Delete User | Deletes user. | DELETE /api/lunasa/snmp/users/{userid} |
| List Notifications | Lists SNMP notifications for specified user. | GET /api/lunasa/snmp/users/{userid}/notifications |
| Create Notification | Creates an SMP user notification. | POST /api/lunasa/snmp/users/{userid}/notifications |
| Notification Info | Gets configuration information for specified notification. | GET /api/lunasa/snmp/users/{userid}/notifications/{notificationid} |
| Delete Notification | Deletes specified notification. | DELETE /api/lunasa/snmp/users/{userid}/notifications/{notificationid} |
Syslog
The table below defines each command available under the Syslog menu and lists its corresponding resource.
| Command | Function | Resource |
|---|---|---|
| List Backups | Lists stored syslog backups. | GET /api/lunasa/syslog/backups |
| Create Backup | Creates a syslog backup. | POST /api/lunasa/syslog/backups |
| Get Backup | Retrieves a syslog backup and deletes it after. | GET /api/lunasa/syslog/backups/{backupid} |
| Delete Backup | Deletes specified syslog backup. | DELETE /api/lunasa/syslog/backups/{backupid} |
| List Remote Hosts | Lists configured remote hosts. | GET /api/lunasa/syslog/remoteHosts |
| Create Remote Host | Creates a remote host entry. | POST /api/lunasa/syslog/remoteHosts |
| Remote Host Info | Gets information on specified remote host. | GET /api/lunasa/syslog/remoteHosts/{remoteHostid} |
