admin/cacti
1
0 Fork 0
mirror of https://github.com/Cacti/cacti.git synced 2026-10-23 03:27:02 +09:00
Code Issues Packages Projects Releases Wiki Activity
Files
fcbcbdd1d7ae3b49445a3686d9c1341591ecb754
cacti/cli/add_device.php
T
Thomas VincentandTheWitness fcbcbdd1d7 refactor: replace strpos() boolean checks with str_contains/str_starts_with (#6645) 
* refactor: replace strpos() boolean checks with str_contains/str_starts_with

Completes the PHP 8.x string function migration started in lib/.
Converts remaining legacy patterns across 81 files:

- strpos($x, $y) !== false → str_contains($x, $y)
- strpos($x, $y) === false → !str_contains($x, $y)
- strpos($x, $y) != false  → str_contains($x, $y)
- bare if (strpos($x, $y)) → if (str_contains($x, $y))
- substr($x, 0, strlen($y)) == $y → str_starts_with($x, $y)

Intentionally preserves strpos() calls that use the return value as
an integer offset:
- user_admin.php / user_group_admin.php (4 calls, ternary for position)
- auth_profile.php (2 calls, offset for substr); guards fixed from
  bare if ($pos) to if ($pos !== false)

Behavior fix: ss_esxi_vhosts.php:55 bare strpos() missed position-0
matches; str_contains() now correctly detects 'not installed' at any
position. Adjacent line already used str_contains().

Ref: https://github.com/Cacti/cacti/issues/6641

Signed-off-by: Thomas Vincent <thomasvincent@gmail.com>

* fix: correct dead-code elseif in plugin_display_compat() version comparison

The if/elseif chain in plugin_display_compat() checked >=, >=, >, <
— the second >= was unreachable dead code. Corrected to <= to complete
the operator set (>=, <=, >, <).

Without this fix, <= constraints (e.g. "<=1.2") fell through to the <
branch and were rendered as "< =1.2" instead of "<= 1.2".

This pre-existing bug was exposed when converting strpos() to
str_contains(), which made PHPStan detect the always-false condition.

Ref: https://github.com/Cacti/cacti/issues/6641

Signed-off-by: Thomas Vincent <thomasvincent@gmail.com>

* fix: add limit to explode('=') in CLI argument parsers

17 CLI scripts used explode('=', $parameter) without a limit of 2,
silently truncating values containing = (e.g. --note=a=b parsed as
$value='a' instead of 'a=b'). The other 40 CLI scripts already had
the correct limit.

Signed-off-by: Thomas Vincent <thomasvincent@gmail.com>

---------

Signed-off-by: Thomas Vincent <thomasvincent@gmail.com>
Co-authored-by: TheWitness <thewitness@cacti.net>
2026-02-25 11:38:59 -05:00

634 lines
19 KiB
PHP
Executable File
Raw Blame History

#!/usr/bin/env php
<?php
/*
+-------------------------------------------------------------------------+
| Copyright (C) 2004-2026 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(CACTI_PATH_LIBRARY . '/api_automation_tools.php');
require_once(CACTI_PATH_LIBRARY . '/api_device.php');
require_once(CACTI_PATH_LIBRARY . '/api_data_source.php');
require_once(CACTI_PATH_LIBRARY . '/api_graph.php');
require_once(CACTI_PATH_LIBRARY . '/api_tree.php');
require_once(CACTI_PATH_LIBRARY . '/data_query.php');
require_once(CACTI_PATH_LIBRARY . '/poller.php');
require_once(CACTI_PATH_LIBRARY . '/snmp.php');
require_once(CACTI_PATH_LIBRARY . '/template.php');
require_once(CACTI_PATH_LIBRARY . '/utility.php');
// switch to main database for cli's
if (POLLER_ID > 1) {
db_switch_remote_to_main();
}
// process calling arguments
$parms = $_SERVER['argv'];
array_shift($parms);
if (cacti_sizeof($parms)) {
// setup defaults
$description = '';
$ip = '';
$poller_id = POLLER_ID;
$site_id = intval(read_config_option('default_site') ?? 0);
$template_id = intval(read_config_option('default_template') ?? 0);
$community = read_config_option('snmp_community') ?? '';
$snmp_ver = intval(read_config_option('snmp_version') ?? 2);
$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 = intval(read_config_option('snmp_port') ?? 161);
$snmp_timeout = intval(read_config_option('snmp_timeout') ?? 500);
$snmp_retries = intval(read_config_option('snmp_retries') ?? 3);
$snmp_options = read_config_option('snmp_options') ?? '';
if (empty($snmp_options)) {
$snmp_options = 0;
}
$avail = 1;
$ping_method = intval(read_config_option('ping_method') ?? 4);
$ping_port = intval(read_config_option('ping_port') ?? 22);
$ping_timeout = intval(read_config_option('ping_timeout') ?? 500);
$ping_retries = intval(read_config_option('ping_retries') ?? 2);
$max_oids = intval(read_config_option('max_get_size') ?? 5);
$bulk_walk_size = -1;
$proxy = false;
$device_threads = intval(read_config_option('device_threads') ?? 1);
$displayHostTemplates = false;
$displayCommunities = false;
$quietMode = false;
foreach ($parms as $parameter) {
if (str_contains($parameter, '=')) {
[$arg, $value] = explode('=', $parameter, 2);
} else {
$arg = $parameter;
$value = '';
}
switch ($arg) {
case '-d':
$debug = true;
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 '--security-level':
$snmp_security_level = strtolower(trim($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 '--retries':
$snmp_retries = $value;
break;
case '--options':
$snmp_options = $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 fails 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)" . PHP_EOL . PHP_EOL;
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)" . PHP_EOL . PHP_EOL;
display_help();
exit(1);
}
break;
case '--ping_port':
if (is_numeric($value) && ($value > 0)) {
$ping_port = $value;
} else {
print "ERROR: Invalid Ping Port: ($value)" . PHP_EOL . PHP_EOL;
display_help();
exit(1);
}
break;
case '--ping_retries':
if (is_numeric($value) && ($value > 0)) {
$ping_retries = $value;
} else {
print "ERROR: Invalid Ping Retries: ($value)" . PHP_EOL . PHP_EOL;
display_help();
exit(1);
}
break;
case '--max_oids':
if (is_numeric($value) && ($value > 0)) {
$max_oids = $value;
} else {
print "ERROR: Invalid Max OIDS: ($value)" . PHP_EOL . PHP_EOL;
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)" . PHP_EOL . PHP_EOL;
display_help();
exit(1);
}
break;
case '--version':
case '-V':
case '-v':
display_version();
exit(0);
case '--help':
case '-H':
case '-h':
display_help();
exit(0);
case '--list-communities':
$displayCommunities = true;
break;
case '--list-host-templates':
$displayHostTemplates = true;
break;
case '--quiet':
$quietMode = true;
break;
default:
print "ERROR: Invalid Argument: ($arg)" . PHP_EOL . PHP_EOL;
display_help();
exit(1);
}
}
if ($displayCommunities) {
displayCommunities($quietMode);
exit(0);
}
if ($displayHostTemplates) {
displayHostTemplates(getHostTemplates(), $quietMode);
exit(0);
}
// 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)" . PHP_EOL;
exit(1);
}
// process host description
if (isset($hosts[$description])) {
db_execute("UPDATE host SET hostname='$ip' WHERE deleted = '' AND id=" . $hosts[$description]);
print "This host already exists in the database ($description) device-id: (" . $hosts[$description] . ')' . PHP_EOL;
exit(1);
}
if ($description == '') {
print 'ERROR: You must supply a description for all hosts!' . PHP_EOL;
exit(1);
}
if ($ip == '') {
print 'ERROR: You must supply an IP address for all hosts!' . PHP_EOL;
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.' . PHP_EOL;
exit(1);
}
if (isset($snmp_security_level)) {
switch ($snmp_security_level) {
case 'noauthnopriv':
if (empty($snmp_username)) {
print 'ERROR: For SNMP security level noAuthNoPriv, you must enter a username' . PHP_EOL;
exit(1);
} else {
$snmp_auth_protocol = '[None]';
$snmp_priv_protocol = '[None]';
}
break;
case 'authnopriv':
if (empty($snmp_username) || empty($snmp_auth_protocol) || empty($snmp_password)) {
print 'ERROR: For SNMP security level authNoPriv, you must enter username, password and SNMP auth protocol' . PHP_EOL;
exit(1);
} else {
$snmp_priv_protocol = '[None]';
}
break;
case 'authpriv':
if (empty($snmp_username) || empty($snmp_auth_protocol) || empty($snmp_password) || empty($snmp_priv_passphrase) || empty($snmp_priv_protocol)) {
print 'ERROR: For SNMP security level authNoPriv, you must enter username, password, SNMP auth protocol, priv protocol and priv passphrase' . PHP_EOL;
exit(1);
}
break;
default:
print 'ERROR: SNMP security level incorrect. Correct values are noAuthNoPriv, authNoPriv or authPriv.' . PHP_EOL;
exit(1);
}
}
// process ip
if (isset($addresses[$ip])) {
$id = $addresses[$ip];
$phost = db_fetch_row_prepared('SELECT * FROM host WHERE id = ?', [$id]);
$fail = false;
if ($phost['snmp_version'] < '3' && $snmp_ver < '3') {
if ($snmp_ver == 0 && $proxy) {
// proxy but for no snmp
} elseif ($phost['snmp_community'] != $community || $phost['snmp_port'] != $snmp_port) {
if ($proxy) {
// assuming an snmp-proxy
} else {
print "ERROR: This IP ($id) already exists in the database and --proxy was not specified." . PHP_EOL;
exit(1);
}
} else {
$fail = true;
}
} elseif ($phost['snmp_version'] != $snmp_ver) {
// assuming a proxy
} elseif ($phost['snmp_version'] == '3' && $snmp_ver == '3') {
$changed = 0;
$changed += ($phost['snmp_username'] != $snmp_username ? 1 : 0);
$changed += ($phost['snmp_context'] != $snmp_context ? 1 : 0);
$changed += ($phost['snmp_engine_id'] != $snmp_engine_id ? 1 : 0);
$changed += ($phost['snmp_auth_protocol'] != $snmp_auth_protocol ? 1 : 0);
$changed += ($phost['snmp_priv_protocol'] != $snmp_priv_protocol ? 1 : 0);
if ($changed > 0) {
if ($proxy) {
// assuming a proxy
} else {
print "ERROR: This IP ($id) already exists in the database and --proxy was not specified." . PHP_EOL;
exit(1);
}
} else {
$fail = true;
}
} else {
$fail = true;
}
if ($fail) {
db_execute("UPDATE host SET description = '$description' WHERE deleted = '' AND id = " . $addresses[$ip]);
print "ERROR: This IP already exists in the database ($ip) device-id: (" . $addresses[$ip] . ')' . PHP_EOL;
exit(1);
}
}
if (!is_numeric($site_id) || $site_id < 0) {
print 'ERROR: You have specified an invalid site id!' . PHP_EOL;
exit(1);
}
if (!is_numeric($poller_id) || $poller_id < 0) {
print 'ERROR: You have specified an invalid poller id!' . PHP_EOL;
exit(1);
}
// process snmp information
if ($snmp_ver < 0 || $snmp_ver > 3) {
print "ERROR: Invalid snmp version ($snmp_ver)" . PHP_EOL;
exit(1);
}
if ($snmp_ver > 0) {
if ($snmp_port <= 1 || $snmp_port > 65534) {
print 'ERROR: Invalid port. Valid values are from 1-65534' . PHP_EOL;
exit(1);
}
if ($snmp_timeout <= 0 || $snmp_timeout > 20000) {
print 'ERROR: Invalid timeout. Valid values are from 1 to 20000' . PHP_EOL;
exit(1);
}
}
// community/user/password verification
if ($snmp_ver < 3) {
// snmp community can be blank
} else {
if ($snmp_username == '') {
print 'ERROR: When using snmpv3 you must supply an username' . PHP_EOL;
exit(1);
}
}
// validate the disable state
if ($disable != 1 && $disable != 0) {
print "ERROR: Invalid disable flag ($disable)" . PHP_EOL;
exit(1);
}
if ($disable == 0) {
$disable = '';
} else {
$disable = 'on';
}
if ($snmp_ver < 3) {
print "Adding $description ($ip) as \"" . $host_templates[$template_id] . "\" using SNMP v$snmp_ver with community \"$community\"" . PHP_EOL;
} else {
print "Adding $description ($ip) as \"" . $host_templates[$template_id] . "\" using SNMP v$snmp_ver with username \"$snmp_username\"" . PHP_EOL;
}
$host_id = api_device_save(0, $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, $snmp_options, $snmp_retries);
if (is_error_message()) {
print 'ERROR: Failed to add this device' . PHP_EOL;
exit(1);
} else {
print "Success - new device-id: ($host_id)" . PHP_EOL;
exit(0);
}
} else {
display_help();
exit(0);
}
/**
* display_version - displays version information
*
* @return void
*/
function display_version() : void {
$version = get_cacti_cli_version();
print "Cacti Add Device Utility, Version $version, " . COPYRIGHT_YEARS . PHP_EOL;
}
/**
* display_help - displays help information
*
* @return void
*/
function display_help() : void {
display_version();
print PHP_EOL;
print 'usage: add_device.php --description=[description] --ip=[IP] --template=[ID] [--notes="[]"] [--disable]' . PHP_EOL;
print ' [--poller=[id]] [--site=[id] [--external-id=[S]] [--proxy] [--threads=[1]' . PHP_EOL;
print ' [--avail=[ping]] --ping_method=[icmp] --ping_port=[N/A, 1-65534] --ping_timeout=[N] --ping_retries=[2]' . PHP_EOL;
print ' [--version=[0|1|2|3]] [--community=] [--port=161] [--timeout=500] [--retries=3] [--options=0]' . PHP_EOL;
print ' [--username= --password=] [--authproto=] [--privpass= --privproto=] [--context=] [--engineid=]' . PHP_EOL;
print ' [--quiet]' . PHP_EOL . PHP_EOL;
print 'Required:' . PHP_EOL;
print ' --description the name that will be displayed by Cacti in the graphs' . PHP_EOL;
print ' --ip self explanatory (can also be a FQDN)' . PHP_EOL . PHP_EOL;
print 'Optional:' . PHP_EOL;
print ' --proxy if specified, allows adding a second host with same ip address' . PHP_EOL;
print ' --template 0, is a number (read below to get a list of templates)' . PHP_EOL;
print " --location '', The physical location of the Device." . PHP_EOL;
print " --notes '', General information about this host. Must be enclosed using double quotes." . PHP_EOL;
print " --external-id '', An external ID to align Cacti devices with devices from other systems." . PHP_EOL;
print ' --disable 0, 1 to add this host but to disable checks and 0 to enable it' . PHP_EOL;
print ' --poller 0, numeric poller id that will perform data collection for the device.' . PHP_EOL;
print ' --site 0, numeric site id that will be associated with the device.' . PHP_EOL;
print ' --threads 1, numeric number of threads to poll device with.' . PHP_EOL;
print ' --avail pingsnmp, [ping][none, snmp, pingsnmp, pingorsnmp]' . PHP_EOL;
print ' --ping_method tcp, icmp|tcp|udp' . PHP_EOL;
print " --ping_port '', 1-65534" . PHP_EOL;
print ' --ping_retries 2, the number of time to attempt to communicate with a host' . PHP_EOL;
print ' --ping_timeout N, the ping timeout in milliseconds. Defaults to database setting.' . PHP_EOL;
print ' --version 1, 0|1|2|3, snmp version. 0 for no snmp' . PHP_EOL;
print " --community '', snmp community string for snmpv1 and snmpv2. Leave blank for no community" . PHP_EOL;
print ' --port 161' . PHP_EOL;
print ' --timeout 500, The default snmp timeout' . PHP_EOL;
print ' --retries 3, The number of snmp retries' . PHP_EOL;
print ' --options 0, The SNMP Recovery Template Options set to use' . PHP_EOL;
print " --security-level '', noAuthNoPriv|authNoPriv|authPriv, security level for snmpv3" . PHP_EOL;
print " --username '', snmp username for snmpv3" . PHP_EOL;
print " --password '', snmp password for snmpv3" . PHP_EOL;
print " --authproto '', [None]|MD5|SHA|SHA224|SHA256|SHA392|SHA512$, snmp authentication protocol for snmpv3" . PHP_EOL;
print " --privpass '', snmp privacy passphrase for snmpv3" . PHP_EOL;
print " --privproto '', [None]|DES|AES|AES128|AES192|AES192C|AES256|AES256C$, snmp privacy protocol for snmpv3" . PHP_EOL;
print " --context '', snmp context for snmpv3" . PHP_EOL;
print " --engineid '', snmp engineid for snmpv3" . PHP_EOL;
print ' --max_oids 10, 1-60, the number of OIDs that can be obtained in a single SNMP Get request' . PHP_EOL . PHP_EOL;
print ' --bulk_walk -1, 1-60, the bulk walk chunk size that will be used for bulk walks. Use -1 for auto-tune.' . PHP_EOL . PHP_EOL;
print 'List Options:' . PHP_EOL;
print ' --list-host-templates' . PHP_EOL;
print ' --list-communities' . PHP_EOL;
print ' --quiet - batch mode value return' . PHP_EOL . PHP_EOL;
}
Reference in new issue View Git Blame Copy Permalink