NetBox
  • 07 Sep 2023
  • 2 Minutes to read
  • Dark
    Light
  • PDF

NetBox

  • Dark
    Light
  • PDF

Article Summary

NetBox is an open source web application to help manage and document computer networks.


Types of Assets Fetched

This adapter fetches the following types of assets:

  • Devices

Parameters

  1. NetBox Domain (required) - The hostname or IP Address of the NetBox server.

  2. Authentication Token (optional) - Use the API key you have generated, if required.
    3.Verify SSL - Select whether to verify the SSL certificate of the server against the CA database inside of Axonius. For more details, see SSL Trust & CA Settings.

  3. HTTPS Proxy (optional) - Connect the adapter to a proxy instead of directly connecting it to the domain.

To learn more about common adapter connection parameters and buttons, see Adding a New Adapter Connection.

Netbox.png


Advanced Settings

Note:

Advanced settings can either apply for all connections for this adapter, or you can set different advanced settings and/or different scheduling for a specific connection, refer to ​Advanced Configuration for Adapters.

  1. NetBox role include list (optional) - Enter a comma-separated list of NetBox roles. Note that values are case-sensitive.
    • If supplied, all connections for this adapter will only fetch devices whose NetBox role is any of the comma-separated list of NetBox roles that have been defined in this field.
    • If not supplied, all connections for this adapter will fetch devices associated with any of the existing NetBox roles.
  2. NetBox tenant include list (optional) - Enter a comma-separated list of Netbox tenants. Note that values are case-sensitive.
    • If supplied, all connections for this adapter will only fetch devices whose NetBox tenant is any of the comma-separated list of NetBox tenants that have been defined in this field.
    • If not supplied, all connections for this adapter will fetch devices associated with any of the existing NetBox tenants.
  3. Fetch virtual machines - Select to include virtual machines in the fetch.
  4. Fetch IPAM IPs - Select to fetch all known IPs with their hostnames.
  5. Include custom fields for devices (default: false) - Select this option to also fetch custom fields for devices.
  6. Do not use the latest API version for NetBox - Select whether to use the latest API version for NetBox.
    • If selected, the adapter will connect with an NetBox API version below v3.0.
    • If cleared, the adapter will attempt to connect to API versions 3.0 and later.
  7. Do not include Domain in Hostname (optional) - Select to not include the domain within the hostname.
  8. Fetch active devices only - Select to only fetch active devices.


Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.