25. CLI Command Reference¶

This chapter lists all the commands in alphabetical order. For each command there is a short description and reference to sections where the command is discussed in more detail.

addadmin

With this command a web/scan administrator can be created. The command expects a user name and a password separated by a colon (see section Creating a web administrator (scan administrator)).

certdownload

With this command a key and a CA signed certificate can be copied to the GSM (see section Certificate by an external certificate authority).

commit

Not yet activated changes can be confirmed (see section Configuring settings).

ethtool

The command ethtool displays the current status of the network adapters including link status (see section Monitoring and debugging of network functions).

exit

Log out of the command line.

feedstartsync

Starts the feedsynchronization from the command line (see section Feed Synchronization).

feedsyncstatus

This controls whether at this moment a synchronization is performed (see section Feed Synchronization).

feedversion

This command displays the current version. It shows the date and time, i.e. 201502090646 is 6:46 am on February 9th, 2015 (see section Feed Synchronization).

gbfw

This is a frontend for the local Greenbone firewall and only meant for experts.

getip

This command displays the current IP configuration (see section Monitoring and debugging of network functions).

getroute

This command displays the current IP routing configuration (see section Monitoring and debugging of network functions).

getusers

This command displays the currently in the command line logged in users.

gos-admin-menu

This command starts the GOS-Admin-Menu (see section Base configuration).

gsmuser

This is an alternate command for the user management.

ip

This command displays various information about the network configuration (see section Monitoring and debugging of network functions).

ldapcacertdownload

This command allows to save the certificate of the LDAP server on the GSM (see section LDAP with SSL/TLS).

masterkeydownload

Saves the master key on a slave (see chapter Master and Slave Setup).

ntpq

This command displays the time synchronization of the system with external sources (see section Network Time Protocol).

passwd

This allows a user to change their password from the command line (see section Admin password change).

ps

Displays the currently running processes. To see all processes use ps ef.

reboot

Initiate the reboot of the appliance from the command line (see section Reboot and shutdown of the appliance).

rollback

Discard the changes before a commit (see section Configuring settings).

shell

After logging in as admin you will work in a restricted shell. With this command you can run a complete UNIX shell from the command line.

show

This command displays individual files or a schedule (see section Activation key).

shutdown

Initiate the shutdown of the appliance from the command line (see section Reboot and shutdown of the appliance).

softwarestartsync

Start of the synchronization of system upgrades (see section Upgrade).

softwaresyncstatus

Check the status of the synchronization of system upgrades (see section Upgrade).

softwareversion

Display the current software version (see section Upgrade).

sslcatkey

This command displays the certificate signing request for a certificate to be signed (see section Certificate by an external certificate authority).

sslcatreq

This command, like sslcatkey, displays the certificate signing request for a certificate to be signed (see section Certificate by an external certificate authority).

sslcatself

This command displays the self-signed certificate created by the GSM (see section Self-signed certificates).

sslcheck

This command checks the certificate chain of certificates which were issued by a trust center (see section Certificate by an external certificate authority).

ssldownload

With this command the CA signed certificate resulting from a certificate signing request can be copied to the GSM (see section Certificate by an external certificate authority and sslreq).

sslreq

Initiate the creation of a certificate signing request (see section Certificate by an external certificate authority).

sslselfsign

Initiate the creation of a self-signed certificate by the GSM (see section Self-signed certificates).

subscriptiondownload

Download the activation key to the GSM (see section Activation key).

systembackup

Start a backup of the system (see section Backup and Restore).

systembackupstatus

Display the status of a backup of the system (see section Backup and Restore).

systemfeedbackup

Start the backup of the feed (see section Backup and Restore).

systemfeedbackupstatus

Display the status of a backup of the feed (see section Backup and Restore).

systemrecoverybackup

Perform a restore (see section Backup and Restore).

systemrecoverybackupstatus

Display the status of a restore (see section Backup and Restore).

systemrecoverysnapshot

Perform a restore of a snapshot (see section Snapshot of the System).

systemrecoverysnapshotstatus

Display the status of a restore of a snapshot (see section Snapshot of the System).

systemsnapshot

Create a system snapshot (see section Snapshot of the System).

systemsnapshotstatus

Display the status of a system snapshot (see section Snapshot of the System).

systemupgrade

Start an upgrade (see section Upgrade).

systemupgradestatus

Display the status of an upgrade (see section Upgrade).

systemuserdatabackup

Perform the backup of user data (see section Backup of User Data via USB-Stick).

systemuserdatabackupstatus

Display the status of the backup of user data (see section Backup of User Data via USB-Stick).