Node Client WebUI Usage

The Node Client WebUI provides a browser-based interface for managing and interacting with hosts running Node Wizard. It allows users to perform common administrative tasks such as server registration, license management, VM operations, and network configuration without requiring command-line access. This guide walks through the key features and workflows available in the WebUI.

1. Login

The Login page allows users to securely access the Node Client WebUI. From here, users can enter their username and password to begin managing servers and resources.

1. Username entry box for login
2. Password entry box for login
3. Login - Log in with the provided username and password
4. Help - Help menu with links to About and Contact Us pages

1. Username entry box for login
2. Password entry box for login
3. Login - Log in with the provided username and password
4. Help - Help menu with links to About and Contact Us pages

2. Server Management

The Server Management section allows users to register and manage servers on which Node Wizard is deployed. It also provides access to licensing functions and configuration settings for each registered server.

1. Register / Unregister Server - Toggle dropdown menu
2. Register Server
3. Unregister Server
4. License - Toggle dropdown menu
5. Request License
6. Upload License
7. Node Wizard Management

1. Register / Unregister Server - Toggle dropdown menu
2. Register Server
3. Unregister Server
4. License - Toggle dropdown menu
5. Request License
6. Upload License
7. Node Wizard Management

2.1 Register Server

The Register Server option allows the user to add a new server to Node Client using its IP address and authentication token, enabling it to be managed through the WebUI.

1. Server - IP address of the server to register
2. Token - Authentication token generated by Node Wizard for server registration
3. Alias - Server alias
4. Send - Submit

1. Server - IP address of the server to register
2. Token - Authentication token generated by Node Wizard for server registration
3. Alias - Server alias
4. Send - Submit

Back to 2. Server Management

2.2 Unregister Server

The Unregister Server option allows the user to remove a previously registered server from Node Client, preventing further management through the WebUI.

1. Server to unregister

1. Server to unregister

Back to 2. Server Management

2.3 Request License

The Request License option allows the user to generate and submit a license request for a registered server directly through the WebUI.

1. Trial or Paid License selector
2. Number of days for license validity
3. First Name - First name used for the license request
4. Last Name - Last name used for the license request
5. Company - Company name used for the license request
6. Email Address - Email address used for the license request
7. Server - Server selected for the license request
8. Send - Submit license request

1. Trial or Paid License selector
2. Number of days for license validity
3. First Name - First name used for the license request
4. Last Name - Last name used for the license request
5. Company - Company name used for the license request
6. Email Address - Email address used for the license request
7. Server - Server selected for the license request
8. Send - Submit license request

Back to 2. Server Management

2.4 Upload License

The Upload License option allows the user to apply a valid license file to a registered server to enable its features.

1. License file to upload
2. Upload button

1. License file to upload
2. Upload button

Back to 2. Server Management

2.5 Node Wizard Management

The Node Wizard Management section allows the user to view and configure host level settings for a selected server.

1. Select server to manage

1. Select server to manage

Once a server has been selected, the user can edit host level environment variables.

1. Ceph Pool - Libvirt storage pool backed by Ceph and used for VM storage
2. Gateway - IP address of the network gateway
3. Nameserver - IP address of the name server
4. Bridge - Default bridge used for VM creation
5. Edit button

1. Ceph Pool - Libvirt storage pool backed by Ceph and used for VM storage
2. Gateway - IP address of the network gateway
3. Nameserver - IP address of the name server
4. Bridge - Default bridge used for VM creation
5. Edit button

Back to 2. Server Management

3. Server Commands

The Server Commands section provides access to operational tools for managing VMs, templates, networking, and system information on registered hosts. It enables users to perform everyday administrative actions directly through the WebUI.

1. VMs Management
2. Templates Management
3. Network Management
4. Network Device Management
5. Allowed PCI / Disallowed Device
6. System Information

1. VMs Management
2. Templates Management
3. Network Management
4. Network Device Management
5. Allowed PCI / Disallowed Device
6. System Information

3.1 VMs Management

The VMs Management section allows the user to view and manage virtual machines on a selected host, including power operations, access, storage, networking, and device configuration.

1. Select VM to manage

1. Select VM to manage

After a VM has been selected, the VM management menus are displayed.

