Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • task_variables : dict
  • is_triggered : bool
  • trigger_id : str
  • instance_id : str
  • monitor_id : str

Examples


Code Block
languagepy
titleExample
>>> ops_task_id = self.uip.task_variables['ops_task_id']
>>> is_triggered = self.uip.is_triggered
>>> trigger_id = self.uip.trigger_id
>>> instance_id = self.uip.instance_id
>>> monitor_id = self.uip.monitor_id


...

Methods

extension_start (self, fields)

Serves as the starting point for work that will be performed for a task instance. It must be implemented in the derived class.

...

once the work is done, an instance of ExtensionResult must be returned. See the ExtensionResult documentation for a full list of parameters that can be passed to the class constructor

...

extension_cancel (self)

Optional method that allows the Extension to do any cleanup work before terminating. To use it, implement in the derived class.

Parameters

None

Returns

None

...

update_extension_status (self, fields)

Propagate state changes back to the associated extension instance in the Controller.

...

The fields parameter expects a dictionary of output fields to be sent back to the controller for the associated Extension instance. Field names are implementation dependent and correlate with the Universal Template field names in the Controller's Template definition for the associated task.

Returns

None

...


Code Block
languagepy
titleExample
>>> fields = {"foo": "bar"}

...


>>> self.update_extension_status(fields)