→ Applies to: Hyperion 9.x and above

All commands in this article are intended to be executed via Hyperion CLI.

nmctl is a command-line utility designed to simplify network configuration on Hyperion. It offers a more intuitive alternative to tools like nmcli (NetworkManager CLI) and virsh (libvirt manager), with a focus on:

• Bonded interfaces
• Network bridges (vSwitch)
• VLANs (virtual LANs)
• Libvirt-integrated virtual networks

Step 1. Connect to Hyperion appliance via SSH as admin

ssh admin@<your_ip_address_or_hostname>

Step 2. Become Super User

sudo su

Help & Autocomplete

List available command

syneto-nmctl help

Enable auto-complete functionality with TAB

syneto-nmctl completion

Manage vSwitches

Create a new vSwitch with a uplink interface (replace <company_name> and <interface> with the correct information)

syneto-nmctl vswitch create --name "<company_name>" --uplink <interface> 

EXAMPLE

syneto-nmctl vswitch create --name "Company Network" --uplink ens256 

EXAMPLE OUTPUT

[+] Creating bridge 'vswitch1' with label 'Company Network' and uplink 'ens256'
Connection 'Company Network' (73ef8751-d27d-4813-8a54-eaafe55817b4) successfully added.
Error: unknown connection 'Company Network Uplink'. <--IGNORE
Error: cannot delete unknown connection(s): 'Company Network Uplink'. <--IGNORE
[+] Configuring 'ens256' as direct bridge uplink
Connection 'Company Network Uplink' (a5b743ab-48e9-4fdd-88bd-cd1764850421) successfully added.
Connection successfully activated (controller waiting for ports) (D-Bus active path: /org/freedesktop/NetworkManager/ActiveConnection/20)
Connection successfully activated (D-Bus active path: /org/freedesktop/NetworkManager/ActiveConnection/22)

Create a new vSwitch with a bond interface (replace <company_name>, <uplink1> and <uplink2> with the correct information) Add an additional uplink to an existing vSwitch 

syneto-nmctl vswitch create --name "<company_name>" --uplink <uplink1>,<uplink2>

EXAMPLE

syneto-nmctl vswitch change --name vswitch0 --uplink em1,em2

EXAMPLE OUTPUT

Connection 'Management Uplink' (2e2fd3c2-a4a0-4483-9334-092aab45d358) successfully deleted.
[+] Creating bond0 with: em1,em2
Connection 'Management Uplink' (56361be4-934c-47c5-aef9-7f0fdf799fe7) successfully added.
Warning: There is another connection with the name 'em1'. Reference the connection by its uuid '365162e0-f99f-4268-b0ca-e34042d9e05f'
Connection 'em1' (365162e0-f99f-4268-b0ca-e34042d9e05f) successfully added.
Warning: There is another connection with the name 'em2'. Reference the connection by its uuid '5e2a3b71-b16b-43e6-9dbc-8d73515fdd9e'
Connection 'em2' (5e2a3b71-b16b-43e6-9dbc-8d73515fdd9e) successfully added.
Error: unknown connection 'vswitch0'.
Connection successfully activated (controller waiting for ports) (D-Bus active path: /org/freedesktop/NetworkManager/ActiveConnection/22)
Connection successfully activated (controller waiting for ports) (D-Bus active path: /org/freedesktop/NetworkManager/ActiveConnection/25)
[+] Reattaching vnet0 to vswitch0
[+] Reattaching vnet1 to vswitch0

Delete a vSwitch and detach its uplink (replace <vswitch_name> with the correct information)

syneto-nmctl vswitch delete <vswitch_name>

EXAMPLE

syneto-nmctl vswitch delete vswitch0

List all vSwitches

syneto-nmctl vswitch list

EXAMPLE

syneto-nmctl vswitch list

=== Virtual Switches ===
--- General purpose Virtual Switches ---
Management Network        vswitch0     bridge   activated
  └─ em2 (Management Uplink)
cni0                      cni0         bridge   activated
virbr0                    virbr0       bridge   activated

--- VLAN-Dedicated Virtual Switches ---

Change the uplink(s) of an existing vSwitch (replace <vswitch_name>, <uplink1> and <uplink2> with the correct information)

syneto-nmctl vswitch change --name <vswitch_name> --uplink <uplink1>,<uplink2>

EXAMPLE

syneto-nmctl vswitch change --name vswitch0 --uplink em1,em2

EXAMPLE OUTPUT

Connection 'Management Uplink' (2e2fd3c2-a4a0-4483-9334-092aab45d358) successfully deleted.
[+] Creating bond0 with: em1,em2
Connection 'Management Uplink' (56361be4-934c-47c5-aef9-7f0fdf799fe7) successfully added.
Warning: There is another connection with the name 'em1'. Reference the connection by its uuid '365162e0-f99f-4268-b0ca-e34042d9e05f'
Connection 'em1' (365162e0-f99f-4268-b0ca-e34042d9e05f) successfully added.
Warning: There is another connection with the name 'em2'. Reference the connection by its uuid '5e2a3b71-b16b-43e6-9dbc-8d73515fdd9e'
Connection 'em2' (5e2a3b71-b16b-43e6-9dbc-8d73515fdd9e) successfully added.
Error: unknown connection 'vswitch0'.
Connection successfully activated (controller waiting for ports) (D-Bus active path: /org/freedesktop/NetworkManager/ActiveConnection/22)
Connection successfully activated (controller waiting for ports) (D-Bus active path: /org/freedesktop/NetworkManager/ActiveConnection/25)
[+] Reattaching vnet0 to vswitch0
[+] Reattaching vnet1 to vswitch0

Manage Virtual Network

Create a new virtual network connected to a vSwitch (replace <network_name> and <vswitch_name> with the correct information)

syneto-nmctl network create --name "<network_name>" --vswitch <vswitch_name>

EXAMPLE

syneto-nmctl network create --name "Management Network" --vswitch vswitch0

Change the vSwitch of an existing virtual network (replace <network_name> and <vswitch_name> with the correct information)

syneto-nmctl network change --name "<network_name>" --vswitch <vswitch_name>

EXAMPLE

syneto-nmctl network change --name "Management Network" --vswitch vswitch1

Delete a virtual network (replace <network_name> with the network name)

syneto-nmctl network delete --name <vswitch_name>

EXAMPLE

syneto-nmctl network delete --name vswitch1

This operation can be performed only if it is not currently used by any virtual machine

List all libvirt network

syneto-nmctl network list

Manage VLANs

Create a new VLAN network (replace <vlan_name>, <vlan_id> and <vswitch_name> with the correct information)

syneto-nmctl vlan create --name "<vlan_name>" --vlan-id <vlan_id> --vswitch <vswitch_name>

EXAMPLE

syneto-nmctl vlan create --name "VLAN 3003" --vlan-id 3003 --vswitch vswitch1

Delete a VLAN (replace <vlan_name> with the vlan name)

syneto-nmctl vlan delete <vlan_name>

List all VLANs

syneto-nmctl vlan list

Reconnect VM Interfaces

Reconnect VM interfaces to expected vSwitches

syneto-nmctl sync-vm-interfaces

Reconnect all VM interfaces (vnetX) to the correct virtual switches.  
Use this after modifying or recreating vSwitches or VLANs.

Show Network Information

Show all physical network interfaces

syneto-nmctl list physical

Show the status of all interfaces

syneto-nmctl list interfaces

Show all network connections

syneto-nmctl list connections