DLI DC3 Object Model Reference
20210819T152642Z
Autoping server object
objectautoping/
Object representing the autoping server state and configuration
dot_inline_dotgraph_425.png

Retrieving the value is denied if not administrative user

This object contains the following items:

enabledEnabled
itemsItems
ping_intervalPing interval
ping_timeoutPing timeout
post_reboot_delayPost-reboot delay
max_reboot_countDefault maximum total reboot count, if any
max_consecutive_reboot_countDefault maximum consecutive reboot count, if any
pings_before_enablingPings before enabling
resume_without_retrialResume without retrial
handle_failures_immediatelyHandle failures immediately
reset_statisticsReset statistics
notificationsNotifications

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/"

Browse more samples

Enabled

sum (boolean)autoping/enabled/
Autoping global enable status
dot_inline_dotgraph_426.png

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 trueEnabledThe feature is enabled
constant falseDisabledThe feature is disabled

Sample CLI read command:

uom get "autoping/enabled"

true

Sample JS request write command:

request.put({url:"autoping/enabled/",body:true});

Browse more samples

Items

arrayautoping/items/
Autoping item list
dot_inline_dotgraph_427.png

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}]});

Browse more samples

Autoping item data

objectautoping/items/N/
Data related to autoping item state and configuration
dot_inline_dotgraph_428.png

Retrieving the value is denied if not administrative user

This object contains the following items:

enabledEnabled status
addressesAddress list
outletsControlled outlets
scriptScript command, if any
enableRequest item state change
statusAutoping item status
pings_before_enablingPings remaining to enable, if any
recently_failedRecently failed
resumption_trialIn resumption trial

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()+"/"});

Browse more samples

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

Autoping item data: Enabled status

sum (boolean)autoping/items/N/enabled/
Whether this item is enabled (can be triggered)
dot_inline_dotgraph_429.png

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 trueEnabledThe feature is enabled
constant falseDisabledThe 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

Browse more samples

Autoping item data: Address list

arrayautoping/items/N/addresses/
List of addresses to ping
dot_inline_dotgraph_430.png

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'])

Browse more samples

Address

stringautoping/items/N/addresses/N/
URL to ping (default schema is icmp)
dot_inline_dotgraph_431.png

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()+"/"});

Browse more samples

Autoping item data: Controlled outlets

arrayautoping/items/N/outlets/
List of outlets to perform specified action on
dot_inline_dotgraph_432.png

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/"

Browse more samples

Outlet index

numberautoping/items/N/outlets/N/
Index of outlet to perform action on
dot_inline_dotgraph_433.png

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}"

[]

Browse more samples

Autoping item data: Script command, if any

sum (string)autoping/items/N/script/
Action to perform on selected outlets on failure, or cycle them if empty
dot_inline_dotgraph_434.png

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:

stringScript commandAction to perform on selected outlets on failure

all of the following is true:

stringInvalid action placeholderA 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 outletsSelected 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\""

Browse more samples

Autoping item data: Request item state change

callautoping/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).
dot_inline_dotgraph_435.png

Performing the function call is denied if not administrative user

The call accepts the following arguments:

  1. Desired item state: Enabled or Disabled

The call returns the following results:

  1. Empty result: null

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)

Browse more samples

Desired item state

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 trueEnabledThe feature is enabled
constant falseDisabledThe feature is disabled

Empty result

constant nullautoping/items/N/enable/results: 1/
No additional information available

This constant does not correspond to an actual resource.

Target states: Target state

objectautoping/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:

addressAddress
stateState
state_detailsState details, if any
success_countSuccess count
failure_countFailure count
queue_sizeQueue 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}

Browse more samples

Address

stringautoping/items/N/status/hosts/N/address/
Address that is being checked (default schema is icmp)
dot_inline_dotgraph_436.png

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"

Browse more samples

State

sum (optional boolean)autoping/items/N/status/hosts/N/state/
Target perceived state
dot_inline_dotgraph_437.png

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 trueOnlineThe target is responding to ping requests
constant falseOfflineThe target is not responding to ping requests
constant nullUnknownNot 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

Browse more samples

State details, if any

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 nullNo detailsNo additional information available
stringState detailsAdditional 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"

Browse more samples

Success count

numberautoping/items/N/status/hosts/N/success_count/
Number of times this target has responded to a ping request in time
dot_inline_dotgraph_438.png

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

Browse more samples

