Ysincit
commented
3 years ago Hi, I also would like a CLI tool to change the device. I created one, by copying add_device.php (1.2.17) into change_device.php and adapting the code a little bit, and it seems to work well, but I am not sure, if this is fitting into the cacti project concept.
change_device.php has the mandatory parameter --id=
<?php
/*
+-------------------------------------------------------------------------+
| Copyright (C) 2004-2021 The Cacti Group |
| |
| 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 2 |
| 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. |
+-------------------------------------------------------------------------+
| Cacti: The Complete RRDtool-based Graphing Solution |
+-------------------------------------------------------------------------+
| This code is designed, written, and maintained by the Cacti Group. See |
| about.php and/or the AUTHORS file for specific developer information. |
+-------------------------------------------------------------------------+
| http://www.cacti.net/ |
+-------------------------------------------------------------------------+
*/
require(__DIR__ . '/../include/cli_check.php');
require_once($config['base_path'] . '/lib/api_automation_tools.php');
require_once($config['base_path'] . '/lib/api_device.php');
require_once($config['base_path'] . '/lib/api_data_source.php');
require_once($config['base_path'] . '/lib/api_graph.php');
require_once($config['base_path'] . '/lib/api_tree.php');
require_once($config['base_path'] . '/lib/data_query.php');
require_once($config['base_path'] . '/lib/poller.php');
require_once($config['base_path'] . '/lib/snmp.php');
require_once($config['base_path'] . '/lib/template.php');
require_once($config['base_path'] . '/lib/utility.php');
/* process calling arguments */
$parms = $_SERVER['argv'];
array_shift($parms);
if (! cacti_sizeof($parms)) {
display_help();
exit(0);
}
/* setup defaults */
$device_id = '';
$description = '';
$ip = '';
$poller_id = $config['poller_id'];
$site_id = read_config_option('default_site');
$template_id = read_config_option('default_template');
$community = read_config_option('snmp_community');
$snmp_ver = read_config_option('snmp_version');
$disable = 0;
$notes = '';
$location = '';
$external_id = '';
$snmp_username = read_config_option('snmp_username');
$snmp_password = read_config_option('snmp_password');
$snmp_auth_protocol = read_config_option('snmp_auth_protocol');
$snmp_priv_passphrase = read_config_option('snmp_priv_passphrase');
$snmp_priv_protocol = read_config_option('snmp_priv_protocol');
$snmp_context = '';
$snmp_engine_id = '';
$snmp_port = read_config_option('snmp_port');
$snmp_timeout = read_config_option('snmp_timeout');
$avail = 1;
$ping_method = read_config_option('ping_method');
$ping_port = read_config_option('ping_port');
$ping_timeout = read_config_option('ping_timeout');
$ping_retries = read_config_option('ping_retries');
$max_oids = read_config_option('max_get_size');
$bulk_walk_size = -1;
$proxy = false;
$device_threads = read_config_option('device_threads');
$displayHostTemplates = false;
$displayCommunities = false;
$quietMode = false;
foreach($parms as $parameter) {
if (strpos($parameter, '=')) {
list($arg, $value) = explode('=', $parameter);
} else {
$arg = $parameter;
$value = '';
}
switch ($arg) {
case '-d':
$debug = true;
break;
case '--id':
$device_id = trim($value);
break;
case '--version':
case '-V':
case '-v':
display_version();
exit(0);
case '--help':
case '-H':
case '-h':
display_help();
exit(0);
case '--quiet':
$quietMode = true;
break;
default:
}
}
if ( empty($device_id) ) {
print "ERROR: --id is mandatory parameter.\n";
display_help();
exit(1);
}
$phostcount = db_fetch_row_prepared('SELECT COUNT(*) as count FROM host WHERE id = ?', array($device_id));
if ($phostcount['count'] == 0 ) {
print "ERROR: device-id $device_id not found.\n";
exit(1);
}
$phost = db_fetch_row_prepared('SELECT * FROM host WHERE id = ?', array($device_id));
$template_id = $phost['host_template_id'];
$description = $phost['description'];
$ip = $phost['hostname'];
$community = $phost['snmp_community'];
$snmp_ver = $phost['snmp_version'];
$snmp_username = $phost['snmp_username'];
$snmp_password = $phost['snmp_password'];
$snmp_port = $phost['snmp_port'];
$snmp_timeout = $phost['snmp_timeout'];
$disable = $phost['disabled'];
if (empty($disable)) $disable = '0';
if ($disable == "on") $disable = '1';
$avail = $phost['availability_method'];
$ping_method = $phost['ping_method'];
$ping_port = $phost['ping_port'];
$ping_timeout = $phost['ping_timeout'];
$ping_retries = $phost['ping_retries'];
$notes = $phost['notes'];
$snmp_auth_protocol = $phost['snmp_auth_protocol'];
$snmp_priv_passphrase = $phost['snmp_priv_passphrase'];
$snmp_priv_protocol = $phost['snmp_priv_protocol'];
$snmp_context = $phost['snmp_context'];
$snmp_engine_id = $phost['snmp_engine_id'];
$max_oids = $phost['max_oids'];
$device_threads = $phost['device_threads'];
$poller_id = $phost['poller_id'];
$site_id = $phost['site_id'];
$external_id = $phost['external_id'];
$location = $phost['location'];
$bulk_walk_size = $phost['bulk_walk_size'];
foreach($parms as $parameter) {
if (strpos($parameter, '=')) {
list($arg, $value) = explode('=', $parameter);
} else {
$arg = $parameter;
$value = '';
}
switch ($arg) {
case '-d':
$debug = true;
break;
case '--id':
$device_id = trim($value);
break;
case '--description':
$description = trim($value);
break;
case '--ip':
$ip = trim($value);
break;
case '--template':
$template_id = $value;
break;
case '--community':
$community = trim($value);
break;
case '--version':
if (cacti_sizeof($parms) == 1) {
display_version();
exit(0);
} else {
$snmp_ver = trim($value);
}
break;
case '--notes':
$notes = trim($value);
break;
case '--location':
$location = trim($value);
break;
case '--site':
$site_id = trim($value);
break;
case '--poller':
$poller_id = trim($value);
break;
case '--disable':
$disable = $value;
break;
case '--external-id':
$external_id = $value;
break;
case '--username':
$snmp_username = trim($value);
break;
case '--password':
$snmp_password = trim($value);
break;
case '--authproto':
$snmp_auth_protocol = trim($value);
break;
case '--privproto':
$snmp_priv_protocol = trim($value);
break;
case '--privpass':
$snmp_priv_passphrase = trim($value);
break;
case '--context':
$snmp_context = trim($value);
break;
case '--engineid':
$snmp_engine_id = trim($value);
break;
case '--port':
$snmp_port = $value;
break;
case '--proxy':
$proxy = true;
break;
case '--timeout':
$snmp_timeout = $value;
break;
case '--ping_timeout':
$ping_timeout = $value;
break;
case '--threads':
$device_threads = $value;
break;
case '--avail':
switch($value) {
case 'none':
$avail = '0'; /* tried to use AVAIL_NONE, but then preg_match failes on validation, sigh */
break;
case 'ping':
$avail = AVAIL_PING;
break;
case 'snmp':
$avail = AVAIL_SNMP;
break;
case 'pingsnmp':
$avail = AVAIL_SNMP_AND_PING;
break;
case 'pingorsnmp':
$avail = AVAIL_SNMP_OR_PING;
break;
default:
print "ERROR: Invalid Availability Parameter: ($value)\n\n";
display_help();
exit(1);
}
break;
case '--ping_method':
switch(strtolower($value)) {
case 'icmp':
$ping_method = PING_ICMP;
break;
case 'tcp':
$ping_method = PING_TCP;
break;
case 'udp':
$ping_method = PING_UDP;
break;
default:
print "ERROR: Invalid Ping Method: ($value)\n\n";
display_help();
exit(1);
}
break;
case '--ping_port':
if (is_numeric($value) && ($value > 0)) {
$ping_port = $value;
} else {
print "ERROR: Invalid Ping Port: ($value)\n\n";
display_help();
exit(1);
}
break;
case '--ping_retries':
if (is_numeric($value) && ($value > 0)) {
$ping_retries = $value;
} else {
print "ERROR: Invalid Ping Retries: ($value)\n\n";
display_help();
exit(1);
}
break;
case '--max_oids':
if (is_numeric($value) && ($value > 0)) {
$max_oids = $value;
} else {
print "ERROR: Invalid Max OIDS: ($value)\n\n";
display_help();
exit(1);
}
break;
case '--bulk_walk':
if (is_numeric($value) && $value >= -1 && $value != 0) {
$bulk_walk_size = $value;
} else {
print "ERROR: Invalid Bulk Walk Size: ($value)\n\n";
display_help();
exit(1);
}
case '--version':
case '-V':
case '-v':
display_version();
exit(0);
case '--help':
case '-H':
case '-h':
display_help();
exit(0);
case '--quiet':
$quietMode = true;
break;
default:
print "ERROR: Invalid Argument: ($arg)\n\n";
display_help();
exit(1);
}
}
/* process the various lists into validation arrays */
$host_templates = getHostTemplates();
$hosts = getHostsByDescription();
$addresses = getAddresses();
/* process templates */
if (!isset($host_templates[$template_id])) {
print "ERROR: Unknown template id ($template_id)\n";
exit(1);
}
if ($description == '') {
print "ERROR: You must supply a description for all hosts!\n";
exit(1);
}
if ($ip == '') {
print "ERROR: You must supply an IP address for all hosts!\n";
exit(1);
}
if ($snmp_ver > 3 || $snmp_ver < 0 || !is_numeric($snmp_ver)) {
print "ERROR: The snmp version must be between 0 and 3. If you did not specify one, goto Configuration > Settings > Device Defaults and resave your defaults.\n";
exit(1);
}
if (!is_numeric($site_id) || $site_id < 0) {
print "ERROR: You have specified an invalid site id!\n";
exit(1);
}
if (!is_numeric($poller_id) || $poller_id < 0) {
print "ERROR: You have specified an invalid poller id!\n";
exit(1);
}
/* process snmp information */
if ($snmp_ver < 0 || $snmp_ver > 3) {
print "ERROR: Invalid snmp version ($snmp_ver)\n";
exit(1);
} elseif ($snmp_ver > 0) {
if ($snmp_port <= 1 || $snmp_port > 65534) {
print "ERROR: Invalid port. Valid values are from 1-65534\n";
exit(1);
}
if ($snmp_timeout <= 0 || $snmp_timeout > 20000) {
print "ERROR: Invalid timeout. Valid values are from 1 to 20000\n";
exit(1);
}
}
/* community/user/password verification */
if ($snmp_ver < 3) {
/* snmp community can be blank */
} else {
if ($snmp_username == "" || $snmp_password == "") {
print "ERROR: When using snmpv3 you must supply an username and password\n";
exit(1);
}
}
/* validate the disable state */
if ($disable != 1 && $disable != 0) {
print "ERROR: Invalid disable flag ($disable)\n";
exit(1);
}
if ($disable == 0) {
$disable = "";
} else {
$disable = "on";
}
if (!$quietMode) print "Changing device-id: $device_id to $description ($ip) as \"" . $host_templates[$template_id] . "\" using SNMP v$snmp_ver with community \"$community\"\n";
$host_id = api_device_save($device_id, $template_id, $description, $ip,
$community, $snmp_ver, $snmp_username, $snmp_password,
$snmp_port, $snmp_timeout, $disable, $avail, $ping_method,
$ping_port, $ping_timeout, $ping_retries, $notes,
$snmp_auth_protocol, $snmp_priv_passphrase,
$snmp_priv_protocol, $snmp_context, $snmp_engine_id, $max_oids, $device_threads,
$poller_id, $site_id, $external_id, $location, $bulk_walk_size);
if (is_error_message()) {
print "ERROR: Failed to change this device\n";
exit(1);
} else {
if (!$quietMode) print "Success\n";
exit(0);
}
/* display_version - displays version information */
function display_version() {
$version = get_cacti_cli_version();
print "Cacti Change Device Utility, Version $version, " . COPYRIGHT_YEARS . "\n";
}
function display_help() {
display_version();
print "\nusage: change_device.php --id=<device-id> [--description=[description]] [--ip=[IP]] [--template=[ID]] [--notes=\"[]\"] [--disable]\n";
print " [--poller=[id]] [--site=[id] [--external-id=[S]] [--proxy] [--threads=[1]\n";
print " [--avail=[ping]] --ping_method=[icmp] --ping_port=[N/A, 1-65534] --ping_timeout=[N] --ping_retries=[2]\n";
print " [--version=[0|1|2|3]] [--community=] [--port=161] [--timeout=500]\n";
print " [--username= --password=] [--authproto=] [--privpass= --privproto=] [--context=] [--engineid=]\n";
print " [--quiet]\n\n";
print "Required:\n";
print " --id the id for a device, that is field id in table host\n";
print " any optional device attribute parameter given, will replace the existing parameter\n";
print "Optional:\n";
print " --description the name that will be displayed by Cacti in the graphs\n";
print " --ip self explanatory (can also be a FQDN)\n\n";
print " --proxy if specified, allows adding a second host with same ip address\n";
print " --template 0, is a number (read below to get a list of templates)\n";
print " --location '', The physical location of the Device.\n";
print " --notes '', General information about this host. Must be enclosed using double quotes.\n";
print " --external-id '', An external ID to align Cacti devices with devices from other systems.\n";
print " --disable 0, 1 to add this host but to disable checks and 0 to enable it\n";
print " --poller 0, numeric poller id that will perform data collection for the device.\n";
print " --site 0, numeric site id that will be associated with the device.\n";
print " --threads 1, numeric number of threads to poll device with.\n";
print " --avail pingsnmp, [ping][none, snmp, pingsnmp, pingorsnmp]\n";
print " --ping_method tcp, icmp|tcp|udp\n";
print " --ping_port '', 1-65534\n";
print " --ping_retries 2, the number of time to attempt to communicate with a host\n";
print " --ping_timeout N, the ping timeout in milliseconds. Defaults to database setting.\n";
print " --version 1, 0|1|2|3, snmp version. 0 for no snmp\n";
print " --community '', snmp community string for snmpv1 and snmpv2. Leave blank for no community\n";
print " --port 161\n";
print " --timeout 500\n";
print " --username '', snmp username for snmpv3\n";
print " --password '', snmp password for snmpv3\n";
print " --authproto '', snmp authentication protocol for snmpv3\n";
print " --privpass '', snmp privacy passphrase for snmpv3\n";
print " --privproto '', snmp privacy protocol for snmpv3\n";
print " --context '', snmp context for snmpv3\n";
print " --engineid '', snmp engineid for snmpv3\n";
print " --max_oids 10, 1-60, the number of OIDs that can be obtained in a single SNMP Get request\n\n";
print " --bulk_walk -1, 1-60, the bulk walk chunk size that will be used for bulk walks. Use -1 for auto-tune.\n\n";
print " --quiet - batch mode value return\n\n";
}kind regards!
Hey guys
Presently there is a way to add a device and remove a device via CLI however there is no way to change a device parameter via CLI so if you want to make a mass change there is no way to do it unless you make the change direct against the DB unless I am wrong
If you were making a network subnet change, for example, moving from 192.168.1.0 to 192.168.2.0 this would come in handy as you could loop through the script with a list of the new device to IP mapping to make the change instead of manually or doing it via the DB
Thanks!