Werk #16581: Automatic creation of labels based on OS information from the agent

Component	Checks & agents
Title	Automatic creation of labels based on OS information from the agent
Date	Mar 8, 2024
Level	Trivial Change
Class	New Feature
Compatibility	Compatible - no manual interaction needed
Checkmk versions & editions	2.4.0b1 Checkmk Community, Checkmk Pro, Checkmk Ultimate, Checkmk Ultimate MT 2.3.0b2 Checkmk Community, Checkmk Pro, Checkmk Ultimate, Checkmk Ultimate MT

Checkmk automatically creates host labels based on OS data sent by the agents on check_mk section. 

• cmk/os_type: High-level category of the OS, e.g., linux, windows, or unix. Value taken from OSType line.
• cmk/os_platform: The distribution of the OS, e.g., freebsd, openbsd, debian, ubuntu, or redhat. Value is taken from OSPlatform line.
• cmk/os_name: The human-readable name of the OS, e.g., Windows, Debian GNU/Linux, or Mac OS X. Value taken from OSName line.
• cmk/os_version: The numeric version of the OS, e.g., 24.04 for Ubuntu, or 10.0.14393 for Windows. Value taken from OSVersion line.

No label is created if the respective line is not present. cmk/os_platform will fall back to AgentOS, if OSPlatform is unavailable.

The label cmk/os_family has been present in Checkmk for a while now. However, which this Werk we introduced cmk/os_type as a more generic replacement. cmk/os_family will still be available for some time, but it will be removed from Checkmk eventually. Please start migration e.g., your rules, filters, views or dasboards to cmk/os_name or cmk/os_type, depending on your use-case.

The following list shows example values reported by agents for each OS. AgentOS is the source for the deprecated cmk/os_family label.

• AIX

  • AgentOS: aix → cmk/os_family (deprecated)
  • OSType: unix → cmk/os_type
  • OSName: AIX → cmk/os_name
  • OSVersion: [oslevel -s]: 7100-05-04-1914 → cmk/os_version

• FreeBSD

  • AgentOS: freebsd → cmk/os_family (deprecated)
  • OSType: unix → cmk/os_type
  • OSName: [/etc/os-release (NAME)]: FreeBSD → cmk/os_name
  • OSVersion: [/etc/os-release (VERSION_ID)]: 13.2 → cmk/os_version

• HP-UX

  • AgentOS: hpux → cmk/os_family (deprecated)
  • OSType: unix → cmk/os_type
  • OSName: HP-UX → cmk/os_name
  • OSVersion: [uname -r | cut -d' ' -f1]: B.11.31 → cmk/os_version

• Linux

  • AgentOS: linux → cmk/os_family (deprecated)
  • OSType: linux → cmk/os_type
  • OSPlatform: [/etc/os-release (ID)]: ubuntu → cmk/os_platform
  • OSName: [/etc/os-release (NAME)]: Ubuntu → cmk/os_name
  • OSVersion: [/etc/os-release (VERSION_ID)]: 22.04 → cmk/os_version

• macOS

  • AgentOS: macosx → cmk/os_family (deprecated)
  • OSType: macos → cmk/os_type
  • OSName: [sw_vers -productName]: macOS → cmk/os_name
  • OSVersion: [sw_vers -productVersion]: 13.0 → cmk/os_version

• NetBSD

  • AgentOS: netbsd → cmk/os_family (deprecated)
  • OSType: unix → cmk/os_type
  • OSName: [uname -s]: NetBSD → cmk/os_name
  • OSVersion: [uname -r]: 9.3 → cmk/os_version

• OpenBSD

  • AgentOS: openbsd → cmk/os_family (deprecated)
  • OSType: unix → cmk/os_type
  • OSName: [uname -s]: OpenBSD → cmk/os_name
  • OSVersion: [uname -r]: 7.4 → cmk/os_version

• OpenVMS

  • AgentOS: openvms → cmk/os_family (deprecated)
  • OSName: OpenVMS → cmk/os_name

• OpenWRT

  • AgentOS: openwrt → cmk/os_family (deprecated)
  • OSType: linux → cmk/os_type
  • OSName: [/etc/os-release (NAME)]: OpenWRT → cmk/os_name
  • OSVersion: [/etc/os-release (VERSION_ID)]: snapshot → cmk/os_version

• Solaris

  • AgentOS: solaris → cmk/os_family (deprecated)
  • OSType: unix → cmk/os_type
  • OSName: [/etc/os-release (NAME)]: Oracle Solaris → cmk/os_name
  • OSVersion: [/etc/os-release (VERSION_ID)]: 11.4 → cmk/os_version

• Windows

  • AgentOS: windows → cmk/os_family (deprecated)
  • OSType: windows → cmk/os_type
  • OSName: [wmi]: Microsoft Windows 10 Pro → cmk/os_name
  • OSVersion: [wmi]: 10.0.19045 → cmk/os_version

• z/OS

  • AgentOS: z/OS → cmk/os_family (deprecated)
  • OSType: z/os → cmk/os_type
  • OSName: z/OS → cmk/os_name

To the list of all Werks