Skip to main content
Version: 0.6.0

Node Wizard (CLI) Usage

Node Wizard (CLI) provides a command line interface for managing specific system admin tasks.

How to run Node Wizard (CLI)​

Connect to the relevant VM host to apply changes and use --help or -h option for usage information.

Linux​

sudo /root/bin/node_wizard/node-wizard -h

Windows​

Node Wizard (Windows CLI) can be run from an elevated (Run as Administrator) PowerShell prompt.

C:\root\bin\node_wizard\node-wizard-win.exe -h

Usage​

Usage :node-wizard [options]

  options: 
    --help|-h                              print help 
    --version|-v                           print version 
    --token                                print token
    --list-allowed                         print allowed list
    --add-allowed        [pci addr]        add pci to allowed list
    --delete-allowed     [pci addr]        delete pci from allowed list
    --list-disallowed                      print disallowed list
    --add-disallowed     [device name]     add device/bridge name to disallowed list
    --delete-disallowed  [device name]     delete device/bridge name from disallowed list
    --generate-cert      [ip address]      server ip address(es) and (optional)dns name(s) for certificate, comma separate

The options are identical for Linux and Windows; a few of the examples below use Linux paths.

Token​

To register a VM host to the selected control plane (Cluster Wizard or Node Client), a token is necessary. This token will be printed when Node Wizard is installed. To retrieve this token after installation, run the following command.

# linux
sudo /root/bin/node_wizard/node-wizard --token
# windows
C:\root\bin\node_wizard\node-wizard-win.exe --token

Allowed List​

To attach a PCI device to a VM, the PCI address needs to be added to allowed (PCI address) list first.

# Add a PCI address to the allowed list
sudo /root/bin/node_wizard/node-wizard --add-allowed [PCI address]
# To print the list
sudo /root/bin/node_wizard/node-wizard --list-allowed
# Remove from the allowed list.
sudo /root/bin/node_wizard/node-wizard --delete-allowed [PCI address]

Disallowed List​

To prevent a bridge to be attached to a VM, the network device/bridge needs to be added to disallowed list first.

# Add a Device/Bridge to the disallowed list
sudo /root/bin/node_wizard/node-wizard --add-disallowed [network device/bridge]
# To print the list
sudo /root/bin/node_wizard/node-wizard --list-disallowed
# Remove from the disallowed list.
sudo /root/bin/node_wizard/node-wizard --delete-disallowed [network device/bridge]

TLS Certificate​

From version 0.6.0, Node Wizard automatically generates a TLS certificate during installation. To regenerate this certificate(e.g., following an IP change, certificate expiration, or file corruption), run the command below.

# linux
sudo /root/bin/node_wizard/node-wizard --generate-cert [server ip address(es),dns name(s)]
# windows
C:\root\bin\node_wizard\node-wizard-win.exe --generate-cert [server ip address(es),dns name(s)]

If the CA is also recreated, note that the host needs to be updated with key ca (using Cluster Wizard) or re-registered (using Node Client).