- 15 Mar 2023
- 2 Minutes to read
-
Print
-
DarkLight
-
PDF
NetBox
- Updated on 15 Mar 2023
- 2 Minutes to read
-
Print
-
DarkLight
-
PDF
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
-
NetBox Domain (required) - The hostname or IP Address of the NetBox server.
-
Authentication Token (optional) - Use the API key you have generated, if required.
-
Verify SSL - Select to verify the SSL certificate offered by the value supplied in NetBox Domain. For more details, see SSL Trust & CA Settings.
-
HTTPS Proxy (optional) - A proxy to use when connecting to the value supplied in NetBox Domain.
-
For details on the common adapter connection parameters and buttons, see Adding a New Adapter Connection.
Advanced Settings
From Version 4.6, 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.
- 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.
- 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.
- Fetch virtual machines - Select to include virtual machines in the fetch.
- Fetch IPAM IPs - Select to fetch all known IPs with their hostnames.
- Include custom fields for devices (default: false) - Select this option to also fetch custom fields for devices.
- 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.
- Do not include Domain in Hostname (optional) - Select to not include the domain within the hostname.
- Fetch active devices only - Select to only fetch active devices.