Fortinet white logo
Fortinet white logo

CLI Reference

execute nethsm

execute nethsm

nethsm

This topic includes the following commands:

execute nethsm primus clear-pkcs-provider-log

Clear logs from /var/log/pkcs11.log, generated by pkcs11.so, the OpenSSL provider.

execute nethsm primus clear-pkcs-provider-log

execute nethsm primus clear-primus-log

Clear logs from /var/log/primus.log, generated by libprimusP11.so.

execute nethsm primus clear-primus-log

execute nethsm primus delete-object

Delete Hardware Security Module object(s).

execute nethsm primus delete-object <label>

Parameter

Description

Type

Size

<label>

Label of the HSM object(s) to delete.

string

execute nethsm primus dump-pkcs-provider-log

Dump logs from /var/log/pkcs11.log, generated by pkcs11.so, the OpenSSL provider.

execute nethsm primus dump-pkcs-provider-log

execute nethsm primus dump-primus-log

Dump logs from /var/log/primus.log, generated by libprimusP11.so.

execute nethsm primus dump-primus-log

execute nethsm primus inspect-primus-library-info

Display information about the integrated libprimusP11.so library.

execute nethsm primus inspect-primus-library-info

execute nethsm primus list-objects

List Hardware Security Module objects.

execute nethsm primus list-objects

execute nethsm primus upload-primus-cfg

Upload nethsm primus.cfg file.

execute nethsm primus upload-primus-cfg <filename> <tftp server>

Parameter

Description

Type

Size

<filename>

File name on the TFTP server.

string

<tftp server>

TFTP server IP or FQDN.

string

execute nethsm primus upload-primus-cfg-raw

Upload nethsm primus.cfg file.

execute nethsm primus upload-primus-cfg-raw <filename> <tftp server>

Parameter

Description

Type

Size

<filename>

File name on the TFTP server.

string

<tftp server>

TFTP server IP or FQDN.

string

execute nethsm safenet clear-log

Clear NETHSM log.

execute nethsm safenet clear-log

execute nethsm safenet client-cert-create

(Re)Create client certificate.

execute nethsm safenet client-cert-create <string>

Parameter

Description

Type

Size

<string>

Country name (e.g. Canada) or country code (e.g. ca).

string

execute nethsm safenet client-cert-export ftp

Export client certificate over FTP

execute nethsm safenet client-cert-export ftp <ftp server>[:ftp port] <remote-path> <Enter>|<user> <passwd>

Parameter

Description

Type

Size

<ftp server>[:ftp port]

FTP server IP, can be attached with port.

string

<remote-path>

FTP remote directory.

string

<Enter>|<user>

FTP username may be needed.

string

<passwd>

FTP password.

string

execute nethsm safenet client-cert-export tftp

Export client certificate over TFTP

execute nethsm safenet client-cert-export tftp <ip>

Parameter

Description

Type

Size

<ip>

IP address of TFTP server.

string

execute nethsm safenet client-cert-show

Display client certificate

execute nethsm safenet client-cert-show

execute nethsm safenet config-export ftp

Import nethsm config from a FTP server.

execute nethsm safenet config-export ftp <ip>[:ftp port] <remote-path> <Enter>|<user> <passwd>

Parameter

Description

Type

Size

<ip>[:ftp port]

FTP server IP, can also include port.

string

<remote-path>

FTP remote directory.

string

<Enter>|<user>

FTP username may be needed.

string

<passwd>

FTP password.

string

execute nethsm safenet config-export tftp

Export nethsm config over TFTP

execute nethsm safenet config-export tftp <ip>

Parameter

Description

Type

Size

<ip>

IP address of TFTP server.

string

execute nethsm safenet config-import ftp

Export nethsm config over FTP

execute nethsm safenet config-import ftp <string> <ftp server>[:ftp port] <Enter>|<user> <passwd>

Parameter

Description

Type

Size

<string>

File name on the FTP server.

string

<ftp server>[:ftp port]

