Skip to main content

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

XLSERVER:NTP>h
         help(h): to show this help
         quite(q): to back to previous screen
         show: display current NTP configuration
         setup(set): reconfigure NTP servers
         disable: disable ntp configuration

  1. Show current NTP configuration:

show

XLSERVER:NTP>show
Current NTP Servers (from /etc/chrony.conf):
server 216.239.35.0 iburst
server 216.239.35.4 iburst
server 216.239.35.8 iburst

NTP Synchronization Status (chronyc sources -v):

  .-- Source mode  '^' = server, '=' = peer, '#' = local clock.
 / .- Source state '*' = current best, '+' = combined, '-' = not combined,
| /             'x' = may be in error, '~' = too variable, '?' = unusable.
||                                                 .- xxxx [ yyyy ] +/- zzzz
||      Reachability register (octal) -.           |  xxxx = adjusted offset,
||      Log2(Polling interval) --.      |          |  yyyy = measured offset,
||                                \     |          |  zzzz = estimated error.
||                                 |    |           \
MS Name/IP address         Stratum Poll Reach LastRx Last sample
===============================================================================
^+ time.cloudflare.com           3   6    17     5   -675us[ -836us] +/-   12ms
^+ 2001:19f0:6801:7ed::123       2   6    17     6   -744us[ -905us] +/-   24ms
^- 2001:41d0:8:9233::1           2   6    17     6   -433us[ -594us] +/-   35ms
^* 2a01:e0a:431:b527::a123       1   6    17     5   +492us[ +331us] +/-   10ms
^? time1.google.com              0   7     0     -     +0ns[   +0ns] +/-    0ns
^? time2.google.com              0   7     0     -     +0ns[   +0ns] +/-    0ns
^? time3.google.com              0   7     0     -     +0ns[   +0ns] +/-    0ns
  1. To configure or reconfigure NTP servers:

setup

Follow the prompts to add NTP server addresses.

XLSERVER:NTP>set
NTP Server Setup - Enter 1 to 3 NTP servers
Press Enter without input to finish (minimum 1 server required)
Enter NTP server 1 [optional if > 1]: 216.239.35.0
Added: 216.239.35.0
Enter NTP server 2 [optional if > 1]:

Entered NTP servers:
1. 216.239.35.0
Do you want to save this NTP configuration? [NO]: YES
Configuring NTP servers...
server 216.239.35.0 iburst
NTP configuration saved and applied successfully.
Current NTP Servers (from /etc/chrony.conf):
server 216.239.35.0 iburst
  1. To disable NTP configuration:

disable

XLSERVER:NTP>disable
Disabling NTP...
Are you sure you want to disable NTP? [NO]: YES
NTP disabled successfully.
Current NTP Servers (from /etc/chrony.conf):
No NTP servers configured.

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