manual:api:reference:script:object

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
manual:api:reference:script:object [2021/01/27 21:18]
127.0.0.1 external edit
manual:api:reference:script:object [2021/01/29 13:40] (current)
Andrejs.Griscenko
Line 18: Line 18:
 | **type** \\ (required) | integer | Script type. \\ \\ Possible values: \\ 0 - Script; \\ 1 - IPMI; \\ 5 - //​(default)//​ Webhook. | | **type** \\ (required) | integer | Script type. \\ \\ Possible values: \\ 0 - Script; \\ 1 - IPMI; \\ 5 - //​(default)//​ Webhook. |
 | usrgrpid | string | ID of the user group that will be allowed to run the script. If set to 0, the script will be available for all user groups. \\ \\ Default: 0. | | usrgrpid | string | ID of the user group that will be allowed to run the script. If set to 0, the script will be available for all user groups. \\ \\ Default: 0. |
-| timeout | string | Webhook script timeout. Accepts ​seconds ​and time unit with suffix. \\ \\ Possible values: \\ 1-60s \\ \\ Default value: \\ 30s |+| timeout | string | Webhook script ​execution ​timeout ​in seconds. Time suffixes are supported, e.g. 30s, 1m. \\ \\ Possible values: \\ 1-60s \\ \\ Default value: \\ 30s |
 | parameters | array  | Array of [[manual:​api:​reference:​script:​object#​Webhook parameters|webhook input parameters]]. | | parameters | array  | Array of [[manual:​api:​reference:​script:​object#​Webhook parameters|webhook input parameters]]. |
  
 ==== Webhook parameters ==== ==== Webhook parameters ====
  
-Parameters passed to webhook script when it is calledhave the following properties.+Parameters passed to webhook script when it is called have the following properties.
  
 ^ Property ^ [[:​manual/​api/​reference_commentary#​data_types|Type]] ^ Description ^ ^ Property ^ [[:​manual/​api/​reference_commentary#​data_types|Type]] ^ Description ^
 | **name** \\ (required) | string | Parameter name. | | **name** \\ (required) | string | Parameter name. |
-| value | string | Parameter value, support macrosSupported macros described on [[manual:​appendix:​macros:​supported_by_location|page]]. |+| value | string | Parameter value. ​Supports ​[[manual:​appendix:​macros:​supported_by_location|macros]]. |
  
 ==== Debug ==== ==== Debug ====
  
-Debug information of executed ​script of webhook ​type. The debug object has the following properties.+Debug information of executed webhook ​script. The debug object has the following properties.
  
 ^ Property ^ [[:​manual/​api/​reference_commentary#​data_types|Type]] ^ Description ^ ^ Property ^ [[:​manual/​api/​reference_commentary#​data_types|Type]] ^ Description ^
Line 42: Line 42:
  
 ^ Property ^ [[:​manual/​api/​reference_commentary#​data_types|Type]] ^ Description ^ ^ Property ^ [[:​manual/​api/​reference_commentary#​data_types|Type]] ^ Description ^
-| level | integer | Log level. ​\\ \\ Possible values: \\ 1-6 +| level | integer | Log level. | 
-| ms | string | The elapsed ​time since the script was run when the log entry was recorded. |+| ms | string | The time elapsed ​in milliseconds ​since the script was run before ​log entry was added. |
 | message | string | Log message. | | message | string | Log message. |