callback.ospp

Callback property

type

object

properties

  • isTemplateGeneratedByOspComposer

Name of the playbook that generated this file. If present, the file is managed by the Composer and may be overwritten on regeneration. Used for selective clean. Do not edit or set manually.

type

string

  • linkedOutputs

The list of outputs to link to this callback

type

array

items

ValueOutputConfigurationEntity

  • retry

The retry handling configuration

Default value is [{“delay”:{“unit”:”SECONDS”,”value”:10},”number”:3}]

default

delay

unit

SECONDS

value

10

number

3

RetryConfiguration

  • templateId

The id of the template to use for this file

type

string

  • templateVariables

The variables and their values to be replaced from the template

type

object

additionalProperties

  • variablesFiles

The variables files to use to replace the variables. The first file of the list will take precedence over the following one. Template variables take precedence over the contents of the files.

type

array

items

type

string

additionalProperties

False

ValueOutputConfigurationEntity

type

object

properties

  • accessedValues

The list of declared accessed values by condition and transform. The wildcard ‘*’ can be used to match multiple value (For example, ‘root.*.test’ will match ‘root.device.1.test’, ‘root.server.test’).

type

array

items

type

string

  • condition

The condition the value must fulfill to trigger the output

type

string

  • outputId

The id of the output

type

string

  • retry

The retry handling configuration

RetryConfiguration

  • transform

The transformation to apply to the value before triggering the output

type

string

  • transformType

The type to apply after the transformation of the triggering output

type

string

enum

BOOLEAN, INTEGER, DECIMAL, TEXT

additionalProperties

False

RetryConfiguration

type

object

properties

  • delay

The delay between retry to do when the output action fail. If a new value is publish during the delay, the previous execution will be canceled.

DurationConfigurationEntity

  • number

The maximum number of retry to do when the output action fail

type

integer

additionalProperties

False

DurationConfigurationEntity

type

object

properties

  • unit

The unit of time expressed

type

string

enum

NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS

  • value

The amount of time expressed with the unit

type

integer

additionalProperties

False