Failure count

numberautoping/items/N/status/hosts/N/failure_count/
Number of times this target has failed to respond to a ping request in time
dot_inline_dotgraph_439.png

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

Browse more samples

Queue size

numberautoping/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)
dot_inline_dotgraph_440.png

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

Browse more samples

Autoping item data: Autoping item status

objectautoping/items/N/status/
Information on monitored target status and reboots
dot_inline_dotgraph_441.png

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:

hostsTarget states
rebootsReboot 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())

Browse more samples

Target states

arrayautoping/items/N/status/hosts/
States of targets associated with this item
dot_inline_dotgraph_442.png

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())

Browse more samples

See also Target states: Target state

Reboot count

numberautoping/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

Browse more samples

Autoping item data: Pings remaining to enable, if any

sum (optional number)autoping/items/N/pings_before_enabling/
Estimate of number of successful ping replies remaining to enable the item, if any
dot_inline_dotgraph_443.png

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 nullTrial period overItem is no longer in the trial state (it is either enabled or disabled)
numberPings remaining to enableEstimate 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

Browse more samples

Autoping item data: Recently failed

sum (boolean)autoping/items/N/recently_failed/
Flag indicating whether this item has recently failed
dot_inline_dotgraph_444.png

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 trueRecently failedThe item has failed recently, and a new failure would be counted as consecutive
constant falseNormal operationThe 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/"

[]

Browse more samples

Autoping item data: In resumption trial

sum (boolean)autoping/items/N/resumption_trial/
Flag indicating whether this item is being tried after service restoration
dot_inline_dotgraph_445.png

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 trueIn resumption trialItem is being tried after service restoration (failures don't cause it to trigger until the required amount of requests succeed)
constant falseNormal operationThe 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())

{}

Browse more samples

Ping interval

numberautoping/ping_interval/
Interval between consecutive pings to the same address
dot_inline_dotgraph_446.png

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

Browse more samples

Ping timeout

numberautoping/ping_timeout/
Absence of response this long means the ping has timed out
dot_inline_dotgraph_447.png

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

Browse more samples

Post-reboot delay

numberautoping/post_reboot_delay/
Time to wait after triggering the autoping action before pinging again
dot_inline_dotgraph_448.png

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

Browse more samples

Default maximum total reboot count, if any

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
dot_inline_dotgraph_449.png

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:

numberMaximum total reboot countMaximum 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 0Retry indefinitelyPerform 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

Browse more samples

Default maximum consecutive reboot count, if any

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
dot_inline_dotgraph_450.png

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:

numberMaximum consecutive reboot countMaximum 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 0Retry indefinitelyPerform 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

Browse more samples

Pings before enabling

numberautoping/pings_before_enabling/
Minimum number of successful ping responses before enabling an autoping entry
dot_inline_dotgraph_451.png

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

Browse more samples

Resume without retrial

sum (boolean)autoping/resume_without_retrial/
Activate enabled entries when service is restored without waiting for a certain number of successful ping responses
dot_inline_dotgraph_452.png

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 trueEnabledThe feature is enabled
constant falseDisabledThe 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

Browse more samples

Handle failures immediately

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
dot_inline_dotgraph_453.png

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 trueEnabledThe feature is enabled
constant falseDisabledThe 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

Browse more samples

Reset statistics

callautoping/reset_statistics/
Clear the statistics (item success, failure and reboot counters)
dot_inline_dotgraph_454.png

Performing the function call is denied if not administrative user

The call has no arguments (supply empty tuple).

The call returns the following results:

  1. Empty result: null

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)

Browse more samples

Empty result

constant nullautoping/reset_statistics/results: 1/
No additional information available

This constant does not correspond to an actual resource.

Notifications

objectautoping/notifications/
Autoping status notifications
dot_inline_dotgraph_455.png

Retrieving the value is denied if not administrative user

This object does not support direct modification.

This object contains the following items:

parameter_kindsParameter kinds
eventsEvents

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))

<...>

Browse more samples

See also Notifications: Parameter kinds

Events

mapautoping/notifications/events/
Event templates
dot_inline_dotgraph_456.png

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))

<...>

Browse more samples

See also Events: Event

Notifications: Parameter kinds

objectautoping/notifications/parameter_kinds/
Kinds of event parameters

This object does not correspond to an actual resource.

This object contains the following items:

