shellgraph

Prepare an Environment

Add the credential, the Environment, the VLANs, the collector token and the tag rules. A scan needs all of them.

You must have the admin role. Do the steps in this sequence: credential, Environment, VLAN, collector token, tag rules.

Add a credential

A credential is the SSH user and the private key that the collector uses.

  1. Open Credentials and select Add credential.
  2. Type a name and the SSH user.
  3. Paste the private key (OpenSSH or PEM format). If the key has a passphrase, type it.
  4. Keep Use sudo for ss on if the target hosts have the sudoers line. See Prepare the target hosts.
  5. Select Save.

The server encrypts the key. The UI never shows the key again. The table shows the fingerprint of the public key.

To change the key, edit the credential and paste the new key. An empty key field keeps the current key.

Add an Environment

  1. Open Environments and select Add Environment.
  2. Type a name, for example “Production”, and an optional description.
  3. Select Save.

Add a VLAN

  1. Open the Environment, then the VLANs tab.
  2. Select Add VLAN.
  3. Type a name, the CIDR (for example 10.0.10.0/24) and the SSH port.
  4. Select the credential.
  5. Optional: type the addresses that the collector must not scan.
  6. Select Save.

The limit is 65536 addresses for each VLAN. The collector asks for --allow-large for more than 4096 addresses. Two VLANs of one Environment must not have the same addresses.

The Collector command column shows the command that scans the VLAN.

Create a collector token

  1. Open Collector tokens and select Create token.
  2. Type the name of the collector machine.
  3. Copy the token and the login command. The UI shows the token one time only.

A token can read the SSH keys of all VLANs. Make one token for each collector machine. If a machine is lost, select Revoke.

Add tag rules

Tags put related hosts near each other on the map.

  1. Open the Environment, then the Tag rules tab.
  2. Select Add tag rule.
  3. Select the match type:
    • Hostname contains: the hostname contains the pattern, for example lb.
    • Regular expression: the hostname matches the pattern, for example ^db-\d+.
  4. Type the tag and select a color.
  5. Type a priority. The server examines the rules from the lowest number to the highest. The first rule that matches gives the tag.
  6. Select Save.

The Preview table shows the tag of each host with the current rules. A host without a tag goes to the group “Untagged”. A manual tag on the host page overrides the rules.

Next step

Scan the VLAN with the collector. See Run a scan.