FTP server IP, can also include port.

string

<Enter>|<user>

FTP username may be needed.

string

<passwd>

FTP password.

string

execute nethsm safenet config-import tftp

Import nethsm config from a TFTP server.

execute nethsm safenet config-import tftp <string> <ip>

Parameter

Description

Type

Size

<string>

File name on the TFTP server.

string

<ip>

IP address of TFTP server.

string

execute nethsm safenet config-show

Display nethsm config

execute nethsm safenet config-show

execute nethsm safenet diagnose

Partition diagnose.

execute nethsm safenet diagnose

execute nethsm safenet hagroup-add

Add HA group.

execute nethsm safenet hagroup-add <hagroup>

Parameter

Description

Type

Size

<hagroup>

HSM HA group name.

string

execute nethsm safenet hagroup-del

Delete HA group.

execute nethsm safenet hagroup-del <hagroup>

Parameter

Description

Type

Size

<hagroup>

HSM HA group name.

string

execute nethsm safenet hagroup-list

List HA group.

execute nethsm safenet hagroup-list <hagroup>

Parameter

Description

Type

Size

<hagroup>

HSM HA group name.

string

execute nethsm safenet register

Register to network HSM server.

execute nethsm safenet register <server>

Parameter

Description

Type

Size

<server>

HSM server name.

string

execute nethsm safenet reset

Erase all NETHSM config.

execute nethsm safenet reset

execute nethsm safenet restore-conf

Restore NETHSM config.

execute nethsm safenet restore-conf

execute nethsm safenet set-conf-opt

Set NETHSM config option.

execute nethsm safenet set-conf-opt

execute nethsm safenet show-log

Show NETHSM log.

execute nethsm safenet show-log

execute nethsm safenet status

Client status.

execute nethsm safenet status <server>

Parameter

Description

Type

Size

<server>

HSM server name.

string

execute nethsm safenet unregister

Unregister from network HSM server.

execute nethsm safenet unregister <server>

Parameter

Description

Type

Size

<server>

HSM server name.

string

execute nethsm

execute nethsm

nethsm

This topic includes the following commands:

execute nethsm primus clear-pkcs-provider-log

Clear logs from /var/log/pkcs11.log, generated by pkcs11.so, the OpenSSL provider.

execute nethsm primus clear-pkcs-provider-log

execute nethsm primus clear-primus-log

Clear logs from /var/log/primus.log, generated by libprimusP11.so.

execute nethsm primus clear-primus-log

execute nethsm primus delete-object

Delete Hardware Security Module object(s).

execute nethsm primus delete-object <label>

Parameter

Description

Type

Size

<label>

Label of the HSM object(s) to delete.

string

execute nethsm primus dump-pkcs-provider-log

Dump logs from /var/log/pkcs11.log, generated by pkcs11.so, the OpenSSL provider.

execute nethsm primus dump-pkcs-provider-log

execute nethsm primus dump-primus-log

Dump logs from /var/log/primus.log, generated by libprimusP11.so.

execute nethsm primus dump-primus-log

execute nethsm primus inspect-primus-library-info

Display information about the integrated libprimusP11.so library.

execute nethsm primus inspect-primus-library-info

execute nethsm primus list-objects

List Hardware Security Module objects.

execute nethsm primus list-objects

execute nethsm primus upload-primus-cfg

Upload nethsm primus.cfg file.

execute nethsm primus upload-primus-cfg <filename> <tftp server>

Parameter

Description

Type

Size

<filename>

File name on the TFTP server.

string

<tftp server>

TFTP server IP or FQDN.

string

execute nethsm primus upload-primus-cfg-raw

Upload nethsm primus.cfg file.

execute nethsm primus upload-primus-cfg-raw <filename> <tftp server>

Parameter

Description

Type

Size

<filename>

File name on the TFTP server.

string

<tftp server>

TFTP server IP or FQDN.

string

execute nethsm safenet clear-log

Clear NETHSM log.

execute nethsm safenet clear-log

