bmo create ipscan -n <sitelocation> -f <ipconfig>.yaml
Request a scan of a particular subnet to auto-discover devices on the network that are eligible for onboarding. Only secure ports are scanned on the subnet. The device's credentials must be added to the Bare Metal Orchestrator cred.yaml file before scanning the network. For instructions to update the cred.yaml file, see the Bare Metal Orchestrator Command Line Interface User's Guide.
Argument Definition
- sitelocation
- The location that was defined for the site. This CLI command uses the location as the site namespace. For more information about the site location, see Site field definitions.
- ipconfig.yaml
- The name of the .yaml file that defines the start and end range of IP addresses to scan, the subnet CIDR, the scan frequency, and specific host IP addresses as applicable. An example ipconfig.yaml file is available in the ~/samples/ipscan/ directory.
Example ipconfig.yaml
The following is an example ipconfig.yaml file.
start_range: 100.10.1.0
end_range: 100.10.1.4
subnet_cidr: 100.10.1.8/31
hosts:
- 100.10.1.101
- 100.10.1.102
scan_frequency: 14400 ##entered in seconds
Attribute Definitions
- 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 a 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 scan frequency is once every 86,400 seconds.