Aller au contenu principal

Appliance Configuration via CLI

The XLServer Appliance provides a built-in Command Line Interface (CLI) for administrative configuration and maintenance.
All operations are performed by connecting to the appliance via SSH using the sysman user.

Accessing the CLI​

  1. Connect to the XLServer appliance with SSH: ssh sysman@<xlserver-host>

cli-connection

  1. Once connected, you can enter help (or h) to view the main menu:

cli-main-menu-help

  1. To exit the CLI, type:

quit

or simply q.

Available CLI Menus​

  • host → Configure hostname
  • ntp → Configure NTP (time synchronization)
  • network → Configure network interfaces (management, backup, client)
  • service → Start/stop/view status of the XLServer service
  • password → Change the sysman password
  • certificate → View or regenerate self-signed SSL certificate
  • cleanup → Clean orphan objects from repository
  • reset → Reset the appliance to initial state

Configure the Hostname​

  1. Enter the host menu:

host help

cli-host-menu

  1. Show current hostname:

show

cli-host-show

  1. To set a new hostname, type the new hostname at the prompt and confirm with YES.

cli-host-set-hostname

  1. Return to the main menu with:

quit

Configure NTP​

  1. Enter the ntp menu:

ntp help

cli-ntp-menu

  1. Show current NTP configuration:

show

  1. To configure or reconfigure NTP servers:

setup

Follow the prompts to add NTP server addresses.

Configure Network​

  1. Enter the network menu:

network help

cli-network-menu

  1. Show available NICs on the appliance:

device

cli-network-device

  1. Show current network configuration:

show

cli-network-show

  • At least one MANAGEMENT network is mandatory.
  • Optional: BACKUP and CLIENT networks.

Configure MANAGEMENT Network​

management

You will be prompted to provide:

  • NIC UUID to use
  • IP assignment (DHCP or Manual)
  • CIDR IP (e.g., 192.168.1.46/24) if manual
  • Gateway IP address
  • DNS server
  • Jumbo frame (enable/disable)
  • Confirm with YES to save changes

cli-network-management

Configure BACKUP Network​

backup

Steps are identical to MANAGEMENT configuration.

Configure CLIENT Network​

client

Steps are identical to MANAGEMENT configuration.

Delete a Network Configuration​

delete

Enter the network type to delete (MANAGEMENT, BACKUP, CLIENT).

Return to the main menu with:

quit

Service Management​

  1. Enter the service menu:

service help

cli-service-menu

  1. View service status:

status

cli-service-status

  1. Stop the service:

stop

  1. Start the service:

start

Change sysman Password​

  1. Enter the password menu:

password

Prompt will display:
XLSERVER:PASSWORD>

  1. Enter the new password and confirm with YES.

Certificate Management​

  1. Enter the certificate menu:

certificate help

cli-certificate-menu

  1. Show current SSL certificate details:

show

cli-certificate-show

  1. Generate a new self-signed certificate:

generate

cli-certificate-generate

Cleanup Command​

The cleanup command removes orphan objects in XLServer.

⚠️ Important: You must stop the XLServer service before running this command.

cleanup

cli-cleanup

Reset the Appliance​

The reset command reinitializes XLServer to its factory state.
This empties the database repository of all user modifications.

⚠️ Important: You must stop the XLServer service before running this command.

reset

cli-reset