mirror/librenms-librenms
1
0
Fork 0
mirror of https://github.com/librenms/librenms.git synced 2024-10-07 16:52:45 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add port description API endpoints and documentation (#15578)

Browse Source 
* Add port description API endpoints and documentation

* Change "update_port_description" behaviour to mimic webUI behaviour

* Fix code style issue

* Fix another code style issue
This commit is contained in:
Nick Lockhart
2024-01-22 23:07:13 +00:00
committed by GitHub
parent 1a36a25f25
commit f3e0f3eb93
3 changed files with 104 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
includes/html/api_functions.inc.php
View File

@@ -1107,6 +1107,62 @@ function get_port_info(Illuminate\Http\Request $request)
});
}
function update_port_description(Illuminate\Http\Request $request)
{
$port_id = $request->route('portid');
$port = Port::hasAccess(Auth::user())
->where([
'port_id' => $port_id,
])->first();
if (empty($port)) {
return api_error(400, 'Invalid port ID.');
}
$data = json_decode($request->getContent(), true);
$field = 'description';
$description = $data[$field];
if (empty($description)) {
// from update-ifalias.inc.php:
// "Set to repoll so we avoid using ifDescr on port poll"
$description = 'repoll';
}
$port->ifAlias = $description;
$port->save();
$ifName = $port->ifName;
$device = $port->device_id;
if ($description == 'repoll') {
// No description provided, clear description
del_dev_attrib($port, 'ifName:' . $ifName); // "port" object has required device_id
log_event("$ifName Port ifAlias cleared via API", $device, 'interface', 3, $port_id);
return api_success_noresult(200, 'Port description cleared.');
} else {
// Prevent poller from overwriting new description
set_dev_attrib($port, 'ifName:' . $ifName, 1); // see above
log_event("$ifName Port ifAlias set via API: $description", $device, 'interface', 3, $port_id);
return api_success_noresult(200, 'Port description updated.');
}
}
function get_port_description(Illuminate\Http\Request $request)
{
$port_id = $request->route('portid');
$port = Port::hasAccess(Auth::user())
->where([
'port_id' => $port_id,
])->first();
if (empty($port)) {
return api_error(400, 'Invalid port ID.');
} else {
return api_success($port->ifAlias, 'port_description');
}
}
/**
* @throws \LibreNMS\Exceptions\ApiException
*/