Skip to main content

DIP dip.yaml

Introduction​

This document describes the required and possible auxiliary configuration parameters for the Device Integration Package (aka DIP). These parameters reside in the dip.yaml file found in the DIP package's root folder.

Required configuration items​

The following configuration items define the minimal set of options required for a functional DIP package.

name: dip_name
version: 1.0.0
commands:
  get_state: "${DIP_ROOT}/get_state_script"
  get_status: "${DIP_ROOT}/get_status_script"

name​

This name configuration item is the given name of the Job Package.

version​

The version configuration item is the version of the Job Package and is used to determine if the new job package has been updated and requires replacement within the download cache.

commands stanza​

  • get_state​

    This is the path to the script called by the agent when executing the get_state call. While similar to get_status, it is not required to be non-invasive and can return more information about the device, such as platform name, OS version, etc. The response must be JSON in the form. The script must, at minimum, print the current state of the device in the form of a JSON string, e.g. {"status":"online"}.

  • get_status​

    This is the path to the script called by the agent when executing the get_status call. The get_status function is intended to be a minimally invasive or non-invasive check of the device's current status and only returns the current state. The script must return the status of the device in the form of a JSON string, e.g. {"status":"online"}

Optional configuration options​

commands:
  finalize: "${DIP_ROOT}/finalize_script"
  get_metrics: "${DIP_ROOT}/get_metrics_script"
  initialize: "${DIP_ROOT}/initialize_script"
  install: "${DIP_ROOT}/install_script"

commands stanza​

  • finalize​

    This is the path to an optional script that will be called when the Agent shuts down. It is typically used to turn off or disable resources that were enabled or turned on in the initialize script.

  • get_metrics​

    This is the path to an optional script that will be called when the Agent pulls metrics from the device.

  • initialize​

    This is the path to an optional script that will be called when the Agent is first started. It can turn on or enable peripherals or resources required by the DIP.

  • install​

    This is the path to an optional script that will be called when the DIP is installed or updated. This script can used to install resources required by the DIP for proper operation.