execute nethsm safenet client-cert-create

(Re)Create client certificate.

execute nethsm safenet client-cert-create <string>

Parameter

Description

Type

Size

<string>

Country name (e.g. Canada) or country code (e.g. ca).

string

execute nethsm safenet client-cert-export ftp

Export client certificate over FTP

execute nethsm safenet client-cert-export ftp <ftp server>[:ftp port] <remote-path> <Enter>|<user> <passwd>

Parameter

Description

Type

Size

<ftp server>[:ftp port]

FTP server IP, can be attached with port.

string

<remote-path>

FTP remote directory.

string

<Enter>|<user>

FTP username may be needed.

string

<passwd>

FTP password.

string

execute nethsm safenet client-cert-export tftp

Export client certificate over TFTP

execute nethsm safenet client-cert-export tftp <ip>

Parameter

Description

Type

Size

<ip>

IP address of TFTP server.

string

execute nethsm safenet client-cert-show

Display client certificate

execute nethsm safenet client-cert-show

execute nethsm safenet config-export ftp

Import nethsm config from a FTP server.

execute nethsm safenet config-export ftp <ip>[:ftp port] <remote-path> <Enter>|<user> <passwd>

Parameter

Description

Type

Size

<ip>[:ftp port]

FTP server IP, can also include port.

string

<remote-path>

FTP remote directory.

string

<Enter>|<user>

FTP username may be needed.

string

<passwd>

FTP password.

string

execute nethsm safenet config-export tftp

Export nethsm config over TFTP

execute nethsm safenet config-export tftp <ip>

Parameter

Description

Type

Size

<ip>

IP address of TFTP server.

string

execute nethsm safenet config-import ftp

Export nethsm config over FTP

execute nethsm safenet config-import ftp <string> <ftp server>[:ftp port] <Enter>|<user> <passwd>

Parameter

Description

Type

Size

<string>

File name on the FTP server.

string

<ftp server>[:ftp port]

FTP server IP, can also include port.

string

<Enter>|<user>

FTP username may be needed.

string

<passwd>

FTP password.

string

execute nethsm safenet config-import tftp

Import nethsm config from a TFTP server.

execute nethsm safenet config-import tftp <string> <ip>

Parameter

Description

Type

Size

<string>

File name on the TFTP server.

string

<ip>

IP address of TFTP server.

string

execute nethsm safenet config-show

Display nethsm config

execute nethsm safenet config-show

execute nethsm safenet diagnose

Partition diagnose.

execute nethsm safenet diagnose

execute nethsm safenet hagroup-add

Add HA group.

execute nethsm safenet hagroup-add <hagroup>

Parameter

Description

Type

Size

<hagroup>

HSM HA group name.

string

execute nethsm safenet hagroup-del

Delete HA group.

execute nethsm safenet hagroup-del <hagroup>

Parameter

Description

Type

Size

<hagroup>

HSM HA group name.

string

execute nethsm safenet hagroup-list

List HA group.

execute nethsm safenet hagroup-list <hagroup>

Parameter

Description

Type

Size

<hagroup>

HSM HA group name.

string

execute nethsm safenet register

Register to network HSM server.

execute nethsm safenet register <server>

Parameter

Description

Type

Size

<server>

HSM server name.

string

execute nethsm safenet reset

Erase all NETHSM config.

execute nethsm safenet reset

execute nethsm safenet restore-conf

Restore NETHSM config.

execute nethsm safenet restore-conf

execute nethsm safenet set-conf-opt

Set NETHSM config option.

execute nethsm safenet set-conf-opt

execute nethsm safenet show-log

Show NETHSM log.

execute nethsm safenet show-log

execute nethsm safenet status

Client status.

execute nethsm safenet status <server>

Parameter

Description

Type

Size

<server>

HSM server name.

string

execute nethsm safenet unregister

Unregister from network HSM server.

execute nethsm safenet unregister <server>

Parameter

Description

Type

Size

<server>

HSM server name.

string