def _extract_disabled_snmp_sections_from_ignored_checks(
self, all_rulesets):
ignored_checks_ruleset = all_rulesets.get("ignored_checks")
if ignored_checks_ruleset.is_empty():
# nothing to do
return
if not all_rulesets.get("snmp_exclude_sections").is_empty():
# this must be an upgrade from 2.0.0 or newer - don't mess with
# the existing rules!
return
self._logger.log(VERBOSE, "Extracting excluded SNMP sections")
all_snmp_section_names = set(
s.name for s in register.iter_all_snmp_sections())
all_check_plugin_names = set(
p.name for p in register.iter_all_check_plugins())
all_inventory_plugin_names = set(
i.name for i in register.iter_all_inventory_plugins())
snmp_exclude_sections_ruleset = cmk.gui.watolib.rulesets.Ruleset(
"snmp_exclude_sections", ignored_checks_ruleset.tag_to_group_map)
for folder, _index, rule in ignored_checks_ruleset.get_rules():
disabled = {CheckPluginName(n) for n in rule.value}
still_needed_sections_names = set(
register.get_relevant_raw_sections(
check_plugin_names=all_check_plugin_names - disabled,
inventory_plugin_names=all_inventory_plugin_names,
))
sections_to_disable = all_snmp_section_names - still_needed_sections_names
if not sections_to_disable:
continue
new_rule = cmk.gui.watolib.rulesets.Rule(
rule.folder, snmp_exclude_sections_ruleset)
new_rule.from_config(rule.to_config())
new_rule.id = cmk.gui.watolib.rulesets.utils.gen_id()
new_rule.value = { # type: ignore[assignment]
'sections_disabled': sorted(str(s) for s in sections_to_disable),
'sections_enabled': [],
}
new_rule.rule_options["comment"] = (
'%s - Checkmk: automatically converted during upgrade from rule '
'"Disabled checks". Please review if these rules can be deleted.'
) % time.strftime("%Y-%m-%d %H:%M", time.localtime())
snmp_exclude_sections_ruleset.append_rule(folder, new_rule)
all_rulesets.set(snmp_exclude_sections_ruleset.name,
snmp_exclude_sections_ruleset)
def _do_inv_for_realhost(
host_config: config.HostConfig,
ipaddress: Optional[HostAddress],
*,
multi_host_sections: MultiHostSections,
run_only_plugin_names: Optional[Set[InventoryPluginName]],
) -> InventoryTrees:
tree_aggregator = _TreeAggregator()
_set_cluster_property(tree_aggregator.trees.inventory, host_config)
section.section_step("Executing inventory plugins")
for inventory_plugin in agent_based_register.iter_all_inventory_plugins():
if run_only_plugin_names and inventory_plugin.name not in run_only_plugin_names:
continue
kwargs = multi_host_sections.get_section_kwargs(
HostKey(host_config.hostname, ipaddress, SourceType.HOST),
inventory_plugin.sections,
)
if not kwargs:
console.vverbose(" %s%s%s%s: skipped (no data)\n", tty.yellow,
tty.bold, inventory_plugin.name, tty.normal)
continue
# Inventory functions can optionally have a second argument: parameters.
# These are configured via rule sets (much like check parameters).
if inventory_plugin.inventory_ruleset_name is not None:
kwargs["params"] = host_config.inventory_parameters(
str(inventory_plugin.inventory_ruleset_name)
) # TODO (mo): keep type!
exception = tree_aggregator.aggregate_results(
inventory_plugin.inventory_function(**kwargs),
inventory_plugin.name,
)
if exception:
console.warning(" %s%s%s%s: failed: %s", tty.red, tty.bold,
inventory_plugin.name, tty.normal, exception)
else:
console.verbose(" %s%s%s%s", tty.green, tty.bold,
inventory_plugin.name, tty.normal)
console.vverbose(": ok\n")
console.verbose("\n")
tree_aggregator.trees.inventory.normalize_nodes()
tree_aggregator.trees.status_data.normalize_nodes()
return tree_aggregator.trees
def _do_inv_for_realhost(
host_config: config.HostConfig,
ipaddress: Optional[HostAddress],
*,
parsed_sections_broker: ParsedSectionsBroker,
run_plugin_names: Container[InventoryPluginName],
) -> InventoryTrees:
tree_aggregator = TreeAggregator()
_set_cluster_property(tree_aggregator.trees.inventory, host_config)
section.section_step("Executing inventory plugins")
for inventory_plugin in agent_based_register.iter_all_inventory_plugins():
if inventory_plugin.name not in run_plugin_names:
continue
for source_type in (SourceType.HOST, SourceType.MANAGEMENT):
kwargs = get_section_kwargs(
parsed_sections_broker,
HostKey(host_config.hostname, ipaddress, source_type),
inventory_plugin.sections,
)
if not kwargs:
console.vverbose(" %s%s%s%s: skipped (no data)\n", tty.yellow,
tty.bold, inventory_plugin.name, tty.normal)
continue
# Inventory functions can optionally have a second argument: parameters.
# These are configured via rule sets (much like check parameters).
if inventory_plugin.inventory_ruleset_name is not None:
kwargs["params"] = host_config.inventory_parameters(
inventory_plugin.inventory_ruleset_name)
exception = tree_aggregator.aggregate_results(
inventory_plugin.inventory_function(**kwargs), )
if exception:
console.warning(" %s%s%s%s: failed: %s", tty.red, tty.bold,
inventory_plugin.name, tty.normal, exception)
else:
console.verbose(" %s%s%s%s", tty.green, tty.bold,
inventory_plugin.name, tty.normal)
console.vverbose(": ok\n")
console.verbose("\n")
tree_aggregator.trees.inventory.normalize_nodes()
tree_aggregator.trees.status_data.normalize_nodes()
return tree_aggregator.trees
def _extract_disabled_snmp_sections_from_ignored_checks(
self, all_rulesets):
ignored_checks_ruleset = all_rulesets.get("ignored_checks")
if ignored_checks_ruleset.is_empty():
# nothing to do
return
if not all_rulesets.get("snmp_exclude_sections").is_empty():
# this must be an upgrade from 2.0.0 or newer - don't mess with
# the existing rules!
return
self._logger.log(VERBOSE, "Extracting excluded SNMP sections")
all_snmp_section_names = set(
s.name for s in register.iter_all_snmp_sections())
all_check_plugin_names = set(
p.name for p in register.iter_all_check_plugins())
all_inventory_plugin_names = set(
i.name for i in register.iter_all_inventory_plugins())
snmp_exclude_sections_ruleset = cmk.gui.watolib.rulesets.Ruleset(
"snmp_exclude_sections", ignored_checks_ruleset.tag_to_group_map)
for folder, _index, rule in ignored_checks_ruleset.get_rules():
disabled = {CheckPluginName(n) for n in rule.value}
still_needed_sections_names = set(
register.get_relevant_raw_sections(
check_plugin_names=all_check_plugin_names - disabled,
inventory_plugin_names=all_inventory_plugin_names,
))
sections_to_disable = all_snmp_section_names - still_needed_sections_names
new_rule = cmk.gui.watolib.rulesets.Rule(
rule.folder, snmp_exclude_sections_ruleset)
new_rule.from_config(rule.to_config())
new_rule.id = cmk.gui.watolib.rulesets.utils.gen_id()
new_rule.value = { # type: ignore[assignment]
'sections_disabled': sorted(str(s) for s in sections_to_disable),
'sections_enabled': [],
}
snmp_exclude_sections_ruleset.append_rule(folder, new_rule)
all_rulesets.set(snmp_exclude_sections_ruleset.name,
snmp_exclude_sections_ruleset)
def _do_inv_for_realhost(
host_config: config.HostConfig,
multi_host_sections: MultiHostSections,
ipaddress: Optional[HostAddress],
inventory_tree: StructuredDataTree,
status_data_tree: StructuredDataTree,
):
section.section_step("Executing inventory plugins")
console.verbose("Plugins:")
for inventory_plugin in agent_based_register.iter_all_inventory_plugins():
kwargs = multi_host_sections.get_section_kwargs(
HostKey(host_config.hostname, ipaddress, SourceType.HOST),
inventory_plugin.sections,
)
if not kwargs:
continue
console.verbose(
" %s%s%s%s" %
(tty.green, tty.bold, inventory_plugin.name, tty.normal))
# Inventory functions can optionally have a second argument: parameters.
# These are configured via rule sets (much like check parameters).
if inventory_plugin.inventory_ruleset_name is not None:
kwargs["params"] = host_config.inventory_parameters(
str(inventory_plugin.inventory_ruleset_name)
) # TODO (mo): keep type!
_aggregate_inventory_results(
inventory_plugin.inventory_function(**kwargs),
inventory_tree,
status_data_tree,
)
console.verbose("\n")
def _do_inv_for_realhost(
config_cache: config.ConfigCache,
host_config: config.HostConfig,
sources: Sequence[ABCSource],
multi_host_sections: Optional[MultiHostSections],
hostname: HostName,
ipaddress: Optional[HostAddress],
inventory_tree: StructuredDataTree,
status_data_tree: StructuredDataTree,
) -> Sequence[Tuple[ABCSource, Result[ABCHostSections, Exception]]]:
results: List[Tuple[ABCSource, Result[ABCHostSections, Exception]]] = []
for source in sources:
if isinstance(source, checkers.snmp.SNMPSource):
# TODO(ml): This modifies the SNMP fetcher config dynamically.
source.on_snmp_scan_error = "raise" # default
checkers.FileCacheConfigurer.snmp_disabled = True
source.use_snmpwalk_cache = False
source.ignore_check_interval = True
if multi_host_sections is not None:
# Status data inventory already provides filled multi_host_sections object.
# SNMP data source: If 'do_status_data_inv' is enabled there may be
# sections for inventory plugins which were not fetched yet.
host_sections = multi_host_sections.setdefault(
# TODO(ml): are
# hostname == source.hostname
# ipaddress == source.ipaddress
# ?
HostKey(hostname, ipaddress, source.source_type),
SNMPHostSections(),
)
# TODO(ml): This modifies the SNMP fetcher config dynamically.
# Can the fetcher handle that on its own?
source.prefetched_sections = host_sections.sections
# When executing the structured status inventory, we are in the Mode.CHECKING
assert source.mode is Mode.INVENTORY or source.mode is Mode.CHECKING
host_section = source.parse(source.fetch())
results.append((source, host_section))
if host_section.is_ok():
assert host_section.ok is not None
host_sections.update(host_section.ok)
if multi_host_sections is None:
multi_host_sections = MultiHostSections()
hs = checkers.update_host_sections(
multi_host_sections,
checkers.make_nodes(
config_cache,
host_config,
ipaddress,
checkers.Mode.INVENTORY,
sources,
),
max_cachefile_age=host_config.max_cachefile_age,
selected_raw_sections=None,
host_config=host_config,
)
results.extend(hs)
section.section_step("Executing inventory plugins")
console.verbose("Plugins:")
for inventory_plugin in agent_based_register.iter_all_inventory_plugins():
kwargs = multi_host_sections.get_section_kwargs(
HostKey(hostname, ipaddress, SourceType.HOST),
inventory_plugin.sections,
)
if not kwargs:
continue
console.verbose(
" %s%s%s%s" %
(tty.green, tty.bold, inventory_plugin.name, tty.normal))
# Inventory functions can optionally have a second argument: parameters.
# These are configured via rule sets (much like check parameters).
if inventory_plugin.inventory_ruleset_name is not None:
kwargs["params"] = host_config.inventory_parameters(
str(inventory_plugin.inventory_ruleset_name)
) # TODO (mo): keep type!
_aggregate_inventory_results(
inventory_plugin.inventory_function(**kwargs),
inventory_tree,
status_data_tree,
)
console.verbose("\n")
return results
def _do_inv_for_realhost(
config_cache: config.ConfigCache,
host_config: config.HostConfig,
sources: data_sources.DataSources,
multi_host_sections: Optional[MultiHostSections],
hostname: HostName,
ipaddress: Optional[HostAddress],
inventory_tree: StructuredDataTree,
status_data_tree: StructuredDataTree,
) -> None:
for source in sources:
if isinstance(source, data_sources.snmp.SNMPDataSource):
# TODO(ml): This modifies the SNMP fetcher config dynamically.
configurator = cast(data_sources.snmp.SNMPConfigurator, source.configurator)
configurator.on_snmp_scan_error = "raise" # default
configurator.do_snmp_scan = True
data_sources.FileCacheConfigurator.snmp_disabled = True
configurator.use_snmpwalk_cache = False
configurator.ignore_check_interval = True
if multi_host_sections is not None:
# Status data inventory already provides filled multi_host_sections object.
# SNMP data source: If 'do_status_data_inv' is enabled there may be
# sections for inventory plugins which were not fetched yet.
host_sections = multi_host_sections.setdefault(
# TODO(ml): are
# hostname == source.hostname
# ipaddress == source.ipaddress
# ?
HostKey(hostname, ipaddress, source.configurator.source_type),
SNMPHostSections(),
)
# TODO(ml): This modifies the SNMP fetcher config dynamically.
# Can the fetcher handle that on its own?
configurator.prefetched_sections = host_sections.sections
host_sections.update(source.run(selected_raw_sections=None))
if multi_host_sections is None:
multi_host_sections = data_sources.make_host_sections(
config_cache,
host_config,
ipaddress,
data_sources.Mode.INVENTORY,
sources,
max_cachefile_age=host_config.max_cachefile_age,
selected_raw_sections=None,
)
section.section_step("Executing inventory plugins")
console.verbose("Plugins:")
for inventory_plugin in agent_based_register.iter_all_inventory_plugins():
kwargs = multi_host_sections.get_section_kwargs(
HostKey(hostname, ipaddress, SourceType.HOST),
inventory_plugin.sections,
)
if not kwargs:
continue
console.verbose(" %s%s%s%s" % (tty.green, tty.bold, inventory_plugin.name, tty.normal))
# Inventory functions can optionally have a second argument: parameters.
# These are configured via rule sets (much like check parameters).
if inventory_plugin.inventory_ruleset_name is not None:
kwargs["params"] = host_config.inventory_parameters(
str(inventory_plugin.inventory_ruleset_name)) # TODO (mo): keep type!
_aggregate_inventory_results(
inventory_plugin.inventory_function(**kwargs),
inventory_tree,
status_data_tree,
)
console.verbose("\n")
def _do_inv_for_realhost(
host_config: config.HostConfig,
*,
parsed_sections_broker: ParsedSectionsBroker,
run_plugin_names: Container[InventoryPluginName],
retentions_tracker: RetentionsTracker,
) -> InventoryTrees:
tree_aggregator = TreeAggregator()
_set_cluster_property(tree_aggregator.trees.inventory, host_config)
section.section_step("Executing inventory plugins")
for inventory_plugin in agent_based_register.iter_all_inventory_plugins():
if inventory_plugin.name not in run_plugin_names:
continue
for host_key in (host_config.host_key, host_config.host_key_mgmt):
kwargs = get_section_kwargs(
parsed_sections_broker,
host_key,
inventory_plugin.sections,
)
if not kwargs:
console.vverbose(
" %s%s%s%s: skipped (no data)\n",
tty.yellow,
tty.bold,
inventory_plugin.name,
tty.normal,
)
continue
# Inventory functions can optionally have a second argument: parameters.
# These are configured via rule sets (much like check parameters).
if inventory_plugin.inventory_ruleset_name is not None:
kwargs = {
**kwargs,
"params":
host_config.inventory_parameters(
inventory_plugin.inventory_ruleset_name),
}
exception = tree_aggregator.aggregate_results(
inventory_generator=inventory_plugin.inventory_function(
**kwargs),
retentions_tracker=retentions_tracker,
raw_cache_info=parsed_sections_broker.get_cache_info(
inventory_plugin.sections),
is_legacy_plugin=inventory_plugin.module is None,
)
if exception:
console.warning(
" %s%s%s%s: failed: %s",
tty.red,
tty.bold,
inventory_plugin.name,
tty.normal,
exception,
)
else:
console.verbose(" %s%s%s%s", tty.green, tty.bold,
inventory_plugin.name, tty.normal)
console.vverbose(": ok\n")
console.verbose("\n")
return tree_aggregator.trees
