system - Manage the operating system


[1] system [soft [check] | role | hard | machine | architecture | cpu | memory | disk | raid | serial | uuid | end]

[2] system patch (aload | (ftp | sftp | tftp) <file-server> <file-name>)

[3] system backup [(create [report] | clear)]

[4] system backup [(save | load) (ftp | sftp | tftp) <file-server> <file-name>]

[5] system report [load | memory | disk | raid | link | gateway | connection | service | vpnipsec | antivirus | counter [web | rweb | firewall | guard | antivirus | avserver | waf] [raz]]


The first usage form displays information about the actual system. In this usage form the optional arguments are as follows:

* soft: software OS (Operating System) name and version. If the optional check keyword is specified, the system checks for available updates.

* role: the system role (can be Gateway or Manager).

* hard: this is a string consisting of fields that gives the appliance model configured during its installation. Details are as follows:

• OS|VE|WH: (OS installation, VE: Virtual Edition, HW: Hardware),

• US<number>: number of USers in forwarding mode,

• GR<number>: GuaRd blacklist records number,

• RU<number>: number of Userse in Revers mode,

• RW<number>: number of Reverse Websites,

• RC<number>: Reverse Cache size in MB,

• LR<number>: Logs Rotation period,

• UL<number>: maximum size for UpLoaded files in MB,

• PC<number>: Persistent Cache (0:off, 1:on),

• WL<number>: persistent Web access logging (0:off, 1:on),

• RL<number>: persistent rWeb access logging (0:off, 1:on).

* machine: machine manufacturer and product name.

* architecture: the installed CPU architecture (32 or 64 bits).

* cpu: CPU information.

* memory: total RAM capacity.

* disk: disks information.

* raid: RAID configuration.

* serial: the serial number.

* uuid: the appliance Universally Unique IDentifier.

* end: subscription period end of the system.

Please note that your appliance should be connected to the internet and have access to registration services (HTTP/HTTPS) in order to allow its subscription renewal.

The second usage form allows you to load an OS patch from a file server or automatically from an official Web server. To automatically download a patch from an official Web server use the keyword aload. If you want to explicitly download from a file, only trusted file servers are allowed. Trusted file servers are defined with the command access. The explicit download form requires three mandatory arguments. The first argument is the protocol name (ftp, tftp or sftp). The second argument is the name or IP address of the file server. The third argument is the patch file name. The apply command must be used to apply a loaded patch. Note that some patches require a system reboot. In this case the system is automatically rebooted.

The third and fourth usage forms allow you to make a full system backup and restore. A system backup contains all necessary files to restore a crashed system on a new machine. Note that a system backup should only be restored on a freshly installed OS. Compared to a saved configuration (see the command conf), a system backup includes not only the logical configuration but also all data uploaded to the system like the antivirus signatures, URL lists, SSL certificates or custom WAF rules. Note that cached objects and archived logs are not part of the backup.

It is important to note that the OS version and tuning parameters (chosen during the installation) in the backup should be the same as the OS version and tuning parameters chosen for the new machine. In addition the CPU architecture and number of network interface devices on the new machine should be identical to the machine on which the backup has been made. Otherwise the restore operation can fail. As a restoration operation may fail for various reasons, it is highly recommended to test and validate backups prior to rely on them.

CAUTION: as the S/N of a registered appliance is bound to the MAC address of its first NIC (eth0), the first NIC of the new machine should have the same MAC address as the crashed machine. If changing a MAC address on the new machine is not an option, please contact our support services.

Without any argument, the system backup command displays the last system backup date and time. A system backup should be first created prior to save it on a file server. To create a system backup, use the keyword create. This will launch the system backup operation in background. Depending on your configuration, a system backup could take between 10 seconds and several minutes. The optional keyword report allows you to display the last system backup report. To delete a previously created or loaded system backup use the keyword clear.

A system backup can only be save on a trusted file servers. Trusted file servers are defined with the command access. The save usage form requires three mandatory arguments. The first argument is the protocol name. Possible values for this argument are ftp, sftp and tftp. The second argument is the name or IP address of the file server. The third argument is the system backup file name. To restore a previously saved system backup use the load usage form. To take effect, the command apply should be used after having loaded a system backup. Please note that loading a system backup automatically clear any previousely loaded or created backup.

The fifth usage form allows you to display a report on the system activity and its health. It checks critical software and hardware health components and informs you about potential malfunction. Without any optional argument, this command displays a complete report on all components. If an optional argument is given, only a report related to that component is displayed.

The keyword load displays a report on the combined CPU and disk IO utilization over 1, 5, and 15 minutes. It is an indication of the the system load. Zero means there is no load, 100 means the system is fully loaded and a value greater than 100 means the system is overloaded.

The keyword memory displays a report on the RAM and swap memory size.

The keyword disk displays a report on disks activity in your configuration. This report includes the disks’ average i/o time in milliseconds and the disks’ i/o time averaged over the last 1 minute. If disks support SMART (Self-Monitoring, Analysis and Reporting Technology), the report also includes the health status of the corresponding disks and if possible the lifetime percentage for SSDs (100% means the SSD has 100% life). Note that the health status is not always available for disks in a hardware raid array. Refer to your vendor-specific health checking systems to monitor those disks.

If the system has been installed with software RAID support, the keyword raid displays a report on the installed RAID.

The keyword link displays the status of Ethernet links. Associated IP addresses to each Ethernet interface are also displayed. You can use this command to check floating IP addresses configured with the command vrrp.

The keyword gateway displays the status of connected gateways. Please note that only gateways that have been manually added by the ip command are monitored (ie. automatically added gateways in public cloud environment are not monitored).

The keyword connection displays the number of active (established) TCP connections per appliance network interface. In addition the total number of all TCP connections in all states (established, syn-sent, syn-recv, fin-wait-1, fin-wait-2, time-wait, closed, close-wait, last-ack, closing and listening) is displayed.

The keyword service displays the status of all critical software components. Note that critical software components differ according to your current system configuration.

The keyword vpnipsec displays the status of site to site VPN IPsec tunnels.

The keyword antivirus displays the status of the last automatic antivirus signatures update.

Finally the keyword counter displays the total number of blocked or allowed contents until the last log rotation. Please note that a counter is available only if its related logging is activated (see the command log). The optional argument raz allows you to reset a counter. Counter calculations are made since the system installation or the last reset operation. The real number of blocked or allowed contents can differ from values given by counters as some logs can be deactivated for a period of time and then be reactivated.


access (1) antivirus (1) apply (1) conf (1) file (1) ip (1) job (1) log (1) mode (1) reboot (1) register (1) rweb (1) transparent (1) vrrp (1)


CacheGuard Technologies Ltd <>

Send bug reports or comments to the above author.


Copyright (C) 2009-2024 CacheGuard - All rights reserved