1. Selected VM
2. Power Menu
3. Access Menu
4. Snapshot Menu
5. Template Menu
6. Network Menu
7. Disk Menu
8. PCI Menu
9. Info/Manage Menu
10. ISO Management
11. Create VM

1. Selected VM
2. Power Menu
3. Access Menu
4. Snapshot Menu
5. Template Menu
6. Network Menu
7. Disk Menu
8. PCI Menu
9. Info/Manage Menu
10. ISO Management
11. Create VM

Back to 3. Server Commands

3.1.1 Power Menu

Node Client WebUI VM Management - Power Menu

• Power - gracefully powers off the selected VM
• Force Power Off - immediately power off the selected VM without a graceful shutdown

Back to 3.1 VMs Management

3.1.2 Access Menu

Node Client WebUI VM Management - Access Menu

• VNC Info - Provide VNC connection information
• SSH Terminal - Provide WebUI based SSH access to selected VM
• VNC Display - Provide WebUI based VNC access to selected VM

Back to 3.1 VMs Management

3.1.3 Snapshot Menu

Node Client WebUI VM Management - Snapshot Menu

• Snapshot List - List all snapshots
• Snapshot take - Creates a snapshot of the selected VM
• Delete Snapshot - Delete a snapshot
• Rollback Snapshot - Restore the VM to a previous state

Back to 3.1 VMs Management

3.1.4 Template Menu

Node Client WebUI VM Management - Template Menu

• Create Template
• Create Template (Dry Run)

Back to 3.1 VMs Management

3.1.5 Network Menu

Node Client WebUI VM Management - Network Menu

• IP - Display configured IP information for the VM
• List Bridge - List bridge network devices attached to the VM
• Attach Bridge - Attach a bridge network device to the VM
• Detach Bridge - Detach a bridge network device from the VM
• Update Bridge - Update bridge configuration

Back to 3.1 VMs Management

3.1.6 Disk Menu

Node Client WebUI VM Management - Disk Menu

• List Disk - List all disks attached to the VM
• Attach Disk - Attach a disk to the VM
• Detach Disk - Detach a disk from the VM

Back to 3.1 VMs Management

3.1.7 PCI Menu

Node Client WebUI VM Management - PCI Menu

• List PCI - List all host PCI devices attached to the VM
• Attach PCI - Attach a host PCI device to the VM
• Detach PCI - Detach a host PCI device from the VM

Back to 3.1 VMs Management

3.1.8 Info/Manage Menu

Node Client WebUI VM Management - Info/Manage Menu

• Rename VM - Rename the VM
• Delete VM - Delete the VM
• Dump XML - Download the VM's current domain XML
• OS Info - Display known VM OS information

Back to 3.1 VMs Management

3.1.9 ISO Management

Node Client WebUI VM Management - ISO Management

Back to 3.1 VMs Management

3.2 Template Management

The Template Management section provides tools for creating and managing VM templates, as well as deploying VMs from templates.

1. Clone Template to VM
2. Create Template from VM

1. Clone Template to VM
2. Create Template from VM

Back to 3. Server Commands

3.3 Network Management

The Network Management section allows the user to view and manage network interfaces, including device configuration and PCI device accessibility on the selected host.

1. Select host to manage its network

1. Select host to manage its network

3.3.1 Network Management - Device Management

The Device Management view displays the network interfaces on the selected host, provides detailed configuration information, and allows the user to create new network devices such as bridges, VLANs, and VXLANs.

1. Create Bridge - Add a new bridge interface
2. Create VLAN - Add a VLAN interface
3. Create VXLAN - Add a VXLAN interface

1. Create Bridge - Add a new bridge interface
2. Create VLAN - Add a VLAN interface
3. Create VXLAN - Add a VXLAN interface

Back to 3. Server Commands

3.3.2 Network Management - Allowed PCI / Disallowed Device

The Allowed PCI / Disallowed Device view shows which PCI and network devices on the selected host are permitted or restricted for PCI pass-through operations and bridge attachment.

Node Client WebUI Network Management - Allowed PCI / Disallowed Device

Back to 3. Server Commands

3.4 System Information

The System Information section provides access to host-level details and tools, including SSH access and system logs.

1. Access host via SSH
2. Logs

1. Access host via SSH
2. Logs

Back to 3. Server Commands