librenms/scripts/purge-port.php
Maximilian Wilhelm 95024af2c0 feature: Added purge-port scipt to allow deleting of ports from the CLI. (#7528)
* Add purge-port scipt to allow deleting of ports from the CLI.

  This script allows deleting single ports by their port_id or a list
  of ports read from a file or STDIN.

  LibreNMS Port purge tool
        -p <port_id>    Purge single port by it's port-id
        -f <file>       Purge a list of ports, read port-ids from <file>, one on each line.
                        A filename of - means reading from STDIN.

Signed-off-by: Maximilian Wilhelm <max@sdn.clinic>

* Update CLI-Tools.md
2017-11-09 12:57:41 +00:00

82 lines
2.0 KiB
PHP
Executable File

#!/usr/bin/env php
<?php
/*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* libreNMS CLI utility to purge old ports.
*
* @author Maximilian Wilhelm <max@sdn.clinic>
* @copyright 2016-2017 LibreNMS, Barbarossa
* @license GPL
* @package LibreNMS
* @subpackage ?
*
*/
chdir(dirname($argv[0]));
$init_modules = array();
require realpath(__DIR__ . '/..') . '/includes/init.php';
$opt = getopt('p:f:');
// Single Port-id given on cmdline?
$port_id = null;
if ($opt['p']) {
$port_id = $opt['p'];
}
// File with port-ids given on cmdline?
$port_id_file = null;
if ($opt['f']) {
$port_id_file = $opt['f'];
}
if (! $port_id && ! $port_id_file || ($port_id && $port_id_file)) {
print $console_color->convert($config['project_name_version'].' Port purge tool
-p <port_id> Purge single port by it\'s port-id
-f <file> Purge a list of ports, read port-ids from <file>, one on each line.
A filename of - means reading from STDIN.
');
}
// Purge single port
if ($port_id) {
delete_port($port_id);
}
// Delete multiple ports
if ($port_id_file) {
$fh = null;
if ($port_id_file == '-') {
$fh = STDIN;
} else {
$fh = fopen($port_id_file, "r");
if (! $fh) {
echo "Failed to open port-id list \"" . $port_id_file . "\": \n";
exit(1);
}
}
while ($port_id = trim(fgets($fh))) {
delete_port($port_id);
}
if ($fh != STDIN) {
fclose($fh);
}
}