Using the command line interface to run operations on your appliance

You can run commands to restart the appliance hardware, reset the appliance to its original factory settings, or shut down the appliance.

About this task

You can use the command-line interface to reset the appliance configuration data, restart the appliance, or shut down the appliance.

Procedure

  1. Establish a connection with the appliance using the xcadmin user. You can use a serial connection or you can connect with the command-line interface using a Secure Shell (SSH).
    • Serial connection: The serial connection must be between an ASCII terminal or a PC running terminal emulation software to the serial port on the appliance. If you are using a PC for the serial console, you must use a PC-based serial communications program for Windows or Linux. Use either the supplied serial cable or PL-2303 USB-to-serial cable to make the connection to the appliance.
      Important: If you are using the PL-2303 USB-to-serial cable, download and install a driver for the cable before proceeding.
    • Remote login: To connect to the appliance with SSH, provide the URL of your appliance to your SSH client.
  2. After you have established a connection with the appliance, you can issue one of the following commands.
    clear-all
    Resets the configuration data for the appliance, including removing all the data grids and new users. All of the internal processes that are running on the appliance are restarted. This command runs without restarting the appliance hardware.
    clear-logs
    Deletes all of theWebSphere® DataPower® XC10 Appliance log files.
    clear-tls-config
    Resets the Transport Layer Security (TLS) configuration. Run this command if clear-all is not an option because you do not want to lose all configuration data, but TLS configuration becomes corrupted or you want to restore the default TLS values. In most situations, use the user interface for TLS changes or use the clear-all command to revert to the original configuration of the appliance.

    Run the clear-tls-config command on each appliance in the collective. After running the command on each appliance, restart the processes in each appliance in the collective.

    If the collective is successfully communicating, use the device restart command. The collective is communicating properly when all appliances in the collective are accessible through the user interface and can be seen as started in the Collective panel. However, if the TLS configuration is preventing the collective from communicating and the device restart command does not bring the appliance back up, you can use the force-recycle command to forcibly stop and start all the processes in the appliance without saving any data.

    device RESET
    Resets the appliance back to factory settings of the network, licensing, and default user IDs. All the data in the data grids is deleted. You must reinitialize the appliance after running this command.
    device restart
    Restarts the appliance hardware. The data grid, configuration, and user data is saved before the device shuts down and is available when the appliance restarts.
    device shutdown
    Shuts down the appliance hardware. The data grid, configuration, and user data is saved before the device shuts down.
    file get <file_location> <file_name_on_appliance>
    Retrieves a file and saves the file to the appliance.
    firmware upgrade <firmware_file>
    Installs the specified firmware upgrade file.
    force-recycle
    Restarts the WebSphere DataPower XC10 Appliance processes without saving any data. Because data loss can occur, run this command only if you are not worried about data loss or you have tried the device restart command and the appliance did not become available.
    get-dns-servers
    Displays the IP addresses of the configured domain name servers.
    list ethernet-interface
    Lists the available Ethernet interfaces on the appliance.
    net-test available
    Tests whether a network interface exists with an active carrier.
    net-test dns <host_name>
    Performs domain name server look up on a specified host name.
    net-test ping <host_name>
    Tests connectivity to a specified host name or IP address.
    net-test tcp<host_name> <port>
    Tests the ability to open a TCP connection to port at a specified hostname or IP address.
    netif show <interface>
    Displays the Ethernet interface configuration information.
    netif status <interface>
    Displays the Ethernet interface status.
    show version
    Displays the current version of appliance firmware that is installed.
    set-dns-servers <valid DNS server>
    Sets the Domain Name System (DNS) server for the appliance.
    start-progress
    You can issue this command when the startup is in progress. The command displays the percentage of the startup process that has completed.
    status cpu-usage
    Displays the processor load percentage for the past minute, 5 minutes, and 15 minutes.

What to do next

If you reset the appliance, you can reinitialize your appliance. For more information about configuring your appliance, see Initializing and configuring IBM WebSphere DataPower XC10 Appliance.
Parent topic: Troubleshooting
Related tasks:
Editing an aggregate interface
Deleting an aggregate interface
Adding an aggregate interface
Managing the IBM WebSphere DataPower XC10 Appliance Ethernet interfaces
Shutting down or restarting the appliance from the user interface
Monitoring activities with tasks