Changing a Hub's Internal IP Address

You internal private scan hub will usually have a public IP address as well as an internal IP address.

The public IP address will usually be the public address of your organisation's outbound gateway.  This is the address from which your scan hub will communicate with AppCheck's servers (and the wider internet, if for example you use your private scan hub to scan publicly accessible targets).

The private IP address is determined by your internal network configuration, for example on your routers, your hypervisor, and settings within the scanhub VM.  AppCheck's servers will not see requests from this address, but it will be used to communicate with other devices on your network, for example to scan internal targets.

Changing your Scan Hub's Internal IP Address

If you are using DHCP to set the scan hub's IP address then no action on the hub itself is required to change its IP address.

However, if you have assigned a static IP address in the hub's network configuration, then you will need to make changes on the hub VM itself to change the IP address.

The network settings are determined by a YAML file that is stored within /etc/netplan/.  The filename itself can vary, but the file extension will always be .yaml, and there should only be one file there.

For example, your configuration file may be /etc/netplan/01-netcfg.yaml.

How to edit the file

The scanhub comes pre-installed with the text editor nano.  To edit the file using the example name shown above the command would be

sudo nano /etc/netplan/01-netcfg.yaml

This will prompt you to enter the scan hub's command line interface password (you should have received the default password when you set up the hub, though you may have changed it).  You can then use the arrow keys to move the cursor, type as normal, save with ctrl+o and close the editor with ctrl+x.  Check the bottom of the screen for further instructions, for example you'll see a confirmation prompt there when you wish to overwrite an existing file.

If you have trouble with this you may wish to search the web for a more comprehensive guide to using nano.

What the file should look like

Usually you will simply need to change the IP address, by deleting the existing address and typing your new one.

You may also need to make a change to the default gateway, again you can simply delete the existing entry and type your new one.

If you need to make more significant changes to the configuration you may wish to search the web for a guide to netplan configuration files.  AppCheck support may also be able to advise on some changes, but bear in mind the exact required settings will be determined by your network architecture, with which AppCheck Support are not familiar.

How to apply and confirm the changes have taken effect.

Onve you have made the changes, saved, and quit nano, run the following command to apply the changes

sudo netplan apply

If you see any errors these will need addressing.  If not, you can confirm the new address by logging out (by pressing ctrl+d), and checking the address shown on the command line login screen.