[Index]

Model: data/DataCollection

Lightweight collection of data from external sources

Model Details: data/DataCollection

Title Description Details
Name * The name of this data collection.
  • Field Name: name
  • Type: String
Description The description of this data collection.
  • Field Name: description
  • Type: String
Method * Default: collect
  • Field Name: method
  • Type: String
  • Default: collect
  • Choices: ["Collect", "Purge"]
Device model types
  • Field Name: device_model_types.[n]
  • Type: Array
Device Model Type *
  • Field Name: device_model_types.[n].device_model_type
  • Type: String
Connection Parameters *
  • Field Name: device_model_types.[n].connection_parameters
  • Type: String
Create Automate Resources * Create a resource in Automate for each collected record. Default: True
  • Field Name: device_model_types.[n].create_automate_resources
  • Type: Boolean
  • Default: True
Create Standalone Records * Create a standalone record for each collected record. Default: True
  • Field Name: device_model_types.[n].create_standalone_records
  • Type: Boolean
  • Default: True
Standalone Records Expiry Field Standalone records will be removed from the database when the value of the expiry field shows that the record is older than the number of seconds configured. This must be a data field.
  • Field Name: device_model_types.[n].standalone_expiry_field
  • Type: String
Standalone Records Expiry Field Date Format The expiry field will be interpreted as a date using this python datetime format. If %f is used, note that mongo does not support microseconds so the stored value will have millisecond resolution. Default: %Y-%m-%dT%H:%M:%S.%fZ
  • Field Name: device_model_types.[n].standalone_expiry_field_date_format
  • Type: String
  • Default: %Y-%m-%dT%H:%M:%S.%fZ
Standalone Records Expiry Seconds Standalone records will be removed from the database when the value of the expiry field shows that the record is older than the number of seconds configured.
  • Field Name: device_model_types.[n].standalone_expiry_seconds
  • Type: Integer
Move Configuration Configures matching to existing records to determine move destination.
  • Field Name: move_config.[n]
  • Type: Array
Source Model Field
  • Field Name: device_model_types.[n].move_config.[n].left_field
  • Type: String
Source Model Field Regex The first unnamed capture group in the regex will be used to match
  • Field Name: device_model_types.[n].move_config.[n].left_field_regex
  • Type: String
Matched Model Type
  • Field Name: device_model_types.[n].move_config.[n].right_model_type
  • Type: String
Matched Model Field
  • Field Name: device_model_types.[n].move_config.[n].right_field
  • Type: String
Matched Model Field Regex The first unnamed capture group in the regex will be used to match
  • Field Name: device_model_types.[n].move_config.[n].right_field_regex
  • Type: String