Calnex Sentinel - Page 71

Using Sentinel
CX3001 v7.0 © Calnex Solutions 71
calnexsol.com |
Example
Browser
Not Applicable
Curl
curl -k https://192.168.123.123/api/setsettings –data-binary @settings.preset
In this case the file called settings.preset will be uploaded to the Sentinel and applied as a new configuration if it
passes validation. The current settings can be downloaded using getsettings and used as a template for required
new configuration. Alternatively, preset files can be saved within Sentinel using the Save Preset option.
Get
API Call
/api/get/[required setting(s)]
Summary
Get a parameter or group of parameters from the current Sentinel configuration
Description
This service call returns one or more parameters from the Sentinel configuration based on the specified
parameter name or group. The following shows an example of what can be specified.
/api/get
When specified without any additional information this API call will return a list
of all groups that are available within the Sentinel configuration. These groups
correspond to those included in the preset file obtained via the getsettings API
call.
/api/get/measure
This would return a list all settings in the measure group.
/api/get/measure/meas_time
This would return only the value for the meas_time parameter.
Parameters
Name
Description
Required
key
Authentication key obtained from getkey where enabled and login has
not been used
Returns
A list of one or more parameters is returned with their current values. A section of what would be returned for
/api/get/measure is as follows:
…
measure/transparent_mode/monitored_ip1=10.32.1.163
measure/transparent_mode/monitored_ip1_ipv4=10.32.1.163
measure/transparent_mode/monitored_ip1_ipv6=2000::000a
measure/transparent_mode/monitored_ip2=10.32.1.168
measure/transparent_mode/monitored_ip2_ipv4=10.32.1.168
measure/transparent_mode/monitored_ip2_ipv6=2000::000b
measure/transparent_mode/monitored_mac1=E00000000001
measure/transparent_mode/monitored_mac2=F00000000001
measure/transparent_mode/monitored_slave_clkid=0000000000000000
measure/transparent_mode/monitored_master_clkid=0000000000000000
measure/transparent_mode/monitored_mode=0
measure/transparent_mode/include_correction_field=1
measure/context/meas_started=
measure/context/meas_stopped=
measure/context/reference_used=2
measure/ch0/installed=0
measure/ch0/used=false
measure/ch0/signal_type=
measure/ch0/freq=1
measure/ch0/pulse_width=1
measure/ch0/trig_level=0
measure/ch0/vmin=0
measure/ch0/vmax=0
…