Docs

Device42

Suggest Edits

About

The Device42 NetoFuse module provides enriched asset context to Netography Fusion from the Device42 asset management platform. It connects to the Device42 API to retrieve asset information from the Devices table and then uploads it as Context Labels to the Netography Fusion API.

☁️

NetoFuse Modules: Cloud deployment vs. On-Prem deployment

This page documents how to add and configure the NetoFuse module for an on-prem deployment with a container or Python package. If you want to use the cloud deployment model and have this integration run in the Netography Fusion SaaS, you can add it as a context integration in the Netography Fusion Portal instead by consulting the Context Integrations documentation.

API Configuration Parameters

All the fields required for this integration are listed here, along with the corresponding environment variable name used to set that field in the NetoFuse module.

Device42 FieldRequiredNetoFuse Environment VariableDescription
URLYesNETO__DEVICE42__URLURL to Device42 API
Client KeyYesNETO__DEVICE42__CREDENTIALS__CLIENT_KEYDevice42 Token Authentication Client Key
Client SecretYesNETO__DEVICE42_CREDENTIALS__CLIENT_SECRETDevice42 Token Authentication Client Secret
UsernameNoNETO__DEVICE42__CREDENTIALS__USERNAMEDevice42 User Authentication Username, if used instead of Token Authentication
PasswordNoNETO__DEVICE42__CREDENTIALS__PASSWORDDevice42 User Authentication Password, if used instead of Token Authentication

Selecting Token Authentication or User Authentication

Device42 can use either Token Authentication or User Authentication to connect to the API. Token authentication is the recommended approach for a production deployment.

The Username and Password fields are not required if token authentication is used (and conversely, the Client Key and Client Secret fields are not required if User authentication is used).

Device42 Configuration

Follow Device42 instructions to generate a Client Key and Client Secret for a production deployment as documented here: https://api.device42.com/#API_Authentication

device42 NetoFuse Module Configuration

All the fields required for this integration are listed above in the API Configuration Parameters section above. See Configure > module for additional options for setting configuration fields and Credential Storage for additional options for setting credentials.

Advanced Configuration Options

The device42 module gathers asset information from the Devices API endpoints. By default, this uses the /api/2.0/devices/ API endpoint to retrieve all assets and all available fields. The fields that are used for context labels are then limited by the transform.

The params: section passes the key:valueset to the Device42 as parameters to the API call. In this section, set the include_cols key to limit what fields are returned for retrieved assets, and set additional parameters to filter what assets are retrieved. The list of available parameters are in the Device42 API documentation: Device42 API Guide > Devices > Get all v2

default device42 module configuration

  device42:
    url:
    ip_fields: ip,mac_address,label
    fetch_devices: false
    per_page: 1000 # Max is 1000
    credentials:
      username:
      password:
    transform:
      ip:
        context: ip
      ips:
        context: ip
      device_id:
        context: DeviceID
      serial_no:
        context: serial_number
      available:
        context: Available
      mac_id:
        context: mac_id
      mac_address:
        context: mac_addr
      last_updated:
        context: Last_Updated
      device:
        context: Device
      label:
        context: Label
      subnet:
        context: Subnet
      port_name:
        context: Port_Name
      port_id:
        context: Port_ID
      ip_type:
        context: IP_Type
      tags:
        context: Tags

Updated 6 months ago