DLI DC3 Object Model Reference
|
object | autoping/ |
Object representing the autoping server state and configuration |
Retrieving the value is denied if not administrative user
This object contains the following items:
Sample JS request
read command:
request.get({url:"autoping/"},function(error,response,body) {console.log(body)});
⇒
<...>
Sample curl
write command:
curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "..." "http://192.168.0.100/restapi/autoping/"
sum (boolean) | autoping/enabled/ |
Autoping global enable status |
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true | Enabled | The feature is enabled | |
constant false | Disabled | The feature is disabled |
Sample CLI read command:
uom get "autoping/enabled"
⇒
true
Sample JS request
write command:
request.put({url:"autoping/enabled/",body:true});
array | autoping/items/ |
Autoping item list |
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This array represents a value in persistent storage.
This array contains Autoping item data elements.
Sample requests
read command:
print(requests.get('http://192.168.0.100/restapi/autoping/items/',auth=auth,headers=headers).json())
⇒
<...>
Sample JS request
write command:
request.put({url:"autoping/items/",body:[{"enabled":false,"script":"shut_down_heaters","outlets":[1,5],"addresses":["http://4.184.8.247/eifv/IZm0/QaHQ/v-AkznDrZ","230.155.255.1"],"pings_before_enabling":null}]});
object | autoping/items/N/ |
Data related to autoping item state and configuration |
Retrieving the value is denied if not administrative user
This object contains the following items:
Sample requests
write command (note that _autoping_item_data_index
is a variable):
requests.put('http://192.168.0.100/restapi/autoping/items/'+str(_autoping_item_data_index)+'/',auth=auth,headers=headers,json={'script': '', 'outlets': [0, 1, 3, 7], 'addresses': ['https://170.125.120.244/s5MU/KZeN/ftVDhvzW', 'tcp://228.251.252.3:34363'], 'pings_before_enabling': None})
Sample JS request
deletion command (note that _autoping_item_data_index
is a variable):
request.delete({url:"autoping/items/"+_autoping_item_data_index.toString()+"/"});
See also Autoping item data: Enabled status
See also Autoping item data: Address list
See also Autoping item data: Controlled outlets
See also Autoping item data: Script command, if any
See also Autoping item data: Request item state change
See also Autoping item data: Autoping item status
See also Autoping item data: Pings remaining to enable, if any
See also Autoping item data: Recently failed
See also Autoping item data: In resumption trial
sum (boolean) | autoping/items/N/enabled/ |
Whether this item is enabled (can be triggered) |
Retrieving the value is denied if not administrative user
This sum does not support direct modification.
This sum represents a value in persistent storage.
This sum can change as if by itself or indirectly because of other actions.
This sum can assume the following values:
constant true | Enabled | The feature is enabled | |
constant false | Disabled | The feature is disabled |
Sample uom
library read command (note that _autoping_item_data_index
is a variable):
print(uom.dump(uom.autoping.items[_autoping_item_data_index].enabled))
⇒
false
Sample curl
read command (note that :autoping_item_data_index
is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/autoping/items/:autoping_item_data_index/enabled/"
⇒
true
array | autoping/items/N/addresses/ |
List of addresses to ping |
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This array is composite, i.e. is modified as a whole.
This array represents a value in persistent storage.
This array represents an unordered set (order of its elements doesn't matter, and each value should not be supplied more than once).
This array contains Address elements.
Sample CLI write command (note that autoping_item_data_index
is a variable):
uom set "autoping/items/${autoping_item_data_index}/addresses" "[\"tcp://227.251.60.222:10180\"]"
Sample requests
write command (note that _autoping_item_data_index
is a variable):
requests.put('http://192.168.0.100/restapi/autoping/items/'+str(_autoping_item_data_index)+'/addresses/',auth=auth,headers=headers,json=['tcp://GhwU.example.com:63176', 'tcp://VVbs9.3XDXdv.bofLF.OBoNKBS.x3JqD.example.com:17465'])
string | autoping/items/N/addresses/N/ |
URL to ping (default schema is icmp) |
The value is subject to the following constraints: address list are distinct
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This string is a part of a composite value which is modified as a whole.
This string represents a value in persistent storage.
Sample uom
library read command (note that _autoping_item_data_index
and _address_index
are variables):
print(uom.dump(uom.autoping.items[_autoping_item_data_index].addresses[_address_index]))
⇒
"http://2.7.212.44"
Sample JS request
deletion command (note that _autoping_item_data_index
and _address_index
are variables):
request.delete({url:"autoping/items/"+_autoping_item_data_index.toString()+"/addresses/"+_address_index.toString()+"/"});
array | autoping/items/N/outlets/ |
List of outlets to perform specified action on |
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This array is composite, i.e. is modified as a whole.
This array represents a value in persistent storage.
This array represents an unordered set (order of its elements doesn't matter, and each value should not be supplied more than once).
This array contains Outlet index elements.
Sample requests
write command (note that _autoping_item_data_index
is a variable):
requests.put('http://192.168.0.100/restapi/autoping/items/'+str(_autoping_item_data_index)+'/outlets/',auth=auth,headers=headers,json=[0])
Sample curl
outlet index creation command (note that :autoping_item_data_index
is a URL template argument):
curl --digest -u admin:1234 -H "X-CSRF: x" -H "Content-type: application/json" -H "Accept: application/json" --data-binary "5" "http://192.168.0.100/restapi/autoping/items/:autoping_item_data_index/outlets/"
number | autoping/items/N/outlets/N/ |
Index of outlet to perform action on |
The value is subject to the following constraints: all of the following is true:
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This number is a part of a composite value which is modified as a whole.
This number represents a value in persistent storage.
Sample curl
write command (note that :autoping_item_data_index
and :outlet_index_index
are URL template arguments):
curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "[]" "http://192.168.0.100/restapi/autoping/items/:autoping_item_data_index/outlets/:outlet_index_index/"
Sample CLI read command (note that autoping_item_data_index
and outlet_index_index
are variables):
uom get "autoping/items/${autoping_item_data_index}/outlets/${outlet_index_index}"
⇒
[]
sum (string) | autoping/items/N/script/ |
Action to perform on selected outlets on failure, or cycle them if empty |
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can change as if by itself or indirectly because of other actions.
This sum can assume the following values:
string | Script command | Action to perform on selected outlets on failure | all of the following is true:
|
string | Invalid action placeholder | A placeholder for a failure action that has been deleted or renamed (has no effect other than logging a warning) | the value matches ^autoping_deleted:.*$ |
constant "" | Cycle outlets | Selected outlets are to be cycled on failure |
Sample uom
library read command (note that _autoping_item_data_index
is a variable):
print(uom.dump(uom.autoping.items[_autoping_item_data_index].script))
⇒
"disable_contraption"
Sample CLI write command (note that autoping_item_data_index
is a variable):
uom set "autoping/items/${autoping_item_data_index}/script" "\"cycle_gadgets\""
call | autoping/items/N/enable/ |
Request the item to enter enabled or disabled status. Disabled status is entered immediately. If the item is disabled, enabling it is not immediate (takes a trial period). |
Performing the function call is denied if not administrative user
The call accepts the following arguments:
The call returns the following results:
Sample uom
library invocation (note that _autoping_item_data_index
is a variable):
uom.autoping.items[_autoping_item_data_index].enable(false)
⇒
(no output)
Sample requests
invocation (note that _autoping_item_data_index
is a variable):
requests.post('http://192.168.0.100/restapi/autoping/items/'+str(_autoping_item_data_index)+'/enable/',auth=auth,headers=headers,json=[True])
⇒
(no output)
sum (boolean) | autoping/items/N/enable/arguments: 1/ |
The state you request the item to switch to |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant true | Enabled | The feature is enabled | |
constant false | Disabled | The feature is disabled |
constant null | autoping/items/N/enable/results: 1/ |
No additional information available |
This constant does not correspond to an actual resource.
object | autoping/items/N/status/hosts/N/ |
State of a target subjected to ping |
This object is a part of a composite value which is modified as a whole.
This object contains the following items:
address | Address |
state | State |
state_details | State details, if any |
success_count | Success count |
failure_count | Failure count |
queue_size | Queue size |
Sample uom
library write command (note that _autoping_item_data_index
and _target_state_index
are variables):
uom.autoping.items[_autoping_item_data_index].status.hosts[_target_state_index]={address="96.82.244.82",failure_count=0,queue_size=0,state=null,state_details=null,success_count=1990}
Sample CLI read command (note that autoping_item_data_index
and target_state_index
are variables):
uom get "autoping/items/${autoping_item_data_index}/status/hosts/${target_state_index}"
⇒
{"state":null,"success_count":7852,"address":"https://255.217.82.195","state_details":null,"failure_count":0,"queue_size":0}
string | autoping/items/N/status/hosts/N/address/ |
Address that is being checked (default schema is icmp) |
The value is subject to the following constraints: address members of all values of target states are distinct
This string is a part of a composite value which is modified as a whole.
This string does not support direct modification.
This string can change as if by itself or indirectly because of other actions.
Changes to this string cannot be tracked.
Sample requests
read command (note that _autoping_item_data_index
and _target_state_index
are variables):
print(requests.get('http://192.168.0.100/restapi/autoping/items/'+str(_autoping_item_data_index)+'/status/hosts/'+str(_target_state_index)+'/address/',auth=auth,headers=headers).json())
⇒
'5.162.10.222'
Sample curl
read command (note that :autoping_item_data_index
and :target_state_index
are URL template arguments):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/autoping/items/:autoping_item_data_index/status/hosts/:target_state_index/address/"
⇒
"208.7.109.218"
sum (optional boolean) | autoping/items/N/status/hosts/N/state/ |
Target perceived state |
Retrieving the value is denied if not administrative user
This sum is a part of a composite value which is modified as a whole.
This sum does not support direct modification.
This sum can change as if by itself or indirectly because of other actions.
Changes to this sum cannot be tracked.
This sum can assume the following values:
constant true | Online | The target is responding to ping requests | |
constant false | Offline | The target is not responding to ping requests | |
constant null | Unknown | Not enough information about target state |
Sample requests
read command (note that _autoping_item_data_index
and _target_state_index
are variables):
print(requests.get('http://192.168.0.100/restapi/autoping/items/'+str(_autoping_item_data_index)+'/status/hosts/'+str(_target_state_index)+'/state/',auth=auth,headers=headers).json())
⇒
None
Sample curl
read command (note that :autoping_item_data_index
and :target_state_index
are URL template arguments):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/autoping/items/:autoping_item_data_index/status/hosts/:target_state_index/state/"
⇒
null
sum (optional string) | autoping/items/N/status/hosts/N/state_details/ |
Additional information of target state, if any |
This sum is a part of a composite value which is modified as a whole.
This sum does not support direct modification.
This sum can change as if by itself or indirectly because of other actions.
Changes to this sum cannot be tracked.
This sum can assume the following values:
constant null | No details | No additional information available | |
string | State details | Additional information of target state |
Sample requests
read command (note that _autoping_item_data_index
and _target_state_index
are variables):
print(requests.get('http://192.168.0.100/restapi/autoping/items/'+str(_autoping_item_data_index)+'/status/hosts/'+str(_target_state_index)+'/state_details/',auth=auth,headers=headers).json())
⇒
None
Sample uom
library read command (note that _autoping_item_data_index
and _target_state_index
are variables):
print(uom.dump(uom.autoping.items[_autoping_item_data_index].status.hosts[_target_state_index].state_details))
⇒
"Cannot communicate with tcp://254.179.211.204:63239"
number | autoping/items/N/status/hosts/N/success_count/ |
Number of times this target has responded to a ping request in time |
The value represents count, the standard unit of which is the time (times).
The value is subject to the following constraints: all of the following is true:
Retrieving the value is denied if not administrative user
This number is a part of a composite value which is modified as a whole.
This number does not support direct modification.
This number can change as if by itself or indirectly because of other actions.
Changes to this number cannot be tracked.
Sample curl
read command (note that :autoping_item_data_index
and :target_state_index
are URL template arguments):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/autoping/items/:autoping_item_data_index/status/hosts/:target_state_index/success_count/"
⇒
0
Sample CLI read command (note that autoping_item_data_index
and target_state_index
are variables):
uom get "autoping/items/${autoping_item_data_index}/status/hosts/${target_state_index}/success_count"
⇒
1048
number | autoping/items/N/status/hosts/N/failure_count/ |
Number of times this target has failed to respond to a ping request in time |
The value represents count, the standard unit of which is the time (times).
The value is subject to the following constraints: all of the following is true:
Retrieving the value is denied if not administrative user
This number is a part of a composite value which is modified as a whole.
This number does not support direct modification.
This number can change as if by itself or indirectly because of other actions.
Changes to this number cannot be tracked.
Sample CLI read command (note that autoping_item_data_index
and target_state_index
are variables):
uom get "autoping/items/${autoping_item_data_index}/status/hosts/${target_state_index}/failure_count"
⇒
520
Sample curl
read command (note that :autoping_item_data_index
and :target_state_index
are URL template arguments):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/autoping/items/:autoping_item_data_index/status/hosts/:target_state_index/failure_count/"
⇒
461
number | autoping/items/N/status/hosts/N/queue_size/ |
Number of ping requests to which no replies have yet been received (0 if the parent ping item is not enabled) |
The value represents count, the standard unit of which is the time (times).
The value is subject to the following constraints: all of the following is true:
Retrieving the value is denied if not administrative user
This number is a part of a composite value which is modified as a whole.
This number does not support direct modification.
This number can change as if by itself or indirectly because of other actions.
Changes to this number cannot be tracked.
Sample curl
read command (note that :autoping_item_data_index
and :target_state_index
are URL template arguments):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/autoping/items/:autoping_item_data_index/status/hosts/:target_state_index/queue_size/"
⇒
0
Sample requests
read command (note that _autoping_item_data_index
and _target_state_index
are variables):
print(requests.get('http://192.168.0.100/restapi/autoping/items/'+str(_autoping_item_data_index)+'/status/hosts/'+str(_target_state_index)+'/queue_size/',auth=auth,headers=headers).json())
⇒
0
object | autoping/items/N/status/ |
Information on monitored target status and reboots |
The value is unconditionally set to {"reboots":0,"hosts":[]}
on creation and doesn't have to be supplied (if it is, it must match)
Retrieving the value is denied if not administrative user
This object is composite, i.e. is modified as a whole.
This object does not support direct modification.
This object can change as if by itself or indirectly because of other actions.
Changes to this object cannot be tracked.
This object contains the following items:
hosts | Target states |
reboots | Reboot count |
Sample JS request
read command (note that _autoping_item_data_index
is a variable):
request.get({url:"autoping/items/"+_autoping_item_data_index.toString()+"/status/"},function(error,response,body) {console.log(body)});
⇒
Sample requests
read command (note that _autoping_item_data_index
is a variable):
print(requests.get('http://192.168.0.100/restapi/autoping/items/'+str(_autoping_item_data_index)+'/status/',auth=auth,headers=headers).json())
⇒
array | autoping/items/N/status/hosts/ |
States of targets associated with this item |
Retrieving the value is denied if not administrative user
This array is a part of a composite value which is modified as a whole.
This array does not support direct modification.
This array can change as if by itself or indirectly because of other actions.
Changes to this array cannot be tracked.
This array represents an unordered set (order of its elements doesn't matter, and each value should not be supplied more than once).
This array contains Target state elements.
Creating elements in this collection is not supported.
Sample CLI read command (note that autoping_item_data_index
is a variable):
uom get "autoping/items/${autoping_item_data_index}/status/hosts"
⇒
[{"state":null,"success_count":7062,"address":"http://Iz9GIm.SRydeo.3mfd6V.mJpbbw2tvBADx.Qye3d.7XRmA.Ua4oQfP.example.com:27845/WZqK/kLC1f/AyVNE/a6abrS1L/82c.PcX9-lDfs/rGG5/iv7Jm/87PIC2","state_details":null,"failure_count":831,"queue_size":4}]
Sample requests
read command (note that _autoping_item_data_index
is a variable):
print(requests.get('http://192.168.0.100/restapi/autoping/items/'+str(_autoping_item_data_index)+'/status/hosts/',auth=auth,headers=headers).json())
⇒
See also Target states: Target state
number | autoping/items/N/status/reboots/ |
Number of times this item's action has been triggered |
The value represents count, the standard unit of which is the time (times).
The value is subject to the following constraints: all of the following is true:
This number is a part of a composite value which is modified as a whole.
This number does not support direct modification.
This number can change as if by itself or indirectly because of other actions.
Changes to this number cannot be tracked.
Sample JS request
read command (note that _autoping_item_data_index
is a variable):
request.get({url:"autoping/items/"+_autoping_item_data_index.toString()+"/status/reboots/"},function(error,response,body) {console.log(body)});
⇒
3
Sample curl
read command (note that :autoping_item_data_index
is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/autoping/items/:autoping_item_data_index/status/reboots/"
⇒
7
sum (optional number) | autoping/items/N/pings_before_enabling/ |
Estimate of number of successful ping replies remaining to enable the item, if any |
The value is unconditionally set to null
on creation and doesn't have to be supplied (if it is, it must match)
Retrieving the value is denied if not administrative user
This sum does not support direct modification.
This sum can change as if by itself or indirectly because of other actions.
Changes to this sum cannot be tracked.
This sum can assume the following values:
constant null | Trial period over | Item is no longer in the trial state (it is either enabled or disabled) | |
number | Pings remaining to enable | Estimate of successful ping replies remaining to enable the item (replies from targets which have already reached the enable threshold do not count) | all of the following is true: |
Sample uom
library read command (note that _autoping_item_data_index
is a variable):
print(uom.dump(uom.autoping.items[_autoping_item_data_index].pings_before_enabling))
⇒
null
Sample requests
read command (note that _autoping_item_data_index
is a variable):
print(requests.get('http://192.168.0.100/restapi/autoping/items/'+str(_autoping_item_data_index)+'/pings_before_enabling/',auth=auth,headers=headers).json())
⇒
None
sum (boolean) | autoping/items/N/recently_failed/ |
Flag indicating whether this item has recently failed |
Retrieving the value is denied if not administrative user
This sum does not support direct modification.
This sum can change as if by itself or indirectly because of other actions.
Changes to this sum cannot be tracked.
This sum can assume the following values:
constant true | Recently failed | The item has failed recently, and a new failure would be counted as consecutive | |
constant false | Normal operation | The item is in normal operational state |
Sample uom
library read command (note that _autoping_item_data_index
is a variable):
print(uom.dump(uom.autoping.items[_autoping_item_data_index].recently_failed))
⇒
{}
Sample curl
read command (note that :autoping_item_data_index
is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/autoping/items/:autoping_item_data_index/recently_failed/"
⇒
[]
sum (boolean) | autoping/items/N/resumption_trial/ |
Flag indicating whether this item is being tried after service restoration |
Retrieving the value is denied if not administrative user
This sum does not support direct modification.
This sum can change as if by itself or indirectly because of other actions.
Changes to this sum cannot be tracked.
This sum can assume the following values:
constant true | In resumption trial | Item is being tried after service restoration (failures don't cause it to trigger until the required amount of requests succeed) | |
constant false | Normal operation | The item is in normal operational state, and may be triggered by failures |
Sample JS request
read command (note that _autoping_item_data_index
is a variable):
request.get({url:"autoping/items/"+_autoping_item_data_index.toString()+"/resumption_trial/"},function(error,response,body) {console.log(body)});
⇒
[]
Sample requests
read command (note that _autoping_item_data_index
is a variable):
print(requests.get('http://192.168.0.100/restapi/autoping/items/'+str(_autoping_item_data_index)+'/resumption_trial/',auth=auth,headers=headers).json())
⇒
{}
number | autoping/ping_interval/ |
Interval between consecutive pings to the same address |
The value represents time, the standard unit of which is the second (s).
The value is subject to the following constraints: the value is greater than 0
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This number represents a value in persistent storage.
Sample CLI write command:
uom set "autoping/ping_interval" "2"
Sample uom
library read command:
print(uom.dump(uom.autoping.ping_interval))
⇒
5
number | autoping/ping_timeout/ |
Absence of response this long means the ping has timed out |
The value represents time, the standard unit of which is the second (s).
The value is subject to the following constraints: the value is greater than 0
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This number represents a value in persistent storage.
Sample curl
write command:
curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "37" "http://192.168.0.100/restapi/autoping/ping_timeout/"
Sample requests
read command:
print(requests.get('http://192.168.0.100/restapi/autoping/ping_timeout/',auth=auth,headers=headers).json())
⇒
133
number | autoping/post_reboot_delay/ |
Time to wait after triggering the autoping action before pinging again |
The value represents time, the standard unit of which is the second (s).
The value is subject to the following constraints: the value is greater than 0
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This number represents a value in persistent storage.
Sample requests
write command:
requests.put('http://192.168.0.100/restapi/autoping/post_reboot_delay/',auth=auth,headers=headers,json=92)
Sample JS request
read command:
request.get({url:"autoping/post_reboot_delay/"},function(error,response,body) {console.log(body)});
⇒
201
sum (number) | autoping/max_reboot_count/ |
Default maximum total number of times to perform the autoping action on an entry before giving up, if any |
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can assume the following values:
number | Maximum total reboot count | Maximum total number of times to perform the autoping action on an entry before giving up (counter does not get reset if response is received) | all of the following is true: |
constant 0 | Retry indefinitely | Perform the autoping action indefinitely no matter how many reboot attempts yielded no response |
Sample requests
write command:
requests.put('http://192.168.0.100/restapi/autoping/max_reboot_count/',auth=auth,headers=headers,json=7)
Sample CLI read command:
uom get "autoping/max_reboot_count"
⇒
6
sum (number) | autoping/max_consecutive_reboot_count/ |
Default maximum consecutive number of times to perform the autoping action on an entry before giving up, if any |
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can assume the following values:
number | Maximum consecutive reboot count | Maximum consecutive number of times to perform the autoping action on an entry before giving up (counter gets reset if response is received) | all of the following is true: |
constant 0 | Retry indefinitely | Perform the autoping action indefinitely no matter how many consecutive reboot attempts yielded no response |
Sample uom
library write command:
uom.autoping.max_consecutive_reboot_count=64
Sample curl
read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/autoping/max_consecutive_reboot_count/"
⇒
34
number | autoping/pings_before_enabling/ |
Minimum number of successful ping responses before enabling an autoping entry |
The value represents count, the standard unit of which is the time (times).
The value is subject to the following constraints: all of the following is true:
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This number represents a value in persistent storage.
Sample CLI read command:
uom get "autoping/pings_before_enabling"
⇒
8
Sample JS request
read command:
request.get({url:"autoping/pings_before_enabling/"},function(error,response,body) {console.log(body)});
⇒
10
sum (boolean) | autoping/resume_without_retrial/ |
Activate enabled entries when service is restored without waiting for a certain number of successful ping responses |
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true | Enabled | The feature is enabled | |
constant false | Disabled | The feature is disabled |
Sample requests
write command:
requests.put('http://192.168.0.100/restapi/autoping/resume_without_retrial/',auth=auth,headers=headers,json=False)
Sample uom
library write command:
uom.autoping.resume_without_retrial=false
sum (boolean) | autoping/handle_failures_immediately/ |
Detect and act upon explicit failures (e.g. TCP port closed response, HTTP 500, etc.) immediately instead of waiting for timeout |
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true | Enabled | The feature is enabled | |
constant false | Disabled | The feature is disabled |
Sample curl
read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/autoping/handle_failures_immediately/"
⇒
true
Sample CLI read command:
uom get "autoping/handle_failures_immediately"
⇒
true
call | autoping/reset_statistics/ |
Clear the statistics (item success, failure and reboot counters) |
Performing the function call is denied if not administrative user
The call has no arguments (supply empty tuple).
The call returns the following results:
Sample CLI invocation:
uom invoke "autoping/reset_statistics"
⇒
(no output)
Sample requests
invocation:
requests.post('http://192.168.0.100/restapi/autoping/reset_statistics/',auth=auth,headers=headers,json={})
⇒
(no output)
constant null | autoping/reset_statistics/results: 1/ |
No additional information available |
This constant does not correspond to an actual resource.
object | autoping/notifications/ |
Autoping status notifications |
Retrieving the value is denied if not administrative user
This object does not support direct modification.
This object contains the following items:
parameter_kinds | Parameter kinds |
events | Events |
Sample JS request
read command:
request.get({url:"autoping/notifications/"},function(error,response,body) {console.log(body)});
⇒
<...>
Sample uom
library read command:
print(uom.dump(uom.autoping.notifications))
⇒
<...>
See also Notifications: Parameter kinds
map | autoping/notifications/events/ |
Event templates |
Retrieving the value is denied if not administrative user
This map is composite, i.e. is modified as a whole.
This map does not support direct modification.
This map contains Event elements.
Creating elements in this collection is not supported.
Sample requests
read command:
print(requests.get('http://192.168.0.100/restapi/autoping/notifications/events/',auth=auth,headers=headers).json())
⇒
<...>
Sample uom
library read command:
print(uom.dump(uom.autoping.notifications.events))
⇒
<...>
See also Events: Event
object | autoping/notifications/parameter_kinds/ |
Kinds of event parameters |
This object does not correspond to an actual resource.
This object contains the following items:
string | autoping/notifications/parameter_kinds/ping_address/ |
Address of ping target |
sum (variant) | autoping/notifications/parameter_kinds/ping_state/ |
State of the target ping request |
This sum can assume the following values:
constant true | Reachable | The target has responded to the ping | |
constant false | Unreachable | The ping has timed out | |
constant "sent" | Sent | The ping has been sent but no response yet seen, and timeout not reached |
number | autoping/notifications/parameter_kinds/ping_ping_time/ |
The time it took to arrive at this ping state |
The value represents time, the standard unit of which is the second (s).
The value is subject to the following constraints: the value is greater or equal to 0
number | autoping/notifications/parameter_kinds/ping_ping_timeout/ |
The time after which the ping is considered unsuccessful if no response seen |
The value represents time, the standard unit of which is the second (s).
The value is subject to the following constraints: the value is greater than 0
sum (variant) | autoping/notifications/parameter_kinds/ping_item_state/ |
State of the autoping item |
This sum can assume the following values:
constant true | Enabled | The autoping item is enabled | |
constant false | Disabled | The autoping item is disabled | |
constant "enabling" | Enabling | The autoping item is in trial state |
string | autoping/notifications/parameter_kinds/ping_item_name/ |
Name of the autoping item |
string | autoping/notifications/parameter_kinds/ping_item_script_name/ |
Name of the scripting function associated with the autoping item |
string | autoping/notifications/parameter_kinds/ping_item_addrs/ |
Comma-separated list of addresses belonging to this item |
number | autoping/notifications/parameter_kinds/ping_item_total_failure_count/ |
Total number of times the item has failed |
The value represents count, the standard unit of which is the time (times).
The value is subject to the following constraints: all of the following is true:
number | autoping/notifications/parameter_kinds/ping_item_consecutive_failure_count/ |
Number of times the item has failed consecutively |
The value represents count, the standard unit of which is the time (times).
The value is subject to the following constraints: all of the following is true:
sum (optional number) | autoping/notifications/parameter_kinds/ping_item_max_total_failure_count/ |
Number of total failures after which the item becomes disabled, if any |
This sum can assume the following values:
constant null | Retry indefinitely | The action will be performed regardless of the number of total failures | |
number | Maximum total failure count | Number of total failures after which the item becomes disabled | all of the following is true: |
sum (optional number) | autoping/notifications/parameter_kinds/ping_item_max_consecutive_failure_count/ |
Number of consecutive failures after which the item becomes disabled, if any |
This sum can assume the following values:
constant null | Retry indefinitely | The action will be performed regardless of the number of consecutive failures | |
number | Maximum consecutive failure count | Number of consecutive failures after which the item becomes disabled | all of the following is true: |
number | autoping/notifications/parameter_kinds/ping_item_pings_before_enabling/ |
Number of successful pings left to enable the autoping item |
The value represents count, the standard unit of which is the time (times).
The value is subject to the following constraints: all of the following is true:
object | autoping/notifications/events/S/parameters/N/ |
Properties of a parameter associated with the event |
This object is a part of a composite value which is modified as a whole.
This object contains the following items:
id | Identifier |
has_fixed_value | Fixed value flag |
fixed_value | Fixed value |
Sample uom
library write command (note that _event
and _event_parameter_index
are variables):
uom.autoping.notifications.events[_event].parameters[_event_parameter_index]={fixed_value=null,has_fixed_value=false,id="ping_address"}
Sample JS request
read command (note that _event
and _event_parameter_index
are variables):
request.get({url:"autoping/notifications/events/"+_event+"/parameters/"+_event_parameter_index.toString()+"/"},function(error,response,body) {console.log(body)});
⇒
{"fixed_value":null,"has_fixed_value":false,"id":"ping_address"}
string | autoping/notifications/events/S/parameters/N/id/ |
Parameter identifier |
The value is subject to the following constraints: parameter kinds[the value]
Retrieving the value is denied if not administrative user
This string is a part of a composite value which is modified as a whole.
This string does not support direct modification.
Sample curl
read command (note that :event
and :event_parameter_index
are URL template arguments):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/autoping/notifications/events/:event/parameters/:event_parameter_index/id/"
⇒
"ping_item_state"
Sample uom
library read command (note that _event
and _event_parameter_index
are variables):
print(uom.dump(uom.autoping.notifications.events[_event].parameters[_event_parameter_index].id))
⇒
"ping_address"
sum (boolean) | autoping/notifications/events/S/parameters/N/has_fixed_value/ |
Flag indicating that the parameter's value for this event is fixed |
Retrieving the value is denied if not administrative user
This sum is a part of a composite value which is modified as a whole.
This sum does not support direct modification.
This sum can assume the following values:
constant true | Fixed | The value is fixed | |
constant false | Variable | The value is variable |
Sample requests
read command (note that _event
and _event_parameter_index
are variables):
print(requests.get('http://192.168.0.100/restapi/autoping/notifications/events/'+_event+'/parameters/'+str(_event_parameter_index)+'/has_fixed_value/',auth=auth,headers=headers).json())
⇒
False
Sample uom
library read command (note that _event
and _event_parameter_index
are variables):
print(uom.dump(uom.autoping.notifications.events[_event].parameters[_event_parameter_index].has_fixed_value))
⇒
false
sum (variant) | autoping/notifications/events/S/parameters/N/fixed_value/ |
Fixed parameter value for this particular event |
Retrieving the value is denied if not administrative user
This sum is a part of a composite value which is modified as a whole.
This sum does not support direct modification.
This sum can assume the following values:
constant null | Null | Null | |
constant true | True | True | |
constant false | False | False | |
string | String | This string | |
number | Number | This number |
Sample uom
library read command (note that _event
and _event_parameter_index
are variables):
print(uom.dump(uom.autoping.notifications.events[_event].parameters[_event_parameter_index].fixed_value))
⇒
null
Sample requests
read command (note that _event
and _event_parameter_index
are variables):
print(requests.get('http://192.168.0.100/restapi/autoping/notifications/events/'+_event+'/parameters/'+str(_event_parameter_index)+'/fixed_value/',auth=auth,headers=headers).json())
⇒
None
object | autoping/notifications/events/S/ |
Event template |
This object is a part of a composite value which is modified as a whole.
This object contains the following items:
message_template | Message template |
severity | Severity |
parameters | Event parameters |
Sample curl
write command (note that :event
is a URL template argument):
curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "{\"severity\":7,\"message_template\":[\"ping \",0,\" succeeded (\",1,\")\"],\"parameters\":[{\"fixed_value\":null,\"has_fixed_value\":false,\"id\":\"ping_address\"},{\"fixed_value\":null,\"has_fixed_value\":false,\"id\":\"ping_ping_time\"},{\"fixed_value\":true,\"has_fixed_value\":true,\"id\":\"ping_state\"}]}" "http://192.168.0.100/restapi/autoping/notifications/events/:event/"
Sample requests
read command (note that _event
is a variable):
print(requests.get('http://192.168.0.100/restapi/autoping/notifications/events/'+_event+'/',auth=auth,headers=headers).json())
⇒
array | autoping/notifications/events/S/message_template/ |
Template for human-readable message generation |
Retrieving the value is denied if not administrative user
This array is a part of a composite value which is modified as a whole.
This array does not support direct modification.
This array contains Message template element elements.
Creating elements in this collection is not supported.
Sample CLI read command (note that event
is a variable):
uom get "autoping/notifications/events/${event}/message_template"
⇒
["item ",0," (",1,") failed [",2,"/",3,"]"]
Sample curl
read command (note that :event
is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/autoping/notifications/events/:event/message_template/"
⇒
["ping ",0,": no usable route to host, possibly due to local network outage, not considered a failure unless during trial"]
sum (variant) | autoping/notifications/events/S/message_template/N/ |
Element of human-readable message template |
Retrieving the value is denied if not administrative user
This sum is a part of a composite value which is modified as a whole.
This sum does not support direct modification.
This sum can assume the following values:
string | String | Fixed string | |
number | Parameter | Index of message parameter to insert | event parameters[the value] |
Sample CLI read command (note that event
and message_template_element_index
are variables):
uom get "autoping/notifications/events/${event}/message_template/${message_template_element_index}"
⇒
0
Sample uom
library read command (note that _event
and _message_template_element_index
are variables):
print(uom.dump(uom.autoping.notifications.events[_event].message_template[_message_template_element_index]))
⇒
1
sum (enumerated number) | autoping/notifications/events/S/severity/ |
Severity rating assigned to the event |
Retrieving the value is denied if not administrative user
This sum is a part of a composite value which is modified as a whole.
This sum does not support direct modification.
This sum can assume the following values:
constant 1 | Emergency | Treat the event as an emergency | |
constant 2 | Alert | Treat the event as an alert | |
constant 3 | Critical | Treat the event as critical | |
constant 4 | Error | Treat the event as an error | |
constant 5 | Warning | Treat the event as a warning | |
constant 6 | Notice | Treat the event as a notice | |
constant 7 | Informational | Treat the event as informational | |
constant 8 | Debug | Treat the event as debugging-related |
Sample requests
read command (note that _event
is a variable):
print(requests.get('http://192.168.0.100/restapi/autoping/notifications/events/'+_event+'/severity/',auth=auth,headers=headers).json())
⇒
6
Sample CLI read command (note that event
is a variable):
uom get "autoping/notifications/events/${event}/severity"
⇒
6
array | autoping/notifications/events/S/parameters/ |
Additional data associated with the event |
Retrieving the value is denied if not administrative user
This array is a part of a composite value which is modified as a whole.
This array does not support direct modification.
This array contains Event parameter elements.
Creating elements in this collection is not supported.
Sample curl
read command (note that :event
is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/autoping/notifications/events/:event/parameters/"
⇒
Sample JS request
read command (note that _event
is a variable):
request.get({url:"autoping/notifications/events/"+_event+"/parameters/"},function(error,response,body) {console.log(body)});
⇒
See also Event parameters: Event parameter