System commands

System commands allow you to manage the operation of the Management server, which includes managing licenses for the Management server and connectors.

Note: Do not use reserved words in the user name, host name, or file name. Reserved words include: ftp, sftp, ibm, port, user, and file.

Table 1.
Command name	Action	Syntax
system autoreboot	Allows you to enable or disable automatic reboot for a Management server. Note: During a Management server firmware upgrade, the Management server reboots even if the automatic reboot is disabled.	`system autoreboot <on \| off>`
system autoreboot setting	Use the setting parameter to print autoreboot settings.	`system autoreboot setting`
system clean	Clears the system states of the Management server. When you issue a system clean all command, the Management server may reboot. Running the `all` option results in the removal of all data and configurations. The results are equivalent to restoring factory default settings for the appliance. After the reboot, you will be asked to accept the license agreement before logging in to the cloud console for the appliance. You can remove all of the analytics information by entering the `analytics` option. When you run this command with the `analytics` option, it restarts the node to commit the changes. Remember: You must run the system clean analytics command on all of the nodes of a multiple-node cluster to permanently remove the information. If you only run it on one node, then the analytics information is copied back to the server during its next synchronization. For an environment with multiple management server nodes, complete these steps: On each of the management server non-primary nodes, stop the system by entering the following command: `debug system stop` Note: While the primary management server is restarted, the other management server non-primary nodes also lose connectivity. On the management server primary node, enter the following command: `system clean analytics` The node automatically restarts. After the management server primary node finishes restarting, enter the following command on each of the management server non-primary nodes: `system clean analytics` Each of the nodes automatically restarts. You can also remove the contents of the server logs by entering the `logs` option.	`system clean all\|apiconfig\|analytics\|logs` where: `all` - Resets the appliance to factory default settings. `apiconfig` - Removes all the topology, organizations, Products, analytics data, and API configuration from the Management server. `analytics` - Removes all of the analytics information from the system. `logs` - Removes the log information from the system, which can take a large amount of space. You can select from the following options: Export log: This clears all of the log records that are created when you export your analytics data. Elasticsearch: This clears all of the log records that are created by Elasticsearch actions. No: This cancels the log clean command, and does not remove any log information. `sessions` - Removes Web UI session data.
system persist	Enables or disables the disk cache on the Management server. The default and recommended setting is `system persist on`. When persistence is enabled, writes are synchronized to ensure that all requested data is completely written to disk. This behavior helps protect data integrity, particularly when accessing external transactional systems such as databases. When persistence is disabled, on an appliance that supports this feature, performance might be improved. However, there is a risk of losing job progress state.	`system persist { on \| off }`
system persist setting	Displays the current system persist setting: on or off. Use the system persist command to specify whether the disk cache is enabled or disabled.	`system persist setting`
system poweroff	Shuts down all routing services and then powers off the Management server. If the force parameter is used, power is cut off immediately.	`system poweroff`
system show publickey	Authorize transfers from this API Connect server without providing a password.	`system show publickey`
system reboot	Shuts down all routing services and then reboots the Management server. Note: When the system reboots, any network settings that have not been saved are lost. To commit network settings to the Management server, use the net restart command.	`system reboot`
system restart	Restarts the runtime and cloud console, without affecting the network connectivity.	`system restart`
system show platform	Displays information about the Management server, such as: ROM version, appliance platform, serial number, and MAC addresses.	`system show platform`
system show status	Available for Standalone Management servers as well as the Active Management server in an HA pair. Shows whether the following components are up or down: System, Network, and Runtime. Note: The Runtime status returned by the system show status command indicates whether the server processes are running correctly and are available for use. The Runtime status returned by the system show status command indicates only whether the server processes have been started; the ha list command confirms whether they are running correctly and are available for use.	`system show status` Example output: `Appliance Status ---------------- System: Up Network: Up Runtime: Up`
system show version	Displays the version of the operating system on the Management server.	`system show version`
system update firmware	Updates the Operating System on the Management server by using an image from a file; you use command parameters to specify the location of the file, and the mechanism to be used to obtain the file. You can obtain the image file by using any of the following mechanisms: FTP SFTP HTTP HTTPS URL	`system update firmware from ftp <hostname_or_ip_address> [port <number>] [user <user>] file <filepath>` `system update firmware from sftp <hostname_or_ip_address> [port <number>] user <user> file <filepath>` `system update firmware from http <hostname_or_ip_address> [port <number>] [user <user>] file <filepath>` `system update firmware from https <hostname_or_ip_address> [port <number>] user <user> file <filepath>` `system update firmware from url <fileurl> [user <user>]` Note: When using sftp, you must specify the `user` parameter. Anonymous logins are not allowed with sftp.