ping_addressAddress
ping_statePing state
ping_ping_timePing time
ping_ping_timeoutPing timeout
ping_item_stateItem state
ping_item_nameItem name
ping_item_script_nameItem script name
ping_item_addrsItem addresses
ping_item_total_failure_countTotal failure count
ping_item_consecutive_failure_countConsecutive failure count
ping_item_max_total_failure_countMaximum total failure count, if any
ping_item_max_consecutive_failure_countMaximum consecutive failure count, if any
ping_item_pings_before_enablingPings before enabling

Address

stringautoping/notifications/parameter_kinds/ping_address/
Address of ping target

Ping state

sum (variant)autoping/notifications/parameter_kinds/ping_state/
State of the target ping request

This sum can assume the following values:

constant trueReachableThe target has responded to the ping
constant falseUnreachableThe ping has timed out
constant "sent"SentThe ping has been sent but no response yet seen, and timeout not reached

Ping time

numberautoping/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

Ping timeout

numberautoping/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

Item state

sum (variant)autoping/notifications/parameter_kinds/ping_item_state/
State of the autoping item

This sum can assume the following values:

constant trueEnabledThe autoping item is enabled
constant falseDisabledThe autoping item is disabled
constant "enabling"EnablingThe autoping item is in trial state

Item name

stringautoping/notifications/parameter_kinds/ping_item_name/
Name of the autoping item

Item script name

stringautoping/notifications/parameter_kinds/ping_item_script_name/
Name of the scripting function associated with the autoping item

Item addresses

stringautoping/notifications/parameter_kinds/ping_item_addrs/
Comma-separated list of addresses belonging to this item

Total failure count

numberautoping/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:

Consecutive failure count

numberautoping/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:

Maximum total failure count, if any

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 nullRetry indefinitelyThe action will be performed regardless of the number of total failures
numberMaximum total failure countNumber of total failures after which the item becomes disabled

all of the following is true:

Maximum consecutive failure count, if any

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 nullRetry indefinitelyThe action will be performed regardless of the number of consecutive failures
numberMaximum consecutive failure countNumber of consecutive failures after which the item becomes disabled

all of the following is true:

Pings before enabling

numberautoping/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:

Event parameters: Event parameter

objectautoping/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:

idIdentifier
has_fixed_valueFixed value flag
fixed_valueFixed 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"}

Browse more samples

Identifier

stringautoping/notifications/events/S/parameters/N/id/
Parameter identifier
dot_inline_dotgraph_457.png

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"

Browse more samples

Fixed value flag

sum (boolean)autoping/notifications/events/S/parameters/N/has_fixed_value/
Flag indicating that the parameter's value for this event is fixed
dot_inline_dotgraph_458.png

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 trueFixedThe value is fixed
constant falseVariableThe 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

Browse more samples

Fixed value

sum (variant)autoping/notifications/events/S/parameters/N/fixed_value/
Fixed parameter value for this particular event
dot_inline_dotgraph_459.png

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 nullNullNull
constant trueTrueTrue
constant falseFalseFalse
stringStringThis string
numberNumberThis 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

Browse more samples

Events: Event

objectautoping/notifications/events/S/
Event template
dot_inline_dotgraph_460.png

This object is a part of a composite value which is modified as a whole.

This object contains the following items:

message_templateMessage template
severitySeverity
parametersEvent 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())

Browse more samples

Message template

arrayautoping/notifications/events/S/message_template/
Template for human-readable message generation
dot_inline_dotgraph_461.png

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"]

Browse more samples

Message template element

sum (variant)autoping/notifications/events/S/message_template/N/
Element of human-readable message template
dot_inline_dotgraph_462.png

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:

stringStringFixed string
numberParameterIndex of message parameter to insertevent 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

Browse more samples

Severity

sum (enumerated number)autoping/notifications/events/S/severity/
Severity rating assigned to the event
dot_inline_dotgraph_463.png

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 1EmergencyTreat the event as an emergency
constant 2AlertTreat the event as an alert
constant 3CriticalTreat the event as critical
constant 4ErrorTreat the event as an error
constant 5WarningTreat the event as a warning
constant 6NoticeTreat the event as a notice
constant 7InformationalTreat the event as informational
constant 8DebugTreat 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

Browse more samples

Event parameters

arrayautoping/notifications/events/S/parameters/
Additional data associated with the event
dot_inline_dotgraph_464.png

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)});

Browse more samples

See also Event parameters: Event parameter