- Update the cred.yaml file with the root login credentials of the devices and servers on the network to be onboarded, see Default credentials for device discovery.
- Ensure devices to be onboarded meet the hardware and software requirements, see Validated hardware components.
- Devices must be on the same subnet for auto-discovery using
ipscan
. Only secure ports are scanned on the subnet. - All required ports are open, see Firewall port requirements.
Create an ipscan.yaml file and include the IP addresses of the devices on the network to auto-discover. An example ipscan.yaml file is available in the /samples/ipscan/ directory. Both YAML and JSON file formats are accepted.
The attributes you can set include:
- start_range
- The starting IP address for an IP range. Must be specified coupled with endRange.
- end_range
- The end IP address for an IP range. Must be specified coupled with startRange.
- subnet_cidr
- An IP network specified in CIDR format.
- hosts
- A user-defined list of specific IP addresses to scan.
- scan_frequency
- Schedule the frequency of IP scans in seconds. Only one IP scan can be active for a site at any one time. The current scan must end before the next scan starts. The minimum scan frequency is once every 300 seconds and the maximum is once every 86400 seconds.
To perform an ipscan
, you can supply either the IP address range, define a subnet_cidr
, or supply the IP address of one or more host servers.