GET /protocols/nlight-air/pti/logs
FROM API REVISION 6.0
This resource will show you multiple information about the Packet Trace Interface logging.
Used when you are operating a browser without access to the header parameter. This allows you to choose which encoding you want to use for the response:
All these resources can be used according what the resource allows.
To address the raw value of a primitive property, clients append a path segment containing the string $value to the property URL.
To use this query option you need to use the classic resource and add the element name you want to print followed by the query string name.
<span class="warning"><span class="glyphicon glyphicon-warning-sign" aria-hidden="true"> Be careful, the parameter query string is used in the URL and is not like other parameters.
The $select system query option allows clients to request a limited set of properties for each entity.
The value pass in the parameter can be:
If there is no value after the select query option, the parameter will be ignored. All the values that are not specified will not be printed in the response.
If this parameter is not in the request, the Application/Json will be chosen by default.
There are multiple possible values (according the resource):
The first two are the most often used.
Object Name: Logs
propertyName | type | description | get | |
---|---|---|---|---|
Running | Boolean | True if the device is currently logging data ; false otherwise. | GET | |
Timeout | This is the timeout value. | |||
The logging will stop when this value is reached. | GET | |||
TimeoutRemaining | Integer | This is the time remaining. | ||
When the value is equal to -1, that means the logging is stopped. | GET | |||
TimeoutMax | Integer | This is the Timeout maximum value. | GET | |
TimeoutMin | Integer | This is the Timeout mininum value. | GET | |
FileLogExists | Boolean | True if a file log exists on the device ; false otherwise. | GET |
Url Example: https://1.1.1.1/api/rest/v1/protocols/nlight-air/pti/logs
{
"fileLogExists": false,
"timeoutMax": 3600,
"timeoutMin": 0,
"timeoutRemaining": -1,
"running": "false",
"timeout": 30
}
Url Example: https://1.1.1.1/api/rest/v1/protocols/nlight-air/pti/logs
<?xml version="1.0" encoding="utf-8"?>
<Logs>
<Running>false</Running>
<Timeout>30</Timeout>
<TimeoutRemaining>-1</TimeoutRemaining>
<TimeoutMax>3600</TimeoutMax>
<TimeoutMin>0</TimeoutMin>
<FileLogExists>false</FileLogExists>
</Logs>