NetBox

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
• Networks

Parameters

1. NetBox Domain (required) - The hostname or IP Address of the NetBox server.
2. Custom NetBox Domain Path Prefix (optional) - If you have configured a custom path prefix for the NetBox API, enter it here. The path should not include /api at the end, as this is automatically added by the adapter. For example, if your NetBox API is located at mydomain.com/netbox_services/api, enter the value netbox_services in this field.
3. Authentication Token (optional) - Use the API key you have generated, if required.
4. 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.
5. 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.

Advanced Settings

1. NetBox role include list (optional) - Enter a comma-separated list of NetBox roles. Note that values are case-sensitive.
2. NetBox tenant include list (optional) - Enter a comma-separated list of NetBox tenants. Note that values are case-sensitive.
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 - Select this option to also fetch custom fields for devices.
6. Do not include Domain in Hostname (optional) - Select to not include the domain within the hostname.
7. Fetch active devices only - Select to only fetch active devices.
8. Include contacts info for devices - Select this option to fetch contacts associated with each device (Contacts - NetBox Documentation).
   
   

Required Permissions

Users must have View permissions in order to fetch assets, as per NetBox Documentation - Permissions.

• "NetBox will check for the dcim.view_device permission to fetch devices. If the user has not been assigned this permission (either directly or via a group assignment), NetBox will return a 403 (forbidden) HTTP response."

• "Internally, in NetBox, all actions granted by a permission (both built-in and custom) are stored as strings in an array field named actions."