The Appliance Console – Command List

Posted on 6th October 2016

The following commands are available from the console.

Command Function
dig DNS information & diagnostics
netconfig Presents a simple to use console menu where you can configure the virtual appliance’s network settings.
netstat Displays network connections and statistics
nslookup DNS troubleshooting
passwd To change password for the fadmin account use ‘passwd fadmin’
ping Network connectivity & troubleshooting
traceroute Determines the route taken by packets to reach a destination
tenant-enable Enables multi-tenancy mode
tenant-disable Disables multi-tenancy mode
tenant-add “tenant-name” subdomain Adds a tenant, specify a friendly tenant name first in quotes followed by the required subdomain that will be used
tenant-list Shows all tenants and the status of the encryption keys for each
tenant-sync ip-1 ip-2 -p password Synchronises tenants across multiple appliances.  Optionally specify the fadmin password for all appliances with the -p option.
tenant-reset-password subdomain Reset the tenant admin (tadmin) account for the given subdomain.  The password will be reset to ‘password’ without quotes.
install-xen-guest-utils Installs the Citrix XenTools guest drivers for improved system performance.  Requires the xs-tools ISO to be mounted in XenCenter.
support-enable Enables fsupport mode.  This can be used a technical support representative to log in for troubleshooting purposes or performing a password reset for the fadmin account.
iptables Modifies the built-in firewall.  All rules should be commented -m comment —comment “foldr-admin” to enable the rules to persist after a system update.
iptables-save Commits all firewall rules so they are permanently saved.
add-interface ethx Creates an additional network interface.  This must be used before you can configure these NICs with the netconfig menu.  The appliance supports a maximum of 4 virtual NICs (eth0 – eth3)
remove-interface ethx Removes additional network interface.
set-routes ethx Set static routes for additional network interfaces
ethtool -P ethx Displays the MAC address for interface ethx in the example.  Useful if you have attached multiple interfaces to the appliance for identification purposes
certificate-reset Resets the SSL certificate installation back to the self-signed (default) certificate
time-sync x.x.x.x (IP-address of NTP server) Forces the appliance system clock to sync with an NTP server.  NTP must be selected within Foldr Settings >> Appliance >> Time Settings for this command to work successfully
ocsp-enable | disable Enables OCSP stapling
flush-cache Flushes cached database entries on the server
set-ciphers modern | default Configures the appliance web server SSL configuration.  ‘Modern’ disables TLS 1.0, 1.1 and also disables the 3DES cipher suites.
smb-mode legacy|default|modern|edge Configures SMB protocol on the appliance.  The different modes are explained below:

legacy =  sets max client protocol to SMB1
default = sets max client protocol to SMB2
modern = sets min client protocol to SMB2 & max client protocol to SMB3
edge = set max client protocol to SMB3

http-test Performs HTTP(S) connectivity tests using cURL.  Example command to show verbose output:
http-test -v https://letsencrypt.org
ldap-test (filter) Performs LDAP(S) tests using ldapsearch.

Need more help?

Get in touch with our friendly help desk who will be happy to assist you, support@foldr.io