[Index]

Model: data/DeviceModelMapping

Mapping from device connection parameters to model type

Model Details

Title Description Details
Name The name of the device that we are mapping. This is typically used in device dropdowns.
  • Field Name: name
  • Type: String
Connection Parameters Type * Type of connection parameters to use
  • Field Name: connection_parameters_type
  • Type: String
Device Model Type * Device model type to be managed
  • Field Name: device_model_type
  • Type: String
Generic Should the generic driver be used for this mapping?
  • Field Name: generic
  • Type: Boolean
Dynamic Schema When dynamic_schema is True, schema will be imported before each data import
  • Field Name: dynamic_schema
  • Type: Boolean
Override Model Model that can be used to override fields on the connection parameters
  • Field Name: override_model
  • Type: String
  • Target: data/DataModel
  • Target attr: name
  • Format: uri
Allow in NDL When Allow in NDL is True, the device will be allowed in the list of devices in a NDL (Network Device List)
  • Field Name: allow_ndl
  • Type: Boolean
Allow with Data Sync When Allow in Data Sync is True, the device will be allowed in the list of devices usable with Data Sync
  • Field Name: allow_data_sync
  • Type: Boolean
Default Connection Parameters Default parameters to use for connection if there are none defined
  • Field Name: default_helper_params
  • Type: Object
Host Name The host name of the device
  • Field Name: default_helper_params.host
  • Type: String
Port The port to use to connect to the device
  • Field Name: default_helper_params.port
  • Type: String
Admin Username The username to authenticate with the device API
  • Field Name: default_helper_params.username
  • Type: String
Admin Password The password to authenticate with the device API (the text will be hidden)
  • Field Name: default_helper_params.password
  • Type: String
  • Is Password: True
Version The version of the device API
  • Field Name: default_helper_params.version
  • Type: String
Base URL The base URL for the API
  • Field Name: default_helper_params.base_url
  • Type: String
API reference for data/DeviceModelMapping