FarmLightsOutConfiguration object

LightsOut configuration for a Farm.

Example JSON representation

{
  "autostart": true, 
  "enabled": true, 
  "notifications": [
    {
      "minutes": 1, 
      "type": "LightsOutNotification"
    }
  ], 
  "schedule": [
    {
      "daysOfWeek": [
        "sun"
      ], 
      "end": "2013-01-01T12:34:56.789Z", 
      "start": "2013-01-01T12:34:56.789Z"
    }
  ], 
  "shutdownBehavior": "terminate"
}

Properties

property attributes valid values description filter option
notifications
Array of LightsOutNotification objects
required

Sends notification before Light-Out execution.

schedule
Array of LightsOutTimeFrame objects
required

A schedule to run the Farm.

shutdownBehavior
string
required
"terminate"
"suspend"

The method to shutdown a Farm.

autostart
boolean
optional

Start a Farm automatically at the beginning of the allowed timeFrame.

enabled
boolean
optional

Whether the LightsOut should be used or not.